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

cpl_vsi.h

Go to the documentation of this file.
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.18 2003/09/10 19:44:36 warmerda 00036 * added VSIStrerrno() 00037 * 00038 * Revision 1.17 2003/09/08 08:11:40 dron 00039 * Added VSIGMTime() and VSILocalTime(). 00040 * 00041 * Revision 1.16 2003/05/27 20:44:40 warmerda 00042 * added VSI io debugging macros 00043 * 00044 * Revision 1.15 2002/06/17 14:10:14 warmerda 00045 * no stat64 on Win32 00046 * 00047 * Revision 1.14 2002/06/17 14:00:16 warmerda 00048 * segregate VSIStatL() and VSIStatBufL. 00049 * 00050 * Revision 1.13 2002/06/15 02:13:13 aubin 00051 * remove debug test for 64bit compile 00052 * 00053 * Revision 1.12 2002/06/15 00:07:23 aubin 00054 * mods to enable 64bit file i/o 00055 * 00056 * Revision 1.11 2001/04/30 18:19:06 warmerda 00057 * avoid stat on macos_pre10 00058 * 00059 * Revision 1.10 2001/01/19 21:16:41 warmerda 00060 * expanded tabs 00061 * 00062 * Revision 1.9 2001/01/03 17:41:44 warmerda 00063 * added #define for VSIFFlushL 00064 * 00065 * Revision 1.8 2001/01/03 16:17:50 warmerda 00066 * added large file API 00067 * 00068 * Revision 1.7 2000/12/14 18:29:48 warmerda 00069 * added VSIMkdir 00070 * 00071 * Revision 1.6 2000/01/25 03:11:03 warmerda 00072 * added unlink and mkdir 00073 * 00074 * Revision 1.5 1999/05/23 02:43:57 warmerda 00075 * Added documentation block. 00076 * 00077 * Revision 1.4 1999/02/25 04:48:11 danmo 00078 * Added VSIStat() macros specific to _WIN32 (for MSVC++) 00079 * 00080 * Revision 1.3 1999/01/28 18:31:25 warmerda 00081 * Test on _WIN32 rather than WIN32. It seems to be more reliably defined. 00082 * 00083 * Revision 1.2 1998/12/04 21:42:57 danmo 00084 * Added #ifndef WIN32 arounf #include <unistd.h> 00085 * 00086 * Revision 1.1 1998/12/03 18:26:02 warmerda 00087 * New 00088 * 00089 */ 00090 00091 #ifndef CPL_VSI_H_INCLUDED 00092 #define CPL_VSI_H_INCLUDED 00093 00094 #include "cpl_port.h" 00114 /* -------------------------------------------------------------------- */ 00115 /* We need access to ``struct stat''. */ 00116 /* -------------------------------------------------------------------- */ 00117 #ifndef _WIN32 00118 # include <unistd.h> 00119 #endif 00120 #if !defined(macos_pre10) 00121 # include <sys/stat.h> 00122 #endif 00123 00124 CPL_C_START 00125 00126 /* ==================================================================== */ 00127 /* stdio file access functions. */ 00128 /* ==================================================================== */ 00129 00130 FILE CPL_DLL * VSIFOpen( const char *, const char * ); 00131 int CPL_DLL VSIFClose( FILE * ); 00132 int CPL_DLL VSIFSeek( FILE *, long, int ); 00133 long CPL_DLL VSIFTell( FILE * ); 00134 void CPL_DLL VSIRewind( FILE * ); 00135 void CPL_DLL VSIFFlush( FILE * ); 00136 00137 size_t CPL_DLL VSIFRead( void *, size_t, size_t, FILE * ); 00138 size_t CPL_DLL VSIFWrite( void *, size_t, size_t, FILE * ); 00139 char CPL_DLL *VSIFGets( char *, int, FILE * ); 00140 int CPL_DLL VSIFPuts( const char *, FILE * ); 00141 int CPL_DLL VSIFPrintf( FILE *, const char *, ... ); 00142 00143 int CPL_DLL VSIFGetc( FILE * ); 00144 int CPL_DLL VSIFPutc( int, FILE * ); 00145 int CPL_DLL VSIUngetc( int, FILE * ); 00146 int CPL_DLL VSIFEof( FILE * ); 00147 00148 /* ==================================================================== */ 00149 /* VSIStat() related. */ 00150 /* ==================================================================== */ 00151 00152 typedef struct stat VSIStatBuf; 00153 int CPL_DLL VSIStat( const char *, VSIStatBuf * ); 00154 00155 #ifdef _WIN32 00156 # define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */ 00157 # define VSI_ISREG(x) ((x) & S_IFREG) 00158 # define VSI_ISDIR(x) ((x) & S_IFDIR) 00159 # define VSI_ISCHR(x) ((x) & S_IFCHR) 00160 # define VSI_ISBLK(x) ( 0 ) /* N/A on Windows */ 00161 #else 00162 # define VSI_ISLNK(x) S_ISLNK(x) 00163 # define VSI_ISREG(x) S_ISREG(x) 00164 # define VSI_ISDIR(x) S_ISDIR(x) 00165 # define VSI_ISCHR(x) S_ISCHR(x) 00166 # define VSI_ISBLK(x) S_ISBLK(x) 00167 #endif 00168 00169 /* ==================================================================== */ 00170 /* 64bit stdio file access functions. If we have a big size */ 00171 /* defined, then provide protypes for the large file API, */ 00172 /* otherwise redefine to use the regular api. */ 00173 /* ==================================================================== */ 00174 #ifdef VSI_LARGE_API_SUPPORTED 00175 00176 typedef GUIntBig vsi_l_offset; 00177 00178 FILE CPL_DLL * VSIFOpenL( const char *, const char * ); 00179 int CPL_DLL VSIFCloseL( FILE * ); 00180 int CPL_DLL VSIFSeekL( FILE *, vsi_l_offset, int ); 00181 vsi_l_offset CPL_DLL VSIFTellL( FILE * ); 00182 void CPL_DLL VSIRewindL( FILE * ); 00183 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, FILE * ); 00184 size_t CPL_DLL VSIFWriteL( void *, size_t, size_t, FILE * ); 00185 int CPL_DLL VSIFEofL( FILE * ); 00186 void CPL_DLL VSIFFlushL( FILE * ); 00187 00188 #ifndef WIN32 00189 typedef struct stat64 VSIStatBufL; 00190 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ); 00191 #else 00192 #define VSIStatBufL VSIStatBuf 00193 #define VSIStatL VSIStat 00194 #endif 00195 00196 #else 00197 00198 typedef long vsi_l_offset; 00199 00200 #define vsi_l_offset long 00201 00202 #define VSIFOpenL VSIFOpen 00203 #define VSIFCloseL VSIFClose 00204 #define VSIFSeekL VSIFSeek 00205 #define VSIFTellL VSIFTell 00206 #define VSIFRewindL VSIFRewind 00207 #define VSIFReadL VSIFRead 00208 #define VSIFWriteL VSIFWrite 00209 #define VSIFEofL VSIFEof 00210 #define VSIFFlushL VSIFFlush 00211 #define VSIStatBufL VSIStatBuf 00212 #define VSIStatL VSIStat 00213 00214 #endif 00215 00216 /* ==================================================================== */ 00217 /* Memory allocation */ 00218 /* ==================================================================== */ 00219 00220 void CPL_DLL *VSICalloc( size_t, size_t ); 00221 void CPL_DLL *VSIMalloc( size_t ); 00222 void CPL_DLL VSIFree( void * ); 00223 void CPL_DLL *VSIRealloc( void *, size_t ); 00224 char CPL_DLL *VSIStrdup( const char * ); 00225 00226 /* ==================================================================== */ 00227 /* Other... */ 00228 /* ==================================================================== */ 00229 00230 int CPL_DLL VSIMkdir( const char * pathname, long mode ); 00231 int CPL_DLL VSIRmdir( const char * pathname ); 00232 int CPL_DLL VSIUnlink( const char * pathname ); 00233 char CPL_DLL *VSIStrerror( int ); 00234 00235 /* ==================================================================== */ 00236 /* Time quering. */ 00237 /* ==================================================================== */ 00238 00239 unsigned long CPL_DLL VSITime( unsigned long * ); 00240 const char CPL_DLL *VSICTime( unsigned long ); 00241 struct tm CPL_DLL *VSIGMTime( const time_t *pnTime, 00242 struct tm *poBrokenTime ); 00243 struct tm CPL_DLL *VSILocalTime( const time_t *pnTime, 00244 struct tm *poBrokenTime ); 00245 00246 /* -------------------------------------------------------------------- */ 00247 /* the following can be turned on for detailed logging of */ 00248 /* almost all IO calls. */ 00249 /* -------------------------------------------------------------------- */ 00250 #ifdef VSI_DEBUG 00251 00252 #ifndef DEBUG 00253 # define DEBUG 00254 #endif 00255 00256 #include "cpl_error.h" 00257 00258 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 ); 00259 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 ); 00260 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 ); 00261 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 ); 00262 #else 00263 #define VSIDebug4( f, a1, a2, a3, a4 ) {} 00264 #define VSIDebug3( f, a1, a2, a3 ) {} 00265 #define VSIDebug2( f, a1, a2 ) {} 00266 #define VSIDebug1( f, a1 ) {} 00267 #endif 00268 00269 CPL_C_END 00270 00271 #endif /* ndef CPL_VSI_H_INCLUDED */

Generated on Thu Jul 29 19:47:52 2004 for GDAL by doxygen 1.3.7