32 #ifndef CPL_VSI_H_INCLUDED 33 #define CPL_VSI_H_INCLUDED 68 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT 69 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT 71 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT 80 FILE CPL_DLL * VSIFOpen(
const char *,
const char * ) CPL_WARN_UNUSED_RESULT;
81 int CPL_DLL VSIFClose( FILE * );
82 int CPL_DLL VSIFSeek( FILE *,
long,
int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
83 long CPL_DLL VSIFTell( FILE * ) CPL_WARN_UNUSED_RESULT;
84 void CPL_DLL VSIRewind( FILE * );
85 void CPL_DLL VSIFFlush( FILE * );
87 size_t CPL_DLL VSIFRead(
void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
88 size_t CPL_DLL VSIFWrite(
const void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
89 char CPL_DLL *VSIFGets(
char *,
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
90 int CPL_DLL VSIFPuts(
const char *, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
91 int CPL_DLL VSIFPrintf( FILE *,
const char *, ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
93 int CPL_DLL VSIFGetc( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
94 int CPL_DLL VSIFPutc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
95 int CPL_DLL VSIUngetc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96 int CPL_DLL VSIFEof( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
102 typedef struct stat VSIStatBuf;
103 int CPL_DLL VSIStat( const
char *, VSIStatBuf * ) CPL_WARN_UNUSED_RESULT;
106 # define VSI_ISLNK(x) ( 0 ) 107 # define VSI_ISREG(x) ((x) & S_IFREG) 108 # define VSI_ISDIR(x) ((x) & S_IFDIR) 109 # define VSI_ISCHR(x) ((x) & S_IFCHR) 110 # define VSI_ISBLK(x) ( 0 ) 112 # define VSI_ISLNK(x) S_ISLNK(x) 113 # define VSI_ISREG(x) S_ISREG(x) 114 # define VSI_ISDIR(x) S_ISDIR(x) 115 # define VSI_ISCHR(x) S_ISCHR(x) 116 # define VSI_ISBLK(x) S_ISBLK(x) 124 typedef GUIntBig vsi_l_offset;
125 #define VSI_L_OFFSET_MAX GUINTBIG_MAX 129 #define VSIL_STRICT_ENFORCE 132 #ifdef VSIL_STRICT_ENFORCE 133 typedef struct _VSILFILE VSILFILE;
135 typedef FILE VSILFILE;
138 VSILFILE CPL_DLL *
VSIFOpenL(
const char *,
const char * ) CPL_WARN_UNUSED_RESULT;
139 VSILFILE CPL_DLL *
VSIFOpenExL(
const char *,
const char *,
int ) CPL_WARN_UNUSED_RESULT;
140 int CPL_DLL
VSIFCloseL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
141 int CPL_DLL
VSIFSeekL( VSILFILE *, vsi_l_offset,
int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
142 vsi_l_offset CPL_DLL
VSIFTellL( VSILFILE * ) CPL_WARN_UNUSED_RESULT;
144 size_t CPL_DLL
VSIFReadL(
void *,
size_t,
size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
145 int CPL_DLL
VSIFReadMultiRangeL(
int nRanges,
void ** ppData,
const vsi_l_offset* panOffsets,
const size_t* panSizes, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
146 size_t CPL_DLL
VSIFWriteL(
const void *,
size_t,
size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
147 int CPL_DLL
VSIFEofL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
148 int CPL_DLL
VSIFTruncateL( VSILFILE *, vsi_l_offset ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
149 int CPL_DLL
VSIFFlushL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
150 int CPL_DLL
VSIFPrintfL( VSILFILE *,
const char *, ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
151 int CPL_DLL
VSIFPutcL(
int, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
154 const
char* pszFilename,
156 vsi_l_offset* pnSize,
157 GIntBig nMaxSize ) CPL_WARN_UNUSED_RESULT;
159 #if defined(VSI_STAT64_T) 160 typedef struct VSI_STAT64_T VSIStatBufL;
162 #define VSIStatBufL VSIStatBuf 165 int CPL_DLL
VSIStatL(
const char *, VSIStatBufL * ) CPL_WARN_UNUSED_RESULT;
167 #define VSI_STAT_EXISTS_FLAG 0x1 168 #define VSI_STAT_NATURE_FLAG 0x2 169 #define VSI_STAT_SIZE_FLAG 0x4 170 #define VSI_STAT_SET_ERROR_FLAG 0x8 172 int CPL_DLL
VSIStatExL(
const char * pszFilename, VSIStatBufL * psStatBuf,
int nFlags ) CPL_WARN_UNUSED_RESULT;
182 void CPL_DLL *VSICalloc(
size_t,
size_t ) CPL_WARN_UNUSED_RESULT;
183 void CPL_DLL *VSIMalloc(
size_t ) CPL_WARN_UNUSED_RESULT;
184 void CPL_DLL VSIFree(
void * );
185 void CPL_DLL *VSIRealloc(
void *,
size_t ) CPL_WARN_UNUSED_RESULT;
186 char CPL_DLL *VSIStrdup(
const char * ) CPL_WARN_UNUSED_RESULT;
195 void CPL_DLL *
VSIMalloc2(
size_t nSize1,
size_t nSize2 ) CPL_WARN_UNUSED_RESULT;
204 void CPL_DLL *
VSIMalloc3(
size_t nSize1,
size_t nSize2,
size_t nSize3 ) CPL_WARN_UNUSED_RESULT;
207 void CPL_DLL *VSIMallocVerbose(
size_t nSize,
const char* pszFile,
int nLine ) CPL_WARN_UNUSED_RESULT;
208 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__) 210 void CPL_DLL *VSIMalloc2Verbose(
size_t nSize1,
size_t nSize2,
const char* pszFile,
int nLine ) CPL_WARN_UNUSED_RESULT;
211 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__) 213 void CPL_DLL *VSIMalloc3Verbose(
size_t nSize1,
size_t nSize2,
size_t nSize3,
const char* pszFile,
int nLine ) CPL_WARN_UNUSED_RESULT;
214 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__) 216 void CPL_DLL *VSICallocVerbose(
size_t nCount,
size_t nSize,
const char* pszFile,
int nLine ) CPL_WARN_UNUSED_RESULT;
217 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__) 219 void CPL_DLL *VSIReallocVerbose(
void* pOldPtr,
size_t nNewSize,
const char* pszFile,
int nLine ) CPL_WARN_UNUSED_RESULT;
220 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__) 222 char CPL_DLL *VSIStrdupVerbose(
const char* pszStr,
const char* pszFile,
int nLine ) CPL_WARN_UNUSED_RESULT;
223 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__) 233 #define CPLReadDir VSIReadDir 236 char CPL_DLL **
VSIReadDirEx(
const char *pszPath,
int nMaxFiles );
237 int CPL_DLL
VSIMkdir(
const char * pathname,
long mode );
238 int CPL_DLL
VSIRmdir(
const char * pathname );
239 int CPL_DLL
VSIUnlink(
const char * pathname );
240 int CPL_DLL
VSIRename(
const char * oldpath,
const char * newpath );
241 char CPL_DLL *VSIStrerror(
int );
248 void CPL_DLL VSIInstallLargeFileHandler(
void);
262 void CPL_DLL VSICleanupFileManager(
void);
266 vsi_l_offset nDataLength,
267 int bTakeOwnership ) CPL_WARN_UNUSED_RESULT;
269 vsi_l_offset *pnDataLength,
270 int bUnlinkAndSeize );
272 typedef size_t (*VSIWriteFunction)(
const void* ptr,
size_t size,
size_t nmemb, FILE* stream);
279 unsigned long CPL_DLL VSITime(
unsigned long * );
280 const char CPL_DLL *VSICTime(
unsigned long );
281 struct tm CPL_DLL *VSIGMTime(
const time_t *pnTime,
282 struct tm *poBrokenTime );
283 struct tm CPL_DLL *VSILocalTime(
const time_t *pnTime,
284 struct tm *poBrokenTime );
298 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 ); 299 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 ); 300 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 ); 301 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 ); 303 #define VSIDebug4( f, a1, a2, a3, a4 ) {} 304 #define VSIDebug3( f, a1, a2, a3 ) {} 305 #define VSIDebug2( f, a1, a2 ) {} 306 #define VSIDebug1( f, a1 ) {} int VSIMkdir(const char *pathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:303
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1118
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:65
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:362
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:714
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:461
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1173
Core portability definitions for CPL.
vsi_l_offset VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT
Tell current file offset.
Definition: cpl_vsil.cpp:692
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:870
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize) CPL_WARN_UNUSED_RESULT
Ingest a file into memory.
Definition: cpl_vsil.cpp:995
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:4315
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:959
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:99
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:772
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Set an alternative write function and output file handle instead of fwrite() / stdout.
Definition: cpl_vsil_stdout.cpp:57
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1185
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3) CPL_WARN_UNUSED_RESULT
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:890
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:897
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:422
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:461
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:1582
VSILFILE * VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:546
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:397
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:495
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2415
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:508
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:629
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:841
void * VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:878
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1194
CPL error handling services.
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:566
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1612
int VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:424
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership) CPL_WARN_UNUSED_RESULT
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:865
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:740
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:1842
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:664
int VSIRmdir(const char *pathname)
Delete a directory.
Definition: cpl_vsil.cpp:391
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:3241
int VSIUnlink(const char *pathname)
Delete a file.
Definition: cpl_vsil.cpp:331
int VSIFReadMultiRangeL(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read several ranges of bytes from file.
Definition: cpl_vsil.cpp:808
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:923
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:835
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:921
VSILFILE * VSIFOpenExL(const char *, const char *, int) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:595
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:185
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:142
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:1755