Connection.h 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749
  1. /*
  2. * Connection.h, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #pragma once
  11. #include <typeinfo>
  12. #include <type_traits>
  13. #include <boost/mpl/eval_if.hpp>
  14. #include <boost/mpl/equal_to.hpp>
  15. #include <boost/mpl/int.hpp>
  16. #include <boost/mpl/identity.hpp>
  17. #include <boost/mpl/for_each.hpp>
  18. #include <boost/any.hpp>
  19. #include "ConstTransitivePtr.h"
  20. #include "CCreatureSet.h" //for CStackInstance
  21. #include "mapObjects/CGHeroInstance.h"
  22. #include "mapping/CCampaignHandler.h" //for CCampaignState
  23. #include "rmg/CMapGenerator.h" // for CMapGenOptions
  24. const ui32 version = 759;
  25. const ui32 minSupportedVersion = 753;
  26. class CISer;
  27. class COSer;
  28. class CConnection;
  29. class CGObjectInstance;
  30. class CStackInstance;
  31. class CGameState;
  32. class CCreature;
  33. class LibClasses;
  34. class CHero;
  35. class FileStream;
  36. struct CPack;
  37. extern DLL_LINKAGE LibClasses * VLC;
  38. namespace mpl = boost::mpl;
  39. const std::string SAVEGAME_MAGIC = "VCMISVG";
  40. namespace boost
  41. {
  42. namespace asio
  43. {
  44. namespace ip
  45. {
  46. class tcp;
  47. }
  48. class io_service;
  49. template <typename Protocol> class stream_socket_service;
  50. template <typename Protocol,typename StreamSocketService>
  51. class basic_stream_socket;
  52. template <typename Protocol> class socket_acceptor_service;
  53. template <typename Protocol,typename SocketAcceptorService>
  54. class basic_socket_acceptor;
  55. }
  56. class mutex;
  57. }
  58. enum SerializationLvl
  59. {
  60. Wrong=0,
  61. Boolean,
  62. Primitive,
  63. Array,
  64. Pointer,
  65. Enum,
  66. Serializable,
  67. BooleanVector
  68. };
  69. struct TypeComparer
  70. {
  71. bool operator()(const std::type_info *a, const std::type_info *b) const
  72. {
  73. #ifndef __APPLE__
  74. return a->before(*b);
  75. #else
  76. return strcmp(a->name(), b->name()) < 0;
  77. #endif
  78. }
  79. };
  80. struct IPointerCaster
  81. {
  82. virtual boost::any castRawPtr(const boost::any &ptr) const = 0; // takes From*, performs dynamic cast, returns To*
  83. virtual boost::any castSharedPtr(const boost::any &ptr) const = 0; // takes std::shared_ptr<From>, performs dynamic cast, returns std::shared_ptr<To>
  84. virtual boost::any castWeakPtr(const boost::any &ptr) const = 0; // takes std::weak_ptr<From>, performs dynamic cast, returns std::weak_ptr<To>. The object under poitner must live.
  85. //virtual boost::any castUniquePtr(const boost::any &ptr) const = 0; // takes std::unique_ptr<From>, performs dynamic cast, returns std::unique_ptr<To>
  86. };
  87. template <typename From, typename To>
  88. struct PointerCaster : IPointerCaster
  89. {
  90. virtual boost::any castRawPtr(const boost::any &ptr) const override // takes void* pointing to From object, performs dynamic cast, returns void* pointing to To object
  91. {
  92. From * from = (From*)boost::any_cast<void*>(ptr);
  93. To * ret = dynamic_cast<To*>(from);
  94. if (ret == nullptr)
  95. {
  96. // Last resort when RTTI goes mad
  97. ret = static_cast<To*>(from);
  98. }
  99. return (void*)ret;
  100. }
  101. // Helper function performing casts between smart pointers using dynamic_pointer_cast
  102. template<typename SmartPt>
  103. boost::any castSmartPtr(const boost::any &ptr) const
  104. {
  105. try
  106. {
  107. auto from = boost::any_cast<SmartPt>(ptr);
  108. auto ret = std::dynamic_pointer_cast<To>(from);
  109. if (!ret)
  110. {
  111. // Last resort when RTTI goes mad
  112. ret = std::static_pointer_cast<To>(from);
  113. }
  114. return ret;
  115. }
  116. catch(std::exception &e)
  117. {
  118. THROW_FORMAT("Failed cast %s -> %s. Given argument was %s. Error message: %s", typeid(From).name() % typeid(To).name() % ptr.type().name() % e.what());
  119. }
  120. }
  121. virtual boost::any castSharedPtr(const boost::any &ptr) const override
  122. {
  123. return castSmartPtr<std::shared_ptr<From>>(ptr);
  124. }
  125. virtual boost::any castWeakPtr(const boost::any &ptr) const override
  126. {
  127. auto from = boost::any_cast<std::weak_ptr<From>>(ptr);
  128. return castSmartPtr<std::shared_ptr<From>>(from.lock());
  129. }
  130. // virtual boost::any castUniquePtr(const boost::any &ptr) const override
  131. // {
  132. // return castSmartPtr<std::unique_ptr<From>>(ptr);
  133. // }
  134. };
  135. class DLL_LINKAGE CTypeList: public boost::noncopyable
  136. {
  137. public:
  138. struct TypeDescriptor;
  139. typedef std::shared_ptr<TypeDescriptor> TypeInfoPtr;
  140. struct TypeDescriptor
  141. {
  142. ui16 typeID;
  143. const char *name;
  144. std::vector<TypeInfoPtr> children, parents;
  145. };
  146. typedef boost::shared_mutex TMutex;
  147. typedef boost::unique_lock<TMutex> TUniqueLock;
  148. typedef boost::shared_lock<TMutex> TSharedLock;
  149. private:
  150. mutable TMutex mx;
  151. std::map<const std::type_info *, TypeInfoPtr, TypeComparer> typeInfos;
  152. std::map<std::pair<TypeInfoPtr, TypeInfoPtr>, std::unique_ptr<const IPointerCaster>> casters; //for each pair <Base, Der> we provide a caster (each registered relations creates a single entry here)
  153. /// Returns sequence of types starting from "from" and ending on "to". Every next type is derived from the previous.
  154. /// Throws if there is no link registered.
  155. std::vector<TypeInfoPtr> castSequence(TypeInfoPtr from, TypeInfoPtr to) const;
  156. std::vector<TypeInfoPtr> castSequence(const std::type_info *from, const std::type_info *to) const;
  157. template<boost::any(IPointerCaster::*CastingFunction)(const boost::any &) const>
  158. boost::any castHelper(boost::any inputPtr, const std::type_info *fromArg, const std::type_info *toArg) const
  159. {
  160. TSharedLock lock(mx);
  161. auto typesSequence = castSequence(fromArg, toArg);
  162. boost::any ptr = inputPtr;
  163. for(int i = 0; i < static_cast<int>(typesSequence.size()) - 1; i++)
  164. {
  165. auto &from = typesSequence[i];
  166. auto &to = typesSequence[i + 1];
  167. auto castingPair = std::make_pair(from, to);
  168. if(!casters.count(castingPair))
  169. THROW_FORMAT("Cannot find caster for conversion %s -> %s which is needed to cast %s -> %s", from->name % to->name % fromArg->name() % toArg->name());
  170. auto &caster = casters.at(castingPair);
  171. ptr = (*caster.*CastingFunction)(ptr); //Why does std::unique_ptr not have operator->* ..?
  172. }
  173. return ptr;
  174. }
  175. TypeInfoPtr getTypeDescriptor(const std::type_info *type, bool throws = true) const; //if not throws, failure returns nullptr
  176. TypeInfoPtr registerType(const std::type_info *type);
  177. public:
  178. CTypeList();
  179. template <typename Base, typename Derived>
  180. void registerType(const Base * b = nullptr, const Derived * d = nullptr)
  181. {
  182. TUniqueLock lock(mx);
  183. static_assert(std::is_base_of<Base, Derived>::value, "First registerType template parameter needs to ba a base class of the second one.");
  184. static_assert(std::has_virtual_destructor<Base>::value, "Base class needs to have a virtual destructor.");
  185. static_assert(!std::is_same<Base, Derived>::value, "Parameters of registerTypes should be two diffrenet types.");
  186. auto bt = getTypeInfo(b), dt = getTypeInfo(d); //obtain std::type_info
  187. auto bti = registerType(bt), dti = registerType(dt); //obtain our TypeDescriptor
  188. // register the relation between classes
  189. bti->children.push_back(dti);
  190. dti->parents.push_back(bti);
  191. casters[std::make_pair(bti, dti)] = make_unique<const PointerCaster<Base, Derived>>();
  192. casters[std::make_pair(dti, bti)] = make_unique<const PointerCaster<Derived, Base>>();
  193. }
  194. ui16 getTypeID(const std::type_info *type, bool throws = false) const;
  195. template <typename T>
  196. ui16 getTypeID(const T * t = nullptr, bool throws = false) const
  197. {
  198. return getTypeID(getTypeInfo(t), throws);
  199. }
  200. template<typename TInput>
  201. void * castToMostDerived(const TInput * inputPtr) const
  202. {
  203. auto &baseType = typeid(typename std::remove_cv<TInput>::type);
  204. auto derivedType = getTypeInfo(inputPtr);
  205. if (!strcmp(baseType.name(), derivedType->name()))
  206. {
  207. return const_cast<void*>(reinterpret_cast<const void*>(inputPtr));
  208. }
  209. return boost::any_cast<void*>(castHelper<&IPointerCaster::castRawPtr>(
  210. const_cast<void*>(reinterpret_cast<const void*>(inputPtr)), &baseType,
  211. derivedType));
  212. }
  213. template<typename TInput>
  214. boost::any castSharedToMostDerived(const std::shared_ptr<TInput> inputPtr) const
  215. {
  216. auto &baseType = typeid(typename std::remove_cv<TInput>::type);
  217. auto derivedType = getTypeInfo(inputPtr.get());
  218. if (!strcmp(baseType.name(), derivedType->name()))
  219. return inputPtr;
  220. return castHelper<&IPointerCaster::castSharedPtr>(inputPtr, &baseType, derivedType);
  221. }
  222. void * castRaw(void *inputPtr, const std::type_info *from, const std::type_info *to) const
  223. {
  224. return boost::any_cast<void*>(castHelper<&IPointerCaster::castRawPtr>(inputPtr, from, to));
  225. }
  226. boost::any castShared(boost::any inputPtr, const std::type_info *from, const std::type_info *to) const
  227. {
  228. return castHelper<&IPointerCaster::castSharedPtr>(inputPtr, from, to);
  229. }
  230. template <typename T> const std::type_info * getTypeInfo(const T * t = nullptr) const
  231. {
  232. if(t)
  233. return &typeid(*t);
  234. else
  235. return &typeid(T);
  236. }
  237. };
  238. extern DLL_LINKAGE CTypeList typeList;
  239. template<typename Variant, typename Source>
  240. struct VariantLoaderHelper
  241. {
  242. Source & source;
  243. std::vector<std::function<Variant()>> funcs;
  244. VariantLoaderHelper(Source & source):
  245. source(source)
  246. {
  247. mpl::for_each<typename Variant::types>(std::ref(*this));
  248. }
  249. template<typename Type>
  250. void operator()(Type)
  251. {
  252. funcs.push_back([&]() -> Variant
  253. {
  254. Type obj;
  255. source >> obj;
  256. return Variant(obj);
  257. });
  258. }
  259. };
  260. template<typename T>
  261. struct SerializationLevel
  262. {
  263. typedef mpl::integral_c_tag tag;
  264. typedef
  265. typename mpl::eval_if<
  266. boost::is_same<T, bool>,
  267. mpl::int_<Boolean>,
  268. //else
  269. typename mpl::eval_if<
  270. boost::is_same<T, std::vector<bool> >,
  271. mpl::int_<BooleanVector>,
  272. //else
  273. typename mpl::eval_if<
  274. boost::is_fundamental<T>,
  275. mpl::int_<Primitive>,
  276. //else
  277. typename mpl::eval_if<
  278. boost::is_enum<T>,
  279. mpl::int_<Enum>,
  280. //else
  281. typename mpl::eval_if<
  282. boost::is_class<T>,
  283. mpl::int_<Serializable>,
  284. //else
  285. typename mpl::eval_if<
  286. boost::is_array<T>,
  287. mpl::int_<Array>,
  288. //else
  289. typename mpl::eval_if<
  290. boost::is_pointer<T>,
  291. mpl::int_<Pointer>,
  292. //else
  293. typename mpl::eval_if<
  294. boost::is_enum<T>,
  295. mpl::int_<Primitive>,
  296. //else
  297. mpl::int_<Wrong>
  298. >
  299. >
  300. >
  301. >
  302. >
  303. >
  304. >
  305. >::type type;
  306. static const int value = SerializationLevel::type::value;
  307. };
  308. template <typename ObjType, typename IdType>
  309. struct VectorisedObjectInfo
  310. {
  311. const std::vector<ConstTransitivePtr<ObjType> > *vector; //pointer to the appropriate vector
  312. std::function<IdType(const ObjType &)> idRetriever;
  313. //const IdType ObjType::*idPtr; //pointer to the field representing the position in the vector
  314. VectorisedObjectInfo(const std::vector< ConstTransitivePtr<ObjType> > *Vector, std::function<IdType(const ObjType &)> IdGetter)
  315. :vector(Vector), idRetriever(IdGetter)
  316. {
  317. }
  318. };
  319. template<typename T>
  320. si32 idToNumber(const T &t, typename boost::enable_if<boost::is_convertible<T,si32> >::type * dummy = 0)
  321. {
  322. return t;
  323. }
  324. template<typename T, typename NT>
  325. NT idToNumber(const BaseForID<T, NT> &t)
  326. {
  327. return t.getNum();
  328. }
  329. /// Class which is responsible for storing and loading data.
  330. class DLL_LINKAGE CSerializer
  331. {
  332. public:
  333. typedef std::map<const std::type_info *, boost::any, TypeComparer> TTypeVecMap;
  334. TTypeVecMap vectors; //entry must be a pointer to vector containing pointers to the objects of key type
  335. bool smartVectorMembersSerialization;
  336. bool sendStackInstanceByIds;
  337. CSerializer();
  338. ~CSerializer();
  339. virtual void reportState(CLogger * out){};
  340. template <typename T, typename U>
  341. void registerVectoredType(const std::vector<T*> *Vector, const std::function<U(const T&)> &idRetriever)
  342. {
  343. vectors[&typeid(T)] = VectorisedObjectInfo<T, U>(Vector, idRetriever);
  344. }
  345. template <typename T, typename U>
  346. void registerVectoredType(const std::vector<ConstTransitivePtr<T> > *Vector, const std::function<U(const T&)> &idRetriever)
  347. {
  348. vectors[&typeid(T)] = VectorisedObjectInfo<T, U>(Vector, idRetriever);
  349. }
  350. template <typename T, typename U>
  351. const VectorisedObjectInfo<T, U> *getVectorisedTypeInfo()
  352. {
  353. const std::type_info *myType = nullptr;
  354. //
  355. // if(boost::is_base_of<CGObjectInstance, T>::value) //ugly workaround to support also types derived from CGObjectInstance -> if we encounter one, treat it aas CGObj..
  356. // myType = &typeid(CGObjectInstance);
  357. // else
  358. myType = &typeid(T);
  359. TTypeVecMap::iterator i = vectors.find(myType);
  360. if(i == vectors.end())
  361. return nullptr;
  362. else
  363. {
  364. assert(!i->second.empty());
  365. assert(i->second.type() == typeid(VectorisedObjectInfo<T, U>));
  366. VectorisedObjectInfo<T, U> *ret = &(boost::any_cast<VectorisedObjectInfo<T, U>&>(i->second));
  367. return ret;
  368. }
  369. }
  370. template <typename T, typename U>
  371. T* getVectorItemFromId(const VectorisedObjectInfo<T, U> &oInfo, U id) const
  372. {
  373. /* if(id < 0)
  374. return nullptr;*/
  375. si32 idAsNumber = idToNumber(id);
  376. assert(oInfo.vector);
  377. assert(static_cast<si32>(oInfo.vector->size()) > idAsNumber);
  378. return const_cast<T*>((*oInfo.vector)[idAsNumber].get());
  379. }
  380. template <typename T, typename U>
  381. U getIdFromVectorItem(const VectorisedObjectInfo<T, U> &oInfo, const T* obj) const
  382. {
  383. if(!obj)
  384. return U(-1);
  385. return oInfo.idRetriever(*obj);
  386. }
  387. void addStdVecItems(CGameState *gs, LibClasses *lib = VLC);
  388. };
  389. class IBinaryWriter : public virtual CSerializer
  390. {
  391. public:
  392. virtual int write(const void * data, unsigned size) = 0;
  393. };
  394. class DLL_LINKAGE CSaverBase
  395. {
  396. protected:
  397. IBinaryWriter * writer;
  398. public:
  399. CSaverBase(IBinaryWriter * w): writer(w){};
  400. inline int write(const void * data, unsigned size)
  401. {
  402. return writer->write(data, size);
  403. };
  404. };
  405. class CBasicPointerSaver
  406. {
  407. public:
  408. virtual void savePtr(CSaverBase &ar, const void *data) const =0;
  409. virtual ~CBasicPointerSaver(){}
  410. };
  411. template <typename T> //metafunction returning CGObjectInstance if T is its derivate or T elsewise
  412. struct VectorisedTypeFor
  413. {
  414. typedef typename
  415. //if
  416. mpl::eval_if<boost::is_same<CGHeroInstance,T>,
  417. mpl::identity<CGHeroInstance>,
  418. //else if
  419. mpl::eval_if<boost::is_base_of<CGObjectInstance,T>,
  420. mpl::identity<CGObjectInstance>,
  421. //else
  422. mpl::identity<T>
  423. > >::type type;
  424. };
  425. template <typename U>
  426. struct VectorizedIDType
  427. {
  428. typedef typename
  429. //if
  430. mpl::eval_if<boost::is_same<CArtifact,U>,
  431. mpl::identity<ArtifactID>,
  432. //else if
  433. mpl::eval_if<boost::is_same<CCreature,U>,
  434. mpl::identity<CreatureID>,
  435. //else if
  436. mpl::eval_if<boost::is_same<CHero,U>,
  437. mpl::identity<HeroTypeID>,
  438. //else if
  439. mpl::eval_if<boost::is_same<CArtifactInstance,U>,
  440. mpl::identity<ArtifactInstanceID>,
  441. //else if
  442. mpl::eval_if<boost::is_same<CGHeroInstance,U>,
  443. mpl::identity<HeroTypeID>,
  444. //else if
  445. mpl::eval_if<boost::is_base_of<CGObjectInstance,U>,
  446. mpl::identity<ObjectInstanceID>,
  447. //else
  448. mpl::identity<si32>
  449. > > > > > >::type type;
  450. };
  451. template <typename Handler>
  452. struct VariantVisitorSaver : boost::static_visitor<>
  453. {
  454. Handler &h;
  455. VariantVisitorSaver(Handler &H):h(H)
  456. {
  457. }
  458. template <typename T>
  459. void operator()(const T &t)
  460. {
  461. h << t;
  462. }
  463. };
  464. template<typename Ser,typename T>
  465. struct SaveIfStackInstance
  466. {
  467. static bool invoke(Ser &s, const T &data)
  468. {
  469. return false;
  470. }
  471. };
  472. template<typename Ser>
  473. struct SaveIfStackInstance<Ser, CStackInstance *>
  474. {
  475. static bool invoke(Ser &s, const CStackInstance* const &data)
  476. {
  477. assert(data->armyObj);
  478. SlotID slot;
  479. if(data->getNodeType() == CBonusSystemNode::COMMANDER)
  480. slot = SlotID::COMMANDER_SLOT_PLACEHOLDER;
  481. else
  482. slot = data->armyObj->findStack(data);
  483. assert(slot != SlotID());
  484. s << data->armyObj << slot;
  485. return true;
  486. }
  487. };
  488. template<typename Ser,typename T>
  489. struct LoadIfStackInstance
  490. {
  491. static bool invoke(Ser &s, T &data)
  492. {
  493. return false;
  494. }
  495. };
  496. template<typename Ser>
  497. struct LoadIfStackInstance<Ser, CStackInstance *>
  498. {
  499. static bool invoke(Ser &s, CStackInstance* &data)
  500. {
  501. CArmedInstance *armedObj;
  502. SlotID slot;
  503. s >> armedObj >> slot;
  504. if(slot != SlotID::COMMANDER_SLOT_PLACEHOLDER)
  505. {
  506. assert(armedObj->hasStackAtSlot(slot));
  507. data = armedObj->stacks[slot];
  508. }
  509. else
  510. {
  511. auto hero = dynamic_cast<CGHeroInstance *>(armedObj);
  512. assert(hero);
  513. assert(hero->commander);
  514. data = hero->commander;
  515. }
  516. return true;
  517. }
  518. };
  519. /// The class which manages saving objects.
  520. class DLL_LINKAGE COSer : public CSaverBase
  521. {
  522. public:
  523. struct SaveBoolean
  524. {
  525. static void invoke(COSer &s, const bool &data)
  526. {
  527. s.saveBoolean(data);
  528. }
  529. };
  530. struct SaveBooleanVector
  531. {
  532. static void invoke(COSer &s, const std::vector<bool> &data)
  533. {
  534. s.saveBooleanVector(data);
  535. }
  536. };
  537. template<typename T>
  538. struct SavePrimitive
  539. {
  540. static void invoke(COSer &s, const T &data)
  541. {
  542. s.savePrimitive(data);
  543. }
  544. };
  545. template<typename T>
  546. struct SaveSerializable
  547. {
  548. static void invoke(COSer &s, const T &data)
  549. {
  550. s.saveSerializable(data);
  551. }
  552. };
  553. template<typename T>
  554. struct SaveEnum
  555. {
  556. static void invoke(COSer &s, const T &data)
  557. {
  558. s.saveEnum(data);
  559. }
  560. };
  561. template<typename T>
  562. struct SavePointer
  563. {
  564. static void invoke(COSer &s, const T &data)
  565. {
  566. s.savePointer(data);
  567. }
  568. };
  569. template<typename T>
  570. struct SaveArray
  571. {
  572. static void invoke(COSer &s, const T &data)
  573. {
  574. s.saveArray(data);
  575. }
  576. };
  577. template<typename T>
  578. struct SaveWrong
  579. {
  580. static void invoke(COSer &s, const T &data)
  581. {
  582. throw std::runtime_error("Wrong save serialization call!");
  583. }
  584. };
  585. template <typename T>
  586. class CPointerSaver : public CBasicPointerSaver
  587. {
  588. public:
  589. void savePtr(CSaverBase &ar, const void *data) const override
  590. {
  591. COSer &s = static_cast<COSer&>(ar);
  592. const T *ptr = static_cast<const T*>(data);
  593. //T is most derived known type, it's time to call actual serialize
  594. const_cast<T*>(ptr)->serialize(s,version);
  595. }
  596. };
  597. bool saving;
  598. std::map<ui16,CBasicPointerSaver*> savers; // typeID => CPointerSaver<serializer,type>
  599. std::map<const void*, ui32> savedPointers;
  600. bool smartPointerSerialization;
  601. COSer(IBinaryWriter * w): CSaverBase(w)
  602. {
  603. saving=true;
  604. smartPointerSerialization = true;
  605. }
  606. ~COSer()
  607. {
  608. std::map<ui16,CBasicPointerSaver*>::iterator iter;
  609. for(iter = savers.begin(); iter != savers.end(); iter++)
  610. delete iter->second;
  611. }
  612. template<typename T>
  613. void addSaver(const T * t = nullptr)
  614. {
  615. auto ID = typeList.getTypeID(t);
  616. if(!savers.count(ID))
  617. savers[ID] = new CPointerSaver<T>;
  618. }
  619. template<typename Base, typename Derived> void registerType(const Base * b = nullptr, const Derived * d = nullptr)
  620. {
  621. typeList.registerType(b, d);
  622. addSaver(b);
  623. addSaver(d);
  624. }
  625. template<class T>
  626. COSer & operator<<(const T &t)
  627. {
  628. this->save(t);
  629. return * this;
  630. }
  631. template<class T>
  632. COSer & operator&(const T & t)
  633. {
  634. return * this << t;
  635. }
  636. template <typename T>
  637. void savePrimitive(const T &data)
  638. {
  639. this->write(&data,sizeof(data));
  640. }
  641. template <typename T>
  642. void savePointer(const T &data)
  643. {
  644. //write if pointer is not nullptr
  645. ui8 hlp = (data!=nullptr);
  646. *this << hlp;
  647. //if pointer is nullptr then we don't need anything more...
  648. if(!hlp)
  649. return;
  650. if(writer->smartVectorMembersSerialization)
  651. {
  652. typedef typename boost::remove_const<typename boost::remove_pointer<T>::type>::type TObjectType;
  653. typedef typename VectorisedTypeFor<TObjectType>::type VType;
  654. typedef typename VectorizedIDType<TObjectType>::type IDType;
  655. if(const auto *info = writer->getVectorisedTypeInfo<VType, IDType>())
  656. {
  657. IDType id = writer->getIdFromVectorItem<VType>(*info, data);
  658. *this << id;
  659. if(id != IDType(-1)) //vector id is enough
  660. return;
  661. }
  662. }
  663. if(writer->sendStackInstanceByIds)
  664. {
  665. const bool gotSaved = SaveIfStackInstance<COSer,T>::invoke(*this, data);
  666. if(gotSaved)
  667. return;
  668. }
  669. if(smartPointerSerialization)
  670. {
  671. // We might have an object that has multiple inheritance and store it via the non-first base pointer.
  672. // Therefore, all pointers need to be normalized to the actual object address.
  673. auto actualPointer = typeList.castToMostDerived(data);
  674. std::map<const void*,ui32>::iterator i = savedPointers.find(actualPointer);
  675. if(i != savedPointers.end())
  676. {
  677. //this pointer has been already serialized - write only it's id
  678. *this << i->second;
  679. return;
  680. }
  681. //give id to this pointer
  682. ui32 pid = (ui32)savedPointers.size();
  683. savedPointers[actualPointer] = pid;
  684. *this << pid;
  685. }
  686. //write type identifier
  687. ui16 tid = typeList.getTypeID(data);
  688. *this << tid;
  689. this->savePointerHlp(tid, data);
  690. }
  691. //that part of ptr serialization was extracted to allow customization of its behavior in derived classes
  692. template <typename T>
  693. void savePointerHlp(ui16 tid, const T &data)
  694. {
  695. if(!tid)
  696. *this << *data; //if type is unregistered simply write all data in a standard way
  697. else
  698. savers[tid]->savePtr(*this, typeList.castToMostDerived(data)); //call serializer specific for our real type
  699. }
  700. template <typename T>
  701. void saveArray(const T &data)
  702. {
  703. ui32 size = ARRAY_COUNT(data);
  704. for(ui32 i=0; i < size; i++)
  705. *this << data[i];
  706. }
  707. template <typename T>
  708. void save(const T &data)
  709. {
  710. typedef
  711. //if
  712. typename mpl::eval_if< mpl::equal_to<SerializationLevel<T>,mpl::int_<Boolean> >,
  713. mpl::identity<SaveBoolean>,
  714. //else if
  715. typename mpl::eval_if< mpl::equal_to<SerializationLevel<T>,mpl::int_<BooleanVector> >,
  716. mpl::identity<SaveBooleanVector>,
  717. //else if
  718. typename mpl::eval_if< mpl::equal_to<SerializationLevel<T>,mpl::int_<Primitive> >,
  719. mpl::identity<SavePrimitive<T> >,
  720. //else if
  721. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Enum> >,
  722. mpl::identity<SaveEnum<T> >,
  723. //else if
  724. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Pointer> >,
  725. mpl::identity<SavePointer<T> >,
  726. //else if
  727. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Array> >,
  728. mpl::identity<SaveArray<T> >,
  729. //else if
  730. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Serializable> >,
  731. mpl::identity<SaveSerializable<T> >,
  732. //else
  733. mpl::identity<SaveWrong<T> >
  734. >
  735. >
  736. >
  737. >
  738. >
  739. >
  740. >::type typex;
  741. typex::invoke(* this, data);
  742. }
  743. template <typename T>
  744. void saveSerializable(const T &data)
  745. {
  746. const_cast<T&>(data).serialize(*this,version);
  747. }
  748. template <typename T>
  749. void saveSerializable(const std::shared_ptr<T> &data)
  750. {
  751. T *internalPtr = data.get();
  752. *this << internalPtr;
  753. }
  754. template <typename T>
  755. void saveSerializable(const std::unique_ptr<T> &data)
  756. {
  757. T *internalPtr = data.get();
  758. *this << internalPtr;
  759. }
  760. template <typename T>
  761. void saveSerializable(const std::vector<T> &data)
  762. {
  763. ui32 length = data.size();
  764. *this << length;
  765. for(ui32 i=0;i<length;i++)
  766. *this << data[i];
  767. }
  768. template <typename T, size_t N>
  769. void saveSerializable(const std::array<T, N> &data)
  770. {
  771. for(ui32 i=0; i < N; i++)
  772. *this << data[i];
  773. }
  774. template <typename T>
  775. void saveSerializable(const std::set<T> &data)
  776. {
  777. std::set<T> &d = const_cast<std::set<T> &>(data);
  778. ui32 length = d.size();
  779. *this << length;
  780. for(typename std::set<T>::iterator i=d.begin();i!=d.end();i++)
  781. *this << *i;
  782. }
  783. template <typename T, typename U>
  784. void saveSerializable(const std::unordered_set<T, U> &data)
  785. {
  786. std::unordered_set<T, U> &d = const_cast<std::unordered_set<T, U> &>(data);
  787. ui32 length = d.size();
  788. *this << length;
  789. for(typename std::unordered_set<T, U>::iterator i=d.begin();i!=d.end();i++)
  790. *this << *i;
  791. }
  792. template <typename T>
  793. void saveSerializable(const std::list<T> &data)
  794. {
  795. std::list<T> &d = const_cast<std::list<T> &>(data);
  796. ui32 length = d.size();
  797. *this << length;
  798. for(typename std::list<T>::iterator i=d.begin();i!=d.end();i++)
  799. *this << *i;
  800. }
  801. void saveSerializable(const std::string &data)
  802. {
  803. *this << ui32(data.length());
  804. this->write(data.c_str(),data.size());
  805. }
  806. template <typename T1, typename T2>
  807. void saveSerializable(const std::pair<T1,T2> &data)
  808. {
  809. *this << data.first << data.second;
  810. }
  811. template <typename T1, typename T2>
  812. void saveSerializable(const std::map<T1,T2> &data)
  813. {
  814. *this << ui32(data.size());
  815. for(typename std::map<T1,T2>::const_iterator i=data.begin();i!=data.end();i++)
  816. *this << i->first << i->second;
  817. }
  818. template <typename T1, typename T2>
  819. void saveSerializable(const std::multimap<T1, T2> &data)
  820. {
  821. *this << ui32(data.size());
  822. for(typename std::map<T1, T2>::const_iterator i = data.begin(); i != data.end(); i++)
  823. *this << i->first << i->second;
  824. }
  825. template <BOOST_VARIANT_ENUM_PARAMS(typename T)>
  826. void saveSerializable(const boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> &data)
  827. {
  828. si32 which = data.which();
  829. *this << which;
  830. VariantVisitorSaver<COSer> visitor(*this);
  831. boost::apply_visitor(visitor, data);
  832. }
  833. template <typename T>
  834. void saveSerializable(const boost::optional<T> &data)
  835. {
  836. if(data)
  837. {
  838. *this << (ui8)1;
  839. *this << *data;
  840. }
  841. else
  842. {
  843. *this << (ui8)0;
  844. }
  845. }
  846. template <typename E>
  847. void saveEnum(const E &data)
  848. {
  849. si32 writ = static_cast<si32>(data);
  850. *this << writ;
  851. }
  852. void saveBoolean(const bool & data)
  853. {
  854. ui8 writ = static_cast<ui8>(data);
  855. *this << writ;
  856. }
  857. void saveBooleanVector(const std::vector<bool> & data)
  858. {
  859. std::vector<ui8> convData;
  860. std::copy(data.begin(), data.end(), std::back_inserter(convData));
  861. saveSerializable(convData);
  862. }
  863. };
  864. class IBinaryReader : public virtual CSerializer
  865. {
  866. public:
  867. virtual int read(void * data, unsigned size) = 0;
  868. };
  869. class DLL_LINKAGE CLoaderBase
  870. {
  871. protected:
  872. IBinaryReader * reader;
  873. public:
  874. CLoaderBase(IBinaryReader * r): reader(r){};
  875. inline int read(void * data, unsigned size)
  876. {
  877. return reader->read(data, size);
  878. };
  879. };
  880. class CBasicPointerLoader
  881. {
  882. public:
  883. virtual const std::type_info * loadPtr(CLoaderBase &ar, void *data, ui32 pid) const =0; //data is pointer to the ACTUAL POINTER
  884. virtual ~CBasicPointerLoader(){}
  885. };
  886. template <typename T, typename Enable = void>
  887. struct ClassObjectCreator
  888. {
  889. static T *invoke()
  890. {
  891. static_assert(!std::is_abstract<T>::value, "Cannot call new upon abstract classes!");
  892. return new T();
  893. }
  894. };
  895. template<typename T>
  896. struct ClassObjectCreator<T, typename std::enable_if<std::is_abstract<T>::value>::type>
  897. {
  898. static T *invoke()
  899. {
  900. throw std::runtime_error("Something went really wrong during deserialization. Attempted creating an object of an abstract class " + std::string(typeid(T).name()));
  901. }
  902. };
  903. /// The class which manages loading of objects.
  904. class DLL_LINKAGE CISer : public CLoaderBase
  905. {
  906. public:
  907. struct LoadBoolean
  908. {
  909. static void invoke(CISer &s, bool &data)
  910. {
  911. s.loadBoolean(data);
  912. }
  913. };
  914. struct LoadBooleanVector
  915. {
  916. static void invoke(CISer &s, std::vector<bool> &data)
  917. {
  918. s.loadBooleanVector(data);
  919. }
  920. };
  921. template<typename T>
  922. struct LoadEnum
  923. {
  924. static void invoke(CISer &s, T &data)
  925. {
  926. s.loadEnum(data);
  927. }
  928. };
  929. template<typename T>
  930. struct LoadPrimitive
  931. {
  932. static void invoke(CISer &s, T &data)
  933. {
  934. s.loadPrimitive(data);
  935. }
  936. };
  937. template<typename T>
  938. struct LoadPointer
  939. {
  940. static void invoke(CISer &s, T &data)
  941. {
  942. s.loadPointer(data);
  943. }
  944. };
  945. template<typename T>
  946. struct LoadArray
  947. {
  948. static void invoke(CISer &s, T &data)
  949. {
  950. s.loadArray(data);
  951. }
  952. };
  953. template<typename T>
  954. struct LoadSerializable
  955. {
  956. static void invoke(CISer &s, T &data)
  957. {
  958. s.loadSerializable(data);
  959. }
  960. };
  961. template<typename T>
  962. struct LoadWrong
  963. {
  964. static void invoke(CISer &s, const T &data)
  965. {
  966. throw std::runtime_error("Wrong load serialization call!");
  967. }
  968. };
  969. template <typename T> class CPointerLoader : public CBasicPointerLoader
  970. {
  971. public:
  972. const std::type_info * loadPtr(CLoaderBase &ar, void *data, ui32 pid) const override //data is pointer to the ACTUAL POINTER
  973. {
  974. CISer &s = static_cast<CISer&>(ar);
  975. T *&ptr = *static_cast<T**>(data);
  976. //create new object under pointer
  977. typedef typename boost::remove_pointer<T>::type npT;
  978. ptr = ClassObjectCreator<npT>::invoke(); //does new npT or throws for abstract classes
  979. s.ptrAllocated(ptr, pid);
  980. //T is most derived known type, it's time to call actual serialize
  981. ptr->serialize(s,version);
  982. return &typeid(T);
  983. }
  984. };
  985. bool saving;
  986. std::map<ui16,CBasicPointerLoader*> loaders; // typeID => CPointerSaver<serializer,type>
  987. si32 fileVersion;
  988. bool reverseEndianess; //if source has different endianness than us, we reverse bytes
  989. std::map<ui32, void*> loadedPointers;
  990. std::map<ui32, const std::type_info*> loadedPointersTypes;
  991. std::map<const void*, boost::any> loadedSharedPointers;
  992. bool smartPointerSerialization;
  993. CISer(IBinaryReader * r): CLoaderBase(r)
  994. {
  995. saving = false;
  996. fileVersion = 0;
  997. smartPointerSerialization = true;
  998. reverseEndianess = false;
  999. }
  1000. ~CISer()
  1001. {
  1002. std::map<ui16,CBasicPointerLoader*>::iterator iter;
  1003. for(iter = loaders.begin(); iter != loaders.end(); iter++)
  1004. delete iter->second;
  1005. }
  1006. template<typename T>
  1007. void addLoader(const T * t = nullptr)
  1008. {
  1009. auto ID = typeList.getTypeID(t);
  1010. if(!loaders.count(ID))
  1011. loaders[ID] = new CPointerLoader<T>;
  1012. }
  1013. template<typename Base, typename Derived> void registerType(const Base * b = nullptr, const Derived * d = nullptr)
  1014. {
  1015. typeList.registerType(b, d);
  1016. addLoader(b);
  1017. addLoader(d);
  1018. }
  1019. template<class T>
  1020. CISer & operator>>(T &t)
  1021. {
  1022. this->load(t);
  1023. return * this;
  1024. }
  1025. template<class T>
  1026. CISer & operator&(T & t)
  1027. {
  1028. return * this >> t;
  1029. }
  1030. int write(const void * data, unsigned size);
  1031. template <typename T>
  1032. void load(T &data)
  1033. {
  1034. typedef
  1035. //if
  1036. typename mpl::eval_if< mpl::equal_to<SerializationLevel<T>,mpl::int_<Boolean> >,
  1037. mpl::identity<LoadBoolean>,
  1038. //else if
  1039. typename mpl::eval_if< mpl::equal_to<SerializationLevel<T>,mpl::int_<BooleanVector> >,
  1040. mpl::identity<LoadBooleanVector>,
  1041. //else if
  1042. typename mpl::eval_if< mpl::equal_to<SerializationLevel<T>,mpl::int_<Primitive> >,
  1043. mpl::identity<LoadPrimitive<T> >,
  1044. //else if
  1045. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Enum> >,
  1046. mpl::identity<LoadEnum<T> >,
  1047. //else if
  1048. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Pointer> >,
  1049. mpl::identity<LoadPointer<T> >,
  1050. //else if
  1051. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Array> >,
  1052. mpl::identity<LoadArray<T> >,
  1053. //else if
  1054. typename mpl::eval_if<mpl::equal_to<SerializationLevel<T>,mpl::int_<Serializable> >,
  1055. mpl::identity<LoadSerializable<T> >,
  1056. //else
  1057. mpl::identity<LoadWrong<T> >
  1058. >
  1059. >
  1060. >
  1061. >
  1062. >
  1063. >
  1064. >::type typex;
  1065. typex::invoke(* this, data);
  1066. }
  1067. template <typename T>
  1068. void loadPrimitive(T &data)
  1069. {
  1070. if(0) //for testing #989
  1071. {
  1072. this->read(&data,sizeof(data));
  1073. }
  1074. else
  1075. {
  1076. unsigned length = sizeof(data);
  1077. char* dataPtr = (char*)&data;
  1078. this->read(dataPtr,length);
  1079. if(reverseEndianess)
  1080. std::reverse(dataPtr, dataPtr + length);
  1081. }
  1082. }
  1083. template <typename T>
  1084. void loadSerializableBySerializeCall(T &data)
  1085. {
  1086. ////that const cast is evil because it allows to implicitly overwrite const objects when deserializing
  1087. typedef typename boost::remove_const<T>::type nonConstT;
  1088. nonConstT &hlp = const_cast<nonConstT&>(data);
  1089. hlp.serialize(*this,fileVersion);
  1090. //data.serialize(*this,myVersion);
  1091. }
  1092. template <typename T>
  1093. void loadSerializable(T &data)
  1094. {
  1095. loadSerializableBySerializeCall(data);
  1096. }
  1097. template <typename T>
  1098. void loadArray(T &data)
  1099. {
  1100. ui32 size = ARRAY_COUNT(data);
  1101. for(ui32 i = 0; i < size; i++)
  1102. *this >> data[i];
  1103. }
  1104. template <typename T>
  1105. void loadPointer(T &data)
  1106. {
  1107. ui8 hlp;
  1108. *this >> hlp;
  1109. if(!hlp)
  1110. {
  1111. data = nullptr;
  1112. return;
  1113. }
  1114. if(reader->smartVectorMembersSerialization)
  1115. {
  1116. typedef typename boost::remove_const<typename boost::remove_pointer<T>::type>::type TObjectType; //eg: const CGHeroInstance * => CGHeroInstance
  1117. typedef typename VectorisedTypeFor<TObjectType>::type VType; //eg: CGHeroInstance -> CGobjectInstance
  1118. typedef typename VectorizedIDType<TObjectType>::type IDType;
  1119. if(const auto *info = reader->getVectorisedTypeInfo<VType, IDType>())
  1120. {
  1121. IDType id;
  1122. *this >> id;
  1123. if(id != IDType(-1))
  1124. {
  1125. data = static_cast<T>(reader->getVectorItemFromId<VType, IDType>(*info, id));
  1126. return;
  1127. }
  1128. }
  1129. }
  1130. if(reader->sendStackInstanceByIds)
  1131. {
  1132. bool gotLoaded = LoadIfStackInstance<CISer,T>::invoke(* this, data);
  1133. if(gotLoaded)
  1134. return;
  1135. }
  1136. ui32 pid = 0xffffffff; //pointer id (or maybe rather pointee id)
  1137. if(smartPointerSerialization)
  1138. {
  1139. *this >> pid; //get the id
  1140. std::map<ui32, void*>::iterator i = loadedPointers.find(pid); //lookup
  1141. if(i != loadedPointers.end())
  1142. {
  1143. // We already got this pointer
  1144. // Cast it in case we are loading it to a non-first base pointer
  1145. assert(loadedPointersTypes.count(pid));
  1146. data = reinterpret_cast<T>(typeList.castRaw(i->second, loadedPointersTypes.at(pid), &typeid(typename boost::remove_const<typename boost::remove_pointer<T>::type>::type)));
  1147. return;
  1148. }
  1149. }
  1150. //get type id
  1151. ui16 tid;
  1152. *this >> tid;
  1153. this->loadPointerHlp(tid, data, pid);
  1154. }
  1155. //that part of ptr deserialization was extracted to allow customization of its behavior in derived classes
  1156. template <typename T>
  1157. void loadPointerHlp( ui16 tid, T & data, ui32 pid )
  1158. {
  1159. if(!tid)
  1160. {
  1161. typedef typename boost::remove_pointer<T>::type npT;
  1162. typedef typename boost::remove_const<npT>::type ncpT;
  1163. data = ClassObjectCreator<ncpT>::invoke();
  1164. ptrAllocated(data, pid);
  1165. *this >> *data;
  1166. }
  1167. else
  1168. {
  1169. auto typeInfo = loaders[tid]->loadPtr(*this,&data, pid);
  1170. data = reinterpret_cast<T>(typeList.castRaw((void*)data, typeInfo, &typeid(typename boost::remove_const<typename boost::remove_pointer<T>::type>::type)));
  1171. }
  1172. }
  1173. template <typename T>
  1174. void ptrAllocated(const T *ptr, ui32 pid)
  1175. {
  1176. if(smartPointerSerialization && pid != 0xffffffff)
  1177. {
  1178. loadedPointersTypes[pid] = &typeid(T);
  1179. loadedPointers[pid] = (void*)ptr; //add loaded pointer to our lookup map; cast is to avoid errors with const T* pt
  1180. }
  1181. }
  1182. #define READ_CHECK_U32(x) \
  1183. ui32 length; \
  1184. *this >> length; \
  1185. if(length > 500000) \
  1186. { \
  1187. logGlobal->warnStream() << "Warning: very big length: " << length;\
  1188. reader->reportState(logGlobal); \
  1189. };
  1190. template <typename T>
  1191. void loadSerializable(std::shared_ptr<T> &data)
  1192. {
  1193. typedef typename boost::remove_const<T>::type NonConstT;
  1194. NonConstT *internalPtr;
  1195. *this >> internalPtr;
  1196. void *internalPtrDerived = typeList.castToMostDerived(internalPtr);
  1197. if(internalPtr)
  1198. {
  1199. auto itr = loadedSharedPointers.find(internalPtrDerived);
  1200. if(itr != loadedSharedPointers.end())
  1201. {
  1202. // This pointers is already loaded. The "data" needs to be pointed to it,
  1203. // so their shared state is actually shared.
  1204. try
  1205. {
  1206. auto actualType = typeList.getTypeInfo(internalPtr);
  1207. auto typeWeNeedToReturn = typeList.getTypeInfo<T>();
  1208. if(*actualType == *typeWeNeedToReturn)
  1209. {
  1210. // No casting needed, just unpack already stored std::shared_ptr and return it
  1211. data = boost::any_cast<std::shared_ptr<T>>(itr->second);
  1212. }
  1213. else
  1214. {
  1215. // We need to perform series of casts
  1216. auto ret = typeList.castShared(itr->second, actualType, typeWeNeedToReturn);
  1217. data = boost::any_cast<std::shared_ptr<T>>(ret);
  1218. }
  1219. }
  1220. catch(std::exception &e)
  1221. {
  1222. logGlobal->errorStream() << e.what();
  1223. logGlobal->errorStream() << boost::format("Failed to cast stored shared ptr. Real type: %s. Needed type %s. FIXME FIXME FIXME")
  1224. % itr->second.type().name() % typeid(std::shared_ptr<T>).name();
  1225. //TODO scenario with inheritance -> we can have stored ptr to base and load ptr to derived (or vice versa)
  1226. assert(0);
  1227. }
  1228. }
  1229. else
  1230. {
  1231. auto hlp = std::shared_ptr<NonConstT>(internalPtr);
  1232. data = hlp; //possibly adds const
  1233. loadedSharedPointers[internalPtrDerived] = typeList.castSharedToMostDerived(hlp);
  1234. }
  1235. }
  1236. else
  1237. data.reset();
  1238. }
  1239. template <typename T>
  1240. void loadSerializable(std::unique_ptr<T> &data)
  1241. {
  1242. T *internalPtr;
  1243. *this >> internalPtr;
  1244. data.reset(internalPtr);
  1245. }
  1246. template <typename T>
  1247. void loadSerializable(std::vector<T> &data)
  1248. {
  1249. READ_CHECK_U32(length);
  1250. data.resize(length);
  1251. for(ui32 i=0;i<length;i++)
  1252. *this >> data[i];
  1253. }
  1254. template <typename T, size_t N>
  1255. void loadSerializable(std::array<T, N> &data)
  1256. {
  1257. for(ui32 i = 0; i < N; i++)
  1258. *this >> data[i];
  1259. }
  1260. template <typename T>
  1261. void loadSerializable(std::set<T> &data)
  1262. {
  1263. READ_CHECK_U32(length);
  1264. data.clear();
  1265. T ins;
  1266. for(ui32 i=0;i<length;i++)
  1267. {
  1268. *this >> ins;
  1269. data.insert(ins);
  1270. }
  1271. }
  1272. template <typename T, typename U>
  1273. void loadSerializable(std::unordered_set<T, U> &data)
  1274. {
  1275. READ_CHECK_U32(length);
  1276. data.clear();
  1277. T ins;
  1278. for(ui32 i=0;i<length;i++)
  1279. {
  1280. *this >> ins;
  1281. data.insert(ins);
  1282. }
  1283. }
  1284. template <typename T>
  1285. void loadSerializable(std::list<T> &data)
  1286. {
  1287. READ_CHECK_U32(length);
  1288. data.clear();
  1289. T ins;
  1290. for(ui32 i=0;i<length;i++)
  1291. {
  1292. *this >> ins;
  1293. data.push_back(ins);
  1294. }
  1295. }
  1296. template <typename T1, typename T2>
  1297. void loadSerializable(std::pair<T1,T2> &data)
  1298. {
  1299. *this >> data.first >> data.second;
  1300. }
  1301. template <typename T1, typename T2>
  1302. void loadSerializable(std::map<T1,T2> &data)
  1303. {
  1304. READ_CHECK_U32(length);
  1305. data.clear();
  1306. T1 key;
  1307. T2 value;
  1308. for(ui32 i=0;i<length;i++)
  1309. {
  1310. *this >> key >> value;
  1311. data.insert(std::pair<T1, T2>(std::move(key), std::move(value)));
  1312. }
  1313. }
  1314. template <typename T1, typename T2>
  1315. void loadSerializable(std::multimap<T1, T2> &data)
  1316. {
  1317. READ_CHECK_U32(length);
  1318. data.clear();
  1319. T1 key;
  1320. T2 value;
  1321. for(ui32 i = 0; i < length; i++)
  1322. {
  1323. *this >> key >> value;
  1324. data.insert(std::pair<T1, T2>(std::move(key), std::move(value)));
  1325. }
  1326. }
  1327. void loadSerializable(std::string &data)
  1328. {
  1329. READ_CHECK_U32(length);
  1330. data.resize(length);
  1331. this->read((void*)data.c_str(),length);
  1332. }
  1333. template <BOOST_VARIANT_ENUM_PARAMS(typename T)>
  1334. void loadSerializable(boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> &data)
  1335. {
  1336. typedef boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> TVariant;
  1337. VariantLoaderHelper<TVariant, CISer> loader(*this);
  1338. si32 which;
  1339. *this >> which;
  1340. assert(which < loader.funcs.size());
  1341. data = loader.funcs.at(which)();
  1342. }
  1343. template <typename T>
  1344. void loadSerializable(boost::optional<T> & data)
  1345. {
  1346. ui8 present;
  1347. *this >> present;
  1348. if(present)
  1349. {
  1350. T t;
  1351. *this >> t;
  1352. data = t;
  1353. }
  1354. else
  1355. {
  1356. data = boost::optional<T>();
  1357. }
  1358. }
  1359. // void loadSerializable(CStackInstance *&s)
  1360. // {
  1361. // if(sendStackInstanceByIds)
  1362. // {
  1363. // CArmedInstance *armed;
  1364. // SlotID slot;
  1365. // *this >> armed >> slot;
  1366. // assert(armed->hasStackAtSlot(slot));
  1367. // s = armed->stacks[slot];
  1368. // }
  1369. // else
  1370. // loadSerializableBySerializeCall(s);
  1371. // }
  1372. template <typename E>
  1373. void loadEnum(E &data)
  1374. {
  1375. si32 read;
  1376. *this >> read;
  1377. data = static_cast<E>(read);
  1378. }
  1379. void loadBoolean(bool &data)
  1380. {
  1381. ui8 read;
  1382. *this >> read;
  1383. data = static_cast<bool>(read);
  1384. }
  1385. void loadBooleanVector(std::vector<bool> & data)
  1386. {
  1387. std::vector<ui8> convData;
  1388. loadSerializable(convData);
  1389. convData.resize(data.size());
  1390. range::copy(convData, data.begin());
  1391. }
  1392. };
  1393. class DLL_LINKAGE CSaveFile
  1394. :public IBinaryWriter
  1395. {
  1396. public:
  1397. COSer serializer;
  1398. boost::filesystem::path fName;
  1399. std::unique_ptr<FileStream> sfile;
  1400. CSaveFile(const boost::filesystem::path &fname); //throws!
  1401. ~CSaveFile();
  1402. int write(const void * data, unsigned size) override;
  1403. void openNextFile(const boost::filesystem::path &fname); //throws!
  1404. void clear();
  1405. void reportState(CLogger * out) override;
  1406. void putMagicBytes(const std::string &text);
  1407. template<class T>
  1408. CSaveFile & operator<<(const T &t)
  1409. {
  1410. serializer << t;
  1411. return * this;
  1412. }
  1413. };
  1414. class DLL_LINKAGE CLoadFile
  1415. : public IBinaryReader
  1416. {
  1417. public:
  1418. CISer serializer;
  1419. boost::filesystem::path fName;
  1420. std::unique_ptr<FileStream> sfile;
  1421. CLoadFile(const boost::filesystem::path & fname, int minimalVersion = version); //throws!
  1422. ~CLoadFile();
  1423. int read(void * data, unsigned size) override; //throws!
  1424. void openNextFile(const boost::filesystem::path & fname, int minimalVersion); //throws!
  1425. void clear();
  1426. void reportState(CLogger * out) override;
  1427. void checkMagicBytes(const std::string & text);
  1428. template<class T>
  1429. CLoadFile & operator>>(T &t)
  1430. {
  1431. serializer >> t;
  1432. return * this;
  1433. }
  1434. };
  1435. class DLL_LINKAGE CLoadIntegrityValidator
  1436. : public IBinaryReader
  1437. {
  1438. public:
  1439. CISer serializer;
  1440. std::unique_ptr<CLoadFile> primaryFile, controlFile;
  1441. bool foundDesync;
  1442. CLoadIntegrityValidator(const boost::filesystem::path &primaryFileName, const boost::filesystem::path &controlFileName, int minimalVersion = version); //throws!
  1443. int read( void * data, unsigned size) override; //throws!
  1444. void checkMagicBytes(const std::string &text);
  1445. std::unique_ptr<CLoadFile> decay(); //returns primary file. CLoadIntegrityValidator stops being usable anymore
  1446. };
  1447. typedef boost::asio::basic_stream_socket < boost::asio::ip::tcp , boost::asio::stream_socket_service<boost::asio::ip::tcp> > TSocket;
  1448. typedef boost::asio::basic_socket_acceptor<boost::asio::ip::tcp, boost::asio::socket_acceptor_service<boost::asio::ip::tcp> > TAcceptor;
  1449. class DLL_LINKAGE CConnection
  1450. : public IBinaryReader, public IBinaryWriter
  1451. {
  1452. //CGameState *gs;
  1453. CConnection(void);
  1454. void init();
  1455. void reportState(CLogger * out) override;
  1456. public:
  1457. CISer iser;
  1458. COSer oser;
  1459. boost::mutex *rmx, *wmx; // read/write mutexes
  1460. TSocket * socket;
  1461. bool logging;
  1462. bool connected;
  1463. bool myEndianess, contactEndianess; //true if little endian, if endianness is different we'll have to revert received multi-byte vars
  1464. boost::asio::io_service *io_service;
  1465. std::string name; //who uses this connection
  1466. int connectionID;
  1467. boost::thread *handler;
  1468. bool receivedStop, sendStop;
  1469. CConnection(std::string host, std::string port, std::string Name);
  1470. CConnection(TAcceptor * acceptor, boost::asio::io_service *Io_service, std::string Name);
  1471. CConnection(TSocket * Socket, std::string Name); //use immediately after accepting connection into socket
  1472. int write(const void * data, unsigned size) override;
  1473. int read(void * data, unsigned size) override;
  1474. void close();
  1475. bool isOpen() const;
  1476. template<class T>
  1477. CConnection &operator&(const T&);
  1478. virtual ~CConnection(void);
  1479. CPack *retreivePack(); //gets from server next pack (allocates it with new)
  1480. void sendPackToServer(const CPack &pack, PlayerColor player, ui32 requestID);
  1481. void disableStackSendingByID();
  1482. void enableStackSendingByID();
  1483. void disableSmartPointerSerialization();
  1484. void enableSmartPointerSerializatoin();
  1485. void disableSmartVectorMemberSerialization();
  1486. void enableSmartVectorMemberSerializatoin();
  1487. void prepareForSendingHeroes(); //disables sending vectorised, enables smart pointer serialization, clears saved/loaded ptr cache
  1488. void enterPregameConnectionMode();
  1489. template<class T>
  1490. CConnection & operator>>(T &t)
  1491. {
  1492. iser >> t;
  1493. return * this;
  1494. }
  1495. template<class T>
  1496. CConnection & operator<<(const T &t)
  1497. {
  1498. oser << t;
  1499. return * this;
  1500. }
  1501. };
  1502. DLL_LINKAGE std::ostream &operator<<(std::ostream &str, const CConnection &cpc);
  1503. // Serializer that stores objects in the dynamic buffer. Allows performing deep object copies.
  1504. class DLL_LINKAGE CMemorySerializer
  1505. : public IBinaryReader, public IBinaryWriter
  1506. {
  1507. std::vector<ui8> buffer;
  1508. size_t readPos; //index of the next byte to be read
  1509. public:
  1510. CISer iser;
  1511. COSer oser;
  1512. int read(void * data, unsigned size) override; //throws!
  1513. int write(const void * data, unsigned size) override;
  1514. CMemorySerializer();
  1515. template <typename T>
  1516. static std::unique_ptr<T> deepCopy(const T &data)
  1517. {
  1518. CMemorySerializer mem;
  1519. mem.oser << &data;
  1520. std::unique_ptr<T> ret;
  1521. mem.iser >> ret;
  1522. return ret;
  1523. }
  1524. };
  1525. template<typename T>
  1526. class CApplier
  1527. {
  1528. public:
  1529. std::map<ui16,T*> apps;
  1530. ~CApplier()
  1531. {
  1532. typename std::map<ui16, T*>::iterator iter;
  1533. for(iter = apps.begin(); iter != apps.end(); iter++)
  1534. delete iter->second;
  1535. }
  1536. template<typename RegisteredType>
  1537. void addApplier(ui16 ID)
  1538. {
  1539. if(!apps.count(ID))
  1540. {
  1541. RegisteredType * rtype = nullptr;
  1542. apps[ID] = T::getApplier(rtype);
  1543. }
  1544. }
  1545. template<typename Base, typename Derived>
  1546. void registerType(const Base * b = nullptr, const Derived * d = nullptr)
  1547. {
  1548. typeList.registerType(b, d);
  1549. addApplier<Base>(typeList.getTypeID(b));
  1550. addApplier<Derived>(typeList.getTypeID(d));
  1551. }
  1552. };