cpl_conv.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  * $Id: cpl_conv.h,v 1.39 2005/09/11 21:08:21 fwarmerdam 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.39  2005/09/11 21:08:21  fwarmerdam
00033  * added CPLReadLineL
00034  *
00035  * Revision 1.38  2005/08/25 18:06:48  fwarmerdam
00036  * void in empty arg lists.
00037  *
00038  * Revision 1.37  2005/06/10 15:00:00  fwarmerdam
00039  * added cpl_getexecpath.cpp
00040  *
00041  * Revision 1.36  2005/04/04 15:23:31  fwarmerdam
00042  * some functions now CPL_STDCALL
00043  *
00044  * Revision 1.35  2004/11/17 22:57:21  fwarmerdam
00045  * added CPLScanPointer() and CPLPrintPointer()
00046  *
00047  * Revision 1.34  2004/08/16 20:24:07  warmerda
00048  * added CPLUnlinkTree
00049  *
00050  * Revision 1.33  2004/08/11 18:41:46  warmerda
00051  * added CPLExtractRelativePath
00052  *
00053  * Revision 1.32  2004/07/31 04:51:36  warmerda
00054  * added shared file open support
00055  *
00056  * Revision 1.31  2004/03/28 16:22:02  warmerda
00057  * const correctness changes in scan functions
00058  *
00059  * Revision 1.30  2004/03/24 09:01:17  dron
00060  * Added CPLPrintUIntBig().
00061  *
00062  * Revision 1.29  2004/02/07 14:03:30  dron
00063  * CPLDecToPackedDMS() added.
00064  *
00065  * Revision 1.28  2004/02/01 08:37:55  dron
00066  * Added CPLPackedDMSToDec().
00067  *
00068  * Revision 1.27  2003/12/28 17:24:43  warmerda
00069  * added CPLFreeConfig
00070  *
00071  * Revision 1.26  2003/10/17 07:06:06  dron
00072  * Added locale selection option to CPLScanDouble() and CPLPrintDOuble().
00073  *
00074  * Revision 1.25  2003/09/28 14:14:16  dron
00075  * Added CPLScanString().
00076  *
00077  * Revision 1.24  2003/09/08 11:09:53  dron
00078  * Added CPLPrintDouble() and CPLPrintTime().
00079  *
00080  * Revision 1.23  2003/09/07 14:38:43  dron
00081  * Added CPLPrintString(), CPLPrintStringFill(), CPLPrintInt32(), CPLPrintUIntBig().
00082  *
00083  * Revision 1.22  2003/08/31 14:48:05  dron
00084  * Added CPLScanLong() and CPLScanDouble().
00085  *
00086  * Revision 1.21  2003/08/25 20:01:58  dron
00087  * Added CPLFGets() helper function.
00088  *
00089  * Revision 1.20  2003/05/08 21:51:14  warmerda
00090  * added CPL{G,S}etConfigOption() usage
00091  *
00092  * Revision 1.19  2003/03/02 04:44:38  warmerda
00093  * added CPLStringToComplex
00094  *
00095  * Revision 1.18  2002/12/13 06:00:54  warmerda
00096  * added CPLProjectRelativeFilename() and CPLIsFilenameRelative()
00097  *
00098  * Revision 1.17  2002/12/09 18:52:51  warmerda
00099  * added DMS conversion
00100  *
00101  * Revision 1.16  2002/12/03 04:42:02  warmerda
00102  * improved finder cleanup support
00103  *
00104  * Revision 1.15  2002/08/15 09:23:24  dron
00105  * Added CPLGetDirname() function
00106  *
00107  * Revision 1.14  2002/02/01 20:39:50  warmerda
00108  * ensure CPLReadLine() is exported from DLL
00109  *
00110  * Revision 1.13  2001/12/12 17:06:57  warmerda
00111  * added CPLStat
00112  *
00113  * Revision 1.12  2001/03/16 22:15:08  warmerda
00114  * added CPLResetExtension
00115  *
00116  * Revision 1.1  1998/10/18 06:15:11  warmerda
00117  * Initial implementation.
00118  *
00119  */
00120 
00121 #ifndef CPL_CONV_H_INCLUDED
00122 #define CPL_CONV_H_INCLUDED
00123 
00124 #include "cpl_port.h"
00125 #include "cpl_vsi.h"
00126 #include "cpl_error.h"
00127 
00135 /* -------------------------------------------------------------------- */
00136 /*      Runtime check of various configuration items.                   */
00137 /* -------------------------------------------------------------------- */
00138 CPL_C_START
00139 
00140 void CPL_DLL CPLVerifyConfiguration(void);
00141 
00142 const char CPL_DLL * CPL_STDCALL
00143 CPLGetConfigOption( const char *, const char * );
00144 void CPL_DLL CPL_STDCALL CPLSetConfigOption( const char *, const char * );
00145 void CPL_DLL CPL_STDCALL CPLFreeConfig(void);
00146 
00147 /* -------------------------------------------------------------------- */
00148 /*      Safe malloc() API.  Thin cover over VSI functions with fatal    */
00149 /*      error reporting if memory allocation fails.                     */
00150 /* -------------------------------------------------------------------- */
00151 void CPL_DLL *CPLMalloc( size_t );
00152 void CPL_DLL *CPLCalloc( size_t, size_t );
00153 void CPL_DLL *CPLRealloc( void *, size_t );
00154 char CPL_DLL *CPLStrdup( const char * );
00155 
00156 #define CPLFree VSIFree
00157 
00158 /* -------------------------------------------------------------------- */
00159 /*      Read a line from a text file, and strip of CR/LF.               */
00160 /* -------------------------------------------------------------------- */
00161 char CPL_DLL *CPLFGets( char *, int, FILE *);
00162 const char CPL_DLL *CPLReadLine( FILE * );
00163 const char CPL_DLL *CPLReadLineL( FILE * );
00164 
00165 /* -------------------------------------------------------------------- */
00166 /*      Read a numeric value from an ASCII character string.            */
00167 /* -------------------------------------------------------------------- */
00168 char CPL_DLL *CPLScanString( const char *, int, int, int );
00169 double CPL_DLL CPLScanDouble( const char *, int, char * );
00170 long CPL_DLL CPLScanLong( const char *, int );
00171 GUIntBig CPL_DLL CPLScanUIntBig( const char *, int );
00172 void CPL_DLL *CPLScanPointer( const char *, int );
00173 
00174 /* -------------------------------------------------------------------- */
00175 /*      Print a value to an ASCII character string.                     */
00176 /* -------------------------------------------------------------------- */
00177 int CPL_DLL CPLPrintString( char *, const char *, int );
00178 int CPL_DLL CPLPrintStringFill( char *, const char *, int );
00179 int CPL_DLL CPLPrintInt32( char *, GInt32 , int );
00180 int CPL_DLL CPLPrintUIntBig( char *, GUIntBig , int );
00181 int CPL_DLL CPLPrintDouble( char *, const char *, double, char * );
00182 int CPL_DLL CPLPrintTime( char *, int , const char *, const struct tm *,
00183                           char * );
00184 int CPL_DLL CPLPrintPointer( char *, void *, int );
00185 
00186 /* -------------------------------------------------------------------- */
00187 /*      Fetch a function from DLL / so.                                 */
00188 /* -------------------------------------------------------------------- */
00189 
00190 void CPL_DLL *CPLGetSymbol( const char *, const char * );
00191 
00192 /* -------------------------------------------------------------------- */
00193 /*      Read a directory  (cpl_dir.c)                                   */
00194 /* -------------------------------------------------------------------- */
00195 char CPL_DLL  **CPLReadDir( const char *pszPath );
00196 
00197 /* -------------------------------------------------------------------- */
00198 /*      Fetch executable path.                                          */
00199 /* -------------------------------------------------------------------- */
00200 int CPL_DLL CPLGetExecPath( char *pszPathBuf, int nMaxLength );
00201 
00202 /* -------------------------------------------------------------------- */
00203 /*      Filename handling functions.                                    */
00204 /* -------------------------------------------------------------------- */
00205 const char CPL_DLL *CPLGetPath( const char * );
00206 const char CPL_DLL *CPLGetDirname( const char * );
00207 const char CPL_DLL *CPLGetFilename( const char * );
00208 const char CPL_DLL *CPLGetBasename( const char * );
00209 const char CPL_DLL *CPLGetExtension( const char * );
00210 const char CPL_DLL *CPLFormFilename( const char *pszPath,
00211                                      const char *pszBasename,
00212                                      const char *pszExtension );
00213 const char CPL_DLL *CPLFormCIFilename( const char *pszPath,
00214                                        const char *pszBasename,
00215                                        const char *pszExtension );
00216 const char CPL_DLL *CPLResetExtension( const char *, const char * );
00217 const char CPL_DLL *CPLProjectRelativeFilename( const char *pszProjectDir, 
00218                                             const char *pszSecondaryFilename );
00219 int CPL_DLL CPLIsFilenameRelative( const char *pszFilename );
00220 const char CPL_DLL *CPLExtractRelativePath(const char *, const char *, int *);
00221 
00222 /* -------------------------------------------------------------------- */
00223 /*      Find File Function                                              */
00224 /* -------------------------------------------------------------------- */
00225 typedef const char *(*CPLFileFinder)(const char *, const char *);
00226 
00227 const char    CPL_DLL *CPLFindFile(const char *pszClass, 
00228                                    const char *pszBasename);
00229 const char    CPL_DLL *CPLDefaultFindFile(const char *pszClass, 
00230                                           const char *pszBasename);
00231 void          CPL_DLL CPLPushFileFinder( CPLFileFinder pfnFinder );
00232 CPLFileFinder CPL_DLL CPLPopFileFinder(void);
00233 void          CPL_DLL CPLPushFinderLocation( const char * );
00234 void          CPL_DLL CPLPopFinderLocation(void);
00235 void          CPL_DLL CPLFinderClean(void);
00236 
00237 /* -------------------------------------------------------------------- */
00238 /*      Safe version of stat() that works properly on stuff like "C:".  */
00239 /* -------------------------------------------------------------------- */
00240 int CPL_DLL     CPLStat( const char *, VSIStatBuf * );
00241 
00242 /* -------------------------------------------------------------------- */
00243 /*      Reference counted file handle manager.  Makes sharing file      */
00244 /*      handles more practical.                                         */
00245 /* -------------------------------------------------------------------- */
00246 typedef struct {
00247     FILE *fp;
00248     int   nRefCount;
00249     int   bLarge;
00250     char  *pszFilename;
00251     char  *pszAccess;
00252 } CPLSharedFileInfo;
00253 
00254 FILE CPL_DLL    *CPLOpenShared( const char *, const char *, int );
00255 void CPL_DLL     CPLCloseShared( FILE * );
00256 CPLSharedFileInfo CPL_DLL *CPLGetSharedList( int * );
00257 void CPL_DLL     CPLDumpSharedList( FILE * );
00258 
00259 /* -------------------------------------------------------------------- */
00260 /*      DMS to Dec to DMS conversion.                                   */
00261 /* -------------------------------------------------------------------- */
00262 double CPL_DLL CPLDMSToDec( const char *is );
00263 const char CPL_DLL *CPLDecToDMS( double dfAngle, const char * pszAxis,
00264                                  int nPrecision );
00265 double CPL_DLL CPLPackedDMSToDec( double );
00266 double CPL_DLL CPLDecToPackedDMS( double dfDec );
00267 
00268 void CPL_DLL CPLStringToComplex( const char *pszString, 
00269                                  double *pdfReal, double *pdfImag );
00270 
00271 /* -------------------------------------------------------------------- */
00272 /*      Misc other functions.                                           */
00273 /* -------------------------------------------------------------------- */
00274 int CPL_DLL CPLUnlinkTree( const char * );
00275 CPL_C_END
00276 
00277 #endif /* ndef CPL_CONV_H_INCLUDED */

Generated on Sun Jul 2 22:18:21 2006 for OGR by  doxygen 1.4.6