GDAL
cpl_string.h
Go to the documentation of this file.
1 /**********************************************************************
2  * $Id$
3  *
4  * Name: cpl_string.h
5  * Project: CPL - Common Portability Library
6  * Purpose: String and StringList functions.
7  * Author: Daniel Morissette, dmorissette@mapgears.com
8  *
9  **********************************************************************
10  * Copyright (c) 1998, Daniel Morissette
11  * Copyright (c) 2008-2014, Even Rouault <even dot rouault at mines-paris dot org>
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included
21  * in all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29  * DEALINGS IN THE SOFTWARE.
30  ****************************************************************************/
31 
32 #ifndef CPL_STRING_H_INCLUDED
33 #define CPL_STRING_H_INCLUDED
34 
35 #include "cpl_error.h"
36 #include "cpl_conv.h"
37 #include "cpl_vsi.h"
38 
62 
63 char CPL_DLL **CSLAddString(char **papszStrList,
64  const char *pszNewString) CPL_WARN_UNUSED_RESULT;
65 char CPL_DLL **CSLAddStringMayFail(
66  char **papszStrList, const char *pszNewString) CPL_WARN_UNUSED_RESULT;
67 int CPL_DLL CSLCount(CSLConstList papszStrList);
68 const char CPL_DLL *CSLGetField( CSLConstList, int );
69 void CPL_DLL CPL_STDCALL CSLDestroy(char **papszStrList);
70 char CPL_DLL **CSLDuplicate(CSLConstList papszStrList) CPL_WARN_UNUSED_RESULT;
71 char CPL_DLL **CSLMerge( char **papszOrig,
72  CSLConstList papszOverride ) CPL_WARN_UNUSED_RESULT;
73 
74 char CPL_DLL **CSLTokenizeString(const char *pszString ) CPL_WARN_UNUSED_RESULT;
75 char CPL_DLL **CSLTokenizeStringComplex(
76  const char *pszString, const char *pszDelimiter, int bHonourStrings,
77  int bAllowEmptyTokens ) CPL_WARN_UNUSED_RESULT;
78 char CPL_DLL **CSLTokenizeString2( const char *pszString,
79  const char *pszDelimiter,
80  int nCSLTFlags ) CPL_WARN_UNUSED_RESULT;
81 
83 #define CSLT_HONOURSTRINGS 0x0001
84 
85 #define CSLT_ALLOWEMPTYTOKENS 0x0002
86 
87 #define CSLT_PRESERVEQUOTES 0x0004
88 
89 #define CSLT_PRESERVEESCAPES 0x0008
90 
91 #define CSLT_STRIPLEADSPACES 0x0010
92 
93 #define CSLT_STRIPENDSPACES 0x0020
94 
95 int CPL_DLL CSLPrint(CSLConstList papszStrList, FILE *fpOut);
96 char CPL_DLL **CSLLoad(const char *pszFname) CPL_WARN_UNUSED_RESULT;
97 char CPL_DLL **CSLLoad2(
98  const char *pszFname, int nMaxLines, int nMaxCols,
100 int CPL_DLL CSLSave(CSLConstList papszStrList, const char *pszFname);
101 
102 char CPL_DLL **CSLInsertStrings(char **papszStrList, int nInsertAtLineNo,
103  CSLConstList papszNewLines) CPL_WARN_UNUSED_RESULT;
104 char CPL_DLL **CSLInsertString(char **papszStrList, int nInsertAtLineNo,
105  const char *pszNewLine) CPL_WARN_UNUSED_RESULT;
106 char CPL_DLL **CSLRemoveStrings(
107  char **papszStrList, int nFirstLineToDelete,
108  int nNumToRemove, char ***ppapszRetStrings) CPL_WARN_UNUSED_RESULT;
109 int CPL_DLL CSLFindString( CSLConstList papszList, const char *pszTarget );
110 int CPL_DLL CSLFindStringCaseSensitive( CSLConstList papszList,
111  const char *pszTarget );
112 int CPL_DLL CSLPartialFindString( CSLConstList papszHaystack,
113  const char *pszNeedle );
114 int CPL_DLL CSLFindName(CSLConstList papszStrList, const char *pszName);
115 int CPL_DLL CSLFetchBoolean( CSLConstList papszStrList, const char *pszKey,
116  int bDefault );
117 
118 /* TODO: Deprecate CSLTestBoolean. Remove in GDAL 3.x. */
119 int CPL_DLL CSLTestBoolean( const char *pszValue );
120 /* Do not use CPLTestBoolean in C++ code. Use CPLTestBool. */
121 int CPL_DLL CPLTestBoolean( const char *pszValue );
122 
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))
128 #else /* DO_NOT_USE_DEBUG_BOOL */
129 /* Prefer these for C++ code. */
130 #ifdef DEBUG_BOOL
131 extern "C++" {
132 #endif
133 bool CPL_DLL CPLTestBool( const char *pszValue );
134 bool CPL_DLL CPLFetchBool( CSLConstList papszStrList, const char *pszKey,
135  bool bDefault );
136 #ifdef DEBUG_BOOL
137 }
138 #endif
139 #endif
140 #endif /* __cplusplus */
141 
142 const char CPL_DLL *
143  CPLParseNameValue( const char *pszNameValue, char **ppszKey );
144 
145 const char CPL_DLL *
146  CSLFetchNameValue( CSLConstList papszStrList, const char *pszName);
147 const char CPL_DLL *
148  CSLFetchNameValueDef( CSLConstList papszStrList,
149  const char *pszName,
150  const char *pszDefault );
151 char CPL_DLL **
152  CSLFetchNameValueMultiple(CSLConstList papszStrList, const char *pszName);
153 char CPL_DLL **
154  CSLAddNameValue(char **papszStrList,
155  const char *pszName,
156  const char *pszValue) CPL_WARN_UNUSED_RESULT;
157 char CPL_DLL **
158  CSLSetNameValue(char **papszStrList,
159  const char *pszName,
160  const char *pszValue) CPL_WARN_UNUSED_RESULT;
161 void CPL_DLL CSLSetNameValueSeparator( char ** papszStrList,
162  const char *pszSeparator );
163 
164 char CPL_DLL ** CSLParseCommandLine(const char* pszCommandLine);
165 
167 #define CPLES_BackslashQuotable 0
168 
169 #define CPLES_XML 1
170 
171 #define CPLES_URL 2
172 
173 #define CPLES_SQL 3
174 
175 #define CPLES_CSV 4
176 
177 #define CPLES_XML_BUT_QUOTES 5
178 
179 #define CPLES_CSV_FORCE_QUOTING 6
180 
181 #define CPLES_SQLI 7
182 
183 char CPL_DLL *CPLEscapeString( const char *pszString, int nLength,
184  int nScheme ) CPL_WARN_UNUSED_RESULT;
185 char CPL_DLL *CPLUnescapeString( const char *pszString, int *pnLength,
186  int nScheme ) CPL_WARN_UNUSED_RESULT;
187 
188 char CPL_DLL *CPLBinaryToHex( int nBytes,
189  const GByte *pabyData ) CPL_WARN_UNUSED_RESULT;
190 GByte CPL_DLL *CPLHexToBinary( const char *pszHex,
191  int *pnBytes ) CPL_WARN_UNUSED_RESULT;
192 
193 char CPL_DLL *CPLBase64Encode( int nBytes,
194  const GByte *pabyData ) CPL_WARN_UNUSED_RESULT;
195 int CPL_DLL CPLBase64DecodeInPlace( GByte* pszBase64 ) CPL_WARN_UNUSED_RESULT;
196 
198 typedef enum
199 {
203 } CPLValueType;
204 
205 CPLValueType CPL_DLL CPLGetValueType(const char* pszValue);
206 
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);
210 
211 /* -------------------------------------------------------------------- */
212 /* Locale independent formatting functions. */
213 /* -------------------------------------------------------------------- */
214 int CPL_DLL CPLvsnprintf( char *str, size_t size,
215  CPL_FORMAT_STRING(const char* fmt),
216  va_list args )
217  CPL_PRINT_FUNC_FORMAT(3, 0 );
218 
219 /* ALIAS_CPLSNPRINTF_AS_SNPRINTF might be defined to enable GCC 7 */
220 /* -Wformat-truncation= warnings, but shouldn't be set for normal use */
221 #if defined(ALIAS_CPLSNPRINTF_AS_SNPRINTF)
222 #define CPLsnprintf snprintf
223 #else
224 int CPL_DLL CPLsnprintf( char *str, size_t size,
225  CPL_FORMAT_STRING(const char* fmt), ... )
226  CPL_PRINT_FUNC_FORMAT(3, 4);
227 #endif
228 
230 #if defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
231 int CPL_DLL CPLsprintf( char *str, CPL_FORMAT_STRING(const char* fmt), ... )
233  CPL_WARN_DEPRECATED("Use CPLsnprintf instead");
234 #else
235 int CPL_DLL CPLsprintf( char *str, CPL_FORMAT_STRING(const char* fmt), ... )
236  CPL_PRINT_FUNC_FORMAT(2, 3);
237 #endif
238 
239 int CPL_DLL CPLprintf( CPL_FORMAT_STRING(const char* fmt), ... )
240  CPL_PRINT_FUNC_FORMAT(1, 2);
241 
242 /* For some reason Doxygen_Suppress is needed to avoid warning. Not sure why */
244 /* caution: only works with limited number of formats */
245 int CPL_DLL CPLsscanf( const char* str,
246  CPL_SCANF_FORMAT_STRING(const char* fmt), ... )
247  CPL_SCAN_FUNC_FORMAT(2, 3);
250 const char CPL_DLL *CPLSPrintf( CPL_FORMAT_STRING(const char *fmt), ... )
252 char CPL_DLL **CSLAppendPrintf( char **papszStrList,
253  CPL_FORMAT_STRING(const char *fmt), ... )
254  CPL_PRINT_FUNC_FORMAT(2, 3) CPL_WARN_UNUSED_RESULT;
255 int CPL_DLL CPLVASPrintf( char **buf,
256  CPL_FORMAT_STRING(const char *fmt), va_list args )
257  CPL_PRINT_FUNC_FORMAT(2, 0);
258 
259 /* -------------------------------------------------------------------- */
260 /* RFC 23 character set conversion/recoding API (cpl_recode.cpp). */
261 /* -------------------------------------------------------------------- */
263 #define CPL_ENC_LOCALE ""
264 
265 #define CPL_ENC_UTF8 "UTF-8"
266 
267 #define CPL_ENC_UTF16 "UTF-16"
268 
269 #define CPL_ENC_UCS2 "UCS-2"
270 
271 #define CPL_ENC_UCS4 "UCS-4"
272 
273 #define CPL_ENC_ASCII "ASCII"
274 
275 #define CPL_ENC_ISO8859_1 "ISO-8859-1"
276 
277 int CPL_DLL CPLEncodingCharSize( const char *pszEncoding );
279 void CPL_DLL CPLClearRecodeWarningFlags( void );
281 char CPL_DLL *CPLRecode(
282  const char *pszSource, const char *pszSrcEncoding,
283  const char *pszDstEncoding ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
284 char CPL_DLL *CPLRecodeFromWChar(
285  const wchar_t *pwszSource, const char *pszSrcEncoding,
286  const char *pszDstEncoding ) CPL_WARN_UNUSED_RESULT;
287 wchar_t CPL_DLL *CPLRecodeToWChar(
288  const char *pszSource, const char *pszSrcEncoding,
289  const char *pszDstEncoding ) CPL_WARN_UNUSED_RESULT;
290 int CPL_DLL CPLIsUTF8( const char* pabyData, int nLen );
291 char CPL_DLL *CPLForceToASCII(
292  const char* pabyData, int nLen,
293  char chReplacementChar ) CPL_WARN_UNUSED_RESULT;
294 int CPL_DLL CPLStrlenUTF8( const char *pszUTF8Str );
295 CPL_C_END
296 
297 /************************************************************************/
298 /* CPLString */
299 /************************************************************************/
300 
301 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
302 
303 extern "C++"
304 {
305 #ifndef DOXYGEN_SKIP
306 #include <string>
307 #endif
308 
309 // VC++ implicitly applies __declspec(dllexport) to template base classes
310 // of classes marked with __declspec(dllexport).
311 // Hence, if marked with CPL_DLL, VC++ would export symbols for the specialization
312 // of std::basic_string<char>, since it is a base class of CPLString.
313 // As a result, if an application linked both gdal.dll and a static library that
314 // (implicitly) instantiates std::string (almost all do!), then the linker would
315 // emit an error concerning duplicate symbols for std::string.
316 // The least intrusive solution is to not mark the whole class with
317 // __declspec(dllexport) for VC++, but only its non-inline methods.
318 #ifdef _MSC_VER
319 # define CPLSTRING_CLASS_DLL
320 # define CPLSTRING_METHOD_DLL CPL_DLL
321 #else
322 
323 # define CPLSTRING_CLASS_DLL CPL_DLL
324 # define CPLSTRING_METHOD_DLL
325 
326 #endif
327 
329 class CPLSTRING_CLASS_DLL CPLString : public std::string
330 {
331 public:
332 
334  CPLString(void) {}
336  // cppcheck-suppress noExplicitConstructor
337  CPLString( const std::string &oStr ) : std::string( oStr ) {}
339  // cppcheck-suppress noExplicitConstructor
340  CPLString( const char *pszStr ) : std::string( pszStr ) {}
342  CPLString( const char *pszStr, size_t n ) : std::string( pszStr, n ) {}
343 
345  operator const char* (void) const { return c_str(); }
346 
348  char& operator[](std::string::size_type i)
349  {
350  return std::string::operator[](i);
351  }
352 
354  const char& operator[](std::string::size_type i) const
355  {
356  return std::string::operator[](i);
357  }
358 
360  char& operator[](int i)
361  {
362  return std::string::operator[](
363  static_cast<std::string::size_type>(i));
364  }
365 
367  const char& operator[](int i) const
368  {
369  return std::string::operator[](
370  static_cast<std::string::size_type>(i));
371  }
372 
374  void Clear() { resize(0); }
375 
379  void Seize( char *pszValue )
380  {
381  if (pszValue == nullptr )
382  Clear();
383  else
384  {
385  *this = pszValue;
386  CPLFree(pszValue);
387  }
388  }
389 
390  /* There seems to be a bug in the way the compiler count indices...
391  * Should be CPL_PRINT_FUNC_FORMAT (1, 2) */
392  CPLSTRING_METHOD_DLL CPLString &Printf(
393  CPL_FORMAT_STRING(const char *pszFormat), ... )
394  CPL_PRINT_FUNC_FORMAT (2, 3);
395  CPLSTRING_METHOD_DLL CPLString &vPrintf(
396  CPL_FORMAT_STRING(const char *pszFormat), va_list args )
397  CPL_PRINT_FUNC_FORMAT(2, 0);
398  CPLSTRING_METHOD_DLL CPLString &FormatC( double dfValue, const char *pszFormat = nullptr );
399  CPLSTRING_METHOD_DLL CPLString &Trim();
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 );
406 
407  /* case insensitive find alternates */
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 );
412 
413  CPLSTRING_METHOD_DLL bool endsWith( const std::string& osStr ) const;
414 };
415 
416 #undef CPLSTRING_CLASS_DLL
417 #undef CPLSTRING_METHOD_DLL
418 
419 CPLString CPL_DLL CPLOPrintf(CPL_FORMAT_STRING(const char *pszFormat), ... )
420  CPL_PRINT_FUNC_FORMAT (1, 2);
421 CPLString CPL_DLL CPLOvPrintf(
422  CPL_FORMAT_STRING(const char *pszFormat), va_list args)
423  CPL_PRINT_FUNC_FORMAT (1, 0);
424 CPLString CPL_DLL CPLQuotedSQLIdentifier(const char *pszIdent);
425 
426 /* -------------------------------------------------------------------- */
427 /* URL processing functions, here since they depend on CPLString. */
428 /* -------------------------------------------------------------------- */
429 CPLString CPL_DLL CPLURLGetValue(const char* pszURL, const char* pszKey);
430 CPLString CPL_DLL CPLURLAddKVP(const char* pszURL, const char* pszKey,
431  const char* pszValue);
432 
433 /************************************************************************/
434 /* CPLStringList */
435 /************************************************************************/
436 
438 class CPL_DLL CPLStringList
439 {
440  char **papszList = nullptr;
441  mutable int nCount = 0;
442  mutable int nAllocation = 0;
443  bool bOwnList = false;
444  bool bIsSorted = false;
445 
446  void MakeOurOwnCopy();
447  void EnsureAllocation( int nMaxLength );
448  int FindSortedInsertionPoint( const char *pszLine );
449 
450  public:
451  CPLStringList();
452  explicit CPLStringList( char **papszList, int bTakeOwnership=TRUE );
453  explicit CPLStringList( CSLConstList papszList );
454  CPLStringList( const CPLStringList& oOther );
455  ~CPLStringList();
456 
457  CPLStringList &Clear();
458 
460  int size() const { return Count(); }
461  int Count() const;
462 
464  bool empty() const { return Count() == 0; }
465 
466  CPLStringList &AddString( const char *pszNewString );
467  CPLStringList &AddStringDirectly( char *pszNewString );
468 
469  CPLStringList &InsertString( int nInsertAtLineNo, const char *pszNewLine )
470  { return InsertStringDirectly( nInsertAtLineNo, CPLStrdup(pszNewLine) ); }
471  CPLStringList &InsertStringDirectly( int nInsertAtLineNo, char *pszNewLine);
472 
473  // CPLStringList &InsertStrings( int nInsertAtLineNo, char **papszNewLines );
474  // CPLStringList &RemoveStrings( int nFirstLineToDelete, int nNumToRemove=1 );
475 
477  int FindString( const char *pszTarget ) const
478  { return CSLFindString( papszList, pszTarget ); }
480  int PartialFindString( const char *pszNeedle ) const
481  { return CSLPartialFindString( papszList, pszNeedle ); }
482 
483  int FindName( const char *pszName ) const;
484  bool FetchBool( const char *pszKey, bool bDefault ) const;
485  // Deprecated.
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 );
492 
493  CPLStringList &Assign( char **papszListIn, int bTakeOwnership=TRUE );
495  CPLStringList &operator=(char **papszListIn) {
496  return Assign( papszListIn, TRUE ); }
498  CPLStringList &operator=(const CPLStringList& oOther);
500  CPLStringList &operator=(CSLConstList papszListIn);
501 
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); }
514 
516  char** List() { return papszList; }
518  CSLConstList List() const { return papszList; }
519  char **StealList();
520 
521  CPLStringList &Sort();
523  int IsSorted() const { return bIsSorted; }
524 
526  operator char**(void) { return List(); }
528  operator CSLConstList(void) const { return List(); }
529 };
530 
531 #ifdef GDAL_COMPILATION
532 
533 #include <memory>
534 
536 struct CSLDestroyReleaser
537 {
538  void operator()(char** papszStr) const { CSLDestroy(papszStr); }
539 };
543 using CSLUniquePtr = std::unique_ptr< char*, CSLDestroyReleaser>;
544 
545 #endif
546 
547 } // extern "C++"
548 
549 #endif /* def __cplusplus && !CPL_SUPRESS_CPLUSPLUS */
550 
551 #endif /* CPL_STRING_H_INCLUDED */
CPLString(void)
Constructor.
Definition: cpl_string.h:334
int CPLEncodingCharSize(const char *pszEncoding)
Return bytes per character for encoding.
Definition: cpl_recode.cpp:318
int CSLFindName(CSLConstList papszStrList, const char *pszName)
Find StringList entry with given key name.
Definition: cpl_string.cpp:1708
char * CPLBase64Encode(int nBytes, const GByte *pabyData) CPL_WARN_UNUSED_RESULT
Base64 encode a buffer.
Definition: cpl_base64.cpp:199
size_t CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize)
Appends a source string to a destination buffer.
Definition: cpl_string.cpp:2761
Standard C Covers.
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:759
int CSLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1553
bool empty() const
Return whether the list is empty.
Definition: cpl_string.h:464
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
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:276
void Clear()
Clear the string.
Definition: cpl_string.h:374
GByte * CPLHexToBinary(const char *pszHex, int *pnBytes) CPL_WARN_UNUSED_RESULT
Hexadecimal to binary translation.
Definition: cpl_string.cpp:2533
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:316
int CSLCount(CSLConstList papszStrList)
Return number of items in a string list.
Definition: cpl_string.cpp:147
int CPLBase64DecodeInPlace(GByte *pszBase64) CPL_WARN_UNUSED_RESULT
Decode base64 string "pszBase64" (null terminated) in place.
Definition: cpl_base64.cpp:93
CPLString CPLOPrintf(const char *pszFormat,...)
Return a CPLString with the content of sprintf()
Definition: cplstring.cpp:505
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:81
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:422
const char * CPLSPrintf(const char *fmt,...) CPL_WARN_UNUSED_RESULT
CPLSPrintf() that works with 10 static buffer.
Definition: cpl_string.cpp:977
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:1029
CPLValueType
Type of value.
Definition: cpl_string.h:198
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:1646
Real number.
Definition: cpl_string.h:201
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue) CPL_WARN_UNUSED_RESULT
Assign value to name in StringList.
Definition: cpl_string.cpp:1877
int FindString(const char *pszTarget) const
Return index of pszTarget in the list, or -1.
Definition: cpl_string.h:477
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:173
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:83
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:562
char & operator[](int i)
Return character at specified index.
Definition: cpl_string.h:360
CPLString CPLQuotedSQLIdentifier(const char *pszIdent)
Return a CPLString of the SQL quoted identifier.
Definition: cplstring.cpp:537
int PartialFindString(const char *pszNeedle) const
Return index of pszTarget in the list (using partial search), or -1.
Definition: cpl_string.h:480
Convenient string class based on std::string.
Definition: cpl_string.h:329
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:1838
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:906
size_t CPLStrlcpy(char *pszDest, const char *pszSrc, size_t nDestSize)
Copy source string to a destination buffer.
Definition: cpl_string.cpp:2704
char * CPLStrdup(const char *) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL
Safe version of strdup() function.
Definition: cpl_conv.cpp:293
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:2036
int IsSorted() const
Returns whether the list is sorted.
Definition: cpl_string.h:523
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:1801
int CSLPrint(CSLConstList papszStrList, FILE *fpOut)
Print a StringList to fpOut.
Definition: cpl_string.cpp:461
int CSLPartialFindString(CSLConstList papszHaystack, const char *pszNeedle)
Find a substring within a string list.
Definition: cpl_string.cpp:737
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:497
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:1957
CPLStringList & operator=(char **papszListIn)
Assignment operator.
Definition: cpl_string.h:495
const char * operator[](const char *pszKey) const
Return value corresponding to pszKey, or nullptr.
Definition: cpl_string.h:512
CPL error handling services.
int CPLprintf(const char *fmt,...)
printf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1393
void Seize(char *pszValue)
Assign specified string and take ownership of it (assumed to be allocated with CPLMalloc()).
Definition: cpl_string.h:379
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1186
char ** CSLLoad(const char *pszFname) CPL_WARN_UNUSED_RESULT
Load a text file into a string list.
Definition: cpl_string.cpp:397
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:438
char * CPLBinaryToHex(int nBytes, const GByte *pabyData) CPL_WARN_UNUSED_RESULT
Binary to hexadecimal translation.
Definition: cpl_string.cpp:2475
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:92
bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey, bool bDefault)
Check for boolean key value.
Definition: cpl_string.cpp:1600
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:149
#define CPLFree
Alias of VSIFree()
Definition: cpl_conv.h:81
int size() const
Return size of list.
Definition: cpl_string.h:460
CSLConstList List() const
Return list.
Definition: cpl_string.h:518
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:2572
Various convenience functions for CPL.
int CPLsnprintf(char *str, size_t size, const char *fmt,...)
snprintf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1337
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:1140
int CPLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1575
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:2796
const char * operator[](size_t i) const
Return string at specified index.
Definition: cpl_string.h:509
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:1048
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:921
CPLStringList & InsertString(int nInsertAtLineNo, const char *pszNewLine)
Insert into the list at identified location.
Definition: cpl_string.h:469
CPLString CPLURLAddKVP(const char *pszURL, const char *pszKey, const char *pszValue)
Return a new URL with a new key=value pair.
Definition: cplstring.cpp:455
String.
Definition: cpl_string.h:200
char & operator[](std::string::size_type i)
Return character at specified index.
Definition: cpl_string.h:348
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:964
#define CPL_SCANF_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a sscanf-like function.
Definition: cpl_port.h:923
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
int CSLSave(CSLConstList papszStrList, const char *pszFname)
Write a StringList to a text file.
Definition: cpl_string.cpp:412
CPLString(const char *pszStr)
Constructor.
Definition: cpl_string.h:340
const char & operator[](std::string::size_type i) const
Return character at specified index.
Definition: cpl_string.h:354
char ** CSLDuplicate(CSLConstList papszStrList) CPL_WARN_UNUSED_RESULT
Clone a string list.
Definition: cpl_string.cpp:228
char ** List()
Return list.
Definition: cpl_string.h:516
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags) CPL_WARN_UNUSED_RESULT
Tokenize a string.
Definition: cpl_string.cpp:836
#define CPL_SCAN_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have scanf() formatting.
Definition: cpl_port.h:908
bool CPLTestBool(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1526
int CSLFindString(CSLConstList papszList, const char *pszTarget)
Find a string within a string list (case insensitive).
Definition: cpl_string.cpp:670
int CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Find a string within a string list(case sensitive)
Definition: cpl_string.cpp:704
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Parse NAME=VALUE string into name and value components.
Definition: cpl_string.cpp:1754
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:1674
char ** CSLMerge(char **papszOrig, CSLConstList papszOverride) CPL_WARN_UNUSED_RESULT
Merge two lists.
Definition: cpl_string.cpp:268
CPLString CPLOvPrintf(const char *pszFormat, va_list args)
Return a CPLString with the content of vsprintf()
Definition: cplstring.cpp:524
CPLString(const char *pszStr, size_t n)
Constructor.
Definition: cpl_string.h:342
const char & operator[](int i) const
Return character at specified index.
Definition: cpl_string.h:367
void CSLDestroy(char **papszStrList)
Free string list.
Definition: cpl_string.cpp:200
int CPLIsUTF8(const char *pabyData, int nLen)
Test if a string is encoded as UTF-8.
Definition: cpl_recode.cpp:251
char * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme) CPL_WARN_UNUSED_RESULT
Unescape a string.
Definition: cpl_string.cpp:2248
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:208
char ** CSLParseCommandLine(const char *pszCommandLine)
Tokenize command line arguments in a list of strings.
Definition: cpl_string.cpp:2820
int CPLStrlenUTF8(const char *pszUTF8Str)
Return the number of UTF-8 characters of a nul-terminated string.
Definition: cpl_recode.cpp:363
char * operator[](size_t i)
Return string at specified index.
Definition: cpl_string.h:505
char ** CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter, int bHonourStrings, int bAllowEmptyTokens) CPL_WARN_UNUSED_RESULT
Obsolete tokenizing api.
Definition: cpl_string.cpp:769
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:931
Integer.
Definition: cpl_string.h:202
CPLString(const std::string &oStr)
Constructor.
Definition: cpl_string.h:337
int CSLFetchBoolean(CSLConstList papszStrList, const char *pszKey, int bDefault)
DEPRECATED.
Definition: cpl_string.cpp:1635
char ** CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete, int nNumToRemove, char ***ppapszRetStrings) CPL_WARN_UNUSED_RESULT
Remove strings inside a StringList.
Definition: cpl_string.cpp:588

Generated for GDAL by doxygen 1.8.8.