#include "cpl_port.h"
#include "cpl_vsi.h"
#include "cpl_error.h"
Go to the source code of this file.
Defines | |
#define | CPLFree VSIFree |
Typedefs | |
typedef const char* (* | CPLFileFinder )(const char *, const char *) |
Functions | |
void | CPLVerifyConfiguration () |
CPL_C_START void CPL_DLL* | CPLMalloc ( size_t ) |
void CPL_DLL* | CPLCalloc ( size_t, size_t ) |
void CPL_DLL* | CPLRealloc ( void *, size_t ) |
char CPL_DLL* | CPLStrdup ( const char * ) |
const char* | CPLReadLine ( FILE * ) |
void CPL_DLL* | CPLGetSymbol ( const char *, const char * ) |
char CPL_DLL** | CPLReadDir ( const char *pszPath ) |
const char CPL_DLL* | CPLGetPath ( const char * ) |
const char CPL_DLL* | CPLGetFilename ( const char * ) |
const char CPL_DLL* | CPLGetBasename ( const char * ) |
const char CPL_DLL* | CPLGetExtension ( const char * ) |
const char CPL_DLL* | CPLFormFilename ( const char *pszPath, const char *pszBasename, const char *pszExtension ) |
const char CPL_DLL* | CPLFormCIFilename ( const char *pszPath, const char *pszBasename, const char *pszExtension ) |
const char CPL_DLL* | CPLResetExtension ( const char *, const char * ) |
const char CPL_DLL* | CPLFindFile (const char *pszClass, const char *pszBasename) |
const char CPL_DLL* | CPLDefaultFindFile (const char *pszClass, const char *pszBasename) |
void CPL_DLL | CPLPushFileFinder ( CPLFileFinder pfnFinder ) |
CPLFileFinder CPL_DLL | CPLPopFileFinder () |
void CPL_DLL | CPLPushFinderLocation ( const char * ) |
Various convenience functions for CPL.
|
Safe version of calloc(). This function is like the C library calloc(), but raises a CE_Fatal error with CPLError() if it fails to allocate the desired memory. It should be used for small memory allocations that are unlikely to fail and for which the application is unwilling to test for out of memory conditions. It uses VSICalloc() to get the memory, so any hooking of VSICalloc() will apply to CPLCalloc() as well. CPLFree() or VSIFree() can be used free memory allocated by CPLCalloc().
|
|
Case insensitive file searching, returing full path. This function tries to return the path to a file regardless of whether the file exactly matches the basename, and extension case, or is all upper case, or all lower case. The path is treated as case sensitive. This function is equivelent to CPLFormFilename() on case insensitive file systems (like Windows).
|
|
Build a full file path from a passed path, file basename and extension. The path, and extension are optional. The basename may in fact contain an extension if desired.
CPLFormFilename("abc/xyz","def", ".dat" ) == "abc/xyz/def.dat" CPLFormFilename(NULL,"def", NULL ) == "def" CPLFormFilename(NULL,"abc/def.dat", NULL ) == "abc/def.dat" CPLFormFilename("/abc/xyz/","def.dat", NULL ) == "/abc/xyz/def.dat"
|
|
Extract basename (non-directory, non-extension) portion of filename. Returns a string containing the file basename portion of the passed name. If there is no basename (passed value ends in trailing directory separator, or filename starts with a dot) an empty string is returned.
CPLGetBasename( "abc/def.xyz" ) == "def" CPLGetBasename( "abc/def" ) == "def" CPLGetBasename( "abc/def/" ) == ""
|
|
Extract filename extension from full filename. Returns a string containing the extention portion of the passed name. If there is no extension (the filename has no dot) an empty string is returned. The returned extension will not include the period.
CPLGetExtension( "abc/def.xyz" ) == "xyz" CPLGetExtension( "abc/def" ) == ""
|
|
Extract non-directory portion of filename. Returns a string containing the bare filename portion of the passed filename. If there is no filename (passed value ends in trailing directory separator) an empty string is returned.
CPLGetFilename( "abc/def.xyz" ) == "def.xyz" CPLGetFilename( "/abc/def/" ) == "" CPLGetFilename( "abc/def" ) == "def"
|
|
Extract directory path portion of filename. Returns a string containing the directory path portion of the passed filename. If there is no path in the passed filename an empty string will be returned (not NULL).
CPLGetPath( "abc/def.xyz" ) == "abc" CPLGetPath( "/abc/def/" ) == "abc/def" CPLGetPath( "/" ) == "/" CPLGetPath( "/abc/def" ) == "/abc"
|
|
Fetch a function pointer from a shared library / DLL. This function is meant to abstract access to shared libraries and DLLs and performs functions similar to dlopen()/dlsym() on Unix and LoadLibrary() / GetProcAddress() on Windows. If no support for loading entry points from a shared library is available this function will always return NULL. Rules on when this function issues a CPLError() or not are not currently well defined, and will have to be resolved in the future. Currently CPLGetSymbol() doesn't try to:
Some of these issues may be worked on in the future.
|
|
Safe version of malloc(). This function is like the C library malloc(), but raises a CE_Fatal error with CPLError() if it fails to allocate the desired memory. It should be used for small memory allocations that are unlikely to fail and for which the application is unwilling to test for out of memory conditions. It uses VSIMalloc() to get the memory, so any hooking of VSIMalloc() will apply to CPLMalloc() as well. CPLFree() or VSIFree() can be used free memory allocated by CPLMalloc().
|
|
Simplified line reading from text file. Read a line of text from the given file handle, taking care to capture CR and/or LF and strip off ... equivelent of DKReadLine(). Pointer to an internal buffer is returned. The application shouldn't free it, or depend on it's value past the next call to CPLReadLine(). Note that CPLReadLine() uses VSIFGets(), so any hooking of VSI file services should apply to CPLReadLine() as well. CPLReadLine() maintains an internal buffer, which will appear as a single block memory leak in some circumstances. CPLReadLine() may be called with a NULL FILE * at any time to free this working buffer.
|
|
Safe version of realloc(). This function is like the C library realloc(), but raises a CE_Fatal error with CPLError() if it fails to allocate the desired memory. It should be used for small memory allocations that are unlikely to fail and for which the application is unwilling to test for out of memory conditions. It uses VSIRealloc() to get the memory, so any hooking of VSIRealloc() will apply to CPLRealloc() as well. CPLFree() or VSIFree() can be used free memory allocated by CPLRealloc(). It is also safe to pass NULL in as the existing memory block for CPLRealloc(), in which case it uses VSIMalloc() to allocate a new block.
|
|
Replace the extension with the provided one.
|
|
Safe version of strdup() function. This function is similar to the C library strdup() function, but if the memory allocation fails it will issue a CE_Fatal error with CPLError() instead of returning NULL. It uses VSIStrdup(), so any hooking of that function will apply to CPLStrdup() as well. Memory allocated with CPLStrdup() can be freed with CPLFree() or VSIFree(). It is also safe to pass a NULL string into CPLStrdup(). CPLStrdup() will allocate and return a zero length string (as opposed to a NULL string).
|