/**********************************************************************

 *

 * Name:     cpl_string.h

 * Project:  CPL - Common Portability Library

 * Purpose:  String and StringList functions.

 * Author:   Daniel Morissette, dmorissette@mapgears.com

 *

 **********************************************************************

 * Copyright (c) 1998, Daniel Morissette

 * Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#ifndef CPL_STRING_H_INCLUDED

#define CPL_STRING_H_INCLUDED

#include "cpl_error.h"

#include "cpl_conv.h"

#include "cpl_vsi.h"

#include <stdbool.h>

/**

 * \file cpl_string.h

 *

 * Various convenience functions for working with strings and string lists.

 *

 * A StringList is just an array of strings with the last pointer being

 * NULL.  An empty StringList may be either a NULL pointer, or a pointer to

 * a pointer memory location with a NULL value.

 *

 * A common convention for StringLists is to use them to store name/value

 * lists.  In this case the contents are treated like a dictionary of

 * name/value pairs.  The actual data is formatted with each string having

 * the format "<name>:<value>" (though "=" is also an acceptable separator).

 * A number of the functions in the file operate on name/value style

 * string lists (such as CSLSetNameValue(), and CSLFetchNameValue()).

 *

 * To some extent the CPLStringList C++ class can be used to abstract

 * managing string lists a bit but still be able to return them from C

 * functions.

 *

 */

CPL_C_START

char CPL_DLL **CSLAddString(char **papszStrList,

                            const char *pszNewString) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **

CSLAddStringMayFail(char **papszStrList,

                    const char *pszNewString) CPL_WARN_UNUSED_RESULT;

int CPL_DLL CSLCount(CSLConstList papszStrList);

const char CPL_DLL *CSLGetField(CSLConstList, int);

void CPL_DLL CPL_STDCALL CSLDestroy(char **papszStrList);

char CPL_DLL **CSLDuplicate(CSLConstList papszStrList) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLMerge(char **papszOrig,

                        CSLConstList papszOverride) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLTokenizeString(const char *pszString) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **

CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter,

                         int bHonourStrings,

                         int bAllowEmptyTokens) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLTokenizeString2(const char *pszString,

                                  const char *pszDelimiter,

                                  int nCSLTFlags) CPL_WARN_UNUSED_RESULT;

/** Flag for CSLTokenizeString2() to honour strings */

#define CSLT_HONOURSTRINGS 0x0001

/** Flag for CSLTokenizeString2() to allow empty tokens */

#define CSLT_ALLOWEMPTYTOKENS 0x0002

/** Flag for CSLTokenizeString2() to preserve quotes */

#define CSLT_PRESERVEQUOTES 0x0004

/** Flag for CSLTokenizeString2() to preserve escape characters */

#define CSLT_PRESERVEESCAPES 0x0008

/** Flag for CSLTokenizeString2() to strip leading spaces */

#define CSLT_STRIPLEADSPACES 0x0010

/** Flag for CSLTokenizeString2() to strip trailing spaces */

#define CSLT_STRIPENDSPACES 0x0020

int CPL_DLL CSLPrint(CSLConstList papszStrList, FILE *fpOut);

char CPL_DLL **CSLLoad(const char *pszFname) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLLoad2(const char *pszFname, int nMaxLines, int nMaxCols,

                        CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;

int CPL_DLL CSLSave(CSLConstList papszStrList, const char *pszFname);

char CPL_DLL **

CSLInsertStrings(char **papszStrList, int nInsertAtLineNo,

                 CSLConstList papszNewLines) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLInsertString(char **papszStrList, int nInsertAtLineNo,

                               const char *pszNewLine) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **

CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete, int nNumToRemove,

                 char ***ppapszRetStrings) CPL_WARN_UNUSED_RESULT;

int CPL_DLL CSLFindString(CSLConstList papszList, const char *pszTarget);

int CPL_DLL CSLFindStringCaseSensitive(CSLConstList papszList,

                                       const char *pszTarget);

int CPL_DLL CSLPartialFindString(CSLConstList papszHaystack,

                                 const char *pszNeedle);

int CPL_DLL CSLFindName(CSLConstList papszStrList, const char *pszName);

int CPL_DLL CSLFetchBoolean(CSLConstList papszStrList, const char *pszKey,

                            int bDefault);

/* TODO: Deprecate CSLTestBoolean.  Remove in GDAL 3.x. */

int CPL_DLL CSLTestBoolean(const char *pszValue);

/* Do not use CPLTestBoolean in C++ code.  Use CPLTestBool. */

int CPL_DLL CPLTestBoolean(const char *pszValue);

bool CPL_DLL CPLTestBool(const char *pszValue);

bool CPL_DLL CPLFetchBool(CSLConstList papszStrList, const char *pszKey,

                          bool bDefault);

#ifdef __cplusplus

CPL_C_END

/*! @cond Doxygen_Suppress */

inline bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey,

                         int bDefault)

{

    return CPLFetchBool(papszStrList, pszKey, bDefault != 0);

}

bool CPLFetchBool(CSLConstList papszStrList, const char *pszKey,

                  const char *) = delete;

/*! @endcond */

CPL_C_START

#endif

CPLErr CPL_DLL CPLParseMemorySize(const char *pszValue, GIntBig *pnValue,

                                  bool *pbUnitSpecified);

const char CPL_DLL *CPLParseNameValue(const char *pszNameValue, char **ppszKey);

const char CPL_DLL *CPLParseNameValueSep(const char *pszNameValue,

                                         char **ppszKey, char chSep);

const char CPL_DLL *CSLFetchNameValue(CSLConstList papszStrList,

                                      const char *pszName);

const char CPL_DLL *CSLFetchNameValueDef(CSLConstList papszStrList,

                                         const char *pszName,

                                         const char *pszDefault);

char CPL_DLL **CSLFetchNameValueMultiple(CSLConstList papszStrList,

                                         const char *pszName);

char CPL_DLL **CSLAddNameValue(char **papszStrList, const char *pszName,

                               const char *pszValue) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLSetNameValue(char **papszStrList, const char *pszName,

                               const char *pszValue) CPL_WARN_UNUSED_RESULT;

void CPL_DLL CSLSetNameValueSeparator(char **papszStrList,

                                      const char *pszSeparator);

char CPL_DLL **CSLParseCommandLine(const char *pszCommandLine);

/** Scheme for CPLEscapeString()/CPLUnescapeString() for backlash quoting */

#define CPLES_BackslashQuotable 0

/** Scheme for CPLEscapeString()/CPLUnescapeString() for XML */

#define CPLES_XML 1

/** Scheme for CPLEscapeString()/CPLUnescapeString() for URL */

#define CPLES_URL 2

/** Scheme for CPLEscapeString()/CPLUnescapeString() for SQL */

#define CPLES_SQL 3

/** Scheme for CPLEscapeString()/CPLUnescapeString() for CSV */

#define CPLES_CSV 4

/** Scheme for CPLEscapeString()/CPLUnescapeString() for XML (preserves quotes)

 */

#define CPLES_XML_BUT_QUOTES 5

/** Scheme for CPLEscapeString()/CPLUnescapeString() for CSV (forced quoting) */

#define CPLES_CSV_FORCE_QUOTING 6

/** Scheme for CPLEscapeString()/CPLUnescapeString() for SQL identifiers */

#define CPLES_SQLI 7

char CPL_DLL *CPLEscapeString(const char *pszString, int nLength,

                              int nScheme) CPL_WARN_UNUSED_RESULT;

char CPL_DLL *CPLUnescapeString(const char *pszString, int *pnLength,

                                int nScheme) CPL_WARN_UNUSED_RESULT;

char CPL_DLL *CPLBinaryToHex(int nBytes,

                             const GByte *pabyData) CPL_WARN_UNUSED_RESULT;

GByte CPL_DLL *CPLHexToBinary(const char *pszHex,

                              int *pnBytes) CPL_WARN_UNUSED_RESULT;

char CPL_DLL *CPLBase64Encode(int nBytes,

                              const GByte *pabyData) CPL_WARN_UNUSED_RESULT;

int CPL_DLL CPLBase64DecodeInPlace(GByte *pszBase64) CPL_WARN_UNUSED_RESULT;

/** Type of value */

typedef enum

{

    CPL_VALUE_STRING, /**< String */

    CPL_VALUE_REAL,   /**< Real number */

    CPL_VALUE_INTEGER /**< Integer */

} CPLValueType;

CPLValueType CPL_DLL CPLGetValueType(const char *pszValue);

int CPL_DLL CPLToupper(int c);

int CPL_DLL CPLTolower(int c);

size_t CPL_DLL CPLStrlcpy(char *pszDest, const char *pszSrc, size_t nDestSize);

size_t CPL_DLL CPLStrlcat(char *pszDest, const char *pszSrc, size_t nDestSize);

size_t CPL_DLL CPLStrnlen(const char *pszStr, size_t nMaxLen);

/* -------------------------------------------------------------------- */

/*      Locale independent formatting functions.                        */

/* -------------------------------------------------------------------- */

int CPL_DLL CPLvsnprintf(char *str, size_t size,

                         CPL_FORMAT_STRING(const char *fmt), va_list args)

    CPL_PRINT_FUNC_FORMAT(3, 0);

/* ALIAS_CPLSNPRINTF_AS_SNPRINTF might be defined to enable GCC 7 */

/* -Wformat-truncation= warnings, but shouldn't be set for normal use */

#if defined(ALIAS_CPLSNPRINTF_AS_SNPRINTF)

#define CPLsnprintf snprintf

#else

int CPL_DLL CPLsnprintf(char *str, size_t size,

                        CPL_FORMAT_STRING(const char *fmt), ...)

    CPL_PRINT_FUNC_FORMAT(3, 4);

#endif

/*! @cond Doxygen_Suppress */

#if defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)

int CPL_DLL CPLsprintf(char *str, CPL_FORMAT_STRING(const char *fmt), ...)

    CPL_PRINT_FUNC_FORMAT(2, 3) CPL_WARN_DEPRECATED("Use CPLsnprintf instead");

#else

int CPL_DLL CPLsprintf(char *str, CPL_FORMAT_STRING(const char *fmt), ...)

    CPL_PRINT_FUNC_FORMAT(2, 3);

#endif

/*! @endcond */

int CPL_DLL CPLprintf(CPL_FORMAT_STRING(const char *fmt), ...)

    CPL_PRINT_FUNC_FORMAT(1, 2);

/* For some reason Doxygen_Suppress is needed to avoid warning. Not sure why */

/*! @cond Doxygen_Suppress */

/* caution: only works with limited number of formats */

int CPL_DLL CPLsscanf(const char *str, CPL_SCANF_FORMAT_STRING(const char *fmt),

                      ...) CPL_SCAN_FUNC_FORMAT(2, 3);

/*! @endcond */

const char CPL_DLL *CPLSPrintf(CPL_FORMAT_STRING(const char *fmt), ...)

    CPL_PRINT_FUNC_FORMAT(1, 2) CPL_WARN_UNUSED_RESULT;

char CPL_DLL **CSLAppendPrintf(char **papszStrList,

                               CPL_FORMAT_STRING(const char *fmt), ...)

    CPL_PRINT_FUNC_FORMAT(2, 3) CPL_WARN_UNUSED_RESULT;

int CPL_DLL CPLVASPrintf(char **buf, CPL_FORMAT_STRING(const char *fmt),

                         va_list args) CPL_PRINT_FUNC_FORMAT(2, 0);

/* -------------------------------------------------------------------- */

/*      RFC 23 character set conversion/recoding API (cpl_recode.cpp).  */

/* -------------------------------------------------------------------- */

/** Encoding of the current locale */

#define CPL_ENC_LOCALE ""

/** UTF-8 encoding */

#define CPL_ENC_UTF8 "UTF-8"

/** UTF-16 encoding */

#define CPL_ENC_UTF16 "UTF-16"

/** UCS-2 encoding */

#define CPL_ENC_UCS2 "UCS-2"

/** UCS-4 encoding */

#define CPL_ENC_UCS4 "UCS-4"

/** ASCII encoding */

#define CPL_ENC_ASCII "ASCII"

/** ISO-8859-1 (LATIN1) encoding */

#define CPL_ENC_ISO8859_1 "ISO-8859-1"

int CPL_DLL CPLEncodingCharSize(const char *pszEncoding);

/*! @cond Doxygen_Suppress */

void CPL_DLL CPLClearRecodeWarningFlags(void);

/*! @endcond */

char CPL_DLL *CPLRecode(const char *pszSource, const char *pszSrcEncoding,

                        const char *pszDstEncoding)

    CPL_WARN_UNUSED_RESULT CPL_RETURNS_NONNULL;

char CPL_DLL *

CPLRecodeFromWChar(const wchar_t *pwszSource, const char *pszSrcEncoding,

                   const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT;

wchar_t CPL_DLL *

CPLRecodeToWChar(const char *pszSource, const char *pszSrcEncoding,

                 const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT;

int CPL_DLL CPLIsUTF8(const char *pabyData, int nLen);

bool CPL_DLL CPLIsASCII(const char *pabyData, size_t nLen);

char CPL_DLL *CPLForceToASCII(const char *pabyData, int nLen,

                              char chReplacementChar) CPL_WARN_UNUSED_RESULT;

char CPL_DLL *CPLUTF8ForceToASCII(const char *pszStr, char chReplacementChar)

    CPL_WARN_UNUSED_RESULT;

int CPL_DLL CPLStrlenUTF8(const char *pszUTF8Str)

    /*! @cond Doxygen_Suppress */

    CPL_WARN_DEPRECATED("Use CPLStrlenUTF8Ex() instead")

    /*! @endcond */

    ;

size_t CPL_DLL CPLStrlenUTF8Ex(const char *pszUTF8Str);

int CPL_DLL CPLCanRecode(const char *pszTestStr, const char *pszSrcEncoding,

                         const char *pszDstEncoding) CPL_WARN_UNUSED_RESULT;

CPL_C_END

#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)

extern "C++"

{

    std::string CPL_DLL CPLRemoveSQLComments(const std::string &osInput);

}

#endif

/************************************************************************/

/*                              CPLString                               */

/************************************************************************/

#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)

extern "C++"

{

#ifndef DOXYGEN_SKIP

#include <string>

#include <vector>

#if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)

#include <string_view>

#endif

#endif

// VC++ implicitly applies __declspec(dllexport) to template base classes

// of classes marked with __declspec(dllexport).

// Hence, if marked with CPL_DLL, VC++ would export symbols for the

// specialization of std::basic_string<char>, since it is a base class of

// CPLString. As a result, if an application linked both gdal.dll and a static

// library that (implicitly) instantiates std::string (almost all do!), then the

// linker would emit an error concerning duplicate symbols for std::string. The

// least intrusive solution is to not mark the whole class with

// __declspec(dllexport) for VC++, but only its non-inline methods.

#ifdef _MSC_VER

#define CPLSTRING_CLASS_DLL

#define CPLSTRING_METHOD_DLL CPL_DLL

#else

/*! @cond Doxygen_Suppress */

#define CPLSTRING_CLASS_DLL CPL_DLL

#define CPLSTRING_METHOD_DLL

/*! @endcond */

#endif

    //! Convenient string class based on std::string.

    class CPLSTRING_CLASS_DLL CPLString : public std::string

    {

      public:

        /** Constructor */

        CPLString(void)

        {

        }

        /** Constructor */

        // cppcheck-suppress noExplicitConstructor

        CPLString(const std::string &oStr) : std::string(oStr)

        {

        }

        /** Constructor */

        // cppcheck-suppress noExplicitConstructor

        CPLString(const char *pszStr) : std::string(pszStr)

        {

        }

        /** Constructor */

        CPLString(const char *pszStr, size_t n) : std::string(pszStr, n)

        {

        }

        /** Return string as zero terminated character array */

        operator const char *(void) const

        {

            return c_str();

        }

        /** Return character at specified index */

        char &operator[](std::string::size_type i)

        {

            return std::string::operator[](i);

        }

        /** Return character at specified index */

        const char &operator[](std::string::size_type i) const

        {

            return std::string::operator[](i);

        }

        /** Return character at specified index */

        char &operator[](int i)

        {

            return std::string::operator[](

                static_cast<std::string::size_type>(i));

        }

        /** Return character at specified index */

        const char &operator[](int i) const

        {

            return std::string::operator[](

                static_cast<std::string::size_type>(i));

        }

        /** Clear the string */

        void Clear()

        {

            resize(0);

        }

        /** Assign specified string and take ownership of it (assumed to be

         * allocated with CPLMalloc()). NULL can be safely passed to clear the

         * string. */

        void Seize(char *pszValue)

        {

            if (pszValue == nullptr)

                Clear();

            else

            {

                *this = pszValue;

                CPLFree(pszValue);

            }

        }

        /* There seems to be a bug in the way the compiler count indices...

         * Should be CPL_PRINT_FUNC_FORMAT (1, 2) */

        CPLSTRING_METHOD_DLL CPLString &

        Printf(CPL_FORMAT_STRING(const char *pszFormat), ...)

            CPL_PRINT_FUNC_FORMAT(2, 3);

        CPLSTRING_METHOD_DLL CPLString &

        vPrintf(CPL_FORMAT_STRING(const char *pszFormat), va_list args)

            CPL_PRINT_FUNC_FORMAT(2, 0);

        CPLSTRING_METHOD_DLL CPLString &

        FormatC(double dfValue, const char *pszFormat = nullptr);

        CPLSTRING_METHOD_DLL CPLString &Trim();

        CPLSTRING_METHOD_DLL CPLString &Recode(const char *pszSrcEncoding,

                                               const char *pszDstEncoding);

        CPLSTRING_METHOD_DLL CPLString &replaceAll(const std::string &osBefore,

                                                   const std::string &osAfter);

        CPLSTRING_METHOD_DLL CPLString &replaceAll(const std::string &osBefore,

                                                   char chAfter);

        CPLSTRING_METHOD_DLL CPLString &replaceAll(char chBefore,

                                                   const std::string &osAfter);

        CPLSTRING_METHOD_DLL CPLString &replaceAll(char chBefore, char chAfter);

        /* case insensitive find alternates */

        CPLSTRING_METHOD_DLL size_t ifind(const std::string &str,

                                          size_t pos = 0) const;

        CPLSTRING_METHOD_DLL size_t ifind(const char *s, size_t pos = 0) const;

        CPLSTRING_METHOD_DLL CPLString &toupper(void);

        CPLSTRING_METHOD_DLL CPLString &tolower(void);

        CPLSTRING_METHOD_DLL bool endsWith(const std::string &osStr) const;

        CPLSTRING_METHOD_DLL CPLString URLEncode() const;

        CPLSTRING_METHOD_DLL CPLString SQLQuotedIdentifier() const;

        CPLSTRING_METHOD_DLL CPLString SQLQuotedLiteral() const;

      private:

        operator void *(void) = delete;

    };

#undef CPLSTRING_CLASS_DLL

#undef CPLSTRING_METHOD_DLL

    CPLString CPL_DLL CPLOPrintf(CPL_FORMAT_STRING(const char *pszFormat), ...)

        CPL_PRINT_FUNC_FORMAT(1, 2);

    CPLString CPL_DLL CPLOvPrintf(CPL_FORMAT_STRING(const char *pszFormat),

                                  va_list args) CPL_PRINT_FUNC_FORMAT(1, 0);

    CPLString CPL_DLL CPLQuotedSQLIdentifier(const char *pszIdent);

    /* -------------------------------------------------------------------- */

    /*      URL processing functions, here since they depend on CPLString.  */

    /* -------------------------------------------------------------------- */

    CPLString CPL_DLL CPLURLGetValue(const char *pszURL, const char *pszKey);

    CPLString CPL_DLL CPLURLAddKVP(const char *pszURL, const char *pszKey,

                                   const char *pszValue);

    /************************************************************************/

    /*                            CPLStringList                             */

    /************************************************************************/

    //! String list class designed around our use of C "char**" string lists.

    class CPL_DLL CPLStringList

    {

        char **papszList = nullptr;

        mutable int nCount = 0;

        mutable int nAllocation = 0;

        bool bOwnList = false;

        bool bIsSorted = false;

        bool MakeOurOwnCopy();

        bool EnsureAllocation(int nMaxLength);

        int FindSortedInsertionPoint(const char *pszLine);

      public:

        CPLStringList();

        explicit CPLStringList(char **papszList, int bTakeOwnership = TRUE);

        explicit CPLStringList(CSLConstList papszList);

        explicit CPLStringList(const std::vector<std::string> &aosList);

        explicit CPLStringList(std::initializer_list<const char *> oInitList);

        CPLStringList(const CPLStringList &oOther);

        CPLStringList(CPLStringList &&oOther);

        ~CPLStringList();

        static const CPLStringList BoundToConstList(CSLConstList papszList);

        CPLStringList &Clear();

        /** Clear the list */

        inline void clear()

        {

            Clear();

        }

        /** Return size of list */

        int size() const

        {

            return Count();

        }

        int Count() const;

        /** Return whether the list is empty. */

        bool empty() const

        {

            return Count() == 0;

        }

        CPLStringList &AddString(const char *pszNewString);

        CPLStringList &AddString(const std::string &newString);

        CPLStringList &AddStringDirectly(char *pszNewString);

        /** Add a string to the list */

        void push_back(const char *pszNewString)

        {

            AddString(pszNewString);

        }

        /** Add a string to the list */

        void push_back(const std::string &osStr)

        {

            AddString(osStr.c_str());

        }

#if defined(DOXYGEN_SKIP) || __cplusplus >= 201703L ||                         \

    (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)

        void push_back(std::string_view svStr);

#endif

        CPLStringList &InsertString(int nInsertAtLineNo, const char *pszNewLine)

        {

            return InsertStringDirectly(nInsertAtLineNo, CPLStrdup(pszNewLine));

        }

        CPLStringList &InsertStringDirectly(int nInsertAtLineNo,

                                            char *pszNewLine);

        // CPLStringList &InsertStrings( int nInsertAtLineNo, char

        // **papszNewLines );

        CPLStringList &RemoveStrings(int nFirstLineToDelete,

                                     int nNumToRemove = 1);

        /** Return index of pszTarget in the list, or -1 */

        int FindString(const char *pszTarget) const

        {

            return CSLFindString(papszList, pszTarget);

        }

        /** Return index of pszTarget in the list (using partial search), or -1

         */

        int PartialFindString(const char *pszNeedle) const

        {

            return CSLPartialFindString(papszList, pszNeedle);

        }

        int FindName(const char *pszName) const;

        bool FetchBool(const char *pszKey, bool bDefault) const;

        // Deprecated.

        int FetchBoolean(const char *pszKey, int bDefault) const;

        const char *FetchNameValue(const char *pszKey) const;

        const char *FetchNameValueDef(const char *pszKey,

                                      const char *pszDefault) const;

        CPLStringList &AddNameValue(const char *pszKey, const char *pszValue);

        CPLStringList &SetNameValue(const char *pszKey, const char *pszValue);

        CPLStringList &SetString(int pos, const char *pszString);

        CPLStringList &SetString(int pos, const std::string &osString);

        CPLStringList &SetStringDirectly(int pos, char *pszString);

        CPLStringList &Assign(char **papszListIn, int bTakeOwnership = TRUE);

        /** Assignment operator */

        CPLStringList &operator=(char **papszListIn)

        {

            return Assign(papszListIn, TRUE);

        }

        /** Assignment operator */

        CPLStringList &operator=(const CPLStringList &oOther);

        /** Assignment operator */

        CPLStringList &operator=(CSLConstList papszListIn);

        /** Move assignment operator */

        CPLStringList &operator=(CPLStringList &&oOther);

        /** Return string at specified index */

        char *operator[](int i);

        /** Return string at specified index */

        char *operator[](size_t i)

        {

            return (*this)[static_cast<int>(i)];

        }

        /** Return string at specified index */

        const char *operator[](int i) const;

        /** Return string at specified index */

        const char *operator[](size_t i) const

        {

            return (*this)[static_cast<int>(i)];

        }

        /** Return value corresponding to pszKey, or nullptr */

        const char *operator[](const char *pszKey) const

        {

            return FetchNameValue(pszKey);

        }

        /** Return first element */

        inline const char *front() const

        {

            return papszList[0];

        }

        /** Return last element */

        inline const char *back() const

        {

            return papszList[size() - 1];

        }

        /** begin() implementation */

        const char *const *begin() const

        {

            return papszList ? &papszList[0] : nullptr;

        }

        /** end() implementation */

        const char *const *end() const

        {

            return papszList ? &papszList[size()] : nullptr;

        }

        /** Return list. Ownership remains to the object */

        char **List()

        {

            return papszList;

        }

        /** Return list. Ownership remains to the object */

        CSLConstList List() const

        {

            return papszList;

        }

        char **StealList();

        CPLStringList &Sort();

        /** Returns whether the list is sorted */

        int IsSorted() const

        {

            return bIsSorted;

        }

        /** Return lists */

        operator char **(void)

        {

            return List();

        }

        /** Return lists */

        operator CSLConstList(void) const

        {

            return List();

        }

        /** Return the list as a vector of strings */

        operator std::vector<std::string>(void) const

        {

            return std::vector<std::string>{begin(), end()};

        }

      private:

        operator void *(void) = delete;

    };

#ifdef GDAL_COMPILATION

#include <iterator>  // For std::input_iterator_tag

#include <memory>

#include <string_view>

#include <utility>  // For std::pair

    /*! @cond Doxygen_Suppress */

    struct CPL_DLL CSLDestroyReleaser

    {

        void operator()(char **papszStr) const

        {

            CSLDestroy(papszStr);

        }

    };

    /*! @endcond */

    /** Unique pointer type to use with CSL functions returning a char** */

    using CSLUniquePtr = std::unique_ptr<char *, CSLDestroyReleaser>;

    /** Unique pointer type to use with functions returning a char* to release

     * with VSIFree */

    using CPLCharUniquePtr = std::unique_ptr<char, VSIFreeReleaser>;

    namespace cpl

    {

    /*! @cond Doxygen_Suppress */

    /** Equivalent of C++20 std::string::starts_with(const char*) */

    template <class StringType>

    inline bool starts_with(const StringType &str, const char *prefix)

    {

        const size_t prefixLen = strlen(prefix);

        return str.size() >= prefixLen &&

               str.compare(0, prefixLen, prefix, prefixLen) == 0;

    }

    /** Equivalent of C++20 std::string::starts_with(const std::string &) */

    template <class StringType>

    inline bool starts_with(const StringType &str, const std::string &prefix)

    {

        return str.size() >= prefix.size() &&

               str.compare(0, prefix.size(), prefix) == 0;

    }

    /** Equivalent of C++20 std::string::starts_with(std::string_view) */

    template <class StringType>

    inline bool starts_with(const StringType &str, std::string_view prefix)

    {

        return str.size() >= prefix.size() &&

               str.compare(0, prefix.size(), prefix) == 0;

    }

    /** Equivalent of C++20 std::string::ends_with(const char*) */

    template <class StringType>

    inline bool ends_with(const StringType &str, const char *suffix)

    {

        const size_t suffixLen = strlen(suffix);

        return str.size() >= suffixLen &&

               str.compare(str.size() - suffixLen, suffixLen, suffix,

                           suffixLen) == 0;

    }

Unexecuted instantiation: bool cpl::ends_with<std::__1::basic_string_view<char, std::__1::char_traits<char> > >(std::__1::basic_string_view<char, std::__1::char_traits<char> > const&, char const*)

Unexecuted instantiation: bool cpl::ends_with<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, char const*)

    /** Equivalent of C++20 std::string::ends_with(const std::string &) */

    template <class StringType>

    inline bool ends_with(const StringType &str, const std::string &suffix)

    {

        return str.size() >= suffix.size() &&

               str.compare(str.size() - suffix.size(), suffix.size(), suffix) ==

                   0;

    }

    /** Equivalent of C++20 std::string::ends_with(std::string_view) */

    template <class StringType>

    inline bool ends_with(const StringType &str, std::string_view suffix)

    {

        return str.size() >= suffix.size() &&

               str.compare(str.size() - suffix.size(), suffix.size(), suffix) ==

                   0;

    }

    /** Iterator for a CSLConstList */

    struct CPL_DLL CSLIterator

    {

        using iterator_category = std::input_iterator_tag;

        using difference_type = std::ptrdiff_t;

        using value_type = const char *;

        using pointer = value_type *;

        using reference = value_type &;

        CSLConstList m_papszList = nullptr;

        bool m_bAtEnd = false;

        inline const char *operator*() const

        {

            return *m_papszList;

        }

        inline CSLIterator &operator++()

        {

            if (m_papszList)

                ++m_papszList;

            return *this;

        }

        bool operator==(const CSLIterator &other) const;

        inline bool operator!=(const CSLIterator &other) const

        {

            return !(operator==(other));

        }

    };

    /*! @endcond */

    /** Wrapper for a CSLConstList that can be used with C++ iterators.

     *

     * @since GDAL 3.9

     */

    struct CPL_DLL CSLIteratorWrapper

    {

      public:

        /** Constructor */

        inline explicit CSLIteratorWrapper(CSLConstList papszList)

            : m_papszList(papszList)

        {

        }

        /** Get the begin of the list */

        inline CSLIterator begin() const

        {

            return {m_papszList, false};

        }

        /** Get the end of the list */

        inline CSLIterator end() const

        {

            return {m_papszList, true};

        }

      private:

        CSLConstList m_papszList;

    };

    /** Wraps a CSLConstList in a structure that can be used with C++ iterators.

     *

     * @since GDAL 3.9

     */

    inline CSLIteratorWrapper Iterate(CSLConstList papszList)

    {

        return CSLIteratorWrapper{papszList};

    }

    /*! @cond Doxygen_Suppress */

    inline CSLIteratorWrapper Iterate(const CPLStringList &aosList)

    {

        return Iterate(aosList.List());

    }

    /*! @endcond */

    /*! @cond Doxygen_Suppress */

    inline CSLIteratorWrapper Iterate(char **) = delete;

    /*! @endcond */

    /*! @cond Doxygen_Suppress */

    /** Iterator for a CSLConstList as (name, value) pairs. */

    struct CPL_DLL CSLNameValueIterator

    {

        using iterator_category = std::input_iterator_tag;

        using difference_type = std::ptrdiff_t;

        using value_type = std::pair<const char *, const char *>;

        using pointer = value_type *;

        using reference = value_type &;

        CSLConstList m_papszList = nullptr;

        bool m_bReturnNullKeyIfNotNameValue = false;

        std::string m_osKey{};

        value_type operator*();

        inline CSLNameValueIterator &operator++()

        {

            if (m_papszList)

                ++m_papszList;

            return *this;

        }

        inline bool operator==(const CSLNameValueIterator &other) const

        {

            return m_papszList == other.m_papszList;

        }

        inline bool operator!=(const CSLNameValueIterator &other) const

        {

            return !(operator==(other));

        }

    };

    /*! @endcond */

    /** Wrapper for a CSLConstList that can be used with C++ iterators

     * to get (name, value) pairs.

     *

     * This can for example be used to do the following:

     * for (const auto& [name, value]: cpl::IterateNameValue(papszList)) {}

     *

     * Note that a (name, value) pair returned by dereferencing an iterator

     * is invalidated by the next iteration on the iterator.

     *

     * @since GDAL 3.9

     */

    struct CPL_DLL CSLNameValueIteratorWrapper

    {

      public:

        /** Constructor */

        inline explicit CSLNameValueIteratorWrapper(

            CSLConstList papszList, bool bReturnNullKeyIfNotNameValue)

            : m_papszList(papszList),

              m_bReturnNullKeyIfNotNameValue(bReturnNullKeyIfNotNameValue)

        {

        }

        /** Get the begin of the list */

        inline CSLNameValueIterator begin() const

        {

            return {m_papszList, m_bReturnNullKeyIfNotNameValue};

        }

        /** Get the end of the list */

        CSLNameValueIterator end() const;

      private:

        CSLConstList m_papszList;

        const bool m_bReturnNullKeyIfNotNameValue;

    };

    /** Wraps a CSLConstList in a structure that can be used with C++ iterators

     * to get (name, value) pairs.

     *

     * This can for example be used to do the following:

     * for (const auto& [name, value]: cpl::IterateNameValue(papszList)) {}

     *

     * Note that a (name, value) pair returned by dereferencing an iterator

     * is invalidated by the next iteration on the iterator.

     *

     * @param papszList List to iterate over.

     * @param bReturnNullKeyIfNotNameValue When this is set to true, if a string

     * contained in the list if not of the form name=value, then the value of

     * the iterator will be (nullptr, string).

     *

     * @since GDAL 3.9

     */

    inline CSLNameValueIteratorWrapper

    IterateNameValue(CSLConstList papszList,

                     bool bReturnNullKeyIfNotNameValue = false)

    {

        return CSLNameValueIteratorWrapper{papszList,

                                           bReturnNullKeyIfNotNameValue};

    }

    /*! @cond Doxygen_Suppress */

    inline CSLNameValueIteratorWrapper

    IterateNameValue(const CPLStringList &aosList,

                     bool bReturnNullKeyIfNotNameValue = false)

    {

        return IterateNameValue(aosList.List(), bReturnNullKeyIfNotNameValue);

    }

    /*! @endcond */

    /*! @cond Doxygen_Suppress */

    inline CSLIteratorWrapper IterateNameValue(char **, bool = false) = delete;

    /*! @endcond */

    /** Converts a CSLConstList to a std::vector<std::string> */

    inline std::vector<std::string> ToVector(CSLConstList papszList)

    {

        return CPLStringList::BoundToConstList(papszList);

    }

    inline std::vector<std::string> ToVector(char **) = delete;

    }  // namespace cpl

#endif

}  // extern "C++"

#endif /* def __cplusplus && !CPL_SUPRESS_CPLUSPLUS */

#endif /* CPL_STRING_H_INCLUDED */