34 #ifndef CPL_VSI_VIRTUAL_H_INCLUDED
35 #define CPL_VSI_VIRTUAL_H_INCLUDED
38 #include "cpl_vsi_error.h"
40 #include "cpl_multiproc.h"
47 #ifdef GetDiskFreeSpace
48 #undef GetDiskFreeSpace
60 virtual size_t Read(
void *pBuffer,
size_t nSize,
size_t nCount ) = 0;
63 const size_t* panSizes );
64 virtual size_t Write(
const void *pBuffer,
size_t nSize,
size_t nCount)=0;
65 virtual int Eof() = 0;
83 class CPL_DLL VSIFilesystemHandler {
87 virtual ~VSIFilesystemHandler() {}
90 const char *pszAccess );
93 const char *pszAccess,
95 virtual int Stat(
const char *pszFilename,
VSIStatBufL *pStatBuf,
int nFlags) = 0;
96 virtual int Unlink(
const char *pszFilename )
97 { (void) pszFilename; errno=ENOENT;
return -1; }
99 virtual int Mkdir(
const char *pszDirname,
long nMode )
100 {(void)pszDirname; (void)nMode; errno=ENOENT;
return -1;}
101 virtual int Rmdir(
const char *pszDirname )
102 { (void) pszDirname; errno=ENOENT;
return -1; }
103 virtual int RmdirRecursive(
const char *pszDirname );
104 virtual char **ReadDir(
const char *pszDirname )
105 { (void) pszDirname;
return nullptr; }
106 virtual char **ReadDirEx(
const char *pszDirname,
int )
107 {
return ReadDir(pszDirname); }
108 virtual char **SiblingFiles(
const char * )
110 virtual int Rename(
const char *oldpath,
const char *newpath )
111 { (void) oldpath; (void)newpath; errno=ENOENT;
return -1; }
112 virtual int IsCaseSensitive(
const char* pszFilename )
113 { (void) pszFilename;
return TRUE; }
114 virtual GIntBig GetDiskFreeSpace(
const char* ) {
return -1; }
115 virtual int SupportsSparseFiles(
const char* ) {
return FALSE; }
116 virtual int HasOptimizedReadMultiRange(
const char* ) {
return FALSE; }
117 virtual const char* GetActualURL(
const char* ) {
return nullptr; }
118 virtual const char* GetOptions() {
return nullptr; }
119 virtual char* GetSignedURL(
const char* ,
CSLConstList ) {
return nullptr; }
120 virtual bool Sync(
const char* pszSource,
const char* pszTarget,
121 const char*
const * papszOptions,
122 GDALProgressFunc pProgressFunc,
124 char*** ppapszOutputs );
126 virtual VSIDIR* OpenDir(
const char *pszPath,
int nRecurseDepth,
127 const char*
const *papszOptions);
129 virtual char** GetFileMetadata(
const char * pszFilename,
const char* pszDomain,
132 virtual bool SetFileMetadata(
const char * pszFilename,
134 const char* pszDomain,
144 class CPL_DLL VSIFileManager
147 VSIFilesystemHandler *poDefaultHandler =
nullptr;
148 std::map<std::string, VSIFilesystemHandler *> oHandlers{};
152 static VSIFileManager *Get();
159 static VSIFilesystemHandler *GetHandler(
const char * );
160 static void InstallHandler(
const std::string& osPrefix,
161 VSIFilesystemHandler * );
165 static char** GetPrefixes();
177 class VSIArchiveEntryFileOffset
180 virtual ~VSIArchiveEntryFileOffset();
187 VSIArchiveEntryFileOffset* file_pos;
192 class VSIArchiveContent
198 VSIArchiveEntry* entries =
nullptr;
200 ~VSIArchiveContent();
203 class VSIArchiveReader
206 virtual ~VSIArchiveReader();
208 virtual int GotoFirstFile() = 0;
209 virtual int GotoNextFile() = 0;
210 virtual VSIArchiveEntryFileOffset* GetFileOffset() = 0;
213 virtual GIntBig GetModifiedTime() = 0;
214 virtual int GotoFileOffset(VSIArchiveEntryFileOffset* pOffset) = 0;
217 class VSIArchiveFilesystemHandler :
public VSIFilesystemHandler
222 CPLMutex* hMutex =
nullptr;
226 std::map<CPLString,VSIArchiveContent*> oFileList{};
228 virtual const char* GetPrefix() = 0;
229 virtual std::vector<CPLString> GetExtensions() = 0;
230 virtual VSIArchiveReader* CreateReader(
const char* pszArchiveFileName) = 0;
233 VSIArchiveFilesystemHandler();
234 virtual ~VSIArchiveFilesystemHandler();
236 int Stat(
const char *pszFilename,
VSIStatBufL *pStatBuf,
237 int nFlags )
override;
238 int Unlink(
const char *pszFilename )
override;
239 int Rename(
const char *oldpath,
const char *newpath )
override;
240 int Mkdir(
const char *pszDirname,
long nMode )
override;
241 int Rmdir(
const char *pszDirname )
override;
242 char **ReadDirEx(
const char *pszDirname,
int nMaxFiles )
override;
244 virtual const VSIArchiveContent* GetContentOfArchive(
const char* archiveFilename, VSIArchiveReader* poReader =
nullptr);
245 virtual char* SplitFilename(
const char *pszFilename,
CPLString &osFileInArchive,
int bCheckMainFileExists);
246 virtual VSIArchiveReader* OpenArchiveFile(
const char* archiveFilename,
const char* fileInArchiveName);
247 virtual int FindFileInArchive(
const char* archiveFilename,
const char* fileInArchiveName,
const VSIArchiveEntry** archiveEntry);
270 const GByte* pabyBeginningContent,
274 const int CPL_DEFLATE_TYPE_GZIP = 0;
275 const int CPL_DEFLATE_TYPE_ZLIB = 1;
276 const int CPL_DEFLATE_TYPE_RAW_DEFLATE = 2;
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
virtual int Truncate(vsi_l_offset nNewSize)
Truncate/expand the file to the specified size.
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:176
virtual int Close()=0
Close file.
Convenient string class based on std::string.
Definition: cpl_string.h:333
virtual int Flush()
Flush pending writes to disk.
Definition: cpl_vsi_virtual.h:66
virtual int ReadMultiRange(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes)
Read several ranges of bytes from file.
virtual vsi_l_offset Tell()=0
Tell current file offset.
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:177
virtual size_t Read(void *pBuffer, size_t nSize, size_t nCount)=0
Read bytes from file.
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1216
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
virtual VSIRangeStatus GetRangeStatus(vsi_l_offset nOffset, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsi_virtual.h:71
Directory entry.
Definition: cpl_vsi.h:330
Various convenience functions for working with strings and string lists.
virtual size_t Write(const void *pBuffer, size_t nSize, size_t nCount)=0
Write bytes to file.
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:140
virtual int Eof()=0
Test for end of file.
struct VSI_STAT64_T VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:194
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
#define CPL_UNUSED
Qualifier for an argument that is unused.
Definition: cpl_port.h:955
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:318
Virtual file handle.
Definition: cpl_vsi_virtual.h:56
virtual void * GetNativeFileDescriptor()
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsi_virtual.h:70
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:1007
virtual int Seek(vsi_l_offset nOffset, int nWhence)=0
Seek to requested offset.