GDAL

ogr_p.h
1/******************************************************************************
2 *
3 * Project: OpenGIS Simple Features Reference Implementation
4 * Purpose: Some private helper functions and stuff for OGR implementation.
5 * Author: Frank Warmerdam, warmerdam@pobox.com
6 *
7 ******************************************************************************
8 * Copyright (c) 1999, Frank Warmerdam
9 * Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>
10 *
11 * SPDX-License-Identifier: MIT
12 ****************************************************************************/
13
14#ifndef OGR_P_H_INCLUDED
15#define OGR_P_H_INCLUDED
16
17/* -------------------------------------------------------------------- */
18/* Include the common portability library ... lets us do lots */
19/* of stuff easily. */
20/* -------------------------------------------------------------------- */
21
22#include "cpl_string.h"
23#include "cpl_conv.h"
24#include "cpl_minixml.h"
25
26#include "ogr_core.h"
27
28#include <limits>
29#include <string_view>
30
31 class OGRGeometry;
32 class OGRFieldDefn;
33
34/* A default name for the default geometry column, instead of '' */
35#define OGR_GEOMETRY_DEFAULT_NON_EMPTY_NAME "_ogr_geometry_"
36
37#ifdef CPL_MSB
38#define OGR_SWAP(x) (x == wkbNDR)
39#else
40#define OGR_SWAP(x) (x == wkbXDR)
41#endif
42
43/* PostGIS 1.X has non standard codes for the following geometry types */
44#define POSTGIS15_CURVEPOLYGON 13 /* instead of 10 */
45#define POSTGIS15_MULTICURVE 14 /* instead of 11 */
46#define POSTGIS15_MULTISURFACE 15 /* instead of 12 */
47
48/* Has been deprecated. Can only be used in very specific circumstances */
49#ifdef GDAL_COMPILATION
50#define wkb25DBitInternalUse 0x80000000
51#endif
52
53/* -------------------------------------------------------------------- */
54/* helper function for parsing well known text format vector objects.*/
55/* -------------------------------------------------------------------- */
56
57#ifdef OGR_GEOMETRY_H_INCLUDED
58#define OGR_WKT_TOKEN_MAX 64
59
60 const char CPL_DLL *OGRWktReadToken(const char *pszInput, char *pszToken);
61
62 const char CPL_DLL *OGRWktReadPoints(const char *pszInput,
63 OGRRawPoint **ppaoPoints, double **ppadfZ,
64 int *pnMaxPoints, int *pnReadPoints);
65
66 const char CPL_DLL *
67OGRWktReadPointsM(const char *pszInput, OGRRawPoint **ppaoPoints,
68 double **ppadfZ, double **ppadfM,
69 int *flags, /* geometry flags, are we expecting Z, M, or both;
70 may change due to input */
71 int *pnMaxPoints, int *pnReadPoints);
72
73 void CPL_DLL OGRMakeWktCoordinate(char *, double, double, double, int);
74std::string CPL_DLL OGRMakeWktCoordinate(double, double, double, int,
75 const OGRWktOptions &opts);
76 void CPL_DLL OGRMakeWktCoordinateM(char *, double, double, double, double,
77 OGRBoolean, OGRBoolean);
78std::string CPL_DLL OGRMakeWktCoordinateM(double, double, double, double,
79 OGRBoolean, OGRBoolean,
80 const OGRWktOptions &opts);
81
82#endif
83
84 void CPL_DLL OGRFormatDouble(char *pszBuffer, int nBufferLen, double dfVal,
85 char chDecimalSep, int nPrecision = 15,
86 char chConversionSpecifier = 'f');
87
88#ifdef OGR_GEOMETRY_H_INCLUDED
89std::string CPL_DLL OGRFormatDouble(double val, const OGRWktOptions &opts,
90 int nDimIdx);
91#endif
92
93 int OGRFormatFloat(char *pszBuffer, int nBufferLen, float fVal, int nPrecision,
94 char chConversionSpecifier);
95
96/* -------------------------------------------------------------------- */
97/* Date-time parsing and processing functions */
98/* -------------------------------------------------------------------- */
99
100/* Internal use by OGR drivers only, CPL_DLL is just there in case */
101/* they are compiled as plugins */
102
103 int CPL_DLL OGRTimezoneToTZFlag(const char *pszTZ,
104 bool bEmitErrorIfUnhandledFormat);
105std::string CPL_DLL OGRTZFlagToTimezone(int nTZFlag,
106 const char *pszUTCRepresentation);
107
108 int CPL_DLL OGRGetDayOfWeek(int day, int month, int year);
109 int CPL_DLL OGRParseXMLDateTime(const char *pszXMLDateTime, OGRField *psField);
110 int CPL_DLL OGRParseRFC822DateTime(const char *pszRFC822DateTime,
111 OGRField *psField);
112 char CPL_DLL *OGRGetRFC822DateTime(const OGRField *psField);
113 char CPL_DLL *OGRGetXMLDateTime(const OGRField *psField);
114 char CPL_DLL *OGRGetXMLDateTime(const OGRField *psField,
115 bool bAlwaysMillisecond);
116// 30 = strlen("YYYY-MM-DDThh:mm:ss.sss+hh:mm") + 1
117#define OGR_SIZEOF_ISO8601_DATETIME_BUFFER 30
118 int CPL_DLL
119OGRGetISO8601DateTime(const OGRField *psField, bool bAlwaysMillisecond,
120 char szBuffer[OGR_SIZEOF_ISO8601_DATETIME_BUFFER]);
121
123 enum class OGRISO8601Precision
124{
126 AUTO,
128 MILLISECOND,
130 SECOND,
132 MINUTE
133};
134
136 struct OGRISO8601Format
137{
139 OGRISO8601Precision ePrecision;
140};
141
142 int CPL_DLL
143OGRGetISO8601DateTime(const OGRField *psField, const OGRISO8601Format &sFormat,
144 char szBuffer[OGR_SIZEOF_ISO8601_DATETIME_BUFFER]);
145 char CPL_DLL *OGRGetXML_UTF8_EscapedString(const char *pszString);
146
147#ifdef GDAL_COMPILATION
148 bool CPL_DLL OGRParseDateTimeYYYYMMDDTHHMMZ(std::string_view sInput,
149 OGRField *psField);
150 bool CPL_DLL OGRParseDateTimeYYYYMMDDTHHMMSSZ(std::string_view sInput,
151 OGRField *psField);
152 bool CPL_DLL OGRParseDateTimeYYYYMMDDTHHMMSSsssZ(std::string_view sInput,
153 OGRField *psField);
154#endif
155
156 int OGRCompareDate(const OGRField *psFirstTuple,
157 const OGRField *psSecondTuple); /* used by ogr_gensql.cpp and
158 ogrfeaturequery.cpp */
159
160/* General utility option processing. */
161 int CPL_DLL OGRGeneralCmdLineProcessor(int nArgc, char ***ppapszArgv,
162 int nOptions);
163
164/************************************************************************/
165/* Support for special attributes (feature query and selection) */
166/************************************************************************/
167#define SPF_FID 0
168#define SPF_OGR_GEOMETRY 1
169#define SPF_OGR_STYLE 2
170#define SPF_OGR_GEOM_WKT 3
171#define SPF_OGR_GEOM_AREA 4
172#define SPECIAL_FIELD_COUNT 5
173
174 extern const char *const SpecialFieldNames[SPECIAL_FIELD_COUNT];
175
176/************************************************************************/
177/* Some SRS related stuff, search in SRS data files. */
178/************************************************************************/
179
180 OGRErr CPL_DLL OSRGetEllipsoidInfo(int, char **, double *, double *);
181
182/* Fast atof function */
183 double OGRFastAtof(const char *pszStr);
184
185 OGRErr CPL_DLL OGRCheckPermutation(const int *panPermutation, int nSize);
186
187/************************************************************************/
188/* PostGIS EWKB encoding */
189/************************************************************************/
190
191 OGRGeometry CPL_DLL *OGRGeometryFromEWKB(GByte *pabyWKB, int nLength,
192 int *pnSRID, int bIsPostGIS1_EWKB);
193 OGRGeometry CPL_DLL *OGRGeometryFromHexEWKB(const char *pszBytea, int *pnSRID,
194 int bIsPostGIS1_EWKB);
195 char CPL_DLL *OGRGeometryToHexEWKB(OGRGeometry *poGeometry, int nSRSId,
196 int nPostGISMajor, int nPostGISMinor);
197
198/************************************************************************/
199/* WKB Type Handling encoding */
200/************************************************************************/
201
202 OGRErr CPL_DLL OGRReadWKBGeometryType(const unsigned char *pabyData,
203 OGRwkbVariant wkbVariant,
204 OGRwkbGeometryType *eGeometryType);
205
206/************************************************************************/
207/* WKT Type Handling encoding */
208/************************************************************************/
209
210 OGRErr CPL_DLL OGRReadWKTGeometryType(const char *pszWKT,
211 OGRwkbGeometryType *peGeometryType);
212
213/************************************************************************/
214/* Other */
215/************************************************************************/
216
217 void CPL_DLL OGRUpdateFieldType(OGRFieldDefn *poFDefn, OGRFieldType eNewType,
218 OGRFieldSubType eNewSubType);
219
220/************************************************************************/
221/* OGRRoundValueIEEE754() */
222/************************************************************************/
223
232 inline uint64_t OGRRoundValueIEEE754(uint64_t nVal,
233 int nBitsPrecision) CPL_WARN_UNUSED_RESULT;
234
235 inline uint64_t OGRRoundValueIEEE754(uint64_t nVal, int nBitsPrecision)
236{
237 constexpr int MANTISSA_SIZE = std::numeric_limits<double>::digits - 1;
238 constexpr int MAX_EXPONENT = std::numeric_limits<double>::max_exponent;
239#if __cplusplus >= 201703L
240 static_assert(MANTISSA_SIZE == 52);
241 static_assert(MAX_EXPONENT == 1024);
242#endif
243 // Extract the binary exponent from the IEEE754 representation
244 const int nExponent =
245 ((nVal >> MANTISSA_SIZE) & (2 * MAX_EXPONENT - 1)) - (MAX_EXPONENT - 1);
246 // Add 1 to round-up and the desired precision
247 const int nBitsRequired = 1 + nExponent + nBitsPrecision;
248 // Compute number of nullified bits
249 int nNullifiedBits = MANTISSA_SIZE - nBitsRequired;
250 // this will also capture NaN and Inf since nExponent = 1023,
251 // and thus nNullifiedBits < 0
252 if (nNullifiedBits <= 0)
253 return nVal;
254 if (nNullifiedBits >= MANTISSA_SIZE)
255 nNullifiedBits = MANTISSA_SIZE;
256 nVal >>= nNullifiedBits;
257 nVal <<= nNullifiedBits;
258 return nVal;
259}
260
261/************************************************************************/
262/* OGRRoundCoordinatesIEEE754XYValues() */
263/************************************************************************/
264
269 template <int SPACING>
270 inline void OGRRoundCoordinatesIEEE754XYValues(int nBitsPrecision,
271 GByte *pabyBase, size_t nPoints)
272{
273 // Note: we use SPACING as template for improved code generation.
274
275 if (nBitsPrecision != INT_MIN)
276 {
277 for (size_t i = 0; i < nPoints; i++)
278 {
279 uint64_t nVal;
280
281 memcpy(&nVal, pabyBase + SPACING * i, sizeof(uint64_t));
282 nVal = OGRRoundValueIEEE754(nVal, nBitsPrecision);
283 memcpy(pabyBase + SPACING * i, &nVal, sizeof(uint64_t));
284
285 memcpy(&nVal, pabyBase + sizeof(uint64_t) + SPACING * i,
286 sizeof(uint64_t));
287 nVal = OGRRoundValueIEEE754(nVal, nBitsPrecision);
288 memcpy(pabyBase + sizeof(uint64_t) + SPACING * i, &nVal,
289 sizeof(uint64_t));
290 }
291 }
292}
293
294/************************************************************************/
295/* OGRRoundCoordinatesIEEE754() */
296/************************************************************************/
297
302 template <int SPACING>
303 inline void OGRRoundCoordinatesIEEE754(int nBitsPrecision, GByte *pabyBase,
304 size_t nPoints)
305{
306 if (nBitsPrecision != INT_MIN)
307 {
308 for (size_t i = 0; i < nPoints; i++)
309 {
310 uint64_t nVal;
311
312 memcpy(&nVal, pabyBase + SPACING * i, sizeof(uint64_t));
313 nVal = OGRRoundValueIEEE754(nVal, nBitsPrecision);
314 memcpy(pabyBase + SPACING * i, &nVal, sizeof(uint64_t));
315 }
316 }
317}
318
319/* -------------------------------------------------------------------- */
320/* helper functions for string escaping. */
321/* -------------------------------------------------------------------- */
322
326std::string CPL_DLL OGRDuplicateCharacter(const std::string &osStr, char ch);
327
328#endif /* ndef OGR_P_H_INCLUDED */
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition ogr_feature.h:69
OGRGeometry
Abstract base class for all geometry classes.
Definition ogr_geometry.h:357
OGRRawPoint
Simple container for a position.
Definition ogr_geometry.h:89
OGRWktOptions
Options for formatting WKT output.
Definition ogr_geometry.h:46
cpl_conv.h
Various convenience functions for CPL.
cpl_minixml.h
Definitions for CPL mini XML Parser/Serializer.
CPL_WARN_UNUSED_RESULT
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition cpl_port.h:870
GByte
unsigned char GByte
Unsigned byte type.
Definition cpl_port.h:175
cpl_string.h
Various convenience functions for working with strings and string lists.
ogr_core.h
Core portability services for cross-platform OGR code.
OGRBoolean
int OGRBoolean
Type for a OGR boolean.
Definition ogr_core.h:386
OGRFieldSubType
OGRFieldSubType
List of field subtypes.
Definition ogr_core.h:799
OGRwkbVariant
OGRwkbVariant
Output variants of WKB we support.
Definition ogr_core.h:540
OGRFieldType
OGRFieldType
List of feature field types.
Definition ogr_core.h:772
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition ogr_core.h:405
OGRErr
int OGRErr
Type for a OGR error.
Definition ogr_core.h:370
OGRISO8601Format
Configuration of the ISO8601 formatting output.
Definition ogr_p.h:137
OGRISO8601Format::ePrecision
OGRISO8601Precision ePrecision
Precision of formatting.
Definition ogr_p.h:139
OGRField
OGRFeature field attribute value union.
Definition ogr_core.h:886