GDAL
cpl_vsi.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id$
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"
36 
55 /* -------------------------------------------------------------------- */
56 /* We need access to ``struct stat''. */
57 /* -------------------------------------------------------------------- */
58 
59 /* Unix */
60 #if !defined(_WIN32)
61 # include <unistd.h>
62 #endif
63 
64 /* Windows */
65 #include <sys/stat.h>
66 
68 
70 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
71 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
72 #else
73 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
74 #endif
75 
77 /* ==================================================================== */
78 /* stdio file access functions. These do not support large */
79 /* files, and do not go through the virtualization API. */
80 /* ==================================================================== */
81 
84 FILE CPL_DLL * VSIFOpen( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
85 int CPL_DLL VSIFClose( FILE * );
86 int CPL_DLL VSIFSeek( FILE *, long, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
87 long CPL_DLL VSIFTell( FILE * ) CPL_WARN_UNUSED_RESULT;
88 void CPL_DLL VSIRewind( FILE * );
89 void CPL_DLL VSIFFlush( FILE * );
90 
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;
95 int CPL_DLL VSIFPrintf( FILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
96 
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;
101 
104 /* ==================================================================== */
105 /* VSIStat() related. */
106 /* ==================================================================== */
107 
109 typedef struct stat VSIStatBuf;
110 int CPL_DLL VSIStat( const char *, VSIStatBuf * ) CPL_WARN_UNUSED_RESULT;
113 #ifdef _WIN32
114 # define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */
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 ) /* N/A on Windows */
119 #else
120 
121 # define VSI_ISLNK(x) S_ISLNK(x)
122 
123 # define VSI_ISREG(x) S_ISREG(x)
124 
125 # define VSI_ISDIR(x) S_ISDIR(x)
126 
127 # define VSI_ISCHR(x) S_ISCHR(x)
128 # define VSI_ISBLK(x) S_ISBLK(x)
129 
130 #endif
131 
132 /* ==================================================================== */
133 /* 64bit stdio file access functions. If we have a big size */
134 /* defined, then provide prototypes for the large file API, */
135 /* otherwise redefine to use the regular api. */
136 /* ==================================================================== */
137 
141 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
142 
144 /* Make VSIL_STRICT_ENFORCE active in DEBUG builds */
145 #ifdef DEBUG
146 #define VSIL_STRICT_ENFORCE
147 #endif
148 
150 #ifdef VSIL_STRICT_ENFORCE
151 
152 typedef struct _VSILFILE VSILFILE;
153 #else
154 
155 typedef FILE VSILFILE;
156 #endif
157 
158 VSILFILE CPL_DLL * VSIFOpenL( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
159 VSILFILE CPL_DLL * VSIFOpenExL( const char *, const char *, int ) CPL_WARN_UNUSED_RESULT;
160 int CPL_DLL VSIFCloseL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
161 int CPL_DLL VSIFSeekL( VSILFILE *, vsi_l_offset, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
162 vsi_l_offset CPL_DLL VSIFTellL( VSILFILE * ) CPL_WARN_UNUSED_RESULT;
163 void CPL_DLL VSIRewindL( VSILFILE * );
164 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
165 int CPL_DLL VSIFReadMultiRangeL( int nRanges, void ** ppData, const vsi_l_offset* panOffsets, const size_t* panSizes, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
166 size_t CPL_DLL VSIFWriteL( const void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
167 int CPL_DLL VSIFEofL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
168 int CPL_DLL VSIFTruncateL( VSILFILE *, vsi_l_offset ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
169 int CPL_DLL VSIFFlushL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
170 int CPL_DLL VSIFPrintfL( VSILFILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
171 int CPL_DLL VSIFPutcL( int, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
172 
174 typedef enum
175 {
180 
181 VSIRangeStatus CPL_DLL VSIFGetRangeStatusL( VSILFILE * fp, vsi_l_offset nStart, vsi_l_offset nLength );
182 
183 int CPL_DLL VSIIngestFile( VSILFILE* fp,
184  const char* pszFilename,
185  GByte** ppabyRet,
186  vsi_l_offset* pnSize,
187  GIntBig nMaxSize ) CPL_WARN_UNUSED_RESULT;
188 
189 #if defined(VSI_STAT64_T)
190 
191 typedef struct VSI_STAT64_T VSIStatBufL;
192 #else
193 
194 #define VSIStatBufL VSIStatBuf
195 #endif
196 
197 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ) CPL_WARN_UNUSED_RESULT;
198 
200 #define VSI_STAT_EXISTS_FLAG 0x1
201 
202 #define VSI_STAT_NATURE_FLAG 0x2
203 
204 #define VSI_STAT_SIZE_FLAG 0x4
205 
206 #define VSI_STAT_SET_ERROR_FLAG 0x8
207 
208 int CPL_DLL VSIStatExL( const char * pszFilename, VSIStatBufL * psStatBuf, int nFlags ) CPL_WARN_UNUSED_RESULT;
209 
210 int CPL_DLL VSIIsCaseSensitiveFS( const char * pszFilename );
211 
212 int CPL_DLL VSISupportsSparseFiles( const char* pszPath );
213 
214 int CPL_DLL VSIHasOptimizedReadMultiRange( const char* pszPath );
215 
216 const char CPL_DLL *VSIGetActualURL( const char* pszFilename );
217 
218 char CPL_DLL *VSIGetSignedURL( const char* pszFilename, CSLConstList papszOptions );
219 
220 const char CPL_DLL *VSIGetFileSystemOptions( const char* pszFilename );
221 
222 char CPL_DLL **VSIGetFileSystemsPrefixes( void );
223 
224 void CPL_DLL *VSIFGetNativeFileDescriptorL( VSILFILE* );
225 
226 /* ==================================================================== */
227 /* Memory allocation */
228 /* ==================================================================== */
229 
230 void CPL_DLL *VSICalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
231 void CPL_DLL *VSIMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
232 void CPL_DLL VSIFree( void * );
233 void CPL_DLL *VSIRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
234 char CPL_DLL *VSIStrdup( const char * ) CPL_WARN_UNUSED_RESULT;
235 
236 void CPL_DLL *VSIMallocAligned( size_t nAlignment, size_t nSize ) CPL_WARN_UNUSED_RESULT;
237 void CPL_DLL *VSIMallocAlignedAuto( size_t nSize ) CPL_WARN_UNUSED_RESULT;
238 void CPL_DLL VSIFreeAligned( void* ptr );
239 
240 void CPL_DLL *VSIMallocAlignedAutoVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
242 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
243 
251 void CPL_DLL *VSIMalloc2( size_t nSize1, size_t nSize2 ) CPL_WARN_UNUSED_RESULT;
252 
260 void CPL_DLL *VSIMalloc3( size_t nSize1, size_t nSize2, size_t nSize3 ) CPL_WARN_UNUSED_RESULT;
261 
263 void CPL_DLL *VSIMallocVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
265 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
266 
268 void CPL_DLL *VSIMalloc2Verbose( size_t nSize1, size_t nSize2, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
270 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
271 
273 void CPL_DLL *VSIMalloc3Verbose( size_t nSize1, size_t nSize2, size_t nSize3, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
275 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
276 
278 void CPL_DLL *VSICallocVerbose( size_t nCount, size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
280 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
281 
283 void CPL_DLL *VSIReallocVerbose( void* pOldPtr, size_t nNewSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
285 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
286 
288 char CPL_DLL *VSIStrdupVerbose( const char* pszStr, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
290 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
291 
292 GIntBig CPL_DLL CPLGetPhysicalRAM(void);
293 GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
294 
295 /* ==================================================================== */
296 /* Other... */
297 /* ==================================================================== */
298 
300 #define CPLReadDir VSIReadDir
301 char CPL_DLL **VSIReadDir( const char * );
302 char CPL_DLL **VSIReadDirRecursive( const char *pszPath );
303 char CPL_DLL **VSIReadDirEx( const char *pszPath, int nMaxFiles );
304 int CPL_DLL VSIMkdir( const char * pszPathname, long mode );
305 int CPL_DLL VSIMkdirRecursive( const char * pszPathname, long mode );
306 int CPL_DLL VSIRmdir( const char * pszDirname );
307 int CPL_DLL VSIRmdirRecursive( const char * pszDirname );
308 int CPL_DLL VSIUnlink( const char * pszFilename );
309 int CPL_DLL VSIRename( const char * oldpath, const char * newpath );
310 char CPL_DLL *VSIStrerror( int );
311 GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
312 
313 /* ==================================================================== */
314 /* Install special file access handlers. */
315 /* ==================================================================== */
316 void CPL_DLL VSIInstallMemFileHandler(void);
318 void CPL_DLL VSIInstallLargeFileHandler(void);
320 void CPL_DLL VSIInstallSubFileHandler(void);
321 void VSIInstallCurlFileHandler(void);
322 void CPL_DLL VSICurlClearCache(void);
324 void VSIInstallS3FileHandler(void);
326 void VSIInstallGSFileHandler(void);
328 void VSIInstallAzureFileHandler(void);
330 void VSIInstallOSSFileHandler(void);
332 void VSIInstallSwiftFileHandler(void);
334 void VSIInstallGZipFileHandler(void); /* No reason to export that */
335 void VSIInstallZipFileHandler(void); /* No reason to export that */
336 void VSIInstallStdinHandler(void); /* No reason to export that */
337 void VSIInstallStdoutHandler(void); /* No reason to export that */
338 void CPL_DLL VSIInstallSparseFileHandler(void);
339 void VSIInstallTarFileHandler(void); /* No reason to export that */
340 void CPL_DLL VSIInstallCryptFileHandler(void);
341 void CPL_DLL VSISetCryptKey(const GByte* pabyKey, int nKeySize);
343 void CPL_DLL VSICleanupFileManager(void);
346 VSILFILE CPL_DLL *VSIFileFromMemBuffer( const char *pszFilename,
347  GByte *pabyData,
348  vsi_l_offset nDataLength,
349  int bTakeOwnership ) CPL_WARN_UNUSED_RESULT;
350 GByte CPL_DLL *VSIGetMemFileBuffer( const char *pszFilename,
351  vsi_l_offset *pnDataLength,
352  int bUnlinkAndSeize );
353 
355 typedef size_t (*VSIWriteFunction)(const void* ptr, size_t size, size_t nmemb, FILE* stream);
356 void CPL_DLL VSIStdoutSetRedirection( VSIWriteFunction pFct, FILE* stream );
357 
358 /* ==================================================================== */
359 /* Time querying. */
360 /* ==================================================================== */
361 
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 );
372 /* -------------------------------------------------------------------- */
373 /* the following can be turned on for detailed logging of */
374 /* almost all IO calls. */
375 /* -------------------------------------------------------------------- */
376 #ifdef VSI_DEBUG
377 
378 #ifndef DEBUG
379 # define DEBUG
380 #endif
381 
382 #include "cpl_error.h"
383 
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 );
388 #else
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 ) {}
393 #endif
394 
396 CPL_C_END
397 
398 #endif /* ndef CPL_VSI_H_INCLUDED */
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:174
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1369
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1155
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:558
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1053
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:597
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1696
Core portability definitions for CPL.
vsi_l_offset VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT
Tell current file offset.
Definition: cpl_vsil.cpp:1031
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:335
Hole.
Definition: cpl_vsi.h:178
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
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:1306
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:155
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:1500
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8497
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:975
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1411
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:1146
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:951
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:1460
Data present.
Definition: cpl_vsi.h:177
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:1129
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:681
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:904
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl) ...
Definition: cpl_vsil_curl_streaming.cpp:2120
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:938
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 VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:444
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:492
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8515
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2083
VSILFILE * VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:818
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:421
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:1739
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1224
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1347
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:578
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2652
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:647
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:191
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:928
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1260
Unknown.
Definition: cpl_vsi.h:176
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:703
void * VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1116
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
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1717
CPL error handling services.
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:547
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1205
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1184
void * VSIMallocAligned(size_t nAlignment, size_t nSize) CPL_WARN_UNUSED_RESULT
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:892
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1813
int VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:558
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:249
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:1242
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1094
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:8588
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:355
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:2022
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:988
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:733
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8464
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:919
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1138
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:1180
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:139
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl) ...
Definition: cpl_vsil_curl.cpp:8550
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
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1374
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl) ...
Definition: cpl_vsil_curl.cpp:8567
void * VSICalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Analog of calloc().
Definition: cpl_vsisimple.cpp:444
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8533
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:337
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:246
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:827
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:972
VSILFILE * VSIFOpenExL(const char *, const char *, int) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:872
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:205
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:2157
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streamin/ OpenStack Swif Object Storage (Swift) file system handler (requires libcu...
Definition: cpl_vsil_curl_streaming.cpp:2176
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl) ...
Definition: cpl_vsil_curl_streaming.cpp:2138
char * VSIStrdup(const char *) CPL_WARN_UNUSED_RESULT
Analog of strdup().
Definition: cpl_vsisimple.cpp:995
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2101
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:929
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:780

Generated for GDAL by doxygen 1.8.8.