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 58 virtual int Seek(
vsi_l_offset nOffset,
int nWhence ) = 0;
60 virtual size_t Read(
void *pBuffer,
size_t nSize,
size_t nCount ) = 0;
61 virtual int ReadMultiRange(
int nRanges,
void ** ppData,
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;
67 virtual int Close() = 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; }
98 virtual int Mkdir(
const char *pszDirname,
long nMode )
99 {(void)pszDirname; (void)nMode; errno=ENOENT;
return -1;}
100 virtual int Rmdir(
const char *pszDirname )
101 { (void) pszDirname; errno=ENOENT;
return -1; }
102 virtual char **ReadDir(
const char *pszDirname )
103 { (void) pszDirname;
return NULL; }
104 virtual char **ReadDirEx(
const char *pszDirname,
int )
105 {
return ReadDir(pszDirname); }
106 virtual int Rename(
const char *oldpath,
const char *newpath )
107 { (void) oldpath; (void)newpath; errno=ENOENT;
return -1; }
108 virtual int IsCaseSensitive(
const char* pszFilename )
109 { (void) pszFilename;
return TRUE; }
110 virtual GIntBig GetDiskFreeSpace(
const char* ) {
return -1; }
111 virtual int SupportsSparseFiles(
const char* ) {
return FALSE; }
120 class CPL_DLL VSIFileManager
123 VSIFilesystemHandler *poDefaultHandler;
124 std::map<std::string, VSIFilesystemHandler *> oHandlers;
128 static VSIFileManager *Get();
133 static VSIFilesystemHandler *GetHandler(
const char * );
134 static void InstallHandler(
const std::string& osPrefix,
135 VSIFilesystemHandler * );
149 class VSIArchiveEntryFileOffset
152 virtual ~VSIArchiveEntryFileOffset();
159 VSIArchiveEntryFileOffset* file_pos;
164 class VSIArchiveContent
170 VSIArchiveEntry* entries;
172 VSIArchiveContent() : mTime(0), nFileSize(0), nEntries(0), entries(NULL) {}
173 ~VSIArchiveContent();
176 class VSIArchiveReader
179 virtual ~VSIArchiveReader();
181 virtual int GotoFirstFile() = 0;
182 virtual int GotoNextFile() = 0;
183 virtual VSIArchiveEntryFileOffset* GetFileOffset() = 0;
186 virtual GIntBig GetModifiedTime() = 0;
187 virtual int GotoFileOffset(VSIArchiveEntryFileOffset* pOffset) = 0;
190 class VSIArchiveFilesystemHandler :
public VSIFilesystemHandler
197 std::map<CPLString,VSIArchiveContent*> oFileList;
199 virtual const char* GetPrefix() = 0;
200 virtual std::vector<CPLString> GetExtensions() = 0;
201 virtual VSIArchiveReader* CreateReader(
const char* pszArchiveFileName) = 0;
204 VSIArchiveFilesystemHandler();
205 virtual ~VSIArchiveFilesystemHandler();
208 virtual int Unlink(
const char *pszFilename )
CPL_OVERRIDE;
209 virtual int Rename(
const char *oldpath,
const char *newpath )
CPL_OVERRIDE;
210 virtual int Mkdir(
const char *pszDirname,
long nMode )
CPL_OVERRIDE;
211 virtual int Rmdir(
const char *pszDirname )
CPL_OVERRIDE;
212 virtual char **ReadDirEx(
const char *pszDirname,
int nMaxFiles )
CPL_OVERRIDE;
214 virtual const VSIArchiveContent* GetContentOfArchive(
const char* archiveFilename, VSIArchiveReader* poReader = NULL);
215 virtual char* SplitFilename(
const char *pszFilename,
CPLString &osFileInArchive,
int bCheckMainFileExists);
216 virtual VSIArchiveReader* OpenArchiveFile(
const char* archiveFilename,
const char* fileInArchiveName);
217 virtual int FindFileInArchive(
const char* archiveFilename,
const char* fileInArchiveName,
const VSIArchiveEntry** archiveEntry);
224 const GByte* pabyBeginningContent,
VSIRangeStatus
Definition: cpl_vsi.h:173
#define CPL_OVERRIDE
Definition: cpl_port.h:1055
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
unsigned char GByte
Definition: cpl_port.h:207
Definition: cpl_vsi_virtual.h:56
virtual void * GetNativeFileDescriptor()
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsi_virtual.h:70
Convenient string class based on std::string.
Definition: cpl_string.h:338
Definition: cpl_vsi.h:175
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:190
unsigned long long GUIntBig
Definition: cpl_port.h:253
#define CPL_UNUSED
Definition: cpl_port.h:1008
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:138
long long GIntBig
Definition: cpl_port.h:250
virtual int Flush()
Flush pending writes to disk.
Definition: cpl_vsi_virtual.h:66