json.cpp 42 KB

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