00001 /****************************************************************************** 00002 * Copyright (c) 1998, Frank Warmerdam 00003 * 00004 * Permission is hereby granted, free of charge, to any person obtaining a 00005 * copy of this software and associated documentation files (the "Software"), 00006 * to deal in the Software without restriction, including without limitation 00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 00008 * and/or sell copies of the Software, and to permit persons to whom the 00009 * Software is furnished to do so, subject to the following conditions: 00010 * 00011 * The above copyright notice and this permission notice shall be included 00012 * in all copies or substantial portions of the Software. 00013 * 00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 00017 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 00019 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 00020 * DEALINGS IN THE SOFTWARE. 00021 ****************************************************************************** 00022 * 00023 * cpl_vsi.h 00024 * 00025 * Include file defining the Virtual System Interface (VSI) functions. This 00026 * should normally be included by all translators using VSI functions for 00027 * accessing system services. It is also used by the GDAL core, and can be 00028 * used by higher level applications which adhere to VSI use. 00029 * 00030 * Most VSI functions are direct analogs of Posix C library functions. 00031 * VSI exists to allow ``hooking'' these functions to provide application 00032 * specific checking, io redirection and so on. 00033 * 00034 * $Log: cpl_vsi.h,v $ 00035 * Revision 1.20 2005/04/12 03:51:11 fwarmerdam 00036 * Fixed stat64 problem. 00037 * 00038 * Revision 1.19 2005/04/12 00:27:39 fwarmerdam 00039 * added macos large file support 00040 * 00041 * Revision 1.18 2003/09/10 19:44:36 warmerda 00042 * added VSIStrerrno() 00043 * 00044 * Revision 1.17 2003/09/08 08:11:40 dron 00045 * Added VSIGMTime() and VSILocalTime(). 00046 * 00047 * Revision 1.16 2003/05/27 20:44:40 warmerda 00048 * added VSI io debugging macros 00049 * 00050 * Revision 1.15 2002/06/17 14:10:14 warmerda 00051 * no stat64 on Win32 00052 * 00053 * Revision 1.14 2002/06/17 14:00:16 warmerda 00054 * segregate VSIStatL() and VSIStatBufL. 00055 * 00056 * Revision 1.13 2002/06/15 02:13:13 aubin 00057 * remove debug test for 64bit compile 00058 * 00059 * Revision 1.12 2002/06/15 00:07:23 aubin 00060 * mods to enable 64bit file i/o 00061 * 00062 * Revision 1.11 2001/04/30 18:19:06 warmerda 00063 * avoid stat on macos_pre10 00064 * 00065 * Revision 1.10 2001/01/19 21:16:41 warmerda 00066 * expanded tabs 00067 * 00068 * Revision 1.9 2001/01/03 17:41:44 warmerda 00069 * added #define for VSIFFlushL 00070 * 00071 * Revision 1.8 2001/01/03 16:17:50 warmerda 00072 * added large file API 00073 * 00074 * Revision 1.7 2000/12/14 18:29:48 warmerda 00075 * added VSIMkdir 00076 * 00077 * Revision 1.6 2000/01/25 03:11:03 warmerda 00078 * added unlink and mkdir 00079 * 00080 * Revision 1.5 1999/05/23 02:43:57 warmerda 00081 * Added documentation block. 00082 * 00083 * Revision 1.4 1999/02/25 04:48:11 danmo 00084 * Added VSIStat() macros specific to _WIN32 (for MSVC++) 00085 * 00086 * Revision 1.3 1999/01/28 18:31:25 warmerda 00087 * Test on _WIN32 rather than WIN32. It seems to be more reliably defined. 00088 * 00089 * Revision 1.2 1998/12/04 21:42:57 danmo 00090 * Added #ifndef WIN32 arounf #include <unistd.h> 00091 * 00092 * Revision 1.1 1998/12/03 18:26:02 warmerda 00093 * New 00094 * 00095 */ 00096 00097 #ifndef CPL_VSI_H_INCLUDED 00098 #define CPL_VSI_H_INCLUDED 00099 00100 #include "cpl_port.h" 00120 /* -------------------------------------------------------------------- */ 00121 /* We need access to ``struct stat''. */ 00122 /* -------------------------------------------------------------------- */ 00123 #ifndef _WIN32 00124 # include <unistd.h> 00125 #endif 00126 #if !defined(macos_pre10) 00127 # include <sys/stat.h> 00128 #endif 00129 00130 CPL_C_START 00131 00132 /* ==================================================================== */ 00133 /* stdio file access functions. */ 00134 /* ==================================================================== */ 00135 00136 FILE CPL_DLL * VSIFOpen( const char *, const char * ); 00137 int CPL_DLL VSIFClose( FILE * ); 00138 int CPL_DLL VSIFSeek( FILE *, long, int ); 00139 long CPL_DLL VSIFTell( FILE * ); 00140 void CPL_DLL VSIRewind( FILE * ); 00141 void CPL_DLL VSIFFlush( FILE * ); 00142 00143 size_t CPL_DLL VSIFRead( void *, size_t, size_t, FILE * ); 00144 size_t CPL_DLL VSIFWrite( void *, size_t, size_t, FILE * ); 00145 char CPL_DLL *VSIFGets( char *, int, FILE * ); 00146 int CPL_DLL VSIFPuts( const char *, FILE * ); 00147 int CPL_DLL VSIFPrintf( FILE *, const char *, ... ); 00148 00149 int CPL_DLL VSIFGetc( FILE * ); 00150 int CPL_DLL VSIFPutc( int, FILE * ); 00151 int CPL_DLL VSIUngetc( int, FILE * ); 00152 int CPL_DLL VSIFEof( FILE * ); 00153 00154 /* ==================================================================== */ 00155 /* VSIStat() related. */ 00156 /* ==================================================================== */ 00157 00158 typedef struct stat VSIStatBuf; 00159 int CPL_DLL VSIStat( const char *, VSIStatBuf * ); 00160 00161 #ifdef _WIN32 00162 # define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */ 00163 # define VSI_ISREG(x) ((x) & S_IFREG) 00164 # define VSI_ISDIR(x) ((x) & S_IFDIR) 00165 # define VSI_ISCHR(x) ((x) & S_IFCHR) 00166 # define VSI_ISBLK(x) ( 0 ) /* N/A on Windows */ 00167 #else 00168 # define VSI_ISLNK(x) S_ISLNK(x) 00169 # define VSI_ISREG(x) S_ISREG(x) 00170 # define VSI_ISDIR(x) S_ISDIR(x) 00171 # define VSI_ISCHR(x) S_ISCHR(x) 00172 # define VSI_ISBLK(x) S_ISBLK(x) 00173 #endif 00174 00175 /* ==================================================================== */ 00176 /* 64bit stdio file access functions. If we have a big size */ 00177 /* defined, then provide protypes for the large file API, */ 00178 /* otherwise redefine to use the regular api. */ 00179 /* ==================================================================== */ 00180 #ifdef VSI_LARGE_API_SUPPORTED 00181 00182 typedef GUIntBig vsi_l_offset; 00183 00184 FILE CPL_DLL * VSIFOpenL( const char *, const char * ); 00185 int CPL_DLL VSIFCloseL( FILE * ); 00186 int CPL_DLL VSIFSeekL( FILE *, vsi_l_offset, int ); 00187 vsi_l_offset CPL_DLL VSIFTellL( FILE * ); 00188 void CPL_DLL VSIRewindL( FILE * ); 00189 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, FILE * ); 00190 size_t CPL_DLL VSIFWriteL( void *, size_t, size_t, FILE * ); 00191 int CPL_DLL VSIFEofL( FILE * ); 00192 void CPL_DLL VSIFFlushL( FILE * ); 00193 00194 #ifndef WIN32 00195 typedef struct VSI_STAT64_T VSIStatBufL; 00196 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ); 00197 #else 00198 #define VSIStatBufL VSIStatBuf 00199 #define VSIStatL VSIStat 00200 #endif 00201 00202 #else 00203 00204 typedef long vsi_l_offset; 00205 00206 #define vsi_l_offset long 00207 00208 #define VSIFOpenL VSIFOpen 00209 #define VSIFCloseL VSIFClose 00210 #define VSIFSeekL VSIFSeek 00211 #define VSIFTellL VSIFTell 00212 #define VSIFRewindL VSIFRewind 00213 #define VSIFReadL VSIFRead 00214 #define VSIFWriteL VSIFWrite 00215 #define VSIFEofL VSIFEof 00216 #define VSIFFlushL VSIFFlush 00217 #define VSIStatBufL VSIStatBuf 00218 #define VSIStatL VSIStat 00219 00220 #endif 00221 00222 /* ==================================================================== */ 00223 /* Memory allocation */ 00224 /* ==================================================================== */ 00225 00226 void CPL_DLL *VSICalloc( size_t, size_t ); 00227 void CPL_DLL *VSIMalloc( size_t ); 00228 void CPL_DLL VSIFree( void * ); 00229 void CPL_DLL *VSIRealloc( void *, size_t ); 00230 char CPL_DLL *VSIStrdup( const char * ); 00231 00232 /* ==================================================================== */ 00233 /* Other... */ 00234 /* ==================================================================== */ 00235 00236 int CPL_DLL VSIMkdir( const char * pathname, long mode ); 00237 int CPL_DLL VSIRmdir( const char * pathname ); 00238 int CPL_DLL VSIUnlink( const char * pathname ); 00239 char CPL_DLL *VSIStrerror( int ); 00240 00241 /* ==================================================================== */ 00242 /* Time quering. */ 00243 /* ==================================================================== */ 00244 00245 unsigned long CPL_DLL VSITime( unsigned long * ); 00246 const char CPL_DLL *VSICTime( unsigned long ); 00247 struct tm CPL_DLL *VSIGMTime( const time_t *pnTime, 00248 struct tm *poBrokenTime ); 00249 struct tm CPL_DLL *VSILocalTime( const time_t *pnTime, 00250 struct tm *poBrokenTime ); 00251 00252 /* -------------------------------------------------------------------- */ 00253 /* the following can be turned on for detailed logging of */ 00254 /* almost all IO calls. */ 00255 /* -------------------------------------------------------------------- */ 00256 #ifdef VSI_DEBUG 00257 00258 #ifndef DEBUG 00259 # define DEBUG 00260 #endif 00261 00262 #include "cpl_error.h" 00263 00264 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 ); 00265 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 ); 00266 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 ); 00267 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 ); 00268 #else 00269 #define VSIDebug4( f, a1, a2, a3, a4 ) {} 00270 #define VSIDebug3( f, a1, a2, a3 ) {} 00271 #define VSIDebug2( f, a1, a2 ) {} 00272 #define VSIDebug1( f, a1 ) {} 00273 #endif 00274 00275 CPL_C_END 00276 00277 #endif /* ndef CPL_VSI_H_INCLUDED */