Go to the documentation of this file.
32 #ifndef CPL_VSI_H_INCLUDED
33 #define CPL_VSI_H_INCLUDED
69 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
70 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
72 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
84 int CPL_DLL VSIFClose( FILE * );
85 int CPL_DLL VSIFSeek( FILE *,
long,
int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
87 void CPL_DLL VSIRewind( FILE * );
88 void CPL_DLL VSIFFlush( FILE * );
90 size_t CPL_DLL VSIFRead(
void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
91 size_t CPL_DLL VSIFWrite(
const void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
92 char CPL_DLL *VSIFGets(
char *,
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
93 int CPL_DLL VSIFPuts(
const char *, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96 int CPL_DLL VSIFGetc( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
97 int CPL_DLL VSIFPutc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
98 int CPL_DLL VSIUngetc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
99 int CPL_DLL VSIFEof( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
108 typedef struct stat VSIStatBuf;
113 # define VSI_ISLNK(x) ( 0 )
114 # define VSI_ISREG(x) ((x) & S_IFREG)
115 # define VSI_ISDIR(x) ((x) & S_IFDIR)
116 # define VSI_ISCHR(x) ((x) & S_IFCHR)
117 # define VSI_ISBLK(x) ( 0 )
120 # define VSI_ISLNK(x) S_ISLNK(x)
122 # define VSI_ISREG(x) S_ISREG(x)
124 # define VSI_ISDIR(x) S_ISDIR(x)
126 # define VSI_ISCHR(x) S_ISCHR(x)
127 # define VSI_ISBLK(x) S_ISBLK(x)
140 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
145 #define VSIL_STRICT_ENFORCE
149 #ifdef VSIL_STRICT_ENFORCE
163 size_t CPL_DLL
VSIFReadL(
void *,
size_t,
size_t,
VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
165 size_t CPL_DLL
VSIFWriteL(
const void *,
size_t,
size_t,
VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
183 const char* pszFilename,
188 #if defined(VSI_STAT64_T)
193 #define VSIStatBufL VSIStatBuf
199 #define VSI_STAT_EXISTS_FLAG 0x1
201 #define VSI_STAT_NATURE_FLAG 0x2
203 #define VSI_STAT_SIZE_FLAG 0x4
205 #define VSI_STAT_SET_ERROR_FLAG 0x8
221 void CPL_DLL
VSIFree(
void * );
231 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
254 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
259 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
264 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
269 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
274 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
279 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
289 #define CPLReadDir VSIReadDir
292 char CPL_DLL **
VSIReadDirEx(
const char *pszPath,
int nMaxFiles );
293 int CPL_DLL
VSIMkdir(
const char * pathname,
long mode );
294 int CPL_DLL
VSIRmdir(
const char * pathname );
295 int CPL_DLL
VSIUnlink(
const char * pathname );
296 int CPL_DLL
VSIRename(
const char * oldpath,
const char * newpath );
305 void CPL_DLL VSIInstallLargeFileHandler(
void);
324 void CPL_DLL VSICleanupFileManager(
void);
333 int bUnlinkAndSeize );
336 typedef size_t (*
VSIWriteFunction)(
const void* ptr,
size_t size,
size_t nmemb, FILE* stream);
344 unsigned long CPL_DLL VSITime(
unsigned long * );
345 const char CPL_DLL *VSICTime(
unsigned long );
346 struct tm CPL_DLL *VSIGMTime(
const time_t *pnTime,
347 struct tm *poBrokenTime );
348 struct tm CPL_DLL *VSILocalTime(
const time_t *pnTime,
349 struct tm *poBrokenTime );
365 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 );
366 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 );
367 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 );
368 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 );
370 #define VSIDebug4( f, a1, a2, a3, a4 ) {}
371 #define VSIDebug3( f, a1, a2, a3 ) {}
372 #define VSIDebug2( f, a1, a2 ) {}
373 #define VSIDebug1( f, a1 ) {}
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1187
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:967
@ VSI_RANGE_STATUS_HOLE
Definition: cpl_vsi.h:177
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Definition: cpl_vsil_stdout.cpp:64
GIntBig CPLGetUsablePhysicalRAM(void)
Definition: cpl_vsisimple.cpp:1423
void VSIFreeAligned(void *ptr)
Definition: cpl_vsisimple.cpp:965
unsigned char GByte
Definition: cpl_port.h:207
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1126
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:992
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:922
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1212
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:434
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:933
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:671
void VSIInstallSubFileHandler(void)
Definition: cpl_vsil_subfile.cpp:496
VSIRangeStatus
Definition: cpl_vsi.h:173
GIntBig CPLGetPhysicalRAM(void)
Definition: cpl_vsisimple.cpp:1352
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:388
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:662
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:829
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:540
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1036
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Definition: cpl_vsi.h:336
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:712
void VSIInstallSparseFileHandler(void)
Definition: cpl_vsil_sparsefile.cpp:588
#define CPL_C_START
Definition: cpl_port.h:352
@ VSI_RANGE_STATUS_UNKNOWN
Definition: cpl_vsi.h:175
VSIRangeStatus VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsil.cpp:1241
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1082
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:5017
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1805
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:116
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:807
unsigned long long GUIntBig
Definition: cpl_port.h:253
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:870
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:5068
#define CPL_C_END
Definition: cpl_port.h:354
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:421
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1168
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:451
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2033
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2031
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:570
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1124
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1143
int VSIRmdir(const char *pathname)
Delete a directory.
Definition: cpl_vsil.cpp:417
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:1928
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:4950
char * VSIStrerror(int)
Definition: cpl_vsisimple.cpp:1335
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:538
int VSIUnlink(const char *pathname)
Delete a file.
Definition: cpl_vsil.cpp:357
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:764
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:903
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2634
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:138
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:817
void * VSIMalloc2(size_t nSize1, size_t nSize2)
Definition: cpl_vsisimple.cpp:1104
char * VSIStrdup(const char *)
Definition: cpl_vsisimple.cpp:985
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:982
void * VSICalloc(size_t, size_t)
Definition: cpl_vsisimple.cpp:438
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1230
void * VSIMallocAlignedAuto(size_t nSize)
Definition: cpl_vsisimple.cpp:928
void * VSIMalloc(size_t)
Definition: cpl_vsisimple.cpp:548
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:159
long long GIntBig
Definition: cpl_port.h:250
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:490
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Definition: cpl_vsil_crypt.cpp:197
#define CPL_WARN_UNUSED_RESULT
Definition: cpl_port.h:999
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1495
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:989
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:190
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:1980
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:941
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:608
int VSIMkdir(const char *pathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:329
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Definition: cpl_vsisimple.cpp:882
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:82
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:5088
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:1278
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
Definition: cpl_vsisimple.cpp:1117
@ VSI_RANGE_STATUS_DATA
Definition: cpl_vsi.h:176
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1474
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1150
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1193
FILE VSILFILE
Definition: cpl_vsi.h:154
Generated for GDAL by
1.8.17.