json.cpp 43 KB

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