GDAL
cpl_vsi.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id: cpl_vsi.h 41167 2018-01-02 16:42:48Z goatbar $
3  *
4  * Project: CPL - Common Portability Library
5  * Author: Frank Warmerdam, warmerdam@pobox.com
6  * Purpose: Include file defining Virtual File System (VSI) functions, a
7  * layer over POSIX file and other system services.
8  *
9  ******************************************************************************
10  * Copyright (c) 1998, Frank Warmerdam
11  * Copyright (c) 2008-2014, Even Rouault <even dot rouault at mines-paris dot org>
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included
21  * in all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29  * DEALINGS IN THE SOFTWARE.
30  ****************************************************************************/
31 
32 #ifndef CPL_VSI_H_INCLUDED
33 #define CPL_VSI_H_INCLUDED
34 
35 #include "cpl_port.h"
54 /* -------------------------------------------------------------------- */
55 /* We need access to ``struct stat''. */
56 /* -------------------------------------------------------------------- */
57 
58 /* Unix */
59 #if !defined(_WIN32)
60 # include <unistd.h>
61 #endif
62 
63 /* Windows */
64 #include <sys/stat.h>
65 
67 
69 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
70 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
71 #else
72 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
73 #endif
74 
76 /* ==================================================================== */
77 /* stdio file access functions. These do not support large */
78 /* files, and do not go through the virtualization API. */
79 /* ==================================================================== */
80 
83 FILE CPL_DLL * VSIFOpen( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
84 int CPL_DLL VSIFClose( FILE * );
85 int CPL_DLL VSIFSeek( FILE *, long, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
86 long CPL_DLL VSIFTell( FILE * ) CPL_WARN_UNUSED_RESULT;
87 void CPL_DLL VSIRewind( FILE * );
88 void CPL_DLL VSIFFlush( FILE * );
89 
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;
94 int CPL_DLL VSIFPrintf( FILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
95 
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;
100 
103 /* ==================================================================== */
104 /* VSIStat() related. */
105 /* ==================================================================== */
106 
108 typedef struct stat VSIStatBuf;
109 int CPL_DLL VSIStat( const char *, VSIStatBuf * ) CPL_WARN_UNUSED_RESULT;
112 #ifdef _WIN32
113 # define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */
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 ) /* N/A on Windows */
118 #else
119 
120 # define VSI_ISLNK(x) S_ISLNK(x)
121 
122 # define VSI_ISREG(x) S_ISREG(x)
123 
124 # define VSI_ISDIR(x) S_ISDIR(x)
125 
126 # define VSI_ISCHR(x) S_ISCHR(x)
127 # define VSI_ISBLK(x) S_ISBLK(x)
128 
129 #endif
130 
131 /* ==================================================================== */
132 /* 64bit stdio file access functions. If we have a big size */
133 /* defined, then provide prototypes for the large file API, */
134 /* otherwise redefine to use the regular api. */
135 /* ==================================================================== */
136 
140 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
141 
143 /* Make VSIL_STRICT_ENFORCE active in DEBUG builds */
144 #ifdef DEBUG
145 #define VSIL_STRICT_ENFORCE
146 #endif
147 
149 #ifdef VSIL_STRICT_ENFORCE
150 
151 typedef struct _VSILFILE VSILFILE;
152 #else
153 
154 typedef FILE VSILFILE;
155 #endif
156 
157 VSILFILE CPL_DLL * VSIFOpenL( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
158 VSILFILE CPL_DLL * VSIFOpenExL( const char *, const char *, int ) CPL_WARN_UNUSED_RESULT;
159 int CPL_DLL VSIFCloseL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
160 int CPL_DLL VSIFSeekL( VSILFILE *, vsi_l_offset, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
161 vsi_l_offset CPL_DLL VSIFTellL( VSILFILE * ) CPL_WARN_UNUSED_RESULT;
162 void CPL_DLL VSIRewindL( VSILFILE * );
163 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
164 int CPL_DLL VSIFReadMultiRangeL( int nRanges, void ** ppData, const vsi_l_offset* panOffsets, const size_t* panSizes, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
165 size_t CPL_DLL VSIFWriteL( const void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
166 int CPL_DLL VSIFEofL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
167 int CPL_DLL VSIFTruncateL( VSILFILE *, vsi_l_offset ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
168 int CPL_DLL VSIFFlushL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
169 int CPL_DLL VSIFPrintfL( VSILFILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
170 int CPL_DLL VSIFPutcL( int, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
171 
173 typedef enum
174 {
179 
180 VSIRangeStatus CPL_DLL VSIFGetRangeStatusL( VSILFILE * fp, vsi_l_offset nStart, vsi_l_offset nLength );
181 
182 int CPL_DLL VSIIngestFile( VSILFILE* fp,
183  const char* pszFilename,
184  GByte** ppabyRet,
185  vsi_l_offset* pnSize,
186  GIntBig nMaxSize ) CPL_WARN_UNUSED_RESULT;
187 
188 #if defined(VSI_STAT64_T)
189 
190 typedef struct VSI_STAT64_T VSIStatBufL;
191 #else
192 
193 #define VSIStatBufL VSIStatBuf
194 #endif
195 
196 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ) CPL_WARN_UNUSED_RESULT;
197 
199 #define VSI_STAT_EXISTS_FLAG 0x1
200 
201 #define VSI_STAT_NATURE_FLAG 0x2
202 
203 #define VSI_STAT_SIZE_FLAG 0x4
204 
205 #define VSI_STAT_SET_ERROR_FLAG 0x8
206 
207 int CPL_DLL VSIStatExL( const char * pszFilename, VSIStatBufL * psStatBuf, int nFlags ) CPL_WARN_UNUSED_RESULT;
208 
209 int CPL_DLL VSIIsCaseSensitiveFS( const char * pszFilename );
210 
211 int CPL_DLL VSISupportsSparseFiles( const char* pszPath );
212 
213 int CPL_DLL VSIHasOptimizedReadMultiRange( const char* pszPath );
214 
215 void CPL_DLL *VSIFGetNativeFileDescriptorL( VSILFILE* );
216 
217 /* ==================================================================== */
218 /* Memory allocation */
219 /* ==================================================================== */
220 
221 void CPL_DLL *VSICalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
222 void CPL_DLL *VSIMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
223 void CPL_DLL VSIFree( void * );
224 void CPL_DLL *VSIRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
225 char CPL_DLL *VSIStrdup( const char * ) CPL_WARN_UNUSED_RESULT;
226 
227 void CPL_DLL *VSIMallocAligned( size_t nAlignment, size_t nSize ) CPL_WARN_UNUSED_RESULT;
228 void CPL_DLL *VSIMallocAlignedAuto( size_t nSize ) CPL_WARN_UNUSED_RESULT;
229 void CPL_DLL VSIFreeAligned( void* ptr );
230 
231 void CPL_DLL *VSIMallocAlignedAutoVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
233 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
234 
242 void CPL_DLL *VSIMalloc2( size_t nSize1, size_t nSize2 ) CPL_WARN_UNUSED_RESULT;
243 
251 void CPL_DLL *VSIMalloc3( size_t nSize1, size_t nSize2, size_t nSize3 ) CPL_WARN_UNUSED_RESULT;
252 
254 void CPL_DLL *VSIMallocVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
256 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
257 
259 void CPL_DLL *VSIMalloc2Verbose( size_t nSize1, size_t nSize2, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
261 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
262 
264 void CPL_DLL *VSIMalloc3Verbose( size_t nSize1, size_t nSize2, size_t nSize3, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
266 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
267 
269 void CPL_DLL *VSICallocVerbose( size_t nCount, size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
271 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
272 
274 void CPL_DLL *VSIReallocVerbose( void* pOldPtr, size_t nNewSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
276 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
277 
279 char CPL_DLL *VSIStrdupVerbose( const char* pszStr, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
281 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
282 
283 GIntBig CPL_DLL CPLGetPhysicalRAM(void);
284 GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
285 
286 /* ==================================================================== */
287 /* Other... */
288 /* ==================================================================== */
289 
291 #define CPLReadDir VSIReadDir
292 char CPL_DLL **VSIReadDir( const char * );
293 char CPL_DLL **VSIReadDirRecursive( const char *pszPath );
294 char CPL_DLL **VSIReadDirEx( const char *pszPath, int nMaxFiles );
295 int CPL_DLL VSIMkdir( const char * pszPathname, long mode );
296 int CPL_DLL VSIMkdirRecursive( const char * pszPathname, long mode );
297 int CPL_DLL VSIRmdir( const char * pszDirname );
298 int CPL_DLL VSIRmdirRecursive( const char * pszDirname );
299 int CPL_DLL VSIUnlink( const char * pszFilename );
300 int CPL_DLL VSIRename( const char * oldpath, const char * newpath );
301 char CPL_DLL *VSIStrerror( int );
302 GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
303 
304 /* ==================================================================== */
305 /* Install special file access handlers. */
306 /* ==================================================================== */
307 void CPL_DLL VSIInstallMemFileHandler(void);
309 void CPL_DLL VSIInstallLargeFileHandler(void);
311 void CPL_DLL VSIInstallSubFileHandler(void);
312 void VSIInstallCurlFileHandler(void);
313 void CPL_DLL VSICurlClearCache(void);
315 void VSIInstallS3FileHandler(void);
317 void VSIInstallGSFileHandler(void);
319 void VSIInstallAzureFileHandler(void);
321 void VSIInstallOSSFileHandler(void);
323 void VSIInstallGZipFileHandler(void); /* No reason to export that */
324 void VSIInstallZipFileHandler(void); /* No reason to export that */
325 void VSIInstallStdinHandler(void); /* No reason to export that */
326 void VSIInstallStdoutHandler(void); /* No reason to export that */
327 void CPL_DLL VSIInstallSparseFileHandler(void);
328 void VSIInstallTarFileHandler(void); /* No reason to export that */
329 void CPL_DLL VSIInstallCryptFileHandler(void);
330 void CPL_DLL VSISetCryptKey(const GByte* pabyKey, int nKeySize);
332 void CPL_DLL VSICleanupFileManager(void);
335 VSILFILE CPL_DLL *VSIFileFromMemBuffer( const char *pszFilename,
336  GByte *pabyData,
337  vsi_l_offset nDataLength,
338  int bTakeOwnership ) CPL_WARN_UNUSED_RESULT;
339 GByte CPL_DLL *VSIGetMemFileBuffer( const char *pszFilename,
340  vsi_l_offset *pnDataLength,
341  int bUnlinkAndSeize );
342 
344 typedef size_t (*VSIWriteFunction)(const void* ptr, size_t size, size_t nmemb, FILE* stream);
345 void CPL_DLL VSIStdoutSetRedirection( VSIWriteFunction pFct, FILE* stream );
346 
347 /* ==================================================================== */
348 /* Time querying. */
349 /* ==================================================================== */
350 
352 unsigned long CPL_DLL VSITime( unsigned long * );
353 const char CPL_DLL *VSICTime( unsigned long );
354 struct tm CPL_DLL *VSIGMTime( const time_t *pnTime,
355  struct tm *poBrokenTime );
356 struct tm CPL_DLL *VSILocalTime( const time_t *pnTime,
357  struct tm *poBrokenTime );
361 /* -------------------------------------------------------------------- */
362 /* the following can be turned on for detailed logging of */
363 /* almost all IO calls. */
364 /* -------------------------------------------------------------------- */
365 #ifdef VSI_DEBUG
366 
367 #ifndef DEBUG
368 # define DEBUG
369 #endif
370 
371 #include "cpl_error.h"
372 
373 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 );
374 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 );
375 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 );
376 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 );
377 #else
378 #define VSIDebug4( f, a1, a2, a3, a4 ) {}
379 #define VSIDebug3( f, a1, a2, a3 ) {}
380 #define VSIDebug2( f, a1, a2 ) {}
381 #define VSIDebug1( f, a1 ) {}
382 #endif
383 
385 CPL_C_END
386 
387 #endif /* ndef CPL_VSI_H_INCLUDED */
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:173
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1360
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1151
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:83
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:439
void * VSIMalloc(size_t) CPL_WARN_UNUSED_RESULT
Analog of malloc().
Definition: cpl_vsisimple.cpp:554
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:975
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:596
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1618
Core portability definitions for CPL.
vsi_l_offset VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT
Tell current file offset.
Definition: cpl_vsil.cpp:953
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:331
Hole.
Definition: cpl_vsi.h:177
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:490
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1228
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:154
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:1422
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:7462
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:971
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1333
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:117
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1068
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:947
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Set an alternative write function and output file handle instead of fwrite() / stdout.
Definition: cpl_vsil_stdout.cpp:64
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1431
Data present.
Definition: cpl_vsi.h:176
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:213
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:1125
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:468
void * VSIRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT
Analog of realloc().
Definition: cpl_vsisimple.cpp:677
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:900
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl) ...
Definition: cpl_vsil_curl_streaming.cpp:2060
void * VSIMallocAlignedAuto(size_t nSize) CPL_WARN_UNUSED_RESULT
Allocates a buffer with an alignment constraint such that it can be used by the most demanding vector...
Definition: cpl_vsisimple.cpp:934
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:676
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1270
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:435
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:501
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:7480
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2023
VSILFILE * VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:740
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:434
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1220
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1343
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:544
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2659
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:646
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:333
struct VSI_STAT64_T VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:190
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:356
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:850
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1182
Unknown.
Definition: cpl_vsi.h:175
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:702
void * VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1112
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:1385
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1639
CPL error handling services.
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:559
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1201
void * VSIMallocAligned(size_t nAlignment, size_t nSize) CPL_WARN_UNUSED_RESULT
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:888
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1824
int VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:557
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:239
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:911
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1238
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1016
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:7535
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:344
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:2029
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:910
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:7429
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:915
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1134
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1176
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:138
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl) ...
Definition: cpl_vsil_curl.cpp:7515
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:1128
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1296
void * VSICalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Analog of calloc().
Definition: cpl_vsisimple.cpp:440
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:7498
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:333
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:236
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:881
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:823
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:970
VSILFILE * VSIFOpenExL(const char *, const char *, int) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:794
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:197
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:160
void VSIInstallOSSStreamingFileHandler(void)
Install /vsioss_streaming/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires l...
Definition: cpl_vsil_curl_streaming.cpp:2097
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl) ...
Definition: cpl_vsil_curl_streaming.cpp:2078
char * VSIStrdup(const char *) CPL_WARN_UNUSED_RESULT
Analog of strdup().
Definition: cpl_vsisimple.cpp:991
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2041
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:925

Generated for GDAL by doxygen 1.8.8.