Go to the documentation of this file.
32 #ifndef CPL_VSI_H_INCLUDED
33 #define CPL_VSI_H_INCLUDED
70 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
71 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
73 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
85 int CPL_DLL VSIFClose( FILE * );
86 int CPL_DLL VSIFSeek( FILE *,
long,
int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
88 void CPL_DLL VSIRewind( FILE * );
89 void CPL_DLL VSIFFlush( FILE * );
91 size_t CPL_DLL VSIFRead(
void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
92 size_t CPL_DLL VSIFWrite(
const void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
93 char CPL_DLL *VSIFGets(
char *,
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
94 int CPL_DLL VSIFPuts(
const char *, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
97 int CPL_DLL VSIFGetc( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
98 int CPL_DLL VSIFPutc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
99 int CPL_DLL VSIUngetc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
100 int CPL_DLL VSIFEof( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
109 typedef struct stat VSIStatBuf;
114 # define VSI_ISLNK(x) ( 0 )
115 # define VSI_ISREG(x) ((x) & S_IFREG)
116 # define VSI_ISDIR(x) ((x) & S_IFDIR)
117 # define VSI_ISCHR(x) ((x) & S_IFCHR)
118 # define VSI_ISBLK(x) ( 0 )
121 # define VSI_ISLNK(x) S_ISLNK(x)
123 # define VSI_ISREG(x) S_ISREG(x)
125 # define VSI_ISDIR(x) S_ISDIR(x)
127 # define VSI_ISCHR(x) S_ISCHR(x)
128 # define VSI_ISBLK(x) S_ISBLK(x)
141 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
146 #define VSIL_STRICT_ENFORCE
150 #ifdef VSIL_STRICT_ENFORCE
164 size_t CPL_DLL
VSIFReadL(
void *,
size_t,
size_t,
VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
166 size_t CPL_DLL
VSIFWriteL(
const void *,
size_t,
size_t,
VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
184 const char* pszFilename,
189 #if defined(VSI_STAT64_T)
194 #define VSIStatBufL VSIStatBuf
200 #define VSI_STAT_EXISTS_FLAG 0x1
202 #define VSI_STAT_NATURE_FLAG 0x2
204 #define VSI_STAT_SIZE_FLAG 0x4
206 #define VSI_STAT_SET_ERROR_FLAG 0x8
232 void CPL_DLL
VSIFree(
void * );
242 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
265 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
270 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
275 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
280 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
285 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
290 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
300 #define CPLReadDir VSIReadDir
303 char CPL_DLL **
VSIReadDirEx(
const char *pszPath,
int nMaxFiles );
304 int CPL_DLL
VSIMkdir(
const char * pszPathname,
long mode );
306 int CPL_DLL
VSIRmdir(
const char * pszDirname );
308 int CPL_DLL
VSIUnlink(
const char * pszFilename );
309 int CPL_DLL
VSIRename(
const char * oldpath,
const char * newpath );
318 void CPL_DLL VSIInstallLargeFileHandler(
void);
343 void CPL_DLL VSICleanupFileManager(
void);
352 int bUnlinkAndSeize );
355 typedef size_t (*
VSIWriteFunction)(
const void* ptr,
size_t size,
size_t nmemb, FILE* stream);
363 unsigned long CPL_DLL VSITime(
unsigned long * );
364 const char CPL_DLL *VSICTime(
unsigned long );
365 struct tm CPL_DLL *VSIGMTime(
const time_t *pnTime,
366 struct tm *poBrokenTime );
367 struct tm CPL_DLL *VSILocalTime(
const time_t *pnTime,
368 struct tm *poBrokenTime );
384 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 );
385 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 );
386 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 );
387 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 );
389 #define VSIDebug4( f, a1, a2, a3, a4 ) {}
390 #define VSIDebug3( f, a1, a2, a3 ) {}
391 #define VSIDebug2( f, a1, a2 ) {}
392 #define VSIDebug1( f, a1 ) {}
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1411
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8583
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:904
@ VSI_RANGE_STATUS_HOLE
Definition: cpl_vsi.h:178
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:490
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8549
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Definition: cpl_vsil_stdout.cpp:64
GIntBig CPLGetUsablePhysicalRAM(void)
Definition: cpl_vsisimple.cpp:1431
void VSIFreeAligned(void *ptr)
Definition: cpl_vsisimple.cpp:971
unsigned char GByte
Definition: cpl_port.h:213
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1134
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:986
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1146
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:468
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1220
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:435
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:780
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:925
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2153
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:677
void VSIInstallSubFileHandler(void)
Definition: cpl_vsil_subfile.cpp:501
VSIRangeStatus
Definition: cpl_vsi.h:174
GIntBig CPLGetPhysicalRAM(void)
Definition: cpl_vsisimple.cpp:1360
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:333
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:439
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:356
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:872
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1053
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:647
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1260
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Definition: cpl_vsi.h:355
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:703
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:928
void VSIInstallSparseFileHandler(void)
Definition: cpl_vsil_sparsefile.cpp:559
const char * VSIGetFileSystemOptions(const char *pszFilename)
Return the list of options associated with a virtual file system handler as a serialized XML string.
Definition: cpl_vsil.cpp:1759
#define CPL_C_START
Definition: cpl_port.h:335
@ VSI_RANGE_STATUS_UNKNOWN
Definition: cpl_vsi.h:176
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:1463
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1306
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8513
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1822
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:117
char ** CSLConstList
Definition: cpl_port.h:1184
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:1031
unsigned long long GUIntBig
Definition: cpl_port.h:249
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1094
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8531
#define CPL_C_END
Definition: cpl_port.h:337
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:434
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1176
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:558
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:408
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2036
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2135
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:677
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1348
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1151
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:1739
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2098
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8480
char * VSIStrerror(int)
Definition: cpl_vsisimple.cpp:1343
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:586
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:988
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:895
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2659
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:139
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:823
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8566
void * VSIMalloc2(size_t nSize1, size_t nSize2)
Definition: cpl_vsisimple.cpp:1112
char * VSIStrdup(const char *)
Definition: cpl_vsisimple.cpp:991
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:1206
void * VSICalloc(size_t, size_t)
Definition: cpl_vsisimple.cpp:440
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1238
void * VSIMallocAlignedAuto(size_t nSize)
Definition: cpl_vsisimple.cpp:934
void * VSIMalloc(size_t)
Definition: cpl_vsisimple.cpp:554
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:160
long long GIntBig
Definition: cpl_port.h:246
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:597
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Definition: cpl_vsil_crypt.cpp:205
#define CPL_WARN_UNUSED_RESULT
Definition: cpl_port.h:929
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1717
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:919
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:191
void VSIInstallOSSStreamingFileHandler(void)
Install /vsioss_streaming/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires l...
Definition: cpl_vsil_curl_streaming.cpp:2172
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streamin/ OpenStack Swif Object Storage (Swift) file system handler (requires libcu...
Definition: cpl_vsil_curl_streaming.cpp:2191
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2116
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:947
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:818
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Definition: cpl_vsisimple.cpp:888
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:83
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:8604
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:1500
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:733
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
Definition: cpl_vsisimple.cpp:1125
@ VSI_RANGE_STATUS_DATA
Definition: cpl_vsi.h:177
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1696
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1374
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1201
FILE VSILFILE
Definition: cpl_vsi.h:155
Generated for GDAL by
1.8.17.