Connection.h 44 KB

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