1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/******************************************************************************
*
* Project: CPL - Common Portability Library
* Purpose: Declarations for vsi filesystem plugin handlers
* Author: Thomas Bonfort <thomas.bonfort@airbus.com>
*
******************************************************************************
* Copyright (c) 2019, Thomas Bonfort <thomas.bonfort@airbus.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#ifndef CPL_VSIL_PLUGIN_H_INCLUDED
#define CPL_VSIL_PLUGIN_H_INCLUDED
#include "cpl_port.h"
#include "cpl_string.h"
#include "cpl_vsi.h"
#include "cpl_vsi_virtual.h"
//! @cond Doxygen_Suppress
namespace cpl
{
/************************************************************************/
/* VSIPluginFilesystemHandler */
/************************************************************************/
class VSIPluginHandle;
class VSIPluginFilesystemHandler : public VSIFilesystemHandler
{
CPL_DISALLOW_COPY_ASSIGN(VSIPluginFilesystemHandler)
private:
const char *m_Prefix;
const VSIFilesystemPluginCallbacksStruct *m_cb;
protected:
friend class VSIPluginHandle;
VSIPluginHandle *CreatePluginHandle(void *cbData);
const char *GetCallbackFilename(const char *pszFilename);
bool IsValidFilename(const char *pszFilename);
vsi_l_offset Tell(void *pFile);
int Seek(void *pFile, vsi_l_offset nOffset, int nWhence);
size_t Read(void *pFile, void *pBuffer, size_t nSize, size_t nCount);
int ReadMultiRange(void *pFile, int nRanges, void **ppData,
const vsi_l_offset *panOffsets, const size_t *panSizes);
VSIRangeStatus GetRangeStatus(void *pFile, vsi_l_offset nOffset,
vsi_l_offset nLength);
int Eof(void *pFile);
size_t Write(void *pFile, const void *pBuffer, size_t nSize, size_t nCount);
int Flush(void *pFile);
int Truncate(void *pFile, vsi_l_offset nNewSize);
int Close(void *pFile);
public:
VSIPluginFilesystemHandler(const char *pszPrefix,
const VSIFilesystemPluginCallbacksStruct *cb);
~VSIPluginFilesystemHandler() override;
VSIVirtualHandle *Open(const char *pszFilename, const char *pszAccess,
bool bSetError,
CSLConstList /* papszOptions */) override;
int Stat(const char *pszFilename, VSIStatBufL *pStatBuf,
int nFlags) override;
int Unlink(const char *pszFilename) override;
int Rename(const char *oldpath, const char * /*newpath*/) override;
int Mkdir(const char *pszDirname, long nMode) override;
int Rmdir(const char *pszDirname) override;
char **ReadDir(const char *pszDirname) override
{
return ReadDirEx(pszDirname, 0);
}
char **ReadDirEx(const char *pszDirname, int nMaxFiles) override;
char **SiblingFiles(const char *pszFilename) override;
int HasOptimizedReadMultiRange(const char *pszPath) override;
};
/************************************************************************/
/* VSIPluginHandle */
/************************************************************************/
class VSIPluginHandle : public VSIVirtualHandle
{
CPL_DISALLOW_COPY_ASSIGN(VSIPluginHandle)
protected:
VSIPluginFilesystemHandler *poFS;
void *cbData;
public:
VSIPluginHandle(VSIPluginFilesystemHandler *poFS, void *cbData);
~VSIPluginHandle() override;
vsi_l_offset Tell() override;
int Seek(vsi_l_offset nOffset, int nWhence) override;
size_t Read(void *pBuffer, size_t nSize, size_t nCount) override;
int ReadMultiRange(int nRanges, void **ppData,
const vsi_l_offset *panOffsets,
const size_t *panSizes) override;
VSIRangeStatus GetRangeStatus(vsi_l_offset nOffset,
vsi_l_offset nLength) override;
int Eof() override;
size_t Write(const void *pBuffer, size_t nSize, size_t nCount) override;
int Flush() override;
int Truncate(vsi_l_offset nNewSize) override;
int Close() override;
};
} // namespace cpl
//! @endcond
#endif // CPL_VSIL_PLUGIN_H_INCLUDED
|
