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 mines-paris dot org>
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 /* -------------------------------------------------------------------- */
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 
70 /* -------------------------------------------------------------------- */
71 /* Safe malloc() API. Thin cover over VSI functions with fatal */
72 /* error reporting if memory allocation fails. */
73 /* -------------------------------------------------------------------- */
74 void CPL_DLL *CPLMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
75 void CPL_DLL *CPLCalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
76 void CPL_DLL *CPLRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
77 char CPL_DLL *CPLStrdup( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
78 char CPL_DLL *CPLStrlwr( char *);
79 
81 #define CPLFree VSIFree
82 
83 /* -------------------------------------------------------------------- */
84 /* Read a line from a text file, and strip of CR/LF. */
85 /* -------------------------------------------------------------------- */
86 char CPL_DLL *CPLFGets( char *, int, FILE *);
87 const char CPL_DLL *CPLReadLine( FILE * );
88 const char CPL_DLL *CPLReadLineL( VSILFILE * );
89 const char CPL_DLL *CPLReadLine2L( VSILFILE *, int, CSLConstList );
90 const char CPL_DLL *CPLReadLine3L( VSILFILE *, int, int *, CSLConstList );
91 
92 /* -------------------------------------------------------------------- */
93 /* Convert ASCII string to floating point number */
94 /* (THESE FUNCTIONS ARE NOT LOCALE AWARE!). */
95 /* -------------------------------------------------------------------- */
96 double CPL_DLL CPLAtof(const char *);
97 double CPL_DLL CPLAtofDelim(const char *, char);
98 double CPL_DLL CPLStrtod(const char *, char **);
99 double CPL_DLL CPLStrtodDelim(const char *, char **, char);
100 float CPL_DLL CPLStrtof(const char *, char **);
101 float CPL_DLL CPLStrtofDelim(const char *, char **, char);
102 
103 /* -------------------------------------------------------------------- */
104 /* Convert number to string. This function is locale agnostic */
105 /* (i.e. it will support "," or "." regardless of current locale) */
106 /* -------------------------------------------------------------------- */
107 double CPL_DLL CPLAtofM(const char *);
108 
109 /* -------------------------------------------------------------------- */
110 /* Read a numeric value from an ASCII character string. */
111 /* -------------------------------------------------------------------- */
112 char CPL_DLL *CPLScanString( const char *, int, int, int );
113 double CPL_DLL CPLScanDouble( const char *, int );
114 long CPL_DLL CPLScanLong( const char *, int );
115 unsigned long CPL_DLL CPLScanULong( const char *, int );
116 GUIntBig CPL_DLL CPLScanUIntBig( const char *, int );
117 GIntBig CPL_DLL CPLAtoGIntBig( const char* pszString );
118 GIntBig CPL_DLL CPLAtoGIntBigEx( const char* pszString, int bWarn, int *pbOverflow );
119 void CPL_DLL *CPLScanPointer( const char *, int );
120 
121 /* -------------------------------------------------------------------- */
122 /* Print a value to an ASCII character string. */
123 /* -------------------------------------------------------------------- */
124 int CPL_DLL CPLPrintString( char *, const char *, int );
125 int CPL_DLL CPLPrintStringFill( char *, const char *, int );
126 int CPL_DLL CPLPrintInt32( char *, GInt32 , int );
127 int CPL_DLL CPLPrintUIntBig( char *, GUIntBig , int );
128 int CPL_DLL CPLPrintDouble( char *, const char *, double, const char * );
129 int CPL_DLL CPLPrintTime( char *, int , const char *, const struct tm *,
130  const char * );
131 int CPL_DLL CPLPrintPointer( char *, void *, int );
132 
133 /* -------------------------------------------------------------------- */
134 /* Fetch a function from DLL / so. */
135 /* -------------------------------------------------------------------- */
136 
137 void CPL_DLL *CPLGetSymbol( const char *, const char * );
138 
139 /* -------------------------------------------------------------------- */
140 /* Fetch executable path. */
141 /* -------------------------------------------------------------------- */
142 int CPL_DLL CPLGetExecPath( char *pszPathBuf, int nMaxLength );
143 
144 /* -------------------------------------------------------------------- */
145 /* Filename handling functions. */
146 /* -------------------------------------------------------------------- */
147 const char CPL_DLL *CPLGetPath( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
148 const char CPL_DLL *CPLGetDirname( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
149 const char CPL_DLL *CPLGetFilename( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
150 const char CPL_DLL *CPLGetBasename( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
151 const char CPL_DLL *CPLGetExtension( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
152 char CPL_DLL *CPLGetCurrentDir(void);
153 const char CPL_DLL *CPLFormFilename( const char *pszPath,
154  const char *pszBasename,
155  const char *pszExtension ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
156 const char CPL_DLL *CPLFormCIFilename( const char *pszPath,
157  const char *pszBasename,
158  const char *pszExtension ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
159 const char CPL_DLL *CPLResetExtension( const char *, const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
160 const char CPL_DLL *CPLProjectRelativeFilename( const char *pszProjectDir,
161  const char *pszSecondaryFilename ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
162 int CPL_DLL CPLIsFilenameRelative( const char *pszFilename );
163 const char CPL_DLL *CPLExtractRelativePath(const char *, const char *, int *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
164 const char CPL_DLL *CPLCleanTrailingSlash( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
165 char CPL_DLL **CPLCorrespondingPaths( const char *pszOldFilename,
166  const char *pszNewFilename,
167  char **papszFileList ) CPL_WARN_UNUSED_RESULT;
168 int CPL_DLL CPLCheckForFile( char *pszFilename, char **papszSiblingList );
169 
170 const char CPL_DLL *CPLGenerateTempFilename( const char *pszStem ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
171 const char CPL_DLL *CPLExpandTilde( const char *pszFilename ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
172 const char CPL_DLL *CPLGetHomeDir(void) CPL_WARN_UNUSED_RESULT;
173 
174 /* -------------------------------------------------------------------- */
175 /* Find File Function */
176 /* -------------------------------------------------------------------- */
177 
179 typedef const char *(*CPLFileFinder)(const char *, const char *);
180 
181 const char CPL_DLL *CPLFindFile(const char *pszClass,
182  const char *pszBasename);
183 const char CPL_DLL *CPLDefaultFindFile(const char *pszClass,
184  const char *pszBasename);
185 void CPL_DLL CPLPushFileFinder( CPLFileFinder pfnFinder );
186 CPLFileFinder CPL_DLL CPLPopFileFinder(void);
187 void CPL_DLL CPLPushFinderLocation( const char * );
188 void CPL_DLL CPLPopFinderLocation(void);
189 void CPL_DLL CPLFinderClean(void);
190 
191 /* -------------------------------------------------------------------- */
192 /* Safe version of stat() that works properly on stuff like "C:". */
193 /* -------------------------------------------------------------------- */
194 int CPL_DLL CPLStat( const char *, VSIStatBuf * ) CPL_WARN_UNUSED_RESULT;
195 
196 /* -------------------------------------------------------------------- */
197 /* Reference counted file handle manager. Makes sharing file */
198 /* handles more practical. */
199 /* -------------------------------------------------------------------- */
200 
202 typedef struct {
203  FILE *fp;
204  int nRefCount;
205  int bLarge;
206  char *pszFilename;
207  char *pszAccess;
209 
210 FILE CPL_DLL *CPLOpenShared( const char *, const char *, int );
211 void CPL_DLL CPLCloseShared( FILE * );
212 CPLSharedFileInfo CPL_DLL *CPLGetSharedList( int * );
213 void CPL_DLL CPLDumpSharedList( FILE * );
215 void CPL_DLL CPLCleanupSharedFileMutex( void );
218 /* -------------------------------------------------------------------- */
219 /* DMS to Dec to DMS conversion. */
220 /* -------------------------------------------------------------------- */
221 double CPL_DLL CPLDMSToDec( const char *is );
222 const char CPL_DLL *CPLDecToDMS( double dfAngle, const char * pszAxis,
223  int nPrecision );
224 double CPL_DLL CPLPackedDMSToDec( double );
225 double CPL_DLL CPLDecToPackedDMS( double dfDec );
226 
227 void CPL_DLL CPLStringToComplex( const char *pszString,
228  double *pdfReal, double *pdfImag );
229 
230 /* -------------------------------------------------------------------- */
231 /* Misc other functions. */
232 /* -------------------------------------------------------------------- */
233 int CPL_DLL CPLUnlinkTree( const char * );
234 int CPL_DLL CPLCopyFile( const char *pszNewPath, const char *pszOldPath );
235 int CPL_DLL CPLCopyTree( const char *pszNewPath, const char *pszOldPath );
236 int CPL_DLL CPLMoveFile( const char *pszNewPath, const char *pszOldPath );
237 int CPL_DLL CPLSymlink( const char* pszOldPath, const char* pszNewPath, CSLConstList papszOptions );
238 
239 /* -------------------------------------------------------------------- */
240 /* ZIP Creation. */
241 /* -------------------------------------------------------------------- */
242 
244 #define CPL_ZIP_API_OFFERED
245 
246 void CPL_DLL *CPLCreateZip( const char *pszZipFilename, char **papszOptions );
247 CPLErr CPL_DLL CPLCreateFileInZip( void *hZip, const char *pszFilename,
248  char **papszOptions );
249 CPLErr CPL_DLL CPLWriteFileInZip( void *hZip, const void *pBuffer, int nBufferSize );
250 CPLErr CPL_DLL CPLCloseFileInZip( void *hZip );
251 CPLErr CPL_DLL CPLCloseZip( void *hZip );
252 
253 /* -------------------------------------------------------------------- */
254 /* ZLib compression */
255 /* -------------------------------------------------------------------- */
256 
257 void CPL_DLL *CPLZLibDeflate( const void* ptr, size_t nBytes, int nLevel,
258  void* outptr, size_t nOutAvailableBytes,
259  size_t* pnOutBytes );
260 void CPL_DLL *CPLZLibInflate( const void* ptr, size_t nBytes,
261  void* outptr, size_t nOutAvailableBytes,
262  size_t* pnOutBytes );
263 
264 /* -------------------------------------------------------------------- */
265 /* XML validation. */
266 /* -------------------------------------------------------------------- */
267 int CPL_DLL CPLValidateXML(const char* pszXMLFilename,
268  const char* pszXSDFilename,
269  CSLConstList papszOptions);
270 
271 /* -------------------------------------------------------------------- */
272 /* Locale handling. Prevents parallel executions of setlocale(). */
273 /* -------------------------------------------------------------------- */
274 char* CPLsetlocale (int category, const char* locale);
276 void CPLCleanupSetlocaleMutex(void);
284 int CPL_DLL CPLIsPowerOfTwo( unsigned int i );
285 
286 CPL_C_END
287 
288 /* -------------------------------------------------------------------- */
289 /* C++ object for temporarily forcing a LC_NUMERIC locale to "C". */
290 /* -------------------------------------------------------------------- */
291 
293 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
294 
295 extern "C++"
296 {
297 class CPL_DLL CPLLocaleC
298 {
299  CPL_DISALLOW_COPY_ASSIGN(CPLLocaleC)
300 public:
301  CPLLocaleC();
302  ~CPLLocaleC();
303 
304 private:
305  char *pszOldLocale;
306 };
307 
308 // Does the same as CPLLocaleC except that, when available, it tries to
309 // only affect the current thread. But code that would be dependent of
310 // setlocale(LC_NUMERIC, NULL) returning "C", such as current proj.4 versions,
311 // will not work depending on the actual implementation
312 class CPLThreadLocaleCPrivate;
313 class CPL_DLL CPLThreadLocaleC
314 {
315  CPL_DISALLOW_COPY_ASSIGN(CPLThreadLocaleC)
316 
317 public:
318  CPLThreadLocaleC();
319  ~CPLThreadLocaleC();
320 
321 private:
322  CPLThreadLocaleCPrivate* m_private;
323 };
324 }
325 
326 #endif /* def __cplusplus */
327 
329 
330 
331 /* -------------------------------------------------------------------- */
332 /* C++ object for temporarily forcing a config option */
333 /* -------------------------------------------------------------------- */
334 
336 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
337 
338 extern "C++"
339 {
340 class CPL_DLL CPLConfigOptionSetter
341 {
342  CPL_DISALLOW_COPY_ASSIGN(CPLConfigOptionSetter)
343 public:
344  CPLConfigOptionSetter(const char* pszKey, const char* pszValue,
345  bool bSetOnlyIfUndefined);
346  ~CPLConfigOptionSetter();
347 
348 private:
349  char* m_pszKey;
350  char *m_pszOldValue;
351  bool m_bRestoreOldValue;
352 };
353 }
354 
355 #endif /* def __cplusplus */
356 
358 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
359 
360 extern "C++"
361 {
362 
363 #ifndef DOXYGEN_SKIP
364 #include <type_traits> // for std::is_base_of
365 #endif
366 
367 namespace cpl
368 {
378  template<typename To, typename From> inline To down_cast(From* f)
379  {
380  static_assert(
381  (std::is_base_of<From,
382  typename std::remove_pointer<To>::type>::value),
383  "target type not derived from source type");
384  CPLAssert(f == nullptr || dynamic_cast<To>(f) != nullptr);
385  return static_cast<To>(f);
386  }
387 }
388 } // extern "C++"
389 
390 #endif /* def __cplusplus */
391 
392 #endif /* ndef CPL_CONV_H_INCLUDED */
const char * CPLGetExtension(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract filename extension from full filename.
Definition: cpl_path.cpp:345
int CPLIsFilenameRelative(const char *pszFilename)
Is filename relative or absolute?
Definition: cpl_path.cpp:806
Definition: cpl_conv.h:367
const char * CPLCleanTrailingSlash(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Remove trailing forward/backward slash from the path for UNIX/Windows resp.
Definition: cpl_path.cpp:939
int CPLPrintString(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating `\0' character, to the array pointed to by pszDest.
Definition: cpl_conv.cpp:1223
void * CPLRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT
Safe version of realloc().
Definition: cpl_conv.cpp:225
double CPLDecToPackedDMS(double dfDec)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition: cpl_conv.cpp:2256
void CPLPopFinderLocation(void)
CPLPopFinderLocation.
Definition: cpl_findfile.cpp:285
Standard C Covers.
const char * CPLGetThreadLocalConfigOption(const char *, const char *) CPL_WARN_UNUSED_RESULT
Same as CPLGetConfigOption() but only with options set with CPLSetThreadLocalConfigOption() ...
Definition: cpl_conv.cpp:1780
const char * CPLGetHomeDir(void) CPL_WARN_UNUSED_RESULT
Return the path to the home directory.
Definition: cpl_path.cpp:1166
void CPLPushFinderLocation(const char *)
CPLPushFinderLocation.
Definition: cpl_findfile.cpp:246
int CPLPrintDouble(char *, const char *, double, const char *)
Print double value into specified string buffer.
Definition: cpl_conv.cpp:1444
const char * CPLGetConfigOption(const char *, const char *) CPL_WARN_UNUSED_RESULT
Get the value of a configuration option.
Definition: cpl_conv.cpp:1692
Core portability definitions for CPL.
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
void * CPLMalloc(size_t) CPL_WARN_UNUSED_RESULT
Safe version of malloc().
Definition: cpl_conv.cpp:168
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:1952
int CPLPrintStringFill(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating `\0' character, to the array pointed to by pszDest.
Definition: cpl_conv.cpp:1267
int CPLPrintPointer(char *, void *, int)
Print pointer value into specified string buffer.
Definition: cpl_conv.cpp:1400
int GInt32
Int32 type.
Definition: cpl_port.h:205
char ** CPLGetConfigOptions(void)
Return the list of configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1739
double CPLAtof(const char *)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:117
const char * CPLFormFilename(const char *pszPath, const char *pszBasename, const char *pszExtension) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Build a full file path from a passed path, file basename and extension.
Definition: cpl_path.cpp:535
int CPLIsPowerOfTwo(unsigned int i)
Definition: cpl_conv.cpp:3018
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
void * CPLGetSymbol(const char *, const char *)
Fetch a function pointer from a shared library / DLL.
Definition: cplgetsymbol.cpp:89
CPLErr CPLWriteFileInZip(void *hZip, const void *pBuffer, int nBufferSize)
Write in current file inside a ZIP file.
Definition: cpl_conv.cpp:3101
CPLErr CPLCloseFileInZip(void *hZip)
Close current file inside ZIP file.
Definition: cpl_conv.cpp:3103
void CPLPushFileFinder(CPLFileFinder pfnFinder)
CPLPushFileFinder.
Definition: cpl_findfile.cpp:200
int CPLGetExecPath(char *pszPathBuf, int nMaxLength)
Fetch path of executable.
Definition: cpl_getexecpath.cpp:132
const char * CPLResetExtension(const char *, const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Replace the extension with the provided one.
Definition: cpl_path.cpp:431
char * CPLsetlocale(int category, const char *locale)
Prevents parallel executions of setlocale().
Definition: cpl_conv.cpp:2992
const char * CPLReadLine(FILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:566
void * CPLZLibInflate(const void *ptr, size_t nBytes, void *outptr, size_t nOutAvailableBytes, size_t *pnOutBytes)
Uncompress a buffer compressed with ZLib DEFLATE compression.
Definition: cpl_conv.cpp:3116
float CPLStrtof(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:397
char * CPLStrlwr(char *)
Convert each characters of the string to lower case.
Definition: cpl_conv.cpp:319
void CPLSetThreadLocalConfigOption(const char *pszKey, const char *pszValue)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1885
const char *(* CPLFileFinder)(const char *, const char *)
Callback for CPLPushFileFinder.
Definition: cpl_conv.h:179
int bLarge
Whether fp must be interpreted as VSIFILE*.
Definition: cpl_conv.h:205
double CPLStrtodDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:231
void * CPLCreateZip(const char *pszZipFilename, char **papszOptions)
Create ZIP file.
Definition: cpl_conv.cpp:3091
int CPLUnlinkTree(const char *)
Recursively unlink a directory.
Definition: cpl_conv.cpp:2559
const char * CPLReadLineL(VSILFILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:630
CPLSharedFileInfo * CPLGetSharedList(int *)
Fetch list of open shared files.
Definition: cpl_conv.cpp:2499
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:2129
char * CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Safe version of strdup() function.
Definition: cpl_conv.cpp:293
const char * CPLReadLine2L(VSILFILE *, int, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:652
const char * CPLProjectRelativeFilename(const char *pszProjectDir, const char *pszSecondaryFilename) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Find a file relative to a project file.
Definition: cpl_path.cpp:744
const char * CPLReadLine3L(VSILFILE *, int, int *, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:682
float CPLStrtofDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:347
#define CPLAssert(expr)
Assert on an expression.
Definition: cpl_error.h:186
int CPLSymlink(const char *pszOldPath, const char *pszNewPath, CSLConstList papszOptions)
Create a symbolic link.
Definition: cpl_conv.cpp:2805
void CPLStringToComplex(const char *pszString, double *pdfReal, double *pdfImag)
Fetch the real and imaginary part of a serialized complex number.
Definition: cpl_conv.cpp:2273
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:1502
Information on a shared file.
Definition: cpl_conv.h:202
CPLErr CPLCloseZip(void *hZip)
Close ZIP file.
Definition: cpl_conv.cpp:3105
const char * CPLDefaultFindFile(const char *pszClass, const char *pszBasename)
CPLDefaultFindFile.
Definition: cpl_findfile.cpp:149
const char * CPLFormCIFilename(const char *pszPath, const char *pszBasename, const char *pszExtension) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Case insensitive file searching, returning full path.
Definition: cpl_path.cpp:651
FILE * CPLOpenShared(const char *, const char *, int)
Open a shared file handle.
Definition: cpl_conv.cpp:2335
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:364
int CPLMoveFile(const char *pszNewPath, const char *pszOldPath)
Move a file.
Definition: cpl_conv.cpp:2784
GIntBig CPLAtoGIntBig(const char *pszString)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:998
int CPLCheckForFile(char *pszFilename, char **papszSiblingList)
Check for file existence.
Definition: cpl_conv.cpp:3053
CPL error handling services.
const char * CPLExpandTilde(const char *pszFilename) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Expands ~/ at start of filename.
Definition: cpl_path.cpp:1138
const char * CPLGenerateTempFilename(const char *pszStem) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Generate temporary file name.
Definition: cpl_path.cpp:1095
void CPLDumpSharedList(FILE *)
Report open shared files.
Definition: cpl_conv.cpp:2521
CPLFileFinder CPLPopFileFinder(void)
CPLPopFileFinder.
Definition: cpl_findfile.cpp:235
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1186
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:934
char * pszAccess
Access mode.
Definition: cpl_conv.h:207
char ** CPLGetThreadLocalConfigOptions(void)
Return the list of thread local configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1922
FILE * fp
File pointer.
Definition: cpl_conv.h:203
double CPLDMSToDec(const char *is)
CPLDMSToDec.
Definition: cpl_conv.cpp:2046
const char * CPLFindFile(const char *pszClass, const char *pszBasename)
CPLFindFile.
Definition: cpl_findfile.cpp:177
const char * CPLGetPath(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract directory path portion of filename.
Definition: cpl_path.cpp:153
void * CPLScanPointer(const char *, int)
Extract pointer from string.
Definition: cpl_conv.cpp:1105
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
GIntBig CPLAtoGIntBigEx(const char *pszString, int bWarn, int *pbOverflow)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1050
int CPLStat(const char *, VSIStatBuf *) CPL_WARN_UNUSED_RESULT
Same as VSIStat() except it works on "C:" as if it were "C:\".
Definition: cpl_conv.cpp:1997
double CPLStrtod(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:321
int nRefCount
Reference counter.
Definition: cpl_conv.h:204
int CPLValidateXML(const char *pszXMLFilename, const char *pszXSDFilename, CSLConstList papszOptions)
Validate a XML file against a XML schema.
Definition: cpl_xml_validate.cpp:1073
GUIntBig CPLScanUIntBig(const char *, int)
Extract big integer from string.
Definition: cpl_conv.cpp:964
char * CPLGetCurrentDir(void)
Get the current working directory name.
Definition: cpl_path.cpp:396
int CPLPrintInt32(char *, GInt32, int)
Print GInt32 value into specified string buffer.
Definition: cpl_conv.cpp:1311
void CPLSetConfigOption(const char *, const char *)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1832
double CPLScanDouble(const char *, int)
Extract double from string.
Definition: cpl_conv.cpp:1171
char ** CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename, char **papszFileList) CPL_WARN_UNUSED_RESULT
Identify corresponding paths.
Definition: cpl_path.cpp:990
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:906
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:964
void * CPLCalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Safe version of calloc().
Definition: cpl_conv.cpp:138
void CPLFinderClean(void)
CPLFinderClean.
Definition: cpl_findfile.cpp:134
double CPLAtofM(const char *)
Converts ASCII string to floating point number using any numeric locale.
Definition: cpl_strtod.cpp:142
double CPLAtofDelim(const char *, char)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:73
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
int CPLCopyFile(const char *pszNewPath, const char *pszOldPath)
Copy a file.
Definition: cpl_conv.cpp:2644
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
int CPLPrintUIntBig(char *, GUIntBig, int)
Print GUIntBig value into specified string buffer.
Definition: cpl_conv.cpp:1350
char * pszFilename
Filename.
Definition: cpl_conv.h:206
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:1765
double CPLPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition: cpl_conv.cpp:2222
const char * CPLGetFilename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract non-directory portion of filename.
Definition: cpl_path.cpp:260
void * CPLZLibDeflate(const void *ptr, size_t nBytes, int nLevel, void *outptr, size_t nOutAvailableBytes, size_t *pnOutBytes)
Compress a buffer with ZLib DEFLATE compression.
Definition: cpl_conv.cpp:3107
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:846
CPLErr CPLCreateFileInZip(void *hZip, const char *pszFilename, char **papszOptions)
Create a file in a ZIP file.
Definition: cpl_conv.cpp:3099
const char * CPLGetDirname(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract directory path portion of filename.
Definition: cpl_path.cpp:208
const char * CPLExtractRelativePath(const char *, const char *, int *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Get relative path from directory to target file.
Definition: cpl_path.cpp:847
CPLErr
Error category.
Definition: cpl_error.h:52
void CPLCloseShared(FILE *)
Close shared file.
Definition: cpl_conv.cpp:2408
#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:989
int CPLCopyTree(const char *pszNewPath, const char *pszOldPath)
Recursively copy a tree.
Definition: cpl_conv.cpp:2706
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:931
const char * CPLGetBasename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract basename (non-directory, non-extension) portion of filename.
Definition: cpl_path.cpp:292

Generated for GDAL by doxygen 1.8.8.