-
Notifications
You must be signed in to change notification settings - Fork 0
/
bomba_object.hpp
502 lines (445 loc) · 17.5 KB
/
bomba_object.hpp
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
#ifndef BOMBA_OBJECT
#define BOMBA_OBJECT
#ifndef BOMBA_CORE // Needed to run in godbolt
#include "bomba_core.hpp"
#endif
#include <algorithm>
#if (_MSC_VER && !__INTEL_COMPILER) || __clang__
#define NO_DEFECT_REPORT_2118
#endif
#ifdef NO_DEFECT_REPORT_2118
#include <vector>
#endif
namespace Bomba {
// Suppress GCC warnings that I should not do this
#ifdef __GNUC__
#ifndef __clang__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wnon-template-friend"
#endif
#endif
using SerialisingFunction = void(*)(IStructuredOutput& out, const ISerialisable* parent,
int order, int offset, SerialisationFlags::Flags flags);
using DeserialisingFunction = void(*)(IStructuredInput& in, ISerialisable* parent,
int offset, SerialisationFlags::Flags flags);
using DescribingFunction = void(*)(IPropertyDescriptionFiller& filler);
using TypeAddingFunction = void(*)(ISerialisableDescriptionFiller& filler);
template <typename T, StringLiteral Name>
void serialiseWithOffset(IStructuredOutput& out, const ISerialisable* parent,
int order, int offset, SerialisationFlags::Flags flags) {
T& member = *reinterpret_cast<T*>(uint64_t(parent) + offset);
out.introduceObjectMember(flags, Name, order);
TypedSerialiser<T>::serialiseMember(out, member, flags);
}
template <typename T, StringLiteral Name>
void deserialiseWithOffset(IStructuredInput& in, ISerialisable* parent,
int offset, SerialisationFlags::Flags flags) {
T& member = *reinterpret_cast<T*>(uint64_t(parent) + offset);
TypedSerialiser<T>::deserialiseMember(in, member, flags);
}
template <typename T, StringLiteral Name>
void describeMember(IPropertyDescriptionFiller& filler) {
filler.addMember(Name, "", [&] { TypedSerialiser<T>::describeType(filler); });
}
template <typename T>
void addMemberType(ISerialisableDescriptionFiller& filler) {
if constexpr(std::is_base_of_v<IDescribableSerialisable, T>) {
T instance;
filler.fillMembers(instance.getTypeName(), [&instance] (IPropertyDescriptionFiller& filler) {
instance.describe(filler);
});
}
}
#ifndef NO_DEFECT_REPORT_2118
template <typename Child, int Index>
struct SerialiserStorage {
friend constexpr SerialisingFunction serialiser(SerialiserStorage<Child, Index>);
friend constexpr DeserialisingFunction deserialiser(SerialiserStorage<Child, Index>);
friend constexpr DescribingFunction describer(SerialiserStorage<Child, Index>);
friend constexpr TypeAddingFunction typeAdder(SerialiserStorage<Child, Index>);
friend constexpr SerialisationFlags::Flags memberFlags(SerialiserStorage<Child, Index>);
friend constexpr auto name(SerialiserStorage<Child, Index>);
friend constexpr auto boolIfDeclared(SerialiserStorage<Child, Index>);
};
template <typename Child, int Index, SerialisingFunction Serialiser, DeserialisingFunction Deserialiser,
DescribingFunction Describer, TypeAddingFunction TypeAdder, StringLiteral Name, SerialisationFlags::Flags Flags>
struct SerialiserSaver {
friend constexpr SerialisingFunction serialiser(SerialiserStorage<Child, Index>) {
return Serialiser;
}
friend constexpr DeserialisingFunction deserialiser(SerialiserStorage<Child, Index>) {
return Deserialiser;
}
friend constexpr DescribingFunction describer(SerialiserStorage<Child, Index>) {
return Describer;
}
friend constexpr TypeAddingFunction typeAdder(SerialiserStorage<Child, Index>) {
return TypeAdder;
}
friend constexpr auto name(SerialiserStorage<Child, Index>) {
return Name;
}
friend constexpr SerialisationFlags::Flags memberFlags(SerialiserStorage<Child, Index>) {
return Flags;
}
friend constexpr auto boolIfDeclared(SerialiserStorage<Child, Index>) {
return true;
}
constexpr static bool instantiated = true;
};
template <typename Child, int Index /* set to 0*/, SerialisingFunction Serialiser,
DeserialisingFunction Deserialiser, DescribingFunction Describer, TypeAddingFunction TypeAdder,
StringLiteral Name, SerialisationFlags::Flags Flags, typename SFINAE = void>
struct addMember {
constexpr static bool done = SerialiserSaver<Child, Index, Serialiser, Deserialiser,
Describer, TypeAdder, Name, Flags>::instantiated;
};
template <typename Child, int Index, SerialisingFunction Serialiser,
DeserialisingFunction Deserialiser, DescribingFunction Describer, TypeAddingFunction TypeAdder,
StringLiteral Name, SerialisationFlags::Flags Flags>
struct addMember<Child, Index, Serialiser, Deserialiser, Describer, TypeAdder, Name, Flags, std::enable_if_t<
std::is_same_v<bool, decltype(boolIfDeclared(SerialiserStorage<Child, Index>()))>>> {
constexpr static bool done = addMember<Child, Index + 1, Serialiser, Deserialiser,
Describer, TypeAdder, Name, Flags, void>::done;
};
template <typename Child, int Index = 0, typename SFINAE = void>
struct ObjectInfo {
static void serialise(IStructuredOutput& out, const ISerialisable* parent, SerialisationFlags::Flags flags) {}
static void deserialise(IStructuredInput& in, ISerialisable* parent,
SerialisationFlags::Flags flags, std::optional<std::string_view> memberName, int index) {
in.skipObjectElement(flags);
}
static void describe(IPropertyDescriptionFiller&) {}
static void listTypes(ISerialisableDescriptionFiller&) {}
constexpr static int size = 0;
static std::array<int, size + Index>& getOffsets() {
static std::array<int, size + Index> offsets;
return offsets;
}
};
template <typename Child, int Index>
struct ObjectInfo<Child, Index, std::enable_if_t<
std::is_same_v<bool, decltype(boolIfDeclared(SerialiserStorage<Child, Index>()))>>> {
constexpr static SerialiserStorage<Child, Index> store = {};
static void serialise(IStructuredOutput& out, const ISerialisable* parent, SerialisationFlags::Flags flags) {
constexpr SerialiserStorage<Child, Index> store;
serialiser(store)(out, parent, Index, getOffsets()[Index],
SerialisationFlags::Flags(flags | memberFlags(store)));
ObjectInfo<Child, Index + 1, void>::serialise(out, parent, flags);
}
static void deserialise(IStructuredInput& in, ISerialisable* parent,
SerialisationFlags::Flags flags, std::optional<std::string_view> memberName, int index) {
if ((memberName.has_value() && *memberName == name(store)) || (!memberName.has_value() && index == Index))
deserialiser(store)(in, parent, getOffsets()[Index],
SerialisationFlags::Flags(flags | memberFlags(store)));
else
ObjectInfo<Child, Index + 1, void>::deserialise(in, parent, flags, memberName, index);
}
static void describe(IPropertyDescriptionFiller& filler) {
describer(store)(filler);
ObjectInfo<Child, Index + 1, void>::describe(filler);
}
static void listTypes(ISerialisableDescriptionFiller& filler) {
typeAdder(store)(filler);
ObjectInfo<Child, Index + 1, void>::listTypes(filler);
}
constexpr static int size = ObjectInfo<Child, Index + 1, void>::size + 1;
static std::array<int, size + Index>& getOffsets() {
if constexpr(Index == 0) {
static std::array<int, size> offsets;
return offsets;
} else {
return ObjectInfo<Child, 0>::getOffsets();
}
}
};
#ifdef __GNUC__
#ifndef __clang__
#pragma GCC diagnostic pop
#endif // __GNUC__
#endif // not __clang__
#endif // not NO_DEFECT_REPORT_2118
template <typename Child>
class Serialisable : public IDescribableSerialisable {
#ifdef NO_DEFECT_REPORT_2118
struct Information {
SerialisingFunction serialiser;
DeserialisingFunction deserialiser;
DescribingFunction describer;
TypeAddingFunction typeLister;
const char* name;
SerialisationFlags::Flags flags;
int offset;
};
#endif
constexpr static int8_t garbageNumber1 = 13;
constexpr static int8_t garbageNumber2 = -13;
struct MappingElement {
int size;
std::array<int, 2> lastInitialisedBefore;
const char* name;
};
enum class InitialisationState : uint8_t {
UNINITIALISED,
INITIALISING,
INITIALISING_AGAIN,
INITIALISED
};
struct SerialisationSetupData {
#ifdef NO_DEFECT_REPORT_2118
std::vector<Information>* result;
std::vector<MappingElement> elements;
#else
MappingElement* elements;
#endif
const Child* instance = nullptr;
int index = {};
int parentOffset = {};
InitialisationState initState = InitialisationState::UNINITIALISED;
};
static inline SerialisationSetupData* _setupInstance = nullptr;
#ifdef NO_DEFECT_REPORT_2118
static std::vector<Information> setup() {
std::vector<Information> result;
#else
static bool setup() {
constexpr int memberCount = ObjectInfo<Child>::size;
#endif
SerialisationSetupData setupData;
_setupInstance = &setupData;
#ifdef NO_DEFECT_REPORT_2118
setupData.result = &result;
#else
std::array<MappingElement, memberCount> mappingElements;
setupData.elements = mappingElements.data();
#endif
setupData.initState = InitialisationState::INITIALISING;
// Create the child class in specially prepared garbage
constexpr int allocatedSize = sizeof(Child) / sizeof(void*) + 1;
std::array<std::array<void*, allocatedSize>, 2> allocated; // Allocate as void* to have proper padding
std::array<int8_t*, 2> childBytes;
struct ChildDestroyer { // We must assure proper destruction of Child, even if an exception is thrown
Child* child = nullptr;
~ChildDestroyer() {
if (child)
child->~Child();
}
};
std::array<ChildDestroyer, 2> destroyers;
auto makeChild = [&] (int index) {
setupData.instance = reinterpret_cast<Child*>(&allocated[index]);
setupData.index = 0;
destroyers[index].child = new (&allocated[index]) Child();
childBytes[index] = reinterpret_cast<int8_t*>(destroyers[index].child);
};
makeChild(0);
setupData.parentOffset = reinterpret_cast<uint64_t>(
static_cast<const Serialisable<Child>*>(setupData.instance))
- reinterpret_cast<uint64_t>(setupData.instance);
// Do it again
setupData.initState = InitialisationState::INITIALISING_AGAIN;
makeChild(1);
// Check where garbage was left
#ifdef NO_DEFECT_REPORT_2118
int memberCount = result.size();
#else
std::array<int, memberCount>& offsets = ObjectInfo<Child>::getOffsets();
#endif
for (int i = 0; i < memberCount; i++) {
int start = std::max(setupData.elements[i].lastInitialisedBefore[0],
setupData.elements[i].lastInitialisedBefore[1]);
while (childBytes[0][start] == garbageNumber1 && childBytes[1][start] == garbageNumber2) {
if (start > int(sizeof(Child))) throw std::logic_error("Reflection failed");
start++;
}
#ifdef NO_DEFECT_REPORT_2118
result[i].offset = start;
#else
offsets[i] = start;
#endif
}
setupData.initState = InitialisationState::INITIALISED;
_setupInstance = nullptr;
#ifdef NO_DEFECT_REPORT_2118
result.shrink_to_fit();
return result;
#else
return true;
#endif
}
static inline auto _setup = setup();
template <StringLiteral Name, SerialisationFlags::Flags Flags, typename... Args>
class InitialiserInitialiser {
std::tuple<Args...> _args;
constexpr InitialiserInitialiser(Args... args) :
_args(std::make_tuple(args...)) {
}
template <typename T, size_t... Enumeration>
T makeType(std::index_sequence<Enumeration...>) const {
if constexpr(SerialisableOptionalBase<T> && SerialisableOptionalOrSmartPointer<T>
&& !std::is_constructible_v<T, decltype(std::get<Enumeration>(_args))...>) {
T value;
value = std::decay_t<decltype(*value)>(std::get<Enumeration>(_args)...);
return value;
} else if constexpr(SerialisableOptionalBase<T> && SerialisableOptionalOrSmartPointer<T>) {
if (_setupInstance) [[unlikely]] {
// Can't assure here that the instance part of std::optional won't be left uninitialised if started as blank
T value;
value = std::decay_t<decltype(*value)>();
value = T(std::get<Enumeration>(_args)...);
return value;
} else {
return T(std::get<Enumeration>(_args)...);
}
} else {
return T(std::get<Enumeration>(_args)...);
}
}
public:
#if _MSC_VER && !__INTEL_COMPILER
template <class T>
struct isInitializerList : std::false_type {};
template <class T>
struct isInitializerList<std::initializer_list<T>> : std::true_type {};
template<typename T, std::enable_if_t<(std::is_class_v<T> && !isInitializerList<T>::value)
|| std::is_arithmetic_v<T> || std::is_floating_point_v<T> || std::is_enum_v<T>>* = nullptr>
#else
template <typename T>
#endif
operator T() const {
if (Serialisable::_setupInstance) [[unlikely]] {
SerialisationSetupData& info = *Serialisable::_setupInstance;
#ifdef NO_DEFECT_REPORT_2118
if (std::ssize(info.elements) < info.index + 1)
info.elements.emplace_back();
#endif
info.elements[info.index].size = sizeof(T);
int8_t garbageNumber = info.initState == InitialisationState::INITIALISING
? Serialisable::garbageNumber1 : Serialisable::garbageNumber2;
int lastUninitialised = sizeof(Child) - 1;
while (lastUninitialised && reinterpret_cast<const int8_t*>(
info.instance)[lastUninitialised - 1] == garbageNumber)
lastUninitialised--;
info.elements[info.index].lastInitialisedBefore[info.initState
== InitialisationState::INITIALISING_AGAIN] = lastUninitialised;
#ifdef NO_DEFECT_REPORT_2118
if (info.initState == InitialisationState::INITIALISING) {
info.result->push_back({&serialiseWithOffset<T, Name>, &deserialiseWithOffset<T, Name>,
&describeMember<T, Name>, &addMemberType<T>, Name.c_str()});
}
#else
bool added = addMember<Child, 0, &serialiseWithOffset<T, Name>, &deserialiseWithOffset<T, Name>,
&describeMember<T, Name>, &addMemberType<T>, Name, Flags>::done;
added = !added && Serialisable::_setup; // Avoid unused variable warning and use the _setup
#endif
info.index++;
}
return makeType<T>(std::make_index_sequence<sizeof...(Args)>());
}
friend class Serialisable<Child>;
};
template <StringLiteral Name, SerialisationFlags::Flags Flags>
struct Initialiser : public InitialiserInitialiser<Name, Flags> {
constexpr Initialiser() = default;
template <typename... Args>
InitialiserInitialiser<Name, Flags, Args...> init(Args... args) const {
return InitialiserInitialiser<Name, Flags, Args...>(args...);
}
template <typename Arg>
InitialiserInitialiser<Name, Flags, Arg> operator=(Arg arg) const {
return InitialiserInitialiser<Name, Flags, Arg>(arg);
}
};
protected:
template <StringLiteral Name, SerialisationFlags::Flags Flags = SerialisationFlags::NONE>
inline static constexpr Initialiser<Name, Flags> key = {};
void serialiseInternal(IStructuredOutput& format,
SerialisationFlags::Flags flags) const override {
#ifdef NO_DEFECT_REPORT_2118
format.startWritingObject(SerialisationFlags::Flags(flags | SerialisationFlags::OBJECT_LAYOUT_KNOWN), _setup.size());
for (int i = 0; i < std::ssize(setup); i++) {
_setup[i].serialiser(format, this, i, _setup[i].offset,
SerialisationFlags::Flags(flags | _setup[i].flags | SerialisationFlags::OBJECT_LAYOUT_KNOWN));
}
#else
format.startWritingObject(SerialisationFlags::Flags(flags | SerialisationFlags::OBJECT_LAYOUT_KNOWN), ObjectInfo<Child>::size);
ObjectInfo<Child>::serialise(format, this, SerialisationFlags::Flags(flags | SerialisationFlags::OBJECT_LAYOUT_KNOWN));
#endif
format.endWritingObject(flags);
}
bool deserialiseInternal(IStructuredInput& format,
SerialisationFlags::Flags flags) override {
format.readObject(SerialisationFlags::Flags(flags | SerialisationFlags::OBJECT_LAYOUT_KNOWN),
[&] (std::optional<std::string_view> name, int index) {
#ifdef NO_DEFECT_REPORT_2118
if (name.has_value()) {
for (int i = 0; i < std::ssize(setup); i++) {
if (_setup[i].name == name) {
_setup[i].deserialiser(format, this, _setup[i].offset,
SerialisationFlags::Flags(flags | _setup[i].flags));
goto found;
}
}
format.skipObjectElement(flags);
found:;
return true;
} else {
_setup[index].deserialiser(format, this, _setup[index].offset,
SerialisationFlags::Flags(flags | _setup[index].flags));
return (index < _setup.size() - 1); // If there is a next element
}
#else
ObjectInfo<Child>::deserialise(format, this, flags, name, index);
return (index < ObjectInfo<Child>::size - 1); // True if not the last one
#endif
});
return format.good;
}
Serialisable() {
static_assert(std::is_base_of_v<Serialisable<Child>, Child>, // Must be in a method
"Serialisable's template argument must be the class that inherits from it");
if (_setupInstance) [[unlikely]] {
// We need to keep track of what is allocated and what is garbage
void* start = reinterpret_cast<void*>(reinterpret_cast<uint64_t>(this)
+ sizeof(Serialisable<Child>));
uint8_t garbageNumber = (_setupInstance->initState == InitialisationState::INITIALISING)
? garbageNumber1 : garbageNumber2;
memset(start, garbageNumber, sizeof(Child) - sizeof(Serialisable<Child>));
}
}
Serialisable(const Serialisable&) = default;
Serialisable(Serialisable&&) = default;
Serialisable& operator=(const Serialisable&) = default;
Serialisable& operator=(Serialisable&&) = default;
public:
void describe(IPropertyDescriptionFiller& filler) const override {
#ifdef NO_DEFECT_REPORT_2118
for (int i = 0; i < std::ssize(setup); i++) {
_setup[i].describer(filler);
}
#else
ObjectInfo<Child>::describe(filler);
#endif
}
std::string_view getTypeName() const override {
const char* name = typeid(Child).name(); // Resolved at compile time, should not need RTTI
while (*name != '\0' && !(*name >= 'a' && *name <= 'z') && !(*name >= 'A' && *name <= 'Z'))
name++;
if (*name == '\0')
name = "object";
return name;
}
void listTypes(ISerialisableDescriptionFiller& filler) const override {
#ifdef NO_DEFECT_REPORT_2118
for (int i = 0; i < std::ssize(setup); i++) {
_setup[i].typeLister(filler);
}
#else
ObjectInfo<Child>::listTypes(filler);
#endif
}
virtual ~Serialisable() = default;
};
} // namespace Bomba
#undef NO_DEFECT_REPORT_2118
#endif // BOMBA_OBJECT