Go to the documentation of this file.
32 #ifndef CPL_CONV_H_INCLUDED
33 #define CPL_CONV_H_INCLUDED
52 void CPL_DLL CPLVerifyConfiguration(
void);
55 const char CPL_DLL * CPL_STDCALL
57 const char CPL_DLL * CPL_STDCALL
61 const char *pszValue );
63 void CPL_DLL CPL_STDCALL CPLFreeConfig(
void);
81 #define CPLFree VSIFree
86 char CPL_DLL *
CPLFGets(
char *,
int, FILE *);
96 double CPL_DLL
CPLAtof(
const char *);
98 double CPL_DLL
CPLStrtod(
const char *,
char **);
100 float CPL_DLL
CPLStrtof(
const char *,
char **);
107 double CPL_DLL
CPLAtofM(
const char *);
115 unsigned long CPL_DLL
CPLScanULong(
const char *,
int );
128 int CPL_DLL
CPLPrintDouble(
char *,
const char *,
double,
const char * );
129 int CPL_DLL
CPLPrintTime(
char *,
int ,
const char *,
const struct tm *,
137 void CPL_DLL *
CPLGetSymbol(
const char *,
const char * );
154 const char *pszBasename,
157 const char *pszBasename,
166 const char *pszNewFilename,
168 int CPL_DLL
CPLCheckForFile(
char *pszFilename,
char **papszSiblingList );
179 typedef const char *(*CPLFileFinder)(
const char *,
const char *);
181 const char CPL_DLL *
CPLFindFile(
const char *pszClass,
182 const char *pszBasename);
184 const char *pszBasename);
210 FILE CPL_DLL *
CPLOpenShared(
const char *,
const char *,
int );
215 void CPL_DLL CPLCleanupSharedFileMutex(
void );
222 const char CPL_DLL *
CPLDecToDMS(
double dfAngle,
const char * pszAxis,
228 double *pdfReal,
double *pdfImag );
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 );
244 #define CPL_ZIP_API_OFFERED
246 void CPL_DLL *
CPLCreateZip(
const char *pszZipFilename,
char **papszOptions );
248 char **papszOptions );
257 void CPL_DLL *
CPLZLibDeflate(
const void* ptr,
size_t nBytes,
int nLevel,
258 void* outptr,
size_t nOutAvailableBytes,
259 size_t* pnOutBytes );
261 void* outptr,
size_t nOutAvailableBytes,
262 size_t* pnOutBytes );
268 const char* pszXSDFilename,
276 void CPLCleanupSetlocaleMutex(
void);
293 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
297 class CPL_DLL CPLLocaleC
312 class CPLThreadLocaleCPrivate;
313 class CPL_DLL CPLThreadLocaleC
322 CPLThreadLocaleCPrivate* m_private;
336 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
340 class CPL_DLL CPLConfigOptionSetter
344 CPLConfigOptionSetter(
const char* pszKey,
const char* pszValue,
345 bool bSetOnlyIfUndefined);
346 ~CPLConfigOptionSetter();
351 bool m_bRestoreOldValue;
358 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
364 #include <type_traits>
378 template<
typename To,
typename From>
inline To
down_cast(From* f)
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);
void CPLPopFinderLocation(void)
CPLPopFinderLocation.
Definition: cpl_findfile.cpp:285
void * CPLMalloc(size_t) CPL_WARN_UNUSED_RESULT
Safe version of malloc().
Definition: cpl_conv.cpp:168
double CPLStrtodDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:231
char * CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Safe version of strdup() function.
Definition: cpl_conv.cpp:293
int CPLValidateXML(const char *pszXMLFilename, const char *pszXSDFilename, CSLConstList papszOptions)
Validate a XML file against a XML schema.
Definition: cpl_xml_validate.cpp:1073
const char * CPLReadLineL(VSILFILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:630
int CPLIsPowerOfTwo(unsigned int i)
Definition: cpl_conv.cpp:3018
void * CPLGetSymbol(const char *, const char *)
Fetch a function pointer from a shared library / DLL.
Definition: cplgetsymbol.cpp:89
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
const char * CPLGetExtension(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract filename extension from full filename.
Definition: cpl_path.cpp:345
int CPLPrintStringFill(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition: cpl_conv.cpp:1267
int CPLGetExecPath(char *pszPathBuf, int nMaxLength)
Fetch path of executable.
Definition: cpl_getexecpath.cpp:132
const char * CPLFindFile(const char *pszClass, const char *pszBasename)
CPLFindFile.
Definition: cpl_findfile.cpp:177
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
double CPLDMSToDec(const char *is)
CPLDMSToDec.
Definition: cpl_conv.cpp:2046
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
const char * CPLGetPath(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract directory path portion of filename.
Definition: cpl_path.cpp:153
int CPLPrintUIntBig(char *, GUIntBig, int)
Print GUIntBig value into specified string buffer.
Definition: cpl_conv.cpp:1350
const char * CPLGetHomeDir(void) CPL_WARN_UNUSED_RESULT
Return the path to the home directory.
Definition: cpl_path.cpp:1176
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:949
int CPLCopyFile(const char *pszNewPath, const char *pszOldPath)
Copy a file.
Definition: cpl_conv.cpp:2644
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
CPLErr CPLCloseZip(void *hZip)
Close ZIP file.
Definition: cpl_conv.cpp:3105
void * CPLScanPointer(const char *, int)
Extract pointer from string.
Definition: cpl_conv.cpp:1105
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
void CPLPushFinderLocation(const char *)
CPLPushFinderLocation.
Definition: cpl_findfile.cpp:246
double CPLPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition: cpl_conv.cpp:2222
GIntBig CPLAtoGIntBig(const char *pszString)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:998
int bLarge
Whether fp must be interpreted as VSIFILE*.
Definition: cpl_conv.h:205
void CPLDumpSharedList(FILE *)
Report open shared files.
Definition: cpl_conv.cpp:2521
CPLSharedFileInfo * CPLGetSharedList(int *)
Fetch list of open shared files.
Definition: cpl_conv.cpp:2499
const char * CPLGetConfigOption(const char *, const char *) CPL_WARN_UNUSED_RESULT
Get the value of a configuration option.
Definition: cpl_conv.cpp:1692
const char * CPLExpandTilde(const char *pszFilename) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Expands ~/ at start of filename.
Definition: cpl_path.cpp:1148
Information on a shared file.
Definition: cpl_conv.h:202
const char * CPLGenerateTempFilename(const char *pszStem) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Generate temporary file name.
Definition: cpl_path.cpp:1105
const char * CPLGetFilename(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract non-directory portion of filename.
Definition: cpl_path.cpp:260
double CPLAtofM(const char *)
Converts ASCII string to floating point number using any numeric locale.
Definition: cpl_strtod.cpp:142
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
CPLErr CPLCloseFileInZip(void *hZip)
Close current file inside ZIP file.
Definition: cpl_conv.cpp:3103
void CPLFinderClean(void)
CPLFinderClean.
Definition: cpl_findfile.cpp:134
const char * CPLDefaultFindFile(const char *pszClass, const char *pszBasename)
CPLDefaultFindFile.
Definition: cpl_findfile.cpp:149
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
#define CPLAssert(expr)
Assert on an expression.
Definition: cpl_error.h:186
GIntBig CPLAtoGIntBigEx(const char *pszString, int bWarn, int *pbOverflow)
Convert a string to a 64 bit signed integer.
Definition: cpl_conv.cpp:1050
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
FILE * CPLOpenShared(const char *, const char *, int)
Open a shared file handle.
Definition: cpl_conv.cpp:2335
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
const typedef char *(* CPLFileFinder)(const char *, const char *)
Callback for CPLPushFileFinder.
Definition: cpl_conv.h:179
int CPLCheckForFile(char *pszFilename, char **papszSiblingList)
Check for file existence.
Definition: cpl_conv.cpp:3053
char * CPLGetCurrentDir(void)
Get the current working directory name.
Definition: cpl_path.cpp:396
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:857
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
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1194
void CPLCloseShared(FILE *)
Close shared file.
Definition: cpl_conv.cpp:2408
const char * CPLGetDirname(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Extract directory path portion of filename.
Definition: cpl_path.cpp:208
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
void * CPLCreateZip(const char *pszZipFilename, char **papszOptions)
Create ZIP file.
Definition: cpl_conv.cpp:3091
const char * CPLReadLine3L(VSILFILE *, int, int *, CSLConstList)
Simplified line reading from text file.
Definition: cpl_conv.cpp:682
char ** CPLGetConfigOptions(void)
Return the list of configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1739
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
int CPLPrintString(char *, const char *, int)
Copy the string pointed to by pszSrc, NOT including the terminating ‘\0’ character,...
Definition: cpl_conv.cpp:1223
int CPLIsFilenameRelative(const char *pszFilename)
Is filename relative or absolute?
Definition: cpl_path.cpp:816
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
int CPLMoveFile(const char *pszNewPath, const char *pszOldPath)
Move a file.
Definition: cpl_conv.cpp:2784
float CPLStrtof(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:397
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
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
void CPLSetConfigOption(const char *, const char *)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1832
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:378
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
int CPLUnlinkTree(const char *)
Recursively unlink a directory.
Definition: cpl_conv.cpp:2559
int CPLCopyTree(const char *pszNewPath, const char *pszOldPath)
Recursively copy a tree.
Definition: cpl_conv.cpp:2706
char ** CPLCorrespondingPaths(const char *pszOldFilename, const char *pszNewFilename, char **papszFileList) CPL_WARN_UNUSED_RESULT
Identify corresponding paths.
Definition: cpl_path.cpp:1000
char * pszAccess
Access mode.
Definition: cpl_conv.h:207
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:537
CPLErr CPLWriteFileInZip(void *hZip, const void *pBuffer, int nBufferSize)
Write in current file inside a ZIP file.
Definition: cpl_conv.cpp:3101
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
char * CPLsetlocale(int category, const char *locale)
Prevents parallel executions of setlocale().
Definition: cpl_conv.cpp:2992
int CPLSymlink(const char *pszOldPath, const char *pszNewPath, CSLConstList papszOptions)
Create a symbolic link.
Definition: cpl_conv.cpp:2805
void * CPLRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT
Safe version of realloc().
Definition: cpl_conv.cpp:225
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:939
void * CPLCalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Safe version of calloc().
Definition: cpl_conv.cpp:138
double CPLDecToPackedDMS(double dfDec)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition: cpl_conv.cpp:2256
const char * CPLReadLine(FILE *)
Simplified line reading from text file.
Definition: cpl_conv.cpp:566
int CPLPrintDouble(char *, const char *, double, const char *)
Print double value into specified string buffer.
Definition: cpl_conv.cpp:1444
char * pszFilename
Filename.
Definition: cpl_conv.h:206
CPLErr
Error category.
Definition: cpl_error.h:52
int CPLPrintPointer(char *, void *, int)
Print pointer value into specified string buffer.
Definition: cpl_conv.cpp:1400
double CPLAtof(const char *)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:117
CPLFileFinder CPLPopFileFinder(void)
CPLPopFileFinder.
Definition: cpl_findfile.cpp:235
GUIntBig CPLScanUIntBig(const char *, int)
Extract big integer from string.
Definition: cpl_conv.cpp:964
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:750
CPLErr CPLCreateFileInZip(void *hZip, const char *pszFilename, char **papszOptions)
Create a file in a ZIP file.
Definition: cpl_conv.cpp:3099
int CPLPrintInt32(char *, GInt32, int)
Print GInt32 value into specified string buffer.
Definition: cpl_conv.cpp:1311
float CPLStrtofDelim(const char *, char **, char)
Converts ASCII string to floating point number using specified delimiter.
Definition: cpl_strtod.cpp:347
void CPLPushFileFinder(CPLFileFinder pfnFinder)
CPLPushFileFinder.
Definition: cpl_findfile.cpp:200
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
char ** CPLGetThreadLocalConfigOptions(void)
Return the list of thread local configuration options as KEY=VALUE pairs.
Definition: cpl_conv.cpp:1922
double CPLScanDouble(const char *, int)
Extract double from string.
Definition: cpl_conv.cpp:1171
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
double CPLAtofDelim(const char *, char)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:73
int GInt32
Int32 type.
Definition: cpl_port.h:205
#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:997
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:972
int nRefCount
Reference counter.
Definition: cpl_conv.h:204
FILE * fp
File pointer.
Definition: cpl_conv.h:203
double CPLStrtod(const char *, char **)
Converts ASCII string to floating point number.
Definition: cpl_strtod.cpp:321
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
void CPLSetThreadLocalConfigOption(const char *pszKey, const char *pszValue)
Set a configuration option for GDAL/OGR use.
Definition: cpl_conv.cpp:1885
char * CPLStrlwr(char *)
Convert each characters of the string to lower case.
Definition: cpl_conv.cpp:319
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:657
Generated for GDAL by
1.8.17.