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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
/* -------------------------------------------
Copyright SoftwareLabs
------------------------------------------- */
/* -------------------------------------------
Revision History:
31/01/24: Update documentation (amlel)
------------------------------------------- */
#pragma once
#ifdef __FSKIT_NEWFS__
#include <FSKit/NewFS.hxx>
#endif // __FSKIT_NEWFS__
#include <CompilerKit/CompilerKit.hxx>
#include <HintKit/CompilerHint.hxx>
#include <NewKit/Ref.hpp>
#include <NewKit/Stream.hpp>
/// @brief Filesystem abstraction manager.
/// Works like the VFS or IFS.
#define kBootFolder "/Boot"
#define kBinFolder "/Applications"
#define kShLibsFolder "/Library"
#define kMountFolder "/Mount"
/// refer to first enum.
#define kFileOpsCount 4
#define kFileMimeGeneric "application-type/*"
namespace NewOS
{
enum
{
kFileWriteAll = 100,
kFileReadAll = 101,
kFileReadChunk = 102,
kFileWriteChunk = 103,
kFileIOCnt = (kFileWriteChunk - kFileWriteAll) + 1,
};
typedef VoidPtr NodePtr;
/**
@brief Filesystem Manager Interface class
@brief Used to provide common I/O for a specific filesystem.
*/
class FilesystemManagerInterface
{
public:
FilesystemManagerInterface() = default;
virtual ~FilesystemManagerInterface() = default;
public:
NEWOS_COPY_DEFAULT(FilesystemManagerInterface);
public:
/// @brief Mounts a new filesystem into an active state.
/// @param interface the filesystem interface
/// @return
static bool Mount(FilesystemManagerInterface* interface);
/// @brief Unmounts the active filesystem
/// @return
static FilesystemManagerInterface* Unmount();
/// @brief Getter, gets the active filesystem.
/// @return
static FilesystemManagerInterface* GetMounted();
public:
virtual NodePtr Create(_Input const char* path) = 0;
virtual NodePtr CreateAlias(_Input const char* path) = 0;
virtual NodePtr CreateDirectory(_Input const char* path) = 0;
public:
virtual bool Remove(_Input const char* path) = 0;
public:
virtual NodePtr Open(_Input const char* path, _Input const char* r) = 0;
public:
virtual Void Write(_Input NodePtr node, _Input VoidPtr data, _Input Int32 flags, _Input SizeT size) = 0;
virtual _Output VoidPtr Read(_Input NodePtr node, _Input Int32 flags, _Input SizeT sz) = 0;
public:
virtual bool Seek(_Input NodePtr node, _Input SizeT off) = 0;
public:
virtual SizeT Tell(_Input NodePtr node) = 0;
virtual bool Rewind(_Input NodePtr node) = 0;
};
/** @brief invalid position. (n-pos) */
#define kNPos (SizeT)(-1);
#ifdef __FSKIT_NEWFS__
/**
* @brief Based of FilesystemManagerInterface, takes care of managing NewFS
* disks.
*/
class NewFilesystemManager final : public FilesystemManagerInterface
{
public:
explicit NewFilesystemManager();
~NewFilesystemManager() override;
public:
NEWOS_COPY_DEFAULT(NewFilesystemManager);
public:
NodePtr Create(const char* path) override;
NodePtr CreateAlias(const char* path) override;
NodePtr CreateDirectory(const char* path) override;
public:
bool Remove(const char* path) override;
NodePtr Open(const char* path, const char* r) override;
Void Write(NodePtr node, VoidPtr data, Int32 flags, SizeT sz) override;
VoidPtr Read(NodePtr node, Int32 flags, SizeT sz) override;
bool Seek(NodePtr node, SizeT off);
SizeT Tell(NodePtr node) override;
bool Rewind(NodePtr node) override;
public:
void SetResourceFork(const char* forkName);
void SetDataFork(const char* forkName);
NewFSParser* GetImpl() noexcept;
private:
Char fDataFork[kNewFSForkNameLen] = {0};
Char fRsrcFork[kNewFSForkNameLen] = {0};
NewFSParser* fImpl{nullptr};
};
#endif // ifdef __FSKIT_NEWFS__
/**
* Usable FileStream
* @tparam Encoding file encoding (char, wchar_t...)
* @tparam FSClass Filesystem contract who takes care of it.
*/
template <typename Encoding = char,
typename FSClass = FilesystemManagerInterface>
class FileStream final
{
public:
explicit FileStream(const Encoding* path, const Encoding* restrict_type);
~FileStream();
public:
FileStream& operator=(const FileStream&);
FileStream(const FileStream&);
public:
ErrorOr<Int64> WriteAll(const VoidPtr data) noexcept
{
if (data == nullptr)
return ErrorOr<Int64>(kErrorInvalidData);
auto man = FSClass::GetMounted();
if (man)
{
man->Write(fFile, data, kFileWriteAll);
return ErrorOr<Int64>(0);
}
return ErrorOr<Int64>(kErrorInvalidData);
}
VoidPtr Read() noexcept
{
auto man = FSClass::GetMounted();
if (man)
{
VoidPtr ret = man->Read(fFile, kFileReadAll, 0);
return ret;
}
return nullptr;
}
voidPtr Read(SizeT offset, SizeT sz)
{
auto man = FSClass::GetMounted();
if (man)
{
man->Seek(fFile, offset);
auto ret = man->Read(fFile, kFileReadChunk, sz);
return ret;
}
return nullptr;
}
Void Write(SizeT offset, voidPtr data, SizeT sz)
{
auto man = FSClass::GetMounted();
if (man)
{
man->Seek(fFile, offset);
man->Write(fFile, data, sz, kFileReadChunk);
}
}
/// @brief Leak node pointer.
/// @return The node pointer.
NodePtr Leak()
{
return fFile;
}
public:
char* MIME() noexcept
{
return const_cast<char*>(fMime);
}
private:
NodePtr fFile;
const Char* fMime{kFileMimeGeneric};
};
#define kRestrictR "r"
#define kRestrictRB "rb"
#define kRestrictW "w"
#define kRestrictRW "rw"
using FileStreamUTF8 = FileStream<Char>;
using FileStreamUTF16 = FileStream<WideChar>;
typedef UInt64 CursorType;
template <typename Encoding, typename Class>
FileStream<Encoding, Class>::FileStream(const Encoding* path,
const Encoding* restrict_type)
: fFile(Class::GetMounted()->Open(path, restrict_type))
{
}
template <typename Encoding, typename Class>
FileStream<Encoding, Class>::~FileStream() = default;
} // namespace NewOS
#define node_cast(PTR) reinterpret_cast<NewOS::NodePtr>(PTR)
|
