serialize.h 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210
  1. // This file is part of libigl, a simple c++ geometry processing library.
  2. //
  3. // Copyright (C) 2014 Christian Schüller <schuellchr@gmail.com>
  4. //
  5. // This Source Code Form is subject to the terms of the Mozilla Public License
  6. // v. 2.0. If a copy of the MPL was not distributed with this file, You can
  7. // obtain one at http://mozilla.org/MPL/2.0/.
  8. #ifndef IGL_SERIALIZE_H
  9. #define IGL_SERIALIZE_H
  10. // -----------------------------------------------------------------------------
  11. // Functions to save and load a serialization of fundamental c++ data types to
  12. // and from a binary file. STL containers, Eigen matrix types and nested data
  13. // structures are also supported. To serialize a user defined class implement
  14. // the interface Serializable or SerializableBase.
  15. //
  16. // See also: xml/serialize_xml.h
  17. // -----------------------------------------------------------------------------
  18. // TODOs:
  19. // * arbitrary pointer graph structures
  20. // -----------------------------------------------------------------------------
  21. // Known issues: This is not written in libigl-style so it isn't (easily)
  22. // "dualized" into the static library.
  23. //
  24. #include <type_traits>
  25. #include <iostream>
  26. #include <fstream>
  27. #include <cstdint>
  28. #include <numeric>
  29. #include <vector>
  30. #include <set>
  31. #include <map>
  32. #include <memory>
  33. #include <cstdint>
  34. #include <Eigen/Dense>
  35. #include <Eigen/Sparse>
  36. #include "igl_inline.h"
  37. // non-intrusive serialization helper macros
  38. #define SERIALIZE_TYPE(Type,Params) \
  39. namespace igl { namespace serialization { \
  40. void _serialization(bool s,Type& obj,std::vector<char>& buffer) {Params} \
  41. template<> inline void serialize(const Type& obj,std::vector<char>& buffer) { \
  42. _serialization(true,const_cast<Type&>(obj),buffer); \
  43. } \
  44. template<> inline void deserialize(Type& obj,const std::vector<char>& buffer) { \
  45. _serialization(false,obj,const_cast<std::vector<char>&>(buffer)); \
  46. } \
  47. }}
  48. #define SERIALIZE_TYPE_SOURCE(Type,Params) \
  49. namespace igl { namespace serialization { \
  50. void _serialization(bool s,Type& obj,std::vector<char>& buffer) {Params} \
  51. void _serialize(const Type& obj,std::vector<char>& buffer) { \
  52. _serialization(true,const_cast<Type&>(obj),buffer); \
  53. } \
  54. void _deserialize(Type& obj,const std::vector<char>& buffer) { \
  55. _serialization(false,obj,const_cast<std::vector<char>&>(buffer)); \
  56. } \
  57. }}
  58. #define SERIALIZE_MEMBER(Object) igl::serializer(s,obj.Object,std::string(#Object),buffer);
  59. #define SERIALIZE_MEMBER_NAME(Object,Name) igl::serializer(s,obj.Object,std::string(Name),buffer);
  60. namespace igl
  61. {
  62. struct IndexedPointerBase;
  63. // Serializes the given object either to a file or to a provided buffer
  64. // Templates:
  65. // T type of the object to serialize
  66. // Inputs:
  67. // obj object to serialize
  68. // objectName unique object name,used for the identification
  69. // overwrite set to true to overwrite an existing file
  70. // filename name of the file containing the serialization
  71. // Outputs:
  72. // buffer binary serialization
  73. //
  74. template <typename T>
  75. inline bool serialize(const T& obj,const std::string& filename);
  76. template <typename T>
  77. inline bool serialize(const T& obj,const std::string& objectName,const std::string& filename,bool overwrite = false);
  78. template <typename T>
  79. inline bool serialize(const T& obj,const std::string& objectName,std::vector<char>& buffer);
  80. template <typename T>
  81. inline bool serialize(const T& obj,const std::string& objectName,std::vector<char>& buffer);
  82. // Deserializes the given data from a file or buffer back to the provided object
  83. //
  84. // Templates:
  85. // T type of the object to serialize
  86. // Inputs:
  87. // buffer binary serialization
  88. // objectName unique object name, used for the identification
  89. // filename name of the file containing the serialization
  90. // Outputs:
  91. // obj object to load back serialization to
  92. //
  93. template <typename T>
  94. inline bool deserialize(T& obj,const std::string& filename);
  95. template <typename T>
  96. inline bool deserialize(T& obj,const std::string& objectName,const std::string& filename);
  97. template <typename T>
  98. inline bool deserialize(T& obj,const std::string& objectName,const std::vector<char>& buffer);
  99. // Wrapper to expose both, the de- and serialization as one function
  100. //
  101. template <typename T>
  102. inline bool serializer(bool serialize,T& obj,const std::string& filename);
  103. template <typename T>
  104. inline bool serializer(bool serialize,T& obj,const std::string& objectName,const std::string& filename,bool overwrite = false);
  105. template <typename T>
  106. inline bool serializer(bool serialize,T& obj,const std::string& objectName,std::vector<char>& buffer);
  107. // User defined types have to either overload the function igl::serialization::serialize()
  108. // and igl::serialization::deserialize() for their type (non-intrusive serialization):
  109. //
  110. // namespace igl { namespace serialization
  111. // {
  112. // template<>
  113. // inline void serialize(const UserType& obj,std::vector<char>& buffer) {
  114. // ::igl::serialize(obj.var,"var",buffer);
  115. // }
  116. //
  117. // template<>
  118. // inline void deserialize(UserType& obj,const std::vector<char>& buffer) {
  119. // ::igl::deserialize(obj.var,"var",buffer);
  120. // }
  121. // }}
  122. //
  123. // or use this macro for convenience:
  124. //
  125. // SERIALIZE_TYPE(UserType,
  126. // SERIALIZE_MEMBER(var)
  127. // )
  128. //
  129. // or to derive from the class Serializable and add their the members
  130. // in InitSerialization like the following:
  131. //
  132. // class UserType : public igl::Serializable {
  133. //
  134. // int var;
  135. //
  136. // void InitSerialization() {
  137. // this->Add(var,"var");
  138. // }
  139. // };
  140. // Base interface for user defined types
  141. struct SerializableBase
  142. {
  143. virtual void Serialize(std::vector<char>& buffer) const = 0;
  144. virtual void Deserialize(const std::vector<char>& buffer) = 0;
  145. };
  146. // Convenient interface for user defined types
  147. class Serializable: public SerializableBase
  148. {
  149. private:
  150. template <typename T>
  151. struct SerializationObject : public SerializableBase
  152. {
  153. bool Binary;
  154. std::string Name;
  155. std::unique_ptr<T> Object;
  156. void Serialize(std::vector<char>& buffer) const override {
  157. igl::serialize(*Object,Name,buffer);
  158. }
  159. void Deserialize(const std::vector<char>& buffer) override {
  160. igl::deserialize(*Object,Name,buffer);
  161. }
  162. };
  163. mutable bool initialized;
  164. mutable std::vector<SerializableBase*> objects;
  165. public:
  166. // Override this function to add your member variables which should be serialized
  167. inline virtual void InitSerialization() = 0;
  168. // Following functions can be overridden to handle the specific events.
  169. // Return false to prevent the de-/serialization of an object.
  170. inline virtual bool PreSerialization() const;
  171. inline virtual void PostSerialization() const;
  172. inline virtual bool PreDeserialization();
  173. inline virtual void PostDeserialization();
  174. // Default implementation of SerializableBase interface
  175. inline void Serialize(std::vector<char>& buffer) const override final;
  176. inline void Deserialize(const std::vector<char>& buffer) override final;
  177. // Default constructor, destructor, assignment and copy constructor
  178. inline Serializable();
  179. inline Serializable(const Serializable& obj);
  180. inline ~Serializable();
  181. inline Serializable& operator=(const Serializable& obj);
  182. // Use this function to add your variables which should be serialized
  183. template <typename T>
  184. inline void Add(T& obj,std::string name,bool binary = false);
  185. };
  186. // structure for pointer handling
  187. struct IndexedPointerBase
  188. {
  189. enum { BEGIN,END } Type;
  190. size_t Index;
  191. };
  192. template<typename T>
  193. struct IndexedPointer: public IndexedPointerBase
  194. {
  195. const T* Object;
  196. };
  197. // internal functions
  198. namespace serialization
  199. {
  200. // compile time type checks
  201. template <typename T>
  202. struct is_stl_container { static const bool value = false; };
  203. template <typename T1,typename T2>
  204. struct is_stl_container<std::pair<T1,T2> > { static const bool value = true; };
  205. template <typename T1,typename T2>
  206. struct is_stl_container<std::vector<T1,T2> > { static const bool value = true; };
  207. template <typename T>
  208. struct is_stl_container<std::set<T> > { static const bool value = true; };
  209. template <typename T1,typename T2>
  210. struct is_stl_container<std::map<T1,T2> > { static const bool value = true; };
  211. template <typename T>
  212. struct is_eigen_type { static const bool value = false; };
  213. template <typename T,int R,int C,int P,int MR,int MC>
  214. struct is_eigen_type<Eigen::Matrix<T,R,C,P,MR,MC> > { static const bool value = true; };
  215. template <typename T,int P,typename I>
  216. struct is_eigen_type<Eigen::SparseMatrix<T,P,I> > { static const bool value = true; };
  217. template <typename T>
  218. struct is_smart_ptr { static const bool value = false; };
  219. template <typename T>
  220. struct is_smart_ptr<std::shared_ptr<T> > { static const bool value = true; };
  221. template <typename T>
  222. struct is_smart_ptr<std::unique_ptr<T> > { static const bool value = true; };
  223. template <typename T>
  224. struct is_smart_ptr<std::weak_ptr<T> > { static const bool value = true; };
  225. template <typename T>
  226. struct is_serializable {
  227. static const bool value = std::is_fundamental<T>::value || std::is_same<std::string,T>::value || std::is_enum<T>::value || std::is_base_of<SerializableBase,T>::value
  228. || is_stl_container<T>::value || is_eigen_type<T>::value || std::is_pointer<T>::value || serialization::is_smart_ptr<T>::value;
  229. };
  230. // non serializable types
  231. template <typename T>
  232. inline typename std::enable_if<!is_serializable<T>::value,size_t>::type getByteSize(const T& obj);
  233. template <typename T>
  234. inline typename std::enable_if<!is_serializable<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  235. template <typename T>
  236. inline typename std::enable_if<!is_serializable<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter);
  237. // fundamental types
  238. template <typename T>
  239. inline typename std::enable_if<std::is_fundamental<T>::value,size_t>::type getByteSize(const T& obj);
  240. template <typename T>
  241. inline typename std::enable_if<std::is_fundamental<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  242. template <typename T>
  243. inline typename std::enable_if<std::is_fundamental<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter);
  244. // std::string
  245. inline size_t getByteSize(const std::string& obj);
  246. inline void serialize(const std::string& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  247. inline void deserialize(std::string& obj,std::vector<char>::const_iterator& iter);
  248. // enum types
  249. template <typename T>
  250. inline typename std::enable_if<std::is_enum<T>::value,size_t>::type getByteSize(const T& obj);
  251. template <typename T>
  252. inline typename std::enable_if<std::is_enum<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  253. template <typename T>
  254. inline typename std::enable_if<std::is_enum<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter);
  255. // SerializableBase
  256. template <typename T>
  257. inline typename std::enable_if<std::is_base_of<SerializableBase,T>::value,size_t>::type getByteSize(const T& obj);
  258. template <typename T>
  259. inline typename std::enable_if<std::is_base_of<SerializableBase,T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  260. template <typename T>
  261. inline typename std::enable_if<std::is_base_of<SerializableBase,T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter);
  262. // stl containers
  263. // std::pair
  264. template <typename T1,typename T2>
  265. inline size_t getByteSize(const std::pair<T1,T2>& obj);
  266. template <typename T1,typename T2>
  267. inline void serialize(const std::pair<T1,T2>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  268. template <typename T1,typename T2>
  269. inline void deserialize(std::pair<T1,T2>& obj,std::vector<char>::const_iterator& iter);
  270. // std::vector
  271. template <typename T1,typename T2>
  272. inline size_t getByteSize(const std::vector<T1,T2>& obj);
  273. template <typename T1,typename T2>
  274. inline void serialize(const std::vector<T1,T2>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  275. template <typename T1,typename T2>
  276. inline void deserialize(std::vector<T1,T2>& obj,std::vector<char>::const_iterator& iter);
  277. template <typename T2>
  278. inline void deserialize(std::vector<bool,T2>& obj,std::vector<char>::const_iterator& iter);
  279. // std::set
  280. template <typename T>
  281. inline size_t getByteSize(const std::set<T>& obj);
  282. template <typename T>
  283. inline void serialize(const std::set<T>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  284. template <typename T>
  285. inline void deserialize(std::set<T>& obj,std::vector<char>::const_iterator& iter);
  286. // std::map
  287. template <typename T1,typename T2>
  288. inline size_t getByteSize(const std::map<T1,T2>& obj);
  289. template <typename T1,typename T2>
  290. inline void serialize(const std::map<T1,T2>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  291. template <typename T1,typename T2>
  292. inline void deserialize(std::map<T1,T2>& obj,std::vector<char>::const_iterator& iter);
  293. // Eigen types
  294. template<typename T,int R,int C,int P,int MR,int MC>
  295. inline size_t getByteSize(const Eigen::Matrix<T,R,C,P,MR,MC>& obj);
  296. template<typename T,int R,int C,int P,int MR,int MC>
  297. inline void serialize(const Eigen::Matrix<T,R,C,P,MR,MC>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  298. template<typename T,int R,int C,int P,int MR,int MC>
  299. inline void deserialize(Eigen::Matrix<T,R,C,P,MR,MC>& obj,std::vector<char>::const_iterator& iter);
  300. template<typename T,int P,typename I>
  301. inline size_t getByteSize(const Eigen::SparseMatrix<T,P,I>& obj);
  302. template<typename T,int P,typename I>
  303. inline void serialize(const Eigen::SparseMatrix<T,P,I>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  304. template<typename T,int P,typename I>
  305. inline void deserialize(Eigen::SparseMatrix<T,P,I>& obj,std::vector<char>::const_iterator& iter);
  306. template<typename T,int P>
  307. inline size_t getByteSize(const Eigen::Quaternion<T,P>& obj);
  308. template<typename T,int P>
  309. inline void serialize(const Eigen::Quaternion<T,P>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  310. template<typename T,int P>
  311. inline void deserialize(Eigen::Quaternion<T,P>& obj,std::vector<char>::const_iterator& iter);
  312. // raw pointers
  313. template <typename T>
  314. inline typename std::enable_if<std::is_pointer<T>::value,size_t>::type getByteSize(const T& obj);
  315. template <typename T>
  316. inline typename std::enable_if<std::is_pointer<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  317. template <typename T>
  318. inline typename std::enable_if<std::is_pointer<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter);
  319. // std::shared_ptr and std::unique_ptr
  320. template <typename T>
  321. inline typename std::enable_if<serialization::is_smart_ptr<T>::value,size_t>::type getByteSize(const T& obj);
  322. template <typename T>
  323. inline typename std::enable_if<serialization::is_smart_ptr<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  324. template <template<typename> class T0, typename T1>
  325. inline typename std::enable_if<serialization::is_smart_ptr<T0<T1> >::value>::type deserialize(T0<T1>& obj,std::vector<char>::const_iterator& iter);
  326. // std::weak_ptr
  327. template <typename T>
  328. inline size_t getByteSize(const std::weak_ptr<T>& obj);
  329. template <typename T>
  330. inline void serialize(const std::weak_ptr<T>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter);
  331. template <typename T>
  332. inline void deserialize(std::weak_ptr<T>& obj,std::vector<char>::const_iterator& iter);
  333. // functions to overload for non-intrusive serialization
  334. template <typename T>
  335. inline void serialize(const T& obj,std::vector<char>& buffer);
  336. template <typename T>
  337. inline void deserialize(T& obj,const std::vector<char>& buffer);
  338. // helper functions
  339. template <typename T>
  340. inline void updateMemoryMap(T& obj,size_t size);
  341. }
  342. }
  343. // Always include inlines for these functions
  344. // IMPLEMENTATION
  345. namespace igl
  346. {
  347. template <typename T>
  348. inline bool serialize(const T& obj,const std::string& filename)
  349. {
  350. return serialize(obj,"obj",filename,true);
  351. }
  352. template <typename T>
  353. inline bool serialize(const T& obj,const std::string& objectName,const std::string& filename,bool overwrite)
  354. {
  355. bool success = false;
  356. std::vector<char> buffer;
  357. std::ios_base::openmode mode = std::ios::out | std::ios::binary;
  358. if(overwrite)
  359. mode |= std::ios::trunc;
  360. else
  361. mode |= std::ios::app;
  362. std::ofstream file(filename.c_str(),mode);
  363. if(file.is_open())
  364. {
  365. serialize(obj,objectName,buffer);
  366. file.write(&buffer[0],buffer.size());
  367. file.close();
  368. success = true;
  369. }
  370. else
  371. {
  372. std::cerr << "serialization: file " << filename << " not found!" << std::endl;
  373. }
  374. return success;
  375. }
  376. template <typename T>
  377. inline bool serialize(const T& obj,const std::string& objectName,std::vector<char>& buffer)
  378. {
  379. // serialize object data
  380. size_t size = serialization::getByteSize(obj);
  381. std::vector<char> tmp(size);
  382. auto it = tmp.begin();
  383. serialization::serialize(obj,tmp,it);
  384. std::string objectType(typeid(obj).name());
  385. size_t newObjectSize = tmp.size();
  386. size_t newHeaderSize = serialization::getByteSize(objectName) + serialization::getByteSize(objectType) + sizeof(size_t);
  387. size_t curSize = buffer.size();
  388. size_t newSize = curSize + newHeaderSize + newObjectSize;
  389. buffer.resize(newSize);
  390. std::vector<char>::iterator iter = buffer.begin()+curSize;
  391. // serialize object header (name/type/size)
  392. serialization::serialize(objectName,buffer,iter);
  393. serialization::serialize(objectType,buffer,iter);
  394. serialization::serialize(newObjectSize,buffer,iter);
  395. // copy serialized data to buffer
  396. iter = std::copy(tmp.begin(),tmp.end(),iter);
  397. return true;
  398. }
  399. template <typename T>
  400. inline bool deserialize(T& obj,const std::string& filename)
  401. {
  402. return deserialize(obj,"obj",filename);
  403. }
  404. template <typename T>
  405. inline bool deserialize(T& obj,const std::string& objectName,const std::string& filename)
  406. {
  407. bool success = false;
  408. std::ifstream file(filename.c_str(),std::ios::binary);
  409. if(file.is_open())
  410. {
  411. file.seekg(0,std::ios::end);
  412. std::streamoff size = file.tellg();
  413. file.seekg(0,std::ios::beg);
  414. std::vector<char> buffer(size);
  415. file.read(&buffer[0],size);
  416. deserialize(obj,objectName,buffer);
  417. file.close();
  418. success = true;
  419. }
  420. else
  421. {
  422. std::cerr << "serialization: file " << filename << " not found!" << std::endl;
  423. }
  424. return success;
  425. }
  426. template <typename T>
  427. inline bool deserialize(T& obj,const std::string& objectName,const std::vector<char>& buffer)
  428. {
  429. bool success = false;
  430. // find suitable object header
  431. auto objectIter = buffer.cend();
  432. auto iter = buffer.cbegin();
  433. while(iter != buffer.end())
  434. {
  435. std::string name;
  436. std::string type;
  437. size_t size;
  438. serialization::deserialize(name,iter);
  439. serialization::deserialize(type,iter);
  440. serialization::deserialize(size,iter);
  441. if(name == objectName && type == typeid(obj).name())
  442. {
  443. objectIter = iter;
  444. //break; // find first suitable object header
  445. }
  446. iter+=size;
  447. }
  448. if(objectIter != buffer.end())
  449. {
  450. serialization::deserialize(obj,objectIter);
  451. success = true;
  452. }
  453. else
  454. {
  455. obj = T();
  456. }
  457. return success;
  458. }
  459. // Wrapper function which combines both, de- and serialization
  460. template <typename T>
  461. inline bool serializer(bool s,T& obj,const std::string& filename)
  462. {
  463. return s ? serialize(obj,filename) : deserialize(obj,filename);
  464. }
  465. template <typename T>
  466. inline bool serializer(bool s,T& obj,const std::string& objectName,const std::string& filename,bool overwrite)
  467. {
  468. return s ? serialize(obj,objectName,filename,overwrite) : deserialize(obj,objectName,filename);
  469. }
  470. template <typename T>
  471. inline bool serializer(bool s,T& obj,const std::string& objectName,std::vector<char>& buffer)
  472. {
  473. return s ? serialize(obj,objectName,buffer) : deserialize(obj,objectName,buffer);
  474. }
  475. inline bool Serializable::PreSerialization() const
  476. {
  477. return true;
  478. }
  479. inline void Serializable::PostSerialization() const
  480. {
  481. }
  482. inline bool Serializable::PreDeserialization()
  483. {
  484. return true;
  485. }
  486. inline void Serializable::PostDeserialization()
  487. {
  488. }
  489. inline void Serializable::Serialize(std::vector<char>& buffer) const
  490. {
  491. if(this->PreSerialization())
  492. {
  493. if(initialized == false)
  494. {
  495. objects.clear();
  496. (const_cast<Serializable*>(this))->InitSerialization();
  497. initialized = true;
  498. }
  499. for(const auto& v : objects)
  500. {
  501. v->Serialize(buffer);
  502. }
  503. this->PostSerialization();
  504. }
  505. }
  506. inline void Serializable::Deserialize(const std::vector<char>& buffer)
  507. {
  508. if(this->PreDeserialization())
  509. {
  510. if(initialized == false)
  511. {
  512. objects.clear();
  513. (const_cast<Serializable*>(this))->InitSerialization();
  514. initialized = true;
  515. }
  516. for(auto& v : objects)
  517. {
  518. v->Deserialize(buffer);
  519. }
  520. this->PostDeserialization();
  521. }
  522. }
  523. inline Serializable::Serializable()
  524. {
  525. initialized = false;
  526. }
  527. inline Serializable::Serializable(const Serializable& obj)
  528. {
  529. initialized = false;
  530. objects.clear();
  531. }
  532. inline Serializable::~Serializable()
  533. {
  534. initialized = false;
  535. objects.clear();
  536. }
  537. inline Serializable& Serializable::operator=(const Serializable& obj)
  538. {
  539. if(this != &obj)
  540. {
  541. if(initialized)
  542. {
  543. initialized = false;
  544. objects.clear();
  545. }
  546. }
  547. return *this;
  548. }
  549. template <typename T>
  550. inline void Serializable::Add(T& obj,const std::string name,bool binary)
  551. {
  552. auto object = new SerializationObject<T>();
  553. object->Binary = binary;
  554. object->Name = name;
  555. object->Object = std::unique_ptr<T>(&obj);
  556. objects.push_back(object);
  557. }
  558. namespace serialization
  559. {
  560. template <typename T>
  561. inline typename std::enable_if<!is_serializable<T>::value,size_t>::type getByteSize(const T& obj)
  562. {
  563. return sizeof(std::vector<char>::size_type);
  564. }
  565. template <typename T>
  566. inline typename std::enable_if<!is_serializable<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  567. {
  568. // data
  569. std::vector<char> tmp;
  570. serialize<>(obj,tmp);
  571. // size
  572. size_t size = buffer.size();
  573. serialization::serialize(tmp.size(),buffer,iter);
  574. size_t cur = iter - buffer.begin();
  575. buffer.resize(size+tmp.size());
  576. iter = buffer.begin()+cur;
  577. iter = std::copy(tmp.begin(),tmp.end(),iter);
  578. }
  579. template <typename T>
  580. inline typename std::enable_if<!is_serializable<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter)
  581. {
  582. std::vector<char>::size_type size;
  583. serialization::deserialize<>(size,iter);
  584. std::vector<char> tmp;
  585. tmp.resize(size);
  586. std::copy(iter,iter+size,tmp.begin());
  587. deserialize<>(obj,tmp);
  588. iter += size;
  589. }
  590. // fundamental types
  591. template <typename T>
  592. inline typename std::enable_if<std::is_fundamental<T>::value,size_t>::type getByteSize(const T& obj)
  593. {
  594. return sizeof(T);
  595. }
  596. template <typename T>
  597. inline typename std::enable_if<std::is_fundamental<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  598. {
  599. //serialization::updateMemoryMap(obj,sizeof(T));
  600. const uint8_t* ptr = reinterpret_cast<const uint8_t*>(&obj);
  601. iter = std::copy(ptr,ptr+sizeof(T),iter);
  602. }
  603. template <typename T>
  604. inline typename std::enable_if<std::is_fundamental<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter)
  605. {
  606. uint8_t* ptr = reinterpret_cast<uint8_t*>(&obj);
  607. std::copy(iter,iter+sizeof(T),ptr);
  608. iter += sizeof(T);
  609. }
  610. // std::string
  611. inline size_t getByteSize(const std::string& obj)
  612. {
  613. return getByteSize(obj.length())+obj.length()*sizeof(uint8_t);
  614. }
  615. inline void serialize(const std::string& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  616. {
  617. serialization::serialize(obj.length(),buffer,iter);
  618. for(const auto& cur : obj)
  619. {
  620. serialization::serialize(cur,buffer,iter);
  621. }
  622. }
  623. inline void deserialize(std::string& obj,std::vector<char>::const_iterator& iter)
  624. {
  625. size_t size;
  626. serialization::deserialize(size,iter);
  627. std::string str(size,'\0');
  628. for(size_t i=0; i<size; ++i)
  629. {
  630. serialization::deserialize(str.at(i),iter);
  631. }
  632. obj = str;
  633. }
  634. // enum types
  635. template <typename T>
  636. inline typename std::enable_if<std::is_enum<T>::value,size_t>::type getByteSize(const T& obj)
  637. {
  638. return sizeof(T);
  639. }
  640. template <typename T>
  641. inline typename std::enable_if<std::is_enum<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  642. {
  643. const uint8_t* ptr = reinterpret_cast<const uint8_t*>(&obj);
  644. iter = std::copy(ptr,ptr+sizeof(T),iter);
  645. }
  646. template <typename T>
  647. inline typename std::enable_if<std::is_enum<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter)
  648. {
  649. uint8_t* ptr = reinterpret_cast<uint8_t*>(&obj);
  650. std::copy(iter,iter+sizeof(T),ptr);
  651. iter += sizeof(T);
  652. }
  653. // SerializableBase
  654. template <typename T>
  655. inline typename std::enable_if<std::is_base_of<SerializableBase,T>::value,size_t>::type getByteSize(const T& obj)
  656. {
  657. return sizeof(std::vector<char>::size_type);
  658. }
  659. template <typename T>
  660. inline typename std::enable_if<std::is_base_of<SerializableBase,T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  661. {
  662. // data
  663. std::vector<char> tmp;
  664. obj.Serialize(tmp);
  665. // size
  666. size_t size = buffer.size();
  667. serialization::serialize(tmp.size(),buffer,iter);
  668. size_t cur = iter - buffer.begin();
  669. buffer.resize(size+tmp.size());
  670. iter = buffer.begin()+cur;
  671. iter = std::copy(tmp.begin(),tmp.end(),iter);
  672. }
  673. template <typename T>
  674. inline typename std::enable_if<std::is_base_of<SerializableBase,T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter)
  675. {
  676. std::vector<char>::size_type size;
  677. serialization::deserialize(size,iter);
  678. std::vector<char> tmp;
  679. tmp.resize(size);
  680. std::copy(iter,iter+size,tmp.begin());
  681. obj.Deserialize(tmp);
  682. iter += size;
  683. }
  684. // STL containers
  685. // std::pair
  686. template <typename T1,typename T2>
  687. inline size_t getByteSize(const std::pair<T1,T2>& obj)
  688. {
  689. return getByteSize(obj.first)+getByteSize(obj.second);
  690. }
  691. template <typename T1,typename T2>
  692. inline void serialize(const std::pair<T1,T2>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  693. {
  694. serialization::serialize(obj.first,buffer,iter);
  695. serialization::serialize(obj.second,buffer,iter);
  696. }
  697. template <typename T1,typename T2>
  698. inline void deserialize(std::pair<T1,T2>& obj,std::vector<char>::const_iterator& iter)
  699. {
  700. serialization::deserialize(obj.first,iter);
  701. serialization::deserialize(obj.second,iter);
  702. }
  703. // std::vector
  704. template <typename T1,typename T2>
  705. inline size_t getByteSize(const std::vector<T1,T2>& obj)
  706. {
  707. return std::accumulate(obj.begin(),obj.end(),sizeof(size_t),[](const size_t& acc,const T1& cur) { return acc+getByteSize(cur); });
  708. }
  709. template <typename T1,typename T2>
  710. inline void serialize(const std::vector<T1,T2>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  711. {
  712. size_t size = obj.size();
  713. serialization::serialize(size,buffer,iter);
  714. for(const T1& cur : obj)
  715. {
  716. serialization::serialize(cur,buffer,iter);
  717. }
  718. }
  719. template <typename T1,typename T2>
  720. inline void deserialize(std::vector<T1,T2>& obj,std::vector<char>::const_iterator& iter)
  721. {
  722. size_t size;
  723. serialization::deserialize(size,iter);
  724. obj.resize(size);
  725. for(T1& v : obj)
  726. {
  727. serialization::deserialize(v,iter);
  728. }
  729. }
  730. template <typename T2>
  731. inline void deserialize(std::vector<bool,T2>& obj,std::vector<char>::const_iterator& iter)
  732. {
  733. size_t size;
  734. serialization::deserialize(size,iter);
  735. obj.resize(size);
  736. for(int i=0;i<obj.size();i++)
  737. {
  738. bool val;
  739. serialization::deserialize(val,iter);
  740. obj[i] = val;
  741. }
  742. }
  743. //std::set
  744. template <typename T>
  745. inline size_t getByteSize(const std::set<T>& obj)
  746. {
  747. return std::accumulate(obj.begin(),obj.end(),getByteSize(obj.size()),[](const size_t& acc,const T& cur) { return acc+getByteSize(cur); });
  748. }
  749. template <typename T>
  750. inline void serialize(const std::set<T>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  751. {
  752. serialization::serialize(obj.size(),buffer,iter);
  753. for(const T& cur : obj)
  754. {
  755. serialization::serialize(cur,buffer,iter);
  756. }
  757. }
  758. template <typename T>
  759. inline void deserialize(std::set<T>& obj,std::vector<char>::const_iterator& iter)
  760. {
  761. size_t size;
  762. serialization::deserialize(size,iter);
  763. obj.clear();
  764. for(size_t i=0; i<size; ++i)
  765. {
  766. T val;
  767. serialization::deserialize(val,iter);
  768. obj.insert(val);
  769. }
  770. }
  771. // std::map
  772. template <typename T1,typename T2>
  773. inline size_t getByteSize(const std::map<T1,T2>& obj)
  774. {
  775. return std::accumulate(obj.begin(),obj.end(),sizeof(size_t),[](const size_t& acc,const std::pair<T1,T2>& cur) { return acc+getByteSize(cur); });
  776. }
  777. template <typename T1,typename T2>
  778. inline void serialize(const std::map<T1,T2>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  779. {
  780. serialization::serialize(obj.size(),buffer,iter);
  781. for(const auto& cur : obj)
  782. {
  783. serialization::serialize(cur,buffer,iter);
  784. }
  785. }
  786. template <typename T1,typename T2>
  787. inline void deserialize(std::map<T1,T2>& obj,std::vector<char>::const_iterator& iter)
  788. {
  789. size_t size;
  790. serialization::deserialize(size,iter);
  791. obj.clear();
  792. for(size_t i=0; i<size; ++i)
  793. {
  794. std::pair<T1,T2> pair;
  795. serialization::deserialize(pair,iter);
  796. obj.insert(pair);
  797. }
  798. }
  799. // Eigen types
  800. template<typename T,int R,int C,int P,int MR,int MC>
  801. inline size_t getByteSize(const Eigen::Matrix<T,R,C,P,MR,MC>& obj)
  802. {
  803. // space for numbers of rows,cols and data
  804. return 2*sizeof(typename Eigen::Matrix<T,R,C,P,MR,MC>::Index)+sizeof(T)*obj.rows()*obj.cols();
  805. }
  806. template<typename T,int R,int C,int P,int MR,int MC>
  807. inline void serialize(const Eigen::Matrix<T,R,C,P,MR,MC>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  808. {
  809. serialization::serialize(obj.rows(),buffer,iter);
  810. serialization::serialize(obj.cols(),buffer,iter);
  811. size_t size = sizeof(T)*obj.rows()*obj.cols();
  812. auto ptr = reinterpret_cast<const uint8_t*>(obj.data());
  813. iter = std::copy(ptr,ptr+size,iter);
  814. }
  815. template<typename T,int R,int C,int P,int MR,int MC>
  816. inline void deserialize(Eigen::Matrix<T,R,C,P,MR,MC>& obj,std::vector<char>::const_iterator& iter)
  817. {
  818. typename Eigen::Matrix<T,R,C,P,MR,MC>::Index rows,cols;
  819. serialization::deserialize(rows,iter);
  820. serialization::deserialize(cols,iter);
  821. size_t size = sizeof(T)*rows*cols;
  822. obj.resize(rows,cols);
  823. auto ptr = reinterpret_cast<uint8_t*>(obj.data());
  824. std::copy(iter,iter+size,ptr);
  825. iter+=size;
  826. }
  827. template<typename T,int P,typename I>
  828. inline size_t getByteSize(const Eigen::SparseMatrix<T,P,I>& obj)
  829. {
  830. // space for numbers of rows,cols,nonZeros and tripplets with data (rowIdx,colIdx,value)
  831. size_t size = sizeof(typename Eigen::SparseMatrix<T,P,I>::Index);
  832. return 3*size+(sizeof(T)+2*size)*obj.nonZeros();
  833. }
  834. template<typename T,int P,typename I>
  835. inline void serialize(const Eigen::SparseMatrix<T,P,I>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  836. {
  837. serialization::serialize(obj.rows(),buffer,iter);
  838. serialization::serialize(obj.cols(),buffer,iter);
  839. serialization::serialize(obj.nonZeros(),buffer,iter);
  840. for(int k=0;k<obj.outerSize();++k)
  841. {
  842. for(typename Eigen::SparseMatrix<T,P,I>::InnerIterator it(obj,k);it;++it)
  843. {
  844. serialization::serialize(it.row(),buffer,iter);
  845. serialization::serialize(it.col(),buffer,iter);
  846. serialization::serialize(it.value(),buffer,iter);
  847. }
  848. }
  849. }
  850. template<typename T,int P,typename I>
  851. inline void deserialize(Eigen::SparseMatrix<T,P,I>& obj,std::vector<char>::const_iterator& iter)
  852. {
  853. typename Eigen::SparseMatrix<T,P,I>::Index rows,cols,nonZeros;
  854. serialization::deserialize(rows,iter);
  855. serialization::deserialize(cols,iter);
  856. serialization::deserialize(nonZeros,iter);
  857. obj.resize(rows,cols);
  858. obj.setZero();
  859. std::vector<Eigen::Triplet<T,I> > triplets;
  860. for(int i=0;i<nonZeros;i++)
  861. {
  862. typename Eigen::SparseMatrix<T,P,I>::Index rowId,colId;
  863. serialization::deserialize(rowId,iter);
  864. serialization::deserialize(colId,iter);
  865. T value;
  866. serialization::deserialize(value,iter);
  867. triplets.push_back(Eigen::Triplet<T,I>(rowId,colId,value));
  868. }
  869. obj.setFromTriplets(triplets.begin(),triplets.end());
  870. }
  871. template<typename T,int P>
  872. inline size_t getByteSize(const Eigen::Quaternion<T,P>& obj)
  873. {
  874. return sizeof(T)*4;
  875. }
  876. template<typename T,int P>
  877. inline void serialize(const Eigen::Quaternion<T,P>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  878. {
  879. serialization::serialize(obj.w(),buffer,iter);
  880. serialization::serialize(obj.x(),buffer,iter);
  881. serialization::serialize(obj.y(),buffer,iter);
  882. serialization::serialize(obj.z(),buffer,iter);
  883. }
  884. template<typename T,int P>
  885. inline void deserialize(Eigen::Quaternion<T,P>& obj,std::vector<char>::const_iterator& iter)
  886. {
  887. serialization::deserialize(obj.w(),iter);
  888. serialization::deserialize(obj.x(),iter);
  889. serialization::deserialize(obj.y(),iter);
  890. serialization::deserialize(obj.z(),iter);
  891. }
  892. // pointers
  893. template <typename T>
  894. inline typename std::enable_if<std::is_pointer<T>::value,size_t>::type getByteSize(const T& obj)
  895. {
  896. size_t size = sizeof(bool);
  897. if(obj)
  898. size += getByteSize(*obj);
  899. return size;
  900. }
  901. template <typename T>
  902. inline typename std::enable_if<std::is_pointer<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  903. {
  904. serialization::serialize(obj == nullptr,buffer,iter);
  905. if(obj)
  906. serialization::serialize(*obj,buffer,iter);
  907. }
  908. template <typename T>
  909. inline typename std::enable_if<std::is_pointer<T>::value>::type deserialize(T& obj,std::vector<char>::const_iterator& iter)
  910. {
  911. bool isNullPtr;
  912. serialization::deserialize(isNullPtr,iter);
  913. if(isNullPtr)
  914. {
  915. if(obj)
  916. {
  917. std::cout << "serialization: possible memory leak in serialization for '" << typeid(obj).name() << "'" << std::endl;
  918. obj = nullptr;
  919. }
  920. }
  921. else
  922. {
  923. if(obj)
  924. {
  925. std::cout << "serialization: possible memory corruption in deserialization for '" << typeid(obj).name() << "'" << std::endl;
  926. }
  927. else
  928. {
  929. obj = new typename std::remove_pointer<T>::type();
  930. }
  931. serialization::deserialize(*obj,iter);
  932. }
  933. }
  934. // std::shared_ptr and std::unique_ptr
  935. template <typename T>
  936. inline typename std::enable_if<serialization::is_smart_ptr<T>::value,size_t>::type getByteSize(const T& obj)
  937. {
  938. return getByteSize(obj.get());
  939. }
  940. template <typename T>
  941. inline typename std::enable_if<serialization::is_smart_ptr<T>::value>::type serialize(const T& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  942. {
  943. serialize(obj.get(),buffer,iter);
  944. }
  945. template <template<typename> class T0,typename T1>
  946. inline typename std::enable_if<serialization::is_smart_ptr<T0<T1> >::value>::type deserialize(T0<T1>& obj,std::vector<char>::const_iterator& iter)
  947. {
  948. bool isNullPtr;
  949. serialization::deserialize(isNullPtr,iter);
  950. if(isNullPtr)
  951. {
  952. obj.reset();
  953. }
  954. else
  955. {
  956. obj = T0<T1>(new T1());
  957. serialization::deserialize(*obj,iter);
  958. }
  959. }
  960. // std::weak_ptr
  961. template <typename T>
  962. inline size_t getByteSize(const std::weak_ptr<T>& obj)
  963. {
  964. return sizeof(size_t);
  965. }
  966. template <typename T>
  967. inline void serialize(const std::weak_ptr<T>& obj,std::vector<char>& buffer,std::vector<char>::iterator& iter)
  968. {
  969. }
  970. template <typename T>
  971. inline void deserialize(std::weak_ptr<T>& obj,std::vector<char>::const_iterator& iter)
  972. {
  973. }
  974. // functions to overload for non-intrusive serialization
  975. template <typename T>
  976. inline void serialize(const T& obj,std::vector<char>& buffer)
  977. {
  978. std::cerr << typeid(obj).name() << " is not serializable: derive from igl::Serializable or spezialize the template function igl::serialization::serialize(const T& obj,std::vector<char>& buffer)" << std::endl;
  979. }
  980. template <typename T>
  981. inline void deserialize(T& obj,const std::vector<char>& buffer)
  982. {
  983. std::cerr << typeid(obj).name() << " is not deserializable: derive from igl::Serializable or spezialize the template function igl::serialization::deserialize(T& obj, const std::vector<char>& buffer)" << std::endl;
  984. }
  985. // helper functions
  986. template <typename T>
  987. inline void updateMemoryMap(T& obj,size_t size,std::map<std::uintptr_t,IndexedPointerBase*>& memoryMap)
  988. {
  989. // check if object is already serialized
  990. auto startPtr = new IndexedPointer<T>();
  991. startPtr->Object = &obj;
  992. auto startBasePtr = static_cast<IndexedPointerBase*>(startPtr);
  993. startBasePtr->Type = IndexedPointerBase::BEGIN;
  994. auto startAddress = reinterpret_cast<std::uintptr_t>(&obj);
  995. auto p = std::pair<std::uintptr_t,IndexedPointerBase*>(startAddress,startBasePtr);
  996. auto el = memoryMap.insert(p);
  997. auto iter = ++el.first; // next elememt
  998. if(el.second && (iter == memoryMap.end() || iter->second->Type != IndexedPointerBase::END))
  999. {
  1000. // not yet serialized
  1001. auto endPtr = new IndexedPointer<T>();
  1002. auto endBasePtr = static_cast<IndexedPointerBase*>(endPtr);
  1003. endBasePtr->Type = IndexedPointerBase::END;
  1004. auto endAddress = reinterpret_cast<std::uintptr_t>(&obj) + size - 1;
  1005. auto p = std::pair<std::uintptr_t,IndexedPointerBase*>(endAddress,endBasePtr);
  1006. // insert end address
  1007. memoryMap.insert(el.first,p);
  1008. }
  1009. else
  1010. {
  1011. // already serialized
  1012. // remove inserted address
  1013. memoryMap.erase(el.first);
  1014. }
  1015. }
  1016. }
  1017. }
  1018. #endif