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 spatialys.com>
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
61 CPL_C_START
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,
99 CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
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 {
200 CPL_VALUE_STRING,
201 CPL_VALUE_REAL,
202 CPL_VALUE_INTEGER
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), ... )
232 CPL_PRINT_FUNC_FORMAT(2, 3)
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), ... )
251 CPL_PRINT_FUNC_FORMAT(1, 2) CPL_WARN_UNUSED_RESULT;
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 int CPL_DLL CPLCanRecode(
296 const char *pszTestStr, const char *pszSrcEncoding,
297 const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT;
298 CPL_C_END
299
300 /************************************************************************/
301 /* CPLString */
302 /************************************************************************/
303
304 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
305
306 extern "C++"
307 {
308 #ifndef DOXYGEN_SKIP
309 #include <string>
310 #endif
311
312 // VC++ implicitly applies __declspec(dllexport) to template base classes
313 // of classes marked with __declspec(dllexport).
314 // Hence, if marked with CPL_DLL, VC++ would export symbols for the specialization
315 // of std::basic_string<char>, since it is a base class of CPLString.
316 // As a result, if an application linked both gdal.dll and a static library that
317 // (implicitly) instantiates std::string (almost all do!), then the linker would
318 // emit an error concerning duplicate symbols for std::string.
319 // The least intrusive solution is to not mark the whole class with
320 // __declspec(dllexport) for VC++, but only its non-inline methods.
321 #ifdef _MSC_VER
322 # define CPLSTRING_CLASS_DLL
323 # define CPLSTRING_METHOD_DLL CPL_DLL
324 #else
325
326 # define CPLSTRING_CLASS_DLL CPL_DLL
327 # define CPLSTRING_METHOD_DLL
328
329 #endif
330
332 class CPLSTRING_CLASS_DLL CPLString : public std::string
333 {
334 public:
335
337 CPLString(void) {}
339 // cppcheck-suppress noExplicitConstructor
340 CPLString( const std::string &oStr ) : std::string( oStr ) {}
342 // cppcheck-suppress noExplicitConstructor
343 CPLString( const char *pszStr ) : std::string( pszStr ) {}
345 CPLString( const char *pszStr, size_t n ) : std::string( pszStr, n ) {}
346
348 operator const char* (void) const { return c_str(); }
349
351 char& operator[](std::string::size_type i)
352 {
353 return std::string::operator[](i);
354 }
355
357 const char& operator[](std::string::size_type i) const
358 {
359 return std::string::operator[](i);
360 }
361
363 char& operator[](int i)
364 {
365 return std::string::operator[](
366 static_cast<std::string::size_type>(i));
367 }
368
370 const char& operator[](int i) const
371 {
372 return std::string::operator[](
373 static_cast<std::string::size_type>(i));
374 }
375
377 void Clear() { resize(0); }
378
382 void Seize( char *pszValue )
383 {
384 if (pszValue == nullptr )
385 Clear();
386 else
387 {
388 *this = pszValue;
389 CPLFree(pszValue);
390 }
391 }
392
393 /* There seems to be a bug in the way the compiler count indices...
394 * Should be CPL_PRINT_FUNC_FORMAT (1, 2) */
395 CPLSTRING_METHOD_DLL CPLString &Printf(
396 CPL_FORMAT_STRING(const char *pszFormat), ... )
397 CPL_PRINT_FUNC_FORMAT (2, 3);
398 CPLSTRING_METHOD_DLL CPLString &vPrintf(
399 CPL_FORMAT_STRING(const char *pszFormat), va_list args )
400 CPL_PRINT_FUNC_FORMAT(2, 0);
401 CPLSTRING_METHOD_DLL CPLString &FormatC( double dfValue, const char *pszFormat = nullptr );
402 CPLSTRING_METHOD_DLL CPLString &Trim();
403 CPLSTRING_METHOD_DLL CPLString &Recode( const char *pszSrcEncoding, const char *pszDstEncoding );
404 CPLSTRING_METHOD_DLL CPLString &replaceAll(
405 const std::string &osBefore, const std::string& osAfter );
406 CPLSTRING_METHOD_DLL CPLString &replaceAll( const std::string &osBefore, char chAfter );
407 CPLSTRING_METHOD_DLL CPLString &replaceAll( char chBefore, const std::string &osAfter );
408 CPLSTRING_METHOD_DLL CPLString &replaceAll( char chBefore, char chAfter );
409
410 /* case insensitive find alternates */
411 CPLSTRING_METHOD_DLL size_t ifind( const std::string & str, size_t pos = 0 ) const;
412 CPLSTRING_METHOD_DLL size_t ifind( const char * s, size_t pos = 0 ) const;
413 CPLSTRING_METHOD_DLL CPLString &toupper( void );
414 CPLSTRING_METHOD_DLL CPLString &tolower( void );
415
416 CPLSTRING_METHOD_DLL bool endsWith( const std::string& osStr ) const;
417 };
418
419 #undef CPLSTRING_CLASS_DLL
420 #undef CPLSTRING_METHOD_DLL
421
422 CPLString CPL_DLL CPLOPrintf(CPL_FORMAT_STRING(const char *pszFormat), ... )
423 CPL_PRINT_FUNC_FORMAT (1, 2);
424 CPLString CPL_DLL CPLOvPrintf(
425 CPL_FORMAT_STRING(const char *pszFormat), va_list args)
426 CPL_PRINT_FUNC_FORMAT (1, 0);
427 CPLString CPL_DLL CPLQuotedSQLIdentifier(const char *pszIdent);
428
429 /* -------------------------------------------------------------------- */
430 /* URL processing functions, here since they depend on CPLString. */
431 /* -------------------------------------------------------------------- */
432 CPLString CPL_DLL CPLURLGetValue(const char* pszURL, const char* pszKey);
433 CPLString CPL_DLL CPLURLAddKVP(const char* pszURL, const char* pszKey,
434 const char* pszValue);
435
436 /************************************************************************/
437 /* CPLStringList */
438 /************************************************************************/
439
441 class CPL_DLL CPLStringList
442 {
443 char **papszList = nullptr;
444 mutable int nCount = 0;
445 mutable int nAllocation = 0;
446 bool bOwnList = false;
447 bool bIsSorted = false;
448
449 void MakeOurOwnCopy();
450 void EnsureAllocation( int nMaxLength );
451 int FindSortedInsertionPoint( const char *pszLine );
452
453 public:
454 CPLStringList();
455 explicit CPLStringList( char **papszList, int bTakeOwnership=TRUE );
456 explicit CPLStringList( CSLConstList papszList );
457 CPLStringList( const CPLStringList& oOther );
458 ~CPLStringList();
459
460 CPLStringList &Clear();
461
463 int size() const { return Count(); }
464 int Count() const;
465
467 bool empty() const { return Count() == 0; }
468
469 CPLStringList &AddString( const char *pszNewString );
470 CPLStringList &AddStringDirectly( char *pszNewString );
471
472 CPLStringList &InsertString( int nInsertAtLineNo, const char *pszNewLine )
473 { return InsertStringDirectly( nInsertAtLineNo, CPLStrdup(pszNewLine) ); }
474 CPLStringList &InsertStringDirectly( int nInsertAtLineNo, char *pszNewLine);
475
476 // CPLStringList &InsertStrings( int nInsertAtLineNo, char **papszNewLines );
477 // CPLStringList &RemoveStrings( int nFirstLineToDelete, int nNumToRemove=1 );
478
480 int FindString( const char *pszTarget ) const
481 { return CSLFindString( papszList, pszTarget ); }
483 int PartialFindString( const char *pszNeedle ) const
484 { return CSLPartialFindString( papszList, pszNeedle ); }
485
486 int FindName( const char *pszName ) const;
487 bool FetchBool( const char *pszKey, bool bDefault ) const;
488 // Deprecated.
489 int FetchBoolean( const char *pszKey, int bDefault ) const;
490 const char *FetchNameValue( const char *pszKey ) const;
491 const char *FetchNameValueDef(
492 const char *pszKey, const char *pszDefault ) const;
493 CPLStringList &AddNameValue( const char *pszKey, const char *pszValue );
494 CPLStringList &SetNameValue( const char *pszKey, const char *pszValue );
495
496 CPLStringList &Assign( char **papszListIn, int bTakeOwnership=TRUE );
498 CPLStringList &operator=(char **papszListIn) {
499 return Assign( papszListIn, TRUE ); }
501 CPLStringList &operator=(const CPLStringList& oOther);
503 CPLStringList &operator=(CSLConstList papszListIn);
505 CPLStringList &operator=(CPLStringList&& oOther);
506
508 char * operator[](int i);
510 char * operator[](size_t i) { return (*this)[static_cast<int>(i)]; }
512 const char * operator[](int i) const;
514 const char * operator[](size_t i) const {
515 return (*this)[static_cast<int>(i)]; }
517 const char * operator[](const char* pszKey) const {
518 return FetchNameValue(pszKey); }
519
521 char** List() { return papszList; }
523 CSLConstList List() const { return papszList; }
524 char **StealList();
525
526 CPLStringList &Sort();
528 int IsSorted() const { return bIsSorted; }
529
531 operator char**(void) { return List(); }
533 operator CSLConstList(void) const { return List(); }
534 };
535
536 #ifdef GDAL_COMPILATION
537
538 #include <memory>
539
541 struct CPL_DLL CSLDestroyReleaser
542 {
543 void operator()(char** papszStr) const { CSLDestroy(papszStr); }
544 };
548 using CSLUniquePtr = std::unique_ptr< char*, CSLDestroyReleaser>;
549
551 struct CPL_DLL CPLFreeReleaser
552 {
553 void operator()(void* p) const { CPLFree(p); }
554 };
558 using CPLCharUniquePtr = std::unique_ptr<char, CPLFreeReleaser>;
559
560 #endif
561
562 } // extern "C++"
563
564 #endif /* def __cplusplus && !CPL_SUPRESS_CPLUSPLUS */
565
566 #endif /* CPL_STRING_H_INCLUDED */
CSLLoad2
char ** CSLLoad2(const char *pszFname, int nMaxLines, int nMaxCols, CSLConstList papszOptions)
Load a text file into a string list.
Definition: cpl_string.cpp:318
CPLStringList::operator=
CPLStringList & operator=(char **papszListIn)
Assignment operator.
Definition: cpl_string.h:498
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:869
CPLRecodeFromWChar
char * CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Convert wchar_t string to UTF-8.
Definition: cpl_recode.cpp:160
CSLInsertString
char ** CSLInsertString(char **papszStrList, int nInsertAtLineNo, const char *pszNewLine)
Insert a string at a given line number inside a StringList.
Definition: cpl_string.cpp:564
CSLTokenizeString2
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Tokenize a string.
Definition: cpl_string.cpp:838
CSLFindStringCaseSensitive
int CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Find a string within a string list(case sensitive)
Definition: cpl_string.cpp:706
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
CPLString::CPLString
CPLString(const char *pszStr, size_t n)
Constructor.
Definition: cpl_string.h:345
cpl_error.h
CPLURLAddKVP
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
CSLMerge
char ** CSLMerge(char **papszOrig, CSLConstList papszOverride)
Merge two lists.
Definition: cpl_string.cpp:270
CPLIsUTF8
int CPLIsUTF8(const char *pabyData, int nLen)
Test if a string is encoded as UTF-8.
Definition: cpl_recode.cpp:262
CPLEscapeString
char * CPLEscapeString(const char *pszString, int nLength, int nScheme)
Apply escaping to string to preserve special characters.
Definition: cpl_string.cpp:2042
CSLLoad
char ** CSLLoad(const char *pszFname)
Load a text file into a string list.
Definition: cpl_string.cpp:399
CPLOvPrintf
CPLString CPLOvPrintf(const char *pszFormat, va_list args)
Return a CPLString with the content of vsprintf()
Definition: cplstring.cpp:524
CPLStringList::InsertString
CPLStringList & InsertString(int nInsertAtLineNo, const char *pszNewLine)
Insert into the list at identified location.
Definition: cpl_string.h:472
CPLStrlcat
size_t CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize)
Appends a source string to a destination buffer.
Definition: cpl_string.cpp:2913
CPLStringList
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:441
CSLFindName
int CSLFindName(CSLConstList papszStrList, const char *pszName)
Find StringList entry with given key name.
Definition: cpl_string.cpp:1714
CPLGetValueType
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:2724
cpl_vsi.h
CSLFetchNameValueDef
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:1652
CSLSetNameValue
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Assign value to name in StringList.
Definition: cpl_string.cpp:1883
CPLsnprintf
int CPLsnprintf(char *str, size_t size, const char *fmt,...)
snprintf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1339
CSLAppendPrintf
char ** CSLAppendPrintf(char **papszStrList, const char *fmt,...)
Use CPLSPrintf() to append a new line at the end of a StringList.
Definition: cpl_string.cpp:1031
CSLCount
int CSLCount(CSLConstList papszStrList)
Return number of items in a string list.
Definition: cpl_string.cpp:149
CPLStringList::List
CSLConstList List() const
Return list.
Definition: cpl_string.h:523
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:332
CPLStringList::size
int size() const
Return size of list.
Definition: cpl_string.h:463
CPLFetchBool
bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey, bool bDefault)
Check for boolean key value.
Definition: cpl_string.cpp:1606
CPL_VALUE_STRING
@ CPL_VALUE_STRING
String.
Definition: cpl_string.h:200
CSLPartialFindString
int CSLPartialFindString(CSLConstList papszHaystack, const char *pszNeedle)
Find a substring within a string list.
Definition: cpl_string.cpp:739
CPLStringList::FindString
int FindString(const char *pszTarget) const
Return index of pszTarget in the list, or -1.
Definition: cpl_string.h:480
CPLString::CPLString
CPLString(const std::string &oStr)
Constructor.
Definition: cpl_string.h:340
CSLGetField
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:175
CPLString::operator[]
const char & operator[](std::string::size_type i) const
Return character at specified index.
Definition: cpl_string.h:357
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:329
CSLTestBoolean
int CSLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1559
CPLRecodeToWChar
wchar_t * CPLRecodeToWChar(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Convert UTF-8 string to a wchar_t string.
Definition: cpl_recode.cpp:219
CSLInsertStrings
char ** CSLInsertStrings(char **papszStrList, int nInsertAtLineNo, CSLConstList papszNewLines)
Copies the contents of a StringList inside another StringList before the specified line.
Definition: cpl_string.cpp:499
CPLTestBool
bool CPLTestBool(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1532
CPLString::operator[]
char & operator[](int i)
Return character at specified index.
Definition: cpl_string.h:363
CPLprintf
int CPLprintf(const char *fmt,...)
printf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1395
CPLString::Seize
void Seize(char *pszValue)
Assign specified string and take ownership of it (assumed to be allocated with CPLMalloc()).
Definition: cpl_string.h:382
CPLString::operator[]
const char & operator[](int i) const
Return character at specified index.
Definition: cpl_string.h:370
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1169
CPLVASPrintf
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:1050
CPLStringList::operator[]
char * operator[](size_t i)
Return string at specified index.
Definition: cpl_string.h:510
CPLBase64Encode
char * CPLBase64Encode(int nBytes, const GByte *pabyData)
Base64 encode a buffer.
Definition: cpl_base64.cpp:199
CPLStrlcpy
size_t CPLStrlcpy(char *pszDest, const char *pszSrc, size_t nDestSize)
Copy source string to a destination buffer.
Definition: cpl_string.cpp:2856
CPLStringList::empty
bool empty() const
Return whether the list is empty.
Definition: cpl_string.h:467
CPLString::operator[]
char & operator[](std::string::size_type i)
Return character at specified index.
Definition: cpl_string.h:351
CPL_SCAN_FUNC_FORMAT
#define CPL_SCAN_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have scanf() formatting.
Definition: cpl_port.h:871
CPLURLGetValue
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
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:331
CSLPrint
int CSLPrint(CSLConstList papszStrList, FILE *fpOut)
Print a StringList to fpOut.
Definition: cpl_string.cpp:463
CPLStringList::List
char ** List()
Return list.
Definition: cpl_string.h:521
CSLFindString
int CSLFindString(CSLConstList papszList, const char *pszTarget)
Find a string within a string list (case insensitive).
Definition: cpl_string.cpp:672
cpl_conv.h
CPL_VALUE_INTEGER
@ CPL_VALUE_INTEGER
Integer.
Definition: cpl_string.h:202
CPLRecode
char * CPLRecode(const char *pszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Convert a string from a source encoding to a destination encoding.
Definition: cpl_recode.cpp:81
CPLvsnprintf
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:1142
CPLSPrintf
const char * CPLSPrintf(const char *fmt,...)
CPLSPrintf() that works with 10 static buffer.
Definition: cpl_string.cpp:979
CPLStringList::IsSorted
int IsSorted() const
Returns whether the list is sorted.
Definition: cpl_string.h:528
CSLAddNameValue
char ** CSLAddNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Add a new entry to a StringList of "Name=Value" pairs, ("Name:Value" pairs are also supported for bac...
Definition: cpl_string.cpp:1844
CSLAddStringMayFail
char ** CSLAddStringMayFail(char **papszStrList, const char *pszNewString)
Same as CSLAddString() but may return NULL in case of (memory) failure.
Definition: cpl_string.cpp:94
CPLStrlenUTF8
int CPLStrlenUTF8(const char *pszUTF8Str)
Return the number of UTF-8 characters of a nul-terminated string.
Definition: cpl_recode.cpp:374
CPLStringList::operator[]
const char * operator[](size_t i) const
Return string at specified index.
Definition: cpl_string.h:514
CPLParseNameValue
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Parse NAME=VALUE string into name and value components.
Definition: cpl_string.cpp:1760
CSLTokenizeStringComplex
char ** CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter, int bHonourStrings, int bAllowEmptyTokens)
Obsolete tokenizing api.
Definition: cpl_string.cpp:771
CPLUnescapeString
char * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme)
Unescape a string.
Definition: cpl_string.cpp:2400
CPLEncodingCharSize
int CPLEncodingCharSize(const char *pszEncoding)
Return bytes per character for encoding.
Definition: cpl_recode.cpp:329
CPLStrnlen
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:2948
CSLSave
int CSLSave(CSLConstList papszStrList, const char *pszFname)
Write a StringList to a text file.
Definition: cpl_string.cpp:414
CSLDuplicate
char ** CSLDuplicate(CSLConstList papszStrList)
Clone a string list.
Definition: cpl_string.cpp:230
CPLStringList::PartialFindString
int PartialFindString(const char *pszNeedle) const
Return index of pszTarget in the list (using partial search), or -1.
Definition: cpl_string.h:483
CPL_SCANF_FORMAT_STRING
#define CPL_SCANF_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a sscanf-like function.
Definition: cpl_port.h:886
CSLDestroy
void CSLDestroy(char **papszStrList)
Free string list.
Definition: cpl_string.cpp:202
CPL_VALUE_REAL
@ CPL_VALUE_REAL
Real number.
Definition: cpl_string.h:201
CPLValueType
CPLValueType
Type of value.
Definition: cpl_string.h:198
CPL_WARN_UNUSED_RESULT
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:894
CPL_FORMAT_STRING
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:884
CPLString::CPLString
CPLString(const char *pszStr)
Constructor.
Definition: cpl_string.h:343
CSLTokenizeString
char ** CSLTokenizeString(const char *pszString)
Tokenizes a string and returns a StringList with one string for each token.
Definition: cpl_string.cpp:761
CSLSetNameValueSeparator
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:1963
CPLForceToASCII
char * CPLForceToASCII(const char *pabyData, int nLen, char chReplacementChar)
Return a new string that is made only of ASCII characters.
Definition: cpl_recode.cpp:287
CSLFetchNameValueMultiple
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:1807
CPLTestBoolean
int CPLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1581
CSLFetchNameValue
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:1680
CSLRemoveStrings
char ** CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete, int nNumToRemove, char ***ppapszRetStrings)
Remove strings inside a StringList.
Definition: cpl_string.cpp:590
CPLCanRecode
int CPLCanRecode(const char *pszTestStr, const char *pszSrcEncoding, const char *pszDstEncoding)
Checks if it is possible to recode a string from one encoding to another.
Definition: cpl_recode.cpp:400
CSLAddString
char ** CSLAddString(char **papszStrList, const char *pszNewString)
Append a string to a StringList and return a pointer to the modified StringList.
Definition: cpl_string.cpp:85
CPLString::Clear
void Clear()
Clear the string.
Definition: cpl_string.h:377
CPLOPrintf
CPLString CPLOPrintf(const char *pszFormat,...)
Return a CPLString with the content of sprintf()
Definition: cplstring.cpp:505
CPLStrdup
char * CPLStrdup(const char *)
Safe version of strdup() function.
Definition: cpl_conv.cpp:298
CPLBinaryToHex
char * CPLBinaryToHex(int nBytes, const GByte *pabyData)
Binary to hexadecimal translation.
Definition: cpl_string.cpp:2627
CPLString::CPLString
CPLString(void)
Constructor.
Definition: cpl_string.h:337
CPLStringList::operator[]
const char * operator[](const char *pszKey) const
Return value corresponding to pszKey, or nullptr.
Definition: cpl_string.h:517
CSLParseCommandLine
char ** CSLParseCommandLine(const char *pszCommandLine)
Tokenize command line arguments in a list of strings.
Definition: cpl_string.cpp:2972
CPLBase64DecodeInPlace
int CPLBase64DecodeInPlace(GByte *pszBase64)
Decode base64 string "pszBase64" (null terminated) in place.
Definition: cpl_base64.cpp:93
CSLFetchBoolean
int CSLFetchBoolean(CSLConstList papszStrList, const char *pszKey, int bDefault)
DEPRECATED.
Definition: cpl_string.cpp:1641
CPLQuotedSQLIdentifier
CPLString CPLQuotedSQLIdentifier(const char *pszIdent)
Return a CPLString of the SQL quoted identifier.
Definition: cplstring.cpp:537
CPLFree
#define CPLFree
Alias of VSIFree()
Definition: cpl_conv.h:83
CPL_RETURNS_NONNULL
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:927
CPLHexToBinary
GByte * CPLHexToBinary(const char *pszHex, int *pnBytes)
Hexadecimal to binary translation.
Definition: cpl_string.cpp:2685