2
0

ObjectStream.h 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. // SPDX-FileCopyrightText: 2021 Jorrit Rouwe
  2. // SPDX-License-Identifier: MIT
  3. #pragma once
  4. #include <Jolt/Core/StaticArray.h>
  5. #include <Jolt/Core/Reference.h>
  6. #include <Jolt/ObjectStream/SerializableAttribute.h>
  7. #include <Jolt/Core/RTTI.h>
  8. JPH_NAMESPACE_BEGIN
  9. /// Base class for object stream input and output streams.
  10. class ObjectStream
  11. {
  12. public:
  13. /// Stream type
  14. enum class EStreamType
  15. {
  16. Text,
  17. Binary,
  18. };
  19. protected:
  20. /// Constructor
  21. virtual ~ObjectStream() = default;
  22. /// Identifier for objects
  23. using Identifier = uint32;
  24. static constexpr int sVersion = 1;
  25. static constexpr int sRevision = 0;
  26. static constexpr Identifier sNullIdentifier = 0;
  27. };
  28. /// Interface class for reading from an object stream
  29. class IObjectStreamIn : public ObjectStream
  30. {
  31. public:
  32. ///@name Input type specific operations
  33. virtual bool ReadDataType(EOSDataType &outType) = 0;
  34. virtual bool ReadName(String &outName) = 0;
  35. virtual bool ReadIdentifier(Identifier &outIdentifier) = 0;
  36. virtual bool ReadCount(uint32 &outCount) = 0;
  37. ///@name Read primitives
  38. virtual bool ReadPrimitiveData(uint8 &outPrimitive) = 0;
  39. virtual bool ReadPrimitiveData(uint16 &outPrimitive) = 0;
  40. virtual bool ReadPrimitiveData(int &outPrimitive) = 0;
  41. virtual bool ReadPrimitiveData(uint32 &outPrimitive) = 0;
  42. virtual bool ReadPrimitiveData(uint64 &outPrimitive) = 0;
  43. virtual bool ReadPrimitiveData(float &outPrimitive) = 0;
  44. virtual bool ReadPrimitiveData(bool &outPrimitive) = 0;
  45. virtual bool ReadPrimitiveData(String &outPrimitive) = 0;
  46. virtual bool ReadPrimitiveData(Float3 &outPrimitive) = 0;
  47. virtual bool ReadPrimitiveData(Vec3 &outPrimitive) = 0;
  48. virtual bool ReadPrimitiveData(Vec4 &outPrimitive) = 0;
  49. virtual bool ReadPrimitiveData(Quat &outPrimitive) = 0;
  50. virtual bool ReadPrimitiveData(Mat44 &outPrimitive) = 0;
  51. ///@name Read compounds
  52. virtual bool ReadClassData(const char *inClassName, void *inInstance) = 0;
  53. virtual bool ReadPointerData(const RTTI *inRTTI, void **inPointer, int inRefCountOffset = -1) = 0;
  54. };
  55. /// Interface class for writing to an object stream
  56. class IObjectStreamOut : public ObjectStream
  57. {
  58. public:
  59. ///@name Output type specific operations
  60. virtual void WriteDataType(EOSDataType inType) = 0;
  61. virtual void WriteName(const char *inName) = 0;
  62. virtual void WriteIdentifier(Identifier inIdentifier) = 0;
  63. virtual void WriteCount(uint32 inCount) = 0;
  64. ///@name Write primitives
  65. virtual void WritePrimitiveData(const uint8 &inPrimitive) = 0;
  66. virtual void WritePrimitiveData(const uint16 &inPrimitive) = 0;
  67. virtual void WritePrimitiveData(const int &inPrimitive) = 0;
  68. virtual void WritePrimitiveData(const uint32 &inPrimitive) = 0;
  69. virtual void WritePrimitiveData(const uint64 &inPrimitive) = 0;
  70. virtual void WritePrimitiveData(const float &inPrimitive) = 0;
  71. virtual void WritePrimitiveData(const bool &inPrimitive) = 0;
  72. virtual void WritePrimitiveData(const String &inPrimitive) = 0;
  73. virtual void WritePrimitiveData(const Float3 &inPrimitive) = 0;
  74. virtual void WritePrimitiveData(const Vec3 &inPrimitive) = 0;
  75. virtual void WritePrimitiveData(const Vec4 &inPrimitive) = 0;
  76. virtual void WritePrimitiveData(const Quat &inPrimitive) = 0;
  77. virtual void WritePrimitiveData(const Mat44 &inPrimitive) = 0;
  78. ///@name Write compounds
  79. virtual void WritePointerData(const RTTI *inRTTI, const void *inPointer) = 0;
  80. virtual void WriteClassData(const RTTI *inRTTI, const void *inInstance) = 0;
  81. ///@name Layout hints (for text output)
  82. virtual void HintNextItem() { /* Default is do nothing */ }
  83. virtual void HintIndentUp() { /* Default is do nothing */ }
  84. virtual void HintIndentDown() { /* Default is do nothing */ }
  85. };
  86. // Define macro to declare functions for a specific primitive type
  87. #define JPH_DECLARE_PRIMITIVE(name) \
  88. bool OSIsType(name *, int inArrayDepth, EOSDataType inDataType, const char *inClassName); \
  89. bool OSReadData(IObjectStreamIn &ioStream, name &outPrimitive); \
  90. void OSWriteDataType(IObjectStreamOut &ioStream, name *); \
  91. void OSWriteData(IObjectStreamOut &ioStream, const name &inPrimitive);
  92. // This file uses the JPH_DECLARE_PRIMITIVE macro to define all types
  93. #include <Jolt/ObjectStream/ObjectStreamTypes.h>
  94. // Define serialization templates
  95. template <class T>
  96. bool OSIsType(Array<T> *, int inArrayDepth, EOSDataType inDataType, const char *inClassName)
  97. {
  98. return (inArrayDepth > 0 && OSIsType((T *)nullptr, inArrayDepth - 1, inDataType, inClassName));
  99. }
  100. template <class T, uint N>
  101. bool OSIsType(StaticArray<T, N> *, int inArrayDepth, EOSDataType inDataType, const char *inClassName)
  102. {
  103. return (inArrayDepth > 0 && OSIsType((T *)nullptr, inArrayDepth - 1, inDataType, inClassName));
  104. }
  105. template <class T, uint N>
  106. bool OSIsType(T (*)[N], int inArrayDepth, EOSDataType inDataType, const char *inClassName)
  107. {
  108. return (inArrayDepth > 0 && OSIsType((T *)nullptr, inArrayDepth - 1, inDataType, inClassName));
  109. }
  110. template <class T>
  111. bool OSIsType(Ref<T> *, int inArrayDepth, EOSDataType inDataType, const char *inClassName)
  112. {
  113. return OSIsType((T *)nullptr, inArrayDepth, inDataType, inClassName);
  114. }
  115. template <class T>
  116. bool OSIsType(RefConst<T> *, int inArrayDepth, EOSDataType inDataType, const char *inClassName)
  117. {
  118. return OSIsType((T *)nullptr, inArrayDepth, inDataType, inClassName);
  119. }
  120. /// Define serialization templates for dynamic arrays
  121. template <class T>
  122. bool OSReadData(IObjectStreamIn &ioStream, Array<T> &inArray)
  123. {
  124. bool continue_reading = true;
  125. // Read array length
  126. uint32 array_length;
  127. continue_reading = ioStream.ReadCount(array_length);
  128. // Read array items
  129. if (continue_reading)
  130. {
  131. inArray.resize(array_length);
  132. for (uint32 el = 0; el < array_length && continue_reading; ++el)
  133. continue_reading = OSReadData(ioStream, inArray[el]);
  134. }
  135. return continue_reading;
  136. }
  137. /// Define serialization templates for static arrays
  138. template <class T, uint N>
  139. bool OSReadData(IObjectStreamIn &ioStream, StaticArray<T, N> &inArray)
  140. {
  141. bool continue_reading = true;
  142. // Read array length
  143. uint32 array_length;
  144. continue_reading = ioStream.ReadCount(array_length);
  145. // Check if we can fit this many elements
  146. if (array_length > N)
  147. return false;
  148. // Read array items
  149. if (continue_reading)
  150. {
  151. inArray.resize(array_length);
  152. for (uint32 el = 0; el < array_length && continue_reading; ++el)
  153. continue_reading = OSReadData(ioStream, inArray[el]);
  154. }
  155. return continue_reading;
  156. }
  157. /// Define serialization templates for C style arrays
  158. template <class T, uint N>
  159. bool OSReadData(IObjectStreamIn &ioStream, T (&inArray)[N])
  160. {
  161. bool continue_reading = true;
  162. // Read array length
  163. uint32 array_length;
  164. continue_reading = ioStream.ReadCount(array_length);
  165. if (array_length != N)
  166. return false;
  167. // Read array items
  168. for (uint32 el = 0; el < N && continue_reading; ++el)
  169. continue_reading = OSReadData(ioStream, inArray[el]);
  170. return continue_reading;
  171. }
  172. /// Define serialization templates for references
  173. template <class T>
  174. bool OSReadData(IObjectStreamIn &ioStream, Ref<T> &inRef)
  175. {
  176. return ioStream.ReadPointerData(JPH_RTTI(T), inRef.InternalGetPointer(), T::sInternalGetRefCountOffset());
  177. }
  178. template <class T>
  179. bool OSReadData(IObjectStreamIn &ioStream, RefConst<T> &inRef)
  180. {
  181. return ioStream.ReadPointerData(JPH_RTTI(T), inRef.InternalGetPointer(), T::sInternalGetRefCountOffset());
  182. }
  183. // Define serialization templates for dynamic arrays
  184. template <class T>
  185. void OSWriteDataType(IObjectStreamOut &ioStream, Array<T> *)
  186. {
  187. ioStream.WriteDataType(EOSDataType::Array);
  188. OSWriteDataType(ioStream, (T *)nullptr);
  189. }
  190. template <class T>
  191. void OSWriteData(IObjectStreamOut &ioStream, const Array<T> &inArray)
  192. {
  193. // Write size of array
  194. ioStream.HintNextItem();
  195. ioStream.WriteCount((uint32)inArray.size());
  196. // Write data in array
  197. ioStream.HintIndentUp();
  198. for (const T &v : inArray)
  199. OSWriteData(ioStream, v);
  200. ioStream.HintIndentDown();
  201. }
  202. /// Define serialization templates for static arrays
  203. template <class T, uint N>
  204. void OSWriteDataType(IObjectStreamOut &ioStream, StaticArray<T, N> *)
  205. {
  206. ioStream.WriteDataType(EOSDataType::Array);
  207. OSWriteDataType(ioStream, (T *)nullptr);
  208. }
  209. template <class T, uint N>
  210. void OSWriteData(IObjectStreamOut &ioStream, const StaticArray<T, N> &inArray)
  211. {
  212. // Write size of array
  213. ioStream.HintNextItem();
  214. ioStream.WriteCount(inArray.size());
  215. // Write data in array
  216. ioStream.HintIndentUp();
  217. for (const typename StaticArray<T, N>::value_type &v : inArray)
  218. OSWriteData(ioStream, v);
  219. ioStream.HintIndentDown();
  220. }
  221. /// Define serialization templates for C style arrays
  222. template <class T, uint N>
  223. void OSWriteDataType(IObjectStreamOut &ioStream, T (*)[N])
  224. {
  225. ioStream.WriteDataType(EOSDataType::Array);
  226. OSWriteDataType(ioStream, (T *)nullptr);
  227. }
  228. template <class T, uint N>
  229. void OSWriteData(IObjectStreamOut &ioStream, const T (&inArray)[N])
  230. {
  231. // Write size of array
  232. ioStream.HintNextItem();
  233. ioStream.WriteCount((uint32)N);
  234. // Write data in array
  235. ioStream.HintIndentUp();
  236. for (const T &v : inArray)
  237. OSWriteData(ioStream, v);
  238. ioStream.HintIndentDown();
  239. }
  240. /// Define serialization templates for references
  241. template <class T>
  242. void OSWriteDataType(IObjectStreamOut &ioStream, Ref<T> *)
  243. {
  244. OSWriteDataType(ioStream, (T *)nullptr);
  245. }
  246. template <class T>
  247. void OSWriteData(IObjectStreamOut &ioStream, const Ref<T> &inRef)
  248. {
  249. if (inRef != nullptr)
  250. ioStream.WritePointerData(GetRTTI(inRef.GetPtr()), inRef.GetPtr());
  251. else
  252. ioStream.WritePointerData(nullptr, nullptr);
  253. }
  254. template <class T>
  255. void OSWriteDataType(IObjectStreamOut &ioStream, RefConst<T> *)
  256. {
  257. OSWriteDataType(ioStream, (T *)nullptr);
  258. }
  259. template <class T>
  260. void OSWriteData(IObjectStreamOut &ioStream, const RefConst<T> &inRef)
  261. {
  262. if (inRef != nullptr)
  263. ioStream.WritePointerData(GetRTTI(inRef.GetPtr()), inRef.GetPtr());
  264. else
  265. ioStream.WritePointerData(nullptr, nullptr);
  266. }
  267. JPH_NAMESPACE_END