GDAL

cpl_conv.h
Go to the documentation of this file.
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: CPL - Common Portability Library
5 * Purpose: Convenience functions declarations.
6 * This is intended to remain light weight.
7 * Author: Frank Warmerdam, warmerdam@pobox.com
8 *
9 ******************************************************************************
10 * Copyright (c) 1998, Frank Warmerdam
11 * Copyright (c) 2007-2013, Even Rouault <even dot rouault at spatialys.com>
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a
14 * copy of this software and associated documentation files (the "Software"),
15 * to deal in the Software without restriction, including without limitation
16 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 * and/or sell copies of the Software, and to permit persons to whom the
18 * Software is furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice shall be included
21 * in all copies or substantial portions of the Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 * DEALINGS IN THE SOFTWARE.
30 ****************************************************************************/
31
32 #ifndef CPL_CONV_H_INCLUDED
33 #define CPL_CONV_H_INCLUDED
34
35 #include "cpl_port.h"
36 #include "cpl_vsi.h"
37 #include "cpl_error.h"
38
46 /* -------------------------------------------------------------------- */
47 /* Runtime check of various configuration items. */
48 /* -------------------------------------------------------------------- */
49 CPL_C_START
50
52 void CPL_DLL CPLVerifyConfiguration(void);
55 const char CPL_DLL *CPL_STDCALL CPLGetConfigOption(const char *, const char *)
56 CPL_WARN_UNUSED_RESULT;
57 const char CPL_DLL *CPL_STDCALL CPLGetThreadLocalConfigOption(
58 const char *, const char *) CPL_WARN_UNUSED_RESULT;
59 const char CPL_DLL *CPL_STDCALL
60 CPLGetGlobalConfigOption(const char *, const char *) CPL_WARN_UNUSED_RESULT;
61 void CPL_DLL CPL_STDCALL CPLSetConfigOption(const char *, const char *);
62 void CPL_DLL CPL_STDCALL CPLSetThreadLocalConfigOption(const char *pszKey,
63 const char *pszValue);
64
66 typedef void (*CPLSetConfigOptionSubscriber)(const char *pszKey,
67 const char *pszValue,
68 bool bThreadLocal,
69 void *pUserData);
70 int CPL_DLL CPLSubscribeToSetConfigOption(
71 CPLSetConfigOptionSubscriber pfnCallback, void *pUserData);
72 void CPL_DLL CPLUnsubscribeToSetConfigOption(int nSubscriberId);
73
75 void CPL_DLL CPL_STDCALL CPLFreeConfig(void);
77 char CPL_DLL **CPLGetConfigOptions(void);
78 void CPL_DLL CPLSetConfigOptions(const char *const *papszConfigOptions);
79 char CPL_DLL **CPLGetThreadLocalConfigOptions(void);
80 void CPL_DLL
81 CPLSetThreadLocalConfigOptions(const char *const *papszConfigOptions);
82 void CPL_DLL CPLLoadConfigOptionsFromFile(const char *pszFilename,
83 int bOverrideEnvVars);
84 void CPL_DLL CPLLoadConfigOptionsFromPredefinedFiles(void);
85
86 /* -------------------------------------------------------------------- */
87 /* Safe malloc() API. Thin cover over VSI functions with fatal */
88 /* error reporting if memory allocation fails. */
89 /* -------------------------------------------------------------------- */
90 void CPL_DLL *CPLMalloc(size_t) CPL_WARN_UNUSED_RESULT;
91 void CPL_DLL *CPLCalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT;
92 void CPL_DLL *CPLRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT;
93 char CPL_DLL *
94 CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
95 char CPL_DLL *CPLStrlwr(char *);
96
98 #define CPLFree VSIFree
99
100 /* -------------------------------------------------------------------- */
101 /* Read a line from a text file, and strip of CR/LF. */
102 /* -------------------------------------------------------------------- */
103 char CPL_DLL *CPLFGets(char *, int, FILE *);
104 const char CPL_DLL *CPLReadLine(FILE *);
105 const char CPL_DLL *CPLReadLineL(VSILFILE *);
106 const char CPL_DLL *CPLReadLine2L(VSILFILE *, int, CSLConstList);
107 const char CPL_DLL *CPLReadLine3L(VSILFILE *, int, int *, CSLConstList);
108
109 /* -------------------------------------------------------------------- */
110 /* Convert ASCII string to floating point number */
111 /* (THESE FUNCTIONS ARE NOT LOCALE AWARE!). */
112 /* -------------------------------------------------------------------- */
113 double CPL_DLL CPLAtof(const char *);
114 double CPL_DLL CPLAtofDelim(const char *, char);
115 double CPL_DLL CPLStrtod(const char *, char **);
116 double CPL_DLL CPLStrtodDelim(const char *, char **, char);
117 float CPL_DLL CPLStrtof(const char *, char **);
118 float CPL_DLL CPLStrtofDelim(const char *, char **, char);
119
120 /* -------------------------------------------------------------------- */
121 /* Convert number to string. This function is locale agnostic */
122 /* (i.e. it will support "," or "." regardless of current locale) */
123 /* -------------------------------------------------------------------- */
124 double CPL_DLL CPLAtofM(const char *);
125
126 /* -------------------------------------------------------------------- */
127 /* Read a numeric value from an ASCII character string. */
128 /* -------------------------------------------------------------------- */
129 char CPL_DLL *CPLScanString(const char *, int, int, int);
130 double CPL_DLL CPLScanDouble(const char *, int);
131 long CPL_DLL CPLScanLong(const char *, int);
132 unsigned long CPL_DLL CPLScanULong(const char *, int);
133 GUIntBig CPL_DLL CPLScanUIntBig(const char *, int);
134 GIntBig CPL_DLL CPLAtoGIntBig(const char *pszString);
135 GIntBig CPL_DLL CPLAtoGIntBigEx(const char *pszString, int bWarn,
136 int *pbOverflow);
137 void CPL_DLL *CPLScanPointer(const char *, int);
138
139 /* -------------------------------------------------------------------- */
140 /* Print a value to an ASCII character string. */
141 /* -------------------------------------------------------------------- */
142 int CPL_DLL CPLPrintString(char *, const char *, int);
143 int CPL_DLL CPLPrintStringFill(char *, const char *, int);
144 int CPL_DLL CPLPrintInt32(char *, GInt32, int);
145 int CPL_DLL CPLPrintUIntBig(char *, GUIntBig, int);
146 int CPL_DLL CPLPrintDouble(char *, const char *, double, const char *);
147 int CPL_DLL CPLPrintTime(char *, int, const char *, const struct tm *,
148 const char *);
149 int CPL_DLL CPLPrintPointer(char *, void *, int);
150
151 /* -------------------------------------------------------------------- */
152 /* Fetch a function from DLL / so. */
153 /* -------------------------------------------------------------------- */
154
155 void CPL_DLL *CPLGetSymbol(const char *, const char *);
156
157 /* -------------------------------------------------------------------- */
158 /* Fetch executable path. */
159 /* -------------------------------------------------------------------- */
160 int CPL_DLL CPLGetExecPath(char *pszPathBuf, int nMaxLength);
161
162 /* -------------------------------------------------------------------- */
163 /* Filename handling functions. */
164 /* -------------------------------------------------------------------- */
165 const char CPL_DLL *
166 CPLGetPath(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
167 const char CPL_DLL *
168 CPLGetDirname(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
169 const char CPL_DLL *
170 CPLGetFilename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
171 const char CPL_DLL *
172 CPLGetBasename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
173 const char CPL_DLL *
174 CPLGetExtension(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
175 char CPL_DLL *CPLGetCurrentDir(void);
176 const char CPL_DLL *CPLFormFilename(
177 const char *pszPath, const char *pszBasename,
178 const char *pszExtension) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
179 const char CPL_DLL *CPLFormCIFilename(
180 const char *pszPath, const char *pszBasename,
181 const char *pszExtension) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
182 const char CPL_DLL *CPLResetExtension(const char *, const char *)
183 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
184 const char CPL_DLL *CPLProjectRelativeFilename(const char *pszProjectDir,
185 const char *pszSecondaryFilename)
186 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
187 int CPL_DLL CPLIsFilenameRelative(const char *pszFilename);
188 const char CPL_DLL *CPLExtractRelativePath(const char *, const char *, int *)
189 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
190 const char CPL_DLL *
191 CPLCleanTrailingSlash(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
192 char CPL_DLL **
193 CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename,
194 char **papszFileList) CPL_WARN_UNUSED_RESULT;
195 int CPL_DLL CPLCheckForFile(char *pszFilename, char **papszSiblingList);
196
197 const char CPL_DLL *CPLGenerateTempFilename(const char *pszStem)
198 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
199 const char CPL_DLL *CPLExpandTilde(const char *pszFilename)
200 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
201 const char CPL_DLL *CPLGetHomeDir(void) CPL_WARN_UNUSED_RESULT;
202 const char CPL_DLL *
203 CPLLaunderForFilename(const char *pszName,
204 const char *pszOutputPath) CPL_WARN_UNUSED_RESULT;
205
206 /* -------------------------------------------------------------------- */
207 /* Find File Function */
208 /* -------------------------------------------------------------------- */
209
211 typedef char const *(*CPLFileFinder)(const char *, const char *);
212
213 const char CPL_DLL *CPLFindFile(const char *pszClass, const char *pszBasename);
214 const char CPL_DLL *CPLDefaultFindFile(const char *pszClass,
215 const char *pszBasename);
216 void CPL_DLL CPLPushFileFinder(CPLFileFinder pfnFinder);
217 CPLFileFinder CPL_DLL CPLPopFileFinder(void);
218 void CPL_DLL CPLPushFinderLocation(const char *);
219 void CPL_DLL CPLPopFinderLocation(void);
220 void CPL_DLL CPLFinderClean(void);
221
222 /* -------------------------------------------------------------------- */
223 /* Safe version of stat() that works properly on stuff like "C:". */
224 /* -------------------------------------------------------------------- */
225 int CPL_DLL CPLStat(const char *, VSIStatBuf *) CPL_WARN_UNUSED_RESULT;
226
227 /* -------------------------------------------------------------------- */
228 /* Reference counted file handle manager. Makes sharing file */
229 /* handles more practical. */
230 /* -------------------------------------------------------------------- */
231
233 typedef struct
234 {
235 FILE *fp;
236 int nRefCount;
237 int bLarge;
238 char *pszFilename;
239 char *pszAccess;
240 } CPLSharedFileInfo;
241
242 FILE CPL_DLL *CPLOpenShared(const char *, const char *, int);
243 void CPL_DLL CPLCloseShared(FILE *);
244 CPLSharedFileInfo CPL_DLL *CPLGetSharedList(int *);
245 void CPL_DLL CPLDumpSharedList(FILE *);
247 void CPL_DLL CPLCleanupSharedFileMutex(void);
250 /* -------------------------------------------------------------------- */
251 /* DMS to Dec to DMS conversion. */
252 /* -------------------------------------------------------------------- */
253 double CPL_DLL CPLDMSToDec(const char *is);
254 const char CPL_DLL *CPLDecToDMS(double dfAngle, const char *pszAxis,
255 int nPrecision);
256 double CPL_DLL CPLPackedDMSToDec(double);
257 double CPL_DLL CPLDecToPackedDMS(double dfDec);
258
259 void CPL_DLL CPLStringToComplex(const char *pszString, double *pdfReal,
260 double *pdfImag);
261
262 /* -------------------------------------------------------------------- */
263 /* Misc other functions. */
264 /* -------------------------------------------------------------------- */
265 int CPL_DLL CPLUnlinkTree(const char *);
266 int CPL_DLL CPLCopyFile(const char *pszNewPath, const char *pszOldPath);
267 int CPL_DLL CPLCopyTree(const char *pszNewPath, const char *pszOldPath);
268 int CPL_DLL CPLMoveFile(const char *pszNewPath, const char *pszOldPath);
269 int CPL_DLL CPLSymlink(const char *pszOldPath, const char *pszNewPath,
270 CSLConstList papszOptions);
271
272 /* -------------------------------------------------------------------- */
273 /* ZIP Creation. */
274 /* -------------------------------------------------------------------- */
275
277 #define CPL_ZIP_API_OFFERED
278
279 void CPL_DLL *CPLCreateZip(const char *pszZipFilename, char **papszOptions);
280 CPLErr CPL_DLL CPLCreateFileInZip(void *hZip, const char *pszFilename,
281 char **papszOptions);
282 CPLErr CPL_DLL CPLWriteFileInZip(void *hZip, const void *pBuffer,
283 int nBufferSize);
284 CPLErr CPL_DLL CPLCloseFileInZip(void *hZip);
285 CPLErr CPL_DLL CPLAddFileInZip(void *hZip, const char *pszArchiveFilename,
286 const char *pszInputFilename, VSILFILE *fpInput,
287 CSLConstList papszOptions,
288 GDALProgressFunc pProgressFunc,
289 void *pProgressData);
290 CPLErr CPL_DLL CPLCloseZip(void *hZip);
291
292 /* -------------------------------------------------------------------- */
293 /* ZLib compression */
294 /* -------------------------------------------------------------------- */
295
296 void CPL_DLL *CPLZLibDeflate(const void *ptr, size_t nBytes, int nLevel,
297 void *outptr, size_t nOutAvailableBytes,
298 size_t *pnOutBytes);
299 void CPL_DLL *CPLZLibInflate(const void *ptr, size_t nBytes, void *outptr,
300 size_t nOutAvailableBytes, size_t *pnOutBytes);
301
302 /* -------------------------------------------------------------------- */
303 /* XML validation. */
304 /* -------------------------------------------------------------------- */
305 int CPL_DLL CPLValidateXML(const char *pszXMLFilename,
306 const char *pszXSDFilename,
307 CSLConstList papszOptions);
308
309 /* -------------------------------------------------------------------- */
310 /* Locale handling. Prevents parallel executions of setlocale(). */
311 /* -------------------------------------------------------------------- */
312 char *CPLsetlocale(int category, const char *locale);
314 void CPLCleanupSetlocaleMutex(void);
322 int CPL_DLL CPLIsPowerOfTwo(unsigned int i);
323
324 CPL_C_END
325
326 /* -------------------------------------------------------------------- */
327 /* C++ object for temporarily forcing a LC_NUMERIC locale to "C". */
328 /* -------------------------------------------------------------------- */
329
331 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
332
333 extern "C++"
334 {
335 class CPL_DLL CPLLocaleC
336 {
337 CPL_DISALLOW_COPY_ASSIGN(CPLLocaleC)
338 public:
339 CPLLocaleC();
340 ~CPLLocaleC();
341
342 private:
343 char *pszOldLocale;
344 };
345
346 // Does the same as CPLLocaleC except that, when available, it tries to
347 // only affect the current thread. But code that would be dependent of
348 // setlocale(LC_NUMERIC, NULL) returning "C", such as current proj.4
349 // versions, will not work depending on the actual implementation
350 class CPLThreadLocaleCPrivate;
351 class CPL_DLL CPLThreadLocaleC
352 {
353 CPL_DISALLOW_COPY_ASSIGN(CPLThreadLocaleC)
354
355 public:
356 CPLThreadLocaleC();
357 ~CPLThreadLocaleC();
358
359 private:
360 CPLThreadLocaleCPrivate *m_private;
361 };
362 }
363
364 #endif /* def __cplusplus */
365
367 /* -------------------------------------------------------------------- */
368 /* C++ object for temporarily forcing a config option */
369 /* -------------------------------------------------------------------- */
370
372 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
373
374 extern "C++"
375 {
376 class CPL_DLL CPLConfigOptionSetter
377 {
378 CPL_DISALLOW_COPY_ASSIGN(CPLConfigOptionSetter)
379 public:
380 CPLConfigOptionSetter(const char *pszKey, const char *pszValue,
381 bool bSetOnlyIfUndefined);
382 ~CPLConfigOptionSetter();
383
384 private:
385 char *m_pszKey;
386 char *m_pszOldValue;
387 bool m_bRestoreOldValue;
388 };
389 }
390
391 #endif /* def __cplusplus */
392
394 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
395
396 extern "C++"
397 {
398
399 #ifndef DOXYGEN_SKIP
400 #include <type_traits> // for std::is_base_of
401 #endif
402
403 namespace cpl
404 {
414 template <typename To, typename From> inline To down_cast(From *f)
415 {
416 static_assert(
417 (std::is_base_of<From,
418 typename std::remove_pointer<To>::type>::value),
419 "target type not derived from source type");
420 CPLAssert(f == nullptr || dynamic_cast<To>(f) != nullptr);
421 return static_cast<To>(f);
422 }
423 } // namespace cpl
424 } // extern "C++"
425
426 #endif /* def __cplusplus */
427
428 #if defined(__cplusplus) && defined(GDAL_COMPILATION)
429
430 extern "C++"
431 {
432 #include <memory> // for std::unique_ptr
433 namespace cpl
434 {
436 template <typename T, typename... Args>
437 std::unique_ptr<T> make_unique(Args &&...args)
438 {
439 return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
440 }
441 } // namespace cpl
442 } // extern "C++"
443
444 #endif /* def __cplusplus */
445
446 #endif /* ndef CPL_CONV_H_INCLUDED */
CPLPopFinderLocation
void CPLPopFinderLocation(void)
CPLPopFinderLocation.
Definition: cpl_findfile.cpp:290
CPLStrtodDelim
double CPLStrtodDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:233
CPLValidateXML
int CPLValidateXML(const char *pszXMLFilename, const char *pszXSDFilename, CSLConstList papszOptions)
Validate a XML file against a XML schema.
Definition: cpl_xml_validate.cpp:1061
CPLReadLineL
const char * CPLReadLineL(VSILFILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:646
CPLGenerateTempFilename
const char * CPLGenerateTempFilename(const char *pszStem)
Generate temporary file name.
Definition: cpl_path.cpp:1112
CPLLoadConfigOptionsFromFile
void CPLLoadConfigOptionsFromFile(const char *pszFilename, int bOverrideEnvVars)
Load configuration from a given configuration file.
Definition: cpl_conv.cpp:2154
CPLIsPowerOfTwo
int CPLIsPowerOfTwo(unsigned int i)
Definition: cpl_conv.cpp:3341
CPLGetSymbol
void * CPLGetSymbol(const char *, const char *)
Fetch a function pointer from a shared library / DLL.
Definition: cplgetsymbol.cpp:87
CPLScanString
char * CPLScanString(const char *, int, int, int)
Scan up to a maximum number of characters from a given string, allocate a buffer for a new string and...
Definition: cpl_conv.cpp:868
CPLPrintStringFill
int CPLPrintStringFill(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition: cpl_conv.cpp:1268
cpl_error.h
CPLCleanTrailingSlash
const char * CPLCleanTrailingSlash(const char *)
Remove trailing forward/backward slash from the path for UNIX/Windows resp.
Definition: cpl_path.cpp:958
CPLGetExecPath
int CPLGetExecPath(char *pszPathBuf, int nMaxLength)
Fetch path of executable.
Definition: cpl_getexecpath.cpp:67
CPLFindFile
const char * CPLFindFile(const char *pszClass, const char *pszBasename)
CPLFindFile.
Definition: cpl_findfile.cpp:180
CPLPrintTime
int CPLPrintTime(char *, int, const char *, const struct tm *, const char *)
Print specified time value accordingly to the format options and specified locale name.
Definition: cpl_conv.cpp:1501
CPLDMSToDec
double CPLDMSToDec(const char *is)
CPLDMSToDec.
Definition: cpl_conv.cpp:2434
CPLExtractRelativePath
const char * CPLExtractRelativePath(const char *, const char *, int *)
Get relative path from directory to target file.
Definition: cpl_path.cpp:868
CPLZLibInflate
void * CPLZLibInflate(const void *ptr, size_t nBytes, void *outptr, size_t nOutAvailableBytes, size_t *pnOutBytes)
Uncompress a buffer compressed with ZLib compression.
Definition: cpl_conv.cpp:3450
CPLPrintUIntBig
int CPLPrintUIntBig(char *, GUIntBig, int)
Print GUIntBig value into specified string buffer.
Definition: cpl_conv.cpp:1351
CPLCalloc
void * CPLCalloc(size_t, size_t)
Safe version of calloc().
Definition: cpl_conv.cpp:151
CPLCopyFile
int CPLCopyFile(const char *pszNewPath, const char *pszOldPath)
Copy a file.
Definition: cpl_conv.cpp:3022
CPLSetConfigOptions
void CPLSetConfigOptions(const char *const *papszConfigOptions)
Replace the full list of configuration options with the passed list of KEY=VALUE pairs.
Definition: cpl_conv.cpp:1762
CPLCloseZip
CPLErr CPLCloseZip(void *hZip)
Close ZIP file.
Definition: cpl_conv.cpp:3437
CPLScanPointer
void * CPLScanPointer(const char *, int)
Extract pointer from string.
Definition: cpl_conv.cpp:1106
cpl_vsi.h
CPLPushFinderLocation
void CPLPushFinderLocation(const char *)
CPLPushFinderLocation.
Definition: cpl_findfile.cpp:251
CPLPackedDMSToDec
double CPLPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition: cpl_conv.cpp:2609
CPLAtoGIntBig
GIntBig CPLAtoGIntBig(const char *pszString)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1012
CPLSharedFileInfo::bLarge
int bLarge
Whether fp must be interpreted as VSIFILE*.
Definition: cpl_conv.h:237
CPLDumpSharedList
void CPLDumpSharedList(FILE *)
Report open shared files.
Definition: cpl_conv.cpp:2905
CPLGetSharedList
CPLSharedFileInfo * CPLGetSharedList(int *)
Fetch list of open shared files.
Definition: cpl_conv.cpp:2883
CPLResetExtension
const char * CPLResetExtension(const char *, const char *)
Replace the extension with the provided one.
Definition: cpl_path.cpp:442
CPLSharedFileInfo
Information on a shared file.
Definition: cpl_conv.h:233
CPLRealloc
void * CPLRealloc(void *, size_t)
Safe version of realloc().
Definition: cpl_conv.cpp:238
CPLAtofM
double CPLAtofM(const char *)
Converts ASCII string to floating point number using any numeric locale.
Definition: cpl_strtod.cpp:143
CPLGetPath
const char * CPLGetPath(const char *)
Extract directory path portion of filename.
Definition: cpl_path.cpp:150
CPLCloseFileInZip
CPLErr CPLCloseFileInZip(void *hZip)
Close current file inside ZIP file.
Definition: cpl_conv.cpp:3432
CPLFinderClean
void CPLFinderClean(void)
CPLFinderClean.
Definition: cpl_findfile.cpp:133
CPLGetThreadLocalConfigOption
const char * CPLGetThreadLocalConfigOption(const char *, const char *)
Same as CPLGetConfigOption() but only with options set with CPLSetThreadLocalConfigOption()
Definition: cpl_conv.cpp:1776
CPLDefaultFindFile
const char * CPLDefaultFindFile(const char *pszClass, const char *pszBasename)
CPLDefaultFindFile.
Definition: cpl_findfile.cpp:148
CPLSetConfigOptionSubscriber
void(* CPLSetConfigOptionSubscriber)(const char *pszKey, const char *pszValue, bool bThreadLocal, void *pUserData)
Callback for CPLSubscribeToSetConfigOption()
Definition: cpl_conv.h:66
CPLAssert
#define CPLAssert(expr)
Assert on an expression.
Definition: cpl_error.h:213
CPLAtoGIntBigEx
GIntBig CPLAtoGIntBigEx(const char *pszString, int bWarn, int *pbOverflow)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1058
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:306
CPLOpenShared
FILE * CPLOpenShared(const char *, const char *, int)
Open a shared file handle.
Definition: cpl_conv.cpp:2720
CPLZLibDeflate
void * CPLZLibDeflate(const void *ptr, size_t nBytes, int nLevel, void *outptr, size_t nOutAvailableBytes, size_t *pnOutBytes)
Compress a buffer with ZLib compression.
Definition: cpl_conv.cpp:3442
CPLGetGlobalConfigOption
const char * CPLGetGlobalConfigOption(const char *, const char *)
Same as CPLGetConfigOption() but excludes environment variables and options set with CPLSetThreadLoca...
Definition: cpl_conv.cpp:1807
CPLCheckForFile
int CPLCheckForFile(char *pszFilename, char **papszSiblingList)
Check for file existence.
Definition: cpl_conv.cpp:3376
CPLGetCurrentDir
char * CPLGetCurrentDir(void)
Get the current working directory name.
Definition: cpl_path.cpp:421
CPLFGets
char * CPLFGets(char *, int, FILE *)
Reads in at most one less than nBufferSize characters from the fp stream and stores them into the buf...
Definition: cpl_conv.cpp:377
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1178
CPLCloseShared
void CPLCloseShared(FILE *)
Close shared file.
Definition: cpl_conv.cpp:2792
CPLGetDirname
const char * CPLGetDirname(const char *)
Extract directory path portion of filename.
Definition: cpl_path.cpp:204
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:229
CPLCreateZip
void * CPLCreateZip(const char *pszZipFilename, char **papszOptions)
Create ZIP file.
Definition: cpl_conv.cpp:3414
CPLReadLine3L
const char * CPLReadLine3L(VSILFILE *, int, int *, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:699
CPLGetConfigOptions
char ** CPLGetConfigOptions(void)
Return the list of configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1736
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:310
CPLPrintString
int CPLPrintString(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition: cpl_conv.cpp:1224
CPLIsFilenameRelative
int CPLIsFilenameRelative(const char *pszFilename)
Is filename relative or absolute?
Definition: cpl_path.cpp:826
CPLFormFilename
const char * CPLFormFilename(const char *pszPath, const char *pszBasename, const char *pszExtension)
Build a full file path from a passed path, file basename and extension.
Definition: cpl_path.cpp:551
CPLProjectRelativeFilename
const char * CPLProjectRelativeFilename(const char *pszProjectDir, const char *pszSecondaryFilename)
Find a file relative to a project file.
Definition: cpl_path.cpp:761
CPLMalloc
void * CPLMalloc(size_t)
Safe version of malloc().
Definition: cpl_conv.cpp:181
CPLLaunderForFilename
const char * CPLLaunderForFilename(const char *pszName, const char *pszOutputPath)
Launder a string to be compatible of a filename.
Definition: cpl_path.cpp:1206
CPLFileFinder
const char *(* CPLFileFinder)(const char *, const char *)
Callback for CPLPushFileFinder.
Definition: cpl_conv.h:211
VSIVirtualHandle
Virtual file handle.
Definition: cpl_vsi_virtual.h:62
CPLFormCIFilename
const char * CPLFormCIFilename(const char *pszPath, const char *pszBasename, const char *pszExtension)
Case insensitive file searching, returning full path.
Definition: cpl_path.cpp:669
CPLMoveFile
int CPLMoveFile(const char *pszNewPath, const char *pszOldPath)
Move a file.
Definition: cpl_conv.cpp:3110
CPLStrtof
float CPLStrtof(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:492
CPLSetThreadLocalConfigOptions
void CPLSetThreadLocalConfigOptions(const char *const *papszConfigOptions)
Replace the full list of thread local configuration options with the passed list of KEY=VALUE pairs.
Definition: cpl_conv.cpp:2063
CPLCorrespondingPaths
char ** CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename, char **papszFileList)
Identify corresponding paths.
Definition: cpl_path.cpp:1008
CPLScanULong
unsigned long CPLScanULong(const char *, int)
Scan up to a maximum number of characters from a string and convert the result to a unsigned long.
Definition: cpl_conv.cpp:956
CPLSetConfigOption
void CPLSetConfigOption(const char *, const char *)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1938
cpl::down_cast
To down_cast(From *f)
Use cpl::down_cast<Derived*>(pointer_to_base) as equivalent of static_cast<Derived*>(pointer_to_base)...
Definition: cpl_conv.h:414
CPLDecToDMS
const char * CPLDecToDMS(double dfAngle, const char *pszAxis, int nPrecision)
Translate a decimal degrees value to a DMS string with hemisphere.
Definition: cpl_conv.cpp:2519
CPLUnlinkTree
int CPLUnlinkTree(const char *)
Recursively unlink a directory.
Definition: cpl_conv.cpp:2939
CPLCopyTree
int CPLCopyTree(const char *pszNewPath, const char *pszOldPath)
Recursively copy a tree.
Definition: cpl_conv.cpp:3035
CPLSubscribeToSetConfigOption
int CPLSubscribeToSetConfigOption(CPLSetConfigOptionSubscriber pfnCallback, void *pUserData)
Install a callback that will be notified of calls to CPLSetConfigOption()/ CPLSetThreadLocalConfigOpt...
Definition: cpl_conv.cpp:1839
CPLSharedFileInfo::pszAccess
char * pszAccess
Access mode.
Definition: cpl_conv.h:239
CPLWriteFileInZip
CPLErr CPLWriteFileInZip(void *hZip, const void *pBuffer, int nBufferSize)
Write in current file inside a ZIP file.
Definition: cpl_conv.cpp:3427
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:226
CPLLoadConfigOptionsFromPredefinedFiles
void CPLLoadConfigOptionsFromPredefinedFiles(void)
Load configuration from a set of predefined files.
Definition: cpl_conv.cpp:2350
CPLsetlocale
char * CPLsetlocale(int category, const char *locale)
Prevents parallel executions of setlocale().
Definition: cpl_conv.cpp:3315
CPLSymlink
int CPLSymlink(const char *pszOldPath, const char *pszNewPath, CSLConstList papszOptions)
Create a symbolic link.
Definition: cpl_conv.cpp:3134
CPLUnsubscribeToSetConfigOption
void CPLUnsubscribeToSetConfigOption(int nSubscriberId)
Remove a subscriber installed with CPLSubscribeToSetConfigOption()
Definition: cpl_conv.cpp:1871
CPLStat
int CPLStat(const char *, VSIStatBuf *)
Same as VSIStat() except it works on "C:" as if it were "C:\".
Definition: cpl_conv.cpp:2385
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:976
CPLExpandTilde
const char * CPLExpandTilde(const char *pszFilename)
Expands ~/ at start of filename.
Definition: cpl_path.cpp:1153
CPLDecToPackedDMS
double CPLDecToPackedDMS(double dfDec)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition: cpl_conv.cpp:2643
cpl_port.h
CPLReadLine
const char * CPLReadLine(FILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:578
CPLPrintDouble
int CPLPrintDouble(char *, const char *, double, const char *)
Print double value into specified string buffer.
Definition: cpl_conv.cpp:1443
CPLSharedFileInfo::pszFilename
char * pszFilename
Filename.
Definition: cpl_conv.h:238
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:52
CPLPrintPointer
int CPLPrintPointer(char *, void *, int)
Print pointer value into specified string buffer.
Definition: cpl_conv.cpp:1399
CPLStrdup
char * CPLStrdup(const char *)
Safe version of strdup() function.
Definition: cpl_conv.cpp:306
CPLAtof
double CPLAtof(const char *)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:118
CPLPopFileFinder
CPLFileFinder CPLPopFileFinder(void)
CPLPopFileFinder.
Definition: cpl_findfile.cpp:240
CPLScanUIntBig
GUIntBig CPLScanUIntBig(const char *, int)
Extract big integer from string.
Definition: cpl_conv.cpp:986
CPLReadLine2L
const char * CPLReadLine2L(VSILFILE *, int, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:671
CPLCreateFileInZip
CPLErr CPLCreateFileInZip(void *hZip, const char *pszFilename, char **papszOptions)
Create a file in a ZIP file.
Definition: cpl_conv.cpp:3422
CPLGetHomeDir
const char * CPLGetHomeDir(void)
Return the path to the home directory.
Definition: cpl_path.cpp:1181
CPLPrintInt32
int CPLPrintInt32(char *, GInt32, int)
Print GInt32 value into specified string buffer.
Definition: cpl_conv.cpp:1312
CPLStrtofDelim
float CPLStrtofDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:448
CPLPushFileFinder
void CPLPushFileFinder(CPLFileFinder pfnFinder)
CPLPushFileFinder.
Definition: cpl_findfile.cpp:203
CPLScanLong
long CPLScanLong(const char *, int)
Scan up to a maximum number of characters from a string and convert the result to a long.
Definition: cpl_conv.cpp:928
CPLGetThreadLocalConfigOptions
char ** CPLGetThreadLocalConfigOptions(void)
Return the list of thread local configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:2033
CPLScanDouble
double CPLScanDouble(const char *, int)
Extract double from string.
Definition: cpl_conv.cpp:1172
CPLGetBasename
const char * CPLGetBasename(const char *)
Extract basename (non-directory, non-extension) portion of filename.
Definition: cpl_path.cpp:287
CPLStringToComplex
void CPLStringToComplex(const char *pszString, double *pdfReal, double *pdfImag)
Fetch the real and imaginary part of a serialized complex number.
Definition: cpl_conv.cpp:2660
CPLAtofDelim
double CPLAtofDelim(const char *, char)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:74
GInt32
int GInt32
Int32 type.
Definition: cpl_port.h:186
CPLGetExtension
const char * CPLGetExtension(const char *)
Extract filename extension from full filename.
Definition: cpl_path.cpp:341
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:1042
CPLGetFilename
const char * CPLGetFilename(const char *)
Extract non-directory portion of filename.
Definition: cpl_path.cpp:255
CPL_RETURNS_NONNULL
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:1014
CPLSharedFileInfo::nRefCount
int nRefCount
Reference counter.
Definition: cpl_conv.h:236
CPLSharedFileInfo::fp
FILE * fp
File pointer.
Definition: cpl_conv.h:235
CPLStrtod
double CPLStrtod(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:422
CPLGetConfigOption
const char * CPLGetConfigOption(const char *, const char *)
Get the value of a configuration option.
Definition: cpl_conv.cpp:1688
CPLSetThreadLocalConfigOption
void CPLSetThreadLocalConfigOption(const char *pszKey, const char *pszValue)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1992
CPLStrlwr
char * CPLStrlwr(char *)
Convert each characters of the string to lower case.
Definition: cpl_conv.cpp:332
CPLAddFileInZip
CPLErr CPLAddFileInZip(void *hZip, const char *pszArchiveFilename, const char *pszInputFilename, VSILFILE *fpInput, CSLConstList papszOptions, GDALProgressFunc pProgressFunc, void *pProgressData)
Add a file inside a ZIP file opened/created with CPLCreateZip().
Definition: cpl_minizip_zip.cpp:2332