json.cpp 43 KB

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