47 #ifndef _MIRA_RECURSIVEMEMBERREFLECTOR_H_ 48 #define _MIRA_RECURSIVEMEMBERREFLECTOR_H_ 50 #include <type_traits> 80 namespace serialization {
87 [[nodiscard]]
bool query()
const 112 template<
typename T,
typename Reflector>
119 template<
typename T,
typename Reflector>
124 reflectedAsPointer<T, Reflector>().
set();
147 friend class ClassFactoryDefaultConstClassBuilder;
152 XMemberNotFound(ex) {}
154 void raise(
bool recursive =
false)
override 252 template <
typename Derived>
260 mCurrentMemberMeta(nullptr) {}
302 if constexpr(Derived::isReadOnly::value) {
304 this->
This()->atomic(val);
307 this->
This()->atomic(val);
308 member =
static_cast<T
>(val);
322 this->
This()->invoke(member);
332 this->
This()->object(member);
353 if constexpr (std::is_base_of_v<mira::Object, T>) {
356 else if constexpr (std::is_abstract_v<T>) {
375 this->
This()->invokePointerObject(*pointer);
393 typedef serialization::PolymorphicPointerReflectorRegistrar<Derived> OurRegistrar;
395 typename OurRegistrar::ReflectorRef r =
396 OurRegistrar::instance().getPolymorphicPointerReflector(
typeId);
401 catch (XPolymorphicPointerReflectorNotRegistered&) {
405 "Cannot reflect the polymorphic member pointer '" 407 <<
"' was not registered with this serializer '" << typeName<Derived>()
409 #ifndef MIRA_REGISTER_LEGACY_SERIALIZERS
410 <<
" (Registration with legacy serializers must be explicitly enabled" 411 " by activating the option REGISTER_LEGACY_SERIALIZERS" 412 " [GlobalConfig, requires recompilation])";
429 this->
This()->invokePointerObject(*pointer);
451 typedef serialization::PolymorphicPointerReflectorRegistrar<Derived> OurRegistrar;
453 if(!OurRegistrar::isDestroyed())
454 OurRegistrar::instance().template registerClass<T>();
470 typedef serialization::PolymorphicPointerReflectorRegistrar<Derived> OurRegistrar;
471 if(!OurRegistrar::isDestroyed())
472 OurRegistrar::instance().template unregisterClass<T>();
481 assert(mCurrentMemberMeta!=NULL);
482 return *mCurrentMemberMeta;
493 return mCurrentMemberFullID;
506 return serialization::reflectedAsPointer<T, Derived>().query();
515 this->
This()->trackObject(member);
526 static_assert(
sizeof(T) == 0,
"Trying to reflect unknown type.");
533 this->
This()->invokeTrackObject(member);
534 this->
This()->atomic(member);
541 this->
This()->invokeTrackObject(member);
542 this->
This()->enumeration(member);
549 this->
This()->invokeTrackObject(member);
550 std::size_t size =
sizeof(
member)
551 / (static_cast<const char*>(static_cast<const void*>(&
member[1]))
552 -
static_cast<const char*
>(
static_cast<const void*
>(&
member[0])));
555 serialization::Array<ItemType> array(
member, size);
563 this->
This()->invokeTrackObject(member);
566 "Trying to call reflectComplex<T>() with IsCollection<T> == true " 567 "- something is wrong.");
569 this->
This()->invoke(member);
571 this->
This()->object(member);
578 this->
This()->invokeTrackObject(member);
581 static_assert(!isTransparent::value,
582 "Trying to call reflectCollection<T>() with IsTransparentSerializable<T> == " 583 "true - something is wrong.");
584 this->
This()->collection(member);
591 this->
This()->pointer(member);
600 this->
This()->pointerNormal(member, typeId<T>());
616 this->
This()->pointerPolymorphic(member,
typeId);
626 this->
This()->pointerAbstract(member, typeId<T>());
636 if constexpr (std::is_pointer_v<Type>) {
642 else if constexpr (std::is_class_v<Type>) {
650 else if constexpr (std::is_enum_v<Type>) {
653 else if constexpr (std::is_array_v<Type>) {
676 this->
This()->invokeMemberOverwrite(member, meta);
697 std::string prevFullID;
699 prevFullID = mCurrentMemberFullID;
702 if(mCurrentMemberFullID.empty()) {
704 MIRA_THROW(XLogical,
"Top-level member cannot be 'inline'. " 705 "It must have an ID != NULL!");
706 mCurrentMemberFullID=meta.
id;
707 }
else if(meta.
id!=
nullptr)
708 mCurrentMemberFullID = mCurrentMemberFullID +
"." + meta.
id;
713 if(meta.
id !=
nullptr)
714 mCurrentMemberMeta = &meta;
729 mCurrentMemberFullID=prevFullID;
731 mCurrentMemberMeta = prevMeta;
738 mCurrentMemberFullID=prevFullID;
740 mCurrentMemberMeta = prevMeta;
763 }
catch (XMemberNotFound& ex) {
773 (Derived::isReadOnly::value ?
"serializing" :
"deserializing") <<
774 " '" << meta.
getName() <<
"'");
783 template<
typename T,
typename U>
785 const U& defaultValue)
791 }
catch (XMemberNotFound&) {
792 if constexpr(!Derived::isReadOnly::value) {
794 "using the default value instead.";
813 (Derived::isReadOnly::value ?
"serializing" :
"deserializing") <<
814 " '" << meta.
getName() <<
"'");
832 }
catch (XMemberNotFound&) {
839 (Derived::isReadOnly::value ?
"serializing" :
"deserializing") <<
840 " '" << meta.
getName() <<
"'");
849 std::string mCurrentMemberFullID;
873 template <
typename Derived>
886 this->
This()->pushObjectTrackingStore();
888 this->
This()->popObjectTrackingStore();
897 this->
This()->pushObjectTrackingStore();
900 this->
This()->popObjectTrackingStore();
910 this->
This()->pushObjectTrackingStore();
912 this->
This()->popObjectTrackingStore();
919 this->
This()->pushObjectTrackingStore();
921 this->
This()->popObjectTrackingStore();
930 this->
template member<T, T>(name,
member, comment, defaultValue, flags);
933 template<
typename T,
typename U>
937 this->
This()->pushObjectTrackingStore();
940 this->
This()->popObjectTrackingStore();
949 const char* comment,
const T& defaultValue,
951 this->
template member<T, T>(name,
member,
setter, comment, defaultValue, flags);
954 template<
typename T,
typename U>
956 const char* comment,
const U& defaultValue,
959 this->
This()->pushObjectTrackingStore();
962 this->
This()->popObjectTrackingStore();
968 const char* comment,
const T& defaultValue,
970 this->
template member<T, T>(name,
getter,
setter, comment, defaultValue, flags);
973 template<
typename T,
typename U>
975 const char* comment,
const U& defaultValue,
978 this->
This()->pushObjectTrackingStore();
981 this->
This()->popObjectTrackingStore();
989 this->
This()->pushObjectTrackingStore();
991 this->
This()->popObjectTrackingStore();
1001 this->
This()->pushObjectTrackingStore();
1003 this->
This()->popObjectTrackingStore();
1008 template<
typename T>
1013 this->
This()->pushObjectTrackingStore();
1015 this->
This()->popObjectTrackingStore();
1018 template<
typename T>
1023 this->
This()->pushObjectTrackingStore();
1025 this->
This()->popObjectTrackingStore();
1029 template<
typename T>
1033 this->
template property<T, T>(name,
member, comment, defaultValue, std::move(hint), flags);
1036 template<
typename T,
typename U>
1041 this->
This()->pushObjectTrackingStore();
1044 this->
This()->popObjectTrackingStore();
1051 template<
typename T>
1053 const char* comment,
const T& defaultValue,
1056 this->
template property<T, T>(name,
member,
setter, comment, defaultValue, std::move(hint), flags);
1059 template<
typename T,
typename U>
1061 const char* comment,
const U& defaultValue,
1065 this->
This()->pushObjectTrackingStore();
1068 this->
This()->popObjectTrackingStore();
1072 template<
typename T>
1074 const char* comment,
const T& defaultValue,
1077 this->
template property<T, T>(name,
getter,
setter, comment, defaultValue, std::move(hint), flags);
1080 template<
typename T,
typename U>
1082 const char* comment,
const U& defaultValue,
1086 this->
This()->pushObjectTrackingStore();
1089 this->
This()->popObjectTrackingStore();
1098 template<
typename T>
1101 this->
This()->pushObjectTrackingStore();
1103 this->
This()->popObjectTrackingStore();
1114 template<
typename T>
1118 this->
This()->pushObjectTrackingStore();
1120 this->
This()->popObjectTrackingStore();
1129 template<
typename T>
1133 this->
This()->pushObjectTrackingStore();
1135 this->
This()->popObjectTrackingStore();
TypeId typeId()
Generates unique IDs for different types.
Definition: TypeId.h:94
This object can use object tracking internally, but the object tracking system's state remains unchan...
Definition: ReflectControlFlags.h:82
void reflectPointerAbstract(T *&member)
Type C3: for members that are pointers to abstract classes not derived from mira::Object.
Definition: RecursiveMemberReflector.h:624
Type trait that indicates whether pointer tracking can be enabled for this type.
Definition: IsObjectTrackable.h:68
void object(T &member)
Is called for each complex object.
Definition: RecursiveMemberReflector.h:321
Provides safe casts for casting from a pointer to void* and vice versa while taking care of polymorph...
void property(const char *name, T &member, const char *comment, const U &defaultValue, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1037
void property(const char *name, Getter< T > getter, Setter< T > setter, const char *comment, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1019
void member(const char *name, const T &member, Setter< T > setter, const char *comment, const U &defaultValue, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:955
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
void reflectPointerPolymorphic(T *&member)
Type C2: for members that are pointers to polymorphic classes derived from mira::Object.
Definition: RecursiveMemberReflector.h:605
void member(const char *name, const T &member, Setter< T > setter, const char *comment, const T &defaultValue, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:948
Abstract base class for most Reflectors.
const std::string & getCurrentMemberFullID() const
Returns the full human readable object id / name of the current member being reflected.
Definition: RecursiveMemberReflector.h:490
void member(const char *name, T &member, const char *comment, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:883
void property(const char *name, T &member, const char *comment, const T &defaultValue, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1030
#define MIRA_LOG(level)
Use this macro to log data.
Definition: LoggingCore.h:529
void trackObject(T &member)
Definition: RecursiveMemberReflector.h:337
Class object which supports some kind of class reflection.
Definition: Class.h:97
#define MIRA_RETHROW(ex, msg)
Macro for rethrowing an exception with file and line information and for adding additional informatio...
Definition: Exception.h:144
Contains toString and fromString functions for converting data types to strings and the other way rou...
#define MIRA_DEFINE_SERIALIZABLE_EXCEPTION(Ex, Base)
Macro for easily defining a new serializable exception class.
Definition: Exceptions.h:66
Setter< T > setter(void(*f)(const T &))
Creates a Setter for global or static class methods taking the argument by const reference.
Definition: GetterSetter.h:443
Holds a boost::function object to a special setter function that must meet the signature "void method...
Definition: GetterSetter.h:395
Type trait that indicates whether a type can be serialized as an atomic value.
Definition: IsAtomicSerializable.h:83
void property(const char *name, T &member, const char *comment, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:985
void chooseReflect(T &member)
Detect the members type (A1,A2,A3,B1,B2,C) and choose the appropriate function.
Definition: RecursiveMemberReflector.h:633
Provides type trait that indicates whether a type should be serialized "transparently".
Provides type trait that indicates whether pointer/object tracking should be enabled for a certain ty...
Contains internal accessor class that abstracts from the underlying getter and setter classes or dire...
void invokeMemberWithDefault(T &member, const ReflectMemberMeta &meta, const U &defaultValue)
Delegates to invokeMember() and handles any occurring XMemberNotFound exception by setting the member...
Definition: RecursiveMemberReflector.h:784
void pointerAbstract(T *&pointer, int typeId)
Is called if a reflected pointer is a pointer to an abstract class.
Definition: RecursiveMemberReflector.h:426
#define MIRA_THROW(ex, msg)
Macro for throwing an exception.
Definition: Exception.h:78
Marker for indicating parameters that should be ignored if they are missing in the config file...
void property(const char *name, const T &member, Setter< T > setter, const char *comment, const U &defaultValue, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1060
A property hint gives optional instructions to the property editor, i.e.
Definition: PropertyHint.h:82
Derived * This()
"Curiously recurring template pattern" (CRTP).
Definition: AbstractReflector.h:246
Wrapper class for reflecting arrays.
XMemberNotFound_NoDefault() MIRA_NOEXCEPT_OR_NOTHROW
Definition: RecursiveMemberReflector.h:148
const ReflectMemberMeta & getCurrentMemberMeta() const
Returns the meta-information of the current member that is reflected.
Definition: RecursiveMemberReflector.h:479
void property(const char *name, const std::string &id, T &member, const char *comment, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:997
Abstract base class for most Reflectors.
Definition: AbstractReflector.h:160
static bool usesHumanReadableIDs()
Returns true, if the concrete derived Reflector supports human readable IDs.
Definition: ReflectorInterface.h:801
Marker for indicating parameters that should be ignored if they are missing in the config file...
Definition: IgnoreMissing.h:73
Can be thrown by subclasses of RecursiveMemberReflectorBase to indicate that they did not find a cert...
Definition: RecursiveMemberReflector.h:143
$Header file containing base classes to enable class creation using a class factory$ ...
Implementation of the InstantiationPolicy that is used by the Singleton template. ...
Definition: Singleton.h:310
void pointerPolymorphic(T *&pointer, int typeId)
Is called if a reflected pointer is a polymorphic pointer to an object that is derived from mira::Obj...
Definition: RecursiveMemberReflector.h:387
bool query() const
Definition: RecursiveMemberReflector.h:87
void delegate(Getter< T > getter, Setter< T > setter, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Delegates the serialization directly to the specified member, without creating a separate compound fo...
Definition: RecursiveMemberReflector.h:1130
static bool isReflectedAsPointer()
For internal use only: Returns true, if the type T is ever reflected as pointer within the current tr...
Definition: RecursiveMemberReflector.h:504
SetReflectedAsPointer()
Definition: RecursiveMemberReflector.h:122
A singleton template class that can be freely configured using policies that control the instantiatio...
Definition: Singleton.h:495
void pointerNormal(T *&pointer, int typeId)
Is called if a reflected pointer is a "normal" pointer.
Definition: RecursiveMemberReflector.h:372
No flags.
Definition: ReflectControlFlags.h:65
A singleton class that can be freely configured using policies that control the creation, instantiation, lifetime and thread-safety.
PropertyHint type(const std::string &t)
Sets the attribute "type" to the specified value.
Definition: PropertyHint.h:295
void invokeTrackObject(T &member)
tracks the given object (if pointer tracking is enabled for type T)
Definition: RecursiveMemberReflector.h:512
void reflectPointer(T &member)
Type C: for members that are pointers.
Definition: RecursiveMemberReflector.h:589
Core class of the logging library.
void delegate(T &member, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Delegates the serialization directly to the specified member, without creating a separate compound fo...
Definition: RecursiveMemberReflector.h:1099
void reflectUnknown(T &member)
Definition: RecursiveMemberReflector.h:524
void invokePointerObject(T &member)
Is called to reflect objects of pointers.
Definition: RecursiveMemberReflector.h:748
void property(const char *name, const T &member, Setter< T > setter, const char *comment, const T &defaultValue, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1052
Getter< T > getter(T(*f)())
Creates a Getter for global or static class methods returning the result by value.
Definition: GetterSetter.h:136
The RecursiveMemberReflectorBase is a base class for all Reflectors that are used to visit the reflec...
Definition: RecursiveMemberReflector.h:253
static void unregisterClass()
Unregisters the class.
Definition: RecursiveMemberReflector.h:468
Provides type trait that indicates whether a type is a collection.
void property(const char *name, Getter< T > getter, Setter< T > setter, const char *comment, const U &defaultValue, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1081
void property(const char *name, Getter< T > getter, Setter< T > setter, const char *comment, const T &defaultValue, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1073
void invokeMemberWithoutDefault(T &member, const ReflectMemberMeta &meta)
Delegates to invokeMember() and rethrows any occurring XMemberNotFound exception as XIO exception...
Definition: RecursiveMemberReflector.h:759
void member(const char *name, T &member, const char *comment, const U &defaultValue, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:934
virtual std::string const & getIdentifier() const
Return identifier for the class.
void member(const char *name, const std::string &id, T &member, const char *comment, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:894
RecursiveMemberReflectorBase()
The constructor.
Definition: RecursiveMemberReflector.h:259
#define MIRA_NOEXCEPT_OR_NOTHROW
Definition: NoExcept.h:99
#define MIRA_OBJECT(classIdentifier)
Use this MACRO if you like the factory to automatically extract the class name from the given identif...
Definition: FactoryMacros.h:179
XMemberNotFound_NoDefault(XMemberNotFound &ex) MIRA_NOEXCEPT_OR_NOTHROW
Definition: RecursiveMemberReflector.h:151
Implementation of the CreationPolicy that is used by the Singleton template.
Definition: Singleton.h:165
Base class for exceptions.
Definition: Exception.h:195
void member(const char *name, const T &member, Setter< T > setter, const char *comment, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:907
static OneWaySwitch & reflectedAsPointer()
For internal use only: Holds value.isOn=true, iff the type T is ever reflected as pointer with Reflec...
Definition: RecursiveMemberReflector.h:113
void member(const char *name, T &member, const char *comment, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Specifies a class member for reflection/serialization.
Definition: ReflectorInterface.h:375
Holds a boost::function object to a special getter function that must meet the signature "T method()"...
Definition: GetterSetter.h:87
void member(const char *name, Getter< T > getter, Setter< T > setter, const char *comment, const T &defaultValue, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:967
void invokeMember(T &member, const ReflectMemberMeta &meta)
Is called to invoke this Reflector on the member with the specified meta information.
Definition: RecursiveMemberReflector.h:674
Provides type trait that indicates whether a type can be serialized as atomic value.
void property(const char *name, const T &member, Setter< T > setter, const char *comment, PropertyHint &&hint=PropertyHint(), ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:1009
void pointer(T *&pointer)
Is called if the member is a pointer.
Definition: RecursiveMemberReflector.h:345
void delegate(const T &member, Setter< T > setter, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Delegates the serialization directly to the specified member, without creating a separate compound fo...
Definition: RecursiveMemberReflector.h:1115
void reflectCollection(T &member)
Type B?c: for collection types.
Definition: RecursiveMemberReflector.h:576
static constexpr auto MIRA_REFLECTOR_TOPLEVEL_NAME
Use this when a reflector needs to choose a name for serializing an object.
Definition: RecursiveMemberReflector.h:269
void invokeMemberOverwrite(T &member, const ReflectMemberMeta &meta)
The actual invokeMember implementation that is called from invokeMember().
Definition: RecursiveMemberReflector.h:686
void enumeration(T &member)
Is called by the if the member is an enumeration.
Definition: RecursiveMemberReflector.h:301
ReflectCtrlFlags
Control Flags that can modify the behavior of certain reflectors.
Definition: ReflectControlFlags.h:63
void reflectEnumeration(T &member)
Type A2: for enums.
Definition: RecursiveMemberReflector.h:539
void collection(T &member)
Is called for each complex object or array, where the IsCollection<T> trait is true_type.
Definition: RecursiveMemberReflector.h:331
void reflectComplex(T &member)
Type B1/B2: for complex types.
Definition: RecursiveMemberReflector.h:561
Type trait that indicates whether a type is a collection.
Definition: IsCollection.h:63
void member(const char *name, T &member, const char *comment, const T &defaultValue, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:928
void member(const char *name, Getter< T > getter, Setter< T > setter, const char *comment, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:916
static void registerClass()
Registers a new polymorphic class at the PolymorphPointerReflector.
Definition: RecursiveMemberReflector.h:449
void member(const char *name, Getter< T > getter, Setter< T > setter, const char *comment, const U &defaultValue, ReflectCtrlFlags flags=REFLECT_CTRLFLAG_NONE)
Definition: RecursiveMemberReflector.h:974
Definition: IsTransparentSerializable.h:84
Accessor< Getter, Setter > makeAccessor(const Getter &getter, const Setter &setter)
Helper method that creates an accessor from a different combination of either direct access to a vari...
Definition: Accessor.h:300
void reflectPointerNormal(T *&member)
Type C1: for members that are pointers to normal classes.
Definition: RecursiveMemberReflector.h:598
The RecursiveMemberReflector extents the RecursiveMemberReflectorBase class and implements the member...
Definition: RecursiveMemberReflector.h:874
void * void_upcast(T *pointer)
Safe cast for casting from a pointer upwards to void* while taking care of polymorphism and multiple ...
Definition: VoidCast.h:108
Definition: RecursiveMemberReflector.h:120
For internal use by RecursiveMemberReflector.h!
void atomic(T &member)
Is called if the member is an atomic type (int, float, etc).
Definition: RecursiveMemberReflector.h:288
void reflectArray(T &member)
Type A3: for arrays.
Definition: RecursiveMemberReflector.h:547
Definition: RecursiveMemberReflector.h:84
void reflectAtomic(T &member)
Type A1: for atomic members (float,int,etc.)
Definition: RecursiveMemberReflector.h:531
Definition: LoggingCore.h:77
void invokeMemberWithDefault(T &member, const ReflectMemberMeta &meta, const serialization::IgnoreMissing &defaultValue)
Delegates to invokeMember() and handles any occurring XMemberNotFound exception by ignoring the excep...
Definition: RecursiveMemberReflector.h:825
virtual int getTypeId() const =0
Return unique id for the class.