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-source.html,v $ 00034 * Revision 1.13 2002/12/21 19:13:12 warmerda 00034 * updated 00034 * 00035 * Revision 1.15 2002/06/17 14:10:14 warmerda 00036 * no stat64 on Win32 00037 * 00038 * Revision 1.14 2002/06/17 14:00:16 warmerda 00039 * segregate VSIStatL() and VSIStatBufL. 00040 * 00041 * Revision 1.13 2002/06/15 02:13:13 aubin 00042 * remove debug test for 64bit compile 00043 * 00044 * Revision 1.12 2002/06/15 00:07:23 aubin 00045 * mods to enable 64bit file i/o 00046 * 00047 * Revision 1.11 2001/04/30 18:19:06 warmerda 00048 * avoid stat on macos_pre10 00049 * 00050 * Revision 1.10 2001/01/19 21:16:41 warmerda 00051 * expanded tabs 00052 * 00053 * Revision 1.9 2001/01/03 17:41:44 warmerda 00054 * added #define for VSIFFlushL 00055 * 00056 * Revision 1.8 2001/01/03 16:17:50 warmerda 00057 * added large file API 00058 * 00059 * Revision 1.7 2000/12/14 18:29:48 warmerda 00060 * added VSIMkdir 00061 * 00062 * Revision 1.6 2000/01/25 03:11:03 warmerda 00063 * added unlink and mkdir 00064 * 00065 * Revision 1.5 1999/05/23 02:43:57 warmerda 00066 * Added documentation block. 00067 * 00068 * Revision 1.4 1999/02/25 04:48:11 danmo 00069 * Added VSIStat() macros specific to _WIN32 (for MSVC++) 00070 * 00071 * Revision 1.3 1999/01/28 18:31:25 warmerda 00072 * Test on _WIN32 rather than WIN32. It seems to be more reliably defined. 00073 * 00074 * Revision 1.2 1998/12/04 21:42:57 danmo 00075 * Added #ifndef WIN32 arounf #include <unistd.h> 00076 * 00077 * Revision 1.1 1998/12/03 18:26:02 warmerda 00078 * New 00079 * 00080 */ 00081 00082 #ifndef CPL_VSI_H_INCLUDED 00083 #define CPL_VSI_H_INCLUDED 00084 00085 #include "cpl_port.h" 00105 /* -------------------------------------------------------------------- */ 00106 /* We need access to ``struct stat''. */ 00107 /* -------------------------------------------------------------------- */ 00108 #ifndef _WIN32 00109 # include <unistd.h> 00110 #endif 00111 #if !defined(macos_pre10) 00112 # include <sys/stat.h> 00113 #endif 00114 00115 CPL_C_START 00116 00117 /* ==================================================================== */ 00118 /* stdio file access functions. */ 00119 /* ==================================================================== */ 00120 00121 FILE CPL_DLL * VSIFOpen( const char *, const char * ); 00122 int CPL_DLL VSIFClose( FILE * ); 00123 int CPL_DLL VSIFSeek( FILE *, long, int ); 00124 long CPL_DLL VSIFTell( FILE * ); 00125 void CPL_DLL VSIRewind( FILE * ); 00126 void CPL_DLL VSIFFlush( FILE * ); 00127 00128 size_t CPL_DLL VSIFRead( void *, size_t, size_t, FILE * ); 00129 size_t CPL_DLL VSIFWrite( void *, size_t, size_t, FILE * ); 00130 char CPL_DLL *VSIFGets( char *, int, FILE * ); 00131 int CPL_DLL VSIFPuts( const char *, FILE * ); 00132 int CPL_DLL VSIFPrintf( FILE *, const char *, ... ); 00133 00134 int CPL_DLL VSIFGetc( FILE * ); 00135 int CPL_DLL VSIFPutc( int, FILE * ); 00136 int CPL_DLL VSIUngetc( int, FILE * ); 00137 int CPL_DLL VSIFEof( FILE * ); 00138 00139 /* ==================================================================== */ 00140 /* VSIStat() related. */ 00141 /* ==================================================================== */ 00142 00143 typedef struct stat VSIStatBuf; 00144 int CPL_DLL VSIStat( const char *, VSIStatBuf * ); 00145 00146 #ifdef _WIN32 00147 # define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */ 00148 # define VSI_ISREG(x) ((x) & S_IFREG) 00149 # define VSI_ISDIR(x) ((x) & S_IFDIR) 00150 # define VSI_ISCHR(x) ((x) & S_IFCHR) 00151 # define VSI_ISBLK(x) ( 0 ) /* N/A on Windows */ 00152 #else 00153 # define VSI_ISLNK(x) S_ISLNK(x) 00154 # define VSI_ISREG(x) S_ISREG(x) 00155 # define VSI_ISDIR(x) S_ISDIR(x) 00156 # define VSI_ISCHR(x) S_ISCHR(x) 00157 # define VSI_ISBLK(x) S_ISBLK(x) 00158 #endif 00159 00160 /* ==================================================================== */ 00161 /* 64bit stdio file access functions. If we have a big size */ 00162 /* defined, then provide protypes for the large file API, */ 00163 /* otherwise redefine to use the regular api. */ 00164 /* ==================================================================== */ 00165 #ifdef VSI_LARGE_API_SUPPORTED 00166 00167 typedef GUIntBig vsi_l_offset; 00168 00169 FILE CPL_DLL * VSIFOpenL( const char *, const char * ); 00170 int CPL_DLL VSIFCloseL( FILE * ); 00171 int CPL_DLL VSIFSeekL( FILE *, vsi_l_offset, int ); 00172 vsi_l_offset CPL_DLL VSIFTellL( FILE * ); 00173 void CPL_DLL VSIRewindL( FILE * ); 00174 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, FILE * ); 00175 size_t CPL_DLL VSIFWriteL( void *, size_t, size_t, FILE * ); 00176 int CPL_DLL VSIFEofL( FILE * ); 00177 void CPL_DLL VSIFFlushL( FILE * ); 00178 00179 #ifndef WIN32 00180 typedef struct stat64 VSIStatBufL; 00181 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ); 00182 #else 00183 #define VSIStatBufL VSIStatBuf 00184 #define VSIStatL VSIStat 00185 #endif 00186 00187 #else 00188 00189 typedef long vsi_l_offset; 00190 00191 #define vsi_l_offset long 00192 00193 #define VSIFOpenL VSIFOpen 00194 #define VSIFCloseL VSIFClose 00195 #define VSIFSeekL VSIFSeek 00196 #define VSIFTellL VSIFTell 00197 #define VSIFRewindL VSIFRewind 00198 #define VSIFReadL VSIFRead 00199 #define VSIFWriteL VSIFWrite 00200 #define VSIFEofL VSIFEof 00201 #define VSIFFlushL VSIFFlush 00202 #define VSIStatBufL VSIStatBuf 00203 #define VSIStatL VSIStat 00204 00205 #endif 00206 00207 /* ==================================================================== */ 00208 /* Memory allocation */ 00209 /* ==================================================================== */ 00210 00211 void CPL_DLL *VSICalloc( size_t, size_t ); 00212 void CPL_DLL *VSIMalloc( size_t ); 00213 void CPL_DLL VSIFree( void * ); 00214 void CPL_DLL *VSIRealloc( void *, size_t ); 00215 char CPL_DLL *VSIStrdup( const char * ); 00216 00217 /* ==================================================================== */ 00218 /* Other... */ 00219 /* ==================================================================== */ 00220 00221 int CPL_DLL VSIMkdir( const char * pathname, long mode ); 00222 int CPL_DLL VSIRmdir( const char * pathname ); 00223 int CPL_DLL VSIUnlink( const char * pathname ); 00224 00225 CPL_C_END 00226 00227 #endif /* ndef CPL_VSI_H_INCLUDED */