GDAL
cpl_conv.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id: cpl_conv.h 38344 2017-05-14 18:54:32Z rouault $
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 #ifdef __cplusplus
90 const char CPL_DLL *CPLReadLine2L( VSILFILE * , int nMaxCols,
91  const char * const * papszOptions );
92 #else
93 const char CPL_DLL *CPLReadLine2L( VSILFILE * , int nMaxCols,
94  char** papszOptions );
95 #endif
96 
97 /* -------------------------------------------------------------------- */
98 /* Convert ASCII string to floating point number */
99 /* (THESE FUNCTIONS ARE NOT LOCALE AWARE!). */
100 /* -------------------------------------------------------------------- */
101 double CPL_DLL CPLAtof(const char *);
102 double CPL_DLL CPLAtofDelim(const char *, char);
103 double CPL_DLL CPLStrtod(const char *, char **);
104 double CPL_DLL CPLStrtodDelim(const char *, char **, char);
105 float CPL_DLL CPLStrtof(const char *, char **);
106 float CPL_DLL CPLStrtofDelim(const char *, char **, char);
107 
108 /* -------------------------------------------------------------------- */
109 /* Convert number to string. This function is locale agnostic */
110 /* (i.e. it will support "," or "." regardless of current locale) */
111 /* -------------------------------------------------------------------- */
112 double CPL_DLL CPLAtofM(const char *);
113 
114 /* -------------------------------------------------------------------- */
115 /* Read a numeric value from an ASCII character string. */
116 /* -------------------------------------------------------------------- */
117 char CPL_DLL *CPLScanString( const char *, int, int, int );
118 double CPL_DLL CPLScanDouble( const char *, int );
119 long CPL_DLL CPLScanLong( const char *, int );
120 unsigned long CPL_DLL CPLScanULong( const char *, int );
121 GUIntBig CPL_DLL CPLScanUIntBig( const char *, int );
122 GIntBig CPL_DLL CPLAtoGIntBig( const char* pszString );
123 GIntBig CPL_DLL CPLAtoGIntBigEx( const char* pszString, int bWarn, int *pbOverflow );
124 void CPL_DLL *CPLScanPointer( const char *, int );
125 
126 /* -------------------------------------------------------------------- */
127 /* Print a value to an ASCII character string. */
128 /* -------------------------------------------------------------------- */
129 int CPL_DLL CPLPrintString( char *, const char *, int );
130 int CPL_DLL CPLPrintStringFill( char *, const char *, int );
131 int CPL_DLL CPLPrintInt32( char *, GInt32 , int );
132 int CPL_DLL CPLPrintUIntBig( char *, GUIntBig , int );
133 int CPL_DLL CPLPrintDouble( char *, const char *, double, const char * );
134 int CPL_DLL CPLPrintTime( char *, int , const char *, const struct tm *,
135  const char * );
136 int CPL_DLL CPLPrintPointer( char *, void *, int );
137 
138 /* -------------------------------------------------------------------- */
139 /* Fetch a function from DLL / so. */
140 /* -------------------------------------------------------------------- */
141 
142 void CPL_DLL *CPLGetSymbol( const char *, const char * );
143 
144 /* -------------------------------------------------------------------- */
145 /* Fetch executable path. */
146 /* -------------------------------------------------------------------- */
147 int CPL_DLL CPLGetExecPath( char *pszPathBuf, int nMaxLength );
148 
149 /* -------------------------------------------------------------------- */
150 /* Filename handling functions. */
151 /* -------------------------------------------------------------------- */
152 const char CPL_DLL *CPLGetPath( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
153 const char CPL_DLL *CPLGetDirname( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
154 const char CPL_DLL *CPLGetFilename( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
155 const char CPL_DLL *CPLGetBasename( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
156 const char CPL_DLL *CPLGetExtension( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
157 char CPL_DLL *CPLGetCurrentDir(void);
158 const char CPL_DLL *CPLFormFilename( const char *pszPath,
159  const char *pszBasename,
160  const char *pszExtension ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
161 const char CPL_DLL *CPLFormCIFilename( const char *pszPath,
162  const char *pszBasename,
163  const char *pszExtension ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
164 const char CPL_DLL *CPLResetExtension( const char *, const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
165 const char CPL_DLL *CPLProjectRelativeFilename( const char *pszProjectDir,
166  const char *pszSecondaryFilename ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
167 int CPL_DLL CPLIsFilenameRelative( const char *pszFilename );
168 const char CPL_DLL *CPLExtractRelativePath(const char *, const char *, int *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
169 const char CPL_DLL *CPLCleanTrailingSlash( const char * ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
170 char CPL_DLL **CPLCorrespondingPaths( const char *pszOldFilename,
171  const char *pszNewFilename,
172  char **papszFileList ) CPL_WARN_UNUSED_RESULT;
173 int CPL_DLL CPLCheckForFile( char *pszFilename, char **papszSiblingList );
174 
175 const char CPL_DLL *CPLGenerateTempFilename( const char *pszStem ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
176 const char CPL_DLL *CPLExpandTilde( const char *pszFilename ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
177 
178 /* -------------------------------------------------------------------- */
179 /* Find File Function */
180 /* -------------------------------------------------------------------- */
181 
183 typedef const char *(*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;
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, char** 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  char** papszOptions);
274 
275 /* -------------------------------------------------------------------- */
276 /* Locale handling. Prevents parallel executions of setlocale(). */
277 /* -------------------------------------------------------------------- */
278 char* CPLsetlocale (int category, const char* locale);
280 void CPLCleanupSetlocaleMutex(void);
283 CPL_C_END
284 
285 /* -------------------------------------------------------------------- */
286 /* C++ object for temporarily forcing a LC_NUMERIC locale to "C". */
287 /* -------------------------------------------------------------------- */
288 
290 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
291 
292 class CPL_DLL CPLLocaleC
293 {
294 public:
295  CPLLocaleC();
296  ~CPLLocaleC();
297 
298 private:
299  char *pszOldLocale;
300 
301  /* Make it non-copyable */
302  CPLLocaleC(const CPLLocaleC&);
303  CPLLocaleC& operator=(const CPLLocaleC&);
304 };
305 
306 // Does the same as CPLLocaleC except that, when available, it tries to
307 // only affect the current thread. But code that would be dependent of
308 // setlocale(LC_NUMERIC, NULL) returning "C", such as current proj.4 versions,
309 // will not work depending on the actual implementation
310 class CPL_DLL CPLThreadLocaleC
311 {
312 public:
313  CPLThreadLocaleC();
314  ~CPLThreadLocaleC();
315 
316 private:
317 #ifdef HAVE_USELOCALE
318  locale_t nNewLocale;
319  locale_t nOldLocale;
320 #else
321 #if defined(_MSC_VER)
322  int nOldValConfigThreadLocale;
323 #endif
324  char *pszOldLocale;
325 #endif
326 
327  /* Make it non-copyable */
328  CPLThreadLocaleC(const CPLThreadLocaleC&);
329  CPLThreadLocaleC& operator=(const CPLThreadLocaleC&);
330 };
331 
332 #endif /* def __cplusplus */
333 
335 
336 
337 /* -------------------------------------------------------------------- */
338 /* C++ object for temporarily forcing a config option */
339 /* -------------------------------------------------------------------- */
340 
342 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
343 
344 class CPL_DLL CPLConfigOptionSetter
345 {
346 public:
347  CPLConfigOptionSetter(const char* pszKey, const char* pszValue,
348  bool bSetOnlyIfUndefined);
349  ~CPLConfigOptionSetter();
350 
351 private:
352  char* m_pszKey;
353  char *m_pszOldValue;
354  bool m_bRestoreOldValue;
355 
356  /* Make it non-copyable */
357  CPLConfigOptionSetter(const CPLConfigOptionSetter&);
358  CPLConfigOptionSetter& operator=(const CPLConfigOptionSetter&);
359 };
360 
361 #endif /* def __cplusplus */
362 
364 
365 #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:781
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:914
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:1181
int CPLSymlink(const char *pszOldPath, const char *pszNewPath, char **papszOptions)
Create a symbolic link.
Definition: cpl_conv.cpp:2732
void * CPLRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT
Safe version of realloc().
Definition: cpl_conv.cpp:215
double CPLDecToPackedDMS(double dfDec)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition: cpl_conv.cpp:2184
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:1716
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:1402
const char * CPLGetConfigOption(const char *, const char *) CPL_WARN_UNUSED_RESULT
Get the value of a configuration option.
Definition: cpl_conv.cpp:1628
Core portability definitions for CPL.
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:352
void * CPLMalloc(size_t) CPL_WARN_UNUSED_RESULT
Safe version of malloc().
Definition: cpl_conv.cpp:158
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:1880
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:1225
int CPLPrintPointer(char *, void *, int)
Print pointer value into specified string buffer.
Definition: cpl_conv.cpp:1358
int GInt32
Int32 type.
Definition: cpl_port.h:197
char ** CPLGetConfigOptions(void)
Return the list of configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1675
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:504
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:154
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:2960
CPLErr CPLCloseFileInZip(void *hZip)
Close current file inside ZIP file.
Definition: cpl_conv.cpp:2962
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:425
char * CPLsetlocale(int category, const char *locale)
Prevents parallel executions of setlocale().
Definition: cpl_conv.cpp:2862
int CPLValidateXML(const char *pszXMLFilename, const char *pszXSDFilename, char **papszOptions)
Validate a XML file against a XML schema.
Definition: cpl_xml_validate.cpp:1073
const char * CPLReadLine(FILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:556
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:2975
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:309
void CPLSetThreadLocalConfigOption(const char *pszKey, const char *pszValue)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1817
const char *(* CPLFileFinder)(const char *, const char *)
Callback for CPLPushFileFinder.
Definition: cpl_conv.h:183
int bLarge
Whether fp must be interpreted as VSIFILE*.
Definition: cpl_conv.h:209
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:2950
int CPLUnlinkTree(const char *)
Recursively unlink a directory.
Definition: cpl_conv.cpp:2487
const char * CPLReadLineL(VSILFILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:620
CPLSharedFileInfo * CPLGetSharedList(int *)
Fetch list of open shared files.
Definition: cpl_conv.cpp:2427
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:2057
char * CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Safe version of strdup() function.
Definition: cpl_conv.cpp:283
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:717
float CPLStrtofDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:347
void CPLStringToComplex(const char *pszString, double *pdfReal, double *pdfImag)
Fetch the real and imaginary part of a serialized complex number.
Definition: cpl_conv.cpp:2201
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:1460
Information on a shared file.
Definition: cpl_conv.h:206
CPLErr CPLCloseZip(void *hZip)
Close ZIP file.
Definition: cpl_conv.cpp:2964
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:624
FILE * CPLOpenShared(const char *, const char *, int)
Open a shared file handle.
Definition: cpl_conv.cpp:2263
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:354
int CPLMoveFile(const char *pszNewPath, const char *pszOldPath)
Move a file.
Definition: cpl_conv.cpp:2711
GIntBig CPLAtoGIntBig(const char *pszString)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:956
int CPLCheckForFile(char *pszFilename, char **papszSiblingList)
Check for file existence.
Definition: cpl_conv.cpp:2912
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:1113
const char * CPLGenerateTempFilename(const char *pszStem) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Generate temporary file name.
Definition: cpl_path.cpp:1070
void CPLDumpSharedList(FILE *)
Report open shared files.
Definition: cpl_conv.cpp:2449
CPLFileFinder CPLPopFileFinder(void)
CPLPopFileFinder.
Definition: cpl_findfile.cpp:235
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:894
char * pszAccess
Access mode.
Definition: cpl_conv.h:211
char ** CPLGetThreadLocalConfigOptions(void)
Return the list of thread local configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1850
FILE * fp
File pointer.
Definition: cpl_conv.h:207
double CPLDMSToDec(const char *is)
CPLDMSToDec.
Definition: cpl_conv.cpp:1974
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:1063
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:253
GIntBig CPLAtoGIntBigEx(const char *pszString, int bWarn, int *pbOverflow)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1008
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:1925
const char * CPLReadLine2L(VSILFILE *, int nMaxCols, const char *const *papszOptions)
Simplified line reading from text file.
Definition: cpl_conv.cpp:642
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:208
GUIntBig CPLScanUIntBig(const char *, int)
Extract big integer from string.
Definition: cpl_conv.cpp:924
char * CPLGetCurrentDir(void)
Get the current working directory name.
Definition: cpl_path.cpp:390
int CPLPrintInt32(char *, GInt32, int)
Print GInt32 value into specified string buffer.
Definition: cpl_conv.cpp:1269
void CPLSetConfigOption(const char *, const char *)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1768
double CPLScanDouble(const char *, int)
Extract double from string.
Definition: cpl_conv.cpp:1129
char ** CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename, char **papszFileList) CPL_WARN_UNUSED_RESULT
Identify corresponding paths.
Definition: cpl_path.cpp:965
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:866
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:1032
void * CPLCalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Safe version of calloc().
Definition: cpl_conv.cpp:128
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:354
int CPLCopyFile(const char *pszNewPath, const char *pszOldPath)
Copy a file.
Definition: cpl_conv.cpp:2571
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:250
int CPLPrintUIntBig(char *, GUIntBig, int)
Print GUIntBig value into specified string buffer.
Definition: cpl_conv.cpp:1308
char * pszFilename
Filename.
Definition: cpl_conv.h:210
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:1701
double CPLPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition: cpl_conv.cpp:2150
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:2966
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:806
CPLErr CPLCreateFileInZip(void *hZip, const char *pszFilename, char **papszOptions)
Create a file in a ZIP file.
Definition: cpl_conv.cpp:2958
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:822
CPLErr
Error category.
Definition: cpl_error.h:52
void CPLCloseShared(FILE *)
Close shared file.
Definition: cpl_conv.cpp:2336
int CPLCopyTree(const char *pszNewPath, const char *pszOldPath)
Recursively copy a tree.
Definition: cpl_conv.cpp:2633
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:999
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.