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 CPLStrtodM(const char *, char **);
117 double CPL_DLL CPLStrtodDelim(const char *, char **, char);
118 float CPL_DLL CPLStrtof(const char *, char **);
119 float CPL_DLL CPLStrtofDelim(const char *, char **, char);
120
121/* -------------------------------------------------------------------- */
122/* Convert number to string. This function is locale agnostic */
123/* (i.e. it will support "," or "." regardless of current locale) */
124/* -------------------------------------------------------------------- */
125 double CPL_DLL CPLAtofM(const char *);
126
127/* -------------------------------------------------------------------- */
128/* Read a numeric value from an ASCII character string. */
129/* -------------------------------------------------------------------- */
130 char CPL_DLL *CPLScanString(const char *, int, int, int);
131 double CPL_DLL CPLScanDouble(const char *, int);
132 long CPL_DLL CPLScanLong(const char *, int);
133 unsigned long CPL_DLL CPLScanULong(const char *, int);
134 GUIntBig CPL_DLL CPLScanUIntBig(const char *, int);
135 GIntBig CPL_DLL CPLAtoGIntBig(const char *pszString);
136 GIntBig CPL_DLL CPLAtoGIntBigEx(const char *pszString, int bWarn,
137 int *pbOverflow);
138 void CPL_DLL *CPLScanPointer(const char *, int);
139
140/* -------------------------------------------------------------------- */
141/* Print a value to an ASCII character string. */
142/* -------------------------------------------------------------------- */
143 int CPL_DLL CPLPrintString(char *, const char *, int);
144 int CPL_DLL CPLPrintStringFill(char *, const char *, int);
145 int CPL_DLL CPLPrintInt32(char *, GInt32, int);
146 int CPL_DLL CPLPrintUIntBig(char *, GUIntBig, int);
147 int CPL_DLL CPLPrintDouble(char *, const char *, double, const char *);
148 int CPL_DLL CPLPrintTime(char *, int, const char *, const struct tm *,
149 const char *);
150 int CPL_DLL CPLPrintPointer(char *, void *, int);
151
152/* -------------------------------------------------------------------- */
153/* Fetch a function from DLL / so. */
154/* -------------------------------------------------------------------- */
155
156 void CPL_DLL *CPLGetSymbol(const char *, const char *);
157
158/* -------------------------------------------------------------------- */
159/* Fetch executable path. */
160/* -------------------------------------------------------------------- */
161 int CPL_DLL CPLGetExecPath(char *pszPathBuf, int nMaxLength);
162
163/* -------------------------------------------------------------------- */
164/* Filename handling functions. */
165/* -------------------------------------------------------------------- */
166 const char CPL_DLL *
167 CPLGetPath(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
168 const char CPL_DLL *
169 CPLGetDirname(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
170 const char CPL_DLL *
171 CPLGetFilename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
172 const char CPL_DLL *
173 CPLGetBasename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
174 const char CPL_DLL *
175 CPLGetExtension(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
176 char CPL_DLL *CPLGetCurrentDir(void);
177 const char CPL_DLL *CPLFormFilename(
178 const char *pszPath, const char *pszBasename,
179 const char *pszExtension) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
180 const char CPL_DLL *CPLFormCIFilename(
181 const char *pszPath, const char *pszBasename,
182 const char *pszExtension) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
183 const char CPL_DLL *CPLResetExtension(const char *, const char *)
184 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
185 const char CPL_DLL *CPLProjectRelativeFilename(const char *pszProjectDir,
186 const char *pszSecondaryFilename)
187 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
188 int CPL_DLL CPLIsFilenameRelative(const char *pszFilename);
189 const char CPL_DLL *CPLExtractRelativePath(const char *, const char *, int *)
190 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
191 const char CPL_DLL *
192 CPLCleanTrailingSlash(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
193 char CPL_DLL **
194 CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename,
195 char **papszFileList) CPL_WARN_UNUSED_RESULT;
196 int CPL_DLL CPLCheckForFile(char *pszFilename, char **papszSiblingList);
197
198 const char CPL_DLL *CPLGenerateTempFilename(const char *pszStem)
199 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
200 const char CPL_DLL *CPLExpandTilde(const char *pszFilename)
201 CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
202 const char CPL_DLL *CPLGetHomeDir(void) CPL_WARN_UNUSED_RESULT;
203 const char CPL_DLL *
204 CPLLaunderForFilename(const char *pszName,
205 const char *pszOutputPath) CPL_WARN_UNUSED_RESULT;
206
207/* -------------------------------------------------------------------- */
208/* Find File Function */
209/* -------------------------------------------------------------------- */
210
212 typedef char const *(*CPLFileFinder)(const char *, const char *);
213
214 const char CPL_DLL *CPLFindFile(const char *pszClass, const char *pszBasename);
215 const char CPL_DLL *CPLDefaultFindFile(const char *pszClass,
216 const char *pszBasename);
217 void CPL_DLL CPLPushFileFinder(CPLFileFinder pfnFinder);
218 CPLFileFinder CPL_DLL CPLPopFileFinder(void);
219 void CPL_DLL CPLPushFinderLocation(const char *);
220 void CPL_DLL CPLPopFinderLocation(void);
221 void CPL_DLL CPLFinderClean(void);
222
223/* -------------------------------------------------------------------- */
224/* Safe version of stat() that works properly on stuff like "C:". */
225/* -------------------------------------------------------------------- */
226 int CPL_DLL CPLStat(const char *, VSIStatBuf *) CPL_WARN_UNUSED_RESULT;
227
228/* -------------------------------------------------------------------- */
229/* Reference counted file handle manager. Makes sharing file */
230/* handles more practical. */
231/* -------------------------------------------------------------------- */
232
234 typedef struct
235{
236 FILE *fp;
237 int nRefCount;
238 int bLarge;
239 char *pszFilename;
240 char *pszAccess;
241} CPLSharedFileInfo;
242
243FILE CPL_DLL *CPLOpenShared(const char *, const char *, int);
244 void CPL_DLL CPLCloseShared(FILE *);
245 CPLSharedFileInfo CPL_DLL *CPLGetSharedList(int *);
246 void CPL_DLL CPLDumpSharedList(FILE *);
248 void CPL_DLL CPLCleanupSharedFileMutex(void);
251/* -------------------------------------------------------------------- */
252/* DMS to Dec to DMS conversion. */
253/* -------------------------------------------------------------------- */
254 double CPL_DLL CPLDMSToDec(const char *is);
255 const char CPL_DLL *CPLDecToDMS(double dfAngle, const char *pszAxis,
256 int nPrecision);
257 double CPL_DLL CPLPackedDMSToDec(double);
258 double CPL_DLL CPLDecToPackedDMS(double dfDec);
259
260 void CPL_DLL CPLStringToComplex(const char *pszString, double *pdfReal,
261 double *pdfImag);
262
263/* -------------------------------------------------------------------- */
264/* Misc other functions. */
265/* -------------------------------------------------------------------- */
266 int CPL_DLL CPLUnlinkTree(const char *);
267 int CPL_DLL CPLCopyFile(const char *pszNewPath, const char *pszOldPath);
268 int CPL_DLL CPLCopyTree(const char *pszNewPath, const char *pszOldPath);
269 int CPL_DLL CPLMoveFile(const char *pszNewPath, const char *pszOldPath);
270 int CPL_DLL CPLSymlink(const char *pszOldPath, const char *pszNewPath,
271 CSLConstList papszOptions);
272
273/* -------------------------------------------------------------------- */
274/* ZIP Creation. */
275/* -------------------------------------------------------------------- */
276
278#define CPL_ZIP_API_OFFERED
280 void CPL_DLL *CPLCreateZip(const char *pszZipFilename, char **papszOptions);
281 CPLErr CPL_DLL CPLCreateFileInZip(void *hZip, const char *pszFilename,
282 char **papszOptions);
283 CPLErr CPL_DLL CPLWriteFileInZip(void *hZip, const void *pBuffer,
284 int nBufferSize);
285 CPLErr CPL_DLL CPLCloseFileInZip(void *hZip);
286 CPLErr CPL_DLL CPLAddFileInZip(void *hZip, const char *pszArchiveFilename,
287 const char *pszInputFilename, VSILFILE *fpInput,
288 CSLConstList papszOptions,
289 GDALProgressFunc pProgressFunc,
290 void *pProgressData);
291 CPLErr CPL_DLL CPLCloseZip(void *hZip);
292
293/* -------------------------------------------------------------------- */
294/* ZLib compression */
295/* -------------------------------------------------------------------- */
296
297 void CPL_DLL *CPLZLibDeflate(const void *ptr, size_t nBytes, int nLevel,
298 void *outptr, size_t nOutAvailableBytes,
299 size_t *pnOutBytes);
300 void CPL_DLL *CPLZLibInflate(const void *ptr, size_t nBytes, void *outptr,
301 size_t nOutAvailableBytes, size_t *pnOutBytes);
302 void CPL_DLL *CPLZLibInflateEx(const void *ptr, size_t nBytes, void *outptr,
303 size_t nOutAvailableBytes,
304 bool bAllowResizeOutptr, size_t *pnOutBytes);
305
306/* -------------------------------------------------------------------- */
307/* XML validation. */
308/* -------------------------------------------------------------------- */
309 int CPL_DLL CPLValidateXML(const char *pszXMLFilename,
310 const char *pszXSDFilename,
311 CSLConstList papszOptions);
312
313/* -------------------------------------------------------------------- */
314/* Locale handling. Prevents parallel executions of setlocale(). */
315/* -------------------------------------------------------------------- */
316 char *CPLsetlocale(int category, const char *locale);
318 void CPLCleanupSetlocaleMutex(void);
326 int CPL_DLL CPLIsPowerOfTwo(unsigned int i);
327
328 CPL_C_END
329
330/* -------------------------------------------------------------------- */
331/* C++ object for temporarily forcing a LC_NUMERIC locale to "C". */
332/* -------------------------------------------------------------------- */
333
335#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
336
337 extern "C++"
338{
339 class CPL_DLL CPLLocaleC
340 {
341 CPL_DISALLOW_COPY_ASSIGN(CPLLocaleC)
342 public:
343 CPLLocaleC();
344 ~CPLLocaleC();
345
346 private:
347 char *pszOldLocale;
348 };
349
350 // Does the same as CPLLocaleC except that, when available, it tries to
351 // only affect the current thread. But code that would be dependent of
352 // setlocale(LC_NUMERIC, NULL) returning "C", such as current proj.4
353 // versions, will not work depending on the actual implementation
354 class CPLThreadLocaleCPrivate;
355
356 class CPL_DLL CPLThreadLocaleC
357 {
358 CPL_DISALLOW_COPY_ASSIGN(CPLThreadLocaleC)
359
360 public:
361 CPLThreadLocaleC();
362 ~CPLThreadLocaleC();
363
364 private:
365 CPLThreadLocaleCPrivate *m_private;
366 };
367}
368
369#endif /* def __cplusplus */
371
372/* -------------------------------------------------------------------- */
373/* C++ object for temporarily forcing a config option */
374/* -------------------------------------------------------------------- */
375
377#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
378
379 extern "C++"
380{
381 class CPL_DLL CPLConfigOptionSetter
382 {
383 CPL_DISALLOW_COPY_ASSIGN(CPLConfigOptionSetter)
384 public:
385 CPLConfigOptionSetter(const char *pszKey, const char *pszValue,
386 bool bSetOnlyIfUndefined);
387 ~CPLConfigOptionSetter();
388
389 private:
390 char *m_pszKey;
391 char *m_pszOldValue;
392 bool m_bRestoreOldValue;
393 };
394}
395
396#endif /* def __cplusplus */
398
399#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
400
401 extern "C++"
402{
403
404#ifndef DOXYGEN_SKIP
405#include <type_traits> // for std::is_base_of
406#endif
407
408 namespace cpl
409 {
419 template <typename To, typename From> inline To down_cast(From *f)
420 {
421 static_assert(
422 (std::is_base_of<From,
423 typename std::remove_pointer<To>::type>::value),
424 "target type not derived from source type");
425 CPLAssert(f == nullptr || dynamic_cast<To>(f) != nullptr);
426 return static_cast<To>(f);
427 }
428 } // namespace cpl
429} // extern "C++"
430
431#endif /* def __cplusplus */
432
433#endif /* ndef CPL_CONV_H_INCLUDED */
CPLGetHomeDir
const char * CPLGetHomeDir(void)
Return the path to the home directory.
Definition cpl_path.cpp:1179
CPLExpandTilde
const char * CPLExpandTilde(const char *pszFilename)
Expands ~/ at start of filename.
Definition cpl_path.cpp:1151
CPLSetConfigOptionSubscriber
void(* CPLSetConfigOptionSubscriber)(const char *pszKey, const char *pszValue, bool bThreadLocal, void *pUserData)
Callback for CPLSubscribeToSetConfigOption()
Definition cpl_conv.h:66
CPLCreateZip
void * CPLCreateZip(const char *pszZipFilename, char **papszOptions)
Create ZIP file.
Definition cpl_conv.cpp:3423
CPLAtofDelim
double CPLAtofDelim(const char *, char)
Converts ASCII string to floating point number.
Definition cpl_strtod.cpp:74
CPLPrintStringFill
int CPLPrintStringFill(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition cpl_conv.cpp:1273
CPLGetSymbol
void * CPLGetSymbol(const char *, const char *)
Fetch a function pointer from a shared library / DLL.
Definition cplgetsymbol.cpp:87
CPLIsFilenameRelative
int CPLIsFilenameRelative(const char *pszFilename)
Is filename relative or absolute?
Definition cpl_path.cpp:824
CPLReadLine2L
const char * CPLReadLine2L(VSILFILE *, int, CSLConstList)
Simplified line reading from text file.
Definition cpl_conv.cpp:676
CPLPrintUIntBig
int CPLPrintUIntBig(char *, GUIntBig, int)
Print GUIntBig value into specified string buffer.
Definition cpl_conv.cpp:1356
CPLCopyTree
int CPLCopyTree(const char *pszNewPath, const char *pszOldPath)
Recursively copy a tree.
Definition cpl_conv.cpp:3043
CPLCloseShared
void CPLCloseShared(FILE *)
Close shared file.
Definition cpl_conv.cpp:2800
CPLStrtof
float CPLStrtof(const char *, char **)
Converts ASCII string to floating point number.
Definition cpl_strtod.cpp:545
CPLsetlocale
char * CPLsetlocale(int category, const char *locale)
Prevents parallel executions of setlocale().
Definition cpl_conv.cpp:3324
CPLReadLine3L
const char * CPLReadLine3L(VSILFILE *, int, int *, CSLConstList)
Simplified line reading from text file.
Definition cpl_conv.cpp:704
CPLStrtod
double CPLStrtod(const char *, char **)
Converts ASCII string to floating point number.
Definition cpl_strtod.cpp:437
CPLGetExtension
const char * CPLGetExtension(const char *)
Extract filename extension from full filename.
Definition cpl_path.cpp:365
CPLLoadConfigOptionsFromFile
void CPLLoadConfigOptionsFromFile(const char *pszFilename, int bOverrideEnvVars)
Load configuration from a given configuration file.
Definition cpl_conv.cpp:2162
CPLMoveFile
int CPLMoveFile(const char *pszNewPath, const char *pszOldPath)
Move a file.
Definition cpl_conv.cpp:3118
CPLGetThreadLocalConfigOptions
char ** CPLGetThreadLocalConfigOptions(void)
Return the list of thread local configuration options as KEY=VALUE pairs.
Definition cpl_conv.cpp:2041
CPLPrintInt32
int CPLPrintInt32(char *, GInt32, int)
Print GInt32 value into specified string buffer.
Definition cpl_conv.cpp:1317
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:933
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:1770
CPLRealloc
void * CPLRealloc(void *, size_t)
Safe version of realloc().
Definition cpl_conv.cpp:242
CPLFileFinder
char const *(* CPLFileFinder)(const char *, const char *)
Callback for CPLPushFileFinder.
Definition cpl_conv.h:212
CPLStrtofDelim
float CPLStrtofDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition cpl_strtod.cpp:501
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:3459
CPLSymlink
int CPLSymlink(const char *pszOldPath, const char *pszNewPath, CSLConstList papszOptions)
Create a symbolic link.
Definition cpl_conv.cpp:3142
CPLGetBasename
const char * CPLGetBasename(const char *)
Extract basename (non-directory, non-extension) portion of filename.
Definition cpl_path.cpp:311
CPLLaunderForFilename
const char * CPLLaunderForFilename(const char *pszName, const char *pszOutputPath)
Launder a string to be compatible of a filename.
Definition cpl_path.cpp:1204
CPLMalloc
void * CPLMalloc(size_t)
Safe version of malloc().
Definition cpl_conv.cpp:187
CPLGetDirname
const char * CPLGetDirname(const char *)
Extract directory path portion of filename.
Definition cpl_path.cpp:213
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
CPLGetExecPath
int CPLGetExecPath(char *pszPathBuf, int nMaxLength)
Fetch path of executable.
Definition cpl_getexecpath.cpp:67
CPLFormCIFilename
const char * CPLFormCIFilename(const char *pszPath, const char *pszBasename, const char *pszExtension)
Case insensitive file searching, returning full path.
Definition cpl_path.cpp:678
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:873
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:1506
CPLFinderClean
void CPLFinderClean(void)
CPLFinderClean.
Definition cpl_findfile.cpp:133
CPLCalloc
void * CPLCalloc(size_t, size_t)
Safe version of calloc().
Definition cpl_conv.cpp:157
CPLAtoGIntBigEx
GIntBig CPLAtoGIntBigEx(const char *pszString, int bWarn, int *pbOverflow)
Convert a string to a 64 bit signed integer.
Definition cpl_conv.cpp:1063
CPLScanPointer
void * CPLScanPointer(const char *, int)
Extract pointer from string.
Definition cpl_conv.cpp:1111
CPLGenerateTempFilename
const char * CPLGenerateTempFilename(const char *pszStem)
Generate temporary file name.
Definition cpl_path.cpp:1110
CPLGetPath
const char * CPLGetPath(const char *)
Extract directory path portion of filename.
Definition cpl_path.cpp:144
CPLCorrespondingPaths
char ** CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename, char **papszFileList)
Identify corresponding paths.
Definition cpl_path.cpp:1006
CPLStrdup
char * CPLStrdup(const char *)
Safe version of strdup() function.
Definition cpl_conv.cpp:310
CPLCreateFileInZip
CPLErr CPLCreateFileInZip(void *hZip, const char *pszFilename, char **papszOptions)
Create a file in a ZIP file.
Definition cpl_conv.cpp:3431
CPLLoadConfigOptionsFromPredefinedFiles
void CPLLoadConfigOptionsFromPredefinedFiles(void)
Load configuration from a set of predefined files.
Definition cpl_conv.cpp:2358
CPLGetConfigOptions
char ** CPLGetConfigOptions(void)
Return the list of configuration options as KEY=VALUE pairs.
Definition cpl_conv.cpp:1744
CPLStrtodM
double CPLStrtodM(const char *, char **)
Converts ASCII string to floating point number.
Definition cpl_strtod.cpp:464
CPLDMSToDec
double CPLDMSToDec(const char *is)
CPLDMSToDec.
Definition cpl_conv.cpp:2442
CPLCleanTrailingSlash
const char * CPLCleanTrailingSlash(const char *)
Remove trailing forward/backward slash from the path for UNIX/Windows resp.
Definition cpl_path.cpp:956
CPLReadLineL
const char * CPLReadLineL(VSILFILE *)
Simplified line reading from text file.
Definition cpl_conv.cpp:651
CPLReadLine
const char * CPLReadLine(FILE *)
Simplified line reading from text file.
Definition cpl_conv.cpp:583
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
CPLCloseZip
CPLErr CPLCloseZip(void *hZip)
Close ZIP file.
Definition cpl_conv.cpp:3446
CPLGetGlobalConfigOption
const char * CPLGetGlobalConfigOption(const char *, const char *)
Same as CPLGetConfigOption() but excludes environment variables and options set with CPLSetThreadLoca...
Definition cpl_conv.cpp:1815
CPLResetExtension
const char * CPLResetExtension(const char *, const char *)
Replace the extension with the provided one.
Definition cpl_path.cpp:466
CPLOpenShared
FILE * CPLOpenShared(const char *, const char *, int)
Open a shared file handle.
Definition cpl_conv.cpp:2728
CPLPushFinderLocation
void CPLPushFinderLocation(const char *)
CPLPushFinderLocation.
Definition cpl_findfile.cpp:251
CPLGetCurrentDir
char * CPLGetCurrentDir(void)
Get the current working directory name.
Definition cpl_path.cpp:445
CPLPushFileFinder
void CPLPushFileFinder(CPLFileFinder pfnFinder)
CPLPushFileFinder.
Definition cpl_findfile.cpp:203
CPLStat
int CPLStat(const char *, VSIStatBuf *)
Same as VSIStat() except it works on "C:" as if it were "C:\".
Definition cpl_conv.cpp:2393
CPLUnsubscribeToSetConfigOption
void CPLUnsubscribeToSetConfigOption(int nSubscriberId)
Remove a subscriber installed with CPLSubscribeToSetConfigOption()
Definition cpl_conv.cpp:1879
CPLDecToPackedDMS
double CPLDecToPackedDMS(double dfDec)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition cpl_conv.cpp:2651
CPLExtractRelativePath
const char * CPLExtractRelativePath(const char *, const char *, int *)
Get relative path from directory to target file.
Definition cpl_path.cpp:866
CPLGetThreadLocalConfigOption
const char * CPLGetThreadLocalConfigOption(const char *, const char *)
Same as CPLGetConfigOption() but only with options set with CPLSetThreadLocalConfigOption()
Definition cpl_conv.cpp:1784
CPLPopFinderLocation
void CPLPopFinderLocation(void)
CPLPopFinderLocation.
Definition cpl_findfile.cpp:290
CPLAtofM
double CPLAtofM(const char *)
Converts ASCII string to floating point number using any numeric locale.
Definition cpl_strtod.cpp:143
CPLSetConfigOption
void CPLSetConfigOption(const char *, const char *)
Set a configuration option for GDAL/OGR use.
Definition cpl_conv.cpp:1946
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:382
CPLAtoGIntBig
GIntBig CPLAtoGIntBig(const char *pszString)
Convert a string to a 64 bit signed integer.
Definition cpl_conv.cpp:1017
CPLPackedDMSToDec
double CPLPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition cpl_conv.cpp:2617
CPLDumpSharedList
void CPLDumpSharedList(FILE *)
Report open shared files.
Definition cpl_conv.cpp:2913
CPLUnlinkTree
int CPLUnlinkTree(const char *)
Recursively unlink a directory.
Definition cpl_conv.cpp:2947
CPLSubscribeToSetConfigOption
int CPLSubscribeToSetConfigOption(CPLSetConfigOptionSubscriber pfnCallback, void *pUserData)
Install a callback that will be notified of calls to CPLSetConfigOption()/ CPLSetThreadLocalConfigOpt...
Definition cpl_conv.cpp:1847
CPLProjectRelativeFilename
const char * CPLProjectRelativeFilename(const char *pszProjectDir, const char *pszSecondaryFilename)
Find a file relative to a project file.
Definition cpl_path.cpp:769
CPLScanUIntBig
GUIntBig CPLScanUIntBig(const char *, int)
Extract big integer from string.
Definition cpl_conv.cpp:991
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:2527
CPLFindFile
const char * CPLFindFile(const char *pszClass, const char *pszBasename)
CPLFindFile.
Definition cpl_findfile.cpp:180
CPLScanDouble
double CPLScanDouble(const char *, int)
Extract double from string.
Definition cpl_conv.cpp:1177
CPLIsPowerOfTwo
int CPLIsPowerOfTwo(unsigned int i)
Definition cpl_conv.cpp:3350
CPLGetConfigOption
const char * CPLGetConfigOption(const char *, const char *)
Get the value of a configuration option.
Definition cpl_conv.cpp:1696
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:961
CPLSetThreadLocalConfigOption
void CPLSetThreadLocalConfigOption(const char *pszKey, const char *pszValue)
Set a configuration option for GDAL/OGR use.
Definition cpl_conv.cpp:2000
CPLStrtodDelim
double CPLStrtodDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition cpl_strtod.cpp:234
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:419
CPLGetFilename
const char * CPLGetFilename(const char *)
Extract non-directory portion of filename.
Definition cpl_path.cpp:279
CPLStrlwr
char * CPLStrlwr(char *)
Convert each characters of the string to lower case.
Definition cpl_conv.cpp:336
CPLCopyFile
int CPLCopyFile(const char *pszNewPath, const char *pszOldPath)
Copy a file.
Definition cpl_conv.cpp:3030
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:545
CPLPrintDouble
int CPLPrintDouble(char *, const char *, double, const char *)
Print double value into specified string buffer.
Definition cpl_conv.cpp:1448
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:3451
CPLPrintString
int CPLPrintString(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition cpl_conv.cpp:1229
CPLCloseFileInZip
CPLErr CPLCloseFileInZip(void *hZip)
Close current file inside ZIP file.
Definition cpl_conv.cpp:3441
CPLDefaultFindFile
const char * CPLDefaultFindFile(const char *pszClass, const char *pszBasename)
CPLDefaultFindFile.
Definition cpl_findfile.cpp:148
CPLWriteFileInZip
CPLErr CPLWriteFileInZip(void *hZip, const void *pBuffer, int nBufferSize)
Write in current file inside a ZIP file.
Definition cpl_conv.cpp:3436
CPLPopFileFinder
CPLFileFinder CPLPopFileFinder(void)
CPLPopFileFinder.
Definition cpl_findfile.cpp:240
CPLPrintPointer
int CPLPrintPointer(char *, void *, int)
Print pointer value into specified string buffer.
Definition cpl_conv.cpp:1404
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:2668
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:2071
CPLZLibInflateEx
void * CPLZLibInflateEx(const void *ptr, size_t nBytes, void *outptr, size_t nOutAvailableBytes, bool bAllowResizeOutptr, size_t *pnOutBytes)
Uncompress a buffer compressed with ZLib compression.
Definition cpl_vsil_gzip.cpp:5039
CPLCheckForFile
int CPLCheckForFile(char *pszFilename, char **papszSiblingList)
Check for file existence.
Definition cpl_conv.cpp:3385
CPLGetSharedList
CPLSharedFileInfo * CPLGetSharedList(int *)
Fetch list of open shared files.
Definition cpl_conv.cpp:2891
CPLAtof
double CPLAtof(const char *)
Converts ASCII string to floating point number.
Definition cpl_strtod.cpp:118
cpl_error.h
CPL error handling services.
CPLAssert
#define CPLAssert(expr)
Assert on an expression.
Definition cpl_error.h:216
CPLErr
CPLErr
Error category.
Definition cpl_error.h:53
cpl_port.h
Core portability definitions for CPL.
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition cpl_port.h:218
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition cpl_port.h:299
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition cpl_port.h:295
CPL_RETURNS_NONNULL
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition cpl_port.h:1014
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
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition cpl_port.h:1183
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
GInt32
int GInt32
Int32 type.
Definition cpl_port.h:175
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition cpl_port.h:215
cpl_vsi.h
Standard C Covers.
CPLSharedFileInfo
Information on a shared file.
Definition cpl_conv.h:235
CPLSharedFileInfo::pszAccess
char * pszAccess
Access mode.
Definition cpl_conv.h:240
CPLSharedFileInfo::fp
FILE * fp
File pointer.
Definition cpl_conv.h:236
CPLSharedFileInfo::nRefCount
int nRefCount
Reference counter.
Definition cpl_conv.h:237
CPLSharedFileInfo::pszFilename
char * pszFilename
Filename.
Definition cpl_conv.h:239
CPLSharedFileInfo::bLarge
int bLarge
Whether fp must be interpreted as VSIFILE*.
Definition cpl_conv.h:238
VSIVirtualHandle
Virtual file handle.
Definition cpl_vsi_virtual.h:63