json.cpp 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632
  1. /**************************************************************************/
  2. /* json.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "json.h"
  31. #include "core/config/engine.h"
  32. #include "core/io/file_access.h"
  33. #include "core/object/script_language.h"
  34. #include "core/variant/container_type_validate.h"
  35. const char *JSON::tk_name[TK_MAX] = {
  36. "'{'",
  37. "'}'",
  38. "'['",
  39. "']'",
  40. "identifier",
  41. "string",
  42. "number",
  43. "':'",
  44. "','",
  45. "EOF",
  46. };
  47. void JSON::_add_indent(String &r_result, const String &p_indent, int p_size) {
  48. for (int i = 0; i < p_size; i++) {
  49. r_result += p_indent;
  50. }
  51. }
  52. void JSON::_stringify(String &r_result, const Variant &p_var, const String &p_indent, int p_cur_indent, bool p_sort_keys, HashSet<const void *> &p_markers, bool p_full_precision) {
  53. if (p_cur_indent > Variant::MAX_RECURSION_DEPTH) {
  54. r_result += "...";
  55. ERR_FAIL_MSG("JSON structure is too deep. Bailing.");
  56. }
  57. const char *colon = p_indent.is_empty() ? ":" : ": ";
  58. const char *end_statement = p_indent.is_empty() ? "" : "\n";
  59. switch (p_var.get_type()) {
  60. case Variant::NIL:
  61. r_result += "null";
  62. return;
  63. case Variant::BOOL:
  64. r_result += p_var.operator bool() ? "true" : "false";
  65. return;
  66. case Variant::INT:
  67. r_result += itos(p_var);
  68. return;
  69. case Variant::FLOAT: {
  70. const double num = p_var;
  71. // JSON does not support NaN or Infinity, so use extremely large numbers for infinity.
  72. if (!Math::is_finite(num)) {
  73. if (num == Math::INF) {
  74. r_result += "1e99999";
  75. } else if (num == -Math::INF) {
  76. r_result += "-1e99999";
  77. } else {
  78. WARN_PRINT_ONCE("`NaN` (\"Not a Number\") found in argument passed to JSON.stringify(). `NaN` cannot be represented in JSON, so the value has been replaced with `null`. This warning will not be printed for any later NaN occurrences.");
  79. r_result += "null";
  80. }
  81. return;
  82. }
  83. // Only for exactly 0. If we have approximately 0 let the user decide how much
  84. // precision they want.
  85. if (num == double(0.0)) {
  86. r_result += "0.0";
  87. return;
  88. }
  89. if (p_full_precision) {
  90. const String num_sci = String::num_scientific(num);
  91. if (num_sci.contains_char('.') || num_sci.contains_char('e')) {
  92. r_result += num_sci;
  93. } else {
  94. r_result += num_sci + ".0";
  95. }
  96. } else {
  97. const double magnitude = std::log10(Math::abs(num));
  98. const int precision = MAX(1, 14 - (int)Math::floor(magnitude));
  99. r_result += String::num(num, precision);
  100. }
  101. return;
  102. }
  103. case Variant::PACKED_INT32_ARRAY:
  104. case Variant::PACKED_INT64_ARRAY:
  105. case Variant::PACKED_FLOAT32_ARRAY:
  106. case Variant::PACKED_FLOAT64_ARRAY:
  107. case Variant::PACKED_STRING_ARRAY:
  108. case Variant::ARRAY: {
  109. Array a = p_var;
  110. if (p_markers.has(a.id())) {
  111. r_result += "\"[...]\"";
  112. ERR_FAIL_MSG("Converting circular structure to JSON.");
  113. }
  114. if (a.is_empty()) {
  115. r_result += "[]";
  116. return;
  117. }
  118. r_result += '[';
  119. r_result += end_statement;
  120. p_markers.insert(a.id());
  121. bool first = true;
  122. for (const Variant &var : a) {
  123. if (first) {
  124. first = false;
  125. } else {
  126. r_result += ',';
  127. r_result += end_statement;
  128. }
  129. _add_indent(r_result, p_indent, p_cur_indent + 1);
  130. _stringify(r_result, var, p_indent, p_cur_indent + 1, p_sort_keys, p_markers, p_full_precision);
  131. }
  132. r_result += end_statement;
  133. _add_indent(r_result, p_indent, p_cur_indent);
  134. r_result += ']';
  135. p_markers.erase(a.id());
  136. return;
  137. }
  138. case Variant::DICTIONARY: {
  139. Dictionary d = p_var;
  140. if (p_markers.has(d.id())) {
  141. r_result += "\"{...}\"";
  142. ERR_FAIL_MSG("Converting circular structure to JSON.");
  143. }
  144. r_result += '{';
  145. r_result += end_statement;
  146. p_markers.insert(d.id());
  147. LocalVector<Variant> keys = d.get_key_list();
  148. if (p_sort_keys) {
  149. keys.sort_custom<StringLikeVariantOrder>();
  150. }
  151. bool first_key = true;
  152. for (const Variant &key : keys) {
  153. if (first_key) {
  154. first_key = false;
  155. } else {
  156. r_result += ',';
  157. r_result += end_statement;
  158. }
  159. _add_indent(r_result, p_indent, p_cur_indent + 1);
  160. _stringify(r_result, String(key), p_indent, p_cur_indent + 1, p_sort_keys, p_markers, p_full_precision);
  161. r_result += colon;
  162. _stringify(r_result, d[key], p_indent, p_cur_indent + 1, p_sort_keys, p_markers, p_full_precision);
  163. }
  164. r_result += end_statement;
  165. _add_indent(r_result, p_indent, p_cur_indent);
  166. r_result += '}';
  167. p_markers.erase(d.id());
  168. return;
  169. }
  170. default:
  171. r_result += '"';
  172. r_result += String(p_var).json_escape();
  173. r_result += '"';
  174. return;
  175. }
  176. }
  177. Error JSON::_get_token(const char32_t *p_str, int &index, int p_len, Token &r_token, int &line, String &r_err_str) {
  178. while (p_len > 0) {
  179. switch (p_str[index]) {
  180. case '\n': {
  181. line++;
  182. index++;
  183. break;
  184. }
  185. case 0: {
  186. r_token.type = TK_EOF;
  187. return OK;
  188. } break;
  189. case '{': {
  190. r_token.type = TK_CURLY_BRACKET_OPEN;
  191. index++;
  192. return OK;
  193. }
  194. case '}': {
  195. r_token.type = TK_CURLY_BRACKET_CLOSE;
  196. index++;
  197. return OK;
  198. }
  199. case '[': {
  200. r_token.type = TK_BRACKET_OPEN;
  201. index++;
  202. return OK;
  203. }
  204. case ']': {
  205. r_token.type = TK_BRACKET_CLOSE;
  206. index++;
  207. return OK;
  208. }
  209. case ':': {
  210. r_token.type = TK_COLON;
  211. index++;
  212. return OK;
  213. }
  214. case ',': {
  215. r_token.type = TK_COMMA;
  216. index++;
  217. return OK;
  218. }
  219. case '"': {
  220. index++;
  221. String str;
  222. while (true) {
  223. if (p_str[index] == 0) {
  224. r_err_str = "Unterminated string";
  225. return ERR_PARSE_ERROR;
  226. } else if (p_str[index] == '"') {
  227. index++;
  228. break;
  229. } else if (p_str[index] == '\\') {
  230. //escaped characters...
  231. index++;
  232. char32_t next = p_str[index];
  233. if (next == 0) {
  234. r_err_str = "Unterminated string";
  235. return ERR_PARSE_ERROR;
  236. }
  237. char32_t res = 0;
  238. switch (next) {
  239. case 'b':
  240. res = 8;
  241. break;
  242. case 't':
  243. res = 9;
  244. break;
  245. case 'n':
  246. res = 10;
  247. break;
  248. case 'f':
  249. res = 12;
  250. break;
  251. case 'r':
  252. res = 13;
  253. break;
  254. case 'u': {
  255. // hex number
  256. for (int j = 0; j < 4; j++) {
  257. char32_t c = p_str[index + j + 1];
  258. if (c == 0) {
  259. r_err_str = "Unterminated string";
  260. return ERR_PARSE_ERROR;
  261. }
  262. if (!is_hex_digit(c)) {
  263. r_err_str = "Malformed hex constant in string";
  264. return ERR_PARSE_ERROR;
  265. }
  266. char32_t v;
  267. if (is_digit(c)) {
  268. v = c - '0';
  269. } else if (c >= 'a' && c <= 'f') {
  270. v = c - 'a';
  271. v += 10;
  272. } else if (c >= 'A' && c <= 'F') {
  273. v = c - 'A';
  274. v += 10;
  275. } else {
  276. ERR_PRINT("Bug parsing hex constant.");
  277. v = 0;
  278. }
  279. res <<= 4;
  280. res |= v;
  281. }
  282. index += 4; //will add at the end anyway
  283. if ((res & 0xfffffc00) == 0xd800) {
  284. if (p_str[index + 1] != '\\' || p_str[index + 2] != 'u') {
  285. r_err_str = "Invalid UTF-16 sequence in string, unpaired lead surrogate";
  286. return ERR_PARSE_ERROR;
  287. }
  288. index += 2;
  289. char32_t trail = 0;
  290. for (int j = 0; j < 4; j++) {
  291. char32_t c = p_str[index + j + 1];
  292. if (c == 0) {
  293. r_err_str = "Unterminated string";
  294. return ERR_PARSE_ERROR;
  295. }
  296. if (!is_hex_digit(c)) {
  297. r_err_str = "Malformed hex constant in string";
  298. return ERR_PARSE_ERROR;
  299. }
  300. char32_t v;
  301. if (is_digit(c)) {
  302. v = c - '0';
  303. } else if (c >= 'a' && c <= 'f') {
  304. v = c - 'a';
  305. v += 10;
  306. } else if (c >= 'A' && c <= 'F') {
  307. v = c - 'A';
  308. v += 10;
  309. } else {
  310. ERR_PRINT("Bug parsing hex constant.");
  311. v = 0;
  312. }
  313. trail <<= 4;
  314. trail |= v;
  315. }
  316. if ((trail & 0xfffffc00) == 0xdc00) {
  317. res = (res << 10UL) + trail - ((0xd800 << 10UL) + 0xdc00 - 0x10000);
  318. index += 4; //will add at the end anyway
  319. } else {
  320. r_err_str = "Invalid UTF-16 sequence in string, unpaired lead surrogate";
  321. return ERR_PARSE_ERROR;
  322. }
  323. } else if ((res & 0xfffffc00) == 0xdc00) {
  324. r_err_str = "Invalid UTF-16 sequence in string, unpaired trail surrogate";
  325. return ERR_PARSE_ERROR;
  326. }
  327. } break;
  328. case '"':
  329. case '\\':
  330. case '/': {
  331. res = next;
  332. } break;
  333. default: {
  334. r_err_str = "Invalid escape sequence";
  335. return ERR_PARSE_ERROR;
  336. }
  337. }
  338. str += res;
  339. } else {
  340. if (p_str[index] == '\n') {
  341. line++;
  342. }
  343. str += p_str[index];
  344. }
  345. index++;
  346. }
  347. r_token.type = TK_STRING;
  348. r_token.value = str;
  349. return OK;
  350. } break;
  351. default: {
  352. if (p_str[index] <= 32) {
  353. index++;
  354. break;
  355. }
  356. if (p_str[index] == '-' || is_digit(p_str[index])) {
  357. //a number
  358. const char32_t *rptr;
  359. double number = String::to_float(&p_str[index], &rptr);
  360. index += (rptr - &p_str[index]);
  361. r_token.type = TK_NUMBER;
  362. r_token.value = number;
  363. return OK;
  364. } else if (is_ascii_alphabet_char(p_str[index])) {
  365. String id;
  366. while (is_ascii_alphabet_char(p_str[index])) {
  367. id += p_str[index];
  368. index++;
  369. }
  370. r_token.type = TK_IDENTIFIER;
  371. r_token.value = id;
  372. return OK;
  373. } else {
  374. r_err_str = "Unexpected character";
  375. return ERR_PARSE_ERROR;
  376. }
  377. }
  378. }
  379. }
  380. r_err_str = "Unknown error getting token";
  381. return ERR_PARSE_ERROR;
  382. }
  383. Error JSON::_parse_value(Variant &value, Token &token, const char32_t *p_str, int &index, int p_len, int &line, int p_depth, String &r_err_str) {
  384. if (p_depth > Variant::MAX_RECURSION_DEPTH) {
  385. r_err_str = "JSON structure is too deep";
  386. return ERR_OUT_OF_MEMORY;
  387. }
  388. if (token.type == TK_CURLY_BRACKET_OPEN) {
  389. Dictionary d;
  390. Error err = _parse_object(d, p_str, index, p_len, line, p_depth + 1, r_err_str);
  391. if (err) {
  392. return err;
  393. }
  394. value = d;
  395. } else if (token.type == TK_BRACKET_OPEN) {
  396. Array a;
  397. Error err = _parse_array(a, p_str, index, p_len, line, p_depth + 1, r_err_str);
  398. if (err) {
  399. return err;
  400. }
  401. value = a;
  402. } else if (token.type == TK_IDENTIFIER) {
  403. String id = token.value;
  404. if (id == "true") {
  405. value = true;
  406. } else if (id == "false") {
  407. value = false;
  408. } else if (id == "null") {
  409. value = Variant();
  410. } else {
  411. r_err_str = vformat("Expected 'true', 'false', or 'null', got '%s'", id);
  412. return ERR_PARSE_ERROR;
  413. }
  414. } else if (token.type == TK_NUMBER) {
  415. value = token.value;
  416. } else if (token.type == TK_STRING) {
  417. value = token.value;
  418. } else {
  419. r_err_str = vformat("Expected value, got '%s'", String(tk_name[token.type]));
  420. return ERR_PARSE_ERROR;
  421. }
  422. return OK;
  423. }
  424. Error JSON::_parse_array(Array &array, const char32_t *p_str, int &index, int p_len, int &line, int p_depth, String &r_err_str) {
  425. Token token;
  426. bool need_comma = false;
  427. while (index < p_len) {
  428. Error err = _get_token(p_str, index, p_len, token, line, r_err_str);
  429. if (err != OK) {
  430. return err;
  431. }
  432. if (token.type == TK_BRACKET_CLOSE) {
  433. return OK;
  434. }
  435. if (need_comma) {
  436. if (token.type != TK_COMMA) {
  437. r_err_str = "Expected ','";
  438. return ERR_PARSE_ERROR;
  439. } else {
  440. need_comma = false;
  441. continue;
  442. }
  443. }
  444. Variant v;
  445. err = _parse_value(v, token, p_str, index, p_len, line, p_depth, r_err_str);
  446. if (err) {
  447. return err;
  448. }
  449. array.push_back(v);
  450. need_comma = true;
  451. }
  452. r_err_str = "Expected ']'";
  453. return ERR_PARSE_ERROR;
  454. }
  455. Error JSON::_parse_object(Dictionary &object, const char32_t *p_str, int &index, int p_len, int &line, int p_depth, String &r_err_str) {
  456. bool at_key = true;
  457. String key;
  458. Token token;
  459. bool need_comma = false;
  460. while (index < p_len) {
  461. if (at_key) {
  462. Error err = _get_token(p_str, index, p_len, token, line, r_err_str);
  463. if (err != OK) {
  464. return err;
  465. }
  466. if (token.type == TK_CURLY_BRACKET_CLOSE) {
  467. return OK;
  468. }
  469. if (need_comma) {
  470. if (token.type != TK_COMMA) {
  471. r_err_str = "Expected '}' or ','";
  472. return ERR_PARSE_ERROR;
  473. } else {
  474. need_comma = false;
  475. continue;
  476. }
  477. }
  478. if (token.type != TK_STRING) {
  479. r_err_str = "Expected key";
  480. return ERR_PARSE_ERROR;
  481. }
  482. key = token.value;
  483. err = _get_token(p_str, index, p_len, token, line, r_err_str);
  484. if (err != OK) {
  485. return err;
  486. }
  487. if (token.type != TK_COLON) {
  488. r_err_str = "Expected ':'";
  489. return ERR_PARSE_ERROR;
  490. }
  491. at_key = false;
  492. } else {
  493. Error err = _get_token(p_str, index, p_len, token, line, r_err_str);
  494. if (err != OK) {
  495. return err;
  496. }
  497. Variant v;
  498. err = _parse_value(v, token, p_str, index, p_len, line, p_depth, r_err_str);
  499. if (err) {
  500. return err;
  501. }
  502. object[key] = v;
  503. need_comma = true;
  504. at_key = true;
  505. }
  506. }
  507. r_err_str = "Expected '}'";
  508. return ERR_PARSE_ERROR;
  509. }
  510. void JSON::set_data(const Variant &p_data) {
  511. data = p_data;
  512. text.clear();
  513. }
  514. Error JSON::_parse_string(const String &p_json, Variant &r_ret, String &r_err_str, int &r_err_line) {
  515. const char32_t *str = p_json.ptr();
  516. int idx = 0;
  517. int len = p_json.length();
  518. Token token;
  519. r_err_line = 0;
  520. String aux_key;
  521. Error err = _get_token(str, idx, len, token, r_err_line, r_err_str);
  522. if (err) {
  523. return err;
  524. }
  525. err = _parse_value(r_ret, token, str, idx, len, r_err_line, 0, r_err_str);
  526. // Check if EOF is reached
  527. // or it's a type of the next token.
  528. if (err == OK && idx < len) {
  529. err = _get_token(str, idx, len, token, r_err_line, r_err_str);
  530. if (err || token.type != TK_EOF) {
  531. r_err_str = "Expected 'EOF'";
  532. // Reset return value to empty `Variant`
  533. r_ret = Variant();
  534. return ERR_PARSE_ERROR;
  535. }
  536. }
  537. return err;
  538. }
  539. Error JSON::parse(const String &p_json_string, bool p_keep_text) {
  540. Error err = _parse_string(p_json_string, data, err_str, err_line);
  541. if (err == Error::OK) {
  542. err_line = 0;
  543. }
  544. if (p_keep_text) {
  545. text = p_json_string;
  546. }
  547. return err;
  548. }
  549. String JSON::get_parsed_text() const {
  550. return text;
  551. }
  552. String JSON::stringify(const Variant &p_var, const String &p_indent, bool p_sort_keys, bool p_full_precision) {
  553. String result;
  554. HashSet<const void *> markers;
  555. _stringify(result, p_var, p_indent, 0, p_sort_keys, markers, p_full_precision);
  556. return result;
  557. }
  558. Variant JSON::parse_string(const String &p_json_string) {
  559. Ref<JSON> json;
  560. json.instantiate();
  561. Error error = json->parse(p_json_string);
  562. ERR_FAIL_COND_V_MSG(error != Error::OK, Variant(), vformat("Parse JSON failed. Error at line %d: %s", json->get_error_line(), json->get_error_message()));
  563. return json->get_data();
  564. }
  565. void JSON::_bind_methods() {
  566. ClassDB::bind_static_method("JSON", D_METHOD("stringify", "data", "indent", "sort_keys", "full_precision"), &JSON::stringify, DEFVAL(""), DEFVAL(true), DEFVAL(false));
  567. ClassDB::bind_static_method("JSON", D_METHOD("parse_string", "json_string"), &JSON::parse_string);
  568. ClassDB::bind_method(D_METHOD("parse", "json_text", "keep_text"), &JSON::parse, DEFVAL(false));
  569. ClassDB::bind_method(D_METHOD("get_data"), &JSON::get_data);
  570. ClassDB::bind_method(D_METHOD("set_data", "data"), &JSON::set_data);
  571. ClassDB::bind_method(D_METHOD("get_parsed_text"), &JSON::get_parsed_text);
  572. ClassDB::bind_method(D_METHOD("get_error_line"), &JSON::get_error_line);
  573. ClassDB::bind_method(D_METHOD("get_error_message"), &JSON::get_error_message);
  574. ClassDB::bind_static_method("JSON", D_METHOD("from_native", "variant", "full_objects"), &JSON::from_native, DEFVAL(false));
  575. ClassDB::bind_static_method("JSON", D_METHOD("to_native", "json", "allow_objects"), &JSON::to_native, DEFVAL(false));
  576. ADD_PROPERTY(PropertyInfo(Variant::NIL, "data", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_NIL_IS_VARIANT), "set_data", "get_data"); // Ensures that it can be serialized as binary.
  577. }
  578. #define TYPE "type"
  579. #define ELEM_TYPE "elem_type"
  580. #define KEY_TYPE "key_type"
  581. #define VALUE_TYPE "value_type"
  582. #define ARGS "args"
  583. #define PROPS "props"
  584. static bool _encode_container_type(Dictionary &r_dict, const String &p_key, const ContainerType &p_type, bool p_full_objects) {
  585. if (p_type.builtin_type != Variant::NIL) {
  586. if (p_type.script.is_valid()) {
  587. ERR_FAIL_COND_V(!p_full_objects, false);
  588. const String path = p_type.script->get_path();
  589. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://"), false, "Failed to encode a path to a custom script for a container type.");
  590. r_dict[p_key] = path;
  591. } else if (p_type.class_name != StringName()) {
  592. ERR_FAIL_COND_V(!p_full_objects, false);
  593. r_dict[p_key] = String(p_type.class_name);
  594. } else {
  595. // No need to check `p_full_objects` since `class_name` should be non-empty for `builtin_type == Variant::OBJECT`.
  596. r_dict[p_key] = Variant::get_type_name(p_type.builtin_type);
  597. }
  598. }
  599. return true;
  600. }
  601. Variant JSON::_from_native(const Variant &p_variant, bool p_full_objects, int p_depth) {
  602. #define RETURN_ARGS \
  603. Dictionary ret; \
  604. ret[TYPE] = Variant::get_type_name(p_variant.get_type()); \
  605. ret[ARGS] = args; \
  606. return ret
  607. switch (p_variant.get_type()) {
  608. case Variant::NIL:
  609. case Variant::BOOL: {
  610. return p_variant;
  611. } break;
  612. case Variant::INT: {
  613. return "i:" + String(p_variant);
  614. } break;
  615. case Variant::FLOAT: {
  616. return "f:" + String(p_variant);
  617. } break;
  618. case Variant::STRING: {
  619. return "s:" + String(p_variant);
  620. } break;
  621. case Variant::STRING_NAME: {
  622. return "sn:" + String(p_variant);
  623. } break;
  624. case Variant::NODE_PATH: {
  625. return "np:" + String(p_variant);
  626. } break;
  627. case Variant::RID:
  628. case Variant::CALLABLE:
  629. case Variant::SIGNAL: {
  630. Dictionary ret;
  631. ret[TYPE] = Variant::get_type_name(p_variant.get_type());
  632. return ret;
  633. } break;
  634. case Variant::VECTOR2: {
  635. const Vector2 v = p_variant;
  636. Array args = { v.x, v.y };
  637. RETURN_ARGS;
  638. } break;
  639. case Variant::VECTOR2I: {
  640. const Vector2i v = p_variant;
  641. Array args = { v.x, v.y };
  642. RETURN_ARGS;
  643. } break;
  644. case Variant::RECT2: {
  645. const Rect2 r = p_variant;
  646. Array args = { r.position.x, r.position.y, r.size.width, r.size.height };
  647. RETURN_ARGS;
  648. } break;
  649. case Variant::RECT2I: {
  650. const Rect2i r = p_variant;
  651. Array args = { r.position.x, r.position.y, r.size.width, r.size.height };
  652. RETURN_ARGS;
  653. } break;
  654. case Variant::VECTOR3: {
  655. const Vector3 v = p_variant;
  656. Array args = { v.x, v.y, v.z };
  657. RETURN_ARGS;
  658. } break;
  659. case Variant::VECTOR3I: {
  660. const Vector3i v = p_variant;
  661. Array args = { v.x, v.y, v.z };
  662. RETURN_ARGS;
  663. } break;
  664. case Variant::TRANSFORM2D: {
  665. const Transform2D t = p_variant;
  666. Array args = { t[0].x, t[0].y, t[1].x, t[1].y, t[2].x, t[2].y };
  667. RETURN_ARGS;
  668. } break;
  669. case Variant::VECTOR4: {
  670. const Vector4 v = p_variant;
  671. Array args = { v.x, v.y, v.z, v.w };
  672. RETURN_ARGS;
  673. } break;
  674. case Variant::VECTOR4I: {
  675. const Vector4i v = p_variant;
  676. Array args = { v.x, v.y, v.z, v.w };
  677. RETURN_ARGS;
  678. } break;
  679. case Variant::PLANE: {
  680. const Plane p = p_variant;
  681. Array args = { p.normal.x, p.normal.y, p.normal.z, p.d };
  682. RETURN_ARGS;
  683. } break;
  684. case Variant::QUATERNION: {
  685. const Quaternion q = p_variant;
  686. Array args = { q.x, q.y, q.z, q.w };
  687. RETURN_ARGS;
  688. } break;
  689. case Variant::AABB: {
  690. const AABB aabb = p_variant;
  691. Array args = { aabb.position.x, aabb.position.y, aabb.position.z, aabb.size.x, aabb.size.y, aabb.size.z };
  692. RETURN_ARGS;
  693. } break;
  694. case Variant::BASIS: {
  695. const Basis b = p_variant;
  696. Array args = { b.get_column(0).x, b.get_column(0).y, b.get_column(0).z,
  697. b.get_column(1).x, b.get_column(1).y, b.get_column(1).z,
  698. b.get_column(2).x, b.get_column(2).y, b.get_column(2).z };
  699. RETURN_ARGS;
  700. } break;
  701. case Variant::TRANSFORM3D: {
  702. const Transform3D t = p_variant;
  703. Array args = { t.basis.get_column(0).x, t.basis.get_column(0).y, t.basis.get_column(0).z,
  704. t.basis.get_column(1).x, t.basis.get_column(1).y, t.basis.get_column(1).z,
  705. t.basis.get_column(2).x, t.basis.get_column(2).y, t.basis.get_column(2).z,
  706. t.origin.x, t.origin.y, t.origin.z };
  707. RETURN_ARGS;
  708. } break;
  709. case Variant::PROJECTION: {
  710. const Projection p = p_variant;
  711. Array args = { p[0].x, p[0].y, p[0].z, p[0].w,
  712. p[1].x, p[1].y, p[1].z, p[1].w,
  713. p[2].x, p[2].y, p[2].z, p[2].w,
  714. p[3].x, p[3].y, p[3].z, p[3].w };
  715. RETURN_ARGS;
  716. } break;
  717. case Variant::COLOR: {
  718. const Color c = p_variant;
  719. Array args = { c.r, c.g, c.b, c.a };
  720. RETURN_ARGS;
  721. } break;
  722. case Variant::OBJECT: {
  723. ERR_FAIL_COND_V(!p_full_objects, Variant());
  724. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, Variant(), "Variant is too deep. Bailing.");
  725. const Object *obj = p_variant.get_validated_object();
  726. if (obj == nullptr) {
  727. return Variant();
  728. }
  729. ERR_FAIL_COND_V(!ClassDB::can_instantiate(obj->get_class()), Variant());
  730. List<PropertyInfo> prop_list;
  731. obj->get_property_list(&prop_list);
  732. Array props;
  733. for (const PropertyInfo &pi : prop_list) {
  734. if (!(pi.usage & PROPERTY_USAGE_STORAGE)) {
  735. continue;
  736. }
  737. Variant value;
  738. if (pi.name == CoreStringName(script)) {
  739. const Ref<Script> script = obj->get_script();
  740. if (script.is_valid()) {
  741. const String path = script->get_path();
  742. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://"), Variant(), "Failed to encode a path to a custom script.");
  743. value = path;
  744. }
  745. } else {
  746. value = obj->get(pi.name);
  747. }
  748. props.push_back(pi.name);
  749. props.push_back(_from_native(value, p_full_objects, p_depth + 1));
  750. }
  751. Dictionary ret;
  752. ret[TYPE] = obj->get_class();
  753. ret[PROPS] = props;
  754. return ret;
  755. } break;
  756. case Variant::DICTIONARY: {
  757. const Dictionary dict = p_variant;
  758. Array args;
  759. Dictionary ret;
  760. ret[TYPE] = Variant::get_type_name(p_variant.get_type());
  761. if (!_encode_container_type(ret, KEY_TYPE, dict.get_key_type(), p_full_objects)) {
  762. return Variant();
  763. }
  764. if (!_encode_container_type(ret, VALUE_TYPE, dict.get_value_type(), p_full_objects)) {
  765. return Variant();
  766. }
  767. ret[ARGS] = args;
  768. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  769. for (const KeyValue<Variant, Variant> &kv : dict) {
  770. args.push_back(_from_native(kv.key, p_full_objects, p_depth + 1));
  771. args.push_back(_from_native(kv.value, p_full_objects, p_depth + 1));
  772. }
  773. return ret;
  774. } break;
  775. case Variant::ARRAY: {
  776. const Array arr = p_variant;
  777. Variant ret;
  778. Array args;
  779. if (arr.is_typed()) {
  780. Dictionary d;
  781. d[TYPE] = Variant::get_type_name(p_variant.get_type());
  782. if (!_encode_container_type(d, ELEM_TYPE, arr.get_element_type(), p_full_objects)) {
  783. return Variant();
  784. }
  785. d[ARGS] = args;
  786. ret = d;
  787. } else {
  788. ret = args;
  789. }
  790. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  791. for (int i = 0; i < arr.size(); i++) {
  792. args.push_back(_from_native(arr[i], p_full_objects, p_depth + 1));
  793. }
  794. return ret;
  795. } break;
  796. case Variant::PACKED_BYTE_ARRAY: {
  797. const PackedByteArray arr = p_variant;
  798. Array args;
  799. for (int i = 0; i < arr.size(); i++) {
  800. args.push_back(arr[i]);
  801. }
  802. RETURN_ARGS;
  803. } break;
  804. case Variant::PACKED_INT32_ARRAY: {
  805. const PackedInt32Array arr = p_variant;
  806. Array args;
  807. for (int i = 0; i < arr.size(); i++) {
  808. args.push_back(arr[i]);
  809. }
  810. RETURN_ARGS;
  811. } break;
  812. case Variant::PACKED_INT64_ARRAY: {
  813. const PackedInt64Array arr = p_variant;
  814. Array args;
  815. for (int i = 0; i < arr.size(); i++) {
  816. args.push_back(arr[i]);
  817. }
  818. RETURN_ARGS;
  819. } break;
  820. case Variant::PACKED_FLOAT32_ARRAY: {
  821. const PackedFloat32Array arr = p_variant;
  822. Array args;
  823. for (int i = 0; i < arr.size(); i++) {
  824. args.push_back(arr[i]);
  825. }
  826. RETURN_ARGS;
  827. } break;
  828. case Variant::PACKED_FLOAT64_ARRAY: {
  829. const PackedFloat64Array arr = p_variant;
  830. Array args;
  831. for (int i = 0; i < arr.size(); i++) {
  832. args.push_back(arr[i]);
  833. }
  834. RETURN_ARGS;
  835. } break;
  836. case Variant::PACKED_STRING_ARRAY: {
  837. const PackedStringArray arr = p_variant;
  838. Array args;
  839. for (int i = 0; i < arr.size(); i++) {
  840. args.push_back(arr[i]);
  841. }
  842. RETURN_ARGS;
  843. } break;
  844. case Variant::PACKED_VECTOR2_ARRAY: {
  845. const PackedVector2Array arr = p_variant;
  846. Array args;
  847. for (int i = 0; i < arr.size(); i++) {
  848. Vector2 v = arr[i];
  849. args.push_back(v.x);
  850. args.push_back(v.y);
  851. }
  852. RETURN_ARGS;
  853. } break;
  854. case Variant::PACKED_VECTOR3_ARRAY: {
  855. const PackedVector3Array arr = p_variant;
  856. Array args;
  857. for (int i = 0; i < arr.size(); i++) {
  858. Vector3 v = arr[i];
  859. args.push_back(v.x);
  860. args.push_back(v.y);
  861. args.push_back(v.z);
  862. }
  863. RETURN_ARGS;
  864. } break;
  865. case Variant::PACKED_COLOR_ARRAY: {
  866. const PackedColorArray arr = p_variant;
  867. Array args;
  868. for (int i = 0; i < arr.size(); i++) {
  869. Color v = arr[i];
  870. args.push_back(v.r);
  871. args.push_back(v.g);
  872. args.push_back(v.b);
  873. args.push_back(v.a);
  874. }
  875. RETURN_ARGS;
  876. } break;
  877. case Variant::PACKED_VECTOR4_ARRAY: {
  878. const PackedVector4Array arr = p_variant;
  879. Array args;
  880. for (int i = 0; i < arr.size(); i++) {
  881. Vector4 v = arr[i];
  882. args.push_back(v.x);
  883. args.push_back(v.y);
  884. args.push_back(v.z);
  885. args.push_back(v.w);
  886. }
  887. RETURN_ARGS;
  888. } break;
  889. case Variant::VARIANT_MAX: {
  890. // Nothing to do.
  891. } break;
  892. }
  893. #undef RETURN_ARGS
  894. ERR_FAIL_V_MSG(Variant(), vformat(R"(Unhandled Variant type "%s".)", Variant::get_type_name(p_variant.get_type())));
  895. }
  896. static bool _decode_container_type(const Dictionary &p_dict, const String &p_key, ContainerType &r_type, bool p_allow_objects) {
  897. if (!p_dict.has(p_key)) {
  898. return true;
  899. }
  900. const String type_name = p_dict[p_key];
  901. const Variant::Type builtin_type = Variant::get_type_by_name(type_name);
  902. if (builtin_type < Variant::VARIANT_MAX && builtin_type != Variant::OBJECT) {
  903. r_type.builtin_type = builtin_type;
  904. return true;
  905. }
  906. if (ClassDB::class_exists(type_name)) {
  907. ERR_FAIL_COND_V(!p_allow_objects, false);
  908. r_type.builtin_type = Variant::OBJECT;
  909. r_type.class_name = type_name;
  910. return true;
  911. }
  912. if (type_name.begins_with("res://")) {
  913. ERR_FAIL_COND_V(!p_allow_objects, false);
  914. ERR_FAIL_COND_V_MSG(!ResourceLoader::exists(type_name, "Script"), false, vformat(R"(Invalid script path "%s".)", type_name));
  915. const Ref<Script> script = ResourceLoader::load(type_name, "Script");
  916. ERR_FAIL_COND_V_MSG(script.is_null(), false, vformat(R"(Can't load script at path "%s".)", type_name));
  917. r_type.builtin_type = Variant::OBJECT;
  918. r_type.class_name = script->get_instance_base_type();
  919. r_type.script = script;
  920. return true;
  921. }
  922. ERR_FAIL_V_MSG(false, vformat(R"(Invalid type "%s".)", type_name));
  923. }
  924. Variant JSON::_to_native(const Variant &p_json, bool p_allow_objects, int p_depth) {
  925. switch (p_json.get_type()) {
  926. case Variant::NIL:
  927. case Variant::BOOL: {
  928. return p_json;
  929. } break;
  930. case Variant::STRING: {
  931. const String s = p_json;
  932. if (s.begins_with("i:")) {
  933. return s.substr(2).to_int();
  934. } else if (s.begins_with("f:")) {
  935. const String sub = s.substr(2);
  936. if (sub == "inf") {
  937. return Math::INF;
  938. } else if (sub == "-inf") {
  939. return -Math::INF;
  940. } else if (sub == "nan") {
  941. return Math::NaN;
  942. }
  943. return sub.to_float();
  944. } else if (s.begins_with("s:")) {
  945. return s.substr(2);
  946. } else if (s.begins_with("sn:")) {
  947. return StringName(s.substr(3));
  948. } else if (s.begins_with("np:")) {
  949. return NodePath(s.substr(3));
  950. }
  951. ERR_FAIL_V_MSG(Variant(), "Invalid string, the type prefix is not recognized.");
  952. } break;
  953. case Variant::DICTIONARY: {
  954. const Dictionary dict = p_json;
  955. ERR_FAIL_COND_V(!dict.has(TYPE), Variant());
  956. #define LOAD_ARGS() \
  957. ERR_FAIL_COND_V(!dict.has(ARGS), Variant()); \
  958. const Array args = dict[ARGS]
  959. #define LOAD_ARGS_CHECK_SIZE(m_size) \
  960. ERR_FAIL_COND_V(!dict.has(ARGS), Variant()); \
  961. const Array args = dict[ARGS]; \
  962. ERR_FAIL_COND_V(args.size() != (m_size), Variant())
  963. #define LOAD_ARGS_CHECK_FACTOR(m_factor) \
  964. ERR_FAIL_COND_V(!dict.has(ARGS), Variant()); \
  965. const Array args = dict[ARGS]; \
  966. ERR_FAIL_COND_V(args.size() % (m_factor) != 0, Variant())
  967. switch (Variant::get_type_by_name(dict[TYPE])) {
  968. case Variant::NIL:
  969. case Variant::BOOL: {
  970. ERR_FAIL_V_MSG(Variant(), vformat(R"(Unexpected "%s": Variant type "%s" is JSON-compliant.)", TYPE, dict[TYPE]));
  971. } break;
  972. case Variant::INT:
  973. case Variant::FLOAT:
  974. case Variant::STRING:
  975. case Variant::STRING_NAME:
  976. case Variant::NODE_PATH: {
  977. ERR_FAIL_V_MSG(Variant(), vformat(R"(Unexpected "%s": Variant type "%s" must be represented as a string.)", TYPE, dict[TYPE]));
  978. } break;
  979. case Variant::RID: {
  980. return RID();
  981. } break;
  982. case Variant::CALLABLE: {
  983. return Callable();
  984. } break;
  985. case Variant::SIGNAL: {
  986. return Signal();
  987. } break;
  988. case Variant::VECTOR2: {
  989. LOAD_ARGS_CHECK_SIZE(2);
  990. Vector2 v;
  991. v.x = args[0];
  992. v.y = args[1];
  993. return v;
  994. } break;
  995. case Variant::VECTOR2I: {
  996. LOAD_ARGS_CHECK_SIZE(2);
  997. Vector2i v;
  998. v.x = args[0];
  999. v.y = args[1];
  1000. return v;
  1001. } break;
  1002. case Variant::RECT2: {
  1003. LOAD_ARGS_CHECK_SIZE(4);
  1004. Rect2 r;
  1005. r.position = Point2(args[0], args[1]);
  1006. r.size = Size2(args[2], args[3]);
  1007. return r;
  1008. } break;
  1009. case Variant::RECT2I: {
  1010. LOAD_ARGS_CHECK_SIZE(4);
  1011. Rect2i r;
  1012. r.position = Point2i(args[0], args[1]);
  1013. r.size = Size2i(args[2], args[3]);
  1014. return r;
  1015. } break;
  1016. case Variant::VECTOR3: {
  1017. LOAD_ARGS_CHECK_SIZE(3);
  1018. Vector3 v;
  1019. v.x = args[0];
  1020. v.y = args[1];
  1021. v.z = args[2];
  1022. return v;
  1023. } break;
  1024. case Variant::VECTOR3I: {
  1025. LOAD_ARGS_CHECK_SIZE(3);
  1026. Vector3i v;
  1027. v.x = args[0];
  1028. v.y = args[1];
  1029. v.z = args[2];
  1030. return v;
  1031. } break;
  1032. case Variant::TRANSFORM2D: {
  1033. LOAD_ARGS_CHECK_SIZE(6);
  1034. Transform2D t;
  1035. t[0] = Vector2(args[0], args[1]);
  1036. t[1] = Vector2(args[2], args[3]);
  1037. t[2] = Vector2(args[4], args[5]);
  1038. return t;
  1039. } break;
  1040. case Variant::VECTOR4: {
  1041. LOAD_ARGS_CHECK_SIZE(4);
  1042. Vector4 v;
  1043. v.x = args[0];
  1044. v.y = args[1];
  1045. v.z = args[2];
  1046. v.w = args[3];
  1047. return v;
  1048. } break;
  1049. case Variant::VECTOR4I: {
  1050. LOAD_ARGS_CHECK_SIZE(4);
  1051. Vector4i v;
  1052. v.x = args[0];
  1053. v.y = args[1];
  1054. v.z = args[2];
  1055. v.w = args[3];
  1056. return v;
  1057. } break;
  1058. case Variant::PLANE: {
  1059. LOAD_ARGS_CHECK_SIZE(4);
  1060. Plane p;
  1061. p.normal = Vector3(args[0], args[1], args[2]);
  1062. p.d = args[3];
  1063. return p;
  1064. } break;
  1065. case Variant::QUATERNION: {
  1066. LOAD_ARGS_CHECK_SIZE(4);
  1067. Quaternion q;
  1068. q.x = args[0];
  1069. q.y = args[1];
  1070. q.z = args[2];
  1071. q.w = args[3];
  1072. return q;
  1073. } break;
  1074. case Variant::AABB: {
  1075. LOAD_ARGS_CHECK_SIZE(6);
  1076. AABB aabb;
  1077. aabb.position = Vector3(args[0], args[1], args[2]);
  1078. aabb.size = Vector3(args[3], args[4], args[5]);
  1079. return aabb;
  1080. } break;
  1081. case Variant::BASIS: {
  1082. LOAD_ARGS_CHECK_SIZE(9);
  1083. Basis b;
  1084. b.set_column(0, Vector3(args[0], args[1], args[2]));
  1085. b.set_column(1, Vector3(args[3], args[4], args[5]));
  1086. b.set_column(2, Vector3(args[6], args[7], args[8]));
  1087. return b;
  1088. } break;
  1089. case Variant::TRANSFORM3D: {
  1090. LOAD_ARGS_CHECK_SIZE(12);
  1091. Transform3D t;
  1092. t.basis.set_column(0, Vector3(args[0], args[1], args[2]));
  1093. t.basis.set_column(1, Vector3(args[3], args[4], args[5]));
  1094. t.basis.set_column(2, Vector3(args[6], args[7], args[8]));
  1095. t.origin = Vector3(args[9], args[10], args[11]);
  1096. return t;
  1097. } break;
  1098. case Variant::PROJECTION: {
  1099. LOAD_ARGS_CHECK_SIZE(16);
  1100. Projection p;
  1101. p[0] = Vector4(args[0], args[1], args[2], args[3]);
  1102. p[1] = Vector4(args[4], args[5], args[6], args[7]);
  1103. p[2] = Vector4(args[8], args[9], args[10], args[11]);
  1104. p[3] = Vector4(args[12], args[13], args[14], args[15]);
  1105. return p;
  1106. } break;
  1107. case Variant::COLOR: {
  1108. LOAD_ARGS_CHECK_SIZE(4);
  1109. Color c;
  1110. c.r = args[0];
  1111. c.g = args[1];
  1112. c.b = args[2];
  1113. c.a = args[3];
  1114. return c;
  1115. } break;
  1116. case Variant::OBJECT: {
  1117. // Nothing to do at this stage. `Object` should be treated as a class, not as a built-in type.
  1118. } break;
  1119. case Variant::DICTIONARY: {
  1120. LOAD_ARGS_CHECK_FACTOR(2);
  1121. ContainerType key_type;
  1122. if (!_decode_container_type(dict, KEY_TYPE, key_type, p_allow_objects)) {
  1123. return Variant();
  1124. }
  1125. ContainerType value_type;
  1126. if (!_decode_container_type(dict, VALUE_TYPE, value_type, p_allow_objects)) {
  1127. return Variant();
  1128. }
  1129. Dictionary ret;
  1130. if (key_type.builtin_type != Variant::NIL || value_type.builtin_type != Variant::NIL) {
  1131. ret.set_typed(key_type, value_type);
  1132. }
  1133. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  1134. for (int i = 0; i < args.size() / 2; i++) {
  1135. ret[_to_native(args[i * 2 + 0], p_allow_objects, p_depth + 1)] = _to_native(args[i * 2 + 1], p_allow_objects, p_depth + 1);
  1136. }
  1137. return ret;
  1138. } break;
  1139. case Variant::ARRAY: {
  1140. LOAD_ARGS();
  1141. ContainerType elem_type;
  1142. if (!_decode_container_type(dict, ELEM_TYPE, elem_type, p_allow_objects)) {
  1143. return Variant();
  1144. }
  1145. Array ret;
  1146. if (elem_type.builtin_type != Variant::NIL) {
  1147. ret.set_typed(elem_type);
  1148. }
  1149. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  1150. ret.resize(args.size());
  1151. for (int i = 0; i < args.size(); i++) {
  1152. ret[i] = _to_native(args[i], p_allow_objects, p_depth + 1);
  1153. }
  1154. return ret;
  1155. } break;
  1156. case Variant::PACKED_BYTE_ARRAY: {
  1157. LOAD_ARGS();
  1158. PackedByteArray arr;
  1159. arr.resize(args.size());
  1160. for (int i = 0; i < arr.size(); i++) {
  1161. arr.write[i] = args[i];
  1162. }
  1163. return arr;
  1164. } break;
  1165. case Variant::PACKED_INT32_ARRAY: {
  1166. LOAD_ARGS();
  1167. PackedInt32Array arr;
  1168. arr.resize(args.size());
  1169. for (int i = 0; i < arr.size(); i++) {
  1170. arr.write[i] = args[i];
  1171. }
  1172. return arr;
  1173. } break;
  1174. case Variant::PACKED_INT64_ARRAY: {
  1175. LOAD_ARGS();
  1176. PackedInt64Array arr;
  1177. arr.resize(args.size());
  1178. for (int i = 0; i < arr.size(); i++) {
  1179. arr.write[i] = args[i];
  1180. }
  1181. return arr;
  1182. } break;
  1183. case Variant::PACKED_FLOAT32_ARRAY: {
  1184. LOAD_ARGS();
  1185. PackedFloat32Array arr;
  1186. arr.resize(args.size());
  1187. for (int i = 0; i < arr.size(); i++) {
  1188. arr.write[i] = args[i];
  1189. }
  1190. return arr;
  1191. } break;
  1192. case Variant::PACKED_FLOAT64_ARRAY: {
  1193. LOAD_ARGS();
  1194. PackedFloat64Array arr;
  1195. arr.resize(args.size());
  1196. for (int i = 0; i < arr.size(); i++) {
  1197. arr.write[i] = args[i];
  1198. }
  1199. return arr;
  1200. } break;
  1201. case Variant::PACKED_STRING_ARRAY: {
  1202. LOAD_ARGS();
  1203. PackedStringArray arr;
  1204. arr.resize(args.size());
  1205. for (int i = 0; i < arr.size(); i++) {
  1206. arr.write[i] = args[i];
  1207. }
  1208. return arr;
  1209. } break;
  1210. case Variant::PACKED_VECTOR2_ARRAY: {
  1211. LOAD_ARGS_CHECK_FACTOR(2);
  1212. PackedVector2Array arr;
  1213. arr.resize(args.size() / 2);
  1214. for (int i = 0; i < arr.size(); i++) {
  1215. arr.write[i] = Vector2(args[i * 2 + 0], args[i * 2 + 1]);
  1216. }
  1217. return arr;
  1218. } break;
  1219. case Variant::PACKED_VECTOR3_ARRAY: {
  1220. LOAD_ARGS_CHECK_FACTOR(3);
  1221. PackedVector3Array arr;
  1222. arr.resize(args.size() / 3);
  1223. for (int i = 0; i < arr.size(); i++) {
  1224. arr.write[i] = Vector3(args[i * 3 + 0], args[i * 3 + 1], args[i * 3 + 2]);
  1225. }
  1226. return arr;
  1227. } break;
  1228. case Variant::PACKED_COLOR_ARRAY: {
  1229. LOAD_ARGS_CHECK_FACTOR(4);
  1230. PackedColorArray arr;
  1231. arr.resize(args.size() / 4);
  1232. for (int i = 0; i < arr.size(); i++) {
  1233. arr.write[i] = Color(args[i * 4 + 0], args[i * 4 + 1], args[i * 4 + 2], args[i * 4 + 3]);
  1234. }
  1235. return arr;
  1236. } break;
  1237. case Variant::PACKED_VECTOR4_ARRAY: {
  1238. LOAD_ARGS_CHECK_FACTOR(4);
  1239. PackedVector4Array arr;
  1240. arr.resize(args.size() / 4);
  1241. for (int i = 0; i < arr.size(); i++) {
  1242. arr.write[i] = Vector4(args[i * 4 + 0], args[i * 4 + 1], args[i * 4 + 2], args[i * 4 + 3]);
  1243. }
  1244. return arr;
  1245. } break;
  1246. case Variant::VARIANT_MAX: {
  1247. // Nothing to do.
  1248. } break;
  1249. }
  1250. #undef LOAD_ARGS
  1251. #undef LOAD_ARGS_CHECK_SIZE
  1252. #undef LOAD_ARGS_CHECK_FACTOR
  1253. if (ClassDB::class_exists(dict[TYPE])) {
  1254. ERR_FAIL_COND_V(!p_allow_objects, Variant());
  1255. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, Variant(), "Variant is too deep. Bailing.");
  1256. ERR_FAIL_COND_V(!dict.has(PROPS), Variant());
  1257. const Array props = dict[PROPS];
  1258. ERR_FAIL_COND_V(props.size() % 2 != 0, Variant());
  1259. ERR_FAIL_COND_V(!ClassDB::can_instantiate(dict[TYPE]), Variant());
  1260. Object *obj = ClassDB::instantiate(dict[TYPE]);
  1261. ERR_FAIL_NULL_V(obj, Variant());
  1262. // Avoid premature free `RefCounted`. This must be done before properties are initialized,
  1263. // since script functions (setters, implicit initializer) may be called. See GH-68666.
  1264. Variant variant;
  1265. if (Object::cast_to<RefCounted>(obj)) {
  1266. const Ref<RefCounted> ref = Ref<RefCounted>(Object::cast_to<RefCounted>(obj));
  1267. variant = ref;
  1268. } else {
  1269. variant = obj;
  1270. }
  1271. for (int i = 0; i < props.size() / 2; i++) {
  1272. const StringName name = props[i * 2 + 0];
  1273. const Variant value = _to_native(props[i * 2 + 1], p_allow_objects, p_depth + 1);
  1274. if (name == CoreStringName(script) && value.get_type() != Variant::NIL) {
  1275. const String path = value;
  1276. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://") || !ResourceLoader::exists(path, "Script"),
  1277. Variant(),
  1278. vformat(R"(Invalid script path "%s".)", path));
  1279. const Ref<Script> script = ResourceLoader::load(path, "Script");
  1280. ERR_FAIL_COND_V_MSG(script.is_null(), Variant(), vformat(R"(Can't load script at path "%s".)", path));
  1281. obj->set_script(script);
  1282. } else {
  1283. obj->set(name, value);
  1284. }
  1285. }
  1286. return variant;
  1287. }
  1288. ERR_FAIL_V_MSG(Variant(), vformat(R"(Invalid type "%s".)", dict[TYPE]));
  1289. } break;
  1290. case Variant::ARRAY: {
  1291. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, Array(), "Variant is too deep. Bailing.");
  1292. const Array arr = p_json;
  1293. Array ret;
  1294. ret.resize(arr.size());
  1295. for (int i = 0; i < arr.size(); i++) {
  1296. ret[i] = _to_native(arr[i], p_allow_objects, p_depth + 1);
  1297. }
  1298. return ret;
  1299. } break;
  1300. default: {
  1301. // Nothing to do.
  1302. } break;
  1303. }
  1304. ERR_FAIL_V_MSG(Variant(), vformat(R"(Variant type "%s" is not JSON-compliant.)", Variant::get_type_name(p_json.get_type())));
  1305. }
  1306. #undef TYPE
  1307. #undef ELEM_TYPE
  1308. #undef KEY_TYPE
  1309. #undef VALUE_TYPE
  1310. #undef ARGS
  1311. #undef PROPS
  1312. ////////////
  1313. Ref<Resource> ResourceFormatLoaderJSON::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
  1314. if (r_error) {
  1315. *r_error = ERR_FILE_CANT_OPEN;
  1316. }
  1317. if (!FileAccess::exists(p_path)) {
  1318. if (r_error) {
  1319. *r_error = ERR_FILE_NOT_FOUND;
  1320. }
  1321. return Ref<Resource>();
  1322. }
  1323. Ref<JSON> json;
  1324. json.instantiate();
  1325. Error err = json->parse(FileAccess::get_file_as_string(p_path), Engine::get_singleton()->is_editor_hint());
  1326. if (err != OK) {
  1327. String err_text = "Error parsing JSON file at '" + p_path + "', on line " + itos(json->get_error_line()) + ": " + json->get_error_message();
  1328. if (Engine::get_singleton()->is_editor_hint()) {
  1329. // If running on editor, still allow opening the JSON so the code editor can edit it.
  1330. WARN_PRINT(err_text);
  1331. } else {
  1332. if (r_error) {
  1333. *r_error = err;
  1334. }
  1335. ERR_PRINT(err_text);
  1336. return Ref<Resource>();
  1337. }
  1338. }
  1339. if (r_error) {
  1340. *r_error = OK;
  1341. }
  1342. return json;
  1343. }
  1344. void ResourceFormatLoaderJSON::get_recognized_extensions(List<String> *p_extensions) const {
  1345. p_extensions->push_back("json");
  1346. }
  1347. bool ResourceFormatLoaderJSON::handles_type(const String &p_type) const {
  1348. return (p_type == "JSON");
  1349. }
  1350. String ResourceFormatLoaderJSON::get_resource_type(const String &p_path) const {
  1351. if (p_path.has_extension("json")) {
  1352. return "JSON";
  1353. }
  1354. return "";
  1355. }
  1356. Error ResourceFormatSaverJSON::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
  1357. Ref<JSON> json = p_resource;
  1358. ERR_FAIL_COND_V(json.is_null(), ERR_INVALID_PARAMETER);
  1359. String source = json->get_parsed_text().is_empty() ? JSON::stringify(json->get_data(), "\t", false, true) : json->get_parsed_text();
  1360. Error err;
  1361. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1362. ERR_FAIL_COND_V_MSG(err, err, vformat("Cannot save json '%s'.", p_path));
  1363. file->store_string(source);
  1364. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  1365. return ERR_CANT_CREATE;
  1366. }
  1367. return OK;
  1368. }
  1369. void ResourceFormatSaverJSON::get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const {
  1370. Ref<JSON> json = p_resource;
  1371. if (json.is_valid()) {
  1372. p_extensions->push_back("json");
  1373. }
  1374. }
  1375. bool ResourceFormatSaverJSON::recognize(const Ref<Resource> &p_resource) const {
  1376. return p_resource->get_class_name() == "JSON"; //only json, not inherited
  1377. }