cpl_string.h

Go to the documentation of this file.
00001 /**********************************************************************
00002  * $Id: cpl_string.h 14851 2008-07-07 18:57:42Z mloskot $
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 #define CSLT_STRIPLEADSPACES    0x0010
00078 #define CSLT_STRIPENDSPACES     0x0020
00079 
00080 int CPL_DLL CSLPrint(char **papszStrList, FILE *fpOut);
00081 char CPL_DLL **CSLLoad(const char *pszFname);
00082 int CPL_DLL CSLSave(char **papszStrList, const char *pszFname);
00083 
00084 char CPL_DLL **CSLInsertStrings(char **papszStrList, int nInsertAtLineNo, 
00085                          char **papszNewLines);
00086 char CPL_DLL **CSLInsertString(char **papszStrList, int nInsertAtLineNo, 
00087                                const char *pszNewLine);
00088 char CPL_DLL **CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete,
00089                          int nNumToRemove, char ***ppapszRetStrings);
00090 int CPL_DLL CSLFindString( char **, const char * );
00091 int CPL_DLL CSLPartialFindString( char **papszHaystack, 
00092         const char * pszNeedle );
00093 int CPL_DLL CSLFindName(char **papszStrList, const char *pszName);
00094 int CPL_DLL CSLTestBoolean( const char *pszValue );
00095 int CPL_DLL CSLFetchBoolean( char **papszStrList, const char *pszKey, 
00096                              int bDefault );
00097 
00098 const char CPL_DLL *CPLSPrintf(const char *fmt, ...) CPL_PRINT_FUNC_FORMAT(1, 2);
00099 char CPL_DLL **CSLAppendPrintf(char **papszStrList, const char *fmt, ...) CPL_PRINT_FUNC_FORMAT(2, 3);
00100 int CPL_DLL CPLVASPrintf(char **buf, const char *fmt, va_list args );
00101 
00102 const char CPL_DLL *
00103       CPLParseNameValue(const char *pszNameValue, char **ppszKey );
00104 const char CPL_DLL *
00105       CSLFetchNameValue(char **papszStrList, const char *pszName);
00106 char CPL_DLL **
00107       CSLFetchNameValueMultiple(char **papszStrList, const char *pszName);
00108 char CPL_DLL **
00109       CSLAddNameValue(char **papszStrList, 
00110                       const char *pszName, const char *pszValue);
00111 char CPL_DLL **
00112       CSLSetNameValue(char **papszStrList, 
00113                       const char *pszName, const char *pszValue);
00114 void CPL_DLL CSLSetNameValueSeparator( char ** papszStrList, 
00115                                        const char *pszSeparator );
00116 
00117 #define CPLES_BackslashQuotable 0
00118 #define CPLES_XML               1
00119 #define CPLES_URL               2   /* unescape only for now */
00120 #define CPLES_SQL               3
00121 #define CPLES_CSV               4
00122 
00123 char CPL_DLL *CPLEscapeString( const char *pszString, int nLength, 
00124                                int nScheme );
00125 char CPL_DLL *CPLUnescapeString( const char *pszString, int *pnLength,
00126                                  int nScheme );
00127 
00128 char CPL_DLL *CPLBinaryToHex( int nBytes, const GByte *pabyData );
00129 GByte CPL_DLL *CPLHexToBinary( const char *pszHex, int *pnBytes );
00130 
00131 typedef enum
00132 {
00133     CPL_VALUE_STRING,
00134     CPL_VALUE_REAL,
00135     CPL_VALUE_INTEGER
00136 } CPLValueType;
00137 
00138 CPLValueType CPL_DLL CPLGetValueType(const char* pszValue);
00139 
00140 /* -------------------------------------------------------------------- */
00141 /*      RFC 23 character set conversion/recoding API (cpl_recode.cpp).  */
00142 /* -------------------------------------------------------------------- */
00143 #define CPL_ENC_LOCALE     ""
00144 #define CPL_ENC_UTF8       "UTF-8"
00145 #define CPL_ENC_UTF16      "UTF-16"
00146 #define CPL_ENC_UCS2       "UCS-2"
00147 #define CPL_ENC_UCS4       "UCS-4"
00148 #define CPL_ENC_ASCII      "ASCII"
00149 #define CPL_ENC_ISO8859_1  "ISO-8859-1"
00150 
00151 char CPL_DLL *CPLRecode( const char *pszSource, 
00152                          const char *pszSrcEncoding, 
00153                          const char *pszDstEncoding );
00154 char CPL_DLL *CPLRecodeFromWChar( const wchar_t *pwszSource, 
00155                                   const char *pszSrcEncoding, 
00156                                   const char *pszDstEncoding );
00157 wchar_t CPL_DLL *CPLRecodeToWChar( const char *pszSource,
00158                                    const char *pszSrcEncoding, 
00159                                    const char *pszDstEncoding );
00160 
00161 CPL_C_END
00162 
00163 /************************************************************************/
00164 /*                              CPLString                               */
00165 /************************************************************************/
00166 
00167 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
00168 
00169 #include <string>
00170 
00171 /*
00172  * Simple trick to avoid "using" declaration in header for new compilers
00173  * but make it still working with old compilers which throw C2614 errors.
00174  *
00175  * Define MSVC_OLD_STUPID_BEHAVIOUR
00176  * for old compilers: VC++ 5 and 6 as well as eVC++ 3 and 4.
00177  */
00178 
00179 /*
00180  * Detect old MSVC++ compiler <= 6.0
00181  * 1200 - VC++ 6.0
00182  * 1200-1202 - eVC++ 4.0
00183  */
00184 #if defined(_MSC_VER) 
00185 # if (_MSC_VER <= 1202) 
00186 #  define MSVC_OLD_STUPID_BEHAVIOUR 
00187 # endif
00188 #endif
00189 
00190 /* Avoid C2614 errors */
00191 #ifdef MSVC_OLD_STUPID_BEHAVIOUR
00192     using std::string;
00193 # define std_string string
00194 #else
00195 # define std_string std::string
00196 #endif 
00197 
00198 /* Remove annoying warnings in Microsoft eVC++ and Microsoft Visual C++ */
00199 #if defined(WIN32CE)
00200 #  pragma warning(disable:4251 4275 4786)
00201 #endif
00202 
00203 
00204 
00205 
00206 class CPL_DLL CPLString : public std_string
00207 {
00208 public:
00209 
00210     
00211     CPLString(void) {}
00212     CPLString( const std::string &oStr ) : std_string( oStr ) {}
00213     CPLString( const char *pszStr ) : std_string( pszStr ) {}
00214     
00215     operator const char* (void) const { return c_str(); }
00216 
00217     char& operator[](std::string::size_type i)
00218     {
00219         return std_string::operator[](i);
00220     }
00221     
00222     const char& operator[](std::string::size_type i) const
00223     {
00224         return std_string::operator[](i);
00225     }
00226 
00227     char& operator[](int i)
00228     {
00229         return std_string::operator[](static_cast<std::string::size_type>(i));
00230     }
00231 
00232     const char& operator[](int i) const
00233     {
00234         return std_string::operator[](static_cast<std::string::size_type>(i));
00235     }
00236 
00237     void Clear() { resize(0); }
00238 
00239     /* There seems to be a bug in the way the compiler count indices... Should be CPL_PRINT_FUNC_FORMAT (1, 2) */
00240     CPLString &Printf( const char *pszFormat, ... ) CPL_PRINT_FUNC_FORMAT (2, 3);
00241     CPLString &vPrintf( const char *pszFormat, va_list args );
00242     CPLString &FormatC( double dfValue, const char *pszFormat = NULL );
00243     CPLString &Trim();
00244 };
00245 
00246 #endif /* def __cplusplus && !CPL_SUPRESS_CPLUSPLUS */
00247 
00248 #endif /* _CPL_STRING_H_INCLUDED */

Generated for GDAL by doxygen 1.7.1.