00001 /****************************************************************************** 00002 * $Id: cpl_conv.h,v 1.26 2003/10/17 07:06:06 dron Exp $ 00003 * 00004 * Project: CPL - Common Portability Library 00005 * Purpose: Convenience functions declarations. 00006 * This is intended to remain light weight. 00007 * Author: Frank Warmerdam, warmerdam@pobox.com 00008 * 00009 ****************************************************************************** 00010 * Copyright (c) 1998, Frank Warmerdam 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 00023 * OR 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_conv.h,v $ 00032 * Revision 1.26 2003/10/17 07:06:06 dron 00033 * Added locale selection option to CPLScanDouble() and CPLPrintDOuble(). 00034 * 00035 * Revision 1.25 2003/09/28 14:14:16 dron 00036 * Added CPLScanString(). 00037 * 00038 * Revision 1.24 2003/09/08 11:09:53 dron 00039 * Added CPLPrintDouble() and CPLPrintTime(). 00040 * 00041 * Revision 1.23 2003/09/07 14:38:43 dron 00042 * Added CPLPrintString(), CPLPrintStringFill(), CPLPrintInt32(), CPLPrintUIntBig(). 00043 * 00044 * Revision 1.22 2003/08/31 14:48:05 dron 00045 * Added CPLScanLong() and CPLScanDouble(). 00046 * 00047 * Revision 1.21 2003/08/25 20:01:58 dron 00048 * Added CPLFGets() helper function. 00049 * 00050 * Revision 1.20 2003/05/08 21:51:14 warmerda 00051 * added CPL{G,S}etConfigOption() usage 00052 * 00053 * Revision 1.19 2003/03/02 04:44:38 warmerda 00054 * added CPLStringToComplex 00055 * 00056 * Revision 1.18 2002/12/13 06:00:54 warmerda 00057 * added CPLProjectRelativeFilename() and CPLIsFilenameRelative() 00058 * 00059 * Revision 1.17 2002/12/09 18:52:51 warmerda 00060 * added DMS conversion 00061 * 00062 * Revision 1.16 2002/12/03 04:42:02 warmerda 00063 * improved finder cleanup support 00064 * 00065 * Revision 1.15 2002/08/15 09:23:24 dron 00066 * Added CPLGetDirname() function 00067 * 00068 * Revision 1.14 2002/02/01 20:39:50 warmerda 00069 * ensure CPLReadLine() is exported from DLL 00070 * 00071 * Revision 1.13 2001/12/12 17:06:57 warmerda 00072 * added CPLStat 00073 * 00074 * Revision 1.12 2001/03/16 22:15:08 warmerda 00075 * added CPLResetExtension 00076 * 00077 * Revision 1.1 1998/10/18 06:15:11 warmerda 00078 * Initial implementation. 00079 * 00080 */ 00081 00082 #ifndef CPL_CONV_H_INCLUDED 00083 #define CPL_CONV_H_INCLUDED 00084 00085 #include "cpl_port.h" 00086 #include "cpl_vsi.h" 00087 #include "cpl_error.h" 00088 00096 /* -------------------------------------------------------------------- */ 00097 /* Runtime check of various configuration items. */ 00098 /* -------------------------------------------------------------------- */ 00099 CPL_C_START 00100 00101 void CPL_DLL CPLVerifyConfiguration(); 00102 00103 const char CPL_DLL *CPLGetConfigOption( const char *, const char * ); 00104 void CPL_DLL CPLSetConfigOption( const char *, const char * ); 00105 00106 /* -------------------------------------------------------------------- */ 00107 /* Safe malloc() API. Thin cover over VSI functions with fatal */ 00108 /* error reporting if memory allocation fails. */ 00109 /* -------------------------------------------------------------------- */ 00110 void CPL_DLL *CPLMalloc( size_t ); 00111 void CPL_DLL *CPLCalloc( size_t, size_t ); 00112 void CPL_DLL *CPLRealloc( void *, size_t ); 00113 char CPL_DLL *CPLStrdup( const char * ); 00114 00115 #define CPLFree VSIFree 00116 00117 /* -------------------------------------------------------------------- */ 00118 /* Read a line from a text file, and strip of CR/LF. */ 00119 /* -------------------------------------------------------------------- */ 00120 char CPL_DLL *CPLFGets( char *, int, FILE *); 00121 const char CPL_DLL *CPLReadLine( FILE * ); 00122 00123 /* -------------------------------------------------------------------- */ 00124 /* Read a numeric value from an ASCII character string. */ 00125 /* -------------------------------------------------------------------- */ 00126 char CPL_DLL *CPLScanString( char *, int, int, int ); 00127 double CPL_DLL CPLScanDouble( char *, int, char * ); 00128 long CPL_DLL CPLScanLong( char *, int ); 00129 00130 /* -------------------------------------------------------------------- */ 00131 /* Print a value to an ASCII character string. */ 00132 /* -------------------------------------------------------------------- */ 00133 char CPL_DLL *CPLPrintString( char *, const char *, int ); 00134 char CPL_DLL *CPLPrintStringFill( char *, const char *, int ); 00135 char CPL_DLL *CPLPrintInt32( char *, GInt32 , int ); 00136 char CPL_DLL *CPLPrintUIntBig( char *, GUIntBig , int ); 00137 char CPL_DLL *CPLPrintDouble( char *, const char *, double, char * ); 00138 char CPL_DLL *CPLPrintTime( char *, int , const char *, 00139 const struct tm *, char * ); 00140 00141 /* -------------------------------------------------------------------- */ 00142 /* Fetch a function from DLL / so. */ 00143 /* -------------------------------------------------------------------- */ 00144 00145 void CPL_DLL *CPLGetSymbol( const char *, const char * ); 00146 00147 /* -------------------------------------------------------------------- */ 00148 /* Read a directory (cpl_dir.c) */ 00149 /* -------------------------------------------------------------------- */ 00150 char CPL_DLL **CPLReadDir( const char *pszPath ); 00151 00152 /* -------------------------------------------------------------------- */ 00153 /* Filename handling functions. */ 00154 /* -------------------------------------------------------------------- */ 00155 const char CPL_DLL *CPLGetPath( const char * ); 00156 const char CPL_DLL *CPLGetDirname( const char * ); 00157 const char CPL_DLL *CPLGetFilename( const char * ); 00158 const char CPL_DLL *CPLGetBasename( const char * ); 00159 const char CPL_DLL *CPLGetExtension( const char * ); 00160 const char CPL_DLL *CPLFormFilename( const char *pszPath, 00161 const char *pszBasename, 00162 const char *pszExtension ); 00163 const char CPL_DLL *CPLFormCIFilename( const char *pszPath, 00164 const char *pszBasename, 00165 const char *pszExtension ); 00166 const char CPL_DLL *CPLResetExtension( const char *, const char * ); 00167 const char CPL_DLL *CPLProjectRelativeFilename( const char *pszProjectDir, 00168 const char *pszSecondaryFilename ); 00169 int CPL_DLL CPLIsFilenameRelative( const char *pszFilename ); 00170 00171 /* -------------------------------------------------------------------- */ 00172 /* Find File Function */ 00173 /* -------------------------------------------------------------------- */ 00174 typedef const char *(*CPLFileFinder)(const char *, const char *); 00175 00176 const char CPL_DLL *CPLFindFile(const char *pszClass, 00177 const char *pszBasename); 00178 const char CPL_DLL *CPLDefaultFindFile(const char *pszClass, 00179 const char *pszBasename); 00180 void CPL_DLL CPLPushFileFinder( CPLFileFinder pfnFinder ); 00181 CPLFileFinder CPL_DLL CPLPopFileFinder(); 00182 void CPL_DLL CPLPushFinderLocation( const char * ); 00183 void CPL_DLL CPLPopFinderLocation(); 00184 void CPL_DLL CPLFinderClean(); 00185 00186 /* -------------------------------------------------------------------- */ 00187 /* Safe version of stat() that works properly on stuff like "C:". */ 00188 /* -------------------------------------------------------------------- */ 00189 int CPL_DLL CPLStat( const char *, VSIStatBuf * ); 00190 00191 /* -------------------------------------------------------------------- */ 00192 /* DMS to Dec to DMS conversion. */ 00193 /* -------------------------------------------------------------------- */ 00194 double CPL_DLL CPLDMSToDec( const char *is ); 00195 const char CPL_DLL *CPLDecToDMS( double dfAngle, const char * pszAxis, 00196 int nPrecision ); 00197 00198 void CPL_DLL CPLStringToComplex( const char *pszString, 00199 double *pdfReal, double *pdfImag ); 00200 00201 CPL_C_END 00202 00203 #endif /* ndef CPL_CONV_H_INCLUDED */