- Main Page
- Classes
- Files
- Related Pages

- File List
- File Members

# cpl_string.h

Go to the documentation of this file.

    00001 /**********************************************************************
    00002  * $Id: cpl_string.h 13339 2007-12-14 18:10:05Z warmerdam $
    00003  *
    00004  * Name:     cpl_string.h
    00005  * Project:  CPL - Common Portability Library
    00006  * Purpose:  String and StringList functions.
    00007  * Author:   Daniel Morissette, dmorissette@mapgears.com
    00008  *
    00009  **********************************************************************
    00010  * Copyright (c) 1998, Daniel Morissette
    00011  *
    00012  * Permission is hereby granted, free of charge, to any person obtaining a
    00013  * copy of this software and associated documentation files (the "Software"),
    00014  * to deal in the Software without restriction, including without limitation
    00015  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
    00016  * and/or sell copies of the Software, and to permit persons to whom the
    00017  * Software is furnished to do so, subject to the following conditions:
    00018  *
    00019  * The above copyright notice and this permission notice shall be included
    00020  * in all copies or substantial portions of the Software.
    00021  *
    00022  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00023  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00024  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
    00025  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00026  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    00027  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    00028  * DEALINGS IN THE SOFTWARE.
    00029  ****************************************************************************/
    00030
    00031 #ifndef _CPL_STRING_H_INCLUDED
    00032 #define _CPL_STRING_H_INCLUDED
    00033
    00034 #include "cpl_vsi.h"
    00035 #include "cpl_error.h"
    00036 #include "cpl_conv.h"
    00037
    00056 CPL_C_START
    00057
    00058 char CPL_DLL **CSLAddString(char **papszStrList, const char *pszNewString);
    00059 int CPL_DLL CSLCount(char **papszStrList);
    00060 const char CPL_DLL *CSLGetField( char **, int );
    00061 void CPL_DLL CPL_STDCALL CSLDestroy(char **papszStrList);
    00062 char CPL_DLL **CSLDuplicate(char **papszStrList);
    00063 char CPL_DLL **CSLMerge( char **papszOrig, char **papszOverride );
    00064
    00065 char CPL_DLL **CSLTokenizeString(const char *pszString );
    00066 char CPL_DLL **CSLTokenizeStringComplex(const char *pszString,
    00067                                    const char *pszDelimiter,
    00068                                    int bHonourStrings, int bAllowEmptyTokens );
    00069 char CPL_DLL **CSLTokenizeString2( const char *pszString,
    00070                                    const char *pszDelimeter,
    00071                                    int nCSLTFlags );
    00072
    00073 #define CSLT_HONOURSTRINGS      0x0001
    00074 #define CSLT_ALLOWEMPTYTOKENS   0x0002
    00075 #define CSLT_PRESERVEQUOTES     0x0004
    00076 #define CSLT_PRESERVEESCAPES    0x0008
    00077
    00078 int CPL_DLL CSLPrint(char **papszStrList, FILE *fpOut);
    00079 char CPL_DLL **CSLLoad(const char *pszFname);
    00080 int CPL_DLL CSLSave(char **papszStrList, const char *pszFname);
    00081
    00082 char CPL_DLL **CSLInsertStrings(char **papszStrList, int nInsertAtLineNo,
    00083                          char **papszNewLines);
    00084 char CPL_DLL **CSLInsertString(char **papszStrList, int nInsertAtLineNo,
    00085                                const char *pszNewLine);
    00086 char CPL_DLL **CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete,
    00087                          int nNumToRemove, char ***ppapszRetStrings);
    00088 int CPL_DLL CSLFindString( char **, const char * );
    00089 int CPL_DLL CSLPartialFindString( char **papszHaystack,
    00090         const char * pszNeedle );
    00091 int CPL_DLL CSLTestBoolean( const char *pszValue );
    00092 int CPL_DLL CSLFetchBoolean( char **papszStrList, const char *pszKey,
    00093                              int bDefault );
    00094
    00095 const char CPL_DLL *CPLSPrintf(const char *fmt, ...);
    00096 char CPL_DLL **CSLAppendPrintf(char **papszStrList, char *fmt, ...);
    00097 int CPL_DLL CPLVASPrintf(char **buf, const char *fmt, va_list args );
    00098
    00099 const char CPL_DLL *
    00100       CPLParseNameValue(const char *pszNameValue, char **ppszKey );
    00101 const char CPL_DLL *
    00102       CSLFetchNameValue(char **papszStrList, const char *pszName);
    00103 char CPL_DLL **
    00104       CSLFetchNameValueMultiple(char **papszStrList, const char *pszName);
    00105 char CPL_DLL **
    00106       CSLAddNameValue(char **papszStrList,
    00107                       const char *pszName, const char *pszValue);
    00108 char CPL_DLL **
    00109       CSLSetNameValue(char **papszStrList,
    00110                       const char *pszName, const char *pszValue);
    00111 void CPL_DLL CSLSetNameValueSeparator( char ** papszStrList,
    00112                                        const char *pszSeparator );
    00113
    00114 #define CPLES_BackslashQuotable 0
    00115 #define CPLES_XML               1
    00116 #define CPLES_URL               2   /* unescape only for now */
    00117 #define CPLES_SQL               3
    00118 #define CPLES_CSV               4
    00119
    00120 char CPL_DLL *CPLEscapeString( const char *pszString, int nLength,
    00121                                int nScheme );
    00122 char CPL_DLL *CPLUnescapeString( const char *pszString, int *pnLength,
    00123                                  int nScheme );
    00124
    00125 char CPL_DLL *CPLBinaryToHex( int nBytes, const GByte *pabyData );
    00126 GByte CPL_DLL *CPLHexToBinary( const char *pszHex, int *pnBytes );
    00127
    00128 CPL_C_END
    00129
    00130 /************************************************************************/
    00131 /*                              CPLString                               */
    00132 /************************************************************************/
    00133
    00134 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
    00135
    00136 #include <string>
    00137
    00138 /*
    00139  * Simple trick to avoid "using" declaration in header for new compilers
    00140  * but make it still working with old compilers which throw C2614 errors.
    00141  *
    00142  * Define MSVC_OLD_STUPID_BEHAVIOUR
    00143  * for old compilers: VC++ 5 and 6 as well as eVC++ 3 and 4.
    00144  */
    00145
    00146 /*
    00147  * Detect old MSVC++ compiler <= 6.0
    00148  * 1200 - VC++ 6.0
    00149  * 1200-1202 - eVC++ 4.0
    00150  */
    00151 #if (_MSC_VER <= 1202)
    00152 #  define MSVC_OLD_STUPID_BEHAVIOUR
    00153 #endif
    00154
    00155
    00156 /* Avoid C2614 errors */
    00157 #ifdef MSVC_OLD_STUPID_BEHAVIOUR
    00158     using std::string;
    00159 # define std_string string
    00160 #else
    00161 # define std_string std::string
    00162 #endif
    00163
    00164 /* Remove annoying warnings in Microsoft eVC++ and Microsoft Visual C++ */
    00165 #if defined(WIN32CE)
    00166 #  pragma warning(disable:4251 4275 4786)
    00167 #endif
    00168
    00169
    00170
    00171
    00172 class CPL_DLL CPLString : public std_string
    00173 {
    00174 public:
    00175
    00176
    00177     CPLString(void) {}
    00178     CPLString( const std::string &oStr ) : std_string( oStr ) {}
    00179     CPLString( const char *pszStr ) : std_string( pszStr ) {}
    00180
    00181     operator const char* (void) const { return c_str(); }
    00182
    00183     char& operator[](std::string::size_type i)
    00184     {
    00185         return std_string::operator[](i);
    00186     }
    00187
    00188     const char& operator[](std::string::size_type i) const
    00189     {
    00190         return std_string::operator[](i);
    00191     }
    00192
    00193     char& operator[](int i)
    00194     {
    00195         return std_string::operator[](static_cast<std::string::size_type>(i));
    00196     }
    00197
    00198     const char& operator[](int i) const
    00199     {
    00200         return std_string::operator[](static_cast<std::string::size_type>(i));
    00201     }
    00202
    00203     void Clear() { resize(0); }
    00204
    00205     CPLString &Printf( const char *pszFormat, ... );
    00206     CPLString &vPrintf( const char *pszFormat, va_list args );
    00207     CPLString &FormatC( double dfValue, const char *pszFormat = NULL );
    00208     CPLString &Trim();
    00209 };
    00210
    00211 #endif /* def __cplusplus && !CPL_SUPRESS_CPLUSPLUS */
    00212
    00213 #endif /* _CPL_STRING_H_INCLUDED */

Generated for GDAL by 1.5.1.