JsonNode.cpp 27 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181
  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 "HeroBonus.h"
  13. #include "Filesystem/CResourceLoader.h"
  14. #include "VCMI_Lib.h" //for identifier resolution
  15. #include "CModHandler.h"
  16. using namespace JsonDetail;
  17. class LibClasses;
  18. class CModHandler;
  19. static const JsonNode nullNode;
  20. JsonNode::JsonNode(JsonType Type):
  21. type(DATA_NULL)
  22. {
  23. setType(Type);
  24. }
  25. JsonNode::JsonNode(const char *data, size_t datasize):
  26. type(DATA_NULL)
  27. {
  28. JsonParser parser(data, datasize);
  29. *this = parser.parse("<unknown>");
  30. JsonValidator validator(*this);
  31. }
  32. JsonNode::JsonNode(ResourceID && fileURI):
  33. type(DATA_NULL)
  34. {
  35. auto file = CResourceHandler::get()->loadData(fileURI);
  36. JsonParser parser(reinterpret_cast<char*>(file.first.get()), file.second);
  37. *this = parser.parse(fileURI.getName());
  38. JsonValidator validator(*this);
  39. }
  40. JsonNode::JsonNode(const JsonNode &copy):
  41. type(DATA_NULL)
  42. {
  43. setType(copy.getType());
  44. switch(type)
  45. {
  46. break; case DATA_NULL:
  47. break; case DATA_BOOL: Bool() = copy.Bool();
  48. break; case DATA_FLOAT: Float() = copy.Float();
  49. break; case DATA_STRING: String() = copy.String();
  50. break; case DATA_VECTOR: Vector() = copy.Vector();
  51. break; case DATA_STRUCT: Struct() = copy.Struct();
  52. }
  53. }
  54. JsonNode::~JsonNode()
  55. {
  56. setType(DATA_NULL);
  57. }
  58. void JsonNode::swap(JsonNode &b)
  59. {
  60. using std::swap;
  61. swap(data, b.data);
  62. swap(type, b.type);
  63. }
  64. JsonNode & JsonNode::operator =(JsonNode node)
  65. {
  66. swap(node);
  67. return *this;
  68. }
  69. bool JsonNode::operator == (const JsonNode &other) const
  70. {
  71. if (getType() == other.getType())
  72. {
  73. switch(type)
  74. {
  75. break; case DATA_NULL: return true;
  76. break; case DATA_BOOL: return Bool() == other.Bool();
  77. break; case DATA_FLOAT: return Float() == other.Float();
  78. break; case DATA_STRING: return String() == other.String();
  79. break; case DATA_VECTOR: return Vector() == other.Vector();
  80. break; case DATA_STRUCT: return Struct() == other.Struct();
  81. }
  82. }
  83. return false;
  84. }
  85. bool JsonNode::operator != (const JsonNode &other) const
  86. {
  87. return !(*this == other);
  88. }
  89. JsonNode::JsonType JsonNode::getType() const
  90. {
  91. return type;
  92. }
  93. void JsonNode::setType(JsonType Type)
  94. {
  95. if (type == Type)
  96. return;
  97. //Reset node to NULL
  98. if (Type != DATA_NULL)
  99. setType(DATA_NULL);
  100. switch (type)
  101. {
  102. break; case DATA_STRING: delete data.String;
  103. break; case DATA_VECTOR: delete data.Vector;
  104. break; case DATA_STRUCT: delete data.Struct;
  105. break; default:
  106. break;
  107. }
  108. //Set new node type
  109. type = Type;
  110. switch(type)
  111. {
  112. break; case DATA_NULL:
  113. break; case DATA_BOOL: data.Bool = false;
  114. break; case DATA_FLOAT: data.Float = 0;
  115. break; case DATA_STRING: data.String = new std::string();
  116. break; case DATA_VECTOR: data.Vector = new JsonVector();
  117. break; case DATA_STRUCT: data.Struct = new JsonMap();
  118. }
  119. }
  120. bool JsonNode::isNull() const
  121. {
  122. return type == DATA_NULL;
  123. }
  124. bool & JsonNode::Bool()
  125. {
  126. setType(DATA_BOOL);
  127. return data.Bool;
  128. }
  129. double & JsonNode::Float()
  130. {
  131. setType(DATA_FLOAT);
  132. return data.Float;
  133. }
  134. std::string & JsonNode::String()
  135. {
  136. setType(DATA_STRING);
  137. return *data.String;
  138. }
  139. JsonVector & JsonNode::Vector()
  140. {
  141. setType(DATA_VECTOR);
  142. return *data.Vector;
  143. }
  144. JsonMap & JsonNode::Struct()
  145. {
  146. setType(DATA_STRUCT);
  147. return *data.Struct;
  148. }
  149. const bool boolDefault = false;
  150. const bool & JsonNode::Bool() const
  151. {
  152. if (type == DATA_NULL)
  153. return boolDefault;
  154. assert(type == DATA_BOOL);
  155. return data.Bool;
  156. }
  157. const double floatDefault = 0;
  158. const double & JsonNode::Float() const
  159. {
  160. if (type == DATA_NULL)
  161. return floatDefault;
  162. assert(type == DATA_FLOAT);
  163. return data.Float;
  164. }
  165. const std::string stringDefault = std::string();
  166. const std::string & JsonNode::String() const
  167. {
  168. if (type == DATA_NULL)
  169. return stringDefault;
  170. assert(type == DATA_STRING);
  171. return *data.String;
  172. }
  173. const JsonVector vectorDefault = JsonVector();
  174. const JsonVector & JsonNode::Vector() const
  175. {
  176. if (type == DATA_NULL)
  177. return vectorDefault;
  178. assert(type == DATA_VECTOR);
  179. return *data.Vector;
  180. }
  181. const JsonMap mapDefault = JsonMap();
  182. const JsonMap & JsonNode::Struct() const
  183. {
  184. if (type == DATA_NULL)
  185. return mapDefault;
  186. assert(type == DATA_STRUCT);
  187. return *data.Struct;
  188. }
  189. JsonNode & JsonNode::operator[](std::string child)
  190. {
  191. return Struct()[child];
  192. }
  193. const JsonNode & JsonNode::operator[](std::string child) const
  194. {
  195. JsonMap::const_iterator it = Struct().find(child);
  196. if (it != Struct().end())
  197. return it->second;
  198. return nullNode;
  199. }
  200. ////////////////////////////////////////////////////////////////////////////////
  201. template<typename Iterator>
  202. void JsonWriter::writeContainer(Iterator begin, Iterator end)
  203. {
  204. if (begin == end)
  205. return;
  206. prefix += '\t';
  207. writeEntry(begin++);
  208. while (begin != end)
  209. {
  210. out<<",\n";
  211. writeEntry(begin++);
  212. }
  213. out<<"\n";
  214. prefix.resize(prefix.size()-1);
  215. }
  216. void JsonWriter::writeEntry(JsonMap::const_iterator entry)
  217. {
  218. out << prefix;
  219. writeString(entry->first);
  220. out << " : ";
  221. writeNode(entry->second);
  222. }
  223. void JsonWriter::writeEntry(JsonVector::const_iterator entry)
  224. {
  225. out << prefix;
  226. writeNode(*entry);
  227. }
  228. void JsonWriter::writeString(const std::string &string)
  229. {
  230. static const std::string escaped = "\"\\/\b\f\n\r\t";
  231. out <<'\"';
  232. size_t pos=0, start=0;
  233. for (; pos<string.size(); pos++)
  234. {
  235. size_t escapedChar = escaped.find(string[pos]);
  236. if (escapedChar != std::string::npos)
  237. {
  238. out.write(string.data()+start, pos - start);
  239. out << '\\' << escaped[escapedChar];
  240. start = pos;
  241. }
  242. }
  243. out.write(string.data()+start, pos - start);
  244. out <<'\"';
  245. }
  246. void JsonWriter::writeNode(const JsonNode &node)
  247. {
  248. switch(node.getType())
  249. {
  250. break; case JsonNode::DATA_NULL:
  251. out << "null";
  252. break; case JsonNode::DATA_BOOL:
  253. if (node.Bool())
  254. out << "true";
  255. else
  256. out << "false";
  257. break; case JsonNode::DATA_FLOAT:
  258. out << node.Float();
  259. break; case JsonNode::DATA_STRING:
  260. writeString(node.String());
  261. break; case JsonNode::DATA_VECTOR:
  262. out << "[" << "\n";
  263. writeContainer(node.Vector().begin(), node.Vector().end());
  264. out << prefix << "]";
  265. break; case JsonNode::DATA_STRUCT:
  266. out << "{" << "\n";
  267. writeContainer(node.Struct().begin(), node.Struct().end());
  268. out << prefix << "}";
  269. }
  270. }
  271. JsonWriter::JsonWriter(std::ostream &output, const JsonNode &node):
  272. out(output)
  273. {
  274. writeNode(node);
  275. }
  276. std::ostream & operator<<(std::ostream &out, const JsonNode &node)
  277. {
  278. JsonWriter(out, node);
  279. return out << "\n";
  280. }
  281. ////////////////////////////////////////////////////////////////////////////////
  282. JsonParser::JsonParser(const char * inputString, size_t stringSize):
  283. input(inputString, stringSize),
  284. lineCount(1),
  285. lineStart(0),
  286. pos(0)
  287. {
  288. }
  289. JsonNode JsonParser::parse(std::string fileName)
  290. {
  291. JsonNode root;
  292. extractValue(root);
  293. extractWhitespace(false);
  294. //Warn if there are any non-whitespace symbols left
  295. if (pos < input.size())
  296. error("Not all file was parsed!", true);
  297. if (!errors.empty())
  298. {
  299. tlog3<<"File " << fileName << " is not a valid JSON file!\n";
  300. tlog3<<errors;
  301. }
  302. return root;
  303. }
  304. bool JsonParser::extractSeparator()
  305. {
  306. if (!extractWhitespace())
  307. return false;
  308. if ( input[pos] !=':')
  309. return error("Separator expected");
  310. pos++;
  311. return true;
  312. }
  313. bool JsonParser::extractValue(JsonNode &node)
  314. {
  315. if (!extractWhitespace())
  316. return false;
  317. switch (input[pos])
  318. {
  319. case '\"': return extractString(node);
  320. case 'n' : return extractNull(node);
  321. case 't' : return extractTrue(node);
  322. case 'f' : return extractFalse(node);
  323. case '{' : return extractStruct(node);
  324. case '[' : return extractArray(node);
  325. case '-' : return extractFloat(node);
  326. default:
  327. {
  328. if (input[pos] >= '0' && input[pos] <= '9')
  329. return extractFloat(node);
  330. return error("Value expected!");
  331. }
  332. }
  333. }
  334. bool JsonParser::extractWhitespace(bool verbose)
  335. {
  336. while (true)
  337. {
  338. while (pos < input.size() && (ui8)input[pos] <= ' ')
  339. {
  340. if (input[pos] == '\n')
  341. {
  342. lineCount++;
  343. lineStart = pos+1;
  344. }
  345. pos++;
  346. }
  347. if (pos >= input.size() || input[pos] != '/')
  348. break;
  349. pos++;
  350. if (pos == input.size())
  351. break;
  352. if (input[pos] == '/')
  353. pos++;
  354. else
  355. error("Comments must consist from two slashes!", true);
  356. while (pos < input.size() && input[pos] != '\n')
  357. pos++;
  358. }
  359. if (pos >= input.size() && verbose)
  360. return error("Unexpected end of file!");
  361. return true;
  362. }
  363. bool JsonParser::extractEscaping(std::string &str)
  364. {
  365. switch(input[pos])
  366. {
  367. break; case '\"': str += '\"';
  368. break; case '\\': str += '\\';
  369. break; case '/': str += '/';
  370. break; case 'b': str += '\b';
  371. break; case 'f': str += '\f';
  372. break; case 'n': str += '\n';
  373. break; case 'r': str += '\r';
  374. break; case 't': str += '\t';
  375. break; default: return error("Unknown escape sequence!", true);
  376. };
  377. return true;
  378. }
  379. bool JsonParser::extractString(std::string &str)
  380. {
  381. if (input[pos] != '\"')
  382. return error("String expected!");
  383. pos++;
  384. size_t first = pos;
  385. while (pos != input.size())
  386. {
  387. if (input[pos] == '\"') // Correct end of string
  388. {
  389. str.append( &input[first], pos-first);
  390. pos++;
  391. return true;
  392. }
  393. if (input[pos] == '\\') // Escaping
  394. {
  395. str.append( &input[first], pos-first);
  396. pos++;
  397. if (pos == input.size())
  398. break;
  399. extractEscaping(str);
  400. first = pos + 1;
  401. }
  402. if (input[pos] == '\n') // end-of-line
  403. {
  404. str.append( &input[first], pos-first);
  405. return error("Closing quote not found!", true);
  406. }
  407. if ((unsigned char)(input[pos]) < ' ') // control character
  408. {
  409. str.append( &input[first], pos-first);
  410. first = pos+1;
  411. error("Illegal character in the string!", true);
  412. }
  413. pos++;
  414. }
  415. return error("Unterminated string!");
  416. }
  417. bool JsonParser::extractString(JsonNode &node)
  418. {
  419. std::string str;
  420. if (!extractString(str))
  421. return false;
  422. node.setType(JsonNode::DATA_STRING);
  423. node.String() = str;
  424. return true;
  425. }
  426. bool JsonParser::extractLiteral(const std::string &literal)
  427. {
  428. if (literal.compare(0, literal.size(), &input[pos], literal.size()) != 0)
  429. {
  430. while (pos < input.size() && ((input[pos]>'a' && input[pos]<'z')
  431. || (input[pos]>'A' && input[pos]<'Z')))
  432. pos++;
  433. return error("Unknown literal found", true);
  434. }
  435. pos += literal.size();
  436. return true;
  437. }
  438. bool JsonParser::extractNull(JsonNode &node)
  439. {
  440. if (!extractLiteral("null"))
  441. return false;
  442. node.setType(JsonNode::DATA_NULL);
  443. return true;
  444. }
  445. bool JsonParser::extractTrue(JsonNode &node)
  446. {
  447. if (!extractLiteral("true"))
  448. return false;
  449. node.Bool() = true;
  450. return true;
  451. }
  452. bool JsonParser::extractFalse(JsonNode &node)
  453. {
  454. if (!extractLiteral("false"))
  455. return false;
  456. node.Bool() = false;
  457. return true;
  458. }
  459. bool JsonParser::extractStruct(JsonNode &node)
  460. {
  461. node.setType(JsonNode::DATA_STRUCT);
  462. pos++;
  463. if (!extractWhitespace())
  464. return false;
  465. //Empty struct found
  466. if (input[pos] == '}')
  467. {
  468. pos++;
  469. return true;
  470. }
  471. while (true)
  472. {
  473. if (!extractWhitespace())
  474. return false;
  475. std::string key;
  476. if (!extractString(key))
  477. return false;
  478. if (node.Struct().find(key) != node.Struct().end())
  479. error("Dublicated element encountered!", true);
  480. if (!extractSeparator())
  481. return false;
  482. if (!extractElement(node.Struct()[key], '}'))
  483. return false;
  484. if (input[pos] == '}')
  485. {
  486. pos++;
  487. return true;
  488. }
  489. }
  490. }
  491. bool JsonParser::extractArray(JsonNode &node)
  492. {
  493. pos++;
  494. node.setType(JsonNode::DATA_VECTOR);
  495. if (!extractWhitespace())
  496. return false;
  497. //Empty array found
  498. if (input[pos] == ']')
  499. {
  500. pos++;
  501. return true;
  502. }
  503. while (true)
  504. {
  505. //NOTE: currently 50% of time is this vector resizing.
  506. //May be useful to use list during parsing and then swap() all items to vector
  507. node.Vector().resize(node.Vector().size()+1);
  508. if (!extractElement(node.Vector().back(), ']'))
  509. return false;
  510. if (input[pos] == ']')
  511. {
  512. pos++;
  513. return true;
  514. }
  515. }
  516. }
  517. bool JsonParser::extractElement(JsonNode &node, char terminator)
  518. {
  519. if (!extractValue(node))
  520. return false;
  521. if (!extractWhitespace())
  522. return false;
  523. bool comma = (input[pos] == ',');
  524. if (comma )
  525. {
  526. pos++;
  527. if (!extractWhitespace())
  528. return false;
  529. }
  530. if (input[pos] == terminator)
  531. return true;
  532. if (!comma)
  533. error("Comma expected!", true);
  534. return true;
  535. }
  536. bool JsonParser::extractFloat(JsonNode &node)
  537. {
  538. assert(input[pos] == '-' || (input[pos] >= '0' && input[pos] <= '9'));
  539. bool negative=false;
  540. double result=0;
  541. if (input[pos] == '-')
  542. {
  543. pos++;
  544. negative = true;
  545. }
  546. if (input[pos] < '0' || input[pos] > '9')
  547. return error("Number expected!");
  548. //Extract integer part
  549. while (input[pos] >= '0' && input[pos] <= '9')
  550. {
  551. result = result*10+(input[pos]-'0');
  552. pos++;
  553. }
  554. if (input[pos] == '.')
  555. {
  556. //extract fractional part
  557. pos++;
  558. double fractMult = 0.1;
  559. if (input[pos] < '0' || input[pos] > '9')
  560. return error("Decimal part expected!");
  561. while (input[pos] >= '0' && input[pos] <= '9')
  562. {
  563. result = result + fractMult*(input[pos]-'0');
  564. fractMult /= 10;
  565. pos++;
  566. }
  567. }
  568. //TODO: exponential part
  569. if (negative)
  570. result = -result;
  571. node.setType(JsonNode::DATA_FLOAT);
  572. node.Float() = result;
  573. return true;
  574. }
  575. bool JsonParser::error(const std::string &message, bool warning)
  576. {
  577. std::ostringstream stream;
  578. std::string type(warning?" warning: ":" error: ");
  579. stream << "At line " << lineCount << ", position "<<pos-lineStart
  580. << type << message <<"\n";
  581. errors += stream.str();
  582. return warning;
  583. }
  584. static const std::map<std::string, JsonNode::JsonType> stringToType =
  585. boost::assign::map_list_of
  586. ("null", JsonNode::DATA_NULL) ("bool", JsonNode::DATA_BOOL)
  587. ("number", JsonNode::DATA_FLOAT) ("string", JsonNode::DATA_STRING)
  588. ("array", JsonNode::DATA_VECTOR) ("object", JsonNode::DATA_STRUCT);
  589. //Check current schema entry for validness and converts "type" string to JsonType
  590. bool JsonValidator::validateSchema(JsonNode::JsonType &type, const JsonNode &schema)
  591. {
  592. if (schema.isNull())
  593. return addMessage("Missing schema for current entry!");
  594. const JsonNode &nodeType = schema["type"];
  595. if (nodeType.isNull())
  596. return addMessage("Entry type is not defined in schema!");
  597. if (nodeType.getType() != JsonNode::DATA_STRING)
  598. return addMessage("Entry type must be string!");
  599. std::map<std::string, JsonNode::JsonType>::const_iterator iter = stringToType.find(nodeType.String());
  600. if (iter == stringToType.end())
  601. return addMessage("Unknown entry type found!");
  602. type = iter->second;
  603. return true;
  604. }
  605. //Replaces node with default value if needed and calls type-specific validators
  606. bool JsonValidator::validateType(JsonNode &node, const JsonNode &schema, JsonNode::JsonType type)
  607. {
  608. if (node.isNull())
  609. {
  610. const JsonNode & defaultValue = schema["default"];
  611. if (defaultValue.isNull())
  612. return addMessage("Null entry without default entry!");
  613. else
  614. node = defaultValue;
  615. }
  616. if (minimize && node == schema["default"])
  617. {
  618. node.setType(JsonNode::DATA_NULL);
  619. return false;
  620. }
  621. if (type != node.getType())
  622. {
  623. node.setType(JsonNode::DATA_NULL);
  624. return addMessage("Type mismatch!");
  625. }
  626. if (type == JsonNode::DATA_VECTOR)
  627. return validateItems(node, schema["items"]);
  628. if (type == JsonNode::DATA_STRUCT)
  629. return validateProperties(node, schema["properties"]);
  630. return true;
  631. }
  632. // Basic checks common for any nodes
  633. bool JsonValidator::validateNode(JsonNode &node, const JsonNode &schema, const std::string &name)
  634. {
  635. currentPath.push_back(name);
  636. JsonNode::JsonType type = JsonNode::DATA_NULL;
  637. if (!validateSchema(type, schema)
  638. || !validateType(node, schema, type))
  639. {
  640. node.setType(JsonNode::DATA_NULL);
  641. currentPath.pop_back();
  642. return false;
  643. }
  644. currentPath.pop_back();
  645. return true;
  646. }
  647. //Checks "items" entry from schema (type-specific check for Vector)
  648. bool JsonValidator::validateItems(JsonNode &node, const JsonNode &schema)
  649. {
  650. JsonNode::JsonType type = JsonNode::DATA_NULL;
  651. if (!validateSchema(type, schema))
  652. return false;
  653. bool result = true;
  654. BOOST_FOREACH(JsonNode &entry, node.Vector())
  655. {
  656. if (!validateType(entry, schema, type))
  657. {
  658. result = false;
  659. entry.setType(JsonNode::DATA_NULL);
  660. }
  661. }
  662. return result;
  663. }
  664. //Checks "propertries" entry from schema (type-specific check for Struct)
  665. bool JsonValidator::validateProperties(JsonNode &node, const JsonNode &schema)
  666. {
  667. if (schema.isNull())
  668. return addMessage("Properties entry is missing for struct in schema");
  669. BOOST_FOREACH(auto & schemaEntry, schema.Struct())
  670. {
  671. if (!validateNode(node[schemaEntry.first], schemaEntry.second, schemaEntry.first))
  672. node.Struct().erase(schemaEntry.first);
  673. }
  674. for (auto iter = node.Struct().begin(); iter!= node.Struct().end();)
  675. {
  676. if (!vstd::contains(schema.Struct(), iter->first))
  677. {
  678. addMessage("Missing schema for entry " + iter->first + "!");
  679. iter = node.Struct().erase(iter);
  680. }
  681. else
  682. iter++;
  683. }
  684. return true;
  685. }
  686. bool JsonValidator::addMessage(const std::string &message)
  687. {
  688. std::ostringstream stream;
  689. stream << "At ";
  690. BOOST_FOREACH(const std::string &path, currentPath)
  691. stream << path<<"/";
  692. stream << "\t Error: " << message <<"\n";
  693. errors += stream.str();
  694. return false;
  695. }
  696. JsonValidator::JsonValidator(JsonNode &root, bool Minimize):
  697. minimize(Minimize)
  698. {
  699. if (root.getType() != JsonNode::DATA_STRUCT)
  700. return;
  701. JsonNode schema;
  702. schema.swap(root["schema"]);
  703. root.Struct().erase("schema");
  704. if (!schema.isNull())
  705. {
  706. validateProperties(root, schema);
  707. }
  708. //This message is quite annoying now - most files do not have schemas. May be re-enabled later
  709. //else
  710. // addMessage("Schema not found!", true);
  711. //TODO: better way to show errors (like printing file name as well)
  712. tlog3<<errors;
  713. }
  714. JsonValidator::JsonValidator(JsonNode &root, const JsonNode &schema, bool Minimize):
  715. minimize(Minimize)
  716. {
  717. validateProperties(root, schema);
  718. if (schema.isNull())
  719. addMessage("Schema not found!");
  720. tlog3<<errors;
  721. }
  722. ///JsonUtils
  723. void JsonUtils::parseTypedBonusShort(const JsonVector& source, Bonus *dest)
  724. {
  725. dest->val = source[1].Float();
  726. resolveIdentifier(source[2],dest->subtype);
  727. dest->additionalInfo = source[3].Float();
  728. dest->duration = Bonus::PERMANENT; //TODO: handle flags (as integer)
  729. dest->turnsRemain = 0;
  730. }
  731. Bonus * JsonUtils::parseBonus (const JsonVector &ability_vec) //TODO: merge with AddAbility, create universal parser for all bonus properties
  732. {
  733. Bonus * b = new Bonus();
  734. std::string type = ability_vec[0].String();
  735. auto it = bonusNameMap.find(type);
  736. if (it == bonusNameMap.end())
  737. {
  738. tlog1 << "Error: invalid ability type " << type << std::endl;
  739. return b;
  740. }
  741. b->type = it->second;
  742. parseTypedBonusShort(ability_vec, b);
  743. return b;
  744. }
  745. template <typename T>
  746. const T & parseByMap(const std::map<std::string, T> & map, const JsonNode * val, std::string err)
  747. {
  748. static T defaultValue;
  749. if (!val->isNull())
  750. {
  751. std::string type = val->String();
  752. auto it = map.find(type);
  753. if (it == map.end())
  754. {
  755. tlog1 << "Error: invalid " << err << type << std::endl;
  756. return defaultValue;
  757. }
  758. else
  759. {
  760. return it->second;
  761. }
  762. }
  763. else
  764. return defaultValue;
  765. };
  766. void JsonUtils::resolveIdentifier (si32 &var, const JsonNode &node, std::string name)
  767. {
  768. const JsonNode *value;
  769. value = &node[name];
  770. if (!value->isNull())
  771. {
  772. switch (value->getType())
  773. {
  774. case JsonNode::DATA_FLOAT:
  775. var = value->Float();
  776. break;
  777. case JsonNode::DATA_STRING:
  778. VLC->modh->identifiers.requestIdentifier (value->String(), [&](si32 identifier)
  779. {
  780. var = identifier;
  781. });
  782. break;
  783. default:
  784. tlog2 << "Error! Wrong indentifier used for value of " << name;
  785. }
  786. }
  787. }
  788. void JsonUtils::resolveIdentifier (const JsonNode &node, si32 &var)
  789. {
  790. switch (node.getType())
  791. {
  792. case JsonNode::DATA_FLOAT:
  793. var = node.Float();
  794. break;
  795. case JsonNode::DATA_STRING:
  796. VLC->modh->identifiers.requestIdentifier (node.String(), [&](si32 identifier)
  797. {
  798. var = identifier;
  799. });
  800. break;
  801. default:
  802. tlog2 << "Error! Wrong indentifier used for identifier!";
  803. }
  804. }
  805. Bonus * JsonUtils::parseBonus (const JsonNode &ability)
  806. {
  807. Bonus * b = new Bonus();
  808. const JsonNode *value;
  809. std::string type = ability["type"].String();
  810. auto it = bonusNameMap.find(type);
  811. if (it == bonusNameMap.end())
  812. {
  813. tlog1 << "Error: invalid ability type " << type << std::endl;
  814. return b;
  815. }
  816. b->type = it->second;
  817. resolveIdentifier (b->subtype, ability, "subtype");
  818. b->val = ability["val"].Float();
  819. value = &ability["valueType"];
  820. if (!value->isNull())
  821. b->valType = static_cast<Bonus::ValueType>(parseByMap(bonusValueMap, value, "value type "));
  822. resolveIdentifier (b->additionalInfo, ability, "addInfo");
  823. b->turnsRemain = ability["turns"].Float();
  824. b->sid = ability["sourceID"].Float();
  825. b->description = ability["description"].String();
  826. value = &ability["effectRange"];
  827. if (!value->isNull())
  828. b->effectRange = static_cast<Bonus::LimitEffect>(parseByMap(bonusLimitEffect, value, "effect range "));
  829. value = &ability["duration"];
  830. if (!value->isNull())
  831. {
  832. switch (value->getType())
  833. {
  834. case JsonNode::DATA_STRING:
  835. b->duration = parseByMap(bonusDurationMap, value, "duration type ");
  836. break;
  837. case JsonNode::DATA_VECTOR:
  838. {
  839. ui16 dur = 0;
  840. BOOST_FOREACH (const JsonNode & d, value->Vector())
  841. {
  842. dur |= parseByMap(bonusDurationMap, &d, "duration type ");
  843. }
  844. b->duration = dur;
  845. }
  846. break;
  847. default:
  848. tlog2 << "Error! Wrong bonus duration format.";
  849. }
  850. }
  851. value = &ability["source"];
  852. if (!value->isNull())
  853. b->source = static_cast<Bonus::BonusSource>(parseByMap(bonusSourceMap, value, "source type "));
  854. value = &ability["limiters"];
  855. if (!value->isNull())
  856. {
  857. BOOST_FOREACH (const JsonNode & limiter, value->Vector())
  858. {
  859. switch (limiter.getType())
  860. {
  861. case JsonNode::DATA_STRING: //pre-defined limiters
  862. b->limiter = parseByMap(bonusLimiterMap, &limiter, "limiter type ");
  863. break;
  864. case JsonNode::DATA_STRUCT: //customizable limiters
  865. {
  866. shared_ptr<ILimiter> l;
  867. if (limiter["type"].String() == "CREATURE_TYPE_LIMITER")
  868. {
  869. shared_ptr<CCreatureTypeLimiter> l2 = make_shared<CCreatureTypeLimiter>(); //TODO: How the hell resolve pointer to creature?
  870. const JsonVector vec = limiter["parameters"].Vector();
  871. VLC->modh->identifiers.requestIdentifier(std::string("creature.") + vec[0].String(), [=](si32 creature)
  872. {
  873. l2->setCreature (CreatureID(creature));
  874. });
  875. if (vec.size() > 1)
  876. {
  877. l2->includeUpgrades = vec[1].Bool();
  878. }
  879. else
  880. l2->includeUpgrades = false;
  881. l = l2;
  882. }
  883. if (limiter["type"].String() == "HAS_ANOTHER_BONUS_LIMITER")
  884. {
  885. shared_ptr<HasAnotherBonusLimiter> l2 = make_shared<HasAnotherBonusLimiter>();
  886. const JsonVector vec = limiter["parameters"].Vector();
  887. std::string anotherBonusType = vec[0].String();
  888. auto it = bonusNameMap.find (anotherBonusType);
  889. if (it == bonusNameMap.end())
  890. {
  891. tlog1 << "Error: invalid ability type " << anotherBonusType << std::endl;
  892. continue;
  893. }
  894. l2->type = it->second;
  895. if (vec.size() > 1 )
  896. {
  897. resolveIdentifier (vec[1], l2->subtype);
  898. l2->isSubtypeRelevant = true;
  899. }
  900. l = l2;
  901. }
  902. b->addLimiter(l);
  903. }
  904. break;
  905. }
  906. }
  907. }
  908. value = &ability["propagator"];
  909. if (!value->isNull())
  910. b->propagator = parseByMap(bonusPropagatorMap, value, "propagator type ");
  911. return b;
  912. }
  913. //returns first Key with value equal to given one
  914. template<class Key, class Val>
  915. Key reverseMapFirst(const Val & val, const std::map<Key, Val> map)
  916. {
  917. BOOST_FOREACH(auto it, map)
  918. {
  919. if(it.second == val)
  920. {
  921. return it.first;
  922. }
  923. }
  924. assert(0);
  925. return "";
  926. }
  927. void JsonUtils::unparseBonus( JsonNode &node, const Bonus * bonus )
  928. {
  929. node["type"].String() = reverseMapFirst<std::string, Bonus::BonusType>(bonus->type, bonusNameMap);
  930. node["subtype"].Float() = bonus->subtype;
  931. node["val"].Float() = bonus->val;
  932. node["valueType"].String() = reverseMapFirst<std::string, Bonus::ValueType>(bonus->valType, bonusValueMap);
  933. node["additionalInfo"].Float() = bonus->additionalInfo;
  934. node["turns"].Float() = bonus->turnsRemain;
  935. node["sourceID"].Float() = bonus->source;
  936. node["description"].String() = bonus->description;
  937. node["effectRange"].String() = reverseMapFirst<std::string, Bonus::LimitEffect>(bonus->effectRange, bonusLimitEffect);
  938. node["duration"].String() = reverseMapFirst<std::string, ui16>(bonus->duration, bonusDurationMap);
  939. node["source"].String() = reverseMapFirst<std::string, Bonus::BonusSource>(bonus->source, bonusSourceMap);
  940. if(bonus->limiter)
  941. {
  942. node["limiter"].String() = reverseMapFirst<std::string, TLimiterPtr>(bonus->limiter, bonusLimiterMap);
  943. }
  944. if(bonus->propagator)
  945. {
  946. node["propagator"].String() = reverseMapFirst<std::string, TPropagatorPtr>(bonus->propagator, bonusPropagatorMap);
  947. }
  948. }
  949. void JsonUtils::minimize(JsonNode & node, const JsonNode& schema)
  950. {
  951. JsonValidator validator(node, schema, true);
  952. }
  953. void JsonUtils::validate(JsonNode & node, const JsonNode& schema)
  954. {
  955. JsonValidator validator(node, schema, false);
  956. }
  957. void JsonUtils::merge(JsonNode & dest, JsonNode & source)
  958. {
  959. if (dest.getType() == JsonNode::DATA_NULL)
  960. {
  961. std::swap(dest, source);
  962. return;
  963. }
  964. switch (source.getType())
  965. {
  966. break; case JsonNode::DATA_NULL: dest.setType(JsonNode::DATA_NULL);
  967. break; case JsonNode::DATA_BOOL: std::swap(dest.Bool(), source.Bool());
  968. break; case JsonNode::DATA_FLOAT: std::swap(dest.Float(), source.Float());
  969. break; case JsonNode::DATA_STRING: std::swap(dest.String(), source.String());
  970. break; case JsonNode::DATA_VECTOR:
  971. {
  972. size_t total = std::min(source.Vector().size(), dest.Vector().size());
  973. for (size_t i=0; i< total; i++)
  974. merge(dest.Vector()[i], source.Vector()[i]);
  975. if (source.Vector().size() < dest.Vector().size())
  976. {
  977. //reserve place and *move* data from source to dest
  978. source.Vector().reserve(source.Vector().size() + dest.Vector().size());
  979. std::move(source.Vector().begin(), source.Vector().end(),
  980. std::back_inserter(dest.Vector()));
  981. }
  982. }
  983. break; case JsonNode::DATA_STRUCT:
  984. {
  985. //recursively merge all entries from struct
  986. BOOST_FOREACH(auto & node, source.Struct())
  987. merge(dest[node.first], node.second);
  988. }
  989. }
  990. }
  991. void JsonUtils::mergeCopy(JsonNode & dest, JsonNode source)
  992. {
  993. // uses copy created in stack to safely merge two nodes
  994. merge(dest, source);
  995. }
  996. JsonNode JsonUtils::assembleFromFiles(std::vector<std::string> files)
  997. {
  998. JsonNode result;
  999. BOOST_FOREACH(std::string file, files)
  1000. {
  1001. JsonNode section(ResourceID(file, EResType::TEXT));
  1002. merge(result, section);
  1003. }
  1004. return result;
  1005. }