00001 /****************************************************************************** 00002 * $Id: cpl_conv_h-source.html,v 1.13 2002/12/21 19:13:12 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-source.html,v $ 00031 * Revision 1.13 2002/12/21 19:13:12 warmerda 00031 * updated 00031 * 00032 * Revision 1.18 2002/12/13 06:00:54 warmerda 00033 * added CPLProjectRelativeFilename() and CPLIsFilenameRelative() 00034 * 00035 * Revision 1.17 2002/12/09 18:52:51 warmerda 00036 * added DMS conversion 00037 * 00038 * Revision 1.16 2002/12/03 04:42:02 warmerda 00039 * improved finder cleanup support 00040 * 00041 * Revision 1.15 2002/08/15 09:23:24 dron 00042 * Added CPLGetDirname() function 00043 * 00044 * Revision 1.14 2002/02/01 20:39:50 warmerda 00045 * ensure CPLReadLine() is exported from DLL 00046 * 00047 * Revision 1.13 2001/12/12 17:06:57 warmerda 00048 * added CPLStat 00049 * 00050 * Revision 1.12 2001/03/16 22:15:08 warmerda 00051 * added CPLResetExtension 00052 * 00053 * Revision 1.1 1998/10/18 06:15:11 warmerda 00054 * Initial implementation. 00055 * 00056 */ 00057 00058 #ifndef CPL_CONV_H_INCLUDED 00059 #define CPL_CONV_H_INCLUDED 00060 00061 #include "cpl_port.h" 00062 #include "cpl_vsi.h" 00063 #include "cpl_error.h" 00064 00072 /* -------------------------------------------------------------------- */ 00073 /* Runtime check of various configuration items. */ 00074 /* -------------------------------------------------------------------- */ 00075 CPL_C_START 00076 00077 void CPL_DLL CPLVerifyConfiguration(); 00078 00079 /* -------------------------------------------------------------------- */ 00080 /* Safe malloc() API. Thin cover over VSI functions with fatal */ 00081 /* error reporting if memory allocation fails. */ 00082 /* -------------------------------------------------------------------- */ 00083 void CPL_DLL *CPLMalloc( size_t ); 00084 void CPL_DLL *CPLCalloc( size_t, size_t ); 00085 void CPL_DLL *CPLRealloc( void *, size_t ); 00086 char CPL_DLL *CPLStrdup( const char * ); 00087 00088 #define CPLFree VSIFree 00089 00090 /* -------------------------------------------------------------------- */ 00091 /* Read a line from a text file, and strip of CR/LF. */ 00092 /* -------------------------------------------------------------------- */ 00093 const char CPL_DLL *CPLReadLine( FILE * ); 00094 00095 /* -------------------------------------------------------------------- */ 00096 /* Fetch a function from DLL / so. */ 00097 /* -------------------------------------------------------------------- */ 00098 00099 void CPL_DLL *CPLGetSymbol( const char *, const char * ); 00100 00101 /* -------------------------------------------------------------------- */ 00102 /* Read a directory (cpl_dir.c) */ 00103 /* -------------------------------------------------------------------- */ 00104 char CPL_DLL **CPLReadDir( const char *pszPath ); 00105 00106 /* -------------------------------------------------------------------- */ 00107 /* Filename handling functions. */ 00108 /* -------------------------------------------------------------------- */ 00109 const char CPL_DLL *CPLGetPath( const char * ); 00110 const char CPL_DLL *CPLGetDirname( const char * ); 00111 const char CPL_DLL *CPLGetFilename( const char * ); 00112 const char CPL_DLL *CPLGetBasename( const char * ); 00113 const char CPL_DLL *CPLGetExtension( const char * ); 00114 const char CPL_DLL *CPLFormFilename( const char *pszPath, 00115 const char *pszBasename, 00116 const char *pszExtension ); 00117 const char CPL_DLL *CPLFormCIFilename( const char *pszPath, 00118 const char *pszBasename, 00119 const char *pszExtension ); 00120 const char CPL_DLL *CPLResetExtension( const char *, const char * ); 00121 const char CPL_DLL *CPLProjectRelativeFilename( const char *pszProjectDir, 00122 const char *pszSecondaryFilename ); 00123 int CPL_DLL CPLIsFilenameRelative( const char *pszFilename ); 00124 00125 /* -------------------------------------------------------------------- */ 00126 /* Find File Function */ 00127 /* -------------------------------------------------------------------- */ 00128 typedef const char *(*CPLFileFinder)(const char *, const char *); 00129 00130 const char CPL_DLL *CPLFindFile(const char *pszClass, 00131 const char *pszBasename); 00132 const char CPL_DLL *CPLDefaultFindFile(const char *pszClass, 00133 const char *pszBasename); 00134 void CPL_DLL CPLPushFileFinder( CPLFileFinder pfnFinder ); 00135 CPLFileFinder CPL_DLL CPLPopFileFinder(); 00136 void CPL_DLL CPLPushFinderLocation( const char * ); 00137 void CPL_DLL CPLPopFinderLocation(); 00138 void CPL_DLL CPLFinderClean(); 00139 00140 /* -------------------------------------------------------------------- */ 00141 /* Safe version of stat() that works properly on stuff like "C:". */ 00142 /* -------------------------------------------------------------------- */ 00143 int CPL_DLL CPLStat( const char *, VSIStatBuf * ); 00144 00145 /* -------------------------------------------------------------------- */ 00146 /* DMS to Dec to DMS conversion. */ 00147 /* -------------------------------------------------------------------- */ 00148 double CPL_DLL CPLDMSToDec( const char *is ); 00149 const char CPL_DLL *CPLDecToDMS( double dfAngle, const char * pszAxis, 00150 int nPrecision ); 00151 00152 CPL_C_END 00153 00154 #endif /* ndef CPL_CONV_H_INCLUDED */