Cogs.Core
Field.h
1#pragma once
2
3#include "Attributes.h"
4
5namespace Cogs
6{
7 namespace Reflection
8 {
9 class Type;
10
17 template<typename T, typename U>
18 struct FieldWrapper : public T
19 {
25 template<typename ClassType, typename FieldType>
26 FieldWrapper(const Name& name, FieldType ClassType::* field) : T(name, field) {}
27
29 FieldWrapper & setDefault(U value);
30
32 FieldWrapper & setRange(U min, U max);
33
35 FieldWrapper& setStep(U step);
36 };
37
41 enum struct FieldFlags : uint16_t
42 {
44 Default = 0,
46 Pointer = 0x1,
48 Array = 0x2,
50 NoSerialize = 0x4,
51 };
52
54 [[nodiscard]]
55 inline FieldFlags operator|(FieldFlags lhs, FieldFlags rhs) { return static_cast<FieldFlags>(static_cast<uint16_t>(lhs) | static_cast<uint16_t>(rhs)); }
56
58 [[nodiscard]]
59 inline FieldFlags operator&(FieldFlags lhs, FieldFlags rhs) { return static_cast<FieldFlags>(static_cast<uint16_t>(lhs) & static_cast<uint16_t>(rhs)); }
60
62 inline FieldFlags & operator|=(FieldFlags & lhs, FieldFlags rhs) { lhs = static_cast<FieldFlags>(static_cast<uint16_t>(lhs) | static_cast<uint16_t>(rhs)); return lhs; }
63
67 class COGSFOUNDATION_API Field
68 {
69 public:
80 template<typename ClassType, typename FieldType>
81 Field(const Name& name, FieldType ClassType::* field);
82
89 template<typename ClassType, typename FieldType>
90 static FieldWrapper<Field, FieldType> create(const Name& name, FieldType ClassType::* field);
91
93 Field(const Field & other) = default;
94
96 Field(Field && other) noexcept = default;
97
99 Field & operator=(const Field & other) = default;
100
102 Field & operator=(Field && other) noexcept = default;
103
110 template<typename FieldValueType>
111 [[nodiscard]]
112 FieldValueType * getPtr(void * container) const
113 {
114 if constexpr (!std::is_array<FieldValueType>()) {
115 assert(sizeof(FieldValueType) <= byteSize && "Pointer overflows field size.");
116 }
117
118 return static_cast<FieldValueType*>(static_cast<void*>(static_cast<char*>(container) + offset));
119 }
120
127 template<typename FieldValueType>
128 [[nodiscard]]
129 const FieldValueType * getPtr(const void * container) const
130 {
131 return static_cast<const FieldValueType*>(static_cast<const void*>(static_cast<const char*>(container) + offset));
132 }
133
135 [[nodiscard]]
136 const Name & getName() const { return name; }
137
139 [[nodiscard]]
140 TypeId getTypeId() const { return typeId; }
141
143 [[nodiscard]]
144 size_t getOffset() const { return offset; }
145
147 [[nodiscard]]
148 FieldFlags getFlags() const { return fieldFlags; }
149
151 [[nodiscard]]
152 bool isSet(FieldFlags flag) const { return (fieldFlags & flag) == flag; }
153
155 [[nodiscard]]
156 size_t getDimensions() const { return arrayDimensions; }
157
159 Field& setSerialize(bool serialize)
160 {
161 if (serialize) {
162 unsetFlag(FieldFlags::NoSerialize);
163 }
164 else {
165 fieldFlags |= FieldFlags::NoSerialize;
166 }
167
168 return *this;
169 }
170
176 template<typename T>
177 Field & add(T attribute)
178 {
179#if defined( EMSCRIPTEN )
180 // Only add runtime attributes for Cogs.js, skip code-gen attributes.
181 if (!attribute.isRuntime())
182 return *this;
183#endif
184 return attributes.add(*this, attribute);
185 }
186
192 template<typename T>
193 [[nodiscard]]
194 const T * get() const
195 {
196 return attributes.get<T>();
197 }
198
199 private:
200 void unsetFlag(FieldFlags flag) { this->fieldFlags = this->fieldFlags & static_cast<FieldFlags>(~uint32_t(flag)); }
201
204
206 FieldFlags fieldFlags = FieldFlags::Default;
207
210
212 size_t offset;
213
215 size_t byteSize;
216
218 size_t arrayDimensions = 0;
219
222
224 };
225 }
226}
227
228#include "Field.inl"
Field definition describing a single data member of a data structure.
Definition: Field.h:68
const Name & getName() const
Get the name of the field.
Definition: Field.h:136
const T * get() const
Retrieve an attribute of the given type from storage, if present.
Definition: Field.h:194
Field & add(T attribute)
Adds the given attribute.
Definition: Field.h:177
TypeId typeId
Type id of the field.
Definition: Field.h:221
size_t getDimensions() const
Get the array dimensions of the field. Returns zero if the field is not an array.
Definition: Field.h:156
Field & setSerialize(bool serialize)
Mark if field shall be serializable, e.g. value saved generating Scene. Default = true.
Definition: Field.h:159
FieldFlags getFlags() const
Get the field flags.
Definition: Field.h:148
bool isSet(FieldFlags flag) const
Checks if the given flag(s) is set. Requires exact bit match if test of several bits.
Definition: Field.h:152
size_t getOffset() const
Get the fields offset from the start of the structure in bytes.
Definition: Field.h:144
Field(Field &&other) noexcept=default
Default move constructor.
Field(const Field &other)=default
Default copy constructor.
Name name
Name of the field.
Definition: Field.h:209
Attributes attributes
Attribute storage.
Definition: Field.h:203
size_t byteSize
Size of the field in bytes.
Definition: Field.h:215
TypeId getTypeId() const
Get the type id of the field.
Definition: Field.h:140
FieldValueType * getPtr(void *container) const
Get a pointer to this field on the given container.
Definition: Field.h:112
const FieldValueType * getPtr(const void *container) const
Get a const pointer to this field on the given container.
Definition: Field.h:129
Field & operator=(const Field &other)=default
Default copy assignment operator.
size_t offset
Offset of the field in bytes from the beginning of the container.
Definition: Field.h:212
Field & operator=(Field &&other) noexcept=default
Default move assignment operator.
FieldFlags
Field flags.
Definition: Field.h:42
@ NoSerialize
Skip Serialize field.
@ Array
Field is an array.
uint16_t TypeId
Built in type used to uniquely identify a single type instance.
Definition: Name.h:48
FieldFlags & operator|=(FieldFlags &lhs, FieldFlags rhs)
Or assignment operator.
Definition: Field.h:62
FieldFlags operator&(FieldFlags lhs, FieldFlags rhs)
And operator.
Definition: Field.h:59
FieldFlags operator|(FieldFlags lhs, FieldFlags rhs)
Or operator.
Definition: Field.h:55
Contains all Cogs related functionality.
Definition: FieldSetter.h:23
Provides scoped storage for a raw pointer and corresponding deletion logic.
Definition: Pointer.h:66
Attribute storage for structures.
Definition: Attributes.h:130
Convenience wrapper for adding attributes during field creation in a type safe manner.
Definition: Field.h:19
FieldWrapper & setStep(U step)
Convenience method for setting the valid value step of the field.
Definition: Field.inl:51
FieldWrapper(const Name &name, FieldType ClassType::*field)
Construct the field wrapper, forwarding arguments to the underlying field.
Definition: Field.h:26
FieldWrapper & setDefault(U value)
Convenience method for setting the default value of the field.
Definition: Field.inl:35
FieldWrapper & setRange(U min, U max)
Convenience method for setting the valid value range of the field.
Definition: Field.inl:43
Represents an unique name.
Definition: Name.h:70