- Main Page
- Classes
- Files
- Directories
- Related Pages

- File List
- File Members

# cpl_string.h

Go to the documentation of this file.

    00001 /**********************************************************************
    00002  * $Id: cpl_string.h,v 1.27 2006/11/22 18:17:49 fwarmerdam Exp $
    00003  *
    00004  * Name:     cpl_string.h
    00005  * Project:  CPL - Common Portability Library
    00006  * Purpose:  String and StringList functions.
    00007  * Author:   Daniel Morissette, danmo@videotron.ca
    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  * $Log: cpl_string.h,v $
    00032  * Revision 1.27  2006/11/22 18:17:49  fwarmerdam
    00033  * changed frmt to const char in CPLSPrintf
    00034  *
    00035  * Revision 1.26  2006/11/16 14:36:11  mloskot
    00036  * Disabled annoying warnings for Visual C++.
    00037  *
    00038  * Revision 1.25  2006/04/12 15:10:40  fwarmerdam
    00039  * argument to InsertString should be const
    00040  *
    00041  * Revision 1.24  2006/03/21 20:11:54  fwarmerdam
    00042  * fixup headers a bit
    00043  *
    00044  * Revision 1.23  2006/02/19 21:54:34  mloskot
    00045  * [WINCE] Changes related to Windows CE port of CPL. Most changes are #ifdef wrappers.
    00046  *
    00047  * Revision 1.22  2005/10/13 01:20:16  fwarmerdam
    00048  * added CSLMerge()
    00049  *
    00050  * Revision 1.21  2005/09/14 19:21:17  fwarmerdam
    00051  * binary pointer is const in binarytohex
    00052  *
    00053  * Revision 1.20  2005/08/31 05:08:01  fwarmerdam
    00054  * fixed up std::string use for vc6 compatability
    00055  *
    00056  * Revision 1.19  2005/08/31 03:30:51  fwarmerdam
    00057  * added binarytohex/hextobinary, CPLString
    00058  *
    00059  * Revision 1.18  2005/04/04 15:23:31  fwarmerdam
    00060  * some functions now CPL_STDCALL
    00061  *
    00062  * Revision 1.17  2004/08/16 20:23:46  warmerda
    00063  * added .csv escaping
    00064  *
    00065  * Revision 1.16  2004/07/12 21:50:38  warmerda
    00066  * Added SQL escaping style
    00067  *
    00068  * Revision 1.15  2003/07/17 10:15:40  dron
    00069  * CSLTestBoolean() added.
    00070  *
    00071  * Revision 1.14  2003/03/11 21:33:03  warmerda
    00072  * added URL encode/decode support, untested
    00073  *
    00074  * Revision 1.13  2003/01/30 19:15:55  warmerda
    00075  * added some docs
    00076  **********************************************************************/
    00077
    00078 #ifndef _CPL_STRING_H_INCLUDED
    00079 #define _CPL_STRING_H_INCLUDED
    00080
    00081 #include "cpl_vsi.h"
    00082 #include "cpl_error.h"
    00083 #include "cpl_conv.h"
    00084
    00103 CPL_C_START
    00104
    00105 char CPL_DLL **CSLAddString(char **papszStrList, const char *pszNewString);
    00106 int CPL_DLL CSLCount(char **papszStrList);
    00107 const char CPL_DLL *CSLGetField( char **, int );
    00108 void CPL_DLL CPL_STDCALL CSLDestroy(char **papszStrList);
    00109 char CPL_DLL **CSLDuplicate(char **papszStrList);
    00110 char CPL_DLL **CSLMerge( char **papszOrig, char **papszOverride );
    00111
    00112 char CPL_DLL **CSLTokenizeString(const char *pszString );
    00113 char CPL_DLL **CSLTokenizeStringComplex(const char *pszString,
    00114                                    const char *pszDelimiter,
    00115                                    int bHonourStrings, int bAllowEmptyTokens );
    00116 char CPL_DLL **CSLTokenizeString2( const char *pszString,
    00117                                    const char *pszDelimeter,
    00118                                    int nCSLTFlags );
    00119
    00120 #define CSLT_HONOURSTRINGS      0x0001
    00121 #define CSLT_ALLOWEMPTYTOKENS   0x0002
    00122 #define CSLT_PRESERVEQUOTES     0x0004
    00123 #define CSLT_PRESERVEESCAPES    0x0008
    00124
    00125 int CPL_DLL CSLPrint(char **papszStrList, FILE *fpOut);
    00126 char CPL_DLL **CSLLoad(const char *pszFname);
    00127 int CPL_DLL CSLSave(char **papszStrList, const char *pszFname);
    00128
    00129 char CPL_DLL **CSLInsertStrings(char **papszStrList, int nInsertAtLineNo,
    00130                          char **papszNewLines);
    00131 char CPL_DLL **CSLInsertString(char **papszStrList, int nInsertAtLineNo,
    00132                                const char *pszNewLine);
    00133 char CPL_DLL **CSLRemoveStrings(char **papszStrList, int nFirstLineToDelete,
    00134                          int nNumToRemove, char ***ppapszRetStrings);
    00135 int CPL_DLL CSLFindString( char **, const char * );
    00136 int CPL_DLL CSLTestBoolean( const char *pszValue );
    00137 int CPL_DLL CSLFetchBoolean( char **papszStrList, const char *pszKey,
    00138                              int bDefault );
    00139
    00140 const char CPL_DLL *CPLSPrintf(const char *fmt, ...);
    00141 char CPL_DLL **CSLAppendPrintf(char **papszStrList, char *fmt, ...);
    00142
    00143 const char CPL_DLL *
    00144       CPLParseNameValue(const char *pszNameValue, char **ppszKey );
    00145 const char CPL_DLL *
    00146       CSLFetchNameValue(char **papszStrList, const char *pszName);
    00147 char CPL_DLL **
    00148       CSLFetchNameValueMultiple(char **papszStrList, const char *pszName);
    00149 char CPL_DLL **
    00150       CSLAddNameValue(char **papszStrList,
    00151                       const char *pszName, const char *pszValue);
    00152 char CPL_DLL **
    00153       CSLSetNameValue(char **papszStrList,
    00154                       const char *pszName, const char *pszValue);
    00155 void CPL_DLL CSLSetNameValueSeparator( char ** papszStrList,
    00156                                        const char *pszSeparator );
    00157
    00158 #define CPLES_BackslashQuotable 0
    00159 #define CPLES_XML               1
    00160 #define CPLES_URL               2   /* unescape only for now */
    00161 #define CPLES_SQL               3
    00162 #define CPLES_CSV               4
    00163
    00164 char CPL_DLL *CPLEscapeString( const char *pszString, int nLength,
    00165                                int nScheme );
    00166 char CPL_DLL *CPLUnescapeString( const char *pszString, int *pnLength,
    00167                                  int nScheme );
    00168
    00169 char CPL_DLL *CPLBinaryToHex( int nBytes, const GByte *pabyData );
    00170 GByte CPL_DLL *CPLHexToBinary( const char *pszHex, int *pnBytes );
    00171
    00172 CPL_C_END
    00173
    00174 /************************************************************************/
    00175 /*                              CPLString                               */
    00176 /************************************************************************/
    00177
    00178 #ifdef __cplusplus
    00179
    00180 #include <string>
    00181
    00182 /*
    00183  * Simple trick to avoid "using" declaration in header for new compilers
    00184  * but make it still working with old compilers which throw C2614 errors.
    00185  *
    00186  * Define MSVC_OLD_STUPID_BEHAVIOUR
    00187  * for old compilers: VC++ 5 and 6 as well as eVC++ 3 and 4.
    00188  */
    00189
    00190 /*
    00191  * Detect old MSVC++ compiler <= 6.0
    00192  * 1200 - VC++ 6.0
    00193  * 1200-1202 - eVC++ 4.0
    00194  */
    00195 #if (_MSC_VER <= 1202)
    00196 #  define MSVC_OLD_STUPID_BEHAVIOUR
    00197 #endif
    00198
    00199
    00200 /* Avoid C2614 errors */
    00201 #ifdef MSVC_OLD_STUPID_BEHAVIOUR
    00202     using std::string;
    00203 # define std_string string
    00204 #else
    00205 # define std_string std::string
    00206 #endif
    00207
    00208 /* Remove annoying warnings in Microsoft eVC++ and Microsoft Visual C++ */
    00209 #if defined(WIN32CE)
    00210 #  pragma warning(disable:4251 4275 4786)
    00211 #endif
    00212
    00213
    00214
    00215
    00216 class CPL_DLL CPLString : public std_string
    00217 {
    00218 public:
    00219     CPLString(void) {}
    00220     CPLString( const std::string &oStr ) : std_string( oStr ) {}
    00221     CPLString( const char *pszStr ) : std_string( pszStr ) {}
    00222
    00223     operator const char* (void) const { return c_str(); }
    00224
    00225     CPLString &Printf( const char *pszFormat, ... );
    00226     CPLString &vPrintf( const char *pszFormat, va_list args );
    00227 };
    00228
    00229 #endif /* def __cplusplus */
    00230
    00231 #endif /* _CPL_STRING_H_INCLUDED */

Generated for GDAL by 1.5.1.