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
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);
219 #if defined(ALIAS_CPLSNPRINTF_AS_SNPRINTF)
220 #define CPLsnprintf snprintf
228 #if defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
243 int CPL_DLL CPLsscanf( const
char* str,
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;
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 ) {}
351 CPLStringT(
const char *pszStr,
size_t n ) : std::string( pszStr, n ) {}
354 operator const char* (void)
const {
return c_str(); }
359 return std::string::operator[](i);
365 return std::string::operator[](i);
371 return std::string::operator[](
372 static_cast<std::string::size_type
>(i));
378 return std::string::operator[](
379 static_cast<std::string::size_type
>(i));
390 if (pszValue ==
nullptr )
407 CPLSTRING_DLL
CPLString &FormatC(
double dfValue, const
char *pszFormat =
nullptr );
409 CPLSTRING_DLL
CPLString &Recode( const
char *pszSrcEncoding, const
char *pszDstEncoding );
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;
440 const
char* pszValue);
451 mutable int nAllocation;
456 void MakeOurOwnCopy();
457 void EnsureAllocation(
int nMaxLength );
458 int FindSortedInsertionPoint(
const char *pszLine );
471 int size()
const {
return Count(); }
475 bool empty()
const {
return Count() == 0; }
481 {
return InsertStringDirectly( nInsertAtLineNo,
CPLStrdup(pszNewLine) ); }
482 CPLStringList &InsertStringDirectly(
int nInsertAtLineNo,
char *pszNewLine);
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 );
507 return Assign( papszListIn, TRUE ); }
516 char *
operator[](
size_t i) {
return (*
this)[
static_cast<int>(i)]; }
521 return (*
this)[
static_cast<int>(i)]; }
524 return FetchNameValue(pszKey); }
527 char**
List() {
return papszList; }
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>;
char ** CSLLoad2(const char *pszFname, int nMaxLines, int nMaxCols, CSLConstList papszOptions)
Definition: cpl_string.cpp:316
CPLStringList & operator=(char **papszListIn)
Definition: cpl_string.h:506
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:904
char * CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Definition: cpl_recode.cpp:149
char ** CSLInsertString(char **papszStrList, int nInsertAtLineNo, const char *pszNewLine)
Definition: cpl_string.cpp:562
const char * CPLReadLineL(VSILFILE *)
Definition: cpl_conv.cpp:630
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:836
int CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:704
unsigned char GByte
Definition: cpl_port.h:213
#define CPLES_CSV
Definition: cpl_string.h:175
#define CPLES_XML_BUT_QUOTES
Definition: cpl_string.h:177
CPLString CPLURLAddKVP(const char *pszURL, const char *pszKey, const char *pszValue)
Definition: cplstring.cpp:476
char ** CSLMerge(char **papszOrig, CSLConstList papszOverride)
Merge two lists.
Definition: cpl_string.cpp:268
int CPLIsUTF8(const char *pabyData, int nLen)
Definition: cpl_recode.cpp:251
char * CPLEscapeString(const char *pszString, int nLength, int nScheme)
Definition: cpl_string.cpp:2032
char ** CSLLoad(const char *pszFname)
Definition: cpl_string.cpp:397
#define CSLT_PRESERVEESCAPES
Definition: cpl_string.h:89
CPLSTRING_DLL CPLString & Printf(const char *pszFormat,...)
Definition: cplstring.cpp:67
CPLString CPLOvPrintf(const char *pszFormat, va_list args)
Definition: cplstring.cpp:545
CPLStringList & InsertString(int nInsertAtLineNo, const char *pszNewLine)
Insert into the list at identified location.
Definition: cpl_string.h:480
#define VSI_REALLOC_VERBOSE(pOldPtr, nNewSize)
Definition: cpl_vsi.h:285
size_t CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize)
Definition: cpl_string.cpp:2755
#define CSLT_PRESERVEQUOTES
Definition: cpl_string.h:87
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:447
void * CPLCalloc(size_t, size_t)
Definition: cpl_conv.cpp:138
int CSLFindName(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1708
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:677
CPLValueType CPLGetValueType(const char *pszValue)
Definition: cpl_string.cpp:2566
#define CSLT_HONOURSTRINGS
Definition: cpl_string.h:83
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1877
int CPLsnprintf(char *str, size_t size, const char *fmt,...)
Definition: cpl_string.cpp:1337
char ** CSLAppendPrintf(char **papszStrList, const char *fmt,...)
Definition: cpl_string.cpp:1029
int CSLCount(CSLConstList papszStrList)
Definition: cpl_string.cpp:147
CSLConstList List() const
Definition: cpl_string.h:529
Convenient string class based on std::string.
Definition: cpl_string.h:336
int size() const
Definition: cpl_string.h:471
bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey, bool bDefault)
Definition: cpl_string.cpp:1600
@ CPL_VALUE_STRING
Definition: cpl_string.h:198
int CSLPartialFindString(CSLConstList papszHaystack, const char *pszNeedle)
Definition: cpl_string.cpp:737
void * CPLRealloc(void *, size_t)
Definition: cpl_conv.cpp:225
int FindString(const char *pszTarget) const
Definition: cpl_string.h:488
CPLStringT(void)
Definition: cpl_string.h:343
CPLStringT(const char *pszStr, size_t n)
Definition: cpl_string.h:351
#define EQUAL(a, b)
Definition: cpl_port.h:559
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:928
#define CPLES_BackslashQuotable
Definition: cpl_string.h:167
CPLStringList & AddString(const char *pszNewString)
Definition: cplstringlist.cpp:353
CPLStringT(const char *pszStr)
Definition: cpl_string.h:349
#define CPLES_XML
Definition: cpl_string.h:169
const char * CSLGetField(CSLConstList, int)
Definition: cpl_string.cpp:173
const char & operator[](std::string::size_type i) const
Definition: cpl_string.h:363
#define CPLAssert(expr)
Definition: cpl_error.h:182
#define CPL_C_START
Definition: cpl_port.h:335
int CSLTestBoolean(const char *pszValue)
Definition: cpl_string.cpp:1553
#define CPLES_SQL
Definition: cpl_string.h:173
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1306
CPLStringT(const std::string &oStr)
Definition: cpl_string.h:346
wchar_t * CPLRecodeToWChar(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Definition: cpl_recode.cpp:208
#define CPLE_OutOfMemory
Definition: cpl_error.h:101
char ** CSLInsertStrings(char **papszStrList, int nInsertAtLineNo, CSLConstList papszNewLines)
Definition: cpl_string.cpp:497
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1526
char & operator[](int i)
Definition: cpl_string.h:369
int CPLprintf(const char *fmt,...)
Definition: cpl_string.cpp:1393
void Seize(char *pszValue)
Definition: cpl_string.h:388
const char & operator[](int i) const
Definition: cpl_string.h:376
char ** CSLConstList
Definition: cpl_port.h:1184
#define CPLES_URL
Definition: cpl_string.h:171
unsigned long long GUIntBig
Definition: cpl_port.h:249
int CPLVASPrintf(char **buf, const char *fmt, va_list args)
Definition: cpl_string.cpp:1048
#define CPLE_OpenFailed
Definition: cpl_error.h:105
char * operator[](size_t i)
Definition: cpl_string.h:516
#define CPLES_CSV_FORCE_QUOTING
Definition: cpl_string.h:179
#define CPL_ENC_UTF8
Definition: cpl_string.h:263
char * CPLBase64Encode(int nBytes, const GByte *pabyData)
Definition: cpl_base64.cpp:199
size_t CPLStrlcpy(char *pszDest, const char *pszSrc, size_t nDestSize)
Definition: cpl_string.cpp:2698
bool empty() const
Definition: cpl_string.h:475
char & operator[](std::string::size_type i)
Definition: cpl_string.h:357
#define CPL_SCAN_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:906
CPLString CPLURLGetValue(const char *pszURL, const char *pszKey)
Definition: cplstring.cpp:443
#define CPL_C_END
Definition: cpl_port.h:337
int CSLPrint(CSLConstList papszStrList, FILE *fpOut)
Definition: cpl_string.cpp:461
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:544
#define VSI_STRDUP_VERBOSE(pszStr)
Definition: cpl_vsi.h:290
void * CPLMalloc(size_t)
Definition: cpl_conv.cpp:168
char ** List()
Definition: cpl_string.h:527
int CSLFindString(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:670
@ CPL_VALUE_INTEGER
Definition: cpl_string.h:200
void CPLErrorReset(void)
Definition: cpl_error.cpp:710
#define VSI_CALLOC_VERBOSE(nCount, nSize)
Definition: cpl_vsi.h:280
char * CPLRecode(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Definition: cpl_recode.cpp:81
int CPLvsnprintf(char *str, size_t size, const char *fmt, va_list args)
Definition: cpl_string.cpp:1140
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
int IsSorted() const
Definition: cpl_string.h:534
CPLStringList & Assign(char **papszListIn, int bTakeOwnership=TRUE)
Definition: cplstringlist.cpp:211
char ** CSLAddNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1838
char ** CSLAddStringMayFail(char **papszStrList, const char *pszNewString)
Definition: cpl_string.cpp:92
int CPLStrlenUTF8(const char *pszUTF8Str)
Definition: cpl_recode.cpp:363
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:232
const char * operator[](size_t i) const
Definition: cpl_string.h:520
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Definition: cpl_string.cpp:1754
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:823
char ** CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter, int bHonourStrings, int bAllowEmptyTokens)
Definition: cpl_string.cpp:769
#define CPLE_NotSupported
Definition: cpl_error.h:109
char * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme)
Definition: cpl_string.cpp:2243
int CPLEncodingCharSize(const char *pszEncoding)
Definition: cpl_recode.cpp:318
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Definition: ogrsf_frmts.h:290
size_t CPLStrnlen(const char *pszStr, size_t nMaxLen)
Definition: cpl_string.cpp:2790
int CSLSave(CSLConstList papszStrList, const char *pszFname)
Definition: cpl_string.cpp:412
char ** CSLDuplicate(CSLConstList papszStrList)
Definition: cpl_string.cpp:228
int PartialFindString(const char *pszNeedle) const
Definition: cpl_string.h:491
#define CPL_SCANF_FORMAT_STRING(arg)
Definition: cpl_port.h:921
void CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
long long GIntBig
Definition: cpl_port.h:246
CPLSTRING_DLL CPLString & vPrintf(const char *pszFormat, va_list args)
Definition: cplstring.cpp:85
int Count() const
Definition: cplstringlist.cpp:238
@ CPL_VALUE_REAL
Definition: cpl_string.h:199
CPLValueType
Definition: cpl_string.h:196
#define CPL_WARN_UNUSED_RESULT
Definition: cpl_port.h:929
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:919
char ** CSLTokenizeString(const char *pszString)
Definition: cpl_string.cpp:759
#define EQUALN(a, b, n)
Definition: cpl_port.h:557
char ** StealList()
Definition: cplstringlist.cpp:509
void CSLSetNameValueSeparator(char **papszStrList, const char *pszSeparator)
Definition: cpl_string.cpp:1957
char * CPLForceToASCII(const char *pabyData, int nLen, char chReplacementChar)
Definition: cpl_recode.cpp:276
char ** CSLFetchNameValueMultiple(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1801
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:818
int CPLTestBoolean(const char *pszValue)
Definition: cpl_string.cpp:1575
const char * CSLFetchNameValue(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1674
char ** CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete, int nNumToRemove, char ***ppapszRetStrings)
Definition: cpl_string.cpp:588
char ** CSLAddString(char **papszStrList, const char *pszNewString)
Definition: cpl_string.cpp:83
void Clear()
Definition: cpl_string.h:383
CPLString CPLOPrintf(const char *pszFormat,...)
Definition: cplstring.cpp:526
char * CPLStrdup(const char *)
Definition: cpl_conv.cpp:293
double CPLAtof(const char *)
Definition: cpl_strtod.cpp:117
char * CPLBinaryToHex(int nBytes, const GByte *pabyData)
Definition: cpl_string.cpp:2469
const char * CPLReadLine2L(VSILFILE *, int, CSLConstList)
Definition: cpl_conv.cpp:652
const char * operator[](const char *pszKey) const
Definition: cpl_string.h:523
#define CSLT_ALLOWEMPTYTOKENS
Definition: cpl_string.h:85
char ** CSLParseCommandLine(const char *pszCommandLine)
Definition: cpl_string.cpp:2814
#define CPLE_FileIO
Definition: cpl_error.h:103
int CPLBase64DecodeInPlace(GByte *pszBase64)
Definition: cpl_base64.cpp:93
int CSLFetchBoolean(CSLConstList papszStrList, const char *pszKey, int bDefault)
Definition: cpl_string.cpp:1635
#define CSLT_STRIPENDSPACES
Definition: cpl_string.h:93
#define CPLFree
Definition: cpl_conv.h:81
#define CSLT_STRIPLEADSPACES
Definition: cpl_string.h:91
#define CPL_RETURNS_NONNULL
Definition: cpl_port.h:962
GByte * CPLHexToBinary(const char *pszHex, int *pnBytes)
Definition: cpl_string.cpp:2527
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1374
double CPLStrtod(const char *, char **)
Definition: cpl_strtod.cpp:321
FILE VSILFILE
Definition: cpl_vsi.h:155
#define STARTS_WITH_CI(a, b)
Definition: cpl_port.h:570
#define CPLE_AppDefined
Definition: cpl_error.h:99
Generated for GDAL by
1.8.17.