GDAL
|
00001 /****************************************************************************** 00002 * $Id: cpl_vsi.h 18725 2010-02-04 21:02:19Z rouault $ 00003 * 00004 * Project: CPL - Common Portability Library 00005 * Author: Frank Warmerdam, warmerdam@pobox.com 00006 * Purpose: Include file defining Virtual File System (VSI) functions, a 00007 * layer over POSIX file and other system services. 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 #ifndef CPL_VSI_H_INCLUDED 00032 #define CPL_VSI_H_INCLUDED 00033 00034 #include "cpl_port.h" 00054 /* -------------------------------------------------------------------- */ 00055 /* We need access to ``struct stat''. */ 00056 /* -------------------------------------------------------------------- */ 00057 00058 /* Unix */ 00059 #if !defined(_WIN32) && !defined(_WIN32_WCE) 00060 # include <unistd.h> 00061 #endif 00062 00063 /* Windows */ 00064 #if !defined(macos_pre10) && !defined(_WIN32_WCE) 00065 # include <sys/stat.h> 00066 #endif 00067 00068 /* Windows CE */ 00069 #if defined(_WIN32_WCE) 00070 # include <wce_stat.h> 00071 #endif 00072 00073 CPL_C_START 00074 00075 /* ==================================================================== */ 00076 /* stdio file access functions. These may not support large */ 00077 /* files, and don't necessarily go through the virtualization */ 00078 /* API. */ 00079 /* ==================================================================== */ 00080 00081 FILE CPL_DLL * VSIFOpen( const char *, const char * ); 00082 int CPL_DLL VSIFClose( FILE * ); 00083 int CPL_DLL VSIFSeek( FILE *, long, int ); 00084 long CPL_DLL VSIFTell( FILE * ); 00085 void CPL_DLL VSIRewind( FILE * ); 00086 void CPL_DLL VSIFFlush( FILE * ); 00087 00088 size_t CPL_DLL VSIFRead( void *, size_t, size_t, FILE * ); 00089 size_t CPL_DLL VSIFWrite( const void *, size_t, size_t, FILE * ); 00090 char CPL_DLL *VSIFGets( char *, int, FILE * ); 00091 int CPL_DLL VSIFPuts( const char *, FILE * ); 00092 int CPL_DLL VSIFPrintf( FILE *, const char *, ... ) CPL_PRINT_FUNC_FORMAT(2, 3); 00093 00094 int CPL_DLL VSIFGetc( FILE * ); 00095 int CPL_DLL VSIFPutc( int, FILE * ); 00096 int CPL_DLL VSIUngetc( int, FILE * ); 00097 int CPL_DLL VSIFEof( FILE * ); 00098 00099 /* ==================================================================== */ 00100 /* VSIStat() related. */ 00101 /* ==================================================================== */ 00102 00103 typedef struct stat VSIStatBuf; 00104 int CPL_DLL VSIStat( const char *, VSIStatBuf * ); 00105 00106 #ifdef _WIN32 00107 # define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */ 00108 # define VSI_ISREG(x) ((x) & S_IFREG) 00109 # define VSI_ISDIR(x) ((x) & S_IFDIR) 00110 # define VSI_ISCHR(x) ((x) & S_IFCHR) 00111 # define VSI_ISBLK(x) ( 0 ) /* N/A on Windows */ 00112 #else 00113 # define VSI_ISLNK(x) S_ISLNK(x) 00114 # define VSI_ISREG(x) S_ISREG(x) 00115 # define VSI_ISDIR(x) S_ISDIR(x) 00116 # define VSI_ISCHR(x) S_ISCHR(x) 00117 # define VSI_ISBLK(x) S_ISBLK(x) 00118 #endif 00119 00120 /* ==================================================================== */ 00121 /* 64bit stdio file access functions. If we have a big size */ 00122 /* defined, then provide protypes for the large file API, */ 00123 /* otherwise redefine to use the regular api. */ 00124 /* ==================================================================== */ 00125 typedef GUIntBig vsi_l_offset; 00126 00127 FILE CPL_DLL * VSIFOpenL( const char *, const char * ); 00128 int CPL_DLL VSIFCloseL( FILE * ); 00129 int CPL_DLL VSIFSeekL( FILE *, vsi_l_offset, int ); 00130 vsi_l_offset CPL_DLL VSIFTellL( FILE * ); 00131 void CPL_DLL VSIRewindL( FILE * ); 00132 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, FILE * ); 00133 size_t CPL_DLL VSIFWriteL( const void *, size_t, size_t, FILE * ); 00134 int CPL_DLL VSIFEofL( FILE * ); 00135 int CPL_DLL VSIFFlushL( FILE * ); 00136 int CPL_DLL VSIFPrintfL( FILE *, const char *, ... ) CPL_PRINT_FUNC_FORMAT(2, 3); 00137 int CPL_DLL VSIFPutcL( int, FILE * ); 00138 00139 #if defined(VSI_STAT64_T) 00140 typedef struct VSI_STAT64_T VSIStatBufL; 00141 #else 00142 #define VSIStatBufL VSIStatBuf 00143 #endif 00144 00145 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ); 00146 00147 /* ==================================================================== */ 00148 /* Memory allocation */ 00149 /* ==================================================================== */ 00150 00151 void CPL_DLL *VSICalloc( size_t, size_t ); 00152 void CPL_DLL *VSIMalloc( size_t ); 00153 void CPL_DLL VSIFree( void * ); 00154 void CPL_DLL *VSIRealloc( void *, size_t ); 00155 char CPL_DLL *VSIStrdup( const char * ); 00156 00164 void CPL_DLL *VSIMalloc2( size_t nSize1, size_t nSize2 ); 00165 00173 void CPL_DLL *VSIMalloc3( size_t nSize1, size_t nSize2, size_t nSize3 ); 00174 00175 00176 /* ==================================================================== */ 00177 /* Other... */ 00178 /* ==================================================================== */ 00179 00180 #define CPLReadDir VSIReadDir 00181 char CPL_DLL **VSIReadDir( const char * ); 00182 int CPL_DLL VSIMkdir( const char * pathname, long mode ); 00183 int CPL_DLL VSIRmdir( const char * pathname ); 00184 int CPL_DLL VSIUnlink( const char * pathname ); 00185 int CPL_DLL VSIRename( const char * oldpath, const char * newpath ); 00186 char CPL_DLL *VSIStrerror( int ); 00187 00188 /* ==================================================================== */ 00189 /* Install special file access handlers. */ 00190 /* ==================================================================== */ 00191 void CPL_DLL VSIInstallMemFileHandler(void); 00192 void CPL_DLL VSIInstallLargeFileHandler(void); 00193 void CPL_DLL VSIInstallSubFileHandler(void); 00194 void VSIInstallGZipFileHandler(void); /* No reason to export that */ 00195 void VSIInstallZipFileHandler(void); /* No reason to export that */ 00196 void VSIInstallStdoutHandler(void); /* No reason to export that */ 00197 void CPL_DLL VSICleanupFileManager(void); 00198 00199 FILE CPL_DLL *VSIFileFromMemBuffer( const char *pszFilename, 00200 GByte *pabyData, 00201 vsi_l_offset nDataLength, 00202 int bTakeOwnership ); 00203 GByte CPL_DLL *VSIGetMemFileBuffer( const char *pszFilename, 00204 vsi_l_offset *pnDataLength, 00205 int bUnlinkAndSeize ); 00206 00207 /* ==================================================================== */ 00208 /* Time quering. */ 00209 /* ==================================================================== */ 00210 00211 unsigned long CPL_DLL VSITime( unsigned long * ); 00212 const char CPL_DLL *VSICTime( unsigned long ); 00213 struct tm CPL_DLL *VSIGMTime( const time_t *pnTime, 00214 struct tm *poBrokenTime ); 00215 struct tm CPL_DLL *VSILocalTime( const time_t *pnTime, 00216 struct tm *poBrokenTime ); 00217 00218 /* -------------------------------------------------------------------- */ 00219 /* the following can be turned on for detailed logging of */ 00220 /* almost all IO calls. */ 00221 /* -------------------------------------------------------------------- */ 00222 #ifdef VSI_DEBUG 00223 00224 #ifndef DEBUG 00225 # define DEBUG 00226 #endif 00227 00228 #include "cpl_error.h" 00229 00230 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 ); 00231 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 ); 00232 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 ); 00233 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 ); 00234 #else 00235 #define VSIDebug4( f, a1, a2, a3, a4 ) {} 00236 #define VSIDebug3( f, a1, a2, a3 ) {} 00237 #define VSIDebug2( f, a1, a2 ) {} 00238 #define VSIDebug1( f, a1 ) {} 00239 #endif 00240 00241 CPL_C_END 00242 00243 #endif /* ndef CPL_VSI_H_INCLUDED */