2
0

json.cpp 42 KB

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