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
39 #include <stdbool.h>
40
63 CPL_C_START
64
65 char CPL_DLL **CSLAddString(char **papszStrList,
66 const char *pszNewString) CPL_WARN_UNUSED_RESULT;
67 char CPL_DLL **CSLAddStringMayFail(
68 char **papszStrList, const char *pszNewString) CPL_WARN_UNUSED_RESULT;
69 int CPL_DLL CSLCount(CSLConstList papszStrList);
70 const char CPL_DLL *CSLGetField( CSLConstList, int );
71 void CPL_DLL CPL_STDCALL CSLDestroy(char **papszStrList);
72 char CPL_DLL **CSLDuplicate(CSLConstList papszStrList) CPL_WARN_UNUSED_RESULT;
73 char CPL_DLL **CSLMerge( char **papszOrig,
74 CSLConstList papszOverride ) CPL_WARN_UNUSED_RESULT;
75
76 char CPL_DLL **CSLTokenizeString(const char *pszString ) CPL_WARN_UNUSED_RESULT;
77 char CPL_DLL **CSLTokenizeStringComplex(
78 const char *pszString, const char *pszDelimiter, int bHonourStrings,
79 int bAllowEmptyTokens ) CPL_WARN_UNUSED_RESULT;
80 char CPL_DLL **CSLTokenizeString2( const char *pszString,
81 const char *pszDelimiter,
82 int nCSLTFlags ) CPL_WARN_UNUSED_RESULT;
83
85 #define CSLT_HONOURSTRINGS 0x0001
86
87 #define CSLT_ALLOWEMPTYTOKENS 0x0002
88
89 #define CSLT_PRESERVEQUOTES 0x0004
90
91 #define CSLT_PRESERVEESCAPES 0x0008
92
93 #define CSLT_STRIPLEADSPACES 0x0010
94
95 #define CSLT_STRIPENDSPACES 0x0020
96
97 int CPL_DLL CSLPrint(CSLConstList papszStrList, FILE *fpOut);
98 char CPL_DLL **CSLLoad(const char *pszFname) CPL_WARN_UNUSED_RESULT;
99 char CPL_DLL **CSLLoad2(
100 const char *pszFname, int nMaxLines, int nMaxCols,
101 CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
102 int CPL_DLL CSLSave(CSLConstList papszStrList, const char *pszFname);
103
104 char CPL_DLL **CSLInsertStrings(char **papszStrList, int nInsertAtLineNo,
105 CSLConstList papszNewLines) CPL_WARN_UNUSED_RESULT;
106 char CPL_DLL **CSLInsertString(char **papszStrList, int nInsertAtLineNo,
107 const char *pszNewLine) CPL_WARN_UNUSED_RESULT;
108 char CPL_DLL **CSLRemoveStrings(
109 char **papszStrList, int nFirstLineToDelete,
110 int nNumToRemove, char ***ppapszRetStrings) CPL_WARN_UNUSED_RESULT;
111 int CPL_DLL CSLFindString( CSLConstList papszList, const char *pszTarget );
112 int CPL_DLL CSLFindStringCaseSensitive( CSLConstList papszList,
113 const char *pszTarget );
114 int CPL_DLL CSLPartialFindString( CSLConstList papszHaystack,
115 const char *pszNeedle );
116 int CPL_DLL CSLFindName(CSLConstList papszStrList, const char *pszName);
117 int CPL_DLL CSLFetchBoolean( CSLConstList papszStrList, const char *pszKey,
118 int bDefault );
119
120 /* TODO: Deprecate CSLTestBoolean. Remove in GDAL 3.x. */
121 int CPL_DLL CSLTestBoolean( const char *pszValue );
122 /* Do not use CPLTestBoolean in C++ code. Use CPLTestBool. */
123 int CPL_DLL CPLTestBoolean( const char *pszValue );
124
125 bool CPL_DLL CPLTestBool( const char *pszValue );
126 bool CPL_DLL CPLFetchBool( CSLConstList papszStrList, const char *pszKey,
127 bool bDefault );
128
129 const char CPL_DLL *
130 CPLParseNameValue( const char *pszNameValue, char **ppszKey );
131
132 const char CPL_DLL *
133 CSLFetchNameValue( CSLConstList papszStrList, const char *pszName);
134 const char CPL_DLL *
135 CSLFetchNameValueDef( CSLConstList papszStrList,
136 const char *pszName,
137 const char *pszDefault );
138 char CPL_DLL **
139 CSLFetchNameValueMultiple(CSLConstList papszStrList, const char *pszName);
140 char CPL_DLL **
141 CSLAddNameValue(char **papszStrList,
142 const char *pszName,
143 const char *pszValue) CPL_WARN_UNUSED_RESULT;
144 char CPL_DLL **
145 CSLSetNameValue(char **papszStrList,
146 const char *pszName,
147 const char *pszValue) CPL_WARN_UNUSED_RESULT;
148 void CPL_DLL CSLSetNameValueSeparator( char ** papszStrList,
149 const char *pszSeparator );
150
151 char CPL_DLL ** CSLParseCommandLine(const char* pszCommandLine);
152
154 #define CPLES_BackslashQuotable 0
155
156 #define CPLES_XML 1
157
158 #define CPLES_URL 2
159
160 #define CPLES_SQL 3
161
162 #define CPLES_CSV 4
163
164 #define CPLES_XML_BUT_QUOTES 5
165
166 #define CPLES_CSV_FORCE_QUOTING 6
167
168 #define CPLES_SQLI 7
169
170 char CPL_DLL *CPLEscapeString( const char *pszString, int nLength,
171 int nScheme ) CPL_WARN_UNUSED_RESULT;
172 char CPL_DLL *CPLUnescapeString( const char *pszString, int *pnLength,
173 int nScheme ) CPL_WARN_UNUSED_RESULT;
174
175 char CPL_DLL *CPLBinaryToHex( int nBytes,
176 const GByte *pabyData ) CPL_WARN_UNUSED_RESULT;
177 GByte CPL_DLL *CPLHexToBinary( const char *pszHex,
178 int *pnBytes ) CPL_WARN_UNUSED_RESULT;
179
180 char CPL_DLL *CPLBase64Encode( int nBytes,
181 const GByte *pabyData ) CPL_WARN_UNUSED_RESULT;
182 int CPL_DLL CPLBase64DecodeInPlace( GByte* pszBase64 ) CPL_WARN_UNUSED_RESULT;
183
185 typedef enum
186 {
187 CPL_VALUE_STRING,
188 CPL_VALUE_REAL,
189 CPL_VALUE_INTEGER
190 } CPLValueType;
191
192 CPLValueType CPL_DLL CPLGetValueType(const char* pszValue);
193
194 size_t CPL_DLL CPLStrlcpy(char* pszDest, const char* pszSrc, size_t nDestSize);
195 size_t CPL_DLL CPLStrlcat(char* pszDest, const char* pszSrc, size_t nDestSize);
196 size_t CPL_DLL CPLStrnlen(const char *pszStr, size_t nMaxLen);
197
198 /* -------------------------------------------------------------------- */
199 /* Locale independent formatting functions. */
200 /* -------------------------------------------------------------------- */
201 int CPL_DLL CPLvsnprintf( char *str, size_t size,
202 CPL_FORMAT_STRING(const char* fmt),
203 va_list args )
204 CPL_PRINT_FUNC_FORMAT(3, 0 );
205
206 /* ALIAS_CPLSNPRINTF_AS_SNPRINTF might be defined to enable GCC 7 */
207 /* -Wformat-truncation= warnings, but shouldn't be set for normal use */
208 #if defined(ALIAS_CPLSNPRINTF_AS_SNPRINTF)
209 #define CPLsnprintf snprintf
210 #else
211 int CPL_DLL CPLsnprintf( char *str, size_t size,
212 CPL_FORMAT_STRING(const char* fmt), ... )
213 CPL_PRINT_FUNC_FORMAT(3, 4);
214 #endif
215
217 #if defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
218 int CPL_DLL CPLsprintf( char *str, CPL_FORMAT_STRING(const char* fmt), ... )
219 CPL_PRINT_FUNC_FORMAT(2, 3)
220 CPL_WARN_DEPRECATED("Use CPLsnprintf instead");
221 #else
222 int CPL_DLL CPLsprintf( char *str, CPL_FORMAT_STRING(const char* fmt), ... )
223 CPL_PRINT_FUNC_FORMAT(2, 3);
224 #endif
225
226 int CPL_DLL CPLprintf( CPL_FORMAT_STRING(const char* fmt), ... )
227 CPL_PRINT_FUNC_FORMAT(1, 2);
228
229 /* For some reason Doxygen_Suppress is needed to avoid warning. Not sure why */
231 /* caution: only works with limited number of formats */
232 int CPL_DLL CPLsscanf( const char* str,
233 CPL_SCANF_FORMAT_STRING(const char* fmt), ... )
234 CPL_SCAN_FUNC_FORMAT(2, 3);
237 const char CPL_DLL *CPLSPrintf( CPL_FORMAT_STRING(const char *fmt), ... )
238 CPL_PRINT_FUNC_FORMAT(1, 2) CPL_WARN_UNUSED_RESULT;
239 char CPL_DLL **CSLAppendPrintf( char **papszStrList,
240 CPL_FORMAT_STRING(const char *fmt), ... )
241 CPL_PRINT_FUNC_FORMAT(2, 3) CPL_WARN_UNUSED_RESULT;
242 int CPL_DLL CPLVASPrintf( char **buf,
243 CPL_FORMAT_STRING(const char *fmt), va_list args )
244 CPL_PRINT_FUNC_FORMAT(2, 0);
245
246 /* -------------------------------------------------------------------- */
247 /* RFC 23 character set conversion/recoding API (cpl_recode.cpp). */
248 /* -------------------------------------------------------------------- */
250 #define CPL_ENC_LOCALE ""
251
252 #define CPL_ENC_UTF8 "UTF-8"
253
254 #define CPL_ENC_UTF16 "UTF-16"
255
256 #define CPL_ENC_UCS2 "UCS-2"
257
258 #define CPL_ENC_UCS4 "UCS-4"
259
260 #define CPL_ENC_ASCII "ASCII"
261
262 #define CPL_ENC_ISO8859_1 "ISO-8859-1"
263
264 int CPL_DLL CPLEncodingCharSize( const char *pszEncoding );
266 void CPL_DLL CPLClearRecodeWarningFlags( void );
268 char CPL_DLL *CPLRecode(
269 const char *pszSource, const char *pszSrcEncoding,
270 const char *pszDstEncoding ) CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;
271 char CPL_DLL *CPLRecodeFromWChar(
272 const wchar_t *pwszSource, const char *pszSrcEncoding,
273 const char *pszDstEncoding ) CPL_WARN_UNUSED_RESULT;
274 wchar_t CPL_DLL *CPLRecodeToWChar(
275 const char *pszSource, const char *pszSrcEncoding,
276 const char *pszDstEncoding ) CPL_WARN_UNUSED_RESULT;
277 int CPL_DLL CPLIsUTF8( const char* pabyData, int nLen );
278 char CPL_DLL *CPLForceToASCII(
279 const char* pabyData, int nLen,
280 char chReplacementChar ) CPL_WARN_UNUSED_RESULT;
281 int CPL_DLL CPLStrlenUTF8( const char *pszUTF8Str );
282 int CPL_DLL CPLCanRecode(
283 const char *pszTestStr, const char *pszSrcEncoding,
284 const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT;
285 CPL_C_END
286
287 /************************************************************************/
288 /* CPLString */
289 /************************************************************************/
290
291 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
292
293 extern "C++"
294 {
295 #ifndef DOXYGEN_SKIP
296 #include <string>
297 #endif
298
299 // VC++ implicitly applies __declspec(dllexport) to template base classes
300 // of classes marked with __declspec(dllexport).
301 // Hence, if marked with CPL_DLL, VC++ would export symbols for the specialization
302 // of std::basic_string<char>, since it is a base class of CPLString.
303 // As a result, if an application linked both gdal.dll and a static library that
304 // (implicitly) instantiates std::string (almost all do!), then the linker would
305 // emit an error concerning duplicate symbols for std::string.
306 // The least intrusive solution is to not mark the whole class with
307 // __declspec(dllexport) for VC++, but only its non-inline methods.
308 #ifdef _MSC_VER
309 # define CPLSTRING_CLASS_DLL
310 # define CPLSTRING_METHOD_DLL CPL_DLL
311 #else
312
313 # define CPLSTRING_CLASS_DLL CPL_DLL
314 # define CPLSTRING_METHOD_DLL
315
316 #endif
317
319 class CPLSTRING_CLASS_DLL CPLString : public std::string
320 {
321 public:
322
324 CPLString(void) {}
326 // cppcheck-suppress noExplicitConstructor
327 CPLString( const std::string &oStr ) : std::string( oStr ) {}
329 // cppcheck-suppress noExplicitConstructor
330 CPLString( const char *pszStr ) : std::string( pszStr ) {}
332 CPLString( const char *pszStr, size_t n ) : std::string( pszStr, n ) {}
333
335 operator const char* (void) const { return c_str(); }
336
338 char& operator[](std::string::size_type i)
339 {
340 return std::string::operator[](i);
341 }
342
344 const char& operator[](std::string::size_type i) const
345 {
346 return std::string::operator[](i);
347 }
348
350 char& operator[](int i)
351 {
352 return std::string::operator[](
353 static_cast<std::string::size_type>(i));
354 }
355
357 const char& operator[](int i) const
358 {
359 return std::string::operator[](
360 static_cast<std::string::size_type>(i));
361 }
362
364 void Clear() { resize(0); }
365
369 void Seize( char *pszValue )
370 {
371 if (pszValue == nullptr )
372 Clear();
373 else
374 {
375 *this = pszValue;
376 CPLFree(pszValue);
377 }
378 }
379
380 /* There seems to be a bug in the way the compiler count indices...
381 * Should be CPL_PRINT_FUNC_FORMAT (1, 2) */
382 CPLSTRING_METHOD_DLL CPLString &Printf(
383 CPL_FORMAT_STRING(const char *pszFormat), ... )
384 CPL_PRINT_FUNC_FORMAT (2, 3);
385 CPLSTRING_METHOD_DLL CPLString &vPrintf(
386 CPL_FORMAT_STRING(const char *pszFormat), va_list args )
387 CPL_PRINT_FUNC_FORMAT(2, 0);
388 CPLSTRING_METHOD_DLL CPLString &FormatC( double dfValue, const char *pszFormat = nullptr );
389 CPLSTRING_METHOD_DLL CPLString &Trim();
390 CPLSTRING_METHOD_DLL CPLString &Recode( const char *pszSrcEncoding, const char *pszDstEncoding );
391 CPLSTRING_METHOD_DLL CPLString &replaceAll(
392 const std::string &osBefore, const std::string& osAfter );
393 CPLSTRING_METHOD_DLL CPLString &replaceAll( const std::string &osBefore, char chAfter );
394 CPLSTRING_METHOD_DLL CPLString &replaceAll( char chBefore, const std::string &osAfter );
395 CPLSTRING_METHOD_DLL CPLString &replaceAll( char chBefore, char chAfter );
396
397 /* case insensitive find alternates */
398 CPLSTRING_METHOD_DLL size_t ifind( const std::string & str, size_t pos = 0 ) const;
399 CPLSTRING_METHOD_DLL size_t ifind( const char * s, size_t pos = 0 ) const;
400 CPLSTRING_METHOD_DLL CPLString &toupper( void );
401 CPLSTRING_METHOD_DLL CPLString &tolower( void );
402
403 CPLSTRING_METHOD_DLL bool endsWith( const std::string& osStr ) const;
404 };
405
406 #undef CPLSTRING_CLASS_DLL
407 #undef CPLSTRING_METHOD_DLL
408
409 CPLString CPL_DLL CPLOPrintf(CPL_FORMAT_STRING(const char *pszFormat), ... )
410 CPL_PRINT_FUNC_FORMAT (1, 2);
411 CPLString CPL_DLL CPLOvPrintf(
412 CPL_FORMAT_STRING(const char *pszFormat), va_list args)
413 CPL_PRINT_FUNC_FORMAT (1, 0);
414 CPLString CPL_DLL CPLQuotedSQLIdentifier(const char *pszIdent);
415
416 /* -------------------------------------------------------------------- */
417 /* URL processing functions, here since they depend on CPLString. */
418 /* -------------------------------------------------------------------- */
419 CPLString CPL_DLL CPLURLGetValue(const char* pszURL, const char* pszKey);
420 CPLString CPL_DLL CPLURLAddKVP(const char* pszURL, const char* pszKey,
421 const char* pszValue);
422
423 /************************************************************************/
424 /* CPLStringList */
425 /************************************************************************/
426
428 class CPL_DLL CPLStringList
429 {
430 char **papszList = nullptr;
431 mutable int nCount = 0;
432 mutable int nAllocation = 0;
433 bool bOwnList = false;
434 bool bIsSorted = false;
435
436 void MakeOurOwnCopy();
437 void EnsureAllocation( int nMaxLength );
438 int FindSortedInsertionPoint( const char *pszLine );
439
440 public:
441 CPLStringList();
442 explicit CPLStringList( char **papszList, int bTakeOwnership=TRUE );
443 explicit CPLStringList( CSLConstList papszList );
444 CPLStringList( const CPLStringList& oOther );
445 ~CPLStringList();
446
447 CPLStringList &Clear();
448
450 int size() const { return Count(); }
451 int Count() const;
452
454 bool empty() const { return Count() == 0; }
455
456 CPLStringList &AddString( const char *pszNewString );
457 CPLStringList &AddStringDirectly( char *pszNewString );
458
459 CPLStringList &InsertString( int nInsertAtLineNo, const char *pszNewLine )
460 { return InsertStringDirectly( nInsertAtLineNo, CPLStrdup(pszNewLine) ); }
461 CPLStringList &InsertStringDirectly( int nInsertAtLineNo, char *pszNewLine);
462
463 // CPLStringList &InsertStrings( int nInsertAtLineNo, char **papszNewLines );
464 // CPLStringList &RemoveStrings( int nFirstLineToDelete, int nNumToRemove=1 );
465
467 int FindString( const char *pszTarget ) const
468 { return CSLFindString( papszList, pszTarget ); }
470 int PartialFindString( const char *pszNeedle ) const
471 { return CSLPartialFindString( papszList, pszNeedle ); }
472
473 int FindName( const char *pszName ) const;
474 bool FetchBool( const char *pszKey, bool bDefault ) const;
475 // Deprecated.
476 int FetchBoolean( const char *pszKey, int bDefault ) const;
477 const char *FetchNameValue( const char *pszKey ) const;
478 const char *FetchNameValueDef(
479 const char *pszKey, const char *pszDefault ) const;
480 CPLStringList &AddNameValue( const char *pszKey, const char *pszValue );
481 CPLStringList &SetNameValue( const char *pszKey, const char *pszValue );
482
483 CPLStringList &Assign( char **papszListIn, int bTakeOwnership=TRUE );
485 CPLStringList &operator=(char **papszListIn) {
486 return Assign( papszListIn, TRUE ); }
488 CPLStringList &operator=(const CPLStringList& oOther);
490 CPLStringList &operator=(CSLConstList papszListIn);
492 CPLStringList &operator=(CPLStringList&& oOther);
493
495 char * operator[](int i);
497 char * operator[](size_t i) { return (*this)[static_cast<int>(i)]; }
499 const char * operator[](int i) const;
501 const char * operator[](size_t i) const {
502 return (*this)[static_cast<int>(i)]; }
504 const char * operator[](const char* pszKey) const {
505 return FetchNameValue(pszKey); }
506
508 char** List() { return papszList; }
510 CSLConstList List() const { return papszList; }
511 char **StealList();
512
513 CPLStringList &Sort();
515 int IsSorted() const { return bIsSorted; }
516
518 operator char**(void) { return List(); }
520 operator CSLConstList(void) const { return List(); }
521 };
522
523 #ifdef GDAL_COMPILATION
524
525 #include <memory>
526
528 struct CPL_DLL CSLDestroyReleaser
529 {
530 void operator()(char** papszStr) const { CSLDestroy(papszStr); }
531 };
535 using CSLUniquePtr = std::unique_ptr< char*, CSLDestroyReleaser>;
536
538 struct CPL_DLL CPLFreeReleaser
539 {
540 void operator()(void* p) const { CPLFree(p); }
541 };
545 using CPLCharUniquePtr = std::unique_ptr<char, CPLFreeReleaser>;
546
547 #endif
548
549 } // extern "C++"
550
551 #endif /* def __cplusplus && !CPL_SUPRESS_CPLUSPLUS */
552
553 #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:485
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:841
CPLRecodeFromWChar
char * CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding, const char *pszDstEncoding)
Convert wchar_t string to UTF-8.
Definition: cpl_recode.cpp:183
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:203
CPLString::CPLString
CPLString(const char *pszStr, size_t n)
Constructor.
Definition: cpl_string.h:332
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:285
CPLEscapeString
char * CPLEscapeString(const char *pszString, int nLength, int nScheme)
Apply escaping to string to preserve special characters.
Definition: cpl_string.cpp:2052
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:459
CPLStrlcat
size_t CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize)
Appends a source string to a destination buffer.
Definition: cpl_string.cpp:2923
CPLStringList
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:428
CSLFindName
int CSLFindName(CSLConstList papszStrList, const char *pszName)
Find StringList entry with given key name.
Definition: cpl_string.cpp:1724
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:2734
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:1662
CSLSetNameValue
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Assign value to name in StringList.
Definition: cpl_string.cpp:1893
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:1349
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:1041
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:510
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:319
CPLStringList::size
int size() const
Return size of list.
Definition: cpl_string.h:450
CPLFetchBool
bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey, bool bDefault)
Check for boolean key value.
Definition: cpl_string.cpp:1616
CPL_VALUE_STRING
@ CPL_VALUE_STRING
String.
Definition: cpl_string.h:187
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:467
CPLString::CPLString
CPLString(const std::string &oStr)
Constructor.
Definition: cpl_string.h:327
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:344
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:301
CSLTestBoolean
int CSLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1569
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:242
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:1542
CPLString::operator[]
char & operator[](int i)
Return character at specified index.
Definition: cpl_string.h:350
CPLprintf
int CPLprintf(const char *fmt,...)
printf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1405
CPLString::Seize
void Seize(char *pszValue)
Assign specified string and take ownership of it (assumed to be allocated with CPLMalloc()).
Definition: cpl_string.h:369
CPLString::operator[]
const char & operator[](int i) const
Return character at specified index.
Definition: cpl_string.h:357
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1053
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:1060
CPLStringList::operator[]
char * operator[](size_t i)
Return string at specified index.
Definition: cpl_string.h:497
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:2866
CPLStringList::empty
bool empty() const
Return whether the list is empty.
Definition: cpl_string.h:454
CPLString::operator[]
char & operator[](std::string::size_type i)
Return character at specified index.
Definition: cpl_string.h:338
CPL_SCAN_FUNC_FORMAT
#define CPL_SCAN_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have scanf() formatting.
Definition: cpl_port.h:843
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:303
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:508
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:189
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:1152
CPLSPrintf
const char * CPLSPrintf(const char *fmt,...)
CPLSPrintf() that works with 10 static buffer.
Definition: cpl_string.cpp:989
CPLStringList::IsSorted
int IsSorted() const
Returns whether the list is sorted.
Definition: cpl_string.h:515
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:1854
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:397
CPLStringList::operator[]
const char * operator[](size_t i) const
Return string at specified index.
Definition: cpl_string.h:501
CPLParseNameValue
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Parse NAME=VALUE string into name and value components.
Definition: cpl_string.cpp:1770
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:2410
CPLEncodingCharSize
int CPLEncodingCharSize(const char *pszEncoding)
Return bytes per character for encoding.
Definition: cpl_recode.cpp:352
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:2958
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:470
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:858
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:188
CPLValueType
CPLValueType
Type of value.
Definition: cpl_string.h:185
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:866
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:856
CPLString::CPLString
CPLString(const char *pszStr)
Constructor.
Definition: cpl_string.h:330
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:1973
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:310
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:1817
CPLTestBoolean
int CPLTestBoolean(const char *pszValue)
Test what boolean value contained in the string.
Definition: cpl_string.cpp:1591
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:1690
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:423
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:364
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:301
CPLBinaryToHex
char * CPLBinaryToHex(int nBytes, const GByte *pabyData)
Binary to hexadecimal translation.
Definition: cpl_string.cpp:2637
CPLString::CPLString
CPLString(void)
Constructor.
Definition: cpl_string.h:324
CPLStringList::operator[]
const char * operator[](const char *pszKey) const
Return value corresponding to pszKey, or nullptr.
Definition: cpl_string.h:504
CSLParseCommandLine
char ** CSLParseCommandLine(const char *pszCommandLine)
Tokenize command line arguments in a list of strings.
Definition: cpl_string.cpp:2982
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:1651
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:899
CPLHexToBinary
GByte * CPLHexToBinary(const char *pszHex, int *pnBytes)
Hexadecimal to binary translation.
Definition: cpl_string.cpp:2695