-
-
Notifications
You must be signed in to change notification settings - Fork 603
/
wiArchive.h
474 lines (452 loc) · 12.1 KB
/
wiArchive.h
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
#pragma once
#include "CommonInclude.h"
#include "wiMath.h"
#include "wiVector.h"
#include "wiColor.h"
#include "wiGraphics.h"
#include <string>
namespace wi
{
// This is a data container used for serialization purposes.
// It can be used to READ or WRITE data, but not both at the same time.
// An archive that was created in WRITE mode can be changed to read mode and vica-versa
// The data flow is always FIFO (first in, first out)
class Archive
{
private:
uint64_t version = 0; // the version number is used for maintaining backwards compatibility with earlier archive versions
bool readMode = false; // archive can be either read or write mode, but not both
size_t pos = 0; // position of the next memory operation, relative to the data's beginning
wi::vector<uint8_t> DATA; // data suitable for read/write operations
const uint8_t* data_ptr = nullptr; // this can either be a memory mapped pointer (read only), or the DATA's pointer
size_t data_ptr_size = 0;
std::string fileName; // save to this file on closing if not empty
std::string directory; // the directory part from the fileName
size_t thumbnail_data_size = 0;
const uint8_t* thumbnail_data_ptr = nullptr;
void CreateEmpty(); // creates new archive in write mode
public:
// Create empty archive for writing
Archive();
Archive(const Archive&) = default;
Archive(Archive&&) = default;
// Create archive from a file.
// If readMode == true, the whole file will be loaded into the archive in read mode
// If readMode == false, the file will be written when the archive is destroyed or Close() is called
Archive(const std::string& fileName, bool readMode = true);
// Creates a memory mapped archive in read mode
Archive(const uint8_t* data, size_t size);
~Archive() { Close(); }
Archive& operator=(const Archive&) = default;
Archive& operator=(Archive&&) = default;
void WriteData(wi::vector<uint8_t>& dest) const { dest.resize(pos); std::memcpy(dest.data(), data_ptr, pos); }
const uint8_t* GetData() const { return data_ptr; }
const size_t GetSize() const { return data_ptr_size; }
size_t GetPos() const { return pos; }
constexpr uint64_t GetVersion() const { return version; }
constexpr bool IsReadMode() const { return readMode; }
// This can set the archive into either read or write mode, and it will reset it's position
void SetReadModeAndResetPos(bool isReadMode);
// Check if the archive has any data
bool IsOpen() const { return data_ptr != nullptr; };
// Close the archive.
// If it was opened from a file in write mode, the file will be written at this point
// The data will be deleted, the archive will be empty after this
void Close();
// Write the archive contents to a specific file
// The archive data will be written starting from the beginning, to the current position
bool SaveFile(const std::string& fileName);
// Write the archive contents into a C++ header file
// dataName : it will be the name of the byte data array in the header, that can be memory mapped
bool SaveHeaderFile(const std::string& fileName, const std::string& dataName);
// If the archive was opened from a file, this will return the file's directory
const std::string& GetSourceDirectory() const;
// If the archive was opened from a file, this will return the file's name
// The file's name will include the directory as well
const std::string& GetSourceFileName() const;
// If Archive contains thumbnail image data, then creates a Texture from it:
wi::graphics::Texture CreateThumbnailTexture() const;
// Set a Texture as the thumbnail. This resets the archive, so you should usually do this before writing data:
void SetThumbnailAndResetPos(const wi::graphics::Texture& texture);
// Open just the tumbnail data from an archive, and return it as a Texture:
static wi::graphics::Texture PeekThumbnail(const std::string& filename);
// Appends the current archive write offset as uint64_t to the archive
// Returns the previous write offset of the archive, which can be used by PatchUnknownJumpPosition()
// to write the current archive position to that previous position
size_t WriteUnknownJumpPosition()
{
size_t pos_prev = pos;
_write(uint64_t(pos));
return pos_prev;
}
// Writes the current archive write offset to the specified archive write offset.
// It can be used with Jump() to skip parts of the archive when reading
void PatchUnknownJumpPosition(size_t offset)
{
assert(!readMode);
assert(!DATA.empty());
assert(offset + sizeof(uint64_t) < DATA.size());
*(uint64_t*)(DATA.data() + offset) = uint64_t(pos);
}
// Modifies the current archive offset
// It can be used in conjunction with WriteUnknownJumpPosition() and PatchUnknownJumpPosition()
void Jump(uint64_t jump_pos)
{
pos = jump_pos;
}
// This is like reading a vector<uint8_t>, but instead of copying the data, it returns the memory mapped pointer and size
inline void MapVector(const uint8_t*& data, size_t& size)
{
(*this) >> size;
data = data_ptr + pos;
pos += size;
}
// It could be templated but we have to be extremely careful of different datasizes on different platforms
// because serialized data should be interchangeable!
// So providing exact copy operations for exact types enforces platform agnosticism
// Write operations
inline Archive& operator<<(bool data)
{
_write((uint32_t)(data ? 1 : 0));
return *this;
}
inline Archive& operator<<(char data)
{
_write((int8_t)data);
return *this;
}
inline Archive& operator<<(short data)
{
_write((int16_t)data);
return *this;
}
inline Archive& operator<<(unsigned char data)
{
_write((uint8_t)data);
return *this;
}
inline Archive& operator<<(unsigned short data)
{
_write((uint16_t)data);
return *this;
}
inline Archive& operator<<(int data)
{
_write((int64_t)data);
return *this;
}
inline Archive& operator<<(unsigned int data)
{
_write((uint64_t)data);
return *this;
}
inline Archive& operator<<(long data)
{
_write((int64_t)data);
return *this;
}
inline Archive& operator<<(unsigned long data)
{
_write((uint64_t)data);
return *this;
}
inline Archive& operator<<(long long data)
{
_write((int64_t)data);
return *this;
}
inline Archive& operator<<(unsigned long long data)
{
_write((uint64_t)data);
return *this;
}
inline Archive& operator<<(float data)
{
_write(data);
return *this;
}
inline Archive& operator<<(double data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMFLOAT2& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMFLOAT3& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMFLOAT4& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMFLOAT3X3& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMFLOAT4X3& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMFLOAT4X4& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMUINT2& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMUINT3& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const XMUINT4& data)
{
_write(data);
return *this;
}
inline Archive& operator<<(const wi::Color& data)
{
_write(data.rgba);
return *this;
}
inline Archive& operator<<(const std::string& data)
{
(*this) << data.length();
for (const auto& x : data)
{
(*this) << x;
}
return *this;
}
template<typename T>
inline Archive& operator<<(const wi::vector<T>& data)
{
// Here we will use the << operator so that non-specified types will have compile error!
(*this) << data.size();
for (const T& x : data)
{
(*this) << x;
}
return *this;
}
inline Archive& operator<<(const wi::Archive& other)
{
// Here we will use the << operator so that non-specified types will have compile error!
// Note: version and thumbnail data is skipped, only data is appended
const size_t start = sizeof(uint64_t) * 2; // version and thumbnail size
for (size_t i = start; i < other.pos; ++i)
{
(*this) << other.data_ptr[i];
}
return *this;
}
// Read operations
inline Archive& operator>>(bool& data)
{
uint32_t temp;
_read(temp);
data = (temp == 1);
return *this;
}
inline Archive& operator>>(char& data)
{
int8_t temp;
_read(temp);
data = (char)temp;
return *this;
}
inline Archive& operator>>(short& data)
{
int16_t temp;
_read(temp);
data = (short)temp;
return *this;
}
inline Archive& operator>>(unsigned char& data)
{
uint8_t temp;
_read(temp);
data = (unsigned char)temp;
return *this;
}
inline Archive& operator>>(unsigned short& data)
{
uint16_t temp;
_read(temp);
data = (unsigned short)temp;
return *this;
}
inline Archive& operator>>(int& data)
{
int64_t temp;
_read(temp);
data = (int)temp;
return *this;
}
inline Archive& operator>>(unsigned int& data)
{
uint64_t temp;
_read(temp);
data = (unsigned int)temp;
return *this;
}
inline Archive& operator>>(long& data)
{
int64_t temp;
_read(temp);
data = (long)temp;
return *this;
}
inline Archive& operator>>(unsigned long& data)
{
uint64_t temp;
_read(temp);
data = (unsigned long)temp;
return *this;
}
inline Archive& operator>>(long long& data)
{
int64_t temp;
_read(temp);
data = (long long)temp;
return *this;
}
inline Archive& operator>>(unsigned long long& data)
{
uint64_t temp;
_read(temp);
data = (unsigned long long)temp;
return *this;
}
inline Archive& operator>>(float& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(double& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMFLOAT2& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMFLOAT3& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMFLOAT4& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMFLOAT3X3& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMFLOAT4X3& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMFLOAT4X4& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMUINT2& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMUINT3& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(XMUINT4& data)
{
_read(data);
return *this;
}
inline Archive& operator>>(wi::Color& data)
{
_read(data.rgba);
return *this;
}
inline Archive& operator>>(std::string& data)
{
uint64_t len;
(*this) >> len;
data.resize(len);
for (size_t i = 0; i < len; ++i)
{
(*this) >> data[i];
}
if (!data.empty() && GetVersion() < 73)
{
// earlier versions of archive saved the strings with 0 terminator
data.pop_back();
}
return *this;
}
template<typename T>
inline Archive& operator>>(wi::vector<T>& data)
{
// Here we will use the >> operator so that non-specified types will have compile error!
size_t count;
(*this) >> count;
data.resize(count);
for (size_t i = 0; i < count; ++i)
{
(*this) >> data[i];
}
return *this;
}
private:
// This should not be exposed to avoid misaligning data by mistake
// Any specific type serialization should be implemented by hand
// But these can be used as helper functions inside this class
// Write data using memory operations
template<typename T>
inline void _write(const T& data)
{
assert(!readMode);
assert(!DATA.empty());
const size_t _right = pos + sizeof(data);
if (_right > DATA.size())
{
DATA.resize(_right * 2);
data_ptr = DATA.data();
data_ptr_size = DATA.size();
}
*(T*)(DATA.data() + pos) = data;
pos = _right;
}
// Read data using memory operations
template<typename T>
inline void _read(T& data)
{
assert(readMode);
assert(data_ptr != nullptr);
assert(pos < data_ptr_size);
data = *(const T*)(data_ptr + pos);
pos += (size_t)(sizeof(data));
}
};
}