JsonUtils.cpp 33 KB

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