JsonNode.cpp 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636
  1. /*
  2. * JsonNode.cpp, 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. #include "StdInc.h"
  11. #include "JsonNode.h"
  12. #include "ScopeGuard.h"
  13. #include "bonuses/BonusParams.h"
  14. #include "bonuses/Bonus.h"
  15. #include "bonuses/Limiters.h"
  16. #include "bonuses/Propagators.h"
  17. #include "bonuses/Updaters.h"
  18. #include "filesystem/Filesystem.h"
  19. #include "modding/IdentifierStorage.h"
  20. #include "VCMI_Lib.h" //for identifier resolution
  21. #include "CGeneralTextHandler.h"
  22. #include "JsonDetail.h"
  23. #include "constants/StringConstants.h"
  24. #include "battle/BattleHex.h"
  25. namespace
  26. {
  27. // to avoid duplicating const and non-const code
  28. template<typename Node>
  29. Node & resolvePointer(Node & in, const std::string & pointer)
  30. {
  31. if(pointer.empty())
  32. return in;
  33. assert(pointer[0] == '/');
  34. size_t splitPos = pointer.find('/', 1);
  35. std::string entry = pointer.substr(1, splitPos - 1);
  36. std::string remainer = splitPos == std::string::npos ? "" : pointer.substr(splitPos);
  37. if(in.getType() == VCMI_LIB_WRAP_NAMESPACE(JsonNode)::JsonType::DATA_VECTOR)
  38. {
  39. if(entry.find_first_not_of("0123456789") != std::string::npos) // non-numbers in string
  40. throw std::runtime_error("Invalid Json pointer");
  41. if(entry.size() > 1 && entry[0] == '0') // leading zeros are not allowed
  42. throw std::runtime_error("Invalid Json pointer");
  43. auto index = boost::lexical_cast<size_t>(entry);
  44. if (in.Vector().size() > index)
  45. return in.Vector()[index].resolvePointer(remainer);
  46. }
  47. return in[entry].resolvePointer(remainer);
  48. }
  49. }
  50. VCMI_LIB_NAMESPACE_BEGIN
  51. using namespace JsonDetail;
  52. class LibClasses;
  53. class CModHandler;
  54. static const JsonNode nullNode;
  55. JsonNode::JsonNode(JsonType Type)
  56. {
  57. setType(Type);
  58. }
  59. JsonNode::JsonNode(const char *data, size_t datasize)
  60. {
  61. JsonParser parser(data, datasize);
  62. *this = parser.parse("<unknown>");
  63. }
  64. JsonNode::JsonNode(const JsonPath & fileURI)
  65. {
  66. auto file = CResourceHandler::get()->load(fileURI)->readAll();
  67. JsonParser parser(reinterpret_cast<char*>(file.first.get()), file.second);
  68. *this = parser.parse(fileURI.getName());
  69. }
  70. JsonNode::JsonNode(const std::string & idx, const JsonPath & fileURI)
  71. {
  72. auto file = CResourceHandler::get(idx)->load(fileURI)->readAll();
  73. JsonParser parser(reinterpret_cast<char*>(file.first.get()), file.second);
  74. *this = parser.parse(fileURI.getName());
  75. }
  76. JsonNode::JsonNode(const JsonPath & fileURI, bool &isValidSyntax)
  77. {
  78. auto file = CResourceHandler::get()->load(fileURI)->readAll();
  79. JsonParser parser(reinterpret_cast<char*>(file.first.get()), file.second);
  80. *this = parser.parse(fileURI.getName());
  81. isValidSyntax = parser.isValid();
  82. }
  83. bool JsonNode::operator == (const JsonNode &other) const
  84. {
  85. return data == other.data;
  86. }
  87. bool JsonNode::operator != (const JsonNode &other) const
  88. {
  89. return !(*this == other);
  90. }
  91. JsonNode::JsonType JsonNode::getType() const
  92. {
  93. return static_cast<JsonType>(data.index());
  94. }
  95. void JsonNode::setMeta(const std::string & metadata, bool recursive)
  96. {
  97. meta = metadata;
  98. if (recursive)
  99. {
  100. switch (getType())
  101. {
  102. break; case JsonType::DATA_VECTOR:
  103. {
  104. for(auto & node : Vector())
  105. {
  106. node.setMeta(metadata);
  107. }
  108. }
  109. break; case JsonType::DATA_STRUCT:
  110. {
  111. for(auto & node : Struct())
  112. {
  113. node.second.setMeta(metadata);
  114. }
  115. }
  116. }
  117. }
  118. }
  119. void JsonNode::setType(JsonType Type)
  120. {
  121. if (getType() == Type)
  122. return;
  123. //float<->int conversion
  124. if(getType() == JsonType::DATA_FLOAT && Type == JsonType::DATA_INTEGER)
  125. {
  126. si64 converted = static_cast<si64>(std::get<double>(data));
  127. data = JsonData(converted);
  128. return;
  129. }
  130. else if(getType() == JsonType::DATA_INTEGER && Type == JsonType::DATA_FLOAT)
  131. {
  132. double converted = static_cast<double>(std::get<si64>(data));
  133. data = JsonData(converted);
  134. return;
  135. }
  136. //Set new node type
  137. switch(Type)
  138. {
  139. break; case JsonType::DATA_NULL: data = JsonData();
  140. break; case JsonType::DATA_BOOL: data = JsonData(false);
  141. break; case JsonType::DATA_FLOAT: data = JsonData(static_cast<double>(0.0));
  142. break; case JsonType::DATA_STRING: data = JsonData(std::string());
  143. break; case JsonType::DATA_VECTOR: data = JsonData(JsonVector());
  144. break; case JsonType::DATA_STRUCT: data = JsonData(JsonMap());
  145. break; case JsonType::DATA_INTEGER: data = JsonData(static_cast<si64>(0));
  146. }
  147. }
  148. bool JsonNode::isNull() const
  149. {
  150. return getType() == JsonType::DATA_NULL;
  151. }
  152. bool JsonNode::isNumber() const
  153. {
  154. return getType() == JsonType::DATA_INTEGER || getType() == JsonType::DATA_FLOAT;
  155. }
  156. bool JsonNode::isString() const
  157. {
  158. return getType() == JsonType::DATA_STRING;
  159. }
  160. bool JsonNode::isVector() const
  161. {
  162. return getType() == JsonType::DATA_VECTOR;
  163. }
  164. bool JsonNode::isStruct() const
  165. {
  166. return getType() == JsonType::DATA_STRUCT;
  167. }
  168. bool JsonNode::containsBaseData() const
  169. {
  170. switch(getType())
  171. {
  172. case JsonType::DATA_NULL:
  173. return false;
  174. case JsonType::DATA_STRUCT:
  175. for(const auto & elem : Struct())
  176. {
  177. if(elem.second.containsBaseData())
  178. return true;
  179. }
  180. return false;
  181. default:
  182. //other types (including vector) cannot be extended via merge
  183. return true;
  184. }
  185. }
  186. bool JsonNode::isCompact() const
  187. {
  188. switch(getType())
  189. {
  190. case JsonType::DATA_VECTOR:
  191. for(const JsonNode & elem : Vector())
  192. {
  193. if(!elem.isCompact())
  194. return false;
  195. }
  196. return true;
  197. case JsonType::DATA_STRUCT:
  198. {
  199. auto propertyCount = Struct().size();
  200. if(propertyCount == 0)
  201. return true;
  202. else if(propertyCount == 1)
  203. return Struct().begin()->second.isCompact();
  204. }
  205. return false;
  206. default:
  207. return true;
  208. }
  209. }
  210. bool JsonNode::TryBoolFromString(bool & success) const
  211. {
  212. success = true;
  213. if(getType() == JsonNode::JsonType::DATA_BOOL)
  214. return Bool();
  215. success = getType() == JsonNode::JsonType::DATA_STRING;
  216. if(success)
  217. {
  218. auto boolParamStr = String();
  219. boost::algorithm::trim(boolParamStr);
  220. boost::algorithm::to_lower(boolParamStr);
  221. success = boolParamStr == "true";
  222. if(success)
  223. return true;
  224. success = boolParamStr == "false";
  225. }
  226. return false;
  227. }
  228. void JsonNode::clear()
  229. {
  230. setType(JsonType::DATA_NULL);
  231. }
  232. bool & JsonNode::Bool()
  233. {
  234. setType(JsonType::DATA_BOOL);
  235. return std::get<bool>(data);
  236. }
  237. double & JsonNode::Float()
  238. {
  239. setType(JsonType::DATA_FLOAT);
  240. return std::get<double>(data);
  241. }
  242. si64 & JsonNode::Integer()
  243. {
  244. setType(JsonType::DATA_INTEGER);
  245. return std::get<si64>(data);
  246. }
  247. std::string & JsonNode::String()
  248. {
  249. setType(JsonType::DATA_STRING);
  250. return std::get<std::string>(data);
  251. }
  252. JsonVector & JsonNode::Vector()
  253. {
  254. setType(JsonType::DATA_VECTOR);
  255. return std::get<JsonVector>(data);
  256. }
  257. JsonMap & JsonNode::Struct()
  258. {
  259. setType(JsonType::DATA_STRUCT);
  260. return std::get<JsonMap>(data);
  261. }
  262. const bool boolDefault = false;
  263. bool JsonNode::Bool() const
  264. {
  265. assert(getType() == JsonType::DATA_NULL || getType() == JsonType::DATA_BOOL);
  266. if (getType() == JsonType::DATA_BOOL)
  267. return std::get<bool>(data);
  268. return boolDefault;
  269. }
  270. const double floatDefault = 0;
  271. double JsonNode::Float() const
  272. {
  273. assert(getType() == JsonType::DATA_NULL || getType() == JsonType::DATA_INTEGER || getType() == JsonType::DATA_FLOAT);
  274. if(getType() == JsonType::DATA_FLOAT)
  275. return std::get<double>(data);
  276. if(getType() == JsonType::DATA_INTEGER)
  277. return static_cast<double>(std::get<si64>(data));
  278. return floatDefault;
  279. }
  280. const si64 integerDefault = 0;
  281. si64 JsonNode::Integer() const
  282. {
  283. assert(getType() == JsonType::DATA_NULL || getType() == JsonType::DATA_INTEGER || getType() == JsonType::DATA_FLOAT);
  284. if(getType() == JsonType::DATA_INTEGER)
  285. return std::get<si64>(data);
  286. if(getType() == JsonType::DATA_FLOAT)
  287. return static_cast<si64>(std::get<double>(data));
  288. return integerDefault;
  289. }
  290. const std::string stringDefault = std::string();
  291. const std::string & JsonNode::String() const
  292. {
  293. assert(getType() == JsonType::DATA_NULL || getType() == JsonType::DATA_STRING);
  294. if (getType() == JsonType::DATA_STRING)
  295. return std::get<std::string>(data);
  296. return stringDefault;
  297. }
  298. const JsonVector vectorDefault = JsonVector();
  299. const JsonVector & JsonNode::Vector() const
  300. {
  301. assert(getType() == JsonType::DATA_NULL || getType() == JsonType::DATA_VECTOR);
  302. if (getType() == JsonType::DATA_VECTOR)
  303. return std::get<JsonVector>(data);
  304. return vectorDefault;
  305. }
  306. const JsonMap mapDefault = JsonMap();
  307. const JsonMap & JsonNode::Struct() const
  308. {
  309. assert(getType() == JsonType::DATA_NULL || getType() == JsonType::DATA_STRUCT);
  310. if (getType() == JsonType::DATA_STRUCT)
  311. return std::get<JsonMap>(data);
  312. return mapDefault;
  313. }
  314. JsonNode & JsonNode::operator[](const std::string & child)
  315. {
  316. return Struct()[child];
  317. }
  318. const JsonNode & JsonNode::operator[](const std::string & child) const
  319. {
  320. auto it = Struct().find(child);
  321. if (it != Struct().end())
  322. return it->second;
  323. return nullNode;
  324. }
  325. JsonNode & JsonNode::operator[](size_t child)
  326. {
  327. if (child >= Vector().size() )
  328. Vector().resize(child + 1);
  329. return Vector()[child];
  330. }
  331. const JsonNode & JsonNode::operator[](size_t child) const
  332. {
  333. if (child < Vector().size() )
  334. return Vector()[child];
  335. return nullNode;
  336. }
  337. const JsonNode & JsonNode::resolvePointer(const std::string &jsonPointer) const
  338. {
  339. return ::resolvePointer(*this, jsonPointer);
  340. }
  341. JsonNode & JsonNode::resolvePointer(const std::string &jsonPointer)
  342. {
  343. return ::resolvePointer(*this, jsonPointer);
  344. }
  345. std::string JsonNode::toJson(bool compact) const
  346. {
  347. std::ostringstream out;
  348. JsonWriter writer(out, compact);
  349. writer.writeNode(*this);
  350. return out.str();
  351. }
  352. ///JsonUtils
  353. static void loadBonusSubtype(BonusSubtypeID & subtype, BonusType type, const JsonNode & node)
  354. {
  355. if (node.isNull())
  356. {
  357. subtype = BonusSubtypeID();
  358. return;
  359. }
  360. if (node.isNumber()) // Compatibility code for 1.3 or older
  361. {
  362. logMod->warn("Bonus subtype must be string! (%s)", node.meta);
  363. subtype = BonusCustomSubtype(node.Integer());
  364. return;
  365. }
  366. if (!node.isString())
  367. {
  368. logMod->warn("Bonus subtype must be string! (%s)", node.meta);
  369. subtype = BonusSubtypeID();
  370. return;
  371. }
  372. switch (type)
  373. {
  374. case BonusType::MAGIC_SCHOOL_SKILL:
  375. case BonusType::SPELL_DAMAGE:
  376. case BonusType::SPELLS_OF_SCHOOL:
  377. case BonusType::SPELL_DAMAGE_REDUCTION:
  378. case BonusType::SPELL_SCHOOL_IMMUNITY:
  379. case BonusType::NEGATIVE_EFFECTS_IMMUNITY:
  380. {
  381. VLC->identifiers()->requestIdentifier( "spellSchool", node, [&subtype](int32_t identifier)
  382. {
  383. subtype = SpellSchool(identifier);
  384. });
  385. break;
  386. }
  387. case BonusType::NO_TERRAIN_PENALTY:
  388. {
  389. VLC->identifiers()->requestIdentifier( "terrain", node, [&subtype](int32_t identifier)
  390. {
  391. subtype = TerrainId(identifier);
  392. });
  393. break;
  394. }
  395. case BonusType::PRIMARY_SKILL:
  396. {
  397. VLC->identifiers()->requestIdentifier( "primarySkill", node, [&subtype](int32_t identifier)
  398. {
  399. subtype = PrimarySkill(identifier);
  400. });
  401. break;
  402. }
  403. case BonusType::IMPROVED_NECROMANCY:
  404. case BonusType::HERO_GRANTS_ATTACKS:
  405. case BonusType::BONUS_DAMAGE_CHANCE:
  406. case BonusType::BONUS_DAMAGE_PERCENTAGE:
  407. case BonusType::SPECIAL_UPGRADE:
  408. case BonusType::HATE:
  409. case BonusType::SUMMON_GUARDIANS:
  410. case BonusType::MANUAL_CONTROL:
  411. {
  412. VLC->identifiers()->requestIdentifier( "creature", node, [&subtype](int32_t identifier)
  413. {
  414. subtype = CreatureID(identifier);
  415. });
  416. break;
  417. }
  418. case BonusType::SPELL_IMMUNITY:
  419. case BonusType::SPELL_DURATION:
  420. case BonusType::SPECIAL_ADD_VALUE_ENCHANT:
  421. case BonusType::SPECIAL_FIXED_VALUE_ENCHANT:
  422. case BonusType::SPECIAL_PECULIAR_ENCHANT:
  423. case BonusType::SPECIAL_SPELL_LEV:
  424. case BonusType::SPECIFIC_SPELL_DAMAGE:
  425. case BonusType::SPELL:
  426. case BonusType::OPENING_BATTLE_SPELL:
  427. case BonusType::SPELL_LIKE_ATTACK:
  428. case BonusType::CATAPULT:
  429. case BonusType::CATAPULT_EXTRA_SHOTS:
  430. case BonusType::HEALER:
  431. case BonusType::SPELLCASTER:
  432. case BonusType::ENCHANTER:
  433. case BonusType::SPELL_AFTER_ATTACK:
  434. case BonusType::SPELL_BEFORE_ATTACK:
  435. case BonusType::SPECIFIC_SPELL_POWER:
  436. case BonusType::ENCHANTED:
  437. case BonusType::MORE_DAMAGE_FROM_SPELL:
  438. case BonusType::ACCURATE_SHOT:
  439. case BonusType::NOT_ACTIVE:
  440. {
  441. VLC->identifiers()->requestIdentifier( "spell", node, [&subtype](int32_t identifier)
  442. {
  443. subtype = SpellID(identifier);
  444. });
  445. break;
  446. }
  447. case BonusType::GENERATE_RESOURCE:
  448. {
  449. VLC->identifiers()->requestIdentifier( "resource", node, [&subtype](int32_t identifier)
  450. {
  451. subtype = GameResID(identifier);
  452. });
  453. break;
  454. }
  455. case BonusType::MOVEMENT:
  456. case BonusType::WATER_WALKING:
  457. case BonusType::FLYING_MOVEMENT:
  458. case BonusType::NEGATE_ALL_NATURAL_IMMUNITIES:
  459. case BonusType::CREATURE_DAMAGE:
  460. case BonusType::FLYING:
  461. case BonusType::GENERAL_DAMAGE_REDUCTION:
  462. case BonusType::PERCENTAGE_DAMAGE_BOOST:
  463. case BonusType::SOUL_STEAL:
  464. case BonusType::TRANSMUTATION:
  465. case BonusType::DESTRUCTION:
  466. case BonusType::DEATH_STARE:
  467. case BonusType::REBIRTH:
  468. case BonusType::VISIONS:
  469. case BonusType::SPELLS_OF_LEVEL: // spell level
  470. case BonusType::CREATURE_GROWTH: // creature level
  471. {
  472. VLC->identifiers()->requestIdentifier( "bonusSubtype", node, [&subtype](int32_t identifier)
  473. {
  474. subtype = BonusCustomSubtype(identifier);
  475. });
  476. break;
  477. }
  478. default:
  479. for(const auto & i : bonusNameMap)
  480. if(i.second == type)
  481. logMod->warn("Bonus type %s does not supports subtypes!", i.first );
  482. subtype = BonusSubtypeID();
  483. }
  484. }
  485. static void loadBonusSourceInstance(BonusSourceID & sourceInstance, BonusSource sourceType, const JsonNode & node)
  486. {
  487. if (node.isNull())
  488. {
  489. sourceInstance = BonusCustomSource();
  490. return;
  491. }
  492. if (node.isNumber()) // Compatibility code for 1.3 or older
  493. {
  494. logMod->warn("Bonus source must be string!");
  495. sourceInstance = BonusCustomSource(node.Integer());
  496. return;
  497. }
  498. if (!node.isString())
  499. {
  500. logMod->warn("Bonus source must be string!");
  501. sourceInstance = BonusCustomSource();
  502. return;
  503. }
  504. switch (sourceType)
  505. {
  506. case BonusSource::ARTIFACT:
  507. case BonusSource::ARTIFACT_INSTANCE:
  508. {
  509. VLC->identifiers()->requestIdentifier( "artifact", node, [&sourceInstance](int32_t identifier)
  510. {
  511. sourceInstance = ArtifactID(identifier);
  512. });
  513. break;
  514. }
  515. case BonusSource::OBJECT_TYPE:
  516. {
  517. VLC->identifiers()->requestIdentifier( "object", node, [&sourceInstance](int32_t identifier)
  518. {
  519. sourceInstance = Obj(identifier);
  520. });
  521. break;
  522. }
  523. case BonusSource::OBJECT_INSTANCE:
  524. case BonusSource::HERO_BASE_SKILL:
  525. sourceInstance = ObjectInstanceID(ObjectInstanceID::decode(node.String()));
  526. break;
  527. case BonusSource::CREATURE_ABILITY:
  528. {
  529. VLC->identifiers()->requestIdentifier( "creature", node, [&sourceInstance](int32_t identifier)
  530. {
  531. sourceInstance = CreatureID(identifier);
  532. });
  533. break;
  534. }
  535. case BonusSource::TERRAIN_OVERLAY:
  536. {
  537. VLC->identifiers()->requestIdentifier( "spell", node, [&sourceInstance](int32_t identifier)
  538. {
  539. sourceInstance = BattleField(identifier);
  540. });
  541. break;
  542. }
  543. case BonusSource::SPELL_EFFECT:
  544. {
  545. VLC->identifiers()->requestIdentifier( "spell", node, [&sourceInstance](int32_t identifier)
  546. {
  547. sourceInstance = SpellID(identifier);
  548. });
  549. break;
  550. }
  551. case BonusSource::TOWN_STRUCTURE:
  552. assert(0); // TODO
  553. sourceInstance = BuildingTypeUniqueID();
  554. break;
  555. case BonusSource::SECONDARY_SKILL:
  556. {
  557. VLC->identifiers()->requestIdentifier( "secondarySkill", node, [&sourceInstance](int32_t identifier)
  558. {
  559. sourceInstance = SecondarySkill(identifier);
  560. });
  561. break;
  562. }
  563. case BonusSource::HERO_SPECIAL:
  564. {
  565. VLC->identifiers()->requestIdentifier( "hero", node, [&sourceInstance](int32_t identifier)
  566. {
  567. sourceInstance = HeroTypeID(identifier);
  568. });
  569. break;
  570. }
  571. case BonusSource::CAMPAIGN_BONUS:
  572. sourceInstance = CampaignScenarioID(CampaignScenarioID::decode(node.String()));
  573. break;
  574. case BonusSource::ARMY:
  575. case BonusSource::STACK_EXPERIENCE:
  576. case BonusSource::COMMANDER:
  577. case BonusSource::GLOBAL:
  578. case BonusSource::TERRAIN_NATIVE:
  579. case BonusSource::OTHER:
  580. default:
  581. sourceInstance = BonusSourceID();
  582. break;
  583. }
  584. }
  585. std::shared_ptr<Bonus> JsonUtils::parseBonus(const JsonVector & ability_vec)
  586. {
  587. auto b = std::make_shared<Bonus>();
  588. std::string type = ability_vec[0].String();
  589. auto it = bonusNameMap.find(type);
  590. if (it == bonusNameMap.end())
  591. {
  592. logMod->error("Error: invalid ability type %s.", type);
  593. return b;
  594. }
  595. b->type = it->second;
  596. b->val = static_cast<si32>(ability_vec[1].Float());
  597. loadBonusSubtype(b->subtype, b->type, ability_vec[2]);
  598. b->additionalInfo = static_cast<si32>(ability_vec[3].Float());
  599. b->duration = BonusDuration::PERMANENT; //TODO: handle flags (as integer)
  600. b->turnsRemain = 0;
  601. return b;
  602. }
  603. template <typename T>
  604. const T parseByMap(const std::map<std::string, T> & map, const JsonNode * val, const std::string & err)
  605. {
  606. static T defaultValue = T();
  607. if (!val->isNull())
  608. {
  609. const std::string & type = val->String();
  610. auto it = map.find(type);
  611. if (it == map.end())
  612. {
  613. logMod->error("Error: invalid %s%s.", err, type);
  614. return defaultValue;
  615. }
  616. else
  617. {
  618. return it->second;
  619. }
  620. }
  621. else
  622. return defaultValue;
  623. }
  624. template <typename T>
  625. const T parseByMapN(const std::map<std::string, T> & map, const JsonNode * val, const std::string & err)
  626. {
  627. if(val->isNumber())
  628. return static_cast<T>(val->Integer());
  629. else
  630. return parseByMap<T>(map, val, err);
  631. }
  632. void JsonUtils::resolveAddInfo(CAddInfo & var, const JsonNode & node)
  633. {
  634. const JsonNode & value = node["addInfo"];
  635. if (!value.isNull())
  636. {
  637. switch (value.getType())
  638. {
  639. case JsonNode::JsonType::DATA_INTEGER:
  640. var = static_cast<si32>(value.Integer());
  641. break;
  642. case JsonNode::JsonType::DATA_FLOAT:
  643. var = static_cast<si32>(value.Float());
  644. break;
  645. case JsonNode::JsonType::DATA_STRING:
  646. VLC->identifiers()->requestIdentifier(value, [&](si32 identifier)
  647. {
  648. var = identifier;
  649. });
  650. break;
  651. case JsonNode::JsonType::DATA_VECTOR:
  652. {
  653. const JsonVector & vec = value.Vector();
  654. var.resize(vec.size());
  655. for(int i = 0; i < vec.size(); i++)
  656. {
  657. switch(vec[i].getType())
  658. {
  659. case JsonNode::JsonType::DATA_INTEGER:
  660. var[i] = static_cast<si32>(vec[i].Integer());
  661. break;
  662. case JsonNode::JsonType::DATA_FLOAT:
  663. var[i] = static_cast<si32>(vec[i].Float());
  664. break;
  665. case JsonNode::JsonType::DATA_STRING:
  666. VLC->identifiers()->requestIdentifier(vec[i], [&var,i](si32 identifier)
  667. {
  668. var[i] = identifier;
  669. });
  670. break;
  671. default:
  672. logMod->error("Error! Wrong identifier used for value of addInfo[%d].", i);
  673. }
  674. }
  675. break;
  676. }
  677. default:
  678. logMod->error("Error! Wrong identifier used for value of addInfo.");
  679. }
  680. }
  681. }
  682. std::shared_ptr<ILimiter> JsonUtils::parseLimiter(const JsonNode & limiter)
  683. {
  684. switch(limiter.getType())
  685. {
  686. case JsonNode::JsonType::DATA_VECTOR:
  687. {
  688. const JsonVector & subLimiters = limiter.Vector();
  689. if(subLimiters.empty())
  690. {
  691. logMod->warn("Warning: empty limiter list");
  692. return std::make_shared<AllOfLimiter>();
  693. }
  694. std::shared_ptr<AggregateLimiter> result;
  695. int offset = 1;
  696. // determine limiter type and offset for sub-limiters
  697. if(subLimiters[0].getType() == JsonNode::JsonType::DATA_STRING)
  698. {
  699. const std::string & aggregator = subLimiters[0].String();
  700. if(aggregator == AllOfLimiter::aggregator)
  701. result = std::make_shared<AllOfLimiter>();
  702. else if(aggregator == AnyOfLimiter::aggregator)
  703. result = std::make_shared<AnyOfLimiter>();
  704. else if(aggregator == NoneOfLimiter::aggregator)
  705. result = std::make_shared<NoneOfLimiter>();
  706. }
  707. if(!result)
  708. {
  709. // collapse for single limiter without explicit aggregate operator
  710. if(subLimiters.size() == 1)
  711. return parseLimiter(subLimiters[0]);
  712. // implicit aggregator must be allOf
  713. result = std::make_shared<AllOfLimiter>();
  714. offset = 0;
  715. }
  716. if(subLimiters.size() == offset)
  717. logMod->warn("Warning: empty sub-limiter list");
  718. for(int sl = offset; sl < subLimiters.size(); ++sl)
  719. result->add(parseLimiter(subLimiters[sl]));
  720. return result;
  721. }
  722. break;
  723. case JsonNode::JsonType::DATA_STRING: //pre-defined limiters
  724. return parseByMap(bonusLimiterMap, &limiter, "limiter type ");
  725. break;
  726. case JsonNode::JsonType::DATA_STRUCT: //customizable limiters
  727. {
  728. std::string limiterType = limiter["type"].String();
  729. const JsonVector & parameters = limiter["parameters"].Vector();
  730. if(limiterType == "CREATURE_TYPE_LIMITER")
  731. {
  732. std::shared_ptr<CCreatureTypeLimiter> creatureLimiter = std::make_shared<CCreatureTypeLimiter>();
  733. VLC->identifiers()->requestIdentifier("creature", parameters[0], [=](si32 creature)
  734. {
  735. creatureLimiter->setCreature(CreatureID(creature));
  736. });
  737. auto includeUpgrades = false;
  738. if(parameters.size() > 1)
  739. {
  740. bool success = true;
  741. includeUpgrades = parameters[1].TryBoolFromString(success);
  742. if(!success)
  743. logMod->error("Second parameter of '%s' limiter should be Bool", limiterType);
  744. }
  745. creatureLimiter->includeUpgrades = includeUpgrades;
  746. return creatureLimiter;
  747. }
  748. else if(limiterType == "HAS_ANOTHER_BONUS_LIMITER")
  749. {
  750. std::string anotherBonusType = parameters[0].String();
  751. auto it = bonusNameMap.find(anotherBonusType);
  752. if(it == bonusNameMap.end())
  753. {
  754. logMod->error("Error: invalid ability type %s.", anotherBonusType);
  755. }
  756. else
  757. {
  758. std::shared_ptr<HasAnotherBonusLimiter> bonusLimiter = std::make_shared<HasAnotherBonusLimiter>();
  759. bonusLimiter->type = it->second;
  760. auto findSource = [&](const JsonNode & parameter)
  761. {
  762. if(parameter.getType() == JsonNode::JsonType::DATA_STRUCT)
  763. {
  764. auto sourceIt = bonusSourceMap.find(parameter["type"].String());
  765. if(sourceIt != bonusSourceMap.end())
  766. {
  767. bonusLimiter->source = sourceIt->second;
  768. bonusLimiter->isSourceRelevant = true;
  769. if(!parameter["id"].isNull()) {
  770. loadBonusSourceInstance(bonusLimiter->sid, bonusLimiter->source, parameter["id"]);
  771. bonusLimiter->isSourceIDRelevant = true;
  772. }
  773. }
  774. }
  775. return false;
  776. };
  777. if(parameters.size() > 1)
  778. {
  779. if(findSource(parameters[1]) && parameters.size() == 2)
  780. return bonusLimiter;
  781. else
  782. {
  783. loadBonusSubtype(bonusLimiter->subtype, bonusLimiter->type, parameters[1]);
  784. bonusLimiter->isSubtypeRelevant = true;
  785. if(parameters.size() > 2)
  786. findSource(parameters[2]);
  787. }
  788. }
  789. return bonusLimiter;
  790. }
  791. }
  792. else if(limiterType == "CREATURE_ALIGNMENT_LIMITER")
  793. {
  794. int alignment = vstd::find_pos(GameConstants::ALIGNMENT_NAMES, parameters[0].String());
  795. if(alignment == -1)
  796. logMod->error("Error: invalid alignment %s.", parameters[0].String());
  797. else
  798. return std::make_shared<CreatureAlignmentLimiter>(static_cast<EAlignment>(alignment));
  799. }
  800. else if(limiterType == "FACTION_LIMITER" || limiterType == "CREATURE_FACTION_LIMITER") //Second name is deprecated, 1.2 compat
  801. {
  802. std::shared_ptr<FactionLimiter> factionLimiter = std::make_shared<FactionLimiter>();
  803. VLC->identifiers()->requestIdentifier("faction", parameters[0], [=](si32 faction)
  804. {
  805. factionLimiter->faction = FactionID(faction);
  806. });
  807. return factionLimiter;
  808. }
  809. else if(limiterType == "CREATURE_LEVEL_LIMITER")
  810. {
  811. auto levelLimiter = std::make_shared<CreatureLevelLimiter>();
  812. if(!parameters.empty()) //If parameters is empty, level limiter works as CREATURES_ONLY limiter
  813. {
  814. levelLimiter->minLevel = parameters[0].Integer();
  815. if(parameters[1].isNumber())
  816. levelLimiter->maxLevel = parameters[1].Integer();
  817. }
  818. return levelLimiter;
  819. }
  820. else if(limiterType == "CREATURE_TERRAIN_LIMITER")
  821. {
  822. std::shared_ptr<CreatureTerrainLimiter> terrainLimiter = std::make_shared<CreatureTerrainLimiter>();
  823. if(!parameters.empty())
  824. {
  825. VLC->identifiers()->requestIdentifier("terrain", parameters[0], [=](si32 terrain)
  826. {
  827. //TODO: support limiters
  828. //terrainLimiter->terrainType = terrain;
  829. });
  830. }
  831. return terrainLimiter;
  832. }
  833. else if(limiterType == "UNIT_ON_HEXES") {
  834. auto hexLimiter = std::make_shared<UnitOnHexLimiter>();
  835. if(!parameters.empty())
  836. {
  837. for (const auto & parameter: parameters){
  838. if(parameter.isNumber())
  839. hexLimiter->applicableHexes.insert(BattleHex(parameter.Integer()));
  840. }
  841. }
  842. return hexLimiter;
  843. }
  844. else
  845. {
  846. logMod->error("Error: invalid customizable limiter type %s.", limiterType);
  847. }
  848. }
  849. break;
  850. default:
  851. break;
  852. }
  853. return nullptr;
  854. }
  855. std::shared_ptr<Bonus> JsonUtils::parseBonus(const JsonNode &ability)
  856. {
  857. auto b = std::make_shared<Bonus>();
  858. if (!parseBonus(ability, b.get()))
  859. {
  860. // caller code can not handle this case and presumes that returned bonus is always valid
  861. logGlobal->error("Failed to parse bonus! Json config was %S ", ability.toJson());
  862. b->type = BonusType::NONE;
  863. return b;
  864. }
  865. return b;
  866. }
  867. std::shared_ptr<Bonus> JsonUtils::parseBuildingBonus(const JsonNode & ability, const FactionID & faction, const BuildingID & building, const std::string & description)
  868. {
  869. /* duration = BonusDuration::PERMANENT
  870. source = BonusSource::TOWN_STRUCTURE
  871. bonusType, val, subtype - get from json
  872. */
  873. auto b = std::make_shared<Bonus>(BonusDuration::PERMANENT, BonusType::NONE, BonusSource::TOWN_STRUCTURE, 0, BuildingTypeUniqueID(faction, building), description);
  874. if(!parseBonus(ability, b.get()))
  875. return nullptr;
  876. return b;
  877. }
  878. static BonusParams convertDeprecatedBonus(const JsonNode &ability)
  879. {
  880. if(vstd::contains(deprecatedBonusSet, ability["type"].String()))
  881. {
  882. logMod->warn("There is deprecated bonus found:\n%s\nTrying to convert...", ability.toJson());
  883. auto params = BonusParams(ability["type"].String(),
  884. ability["subtype"].isString() ? ability["subtype"].String() : "",
  885. ability["subtype"].isNumber() ? ability["subtype"].Integer() : -1);
  886. if(params.isConverted)
  887. {
  888. if(ability["type"].String() == "SECONDARY_SKILL_PREMY" && bonusValueMap.find(ability["valueType"].String())->second == BonusValueType::PERCENT_TO_BASE) //assume secondary skill special
  889. {
  890. params.valueType = BonusValueType::PERCENT_TO_TARGET_TYPE;
  891. params.targetType = BonusSource::SECONDARY_SKILL;
  892. }
  893. logMod->warn("Please, use this bonus:\n%s\nConverted successfully!", params.toJson().toJson());
  894. return params;
  895. }
  896. else
  897. logMod->error("Cannot convert bonus!\n%s", ability.toJson());
  898. }
  899. BonusParams ret;
  900. ret.isConverted = false;
  901. return ret;
  902. }
  903. static TUpdaterPtr parseUpdater(const JsonNode & updaterJson)
  904. {
  905. switch(updaterJson.getType())
  906. {
  907. case JsonNode::JsonType::DATA_STRING:
  908. return parseByMap(bonusUpdaterMap, &updaterJson, "updater type ");
  909. break;
  910. case JsonNode::JsonType::DATA_STRUCT:
  911. if(updaterJson["type"].String() == "GROWS_WITH_LEVEL")
  912. {
  913. std::shared_ptr<GrowsWithLevelUpdater> updater = std::make_shared<GrowsWithLevelUpdater>();
  914. const JsonVector param = updaterJson["parameters"].Vector();
  915. updater->valPer20 = static_cast<int>(param[0].Integer());
  916. if(param.size() > 1)
  917. updater->stepSize = static_cast<int>(param[1].Integer());
  918. return updater;
  919. }
  920. else if (updaterJson["type"].String() == "ARMY_MOVEMENT")
  921. {
  922. std::shared_ptr<ArmyMovementUpdater> updater = std::make_shared<ArmyMovementUpdater>();
  923. if(updaterJson["parameters"].isVector())
  924. {
  925. const auto & param = updaterJson["parameters"].Vector();
  926. if(param.size() < 4)
  927. logMod->warn("Invalid ARMY_MOVEMENT parameters, using default!");
  928. else
  929. {
  930. updater->base = static_cast<si32>(param.at(0).Integer());
  931. updater->divider = static_cast<si32>(param.at(1).Integer());
  932. updater->multiplier = static_cast<si32>(param.at(2).Integer());
  933. updater->max = static_cast<si32>(param.at(3).Integer());
  934. }
  935. return updater;
  936. }
  937. }
  938. else
  939. logMod->warn("Unknown updater type \"%s\"", updaterJson["type"].String());
  940. break;
  941. }
  942. return nullptr;
  943. }
  944. bool JsonUtils::parseBonus(const JsonNode &ability, Bonus *b)
  945. {
  946. const JsonNode * value = nullptr;
  947. std::string type = ability["type"].String();
  948. auto it = bonusNameMap.find(type);
  949. auto params = std::make_unique<BonusParams>(false);
  950. if (it == bonusNameMap.end())
  951. {
  952. params = std::make_unique<BonusParams>(convertDeprecatedBonus(ability));
  953. if(!params->isConverted)
  954. {
  955. logMod->error("Error: invalid ability type %s.", type);
  956. return false;
  957. }
  958. b->type = params->type;
  959. b->val = params->val.value_or(0);
  960. b->valType = params->valueType.value_or(BonusValueType::ADDITIVE_VALUE);
  961. if(params->targetType)
  962. b->targetSourceType = params->targetType.value();
  963. }
  964. else
  965. b->type = it->second;
  966. loadBonusSubtype(b->subtype, b->type, params->isConverted ? params->toJson()["subtype"] : ability["subtype"]);
  967. if(!params->isConverted)
  968. {
  969. b->val = static_cast<si32>(ability["val"].Float());
  970. value = &ability["valueType"];
  971. if (!value->isNull())
  972. b->valType = static_cast<BonusValueType>(parseByMapN(bonusValueMap, value, "value type "));
  973. }
  974. b->stacking = ability["stacking"].String();
  975. resolveAddInfo(b->additionalInfo, ability);
  976. b->turnsRemain = static_cast<si32>(ability["turns"].Float());
  977. if(!ability["description"].isNull())
  978. {
  979. if (ability["description"].isString())
  980. b->description = ability["description"].String();
  981. if (ability["description"].isNumber())
  982. b->description = VLC->generaltexth->translate("core.arraytxt", ability["description"].Integer());
  983. }
  984. value = &ability["effectRange"];
  985. if (!value->isNull())
  986. b->effectRange = static_cast<BonusLimitEffect>(parseByMapN(bonusLimitEffect, value, "effect range "));
  987. value = &ability["duration"];
  988. if (!value->isNull())
  989. {
  990. switch (value->getType())
  991. {
  992. case JsonNode::JsonType::DATA_STRING:
  993. b->duration = parseByMap(bonusDurationMap, value, "duration type ");
  994. break;
  995. case JsonNode::JsonType::DATA_VECTOR:
  996. {
  997. BonusDuration::Type dur = 0;
  998. for (const JsonNode & d : value->Vector())
  999. dur |= parseByMapN(bonusDurationMap, &d, "duration type ");
  1000. b->duration = dur;
  1001. }
  1002. break;
  1003. default:
  1004. logMod->error("Error! Wrong bonus duration format.");
  1005. }
  1006. }
  1007. value = &ability["sourceType"];
  1008. if (!value->isNull())
  1009. b->source = static_cast<BonusSource>(parseByMap(bonusSourceMap, value, "source type "));
  1010. if (!ability["sourceID"].isNull())
  1011. loadBonusSourceInstance(b->sid, b->source, ability["sourceID"]);
  1012. value = &ability["targetSourceType"];
  1013. if (!value->isNull())
  1014. b->targetSourceType = static_cast<BonusSource>(parseByMap(bonusSourceMap, value, "target type "));
  1015. value = &ability["limiters"];
  1016. if (!value->isNull())
  1017. b->limiter = parseLimiter(*value);
  1018. value = &ability["propagator"];
  1019. if (!value->isNull())
  1020. {
  1021. //ALL_CREATURES old propagator compatibility
  1022. if(value->String() == "ALL_CREATURES")
  1023. {
  1024. logMod->warn("ALL_CREATURES propagator is deprecated. Use GLOBAL_EFFECT propagator with CREATURES_ONLY limiter");
  1025. b->addLimiter(std::make_shared<CreatureLevelLimiter>());
  1026. b->propagator = bonusPropagatorMap.at("GLOBAL_EFFECT");
  1027. }
  1028. else
  1029. b->propagator = parseByMap(bonusPropagatorMap, value, "propagator type ");
  1030. }
  1031. value = &ability["updater"];
  1032. if(!value->isNull())
  1033. b->addUpdater(parseUpdater(*value));
  1034. value = &ability["propagationUpdater"];
  1035. if(!value->isNull())
  1036. b->propagationUpdater = parseUpdater(*value);
  1037. return true;
  1038. }
  1039. CSelector JsonUtils::parseSelector(const JsonNode & ability)
  1040. {
  1041. CSelector ret = Selector::all;
  1042. // Recursive parsers for anyOf, allOf, noneOf
  1043. const auto * value = &ability["allOf"];
  1044. if(value->isVector())
  1045. {
  1046. for(const auto & andN : value->Vector())
  1047. ret = ret.And(parseSelector(andN));
  1048. }
  1049. value = &ability["anyOf"];
  1050. if(value->isVector())
  1051. {
  1052. CSelector base = Selector::none;
  1053. for(const auto & andN : value->Vector())
  1054. base = base.Or(parseSelector(andN));
  1055. ret = ret.And(base);
  1056. }
  1057. value = &ability["noneOf"];
  1058. if(value->isVector())
  1059. {
  1060. CSelector base = Selector::none;
  1061. for(const auto & andN : value->Vector())
  1062. base = base.Or(parseSelector(andN));
  1063. ret = ret.And(base.Not());
  1064. }
  1065. BonusType type = BonusType::NONE;
  1066. // Actual selector parser
  1067. value = &ability["type"];
  1068. if(value->isString())
  1069. {
  1070. auto it = bonusNameMap.find(value->String());
  1071. if(it != bonusNameMap.end())
  1072. {
  1073. type = it->second;
  1074. ret = ret.And(Selector::type()(it->second));
  1075. }
  1076. }
  1077. value = &ability["subtype"];
  1078. if(!value->isNull() && type != BonusType::NONE)
  1079. {
  1080. BonusSubtypeID subtype;
  1081. loadBonusSubtype(subtype, type, ability);
  1082. ret = ret.And(Selector::subtype()(subtype));
  1083. }
  1084. value = &ability["sourceType"];
  1085. std::optional<BonusSource> src = std::nullopt; //Fixes for GCC false maybe-uninitialized
  1086. std::optional<BonusSourceID> id = std::nullopt;
  1087. if(value->isString())
  1088. {
  1089. auto it = bonusSourceMap.find(value->String());
  1090. if(it != bonusSourceMap.end())
  1091. src = it->second;
  1092. }
  1093. value = &ability["sourceID"];
  1094. if(!value->isNull() && src.has_value())
  1095. {
  1096. loadBonusSourceInstance(*id, *src, ability);
  1097. }
  1098. if(src && id)
  1099. ret = ret.And(Selector::source(*src, *id));
  1100. else if(src)
  1101. ret = ret.And(Selector::sourceTypeSel(*src));
  1102. value = &ability["targetSourceType"];
  1103. if(value->isString())
  1104. {
  1105. auto it = bonusSourceMap.find(value->String());
  1106. if(it != bonusSourceMap.end())
  1107. ret = ret.And(Selector::targetSourceType()(it->second));
  1108. }
  1109. value = &ability["valueType"];
  1110. if(value->isString())
  1111. {
  1112. auto it = bonusValueMap.find(value->String());
  1113. if(it != bonusValueMap.end())
  1114. ret = ret.And(Selector::valueType(it->second));
  1115. }
  1116. CAddInfo info;
  1117. value = &ability["addInfo"];
  1118. if(!value->isNull())
  1119. {
  1120. resolveAddInfo(info, ability["addInfo"]);
  1121. ret = ret.And(Selector::info()(info));
  1122. }
  1123. value = &ability["effectRange"];
  1124. if(value->isString())
  1125. {
  1126. auto it = bonusLimitEffect.find(value->String());
  1127. if(it != bonusLimitEffect.end())
  1128. ret = ret.And(Selector::effectRange()(it->second));
  1129. }
  1130. value = &ability["lastsTurns"];
  1131. if(value->isNumber())
  1132. ret = ret.And(Selector::turns(value->Integer()));
  1133. value = &ability["lastsDays"];
  1134. if(value->isNumber())
  1135. ret = ret.And(Selector::days(value->Integer()));
  1136. return ret;
  1137. }
  1138. //returns first Key with value equal to given one
  1139. template<class Key, class Val>
  1140. Key reverseMapFirst(const Val & val, const std::map<Key, Val> & map)
  1141. {
  1142. for(auto it : map)
  1143. {
  1144. if(it.second == val)
  1145. {
  1146. return it.first;
  1147. }
  1148. }
  1149. assert(0);
  1150. return "";
  1151. }
  1152. static JsonNode getDefaultValue(const JsonNode & schema, std::string fieldName)
  1153. {
  1154. const JsonNode & fieldProps = schema["properties"][fieldName];
  1155. #if defined(VCMI_IOS)
  1156. if (!fieldProps["defaultIOS"].isNull())
  1157. return fieldProps["defaultIOS"];
  1158. #elif defined(VCMI_ANDROID)
  1159. if (!fieldProps["defaultAndroid"].isNull())
  1160. return fieldProps["defaultAndroid"];
  1161. #elif !defined(VCMI_MOBILE)
  1162. if (!fieldProps["defaultDesktop"].isNull())
  1163. return fieldProps["defaultDesktop"];
  1164. #endif
  1165. return fieldProps["default"];
  1166. }
  1167. static void eraseOptionalNodes(JsonNode & node, const JsonNode & schema)
  1168. {
  1169. assert(schema["type"].String() == "object");
  1170. std::set<std::string> foundEntries;
  1171. for(const auto & entry : schema["required"].Vector())
  1172. foundEntries.insert(entry.String());
  1173. vstd::erase_if(node.Struct(), [&](const auto & node){
  1174. return !vstd::contains(foundEntries, node.first);
  1175. });
  1176. }
  1177. static void minimizeNode(JsonNode & node, const JsonNode & schema)
  1178. {
  1179. if (schema["type"].String() != "object")
  1180. return;
  1181. for(const auto & entry : schema["required"].Vector())
  1182. {
  1183. const std::string & name = entry.String();
  1184. minimizeNode(node[name], schema["properties"][name]);
  1185. if (vstd::contains(node.Struct(), name) && node[name] == getDefaultValue(schema, name))
  1186. node.Struct().erase(name);
  1187. }
  1188. eraseOptionalNodes(node, schema);
  1189. }
  1190. static void maximizeNode(JsonNode & node, const JsonNode & schema)
  1191. {
  1192. // "required" entry can only be found in object/struct
  1193. if (schema["type"].String() != "object")
  1194. return;
  1195. // check all required entries that have default version
  1196. for(const auto & entry : schema["required"].Vector())
  1197. {
  1198. const std::string & name = entry.String();
  1199. if (node[name].isNull() && !getDefaultValue(schema, name).isNull())
  1200. node[name] = getDefaultValue(schema, name);
  1201. maximizeNode(node[name], schema["properties"][name]);
  1202. }
  1203. eraseOptionalNodes(node, schema);
  1204. }
  1205. void JsonUtils::minimize(JsonNode & node, const std::string & schemaName)
  1206. {
  1207. minimizeNode(node, getSchema(schemaName));
  1208. }
  1209. void JsonUtils::maximize(JsonNode & node, const std::string & schemaName)
  1210. {
  1211. maximizeNode(node, getSchema(schemaName));
  1212. }
  1213. bool JsonUtils::validate(const JsonNode & node, const std::string & schemaName, const std::string & dataName)
  1214. {
  1215. std::string log = Validation::check(schemaName, node);
  1216. if (!log.empty())
  1217. {
  1218. logMod->warn("Data in %s is invalid!", dataName);
  1219. logMod->warn(log);
  1220. logMod->trace("%s json: %s", dataName, node.toJson(true));
  1221. }
  1222. return log.empty();
  1223. }
  1224. const JsonNode & getSchemaByName(const std::string & name)
  1225. {
  1226. // cached schemas to avoid loading json data multiple times
  1227. static std::map<std::string, JsonNode> loadedSchemas;
  1228. if (vstd::contains(loadedSchemas, name))
  1229. return loadedSchemas[name];
  1230. auto filename = JsonPath::builtin("config/schemas/" + name);
  1231. if (CResourceHandler::get()->existsResource(filename))
  1232. {
  1233. loadedSchemas[name] = JsonNode(filename);
  1234. return loadedSchemas[name];
  1235. }
  1236. logMod->error("Error: missing schema with name %s!", name);
  1237. assert(0);
  1238. return nullNode;
  1239. }
  1240. const JsonNode & JsonUtils::getSchema(const std::string & URI)
  1241. {
  1242. size_t posColon = URI.find(':');
  1243. size_t posHash = URI.find('#');
  1244. std::string filename;
  1245. if(posColon == std::string::npos)
  1246. {
  1247. filename = URI.substr(0, posHash);
  1248. }
  1249. else
  1250. {
  1251. std::string protocolName = URI.substr(0, posColon);
  1252. filename = URI.substr(posColon + 1, posHash - posColon - 1) + ".json";
  1253. if(protocolName != "vcmi")
  1254. {
  1255. logMod->error("Error: unsupported URI protocol for schema: %s", URI);
  1256. return nullNode;
  1257. }
  1258. }
  1259. // check if json pointer if present (section after hash in string)
  1260. if(posHash == std::string::npos || posHash == URI.size() - 1)
  1261. {
  1262. auto const & result = getSchemaByName(filename);
  1263. if (result.isNull())
  1264. logMod->error("Error: missing schema %s", URI);
  1265. return result;
  1266. }
  1267. else
  1268. {
  1269. auto const & result = getSchemaByName(filename).resolvePointer(URI.substr(posHash + 1));
  1270. if (result.isNull())
  1271. logMod->error("Error: missing schema %s", URI);
  1272. return result;
  1273. }
  1274. }
  1275. void JsonUtils::merge(JsonNode & dest, JsonNode & source, bool ignoreOverride, bool copyMeta)
  1276. {
  1277. if (dest.getType() == JsonNode::JsonType::DATA_NULL)
  1278. {
  1279. std::swap(dest, source);
  1280. return;
  1281. }
  1282. switch (source.getType())
  1283. {
  1284. case JsonNode::JsonType::DATA_NULL:
  1285. {
  1286. dest.clear();
  1287. break;
  1288. }
  1289. case JsonNode::JsonType::DATA_BOOL:
  1290. case JsonNode::JsonType::DATA_FLOAT:
  1291. case JsonNode::JsonType::DATA_INTEGER:
  1292. case JsonNode::JsonType::DATA_STRING:
  1293. case JsonNode::JsonType::DATA_VECTOR:
  1294. {
  1295. std::swap(dest, source);
  1296. break;
  1297. }
  1298. case JsonNode::JsonType::DATA_STRUCT:
  1299. {
  1300. if(!ignoreOverride && vstd::contains(source.flags, "override"))
  1301. {
  1302. std::swap(dest, source);
  1303. }
  1304. else
  1305. {
  1306. if (copyMeta)
  1307. dest.meta = source.meta;
  1308. //recursively merge all entries from struct
  1309. for(auto & node : source.Struct())
  1310. merge(dest[node.first], node.second, ignoreOverride);
  1311. }
  1312. }
  1313. }
  1314. }
  1315. void JsonUtils::mergeCopy(JsonNode & dest, JsonNode source, bool ignoreOverride, bool copyMeta)
  1316. {
  1317. // uses copy created in stack to safely merge two nodes
  1318. merge(dest, source, ignoreOverride, copyMeta);
  1319. }
  1320. void JsonUtils::inherit(JsonNode & descendant, const JsonNode & base)
  1321. {
  1322. JsonNode inheritedNode(base);
  1323. merge(inheritedNode, descendant, true, true);
  1324. std::swap(descendant, inheritedNode);
  1325. }
  1326. JsonNode JsonUtils::intersect(const std::vector<JsonNode> & nodes, bool pruneEmpty)
  1327. {
  1328. if(nodes.empty())
  1329. return nullNode;
  1330. JsonNode result = nodes[0];
  1331. for(int i = 1; i < nodes.size(); i++)
  1332. {
  1333. if(result.isNull())
  1334. break;
  1335. result = JsonUtils::intersect(result, nodes[i], pruneEmpty);
  1336. }
  1337. return result;
  1338. }
  1339. JsonNode JsonUtils::intersect(const JsonNode & a, const JsonNode & b, bool pruneEmpty)
  1340. {
  1341. if(a.getType() == JsonNode::JsonType::DATA_STRUCT && b.getType() == JsonNode::JsonType::DATA_STRUCT)
  1342. {
  1343. // intersect individual properties
  1344. JsonNode result(JsonNode::JsonType::DATA_STRUCT);
  1345. for(const auto & property : a.Struct())
  1346. {
  1347. if(vstd::contains(b.Struct(), property.first))
  1348. {
  1349. JsonNode propertyIntersect = JsonUtils::intersect(property.second, b.Struct().find(property.first)->second);
  1350. if(pruneEmpty && !propertyIntersect.containsBaseData())
  1351. continue;
  1352. result[property.first] = propertyIntersect;
  1353. }
  1354. }
  1355. return result;
  1356. }
  1357. else
  1358. {
  1359. // not a struct - same or different, no middle ground
  1360. if(a == b)
  1361. return a;
  1362. }
  1363. return nullNode;
  1364. }
  1365. JsonNode JsonUtils::difference(const JsonNode & node, const JsonNode & base)
  1366. {
  1367. auto addsInfo = [](JsonNode diff) -> bool
  1368. {
  1369. switch(diff.getType())
  1370. {
  1371. case JsonNode::JsonType::DATA_NULL:
  1372. return false;
  1373. case JsonNode::JsonType::DATA_STRUCT:
  1374. return !diff.Struct().empty();
  1375. default:
  1376. return true;
  1377. }
  1378. };
  1379. if(node.getType() == JsonNode::JsonType::DATA_STRUCT && base.getType() == JsonNode::JsonType::DATA_STRUCT)
  1380. {
  1381. // subtract individual properties
  1382. JsonNode result(JsonNode::JsonType::DATA_STRUCT);
  1383. for(const auto & property : node.Struct())
  1384. {
  1385. if(vstd::contains(base.Struct(), property.first))
  1386. {
  1387. const JsonNode propertyDifference = JsonUtils::difference(property.second, base.Struct().find(property.first)->second);
  1388. if(addsInfo(propertyDifference))
  1389. result[property.first] = propertyDifference;
  1390. }
  1391. else
  1392. {
  1393. result[property.first] = property.second;
  1394. }
  1395. }
  1396. return result;
  1397. }
  1398. else
  1399. {
  1400. if(node == base)
  1401. return nullNode;
  1402. }
  1403. return node;
  1404. }
  1405. JsonNode JsonUtils::assembleFromFiles(const std::vector<std::string> & files)
  1406. {
  1407. bool isValid = false;
  1408. return assembleFromFiles(files, isValid);
  1409. }
  1410. JsonNode JsonUtils::assembleFromFiles(const std::vector<std::string> & files, bool & isValid)
  1411. {
  1412. isValid = true;
  1413. JsonNode result;
  1414. for(const auto & file : files)
  1415. {
  1416. bool isValidFile = false;
  1417. JsonNode section(JsonPath::builtinTODO(file), isValidFile);
  1418. merge(result, section);
  1419. isValid |= isValidFile;
  1420. }
  1421. return result;
  1422. }
  1423. JsonNode JsonUtils::assembleFromFiles(const std::string & filename)
  1424. {
  1425. JsonNode result;
  1426. JsonPath resID = JsonPath::builtinTODO(filename);
  1427. for(auto & loader : CResourceHandler::get()->getResourcesWithName(resID))
  1428. {
  1429. // FIXME: some way to make this code more readable
  1430. auto stream = loader->load(resID);
  1431. std::unique_ptr<ui8[]> textData(new ui8[stream->getSize()]);
  1432. stream->read(textData.get(), stream->getSize());
  1433. JsonNode section(reinterpret_cast<char *>(textData.get()), stream->getSize());
  1434. merge(result, section);
  1435. }
  1436. return result;
  1437. }
  1438. DLL_LINKAGE JsonNode JsonUtils::boolNode(bool value)
  1439. {
  1440. JsonNode node;
  1441. node.Bool() = value;
  1442. return node;
  1443. }
  1444. DLL_LINKAGE JsonNode JsonUtils::floatNode(double value)
  1445. {
  1446. JsonNode node;
  1447. node.Float() = value;
  1448. return node;
  1449. }
  1450. DLL_LINKAGE JsonNode JsonUtils::stringNode(const std::string & value)
  1451. {
  1452. JsonNode node;
  1453. node.String() = value;
  1454. return node;
  1455. }
  1456. DLL_LINKAGE JsonNode JsonUtils::intNode(si64 value)
  1457. {
  1458. JsonNode node;
  1459. node.Integer() = value;
  1460. return node;
  1461. }
  1462. VCMI_LIB_NAMESPACE_END