JsonNode.cpp 27 KB

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