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))
133 bool CPL_DLL CPLTestBool(
const char *pszValue );
134 bool CPL_DLL CPLFetchBool(
CSLConstList papszStrList,
const char *pszKey,
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
205 size_t CPL_DLL
CPLStrlcpy(
char* pszDest,
const char* pszSrc,
size_t nDestSize);
206 size_t CPL_DLL
CPLStrlcat(
char* pszDest,
const char* pszSrc,
size_t nDestSize);
207 size_t CPL_DLL
CPLStrnlen(
const char *pszStr,
size_t nMaxLen);
212 int CPL_DLL CPLvsnprintf(
char *str,
size_t size,
219 #if defined(ALIAS_CPLSNPRINTF_AS_SNPRINTF)
220 #define CPLsnprintf snprintf
222 int CPL_DLL CPLsnprintf(
char *str,
size_t size,
228 #if defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
231 CPL_WARN_DEPRECATED("Use CPLsnprintf instead");
243 int CPL_DLL CPLsscanf( const
char* str,
250 char CPL_DLL **CSLAppendPrintf(
char **papszStrList,
253 int CPL_DLL CPLVASPrintf(
char **buf,
261 #define CPL_ENC_LOCALE ""
263 #define CPL_ENC_UTF8 "UTF-8"
265 #define CPL_ENC_UTF16 "UTF-16"
267 #define CPL_ENC_UCS2 "UCS-2"
269 #define CPL_ENC_UCS4 "UCS-4"
271 #define CPL_ENC_ASCII "ASCII"
273 #define CPL_ENC_ISO8859_1 "ISO-8859-1"
277 void CPL_DLL CPLClearRecodeWarningFlags(
void );
280 const char *pszSource,
const char *pszSrcEncoding,
283 const wchar_t *pwszSource,
const char *pszSrcEncoding,
286 const char *pszSource,
const char *pszSrcEncoding,
288 int CPL_DLL
CPLIsUTF8(
const char* pabyData,
int nLen );
290 const char* pabyData,
int nLen,
299 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
320 # define CPLSTRING_DLL CPL_DLL
322 template<
class Dummy =
void >
class CPLStringT;
323 typedef CPLStringT<> CPLString;
325 template<
class Dummy >
326 class CPLStringT :
public std::string
331 # define CPLSTRING_DLL
332 # define CPLStringT CPLString
335 class CPL_DLL CPLString :
public std::string
346 CPLStringT(
const std::string &oStr ) : std::string( oStr ) {}
349 CPLStringT(
const char *pszStr ) : std::string( pszStr ) {}
351 CPLStringT(
const char *pszStr,
size_t n ) : std::string( pszStr, n ) {}
354 operator const char* (void)
const {
return c_str(); }
357 char& operator[](std::string::size_type i)
359 return std::string::operator[](i);
363 const char& operator[](std::string::size_type i)
const
365 return std::string::operator[](i);
369 char& operator[](
int i)
371 return std::string::operator[](
372 static_cast<std::string::size_type
>(i));
376 const char& operator[](
int i)
const
378 return std::string::operator[](
379 static_cast<std::string::size_type
>(i));
383 void Clear() { resize(0); }
388 void Seize(
char *pszValue )
390 if (pszValue ==
nullptr )
401 CPLSTRING_DLL CPLString &Printf(
404 CPLSTRING_DLL CPLString &vPrintf(
407 CPLSTRING_DLL CPLString &FormatC(
double dfValue, const
char *pszFormat =
nullptr );
408 CPLSTRING_DLL CPLString &Trim();
409 CPLSTRING_DLL CPLString &Recode( const
char *pszSrcEncoding, const
char *pszDstEncoding );
410 CPLSTRING_DLL CPLString &replaceAll(
411 const std::
string &osBefore, const std::
string& osAfter );
412 CPLSTRING_DLL CPLString &replaceAll( const std::
string &osBefore,
char chAfter );
413 CPLSTRING_DLL CPLString &replaceAll(
char chBefore, const std::
string &osAfter );
414 CPLSTRING_DLL CPLString &replaceAll(
char chBefore,
char chAfter );
417 CPLSTRING_DLL
size_t ifind( const std::
string & str,
size_t pos = 0 ) const;
418 CPLSTRING_DLL
size_t ifind( const
char * s,
size_t pos = 0 ) const;
419 CPLSTRING_DLL CPLString &toupper(
void );
420 CPLSTRING_DLL CPLString &tolower(
void );
422 CPLSTRING_DLL
bool endsWith( const std::
string& osStr ) const;
431 CPLString CPL_DLL CPLOvPrintf(
438 CPLString CPL_DLL CPLURLGetValue(const
char* pszURL, const
char* pszKey);
439 CPLString CPL_DLL CPLURLAddKVP(const
char* pszURL, const
char* pszKey,
440 const
char* pszValue);
447 class CPL_DLL CPLStringList
451 mutable int nAllocation;
456 void MakeOurOwnCopy();
457 void EnsureAllocation(
int nMaxLength );
458 int FindSortedInsertionPoint(
const char *pszLine );
462 CPLStringList(
char **papszList,
int bTakeOwnership=TRUE );
465 CPLStringList(
const CPLStringList& oOther );
468 CPLStringList &Clear();
471 int size()
const {
return Count(); }
475 bool empty()
const {
return Count() == 0; }
477 CPLStringList &AddString(
const char *pszNewString );
478 CPLStringList &AddStringDirectly(
char *pszNewString );
480 CPLStringList &InsertString(
int nInsertAtLineNo,
const char *pszNewLine )
481 {
return InsertStringDirectly( nInsertAtLineNo,
CPLStrdup(pszNewLine) ); }
482 CPLStringList &InsertStringDirectly(
int nInsertAtLineNo,
char *pszNewLine);
488 int FindString(
const char *pszTarget )
const
491 int PartialFindString(
const char *pszNeedle )
const
494 int FindName(
const char *pszName )
const;
495 bool FetchBool(
const char *pszKey,
bool bDefault )
const;
497 int FetchBoolean(
const char *pszKey,
int bDefault )
const;
498 const char *FetchNameValue(
const char *pszKey )
const;
499 const char *FetchNameValueDef(
500 const char *pszKey,
const char *pszDefault )
const;
501 CPLStringList &AddNameValue(
const char *pszKey,
const char *pszValue );
502 CPLStringList &SetNameValue(
const char *pszKey,
const char *pszValue );
504 CPLStringList &Assign(
char **papszListIn,
int bTakeOwnership=TRUE );
506 CPLStringList &operator=(
char **papszListIn) {
507 return Assign( papszListIn, TRUE ); }
509 CPLStringList &operator=(
const CPLStringList& oOther);
514 char * operator[](
int i);
516 char * operator[](
size_t i) {
return (*
this)[
static_cast<int>(i)]; }
518 const char * operator[](
int i)
const;
520 const char * operator[](
size_t i)
const {
521 return (*
this)[
static_cast<int>(i)]; }
523 const char * operator[](
const char* pszKey)
const {
524 return FetchNameValue(pszKey); }
527 char** List() {
return papszList; }
532 CPLStringList &Sort();
534 int IsSorted()
const {
return bIsSorted; }
537 operator char**(void) {
return List(); }
542 #ifdef GDAL_COMPILATION
547 struct CSLDestroyReleaser
549 void operator()(
char** papszStr)
const {
CSLDestroy(papszStr); }
554 using CSLUniquePtr = std::unique_ptr< char*, CSLDestroyReleaser>;
CPLValueType CPL_DLL CPLGetValueType(const char *pszValue)
Definition: cpl_string.cpp:2566
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:904
int CPL_DLL CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:704
unsigned char GByte
Definition: cpl_port.h:213
char CPL_DLL ** CSLAddNameValue(char **papszStrList, const char *pszName, const char *pszValue) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:1838
char CPL_DLL ** CSLLoad2(const char *pszFname, int nMaxLines, int nMaxCols, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:316
int CPL_DLL CSLPrint(CSLConstList papszStrList, FILE *fpOut)
Definition: cpl_string.cpp:461
int CPL_DLL CSLFindName(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1708
size_t CPL_DLL CPLStrlcpy(char *pszDest, const char *pszSrc, size_t nDestSize)
Definition: cpl_string.cpp:2698
char CPL_DLL * CPLEscapeString(const char *pszString, int nLength, int nScheme) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:2032
int CPL_DLL CPLEncodingCharSize(const char *pszEncoding)
Definition: cpl_recode.cpp:318
char CPL_DLL ** CSLDuplicate(CSLConstList papszStrList) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:228
void CPL_DLL CPL_STDCALL CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
@ CPL_VALUE_STRING
Definition: cpl_string.h:198
size_t CPL_DLL CPLStrnlen(const char *pszStr, size_t nMaxLen)
Definition: cpl_string.cpp:2790
char CPL_DLL * CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Definition: cpl_conv.cpp:293
char CPL_DLL ** CSLInsertString(char **papszStrList, int nInsertAtLineNo, const char *pszNewLine) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:562
int CPL_DLL CSLSave(CSLConstList papszStrList, const char *pszFname)
Definition: cpl_string.cpp:412
int CPL_DLL CPLBase64DecodeInPlace(GByte *pszBase64) CPL_WARN_UNUSED_RESULT
Definition: cpl_base64.cpp:93
char CPL_DLL ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:836
char CPL_DLL ** CSLMerge(char **papszOrig, CSLConstList papszOverride) CPL_WARN_UNUSED_RESULT
Merge two lists.
Definition: cpl_string.cpp:268
char CPL_DLL ** CSLFetchNameValueMultiple(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1801
int CPL_DLL CPLStrlenUTF8(const char *pszUTF8Str)
Definition: cpl_recode.cpp:363
int CPL_DLL CPLIsUTF8(const char *pabyData, int nLen)
Definition: cpl_recode.cpp:251
char ** CSLConstList
Definition: cpl_port.h:1184
const char CPL_DLL * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
#define CPL_SCAN_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:906
char CPL_DLL * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:2243
int CPL_DLL CSLCount(CSLConstList papszStrList)
Definition: cpl_string.cpp:147
char CPL_DLL * CPLBase64Encode(int nBytes, const GByte *pabyData) CPL_WARN_UNUSED_RESULT
Definition: cpl_base64.cpp:199
char CPL_DLL ** CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete, int nNumToRemove, char ***ppapszRetStrings) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:588
char CPL_DLL ** CSLParseCommandLine(const char *pszCommandLine)
Definition: cpl_string.cpp:2814
wchar_t CPL_DLL * CPLRecodeToWChar(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT
Definition: cpl_recode.cpp:208
const char CPL_DLL * CSLGetField(CSLConstList, int)
Definition: cpl_string.cpp:173
char CPL_DLL * CPLRecode(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Definition: cpl_recode.cpp:81
@ CPL_VALUE_INTEGER
Definition: cpl_string.h:200
size_t CPL_DLL CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize)
Definition: cpl_string.cpp:2755
CPL_C_START char CPL_DLL ** CSLAddString(char **papszStrList, const char *pszNewString) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:83
int CPL_DLL CSLFindString(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:670
char CPL_DLL * CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding, const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT
Definition: cpl_recode.cpp:149
#define CPL_SCANF_FORMAT_STRING(arg)
Definition: cpl_port.h:921
@ CPL_VALUE_REAL
Definition: cpl_string.h:199
CPLValueType
Definition: cpl_string.h:196
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:919
GByte CPL_DLL * CPLHexToBinary(const char *pszHex, int *pnBytes) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:2527
char CPL_DLL ** CSLAddStringMayFail(char **papszStrList, const char *pszNewString) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:92
int CPL_DLL CPLTestBoolean(const char *pszValue)
Definition: cpl_string.cpp:1575
void CPL_DLL CSLSetNameValueSeparator(char **papszStrList, const char *pszSeparator)
Definition: cpl_string.cpp:1957
int CPL_DLL CSLFetchBoolean(CSLConstList papszStrList, const char *pszKey, int bDefault)
Definition: cpl_string.cpp:1635
#define CPL_WARN_UNUSED_RESULT
Definition: cpl_port.h:929
const char CPL_DLL * CSLFetchNameValue(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1674
char CPL_DLL * CPLBinaryToHex(int nBytes, const GByte *pabyData) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:2469
char CPL_DLL ** CSLTokenizeString(const char *pszString) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:759
char CPL_DLL ** CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter, int bHonourStrings, int bAllowEmptyTokens) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:769
char CPL_DLL ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:1877
const char CPL_DLL * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Definition: cpl_string.cpp:1754
int CPL_DLL CSLPartialFindString(CSLConstList papszHaystack, const char *pszNeedle)
Definition: cpl_string.cpp:737
#define CPLFree
Definition: cpl_conv.h:81
int CPL_DLL CSLTestBoolean(const char *pszValue)
Definition: cpl_string.cpp:1553
char CPL_DLL * CPLForceToASCII(const char *pabyData, int nLen, char chReplacementChar) CPL_WARN_UNUSED_RESULT
Definition: cpl_recode.cpp:276
#define CPL_RETURNS_NONNULL
Definition: cpl_port.h:962
char CPL_DLL ** CSLLoad(const char *pszFname) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:397
char CPL_DLL ** CSLInsertStrings(char **papszStrList, int nInsertAtLineNo, CSLConstList papszNewLines) CPL_WARN_UNUSED_RESULT
Definition: cpl_string.cpp:497