Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

cpl_conv.h

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

Generated on Mon Aug 9 12:09:03 2004 for GDAL by doxygen 1.3.8