Line data Source code
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 *
67 : OGRWktReadPointsM(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);
74 : std::string CPL_DLL OGRMakeWktCoordinate(double, double, double, int,
75 : const OGRWktOptions &opts);
76 : void CPL_DLL OGRMakeWktCoordinateM(char *, double, double, double, double, bool,
77 : bool);
78 : std::string CPL_DLL OGRMakeWktCoordinateM(double, double, double, double, bool,
79 : bool, const OGRWktOptions &opts);
80 :
81 : #endif
82 :
83 : void CPL_DLL OGRFormatDouble(char *pszBuffer, int nBufferLen, double dfVal,
84 : char chDecimalSep, int nPrecision = 15,
85 : char chConversionSpecifier = 'f');
86 :
87 : #ifdef OGR_GEOMETRY_H_INCLUDED
88 : std::string CPL_DLL OGRFormatDouble(double val, const OGRWktOptions &opts,
89 : int nDimIdx);
90 : #endif
91 :
92 : int OGRFormatFloat(char *pszBuffer, int nBufferLen, float fVal, int nPrecision,
93 : char chConversionSpecifier);
94 :
95 : /* -------------------------------------------------------------------- */
96 : /* Date-time parsing and processing functions */
97 : /* -------------------------------------------------------------------- */
98 :
99 : /* Internal use by OGR drivers only, CPL_DLL is just there in case */
100 : /* they are compiled as plugins */
101 :
102 : int CPL_DLL OGRTimezoneToTZFlag(const char *pszTZ,
103 : bool bEmitErrorIfUnhandledFormat);
104 : std::string CPL_DLL OGRTZFlagToTimezone(int nTZFlag,
105 : const char *pszUTCRepresentation);
106 :
107 : int CPL_DLL OGRGetDayOfWeek(int day, int month, int year);
108 : int CPL_DLL OGRParseXMLDateTime(const char *pszXMLDateTime, OGRField *psField);
109 : int CPL_DLL OGRParseRFC822DateTime(const char *pszRFC822DateTime,
110 : OGRField *psField);
111 : char CPL_DLL *OGRGetRFC822DateTime(const OGRField *psField);
112 : char CPL_DLL *OGRGetXMLDateTime(const OGRField *psField);
113 : char CPL_DLL *OGRGetXMLDateTime(const OGRField *psField,
114 : bool bAlwaysMillisecond);
115 : // 30 = strlen("YYYY-MM-DDThh:mm:ss.sss+hh:mm") + 1
116 : #define OGR_SIZEOF_ISO8601_DATETIME_BUFFER 30
117 : int CPL_DLL
118 : OGRGetISO8601DateTime(const OGRField *psField, bool bAlwaysMillisecond,
119 : char szBuffer[OGR_SIZEOF_ISO8601_DATETIME_BUFFER]);
120 :
121 : /** Precision of formatting */
122 : enum class OGRISO8601Precision
123 : {
124 : /** Automated mode: millisecond included if non zero, otherwise truncated at second */
125 : AUTO,
126 : /** Always include millisecond */
127 : MILLISECOND,
128 : /** Always include second, but no millisecond */
129 : SECOND,
130 : /** Always include minute, but no second */
131 : MINUTE
132 : };
133 :
134 : /** Configuration of the ISO8601 formatting output */
135 : struct OGRISO8601Format
136 : {
137 : /** Precision of formatting */
138 : OGRISO8601Precision ePrecision;
139 : };
140 :
141 : int CPL_DLL
142 : OGRGetISO8601DateTime(const OGRField *psField, const OGRISO8601Format &sFormat,
143 : char szBuffer[OGR_SIZEOF_ISO8601_DATETIME_BUFFER]);
144 : char CPL_DLL *OGRGetXML_UTF8_EscapedString(const char *pszString);
145 :
146 : #ifdef GDAL_COMPILATION
147 : bool CPL_DLL OGRParseDateTimeYYYYMMDDTHHMMZ(std::string_view sInput,
148 : OGRField *psField);
149 : bool CPL_DLL OGRParseDateTimeYYYYMMDDTHHMMSSZ(std::string_view sInput,
150 : OGRField *psField);
151 : bool CPL_DLL OGRParseDateTimeYYYYMMDDTHHMMSSsssZ(std::string_view sInput,
152 : OGRField *psField);
153 : #endif
154 :
155 : int OGRCompareDate(const OGRField *psFirstTuple,
156 : const OGRField *psSecondTuple); /* used by ogr_gensql.cpp and
157 : ogrfeaturequery.cpp */
158 :
159 : bool CPL_DLL OGRIsGeoJSONMediaType(const char *pszMediaType);
160 :
161 : /* General utility option processing. */
162 : int CPL_DLL OGRGeneralCmdLineProcessor(int nArgc, char ***ppapszArgv,
163 : int nOptions);
164 :
165 : /************************************************************************/
166 : /* Support for special attributes (feature query and selection) */
167 : /************************************************************************/
168 : #define SPF_FID 0
169 : #define SPF_OGR_GEOMETRY 1
170 : #define SPF_OGR_STYLE 2
171 : #define SPF_OGR_GEOM_WKT 3
172 : #define SPF_OGR_GEOM_AREA 4
173 : #define SPECIAL_FIELD_COUNT 5
174 :
175 : extern const char *const SpecialFieldNames[SPECIAL_FIELD_COUNT];
176 :
177 : /************************************************************************/
178 : /* Some SRS related stuff, search in SRS data files. */
179 : /************************************************************************/
180 :
181 : OGRErr CPL_DLL OSRGetEllipsoidInfo(int, char **, double *, double *);
182 :
183 : /* Fast atof function */
184 : double OGRFastAtof(const char *pszStr);
185 :
186 : OGRErr CPL_DLL OGRCheckPermutation(const int *panPermutation, int nSize);
187 :
188 : /************************************************************************/
189 : /* PostGIS EWKB encoding */
190 : /************************************************************************/
191 :
192 : OGRGeometry CPL_DLL *OGRGeometryFromEWKB(GByte *pabyWKB, int nLength,
193 : int *pnSRID, int bIsPostGIS1_EWKB);
194 : OGRGeometry CPL_DLL *OGRGeometryFromHexEWKB(const char *pszBytea, int *pnSRID,
195 : int bIsPostGIS1_EWKB);
196 : char CPL_DLL *OGRGeometryToHexEWKB(const OGRGeometry *poGeometry, int nSRSId,
197 : int nPostGISMajor, int nPostGISMinor);
198 :
199 : /************************************************************************/
200 : /* WKB Type Handling encoding */
201 : /************************************************************************/
202 :
203 : OGRErr CPL_DLL OGRReadWKBGeometryType(const unsigned char *pabyData,
204 : OGRwkbVariant wkbVariant,
205 : OGRwkbGeometryType *eGeometryType);
206 :
207 : /************************************************************************/
208 : /* WKT Type Handling encoding */
209 : /************************************************************************/
210 :
211 : OGRErr CPL_DLL OGRReadWKTGeometryType(const char *pszWKT,
212 : OGRwkbGeometryType *peGeometryType);
213 :
214 : /************************************************************************/
215 : /* Other */
216 : /************************************************************************/
217 :
218 : void CPL_DLL OGRUpdateFieldType(OGRFieldDefn *poFDefn, OGRFieldType eNewType,
219 : OGRFieldSubType eNewSubType);
220 :
221 : /************************************************************************/
222 : /* OGRRoundValueIEEE754() */
223 : /************************************************************************/
224 :
225 : /** Set to zero least significants bits of a double precision floating-point
226 : * number (passed as an integer), taking into account a desired bit precision.
227 : *
228 : * @param nVal Integer representation of a IEEE754 double-precision number.
229 : * @param nBitsPrecision Desired precision (number of bits after integral part)
230 : * @return quantized nVal.
231 : * @since GDAL 3.9
232 : */
233 : inline uint64_t OGRRoundValueIEEE754(uint64_t nVal,
234 : int nBitsPrecision) CPL_WARN_UNUSED_RESULT;
235 :
236 104 : inline uint64_t OGRRoundValueIEEE754(uint64_t nVal, int nBitsPrecision)
237 : {
238 104 : constexpr int MANTISSA_SIZE = std::numeric_limits<double>::digits - 1;
239 104 : constexpr int MAX_EXPONENT = std::numeric_limits<double>::max_exponent;
240 : #if __cplusplus >= 201703L
241 : static_assert(MANTISSA_SIZE == 52);
242 : static_assert(MAX_EXPONENT == 1024);
243 : #endif
244 : // Extract the binary exponent from the IEEE754 representation
245 104 : const int nExponent =
246 104 : ((nVal >> MANTISSA_SIZE) & (2 * MAX_EXPONENT - 1)) - (MAX_EXPONENT - 1);
247 : // Add 1 to round-up and the desired precision
248 104 : const int nBitsRequired = 1 + nExponent + nBitsPrecision;
249 : // Compute number of nullified bits
250 104 : int nNullifiedBits = MANTISSA_SIZE - nBitsRequired;
251 : // this will also capture NaN and Inf since nExponent = 1023,
252 : // and thus nNullifiedBits < 0
253 104 : if (nNullifiedBits <= 0)
254 2 : return nVal;
255 102 : if (nNullifiedBits >= MANTISSA_SIZE)
256 2 : nNullifiedBits = MANTISSA_SIZE;
257 102 : nVal >>= nNullifiedBits;
258 102 : nVal <<= nNullifiedBits;
259 102 : return nVal;
260 : }
261 :
262 : /************************************************************************/
263 : /* OGRRoundCoordinatesIEEE754XYValues() */
264 : /************************************************************************/
265 :
266 : /** Quantize XY values.
267 : *
268 : * @since GDAL 3.9
269 : */
270 : template <int SPACING>
271 707268 : inline void OGRRoundCoordinatesIEEE754XYValues(int nBitsPrecision,
272 : GByte *pabyBase, size_t nPoints)
273 : {
274 : // Note: we use SPACING as template for improved code generation.
275 :
276 707268 : if (nBitsPrecision != INT_MIN)
277 : {
278 42 : for (size_t i = 0; i < nPoints; i++)
279 : {
280 : uint64_t nVal;
281 :
282 29 : memcpy(&nVal, pabyBase + SPACING * i, sizeof(uint64_t));
283 29 : nVal = OGRRoundValueIEEE754(nVal, nBitsPrecision);
284 29 : memcpy(pabyBase + SPACING * i, &nVal, sizeof(uint64_t));
285 :
286 29 : memcpy(&nVal, pabyBase + sizeof(uint64_t) + SPACING * i,
287 : sizeof(uint64_t));
288 29 : nVal = OGRRoundValueIEEE754(nVal, nBitsPrecision);
289 29 : memcpy(pabyBase + sizeof(uint64_t) + SPACING * i, &nVal,
290 : sizeof(uint64_t));
291 : }
292 : }
293 707268 : }
294 :
295 : /************************************************************************/
296 : /* OGRRoundCoordinatesIEEE754() */
297 : /************************************************************************/
298 :
299 : /** Quantize Z or M values.
300 : *
301 : * @since GDAL 3.9
302 : */
303 : template <int SPACING>
304 216705 : inline void OGRRoundCoordinatesIEEE754(int nBitsPrecision, GByte *pabyBase,
305 : size_t nPoints)
306 : {
307 216705 : if (nBitsPrecision != INT_MIN)
308 : {
309 52 : for (size_t i = 0; i < nPoints; i++)
310 : {
311 : uint64_t nVal;
312 :
313 34 : memcpy(&nVal, pabyBase + SPACING * i, sizeof(uint64_t));
314 34 : nVal = OGRRoundValueIEEE754(nVal, nBitsPrecision);
315 34 : memcpy(pabyBase + SPACING * i, &nVal, sizeof(uint64_t));
316 : }
317 : }
318 216705 : }
319 :
320 : /* -------------------------------------------------------------------- */
321 : /* helper functions for string escaping. */
322 : /* -------------------------------------------------------------------- */
323 :
324 : /** Replace all occurrences of ch by it repeated twice.
325 : * Typically used for SQL string literal or identifier escaping.
326 : */
327 : std::string CPL_DLL OGRDuplicateCharacter(const std::string &osStr, char ch);
328 :
329 : #endif /* ndef OGR_P_H_INCLUDED */
|
