CmRTTIType.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691
  1. #pragma once
  2. #include <string>
  3. #include <algorithm>
  4. #include <unordered_map>
  5. #include <boost/function.hpp>
  6. #include <boost/bind.hpp>
  7. #include <boost/type_traits.hpp>
  8. #include <boost/static_assert.hpp>
  9. #include <boost/preprocessor/punctuation/comma.hpp>
  10. #include "CmPrerequisitesUtil.h"
  11. #include "CmManagedDataBlock.h"
  12. #include "CmRTTIField.h"
  13. #include "CmRTTIPlainField.h"
  14. #include "CmRTTIReflectableField.h"
  15. #include "CmRTTIReflectablePtrField.h"
  16. #include "CmRTTIManagedDataBlockField.h"
  17. #include "CmIReflectable.h"
  18. namespace CamelotFramework
  19. {
  20. #define CM_SETGET_MEMBER(name, type, parentType) \
  21. type##& get##name(parentType##* obj) { return obj->##name; } \
  22. void Set##name(parentType##* obj, type##& val) { obj->##name = val; }
  23. #define CM_ADD_PLAINFIELD(name, id, parentType) \
  24. addPlainField(#name, id##, &##parentType##::get##name, &##parentType##::Set##name);
  25. /**
  26. * @brief Provides an interface for accessing fields of a certain class.
  27. * Data can be easily accessed by getter and setter methods.
  28. *
  29. * Supported data types:
  30. * - Plain types - All types defined in CmRTTIField.h, mostly native types and POD (plain old data) structs. Data is parsed byte by byte.
  31. * No pointers to plain types are supported. Data is passed around by value.
  32. * - Reflectable types - Any class deriving from IReflectable. Data is parsed based on fields in its ReflectionInterface. Can be pointer or value type.
  33. * - Arrays of both plain and reflectable types are supported
  34. * - Data blocks - A managed or unmanaged block of data. See CmManagedDataBlock.h
  35. */
  36. class CM_UTILITY_EXPORT RTTITypeBase
  37. {
  38. public:
  39. RTTITypeBase();
  40. virtual ~RTTITypeBase();
  41. virtual Vector<RTTITypeBase*>::type& getDerivedClasses() = 0;
  42. virtual RTTITypeBase* getBaseClass() = 0;
  43. virtual void registerDerivedClass(RTTITypeBase* derivedClass) = 0;
  44. virtual std::shared_ptr<IReflectable> newRTTIObject() = 0;
  45. virtual const String& getRTTIName() = 0;
  46. virtual UINT32 getRTTIId() = 0;
  47. virtual void onSerializationStarted(IReflectable* obj) {}
  48. virtual void onSerializationEnded(IReflectable* obj) {}
  49. virtual void onDeserializationStarted(IReflectable* obj) {}
  50. virtual void onDeserializationEnded(IReflectable* obj) {}
  51. template <class ObjectType, class DataType>
  52. void setPlainValue(ObjectType* object, const String& name, DataType& value)
  53. {
  54. RTTIField* genericField = findField(name);
  55. genericField->checkIsPlain(false);
  56. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  57. field->setValue(object, value);
  58. }
  59. template <class ObjectType, class DataType>
  60. void setPlainArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
  61. {
  62. RTTIField* genericField = findField(name);
  63. genericField->checkIsPlain(true);
  64. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  65. field->setArrayValue(object, index, value);
  66. }
  67. template <class ObjectType, class DataType>
  68. void setReflectableValue(ObjectType* object, const String& name, DataType& value)
  69. {
  70. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  71. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  72. RTTIField* genericField = findField(name);
  73. genericField->checkIsComplex(false);
  74. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  75. field->setValue(object, value);
  76. }
  77. template <class ObjectType, class DataType>
  78. void setReflectableArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
  79. {
  80. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  81. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  82. RTTIField* genericField = findField(name);
  83. genericField->checkIsComplex(true);
  84. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  85. field->setArrayValue(object, index, value);
  86. }
  87. template <class ObjectType>
  88. void setDataBlockValue(ObjectType* object, const String& name, ManagedDataBlock value)
  89. {
  90. RTTIField* genericField = findField(name);
  91. genericField->checkIsDataBlock();
  92. RTTIManagedDataBlockFieldBase* field = static_cast<RTTIManagedDataBlockFieldBase*>(genericField);
  93. field->setValue(object, value);
  94. }
  95. template <class ObjectType, class DataType>
  96. void setReflectablePtrValue(ObjectType* object, const String& name, std::shared_ptr<DataType> value)
  97. {
  98. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  99. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  100. RTTIField* genericField = findField(name);
  101. genericField->checkIsComplexPtr(false);
  102. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  103. field->setValue(object, value);
  104. }
  105. template <class ObjectType, class DataType>
  106. void setReflectablePtrArrayValue(ObjectType* object, const String& name, UINT32 index, std::shared_ptr<DataType> value)
  107. {
  108. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  109. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  110. RTTIField* genericField = findField(name);
  111. genericField->checkIsComplexPtr(true);
  112. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  113. field->setArrayValue(object, index, value);
  114. }
  115. template <class ObjectType, class DataType>
  116. void getPlainValue(ObjectType* object, const String& name, DataType& value)
  117. {
  118. RTTIField* genericField = findField(name);
  119. genericField->checkIsPlain(false);
  120. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  121. field->getValue(object, value);
  122. }
  123. template <class ObjectType, class DataType>
  124. void getPlainArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
  125. {
  126. RTTIField* genericField = findField(name);
  127. genericField->checkIsPlain(true);
  128. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  129. field->getArrayValue(object, index, value);
  130. }
  131. template <class ObjectType>
  132. IReflectable& getReflectableValue(ObjectType* object, const String& name)
  133. {
  134. RTTIField* genericField = findField(name);
  135. genericField->checkIsComplex(false);
  136. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  137. return field->getValue(object);
  138. }
  139. template <class ObjectType>
  140. IReflectable& getReflectableArrayValue(ObjectType* object, const String& name, UINT32 index)
  141. {
  142. RTTIField* genericField = findField(name);
  143. genericField->checkIsComplex(true);
  144. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  145. return field->getArrayValue(object, index);
  146. }
  147. template <class ObjectType>
  148. ManagedDataBlock getDataBlockValue(ObjectType* object, const String& name)
  149. {
  150. RTTIField* genericField = findField(name);
  151. genericField->checkIsDataBlock();
  152. RTTIManagedDataBlockFieldBase* field = static_cast<RTTIManagedDataBlockFieldBase*>(genericField);
  153. return field->getValue(object);
  154. }
  155. template <class ObjectType>
  156. std::shared_ptr<IReflectable> getReflectablePtrValue(ObjectType* object, const String& name)
  157. {
  158. RTTIField* genericField = findField(name);
  159. genericField->checkIsComplexPtr(false);
  160. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  161. return field->getValue(object);
  162. }
  163. template <class ObjectType>
  164. std::shared_ptr<IReflectable> getReflectablePtrArrayValue(ObjectType* object, const String& name, UINT32 index)
  165. {
  166. RTTIField* genericField = findField(name);
  167. genericField->checkIsComplexPtr(true);
  168. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  169. return field->getArrayValue(object, index);
  170. }
  171. template <class ObjectType>
  172. UINT32 getArraySize(ObjectType* object, const String& name)
  173. {
  174. RTTIField* field = findField(name);
  175. return field->getArraySize(object);
  176. }
  177. template <class ObjectType>
  178. void setArraySize(ObjectType* object, const String& name, UINT32 size)
  179. {
  180. RTTIField* field = findField(name);
  181. field->setArraySize(object, size);
  182. }
  183. UINT32 getNumFields() { return (UINT32)mFields.size(); }
  184. RTTIField* getField(UINT32 idx) { return mFields.at(idx); }
  185. /**
  186. * @brief Tries to find a field with the specified name. Throws an exception if it can't.
  187. *
  188. * @param name The name of the field.
  189. */
  190. RTTIField* findField(const String& name);
  191. /**
  192. * @brief Tries to find a field with the specified unique ID. Doesn't throw an exception
  193. * if it can't find the field (Unlike findField(name)).
  194. *
  195. * @param uniqueFieldId Unique identifier for the field.
  196. *
  197. * @return nullptr if it can't find the field.
  198. */
  199. RTTIField* findField(int uniqueFieldId);
  200. protected:
  201. /**
  202. * @brief Tries to add a new field to the fields array, and throws an exception
  203. * if a field with the same name or id already exists.
  204. *
  205. * @param [in] field Field, must be non-null.
  206. */
  207. void addNewField(RTTIField* field);
  208. /**
  209. * @brief Checks if the templated DataType has any references back to us, that aren't weak.
  210. *
  211. * @note This method assumes this class holds a non-weak reference to DataType.
  212. * DataType must derive from IReflectable and implement getRTTIStatic method.
  213. */
  214. template<class DataType>
  215. void checkForCircularReferences()
  216. {
  217. RTTITypeBase* type = DataType::getRTTIStatic();
  218. for(UINT32 i = 0; i < type->getNumFields(); i++)
  219. {
  220. RTTIField* field = type->getField(i);
  221. if(!field->isReflectablePtrType())
  222. continue;
  223. RTTIReflectablePtrFieldBase* reflectablePtrField = static_cast<RTTIReflectablePtrFieldBase*>(field);
  224. if(reflectablePtrField->getRTTIId() == getRTTIId() && ((reflectablePtrField->getFlags() & RTTI_Flag_WeakRef) == 0))
  225. {
  226. throwCircularRefException(getRTTIName(), reflectablePtrField->getRTTIName());
  227. }
  228. }
  229. }
  230. /**
  231. * @brief Throws an exception warning the user that a circular reference was found.
  232. *
  233. * @note Only a separate function so I don't need to include CmException header.
  234. */
  235. void throwCircularRefException(const String& myType, const String& otherType) const;
  236. private:
  237. Vector<RTTIField*>::type mFields;
  238. };
  239. /**
  240. * @brief Used for initializing a certain type as soon as the program is loaded.
  241. */
  242. template<typename Type, typename BaseType>
  243. struct InitRTTIOnStart
  244. {
  245. public:
  246. InitRTTIOnStart()
  247. {
  248. BaseType::getRTTIStatic()->registerDerivedClass(Type::getRTTIStatic());
  249. }
  250. void makeSureIAmInstantiated() { }
  251. };
  252. /**
  253. * @brief Specialization for root class of RTTI hierarchy - IReflectable
  254. */
  255. template<typename Type>
  256. struct InitRTTIOnStart<Type, IReflectable>
  257. {
  258. public:
  259. InitRTTIOnStart()
  260. {
  261. IReflectable::registerDerivedClass(Type::getRTTIStatic());
  262. }
  263. void makeSureIAmInstantiated() { }
  264. };
  265. /**
  266. * @brief Template that returns RTTI type of the specified type, unless the specified
  267. * type is IReflectable in which case it returns a null.
  268. */
  269. template<typename Type>
  270. struct GetRTTIType
  271. {
  272. RTTITypeBase* operator()() { return Type::getRTTIStatic(); }
  273. };
  274. template<>
  275. struct GetRTTIType<IReflectable>
  276. {
  277. RTTITypeBase* operator()() { return nullptr; }
  278. };
  279. /**
  280. * @brief Allows you to provide a run-time type information for a specific class, along with
  281. * support for serialization/deserialization.
  282. *
  283. * Derive from this class and return the derived class from IReflectable::getRTTI.
  284. * This way you can separate serialization logic from
  285. * the actual class you're serializing.
  286. */
  287. template <typename Type, typename BaseType, typename MyRTTIType>
  288. class RTTIType : public RTTITypeBase
  289. {
  290. protected:
  291. /************************************************************************/
  292. /* RTTI CLASS META DATA */
  293. /************************************************************************/
  294. static InitRTTIOnStart<Type, BaseType> initOnStart;
  295. public:
  296. RTTIType()
  297. {
  298. // Compiler will only generate code for stuff that is directly used, including static data members,
  299. // so we fool it here like we're using the class directly. Otherwise compiler won't generate the code for the member
  300. // and our type won't get initialized on start (Actual behavior is a bit more random)
  301. initOnStart.makeSureIAmInstantiated();
  302. }
  303. virtual ~RTTIType() {}
  304. static MyRTTIType* instance()
  305. {
  306. static MyRTTIType inst;
  307. return &inst;
  308. }
  309. virtual Vector<RTTITypeBase*>::type& getDerivedClasses()
  310. {
  311. static Vector<RTTITypeBase*>::type mRTTIDerivedClasses;
  312. return mRTTIDerivedClasses;
  313. }
  314. virtual RTTITypeBase* getBaseClass()
  315. {
  316. return GetRTTIType<BaseType>()();
  317. }
  318. virtual void registerDerivedClass(RTTITypeBase* derivedClass)
  319. {
  320. if(IReflectable::isTypeIdDuplicate(derivedClass->getRTTIId()))
  321. {
  322. CM_EXCEPT(InternalErrorException, "RTTI type \"" + derivedClass->getRTTIName() +
  323. "\" has a duplicate ID: " + toString(derivedClass->getRTTIId()));
  324. }
  325. getDerivedClasses().push_back(derivedClass);
  326. }
  327. /************************************************************************/
  328. /* FIELDS OPERATING DIRECTLY ON SERIALIZABLE OBJECT */
  329. /************************************************************************/
  330. template<class ObjectType, class DataType>
  331. void addPlainField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(),
  332. void (ObjectType::*setter)(DataType&) = nullptr, UINT64 flags = 0)
  333. {
  334. addPlainField<ObjectType, DataType>(name, uniqueId,
  335. boost::function<DataType&(ObjectType*)>(getter),
  336. boost::function<void(ObjectType*, DataType&)>(setter), flags);
  337. }
  338. template<class ObjectType, class DataType>
  339. void addReflectableField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(),
  340. void (ObjectType::*setter)(DataType&) = nullptr, UINT64 flags = 0)
  341. {
  342. addReflectableField<ObjectType, DataType>(name, uniqueId,
  343. boost::function<DataType&(ObjectType*)>(getter),
  344. boost::function<void(ObjectType*, DataType&)>(setter), flags);
  345. }
  346. template<class ObjectType, class DataType>
  347. void addReflectablePtrField(const String& name, UINT32 uniqueId, std::shared_ptr<DataType> (ObjectType::*getter)(),
  348. void (ObjectType::*setter)(std::shared_ptr<DataType>) = nullptr, UINT64 flags = 0)
  349. {
  350. addReflectablePtrField<ObjectType, DataType>(name, uniqueId,
  351. boost::function<std::shared_ptr<DataType>(ObjectType*)>(getter),
  352. boost::function<void(ObjectType*, std::shared_ptr<DataType>)>(setter), flags);
  353. }
  354. template<class ObjectType, class DataType>
  355. void addPlainArrayField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
  356. void (ObjectType::*setter)(UINT32, DataType&) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
  357. {
  358. addPlainArrayField<ObjectType, DataType>(name, uniqueId,
  359. boost::function<DataType&(ObjectType*, UINT32)>(getter),
  360. boost::function<UINT32(ObjectType*)>(getSize),
  361. boost::function<void(ObjectType*, UINT32, DataType&)>(setter),
  362. boost::function<void(ObjectType*, UINT32)>(setSize), flags);
  363. }
  364. template<class ObjectType, class DataType>
  365. void addReflectableArrayField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
  366. void (ObjectType::*setter)(UINT32, DataType&) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
  367. {
  368. addReflectableArrayField<ObjectType, DataType>(name, uniqueId,
  369. boost::function<DataType&(ObjectType*, UINT32)>(getter),
  370. boost::function<UINT32(ObjectType*)>(getSize),
  371. boost::function<void(ObjectType*, UINT32, DataType&)>(setter),
  372. boost::function<void(ObjectType*, UINT32)>(setSize), flags);
  373. }
  374. template<class ObjectType, class DataType>
  375. void addReflectablePtrArrayField(const String& name, UINT32 uniqueId, std::shared_ptr<DataType> (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
  376. void (ObjectType::*setter)(UINT32, std::shared_ptr<DataType>) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
  377. {
  378. addReflectablePtrArrayField<ObjectType, DataType>(name, uniqueId,
  379. boost::function<std::shared_ptr<DataType>(ObjectType*, UINT32)>(getter),
  380. boost::function<UINT32(ObjectType*)>(getSize),
  381. boost::function<void(ObjectType*, UINT32, std::shared_ptr<DataType>)>(setter),
  382. boost::function<void(ObjectType*, UINT32)>(setSize), flags);
  383. }
  384. template<class ObjectType>
  385. void addDataBlockField(const String& name, UINT32 uniqueId, ManagedDataBlock (ObjectType::*getter)(),
  386. void (ObjectType::*setter)(ManagedDataBlock) = nullptr, UINT64 flags = 0, UINT8* (customAllocator)(ObjectType*, UINT32) = 0)
  387. {
  388. addDataBlockField<ObjectType>(name, uniqueId,
  389. boost::function<ManagedDataBlock(ObjectType*)>(getter),
  390. boost::function<void(ObjectType*, ManagedDataBlock)>(setter), flags, customAllocator);
  391. }
  392. protected:
  393. virtual void initSerializableFields() {}
  394. /************************************************************************/
  395. /* FIELDS OPERATING ON DERIVED SERIALIZATION INTERFACE */
  396. /* (Needs an extra pointer to the actual object) */
  397. /************************************************************************/
  398. template<class InterfaceType, class ObjectType, class DataType>
  399. void addPlainField(const String& name, UINT32 uniqueId,
  400. DataType& (InterfaceType::*getter)(ObjectType*),
  401. void (InterfaceType::*setter)(ObjectType*, DataType&), UINT64 flags = 0)
  402. {
  403. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::RTTIType<Type, BaseType, MyRTTIType>, InterfaceType>::value),
  404. "Class with the get/set methods must derive from CamelotFramework::RTTIType.");
  405. BOOST_STATIC_ASSERT_MSG(!(boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  406. "Data type derives from IReflectable but it is being added as a plain field.");
  407. addPlainField<ObjectType, DataType>(name, uniqueId,
  408. boost::function<DataType&(ObjectType*)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1)),
  409. boost::function<void(ObjectType*, DataType&)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  410. }
  411. template<class InterfaceType, class ObjectType, class DataType>
  412. void addReflectableField(const String& name, UINT32 uniqueId,
  413. DataType& (InterfaceType::*getter)(ObjectType*),
  414. void (InterfaceType::*setter)(ObjectType*, DataType&), UINT64 flags = 0)
  415. {
  416. addReflectableField<ObjectType, DataType>(name, uniqueId,
  417. boost::function<DataType&(ObjectType*)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1)),
  418. boost::function<void(ObjectType*, DataType&)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  419. }
  420. template<class InterfaceType, class ObjectType, class DataType>
  421. void addReflectablePtrField(const String& name, UINT32 uniqueId,
  422. std::shared_ptr<DataType> (InterfaceType::*getter)(ObjectType*),
  423. void (InterfaceType::*setter)(ObjectType*, std::shared_ptr<DataType>), UINT64 flags = 0)
  424. {
  425. addReflectablePtrField<ObjectType, DataType>(name, uniqueId,
  426. boost::function<std::shared_ptr<DataType>(ObjectType*)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1)),
  427. boost::function<void(ObjectType*, std::shared_ptr<DataType>)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  428. }
  429. template<class InterfaceType, class ObjectType, class DataType>
  430. void addPlainArrayField(const String& name, UINT32 uniqueId,
  431. DataType& (InterfaceType::*getter)(ObjectType*, UINT32),
  432. UINT32 (InterfaceType::*getSize)(ObjectType*),
  433. void (InterfaceType::*setter)(ObjectType*, UINT32, DataType&),
  434. void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
  435. {
  436. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::RTTIType<Type, BaseType, MyRTTIType>, InterfaceType>::value),
  437. "Class with the get/set methods must derive from CamelotFramework::RTTIType.");
  438. BOOST_STATIC_ASSERT_MSG(!(boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  439. "Data type derives from IReflectable but it is being added as a plain field.");
  440. addPlainArrayField<ObjectType, DataType>(name, uniqueId,
  441. boost::function<DataType&(ObjectType*, UINT32)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
  442. boost::function<UINT32(ObjectType*)>(boost::bind(getSize, static_cast<InterfaceType*>(this), _1)),
  443. boost::function<void(ObjectType*, UINT32, DataType&)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
  444. boost::function<void(ObjectType*, UINT32)>(boost::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
  445. }
  446. template<class InterfaceType, class ObjectType, class DataType>
  447. void addReflectableArrayField(const String& name, UINT32 uniqueId,
  448. DataType& (InterfaceType::*getter)(ObjectType*, UINT32),
  449. UINT32 (InterfaceType::*getSize)(ObjectType*),
  450. void (InterfaceType::*setter)(ObjectType*, UINT32, DataType&),
  451. void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
  452. {
  453. addReflectableArrayField<ObjectType, DataType>(name, uniqueId,
  454. boost::function<DataType&(ObjectType*, UINT32)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
  455. boost::function<UINT32(ObjectType*)>(boost::bind(getSize, static_cast<InterfaceType*>(this), _1)),
  456. boost::function<void(ObjectType*, UINT32, DataType&)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
  457. boost::function<void(ObjectType*, UINT32)>(boost::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
  458. }
  459. template<class InterfaceType, class ObjectType, class DataType>
  460. void addReflectablePtrArrayField(const String& name, UINT32 uniqueId,
  461. std::shared_ptr<DataType> (InterfaceType::*getter)(ObjectType*, UINT32),
  462. UINT32 (InterfaceType::*getSize)(ObjectType*),
  463. void (InterfaceType::*setter)(ObjectType*, UINT32, std::shared_ptr<DataType>),
  464. void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
  465. {
  466. addReflectablePtrArrayField<ObjectType, DataType>(name, uniqueId,
  467. boost::function<std::shared_ptr<DataType>(ObjectType*, UINT32)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
  468. boost::function<UINT32(ObjectType*)>(boost::bind(getSize, static_cast<InterfaceType*>(this), _1)),
  469. boost::function<void(ObjectType*, UINT32, std::shared_ptr<DataType>)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
  470. boost::function<void(ObjectType*, UINT32)>(boost::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
  471. }
  472. template<class InterfaceType, class ObjectType>
  473. void addDataBlockField(const String& name, UINT32 uniqueId, ManagedDataBlock (InterfaceType::*getter)(ObjectType*),
  474. void (InterfaceType::*setter)(ObjectType*, ManagedDataBlock), UINT64 flags = 0,
  475. UINT8* (customAllocator)(ObjectType*, UINT32) = 0)
  476. {
  477. if(customAllocator != 0)
  478. {
  479. addDataBlockField<ObjectType>(name, uniqueId,
  480. boost::function<ManagedDataBlock(ObjectType*)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1)),
  481. boost::function<void(ObjectType*, ManagedDataBlock)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags,
  482. boost::function<UINT8*(ObjectType*, UINT32)>(customAllocator));
  483. }
  484. else
  485. {
  486. addDataBlockField<ObjectType>(name, uniqueId,
  487. boost::function<ManagedDataBlock(ObjectType*)>(boost::bind(getter, static_cast<InterfaceType*>(this), _1)),
  488. boost::function<void(ObjectType*, ManagedDataBlock)>(boost::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  489. }
  490. }
  491. private:
  492. template<class ObjectType, class DataType>
  493. void addPlainField(const String& name, UINT32 uniqueId, boost::any getter, boost::any setter, UINT64 flags)
  494. {
  495. RTTIPlainField<DataType, ObjectType>* newField =
  496. cm_new<RTTIPlainField<DataType, ObjectType>>();
  497. newField->initSingle(name, uniqueId, getter, setter, flags);
  498. addNewField(newField);
  499. }
  500. template<class ObjectType, class DataType>
  501. void addReflectableField(const String& name, UINT32 uniqueId, boost::any getter, boost::any setter, UINT64 flags)
  502. {
  503. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  504. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  505. RTTIReflectableField<DataType, ObjectType>* newField =
  506. cm_new<RTTIReflectableField<DataType, ObjectType>>();
  507. newField->initSingle(name, uniqueId, getter, setter, flags);
  508. addNewField(newField);
  509. }
  510. template<class ObjectType, class DataType>
  511. void addReflectablePtrField(const String& name, UINT32 uniqueId, boost::any getter, boost::any setter, UINT64 flags)
  512. {
  513. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  514. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  515. if((flags & RTTI_Flag_WeakRef) == 0)
  516. checkForCircularReferences<DataType>();
  517. RTTIReflectablePtrField<DataType, ObjectType>* newField =
  518. cm_new<RTTIReflectablePtrField<DataType, ObjectType>>();
  519. newField->initSingle(name, uniqueId, getter, setter, flags);
  520. addNewField(newField);
  521. }
  522. template<class ObjectType, class DataType>
  523. void addPlainArrayField(const String& name, UINT32 uniqueId, boost::any getter, boost::any getSize,
  524. boost::any setter, boost::any setSize, UINT64 flags)
  525. {
  526. RTTIPlainField<DataType, ObjectType>* newField =
  527. cm_new<RTTIPlainField<DataType, ObjectType>>();
  528. newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
  529. addNewField(newField);
  530. }
  531. template<class ObjectType, class DataType>
  532. void addReflectableArrayField(const String& name, UINT32 uniqueId, boost::any getter, boost::any getSize,
  533. boost::any setter, boost::any setSize, UINT64 flags)
  534. {
  535. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  536. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  537. RTTIReflectableField<DataType, ObjectType>* newField =
  538. cm_new<RTTIReflectableField<DataType, ObjectType>>();
  539. newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
  540. addNewField(newField);
  541. }
  542. template<class ObjectType, class DataType>
  543. void addReflectablePtrArrayField(const String& name, UINT32 uniqueId, boost::any getter, boost::any getSize,
  544. boost::any setter, boost::any setSize, UINT64 flags)
  545. {
  546. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, DataType>::value),
  547. "Invalid data type for complex field. It needs to derive from CamelotFramework::IReflectable.");
  548. if((flags & RTTI_Flag_WeakRef) == 0)
  549. checkForCircularReferences<DataType>();
  550. RTTIReflectablePtrField<DataType, ObjectType>* newField =
  551. cm_new<RTTIReflectablePtrField<DataType, ObjectType>>();
  552. newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
  553. addNewField(newField);
  554. }
  555. template<class ObjectType>
  556. void addDataBlockField(const String& name, UINT32 uniqueId, boost::any getter, boost::any setter, UINT64 flags, boost::any customAllocator = boost::any())
  557. {
  558. RTTIManagedDataBlockField<ManagedDataBlock, ObjectType>* newField =
  559. cm_new<RTTIManagedDataBlockField<ManagedDataBlock, ObjectType>>();
  560. newField->initSingle(name, uniqueId, getter, setter, flags, customAllocator);
  561. addNewField(newField);
  562. }
  563. };
  564. template <typename Type, typename BaseType, typename MyRTTIType>
  565. InitRTTIOnStart<Type, BaseType> RTTIType<Type, BaseType, MyRTTIType>::initOnStart;
  566. /**
  567. * @brief Returns true if the provided object can be safely cast into type T.
  568. */
  569. template<class T>
  570. bool rtti_is_of_type(IReflectable* object)
  571. {
  572. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, T>::value),
  573. "Invalid data type for type checking. It needs to derive from CamelotFramework::IReflectable.");
  574. return object->getTypeId() == T::getRTTIStatic()->getRTTIId();
  575. }
  576. /**
  577. * @brief Returns true if the provided object can be safely cast into type T.
  578. */
  579. template<class T>
  580. bool rtti_is_of_type(std::shared_ptr<IReflectable> object)
  581. {
  582. BOOST_STATIC_ASSERT_MSG((boost::is_base_of<CamelotFramework::IReflectable, T>::value),
  583. "Invalid data type for type checking. It needs to derive from CamelotFramework::IReflectable.");
  584. return object->getTypeId() == T::getRTTIStatic()->getRTTIId();
  585. }
  586. }