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
56 CPLGetConfigOption( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
57 const char CPL_DLL * CPL_STDCALL
58 CPLGetThreadLocalConfigOption( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
59 void CPL_DLL CPL_STDCALL CPLSetConfigOption( const char *, const char * );
60 void CPL_DLL CPL_STDCALL CPLSetThreadLocalConfigOption( const char *pszKey,
61 const char *pszValue );
63 void CPL_DLL CPL_STDCALL CPLFreeConfig(void);
65 char CPL_DLL** CPLGetConfigOptions(void);
66 void CPL_DLL CPLSetConfigOptions(const char* const * papszConfigOptions);
67 char CPL_DLL** CPLGetThreadLocalConfigOptions(void);
68 void CPL_DLL CPLSetThreadLocalConfigOptions(const char* const * papszConfigOptions);
69 void CPL_DLL CPLLoadConfigOptionsFromFile(const char* pszFilename, int bOverrideEnvVars);
70 void CPL_DLL CPLLoadConfigOptionsFromPredefinedFiles(void);
71
72 /* -------------------------------------------------------------------- */
73 /* Safe malloc() API. Thin cover over VSI functions with fatal */
74 /* error reporting if memory allocation fails. */
75 /* -------------------------------------------------------------------- */
76 void CPL_DLL *CPLMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
77 void CPL_DLL *CPLCalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
78 void CPL_DLL *CPLRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
79 char CPL_DLL *CPLStrdup( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
80 char CPL_DLL *CPLStrlwr( char *);
81
83 #define CPLFree VSIFree
84
85 /* -------------------------------------------------------------------- */
86 /* Read a line from a text file, and strip of CR/LF. */
87 /* -------------------------------------------------------------------- */
88 char CPL_DLL *CPLFGets( char *, int, FILE *);
89 const char CPL_DLL *CPLReadLine( FILE * );
90 const char CPL_DLL *CPLReadLineL( VSILFILE * );
91 const char CPL_DLL *CPLReadLine2L( VSILFILE *, int, CSLConstList );
92 const char CPL_DLL *CPLReadLine3L( VSILFILE *, int, int *, CSLConstList );
93
94 /* -------------------------------------------------------------------- */
95 /* Convert ASCII string to floating point number */
96 /* (THESE FUNCTIONS ARE NOT LOCALE AWARE!). */
97 /* -------------------------------------------------------------------- */
98 double CPL_DLL CPLAtof(const char *);
99 double CPL_DLL CPLAtofDelim(const char *, char);
100 double CPL_DLL CPLStrtod(const char *, char **);
101 double CPL_DLL CPLStrtodDelim(const char *, char **, char);
102 float CPL_DLL CPLStrtof(const char *, char **);
103 float CPL_DLL CPLStrtofDelim(const char *, char **, char);
104
105 /* -------------------------------------------------------------------- */
106 /* Convert number to string. This function is locale agnostic */
107 /* (i.e. it will support "," or "." regardless of current locale) */
108 /* -------------------------------------------------------------------- */
109 double CPL_DLL CPLAtofM(const char *);
110
111 /* -------------------------------------------------------------------- */
112 /* Read a numeric value from an ASCII character string. */
113 /* -------------------------------------------------------------------- */
114 char CPL_DLL *CPLScanString( const char *, int, int, int );
115 double CPL_DLL CPLScanDouble( const char *, int );
116 long CPL_DLL CPLScanLong( const char *, int );
117 unsigned long CPL_DLL CPLScanULong( const char *, int );
118 GUIntBig CPL_DLL CPLScanUIntBig( const char *, int );
119 GIntBig CPL_DLL CPLAtoGIntBig( const char* pszString );
120 GIntBig CPL_DLL CPLAtoGIntBigEx( const char* pszString, int bWarn, int *pbOverflow );
121 void CPL_DLL *CPLScanPointer( const char *, int );
122
123 /* -------------------------------------------------------------------- */
124 /* Print a value to an ASCII character string. */
125 /* -------------------------------------------------------------------- */
126 int CPL_DLL CPLPrintString( char *, const char *, int );
127 int CPL_DLL CPLPrintStringFill( char *, const char *, int );
128 int CPL_DLL CPLPrintInt32( char *, GInt32 , int );
129 int CPL_DLL CPLPrintUIntBig( char *, GUIntBig , int );
130 int CPL_DLL CPLPrintDouble( char *, const char *, double, const char * );
131 int CPL_DLL CPLPrintTime( char *, int , const char *, const struct tm *,
132 const char * );
133 int CPL_DLL CPLPrintPointer( char *, void *, int );
134
135 /* -------------------------------------------------------------------- */
136 /* Fetch a function from DLL / so. */
137 /* -------------------------------------------------------------------- */
138
139 void CPL_DLL *CPLGetSymbol( const char *, const char * );
140
141 /* -------------------------------------------------------------------- */
142 /* Fetch executable path. */
143 /* -------------------------------------------------------------------- */
144 int CPL_DLL CPLGetExecPath( char *pszPathBuf, int nMaxLength );
145
146 /* -------------------------------------------------------------------- */
147 /* Filename handling functions. */
148 /* -------------------------------------------------------------------- */
149 const char CPL_DLL *CPLGetPath( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
150 const char CPL_DLL *CPLGetDirname( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
151 const char CPL_DLL *CPLGetFilename( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
152 const char CPL_DLL *CPLGetBasename( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
153 const char CPL_DLL *CPLGetExtension( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
154 char CPL_DLL *CPLGetCurrentDir(void);
155 const char CPL_DLL *CPLFormFilename( const char *pszPath,
156 const char *pszBasename,
157 const char *pszExtension ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
158 const char CPL_DLL *CPLFormCIFilename( const char *pszPath,
159 const char *pszBasename,
160 const char *pszExtension ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
161 const char CPL_DLL *CPLResetExtension( const char *, const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
162 const char CPL_DLL *CPLProjectRelativeFilename( const char *pszProjectDir,
163 const char *pszSecondaryFilename ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
164 int CPL_DLL CPLIsFilenameRelative( const char *pszFilename );
165 const char CPL_DLL *CPLExtractRelativePath(const char *, const char *, int *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
166 const char CPL_DLL *CPLCleanTrailingSlash( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
167 char CPL_DLL **CPLCorrespondingPaths( const char *pszOldFilename,
168 const char *pszNewFilename,
169 char **papszFileList ) CPL_WARN_UNUSED_RESULT;
170 int CPL_DLL CPLCheckForFile( char *pszFilename, char **papszSiblingList );
171
172 const char CPL_DLL *CPLGenerateTempFilename( const char *pszStem ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
173 const char CPL_DLL *CPLExpandTilde( const char *pszFilename ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
174 const char CPL_DLL *CPLGetHomeDir(void) CPL_WARN_UNUSED_RESULT;
175 const char CPL_DLL *CPLLaunderForFilename(const char* pszName,
176 const char* pszOutputPath ) CPL_WARN_UNUSED_RESULT;
177
178 /* -------------------------------------------------------------------- */
179 /* Find File Function */
180 /* -------------------------------------------------------------------- */
181
183 typedef char const *(*CPLFileFinder)(const char *, const char *);
184
185 const char CPL_DLL *CPLFindFile(const char *pszClass,
186 const char *pszBasename);
187 const char CPL_DLL *CPLDefaultFindFile(const char *pszClass,
188 const char *pszBasename);
189 void CPL_DLL CPLPushFileFinder( CPLFileFinder pfnFinder );
190 CPLFileFinder CPL_DLL CPLPopFileFinder(void);
191 void CPL_DLL CPLPushFinderLocation( const char * );
192 void CPL_DLL CPLPopFinderLocation(void);
193 void CPL_DLL CPLFinderClean(void);
194
195 /* -------------------------------------------------------------------- */
196 /* Safe version of stat() that works properly on stuff like "C:". */
197 /* -------------------------------------------------------------------- */
198 int CPL_DLL CPLStat( const char *, VSIStatBuf * ) CPL_WARN_UNUSED_RESULT;
199
200 /* -------------------------------------------------------------------- */
201 /* Reference counted file handle manager. Makes sharing file */
202 /* handles more practical. */
203 /* -------------------------------------------------------------------- */
204
206 typedef struct {
207 FILE *fp;
208 int nRefCount;
209 int bLarge;
210 char *pszFilename;
211 char *pszAccess;
212 } CPLSharedFileInfo;
213
214 FILE CPL_DLL *CPLOpenShared( const char *, const char *, int );
215 void CPL_DLL CPLCloseShared( FILE * );
216 CPLSharedFileInfo CPL_DLL *CPLGetSharedList( int * );
217 void CPL_DLL CPLDumpSharedList( FILE * );
219 void CPL_DLL CPLCleanupSharedFileMutex( void );
222 /* -------------------------------------------------------------------- */
223 /* DMS to Dec to DMS conversion. */
224 /* -------------------------------------------------------------------- */
225 double CPL_DLL CPLDMSToDec( const char *is );
226 const char CPL_DLL *CPLDecToDMS( double dfAngle, const char * pszAxis,
227 int nPrecision );
228 double CPL_DLL CPLPackedDMSToDec( double );
229 double CPL_DLL CPLDecToPackedDMS( double dfDec );
230
231 void CPL_DLL CPLStringToComplex( const char *pszString,
232 double *pdfReal, double *pdfImag );
233
234 /* -------------------------------------------------------------------- */
235 /* Misc other functions. */
236 /* -------------------------------------------------------------------- */
237 int CPL_DLL CPLUnlinkTree( const char * );
238 int CPL_DLL CPLCopyFile( const char *pszNewPath, const char *pszOldPath );
239 int CPL_DLL CPLCopyTree( const char *pszNewPath, const char *pszOldPath );
240 int CPL_DLL CPLMoveFile( const char *pszNewPath, const char *pszOldPath );
241 int CPL_DLL CPLSymlink( const char* pszOldPath, const char* pszNewPath, CSLConstList papszOptions );
242
243 /* -------------------------------------------------------------------- */
244 /* ZIP Creation. */
245 /* -------------------------------------------------------------------- */
246
248 #define CPL_ZIP_API_OFFERED
249
250 void CPL_DLL *CPLCreateZip( const char *pszZipFilename, char **papszOptions );
251 CPLErr CPL_DLL CPLCreateFileInZip( void *hZip, const char *pszFilename,
252 char **papszOptions );
253 CPLErr CPL_DLL CPLWriteFileInZip( void *hZip, const void *pBuffer, int nBufferSize );
254 CPLErr CPL_DLL CPLCloseFileInZip( void *hZip );
255 CPLErr CPL_DLL CPLCloseZip( void *hZip );
256
257 /* -------------------------------------------------------------------- */
258 /* ZLib compression */
259 /* -------------------------------------------------------------------- */
260
261 void CPL_DLL *CPLZLibDeflate( const void* ptr, size_t nBytes, int nLevel,
262 void* outptr, size_t nOutAvailableBytes,
263 size_t* pnOutBytes );
264 void CPL_DLL *CPLZLibInflate( const void* ptr, size_t nBytes,
265 void* outptr, size_t nOutAvailableBytes,
266 size_t* pnOutBytes );
267
268 /* -------------------------------------------------------------------- */
269 /* XML validation. */
270 /* -------------------------------------------------------------------- */
271 int CPL_DLL CPLValidateXML(const char* pszXMLFilename,
272 const char* pszXSDFilename,
273 CSLConstList papszOptions);
274
275 /* -------------------------------------------------------------------- */
276 /* Locale handling. Prevents parallel executions of setlocale(). */
277 /* -------------------------------------------------------------------- */
278 char* CPLsetlocale (int category, const char* locale);
280 void CPLCleanupSetlocaleMutex(void);
288 int CPL_DLL CPLIsPowerOfTwo( unsigned int i );
289
290 CPL_C_END
291
292 /* -------------------------------------------------------------------- */
293 /* C++ object for temporarily forcing a LC_NUMERIC locale to "C". */
294 /* -------------------------------------------------------------------- */
295
297 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
298
299 extern "C++"
300 {
301 class CPL_DLL CPLLocaleC
302 {
303 CPL_DISALLOW_COPY_ASSIGN(CPLLocaleC)
304 public:
305 CPLLocaleC();
306 ~CPLLocaleC();
307
308 private:
309 char *pszOldLocale;
310 };
311
312 // Does the same as CPLLocaleC except that, when available, it tries to
313 // only affect the current thread. But code that would be dependent of
314 // setlocale(LC_NUMERIC, NULL) returning "C", such as current proj.4 versions,
315 // will not work depending on the actual implementation
316 class CPLThreadLocaleCPrivate;
317 class CPL_DLL CPLThreadLocaleC
318 {
319 CPL_DISALLOW_COPY_ASSIGN(CPLThreadLocaleC)
320
321 public:
322 CPLThreadLocaleC();
323 ~CPLThreadLocaleC();
324
325 private:
326 CPLThreadLocaleCPrivate* m_private;
327 };
328 }
329
330 #endif /* def __cplusplus */
331
333
334
335 /* -------------------------------------------------------------------- */
336 /* C++ object for temporarily forcing a config option */
337 /* -------------------------------------------------------------------- */
338
340 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
341
342 extern "C++"
343 {
344 class CPL_DLL CPLConfigOptionSetter
345 {
346 CPL_DISALLOW_COPY_ASSIGN(CPLConfigOptionSetter)
347 public:
348 CPLConfigOptionSetter(const char* pszKey, const char* pszValue,
349 bool bSetOnlyIfUndefined);
350 ~CPLConfigOptionSetter();
351
352 private:
353 char* m_pszKey;
354 char *m_pszOldValue;
355 bool m_bRestoreOldValue;
356 };
357 }
358
359 #endif /* def __cplusplus */
360
362 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
363
364 extern "C++"
365 {
366
367 #ifndef DOXYGEN_SKIP
368 #include <type_traits> // for std::is_base_of
369 #endif
370
371 namespace cpl
372 {
382 template<typename To, typename From> inline To down_cast(From* f)
383 {
384 static_assert(
385 (std::is_base_of<From,
386 typename std::remove_pointer<To>::type>::value),
387 "target type not derived from source type");
388 CPLAssert(f == nullptr || dynamic_cast<To>(f) != nullptr);
389 return static_cast<To>(f);
390 }
391 }
392 } // extern "C++"
393
394 #endif /* def __cplusplus */
395
396
397 #if defined(__cplusplus) && defined(GDAL_COMPILATION)
398
399 extern "C++"
400 {
401 #include <memory> // for std::unique_ptr
402 namespace cpl
403 {
405 template <typename T, typename... Args>
406 std::unique_ptr<T> make_unique(Args &&... args) {
407 return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
408 }
409 }
410 } // extern "C++"
411
412 #endif /* def __cplusplus */
413
414 #endif /* ndef CPL_CONV_H_INCLUDED */
CPLPopFinderLocation
void CPLPopFinderLocation(void)
CPLPopFinderLocation.
Definition: cpl_findfile.cpp:287
CPLStrtodDelim
double CPLStrtodDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:234
CPLValidateXML
int CPLValidateXML(const char *pszXMLFilename, const char *pszXSDFilename, CSLConstList papszOptions)
Validate a XML file against a XML schema.
Definition: cpl_xml_validate.cpp:1073
CPLReadLineL
const char * CPLReadLineL(VSILFILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:635
CPLGenerateTempFilename
const char * CPLGenerateTempFilename(const char *pszStem)
Generate temporary file name.
Definition: cpl_path.cpp:1108
CPLLoadConfigOptionsFromFile
void CPLLoadConfigOptionsFromFile(const char *pszFilename, int bOverrideEnvVars)
Load configuration from a given configuration file.
Definition: cpl_conv.cpp:2038
CPLIsPowerOfTwo
int CPLIsPowerOfTwo(unsigned int i)
Definition: cpl_conv.cpp:3168
CPLGetSymbol
void * CPLGetSymbol(const char *, const char *)
Fetch a function pointer from a shared library / DLL.
Definition: cplgetsymbol.cpp:89
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:851
CPLPrintStringFill
int CPLPrintStringFill(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition: cpl_conv.cpp:1274
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:952
CPLGetExecPath
int CPLGetExecPath(char *pszPathBuf, int nMaxLength)
Fetch path of executable.
Definition: cpl_getexecpath.cpp:132
CPLFindFile
const char * CPLFindFile(const char *pszClass, const char *pszBasename)
CPLFindFile.
Definition: cpl_findfile.cpp:177
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:1509
CPLDMSToDec
double CPLDMSToDec(const char *is)
CPLDMSToDec.
Definition: cpl_conv.cpp:2197
CPLExtractRelativePath
const char * CPLExtractRelativePath(const char *, const char *, int *)
Get relative path from directory to target file.
Definition: cpl_path.cpp:860
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:3266
CPLPrintUIntBig
int CPLPrintUIntBig(char *, GUIntBig, int)
Print GUIntBig value into specified string buffer.
Definition: cpl_conv.cpp:1357
CPLCalloc
void * CPLCalloc(size_t, size_t)
Safe version of calloc().
Definition: cpl_conv.cpp:143
CPLCopyFile
int CPLCopyFile(const char *pszNewPath, const char *pszOldPath)
Copy a file.
Definition: cpl_conv.cpp:2794
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:1772
CPLCloseZip
CPLErr CPLCloseZip(void *hZip)
Close ZIP file.
Definition: cpl_conv.cpp:3255
CPLScanPointer
void * CPLScanPointer(const char *, int)
Extract pointer from string.
Definition: cpl_conv.cpp:1112
cpl_vsi.h
CPLPushFinderLocation
void CPLPushFinderLocation(const char *)
CPLPushFinderLocation.
Definition: cpl_findfile.cpp:248
CPLPackedDMSToDec
double CPLPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition: cpl_conv.cpp:2372
CPLAtoGIntBig
GIntBig CPLAtoGIntBig(const char *pszString)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1003
CPLSharedFileInfo::bLarge
int bLarge
Whether fp must be interpreted as VSIFILE*.
Definition: cpl_conv.h:209
CPLDumpSharedList
void CPLDumpSharedList(FILE *)
Report open shared files.
Definition: cpl_conv.cpp:2671
CPLGetSharedList
CPLSharedFileInfo * CPLGetSharedList(int *)
Fetch list of open shared files.
Definition: cpl_conv.cpp:2649
CPLResetExtension
const char * CPLResetExtension(const char *, const char *)
Replace the extension with the provided one.
Definition: cpl_path.cpp:431
CPLSharedFileInfo
Information on a shared file.
Definition: cpl_conv.h:206
CPLRealloc
void * CPLRealloc(void *, size_t)
Safe version of realloc().
Definition: cpl_conv.cpp:230
CPLAtofM
double CPLAtofM(const char *)
Converts ASCII string to floating point number using any numeric locale.
Definition: cpl_strtod.cpp:142
CPLGetPath
const char * CPLGetPath(const char *)
Extract directory path portion of filename.
Definition: cpl_path.cpp:153
CPLCloseFileInZip
CPLErr CPLCloseFileInZip(void *hZip)
Close current file inside ZIP file.
Definition: cpl_conv.cpp:3253
CPLFinderClean
void CPLFinderClean(void)
CPLFinderClean.
Definition: cpl_findfile.cpp:134
CPLGetThreadLocalConfigOption
const char * CPLGetThreadLocalConfigOption(const char *, const char *)
Same as CPLGetConfigOption() but only with options set with CPLSetThreadLocalConfigOption()
Definition: cpl_conv.cpp:1787
CPLDefaultFindFile
const char * CPLDefaultFindFile(const char *pszClass, const char *pszBasename)
CPLDefaultFindFile.
Definition: cpl_findfile.cpp:149
CPLAssert
#define CPLAssert(expr)
Assert on an expression.
Definition: cpl_error.h:198
CPLAtoGIntBigEx
GIntBig CPLAtoGIntBigEx(const char *pszString, int bWarn, int *pbOverflow)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1055
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:329
CPLOpenShared
FILE * CPLOpenShared(const char *, const char *, int)
Open a shared file handle.
Definition: cpl_conv.cpp:2485
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:3257
CPLCheckForFile
int CPLCheckForFile(char *pszFilename, char **papszSiblingList)
Check for file existence.
Definition: cpl_conv.cpp:3203
CPLGetCurrentDir
char * CPLGetCurrentDir(void)
Get the current working directory name.
Definition: cpl_path.cpp:396
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:369
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1169
CPLCloseShared
void CPLCloseShared(FILE *)
Close shared file.
Definition: cpl_conv.cpp:2558
CPLGetDirname
const char * CPLGetDirname(const char *)
Extract directory path portion of filename.
Definition: cpl_path.cpp:208
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:247
CPLCreateZip
void * CPLCreateZip(const char *pszZipFilename, char **papszOptions)
Create ZIP file.
Definition: cpl_conv.cpp:3241
CPLReadLine3L
const char * CPLReadLine3L(VSILFILE *, int, int *, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:687
CPLGetConfigOptions
char ** CPLGetConfigOptions(void)
Return the list of configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1746
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:331
CPLPrintString
int CPLPrintString(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition: cpl_conv.cpp:1230
CPLIsFilenameRelative
int CPLIsFilenameRelative(const char *pszFilename)
Is filename relative or absolute?
Definition: cpl_path.cpp:817
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:538
CPLProjectRelativeFilename
const char * CPLProjectRelativeFilename(const char *pszProjectDir, const char *pszSecondaryFilename)
Find a file relative to a project file.
Definition: cpl_path.cpp:751
CPLMalloc
void * CPLMalloc(size_t)
Safe version of malloc().
Definition: cpl_conv.cpp:173
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:183
CPLFormCIFilename
const char * CPLFormCIFilename(const char *pszPath, const char *pszBasename, const char *pszExtension)
Case insensitive file searching, returning full path.
Definition: cpl_path.cpp:658
CPLMoveFile
int CPLMoveFile(const char *pszNewPath, const char *pszOldPath)
Move a file.
Definition: cpl_conv.cpp:2934
CPLStrtof
float CPLStrtof(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:403
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:1975
CPLCorrespondingPaths
char ** CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename, char **papszFileList)
Identify corresponding paths.
Definition: cpl_path.cpp:1003
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:939
CPLSetConfigOption
void CPLSetConfigOption(const char *, const char *)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1851
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:382
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:2279
CPLUnlinkTree
int CPLUnlinkTree(const char *)
Recursively unlink a directory.
Definition: cpl_conv.cpp:2709
CPLCopyTree
int CPLCopyTree(const char *pszNewPath, const char *pszOldPath)
Recursively copy a tree.
Definition: cpl_conv.cpp:2856
CPLSharedFileInfo::pszAccess
char * pszAccess
Access mode.
Definition: cpl_conv.h:211
CPLWriteFileInZip
CPLErr CPLWriteFileInZip(void *hZip, const void *pBuffer, int nBufferSize)
Write in current file inside a ZIP file.
Definition: cpl_conv.cpp:3251
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:244
CPLLoadConfigOptionsFromPredefinedFiles
void CPLLoadConfigOptionsFromPredefinedFiles(void)
Load configuration from a set of predefined files.
Definition: cpl_conv.cpp:2113
CPLsetlocale
char * CPLsetlocale(int category, const char *locale)
Prevents parallel executions of setlocale().
Definition: cpl_conv.cpp:3142
CPLSymlink
int CPLSymlink(const char *pszOldPath, const char *pszNewPath, CSLConstList papszOptions)
Create a symbolic link.
Definition: cpl_conv.cpp:2955
CPLStat
int CPLStat(const char *, VSIStatBuf *)
Same as VSIStat() except it works on "C:" as if it were "C:\".
Definition: cpl_conv.cpp:2148
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:894
CPLExpandTilde
const char * CPLExpandTilde(const char *pszFilename)
Expands ~/ at start of filename.
Definition: cpl_path.cpp:1151
CPLDecToPackedDMS
double CPLDecToPackedDMS(double dfDec)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition: cpl_conv.cpp:2406
cpl_port.h
CPLReadLine
const char * CPLReadLine(FILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:571
CPLPrintDouble
int CPLPrintDouble(char *, const char *, double, const char *)
Print double value into specified string buffer.
Definition: cpl_conv.cpp:1451
CPLSharedFileInfo::pszFilename
char * pszFilename
Filename.
Definition: cpl_conv.h:210
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:1407
CPLStrdup
char * CPLStrdup(const char *)
Safe version of strdup() function.
Definition: cpl_conv.cpp:298
CPLAtof
double CPLAtof(const char *)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:117
CPLPopFileFinder
CPLFileFinder CPLPopFileFinder(void)
CPLPopFileFinder.
Definition: cpl_findfile.cpp:237
CPLScanUIntBig
GUIntBig CPLScanUIntBig(const char *, int)
Extract big integer from string.
Definition: cpl_conv.cpp:969
CPLReadLine2L
const char * CPLReadLine2L(VSILFILE *, int, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:657
CPLCreateFileInZip
CPLErr CPLCreateFileInZip(void *hZip, const char *pszFilename, char **papszOptions)
Create a file in a ZIP file.
Definition: cpl_conv.cpp:3249
CPLGetHomeDir
const char * CPLGetHomeDir(void)
Return the path to the home directory.
Definition: cpl_path.cpp:1179
CPLPrintInt32
int CPLPrintInt32(char *, GInt32, int)
Print GInt32 value into specified string buffer.
Definition: cpl_conv.cpp:1318
CPLStrtofDelim
float CPLStrtofDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:352
CPLPushFileFinder
void CPLPushFileFinder(CPLFileFinder pfnFinder)
CPLPushFileFinder.
Definition: cpl_findfile.cpp:200
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:911
CPLGetThreadLocalConfigOptions
char ** CPLGetThreadLocalConfigOptions(void)
Return the list of thread local configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1945
CPLScanDouble
double CPLScanDouble(const char *, int)
Extract double from string.
Definition: cpl_conv.cpp:1178
CPLGetBasename
const char * CPLGetBasename(const char *)
Extract basename (non-directory, non-extension) portion of filename.
Definition: cpl_path.cpp:292
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:2423
CPLAtofDelim
double CPLAtofDelim(const char *, char)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:73
GInt32
int GInt32
Int32 type.
Definition: cpl_port.h:205
CPLGetExtension
const char * CPLGetExtension(const char *)
Extract filename extension from full filename.
Definition: cpl_path.cpp:345
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:955
CPLGetFilename
const char * CPLGetFilename(const char *)
Extract non-directory portion of filename.
Definition: cpl_path.cpp:260
CPL_RETURNS_NONNULL
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:927
CPLSharedFileInfo::nRefCount
int nRefCount
Reference counter.
Definition: cpl_conv.h:208
CPLSharedFileInfo::fp
FILE * fp
File pointer.
Definition: cpl_conv.h:207
CPLStrtod
double CPLStrtod(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:326
CPLGetConfigOption
const char * CPLGetConfigOption(const char *, const char *)
Get the value of a configuration option.
Definition: cpl_conv.cpp:1699
VSILFILE
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
CPLSetThreadLocalConfigOption
void CPLSetThreadLocalConfigOption(const char *pszKey, const char *pszValue)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1906
CPLStrlwr
char * CPLStrlwr(char *)
Convert each characters of the string to lower case.
Definition: cpl_conv.cpp:324