Go to the documentation of this file.
32 #ifndef CPL_STRING_H_INCLUDED
33 #define CPL_STRING_H_INCLUDED
69 void CPL_DLL CPL_STDCALL
CSLDestroy(
char **papszStrList);
71 char CPL_DLL **
CSLMerge(
char **papszOrig,
76 const char *pszString,
const char *pszDelimiter,
int bHonourStrings,
79 const char *pszDelimiter,
83 #define CSLT_HONOURSTRINGS 0x0001
85 #define CSLT_ALLOWEMPTYTOKENS 0x0002
87 #define CSLT_PRESERVEQUOTES 0x0004
89 #define CSLT_PRESERVEESCAPES 0x0008
91 #define CSLT_STRIPLEADSPACES 0x0010
93 #define CSLT_STRIPENDSPACES 0x0020
98 const char *pszFname,
int nMaxLines,
int nMaxCols,
104 char CPL_DLL **
CSLInsertString(
char **papszStrList,
int nInsertAtLineNo,
107 char **papszStrList,
int nFirstLineToDelete,
111 const char *pszTarget );
113 const char *pszNeedle );
123 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
124 #ifdef DO_NOT_USE_DEBUG_BOOL
125 #define CPLTestBool(x) CPL_TO_BOOL(CPLTestBoolean(x))
126 #define CPLFetchBool(list,key,default) \
127 CPL_TO_BOOL(CSLFetchBoolean(list,key,default))
150 const char *pszDefault );
162 const char *pszSeparator );
167 #define CPLES_BackslashQuotable 0
177 #define CPLES_XML_BUT_QUOTES 5
179 #define CPLES_CSV_FORCE_QUOTING 6
207 size_t CPL_DLL
CPLStrlcpy(
char* pszDest,
const char* pszSrc,
size_t nDestSize);
208 size_t CPL_DLL
CPLStrlcat(
char* pszDest,
const char* pszSrc,
size_t nDestSize);
209 size_t CPL_DLL
CPLStrnlen(
const char *pszStr,
size_t nMaxLen);
221 #if defined(ALIAS_CPLSNPRINTF_AS_SNPRINTF)
222 #define CPLsnprintf snprintf
230 #if defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
245 int CPL_DLL CPLsscanf( const
char* str,
263 #define CPL_ENC_LOCALE ""
265 #define CPL_ENC_UTF8 "UTF-8"
267 #define CPL_ENC_UTF16 "UTF-16"
269 #define CPL_ENC_UCS2 "UCS-2"
271 #define CPL_ENC_UCS4 "UCS-4"
273 #define CPL_ENC_ASCII "ASCII"
275 #define CPL_ENC_ISO8859_1 "ISO-8859-1"
279 void CPL_DLL CPLClearRecodeWarningFlags(
void );
282 const char *pszSource,
const char *pszSrcEncoding,
285 const wchar_t *pwszSource,
const char *pszSrcEncoding,
288 const char *pszSource,
const char *pszSrcEncoding,
290 int CPL_DLL
CPLIsUTF8(
const char* pabyData,
int nLen );
292 const char* pabyData,
int nLen,
301 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
319 # define CPLSTRING_CLASS_DLL
320 # define CPLSTRING_METHOD_DLL CPL_DLL
323 # define CPLSTRING_CLASS_DLL CPL_DLL
324 # define CPLSTRING_METHOD_DLL
329 class CPLSTRING_CLASS_DLL
CPLString :
public std::string
337 CPLString(
const std::string &oStr ) : std::string( oStr ) {}
340 CPLString(
const char *pszStr ) : std::string( pszStr ) {}
342 CPLString(
const char *pszStr,
size_t n ) : std::string( pszStr, n ) {}
345 operator const char* (void)
const {
return c_str(); }
348 char& operator[](std::string::size_type i)
350 return std::string::operator[](i);
354 const char& operator[](std::string::size_type i)
const
356 return std::string::operator[](i);
360 char& operator[](
int i)
362 return std::string::operator[](
363 static_cast<std::string::size_type>(i));
367 const char& operator[](
int i)
const
369 return std::string::operator[](
370 static_cast<std::string::size_type>(i));
374 void Clear() { resize(0); }
379 void Seize(
char *pszValue )
381 if (pszValue ==
nullptr )
398 CPLSTRING_METHOD_DLL
CPLString &FormatC(
double dfValue, const
char *pszFormat =
nullptr );
400 CPLSTRING_METHOD_DLL
CPLString &Recode( const
char *pszSrcEncoding, const
char *pszDstEncoding );
401 CPLSTRING_METHOD_DLL
CPLString &replaceAll(
402 const std::
string &osBefore, const std::
string& osAfter );
403 CPLSTRING_METHOD_DLL
CPLString &replaceAll( const std::
string &osBefore,
char chAfter );
404 CPLSTRING_METHOD_DLL
CPLString &replaceAll(
char chBefore, const std::
string &osAfter );
405 CPLSTRING_METHOD_DLL
CPLString &replaceAll(
char chBefore,
char chAfter );
408 CPLSTRING_METHOD_DLL
size_t ifind( const std::
string & str,
size_t pos = 0 ) const;
409 CPLSTRING_METHOD_DLL
size_t ifind( const
char * s,
size_t pos = 0 ) const;
410 CPLSTRING_METHOD_DLL
CPLString &toupper(
void );
411 CPLSTRING_METHOD_DLL
CPLString &tolower(
void );
413 CPLSTRING_METHOD_DLL
bool endsWith( const std::
string& osStr ) const;
416 #undef CPLSTRING_CLASS_DLL
417 #undef CPLSTRING_METHOD_DLL
431 const
char* pszValue);
440 char **papszList =
nullptr;
441 mutable int nCount = 0;
442 mutable int nAllocation = 0;
443 bool bOwnList =
false;
444 bool bIsSorted =
false;
446 void MakeOurOwnCopy();
447 void EnsureAllocation(
int nMaxLength );
448 int FindSortedInsertionPoint(
const char *pszLine );
452 explicit CPLStringList(
char **papszList,
int bTakeOwnership=TRUE );
460 int size()
const {
return Count(); }
464 bool empty()
const {
return Count() == 0; }
469 CPLStringList &InsertString(
int nInsertAtLineNo,
const char *pszNewLine )
470 {
return InsertStringDirectly( nInsertAtLineNo,
CPLStrdup(pszNewLine) ); }
471 CPLStringList &InsertStringDirectly(
int nInsertAtLineNo,
char *pszNewLine);
477 int FindString(
const char *pszTarget )
const
480 int PartialFindString(
const char *pszNeedle )
const
483 int FindName(
const char *pszName )
const;
484 bool FetchBool(
const char *pszKey,
bool bDefault )
const;
486 int FetchBoolean(
const char *pszKey,
int bDefault )
const;
487 const char *FetchNameValue(
const char *pszKey )
const;
488 const char *FetchNameValueDef(
489 const char *pszKey,
const char *pszDefault )
const;
490 CPLStringList &AddNameValue(
const char *pszKey,
const char *pszValue );
491 CPLStringList &SetNameValue(
const char *pszKey,
const char *pszValue );
493 CPLStringList &Assign(
char **papszListIn,
int bTakeOwnership=TRUE );
496 return Assign( papszListIn, TRUE ); }
503 char * operator[](
int i);
505 char * operator[](
size_t i) {
return (*
this)[static_cast<int>(i)]; }
507 const char * operator[](
int i)
const;
509 const char * operator[](
size_t i)
const {
510 return (*
this)[static_cast<int>(i)]; }
512 const char * operator[](
const char* pszKey)
const {
513 return FetchNameValue(pszKey); }
516 char** List() {
return papszList; }
523 int IsSorted()
const {
return bIsSorted; }
526 operator char**(void) {
return List(); }
531 #ifdef GDAL_COMPILATION
536 struct CPL_DLL CSLDestroyReleaser
538 void operator()(
char** papszStr)
const {
CSLDestroy(papszStr); }
543 using CSLUniquePtr = std::unique_ptr< char*, CSLDestroyReleaser>;
546 struct CPL_DLL CPLFreeReleaser
548 void operator()(
void* p)
const {
CPLFree(p); }
553 using CPLCharUniquePtr = std::unique_ptr<char, CPLFreeReleaser>;
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:912
char ** CSLAddString(char **papszStrList, const char *pszNewString) CPL_WARN_UNUSED_RESULT
Append a string to a StringList and return a pointer to the modified StringList.
Definition: cpl_string.cpp:81
char * CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Safe version of strdup() function.
Definition: cpl_conv.cpp:292
int CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Find a string within a string list(case sensitive)
Definition: cpl_string.cpp:697
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:214
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags) CPL_WARN_UNUSED_RESULT
Tokenize a string.
Definition: cpl_string.cpp:828
CPLString CPLURLAddKVP(const char *pszURL, const char *pszKey, const char *pszValue)
Return a new URL with a new key=value pair.
Definition: cplstring.cpp:454
int CPLIsUTF8(const char *pabyData, int nLen)
Test if a string is encoded as UTF-8.
Definition: cpl_recode.cpp:250
char ** CSLMerge(char **papszOrig, CSLConstList papszOverride) CPL_WARN_UNUSED_RESULT
Merge two lists.
Definition: cpl_string.cpp:266
CPLString CPLOvPrintf(const char *pszFormat, va_list args)
Return a CPLString with the content of vsprintf()
Definition: cplstring.cpp:523
size_t CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize)
Appends a source string to a destination buffer.
Definition: cpl_string.cpp:2745
char * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme) CPL_WARN_UNUSED_RESULT
Unescape a string.
Definition: cpl_string.cpp:2232
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:437
int CSLFindName(CSLConstList papszStrList, const char *pszName)
Find StringList entry with given key name.
Definition: cpl_string.cpp:1695
CPLValueType CPLGetValueType(const char *pszValue)
Detect the type of the value contained in a string, whether it is a real, an integer or a string Lead...
Definition: cpl_string.cpp:2556
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Same as CSLFetchNameValue() but return pszDefault in case of no match.
Definition: cpl_string.cpp:1634
int CPLsnprintf(char *str, size_t size, const char *fmt,...)
snprintf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1327
char * CPLEscapeString(const char *pszString, int nLength, int nScheme) CPL_WARN_UNUSED_RESULT
Apply escaping to string to preserve special characters.
Definition: cpl_string.cpp:2020
int CSLCount(CSLConstList papszStrList)
Return number of items in a string list.
Definition: cpl_string.cpp:145
Convenient string class based on std::string.
Definition: cpl_string.h:328
bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey, bool bDefault)
Check for boolean key value.
Definition: cpl_string.cpp:1589
String.
Definition: cpl_string.h:199
int CSLPartialFindString(CSLConstList papszHaystack, const char *pszNeedle)
Find a substring within a string list.
Definition: cpl_string.cpp:730
GByte * CPLHexToBinary(const char *pszHex, int *pnBytes) CPL_WARN_UNUSED_RESULT
Hexadecimal to binary translation.
Definition: cpl_string.cpp:2517
char ** CSLInsertString(char **papszStrList, int nInsertAtLineNo, const char *pszNewLine) CPL_WARN_UNUSED_RESULT
Insert a string at a given line number inside a StringList.
Definition: cpl_string.cpp:556
const char * CSLGetField(CSLConstList, int)
Fetches the indicated field, being careful not to crash if the field doesn't exist within this string...
Definition: cpl_string.cpp:171
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:336
int CSLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1543
char * CPLRecode(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Convert a string from a source encoding to a destination encoding.
Definition: cpl_recode.cpp:80
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue) CPL_WARN_UNUSED_RESULT
Assign value to name in StringList.
Definition: cpl_string.cpp:1861
bool CPLTestBool(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1516
int CPLprintf(const char *fmt,...)
printf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1383
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1192
int CPLVASPrintf(char **buf, const char *fmt, va_list args)
This is intended to serve as an easy to use C callable vasprintf() alternative.
Definition: cpl_string.cpp:1038
size_t CPLStrlcpy(char *pszDest, const char *pszSrc, size_t nDestSize)
Copy source string to a destination buffer.
Definition: cpl_string.cpp:2688
char * CPLBinaryToHex(int nBytes, const GByte *pabyData) CPL_WARN_UNUSED_RESULT
Binary to hexadecimal translation.
Definition: cpl_string.cpp:2459
#define CPL_SCAN_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have scanf() formatting.
Definition: cpl_port.h:914
CPLString CPLURLGetValue(const char *pszURL, const char *pszKey)
Return the value matching a key from a key=value pair in a URL.
Definition: cplstring.cpp:421
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:338
const char * CPLSPrintf(const char *fmt,...) CPL_WARN_UNUSED_RESULT
CPLSPrintf() that works with 10 static buffer.
Definition: cpl_string.cpp:968
int CSLPrint(CSLConstList papszStrList, FILE *fpOut)
Print a StringList to fpOut.
Definition: cpl_string.cpp:457
char ** CSLLoad(const char *pszFname) CPL_WARN_UNUSED_RESULT
Load a text file into a string list.
Definition: cpl_string.cpp:395
char ** CSLAppendPrintf(char **papszStrList, const char *fmt,...) CPL_WARN_UNUSED_RESULT
Use CPLSPrintf() to append a new line at the end of a StringList.
Definition: cpl_string.cpp:1019
int CSLFindString(CSLConstList papszList, const char *pszTarget)
Find a string within a string list (case insensitive).
Definition: cpl_string.cpp:663
Integer.
Definition: cpl_string.h:201
int CPLvsnprintf(char *str, size_t size, const char *fmt, va_list args)
vsnprintf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1130
int CPLStrlenUTF8(const char *pszUTF8Str)
Return the number of UTF-8 characters of a nul-terminated string.
Definition: cpl_recode.cpp:362
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Parse NAME=VALUE string into name and value components.
Definition: cpl_string.cpp:1740
char ** CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete, int nNumToRemove, char ***ppapszRetStrings) CPL_WARN_UNUSED_RESULT
Remove strings inside a StringList.
Definition: cpl_string.cpp:581
int CPLEncodingCharSize(const char *pszEncoding)
Return bytes per character for encoding.
Definition: cpl_recode.cpp:317
size_t CPLStrnlen(const char *pszStr, size_t nMaxLen)
Returns the length of a NUL terminated string by reading at most the specified number of bytes.
Definition: cpl_string.cpp:2780
wchar_t * CPLRecodeToWChar(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT
Convert UTF-8 string to a wchar_t string.
Definition: cpl_recode.cpp:207
int CSLSave(CSLConstList papszStrList, const char *pszFname)
Write a StringList to a text file.
Definition: cpl_string.cpp:409
#define CPL_SCANF_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a sscanf-like function.
Definition: cpl_port.h:929
int CPLBase64DecodeInPlace(GByte *pszBase64) CPL_WARN_UNUSED_RESULT
Decode base64 string "pszBase64" (null terminated) in place.
Definition: cpl_base64.cpp:92
void CSLDestroy(char **papszStrList)
Free string list.
Definition: cpl_string.cpp:198
Real number.
Definition: cpl_string.h:200
CPLValueType
Type of value.
Definition: cpl_string.h:197
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:937
char ** CSLTokenizeString(const char *pszString) CPL_WARN_UNUSED_RESULT
Tokenizes a string and returns a StringList with one string for each token.
Definition: cpl_string.cpp:751
char ** CSLDuplicate(CSLConstList papszStrList) CPL_WARN_UNUSED_RESULT
Clone a string list.
Definition: cpl_string.cpp:226
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:927
char ** CSLInsertStrings(char **papszStrList, int nInsertAtLineNo, CSLConstList papszNewLines) CPL_WARN_UNUSED_RESULT
Copies the contents of a StringList inside another StringList before the specified line.
Definition: cpl_string.cpp:492
void CSLSetNameValueSeparator(char **papszStrList, const char *pszSeparator)
Replace the default separator (":" or "=") with the passed separator in the given name/value list.
Definition: cpl_string.cpp:1941
char * CPLBase64Encode(int nBytes, const GByte *pabyData) CPL_WARN_UNUSED_RESULT
Base64 encode a buffer.
Definition: cpl_base64.cpp:198
char ** CSLFetchNameValueMultiple(CSLConstList papszStrList, const char *pszName)
In a StringList of "Name=Value" pairs, look for all the values with the specified name.
Definition: cpl_string.cpp:1786
char ** CSLAddStringMayFail(char **papszStrList, const char *pszNewString) CPL_WARN_UNUSED_RESULT
Same as CSLAddString() but may return NULL in case of (memory) failure.
Definition: cpl_string.cpp:90
int CPLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1565
char * CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding, const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT
Convert wchar_t string to UTF-8.
Definition: cpl_recode.cpp:148
char ** CSLAddNameValue(char **papszStrList, const char *pszName, const char *pszValue) CPL_WARN_UNUSED_RESULT
Add a new entry to a StringList of "Name=Value" pairs, ("Name:Value" pairs are also supported for bac...
Definition: cpl_string.cpp:1822
const char * CSLFetchNameValue(CSLConstList papszStrList, const char *pszName)
In a StringList of "Name=Value" pairs, look for the first value associated with the specified name.
Definition: cpl_string.cpp:1661
char * CPLForceToASCII(const char *pabyData, int nLen, char chReplacementChar) CPL_WARN_UNUSED_RESULT
Return a new string that is made only of ASCII characters.
Definition: cpl_recode.cpp:275
CPLString CPLOPrintf(const char *pszFormat,...)
Return a CPLString with the content of sprintf()
Definition: cplstring.cpp:504
char ** CSLLoad2(const char *pszFname, int nMaxLines, int nMaxCols, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT
Load a text file into a string list.
Definition: cpl_string.cpp:314
char ** CSLParseCommandLine(const char *pszCommandLine)
Tokenize command line arguments in a list of strings.
Definition: cpl_string.cpp:2804
char ** CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter, int bHonourStrings, int bAllowEmptyTokens) CPL_WARN_UNUSED_RESULT
Obsolete tokenizing api.
Definition: cpl_string.cpp:761
int CSLFetchBoolean(CSLConstList papszStrList, const char *pszKey, int bDefault)
DEPRECATED.
Definition: cpl_string.cpp:1623
CPLString CPLQuotedSQLIdentifier(const char *pszIdent)
Return a CPLString of the SQL quoted identifier.
Definition: cplstring.cpp:536
#define CPLFree
Alias of VSIFree()
Definition: cpl_conv.h:80
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:970
Generated for GDAL by
1.8.16.