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,
52 NoCodeGen = 0x8
53 };
54
56 [[nodiscard]]
57 inline FieldFlags operator|(FieldFlags lhs, FieldFlags rhs) { return static_cast<FieldFlags>(static_cast<uint16_t>(lhs) | static_cast<uint16_t>(rhs)); }
58
60 [[nodiscard]]
61 inline FieldFlags operator&(FieldFlags lhs, FieldFlags rhs) { return static_cast<FieldFlags>(static_cast<uint16_t>(lhs) & static_cast<uint16_t>(rhs)); }
62
64 inline FieldFlags & operator|=(FieldFlags & lhs, FieldFlags rhs) { lhs = static_cast<FieldFlags>(static_cast<uint16_t>(lhs) | static_cast<uint16_t>(rhs)); return lhs; }
65
69 class COGSFOUNDATION_API Field
70 {
71 public:
82 template<typename ClassType, typename FieldType>
83 Field(const Name& name, FieldType ClassType::* field);
84
91 template<typename ClassType, typename FieldType>
92 static FieldWrapper<Field, FieldType> create(const Name& name, FieldType ClassType::* field);
93
95 Field(const Field & other) = default;
96
98 Field(Field && other) noexcept = default;
99
101 Field & operator=(const Field & other) = default;
102
104 Field & operator=(Field && other) noexcept = default;
105
112 template<typename FieldValueType>
113 [[nodiscard]]
114 FieldValueType * getPtr(void * container) const
115 {
116 if constexpr (!std::is_array<FieldValueType>()) {
117 assert(sizeof(FieldValueType) <= byteSize && "Pointer overflows field size.");
118 }
119
120 return static_cast<FieldValueType*>(static_cast<void*>(static_cast<char*>(container) + offset));
121 }
122
129 template<typename FieldValueType>
130 [[nodiscard]]
131 const FieldValueType * getPtr(const void * container) const
132 {
133 return static_cast<const FieldValueType*>(static_cast<const void*>(static_cast<const char*>(container) + offset));
134 }
135
137 [[nodiscard]]
138 const Name & getName() const { return name; }
139
141 [[nodiscard]]
142 TypeId getTypeId() const { return typeId; }
143
145 [[nodiscard]]
146 size_t getOffset() const { return offset; }
147
149 [[nodiscard]]
150 FieldFlags getFlags() const { return fieldFlags; }
151
153 [[nodiscard]]
154 bool isSet(FieldFlags flag) const { return (fieldFlags & flag) == flag; }
155
157 [[nodiscard]]
158 size_t getDimensions() const { return arrayDimensions; }
159
161 Field& setSerialize(bool serialize)
162 {
163 if (serialize) {
164 unsetFlag(FieldFlags::NoSerialize);
165 }
166 else {
167 fieldFlags |= FieldFlags::NoSerialize;
168 }
169
170 return *this;
171 }
172
174 Field& setCodeGen(bool codegen)
175 {
176 if (codegen) {
177 unsetFlag(FieldFlags::NoCodeGen);
178 }
179 else {
180 fieldFlags |= FieldFlags::NoCodeGen;
181 }
182
183 return *this;
184 }
185
191 template<typename T>
192 Field & add(T attribute)
193 {
194#if defined( EMSCRIPTEN )
195 // Only add runtime attributes for Cogs.js, skip code-gen attributes.
196 if (!attribute.isRuntime())
197 return *this;
198#endif
199 return attributes.add(*this, attribute);
200 }
201
207 template<typename T>
208 [[nodiscard]]
209 const T * get() const
210 {
211 return attributes.get<T>();
212 }
213
214 private:
215 void unsetFlag(FieldFlags flag) { this->fieldFlags = this->fieldFlags & static_cast<FieldFlags>(~uint32_t(flag)); }
216
219
221 FieldFlags fieldFlags = FieldFlags::Default;
222
225
227 size_t offset;
228
230 size_t byteSize;
231
233 size_t arrayDimensions = 0;
234
237
239 };
240 }
241}
242
243#include "Field.inl"
Field definition describing a single data member of a data structure.
Definition: Field.h:70
const Name & getName() const
Get the name of the field.
Definition: Field.h:138
const T * get() const
Retrieve an attribute of the given type from storage, if present.
Definition: Field.h:209
Field & add(T attribute)
Adds the given attribute.
Definition: Field.h:192
TypeId typeId
Type id of the field.
Definition: Field.h:236
size_t getDimensions() const
Get the array dimensions of the field. Returns zero if the field is not an array.
Definition: Field.h:158
Field & setSerialize(bool serialize)
Mark if field shall be serializable, e.g. value saved generating Scene. Default = true.
Definition: Field.h:161
FieldFlags getFlags() const
Get the field flags.
Definition: Field.h:150
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:154
size_t getOffset() const
Get the fields offset from the start of the structure in bytes.
Definition: Field.h:146
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:224
Attributes attributes
Attribute storage.
Definition: Field.h:218
size_t byteSize
Size of the field in bytes.
Definition: Field.h:230
TypeId getTypeId() const
Get the type id of the field.
Definition: Field.h:142
FieldValueType * getPtr(void *container) const
Get a pointer to this field on the given container.
Definition: Field.h:114
Field & setCodeGen(bool codegen)
Mark if field shall have plumbing code generated. Default = true.
Definition: Field.h:174
const FieldValueType * getPtr(const void *container) const
Get a const pointer to this field on the given container.
Definition: Field.h:131
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:227
Field & operator=(Field &&other) noexcept=default
Default move assignment operator.
FieldFlags
Field flags.
Definition: Field.h:42
@ NoSerialize
Skip Serialize field.
@ NoCodeGen
Do not add code generation of plumbing for this 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:64
FieldFlags operator&(FieldFlags lhs, FieldFlags rhs)
And operator.
Definition: Field.h:61
FieldFlags operator|(FieldFlags lhs, FieldFlags rhs)
Or operator.
Definition: Field.h:57
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