json.cpp 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580
  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. LocalVector<Variant> keys = d.get_key_list();
  111. if (p_sort_keys) {
  112. keys.sort_custom<StringLikeVariantOrder>();
  113. }
  114. bool first_key = true;
  115. for (const Variant &E : keys) {
  116. if (first_key) {
  117. first_key = false;
  118. } else {
  119. s += ",";
  120. s += end_statement;
  121. }
  122. s += _make_indent(p_indent, p_cur_indent + 1) + _stringify(String(E), p_indent, p_cur_indent + 1, p_sort_keys, p_markers);
  123. s += colon;
  124. s += _stringify(d[E], p_indent, p_cur_indent + 1, p_sort_keys, p_markers);
  125. }
  126. s += end_statement + _make_indent(p_indent, p_cur_indent) + "}";
  127. p_markers.erase(d.id());
  128. return s;
  129. }
  130. default:
  131. return "\"" + String(p_var).json_escape() + "\"";
  132. }
  133. }
  134. Error JSON::_get_token(const char32_t *p_str, int &index, int p_len, Token &r_token, int &line, String &r_err_str) {
  135. while (p_len > 0) {
  136. switch (p_str[index]) {
  137. case '\n': {
  138. line++;
  139. index++;
  140. break;
  141. }
  142. case 0: {
  143. r_token.type = TK_EOF;
  144. return OK;
  145. } break;
  146. case '{': {
  147. r_token.type = TK_CURLY_BRACKET_OPEN;
  148. index++;
  149. return OK;
  150. }
  151. case '}': {
  152. r_token.type = TK_CURLY_BRACKET_CLOSE;
  153. index++;
  154. return OK;
  155. }
  156. case '[': {
  157. r_token.type = TK_BRACKET_OPEN;
  158. index++;
  159. return OK;
  160. }
  161. case ']': {
  162. r_token.type = TK_BRACKET_CLOSE;
  163. index++;
  164. return OK;
  165. }
  166. case ':': {
  167. r_token.type = TK_COLON;
  168. index++;
  169. return OK;
  170. }
  171. case ',': {
  172. r_token.type = TK_COMMA;
  173. index++;
  174. return OK;
  175. }
  176. case '"': {
  177. index++;
  178. String str;
  179. while (true) {
  180. if (p_str[index] == 0) {
  181. r_err_str = "Unterminated string";
  182. return ERR_PARSE_ERROR;
  183. } else if (p_str[index] == '"') {
  184. index++;
  185. break;
  186. } else if (p_str[index] == '\\') {
  187. //escaped characters...
  188. index++;
  189. char32_t next = p_str[index];
  190. if (next == 0) {
  191. r_err_str = "Unterminated string";
  192. return ERR_PARSE_ERROR;
  193. }
  194. char32_t res = 0;
  195. switch (next) {
  196. case 'b':
  197. res = 8;
  198. break;
  199. case 't':
  200. res = 9;
  201. break;
  202. case 'n':
  203. res = 10;
  204. break;
  205. case 'f':
  206. res = 12;
  207. break;
  208. case 'r':
  209. res = 13;
  210. break;
  211. case 'u': {
  212. // hex number
  213. for (int j = 0; j < 4; j++) {
  214. char32_t c = p_str[index + j + 1];
  215. if (c == 0) {
  216. r_err_str = "Unterminated string";
  217. return ERR_PARSE_ERROR;
  218. }
  219. if (!is_hex_digit(c)) {
  220. r_err_str = "Malformed hex constant in string";
  221. return ERR_PARSE_ERROR;
  222. }
  223. char32_t v;
  224. if (is_digit(c)) {
  225. v = c - '0';
  226. } else if (c >= 'a' && c <= 'f') {
  227. v = c - 'a';
  228. v += 10;
  229. } else if (c >= 'A' && c <= 'F') {
  230. v = c - 'A';
  231. v += 10;
  232. } else {
  233. ERR_PRINT("Bug parsing hex constant.");
  234. v = 0;
  235. }
  236. res <<= 4;
  237. res |= v;
  238. }
  239. index += 4; //will add at the end anyway
  240. if ((res & 0xfffffc00) == 0xd800) {
  241. if (p_str[index + 1] != '\\' || p_str[index + 2] != 'u') {
  242. r_err_str = "Invalid UTF-16 sequence in string, unpaired lead surrogate";
  243. return ERR_PARSE_ERROR;
  244. }
  245. index += 2;
  246. char32_t trail = 0;
  247. for (int j = 0; j < 4; j++) {
  248. char32_t c = p_str[index + j + 1];
  249. if (c == 0) {
  250. r_err_str = "Unterminated string";
  251. return ERR_PARSE_ERROR;
  252. }
  253. if (!is_hex_digit(c)) {
  254. r_err_str = "Malformed hex constant in string";
  255. return ERR_PARSE_ERROR;
  256. }
  257. char32_t v;
  258. if (is_digit(c)) {
  259. v = c - '0';
  260. } else if (c >= 'a' && c <= 'f') {
  261. v = c - 'a';
  262. v += 10;
  263. } else if (c >= 'A' && c <= 'F') {
  264. v = c - 'A';
  265. v += 10;
  266. } else {
  267. ERR_PRINT("Bug parsing hex constant.");
  268. v = 0;
  269. }
  270. trail <<= 4;
  271. trail |= v;
  272. }
  273. if ((trail & 0xfffffc00) == 0xdc00) {
  274. res = (res << 10UL) + trail - ((0xd800 << 10UL) + 0xdc00 - 0x10000);
  275. index += 4; //will add at the end anyway
  276. } else {
  277. r_err_str = "Invalid UTF-16 sequence in string, unpaired lead surrogate";
  278. return ERR_PARSE_ERROR;
  279. }
  280. } else if ((res & 0xfffffc00) == 0xdc00) {
  281. r_err_str = "Invalid UTF-16 sequence in string, unpaired trail surrogate";
  282. return ERR_PARSE_ERROR;
  283. }
  284. } break;
  285. case '"':
  286. case '\\':
  287. case '/': {
  288. res = next;
  289. } break;
  290. default: {
  291. r_err_str = "Invalid escape sequence";
  292. return ERR_PARSE_ERROR;
  293. }
  294. }
  295. str += res;
  296. } else {
  297. if (p_str[index] == '\n') {
  298. line++;
  299. }
  300. str += p_str[index];
  301. }
  302. index++;
  303. }
  304. r_token.type = TK_STRING;
  305. r_token.value = str;
  306. return OK;
  307. } break;
  308. default: {
  309. if (p_str[index] <= 32) {
  310. index++;
  311. break;
  312. }
  313. if (p_str[index] == '-' || is_digit(p_str[index])) {
  314. //a number
  315. const char32_t *rptr;
  316. double number = String::to_float(&p_str[index], &rptr);
  317. index += (rptr - &p_str[index]);
  318. r_token.type = TK_NUMBER;
  319. r_token.value = number;
  320. return OK;
  321. } else if (is_ascii_alphabet_char(p_str[index])) {
  322. String id;
  323. while (is_ascii_alphabet_char(p_str[index])) {
  324. id += p_str[index];
  325. index++;
  326. }
  327. r_token.type = TK_IDENTIFIER;
  328. r_token.value = id;
  329. return OK;
  330. } else {
  331. r_err_str = "Unexpected character";
  332. return ERR_PARSE_ERROR;
  333. }
  334. }
  335. }
  336. }
  337. r_err_str = "Unknown error getting token";
  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";
  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 = vformat("Expected 'true', 'false', or 'null', got '%s'", 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 = vformat("Expected value, got '%s'", 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 = { v.x, v.y };
  594. RETURN_ARGS;
  595. } break;
  596. case Variant::VECTOR2I: {
  597. const Vector2i v = p_variant;
  598. Array args = { v.x, v.y };
  599. RETURN_ARGS;
  600. } break;
  601. case Variant::RECT2: {
  602. const Rect2 r = p_variant;
  603. Array args = { r.position.x, r.position.y, r.size.width, r.size.height };
  604. RETURN_ARGS;
  605. } break;
  606. case Variant::RECT2I: {
  607. const Rect2i r = p_variant;
  608. Array args = { r.position.x, r.position.y, r.size.width, r.size.height };
  609. RETURN_ARGS;
  610. } break;
  611. case Variant::VECTOR3: {
  612. const Vector3 v = p_variant;
  613. Array args = { v.x, v.y, v.z };
  614. RETURN_ARGS;
  615. } break;
  616. case Variant::VECTOR3I: {
  617. const Vector3i v = p_variant;
  618. Array args = { v.x, v.y, v.z };
  619. RETURN_ARGS;
  620. } break;
  621. case Variant::TRANSFORM2D: {
  622. const Transform2D t = p_variant;
  623. Array args = { t[0].x, t[0].y, t[1].x, t[1].y, t[2].x, t[2].y };
  624. RETURN_ARGS;
  625. } break;
  626. case Variant::VECTOR4: {
  627. const Vector4 v = p_variant;
  628. Array args = { v.x, v.y, v.z, v.w };
  629. RETURN_ARGS;
  630. } break;
  631. case Variant::VECTOR4I: {
  632. const Vector4i v = p_variant;
  633. Array args = { v.x, v.y, v.z, v.w };
  634. RETURN_ARGS;
  635. } break;
  636. case Variant::PLANE: {
  637. const Plane p = p_variant;
  638. Array args = { p.normal.x, p.normal.y, p.normal.z, p.d };
  639. RETURN_ARGS;
  640. } break;
  641. case Variant::QUATERNION: {
  642. const Quaternion q = p_variant;
  643. Array args = { q.x, q.y, q.z, q.w };
  644. RETURN_ARGS;
  645. } break;
  646. case Variant::AABB: {
  647. const AABB aabb = p_variant;
  648. Array args = { aabb.position.x, aabb.position.y, aabb.position.z, aabb.size.x, aabb.size.y, aabb.size.z };
  649. RETURN_ARGS;
  650. } break;
  651. case Variant::BASIS: {
  652. const Basis b = p_variant;
  653. Array args = { b.get_column(0).x, b.get_column(0).y, b.get_column(0).z,
  654. b.get_column(1).x, b.get_column(1).y, b.get_column(1).z,
  655. b.get_column(2).x, b.get_column(2).y, b.get_column(2).z };
  656. RETURN_ARGS;
  657. } break;
  658. case Variant::TRANSFORM3D: {
  659. const Transform3D t = p_variant;
  660. Array args = { t.basis.get_column(0).x, t.basis.get_column(0).y, t.basis.get_column(0).z,
  661. t.basis.get_column(1).x, t.basis.get_column(1).y, t.basis.get_column(1).z,
  662. t.basis.get_column(2).x, t.basis.get_column(2).y, t.basis.get_column(2).z,
  663. t.origin.x, t.origin.y, t.origin.z };
  664. RETURN_ARGS;
  665. } break;
  666. case Variant::PROJECTION: {
  667. const Projection p = p_variant;
  668. Array args = { p[0].x, p[0].y, p[0].z, p[0].w,
  669. p[1].x, p[1].y, p[1].z, p[1].w,
  670. p[2].x, p[2].y, p[2].z, p[2].w,
  671. p[3].x, p[3].y, p[3].z, p[3].w };
  672. RETURN_ARGS;
  673. } break;
  674. case Variant::COLOR: {
  675. const Color c = p_variant;
  676. Array args = { c.r, c.g, c.b, c.a };
  677. RETURN_ARGS;
  678. } break;
  679. case Variant::OBJECT: {
  680. ERR_FAIL_COND_V(!p_full_objects, Variant());
  681. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, Variant(), "Variant is too deep. Bailing.");
  682. const Object *obj = p_variant.get_validated_object();
  683. if (obj == nullptr) {
  684. return Variant();
  685. }
  686. ERR_FAIL_COND_V(!ClassDB::can_instantiate(obj->get_class()), Variant());
  687. List<PropertyInfo> prop_list;
  688. obj->get_property_list(&prop_list);
  689. Array props;
  690. for (const PropertyInfo &pi : prop_list) {
  691. if (!(pi.usage & PROPERTY_USAGE_STORAGE)) {
  692. continue;
  693. }
  694. Variant value;
  695. if (pi.name == CoreStringName(script)) {
  696. const Ref<Script> script = obj->get_script();
  697. if (script.is_valid()) {
  698. const String path = script->get_path();
  699. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://"), Variant(), "Failed to encode a path to a custom script.");
  700. value = path;
  701. }
  702. } else {
  703. value = obj->get(pi.name);
  704. }
  705. props.push_back(pi.name);
  706. props.push_back(_from_native(value, p_full_objects, p_depth + 1));
  707. }
  708. Dictionary ret;
  709. ret[TYPE] = obj->get_class();
  710. ret[PROPS] = props;
  711. return ret;
  712. } break;
  713. case Variant::DICTIONARY: {
  714. const Dictionary dict = p_variant;
  715. Array args;
  716. Dictionary ret;
  717. ret[TYPE] = Variant::get_type_name(p_variant.get_type());
  718. if (!_encode_container_type(ret, KEY_TYPE, dict.get_key_type(), p_full_objects)) {
  719. return Variant();
  720. }
  721. if (!_encode_container_type(ret, VALUE_TYPE, dict.get_value_type(), p_full_objects)) {
  722. return Variant();
  723. }
  724. ret[ARGS] = args;
  725. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  726. for (const KeyValue<Variant, Variant> &kv : dict) {
  727. args.push_back(_from_native(kv.key, p_full_objects, p_depth + 1));
  728. args.push_back(_from_native(kv.value, p_full_objects, p_depth + 1));
  729. }
  730. return ret;
  731. } break;
  732. case Variant::ARRAY: {
  733. const Array arr = p_variant;
  734. Variant ret;
  735. Array args;
  736. if (arr.is_typed()) {
  737. Dictionary d;
  738. d[TYPE] = Variant::get_type_name(p_variant.get_type());
  739. if (!_encode_container_type(d, ELEM_TYPE, arr.get_element_type(), p_full_objects)) {
  740. return Variant();
  741. }
  742. d[ARGS] = args;
  743. ret = d;
  744. } else {
  745. ret = args;
  746. }
  747. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  748. for (int i = 0; i < arr.size(); i++) {
  749. args.push_back(_from_native(arr[i], p_full_objects, p_depth + 1));
  750. }
  751. return ret;
  752. } break;
  753. case Variant::PACKED_BYTE_ARRAY: {
  754. const PackedByteArray arr = p_variant;
  755. Array args;
  756. for (int i = 0; i < arr.size(); i++) {
  757. args.push_back(arr[i]);
  758. }
  759. RETURN_ARGS;
  760. } break;
  761. case Variant::PACKED_INT32_ARRAY: {
  762. const PackedInt32Array arr = p_variant;
  763. Array args;
  764. for (int i = 0; i < arr.size(); i++) {
  765. args.push_back(arr[i]);
  766. }
  767. RETURN_ARGS;
  768. } break;
  769. case Variant::PACKED_INT64_ARRAY: {
  770. const PackedInt64Array arr = p_variant;
  771. Array args;
  772. for (int i = 0; i < arr.size(); i++) {
  773. args.push_back(arr[i]);
  774. }
  775. RETURN_ARGS;
  776. } break;
  777. case Variant::PACKED_FLOAT32_ARRAY: {
  778. const PackedFloat32Array arr = p_variant;
  779. Array args;
  780. for (int i = 0; i < arr.size(); i++) {
  781. args.push_back(arr[i]);
  782. }
  783. RETURN_ARGS;
  784. } break;
  785. case Variant::PACKED_FLOAT64_ARRAY: {
  786. const PackedFloat64Array arr = p_variant;
  787. Array args;
  788. for (int i = 0; i < arr.size(); i++) {
  789. args.push_back(arr[i]);
  790. }
  791. RETURN_ARGS;
  792. } break;
  793. case Variant::PACKED_STRING_ARRAY: {
  794. const PackedStringArray arr = p_variant;
  795. Array args;
  796. for (int i = 0; i < arr.size(); i++) {
  797. args.push_back(arr[i]);
  798. }
  799. RETURN_ARGS;
  800. } break;
  801. case Variant::PACKED_VECTOR2_ARRAY: {
  802. const PackedVector2Array arr = p_variant;
  803. Array args;
  804. for (int i = 0; i < arr.size(); i++) {
  805. Vector2 v = arr[i];
  806. args.push_back(v.x);
  807. args.push_back(v.y);
  808. }
  809. RETURN_ARGS;
  810. } break;
  811. case Variant::PACKED_VECTOR3_ARRAY: {
  812. const PackedVector3Array arr = p_variant;
  813. Array args;
  814. for (int i = 0; i < arr.size(); i++) {
  815. Vector3 v = arr[i];
  816. args.push_back(v.x);
  817. args.push_back(v.y);
  818. args.push_back(v.z);
  819. }
  820. RETURN_ARGS;
  821. } break;
  822. case Variant::PACKED_COLOR_ARRAY: {
  823. const PackedColorArray arr = p_variant;
  824. Array args;
  825. for (int i = 0; i < arr.size(); i++) {
  826. Color v = arr[i];
  827. args.push_back(v.r);
  828. args.push_back(v.g);
  829. args.push_back(v.b);
  830. args.push_back(v.a);
  831. }
  832. RETURN_ARGS;
  833. } break;
  834. case Variant::PACKED_VECTOR4_ARRAY: {
  835. const PackedVector4Array arr = p_variant;
  836. Array args;
  837. for (int i = 0; i < arr.size(); i++) {
  838. Vector4 v = arr[i];
  839. args.push_back(v.x);
  840. args.push_back(v.y);
  841. args.push_back(v.z);
  842. args.push_back(v.w);
  843. }
  844. RETURN_ARGS;
  845. } break;
  846. case Variant::VARIANT_MAX: {
  847. // Nothing to do.
  848. } break;
  849. }
  850. #undef RETURN_ARGS
  851. ERR_FAIL_V_MSG(Variant(), vformat(R"(Unhandled Variant type "%s".)", Variant::get_type_name(p_variant.get_type())));
  852. }
  853. static bool _decode_container_type(const Dictionary &p_dict, const String &p_key, ContainerType &r_type, bool p_allow_objects) {
  854. if (!p_dict.has(p_key)) {
  855. return true;
  856. }
  857. const String type_name = p_dict[p_key];
  858. const Variant::Type builtin_type = Variant::get_type_by_name(type_name);
  859. if (builtin_type < Variant::VARIANT_MAX && builtin_type != Variant::OBJECT) {
  860. r_type.builtin_type = builtin_type;
  861. return true;
  862. }
  863. if (ClassDB::class_exists(type_name)) {
  864. ERR_FAIL_COND_V(!p_allow_objects, false);
  865. r_type.builtin_type = Variant::OBJECT;
  866. r_type.class_name = type_name;
  867. return true;
  868. }
  869. if (type_name.begins_with("res://")) {
  870. ERR_FAIL_COND_V(!p_allow_objects, false);
  871. ERR_FAIL_COND_V_MSG(!ResourceLoader::exists(type_name, "Script"), false, vformat(R"(Invalid script path "%s".)", type_name));
  872. const Ref<Script> script = ResourceLoader::load(type_name, "Script");
  873. ERR_FAIL_COND_V_MSG(script.is_null(), false, vformat(R"(Can't load script at path "%s".)", type_name));
  874. r_type.builtin_type = Variant::OBJECT;
  875. r_type.class_name = script->get_instance_base_type();
  876. r_type.script = script;
  877. return true;
  878. }
  879. ERR_FAIL_V_MSG(false, vformat(R"(Invalid type "%s".)", type_name));
  880. }
  881. Variant JSON::_to_native(const Variant &p_json, bool p_allow_objects, int p_depth) {
  882. switch (p_json.get_type()) {
  883. case Variant::NIL:
  884. case Variant::BOOL: {
  885. return p_json;
  886. } break;
  887. case Variant::STRING: {
  888. const String s = p_json;
  889. if (s.begins_with("i:")) {
  890. return s.substr(2).to_int();
  891. } else if (s.begins_with("f:")) {
  892. return s.substr(2).to_float();
  893. } else if (s.begins_with("s:")) {
  894. return s.substr(2);
  895. } else if (s.begins_with("sn:")) {
  896. return StringName(s.substr(3));
  897. } else if (s.begins_with("np:")) {
  898. return NodePath(s.substr(3));
  899. }
  900. ERR_FAIL_V_MSG(Variant(), "Invalid string, the type prefix is not recognized.");
  901. } break;
  902. case Variant::DICTIONARY: {
  903. const Dictionary dict = p_json;
  904. ERR_FAIL_COND_V(!dict.has(TYPE), Variant());
  905. #define LOAD_ARGS() \
  906. ERR_FAIL_COND_V(!dict.has(ARGS), Variant()); \
  907. const Array args = dict[ARGS]
  908. #define LOAD_ARGS_CHECK_SIZE(m_size) \
  909. ERR_FAIL_COND_V(!dict.has(ARGS), Variant()); \
  910. const Array args = dict[ARGS]; \
  911. ERR_FAIL_COND_V(args.size() != (m_size), Variant())
  912. #define LOAD_ARGS_CHECK_FACTOR(m_factor) \
  913. ERR_FAIL_COND_V(!dict.has(ARGS), Variant()); \
  914. const Array args = dict[ARGS]; \
  915. ERR_FAIL_COND_V(args.size() % (m_factor) != 0, Variant())
  916. switch (Variant::get_type_by_name(dict[TYPE])) {
  917. case Variant::NIL:
  918. case Variant::BOOL: {
  919. ERR_FAIL_V_MSG(Variant(), vformat(R"(Unexpected "%s": Variant type "%s" is JSON-compliant.)", TYPE, dict[TYPE]));
  920. } break;
  921. case Variant::INT:
  922. case Variant::FLOAT:
  923. case Variant::STRING:
  924. case Variant::STRING_NAME:
  925. case Variant::NODE_PATH: {
  926. ERR_FAIL_V_MSG(Variant(), vformat(R"(Unexpected "%s": Variant type "%s" must be represented as a string.)", TYPE, dict[TYPE]));
  927. } break;
  928. case Variant::RID: {
  929. return RID();
  930. } break;
  931. case Variant::CALLABLE: {
  932. return Callable();
  933. } break;
  934. case Variant::SIGNAL: {
  935. return Signal();
  936. } break;
  937. case Variant::VECTOR2: {
  938. LOAD_ARGS_CHECK_SIZE(2);
  939. Vector2 v;
  940. v.x = args[0];
  941. v.y = args[1];
  942. return v;
  943. } break;
  944. case Variant::VECTOR2I: {
  945. LOAD_ARGS_CHECK_SIZE(2);
  946. Vector2i v;
  947. v.x = args[0];
  948. v.y = args[1];
  949. return v;
  950. } break;
  951. case Variant::RECT2: {
  952. LOAD_ARGS_CHECK_SIZE(4);
  953. Rect2 r;
  954. r.position = Point2(args[0], args[1]);
  955. r.size = Size2(args[2], args[3]);
  956. return r;
  957. } break;
  958. case Variant::RECT2I: {
  959. LOAD_ARGS_CHECK_SIZE(4);
  960. Rect2i r;
  961. r.position = Point2i(args[0], args[1]);
  962. r.size = Size2i(args[2], args[3]);
  963. return r;
  964. } break;
  965. case Variant::VECTOR3: {
  966. LOAD_ARGS_CHECK_SIZE(3);
  967. Vector3 v;
  968. v.x = args[0];
  969. v.y = args[1];
  970. v.z = args[2];
  971. return v;
  972. } break;
  973. case Variant::VECTOR3I: {
  974. LOAD_ARGS_CHECK_SIZE(3);
  975. Vector3i v;
  976. v.x = args[0];
  977. v.y = args[1];
  978. v.z = args[2];
  979. return v;
  980. } break;
  981. case Variant::TRANSFORM2D: {
  982. LOAD_ARGS_CHECK_SIZE(6);
  983. Transform2D t;
  984. t[0] = Vector2(args[0], args[1]);
  985. t[1] = Vector2(args[2], args[3]);
  986. t[2] = Vector2(args[4], args[5]);
  987. return t;
  988. } break;
  989. case Variant::VECTOR4: {
  990. LOAD_ARGS_CHECK_SIZE(4);
  991. Vector4 v;
  992. v.x = args[0];
  993. v.y = args[1];
  994. v.z = args[2];
  995. v.w = args[3];
  996. return v;
  997. } break;
  998. case Variant::VECTOR4I: {
  999. LOAD_ARGS_CHECK_SIZE(4);
  1000. Vector4i v;
  1001. v.x = args[0];
  1002. v.y = args[1];
  1003. v.z = args[2];
  1004. v.w = args[3];
  1005. return v;
  1006. } break;
  1007. case Variant::PLANE: {
  1008. LOAD_ARGS_CHECK_SIZE(4);
  1009. Plane p;
  1010. p.normal = Vector3(args[0], args[1], args[2]);
  1011. p.d = args[3];
  1012. return p;
  1013. } break;
  1014. case Variant::QUATERNION: {
  1015. LOAD_ARGS_CHECK_SIZE(4);
  1016. Quaternion q;
  1017. q.x = args[0];
  1018. q.y = args[1];
  1019. q.z = args[2];
  1020. q.w = args[3];
  1021. return q;
  1022. } break;
  1023. case Variant::AABB: {
  1024. LOAD_ARGS_CHECK_SIZE(6);
  1025. AABB aabb;
  1026. aabb.position = Vector3(args[0], args[1], args[2]);
  1027. aabb.size = Vector3(args[3], args[4], args[5]);
  1028. return aabb;
  1029. } break;
  1030. case Variant::BASIS: {
  1031. LOAD_ARGS_CHECK_SIZE(9);
  1032. Basis b;
  1033. b.set_column(0, Vector3(args[0], args[1], args[2]));
  1034. b.set_column(1, Vector3(args[3], args[4], args[5]));
  1035. b.set_column(2, Vector3(args[6], args[7], args[8]));
  1036. return b;
  1037. } break;
  1038. case Variant::TRANSFORM3D: {
  1039. LOAD_ARGS_CHECK_SIZE(12);
  1040. Transform3D t;
  1041. t.basis.set_column(0, Vector3(args[0], args[1], args[2]));
  1042. t.basis.set_column(1, Vector3(args[3], args[4], args[5]));
  1043. t.basis.set_column(2, Vector3(args[6], args[7], args[8]));
  1044. t.origin = Vector3(args[9], args[10], args[11]);
  1045. return t;
  1046. } break;
  1047. case Variant::PROJECTION: {
  1048. LOAD_ARGS_CHECK_SIZE(16);
  1049. Projection p;
  1050. p[0] = Vector4(args[0], args[1], args[2], args[3]);
  1051. p[1] = Vector4(args[4], args[5], args[6], args[7]);
  1052. p[2] = Vector4(args[8], args[9], args[10], args[11]);
  1053. p[3] = Vector4(args[12], args[13], args[14], args[15]);
  1054. return p;
  1055. } break;
  1056. case Variant::COLOR: {
  1057. LOAD_ARGS_CHECK_SIZE(4);
  1058. Color c;
  1059. c.r = args[0];
  1060. c.g = args[1];
  1061. c.b = args[2];
  1062. c.a = args[3];
  1063. return c;
  1064. } break;
  1065. case Variant::OBJECT: {
  1066. // Nothing to do at this stage. `Object` should be treated as a class, not as a built-in type.
  1067. } break;
  1068. case Variant::DICTIONARY: {
  1069. LOAD_ARGS_CHECK_FACTOR(2);
  1070. ContainerType key_type;
  1071. if (!_decode_container_type(dict, KEY_TYPE, key_type, p_allow_objects)) {
  1072. return Variant();
  1073. }
  1074. ContainerType value_type;
  1075. if (!_decode_container_type(dict, VALUE_TYPE, value_type, p_allow_objects)) {
  1076. return Variant();
  1077. }
  1078. Dictionary ret;
  1079. if (key_type.builtin_type != Variant::NIL || value_type.builtin_type != Variant::NIL) {
  1080. ret.set_typed(key_type, value_type);
  1081. }
  1082. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  1083. for (int i = 0; i < args.size() / 2; i++) {
  1084. 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);
  1085. }
  1086. return ret;
  1087. } break;
  1088. case Variant::ARRAY: {
  1089. LOAD_ARGS();
  1090. ContainerType elem_type;
  1091. if (!_decode_container_type(dict, ELEM_TYPE, elem_type, p_allow_objects)) {
  1092. return Variant();
  1093. }
  1094. Array ret;
  1095. if (elem_type.builtin_type != Variant::NIL) {
  1096. ret.set_typed(elem_type);
  1097. }
  1098. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ret, "Variant is too deep. Bailing.");
  1099. ret.resize(args.size());
  1100. for (int i = 0; i < args.size(); i++) {
  1101. ret[i] = _to_native(args[i], p_allow_objects, p_depth + 1);
  1102. }
  1103. return ret;
  1104. } break;
  1105. case Variant::PACKED_BYTE_ARRAY: {
  1106. LOAD_ARGS();
  1107. PackedByteArray arr;
  1108. arr.resize(args.size());
  1109. for (int i = 0; i < arr.size(); i++) {
  1110. arr.write[i] = args[i];
  1111. }
  1112. return arr;
  1113. } break;
  1114. case Variant::PACKED_INT32_ARRAY: {
  1115. LOAD_ARGS();
  1116. PackedInt32Array arr;
  1117. arr.resize(args.size());
  1118. for (int i = 0; i < arr.size(); i++) {
  1119. arr.write[i] = args[i];
  1120. }
  1121. return arr;
  1122. } break;
  1123. case Variant::PACKED_INT64_ARRAY: {
  1124. LOAD_ARGS();
  1125. PackedInt64Array arr;
  1126. arr.resize(args.size());
  1127. for (int i = 0; i < arr.size(); i++) {
  1128. arr.write[i] = args[i];
  1129. }
  1130. return arr;
  1131. } break;
  1132. case Variant::PACKED_FLOAT32_ARRAY: {
  1133. LOAD_ARGS();
  1134. PackedFloat32Array arr;
  1135. arr.resize(args.size());
  1136. for (int i = 0; i < arr.size(); i++) {
  1137. arr.write[i] = args[i];
  1138. }
  1139. return arr;
  1140. } break;
  1141. case Variant::PACKED_FLOAT64_ARRAY: {
  1142. LOAD_ARGS();
  1143. PackedFloat64Array arr;
  1144. arr.resize(args.size());
  1145. for (int i = 0; i < arr.size(); i++) {
  1146. arr.write[i] = args[i];
  1147. }
  1148. return arr;
  1149. } break;
  1150. case Variant::PACKED_STRING_ARRAY: {
  1151. LOAD_ARGS();
  1152. PackedStringArray arr;
  1153. arr.resize(args.size());
  1154. for (int i = 0; i < arr.size(); i++) {
  1155. arr.write[i] = args[i];
  1156. }
  1157. return arr;
  1158. } break;
  1159. case Variant::PACKED_VECTOR2_ARRAY: {
  1160. LOAD_ARGS_CHECK_FACTOR(2);
  1161. PackedVector2Array arr;
  1162. arr.resize(args.size() / 2);
  1163. for (int i = 0; i < arr.size(); i++) {
  1164. arr.write[i] = Vector2(args[i * 2 + 0], args[i * 2 + 1]);
  1165. }
  1166. return arr;
  1167. } break;
  1168. case Variant::PACKED_VECTOR3_ARRAY: {
  1169. LOAD_ARGS_CHECK_FACTOR(3);
  1170. PackedVector3Array arr;
  1171. arr.resize(args.size() / 3);
  1172. for (int i = 0; i < arr.size(); i++) {
  1173. arr.write[i] = Vector3(args[i * 3 + 0], args[i * 3 + 1], args[i * 3 + 2]);
  1174. }
  1175. return arr;
  1176. } break;
  1177. case Variant::PACKED_COLOR_ARRAY: {
  1178. LOAD_ARGS_CHECK_FACTOR(4);
  1179. PackedColorArray arr;
  1180. arr.resize(args.size() / 4);
  1181. for (int i = 0; i < arr.size(); i++) {
  1182. arr.write[i] = Color(args[i * 4 + 0], args[i * 4 + 1], args[i * 4 + 2], args[i * 4 + 3]);
  1183. }
  1184. return arr;
  1185. } break;
  1186. case Variant::PACKED_VECTOR4_ARRAY: {
  1187. LOAD_ARGS_CHECK_FACTOR(4);
  1188. PackedVector4Array arr;
  1189. arr.resize(args.size() / 4);
  1190. for (int i = 0; i < arr.size(); i++) {
  1191. arr.write[i] = Vector4(args[i * 4 + 0], args[i * 4 + 1], args[i * 4 + 2], args[i * 4 + 3]);
  1192. }
  1193. return arr;
  1194. } break;
  1195. case Variant::VARIANT_MAX: {
  1196. // Nothing to do.
  1197. } break;
  1198. }
  1199. #undef LOAD_ARGS
  1200. #undef LOAD_ARGS_CHECK_SIZE
  1201. #undef LOAD_ARGS_CHECK_FACTOR
  1202. if (ClassDB::class_exists(dict[TYPE])) {
  1203. ERR_FAIL_COND_V(!p_allow_objects, Variant());
  1204. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, Variant(), "Variant is too deep. Bailing.");
  1205. ERR_FAIL_COND_V(!dict.has(PROPS), Variant());
  1206. const Array props = dict[PROPS];
  1207. ERR_FAIL_COND_V(props.size() % 2 != 0, Variant());
  1208. ERR_FAIL_COND_V(!ClassDB::can_instantiate(dict[TYPE]), Variant());
  1209. Object *obj = ClassDB::instantiate(dict[TYPE]);
  1210. ERR_FAIL_NULL_V(obj, Variant());
  1211. // Avoid premature free `RefCounted`. This must be done before properties are initialized,
  1212. // since script functions (setters, implicit initializer) may be called. See GH-68666.
  1213. Variant variant;
  1214. if (Object::cast_to<RefCounted>(obj)) {
  1215. const Ref<RefCounted> ref = Ref<RefCounted>(Object::cast_to<RefCounted>(obj));
  1216. variant = ref;
  1217. } else {
  1218. variant = obj;
  1219. }
  1220. for (int i = 0; i < props.size() / 2; i++) {
  1221. const StringName name = props[i * 2 + 0];
  1222. const Variant value = _to_native(props[i * 2 + 1], p_allow_objects, p_depth + 1);
  1223. if (name == CoreStringName(script) && value.get_type() != Variant::NIL) {
  1224. const String path = value;
  1225. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://") || !ResourceLoader::exists(path, "Script"),
  1226. Variant(),
  1227. vformat(R"(Invalid script path "%s".)", path));
  1228. const Ref<Script> script = ResourceLoader::load(path, "Script");
  1229. ERR_FAIL_COND_V_MSG(script.is_null(), Variant(), vformat(R"(Can't load script at path "%s".)", path));
  1230. obj->set_script(script);
  1231. } else {
  1232. obj->set(name, value);
  1233. }
  1234. }
  1235. return variant;
  1236. }
  1237. ERR_FAIL_V_MSG(Variant(), vformat(R"(Invalid type "%s".)", dict[TYPE]));
  1238. } break;
  1239. case Variant::ARRAY: {
  1240. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, Array(), "Variant is too deep. Bailing.");
  1241. const Array arr = p_json;
  1242. Array ret;
  1243. ret.resize(arr.size());
  1244. for (int i = 0; i < arr.size(); i++) {
  1245. ret[i] = _to_native(arr[i], p_allow_objects, p_depth + 1);
  1246. }
  1247. return ret;
  1248. } break;
  1249. default: {
  1250. // Nothing to do.
  1251. } break;
  1252. }
  1253. ERR_FAIL_V_MSG(Variant(), vformat(R"(Variant type "%s" is not JSON-compliant.)", Variant::get_type_name(p_json.get_type())));
  1254. }
  1255. #undef TYPE
  1256. #undef ELEM_TYPE
  1257. #undef KEY_TYPE
  1258. #undef VALUE_TYPE
  1259. #undef ARGS
  1260. #undef PROPS
  1261. ////////////
  1262. 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) {
  1263. if (r_error) {
  1264. *r_error = ERR_FILE_CANT_OPEN;
  1265. }
  1266. if (!FileAccess::exists(p_path)) {
  1267. *r_error = ERR_FILE_NOT_FOUND;
  1268. return Ref<Resource>();
  1269. }
  1270. Ref<JSON> json;
  1271. json.instantiate();
  1272. Error err = json->parse(FileAccess::get_file_as_string(p_path), Engine::get_singleton()->is_editor_hint());
  1273. if (err != OK) {
  1274. String err_text = "Error parsing JSON file at '" + p_path + "', on line " + itos(json->get_error_line()) + ": " + json->get_error_message();
  1275. if (Engine::get_singleton()->is_editor_hint()) {
  1276. // If running on editor, still allow opening the JSON so the code editor can edit it.
  1277. WARN_PRINT(err_text);
  1278. } else {
  1279. if (r_error) {
  1280. *r_error = err;
  1281. }
  1282. ERR_PRINT(err_text);
  1283. return Ref<Resource>();
  1284. }
  1285. }
  1286. if (r_error) {
  1287. *r_error = OK;
  1288. }
  1289. return json;
  1290. }
  1291. void ResourceFormatLoaderJSON::get_recognized_extensions(List<String> *p_extensions) const {
  1292. p_extensions->push_back("json");
  1293. }
  1294. bool ResourceFormatLoaderJSON::handles_type(const String &p_type) const {
  1295. return (p_type == "JSON");
  1296. }
  1297. String ResourceFormatLoaderJSON::get_resource_type(const String &p_path) const {
  1298. String el = p_path.get_extension().to_lower();
  1299. if (el == "json") {
  1300. return "JSON";
  1301. }
  1302. return "";
  1303. }
  1304. Error ResourceFormatSaverJSON::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
  1305. Ref<JSON> json = p_resource;
  1306. ERR_FAIL_COND_V(json.is_null(), ERR_INVALID_PARAMETER);
  1307. String source = json->get_parsed_text().is_empty() ? JSON::stringify(json->get_data(), "\t", false, true) : json->get_parsed_text();
  1308. Error err;
  1309. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1310. ERR_FAIL_COND_V_MSG(err, err, vformat("Cannot save json '%s'.", p_path));
  1311. file->store_string(source);
  1312. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  1313. return ERR_CANT_CREATE;
  1314. }
  1315. return OK;
  1316. }
  1317. void ResourceFormatSaverJSON::get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const {
  1318. Ref<JSON> json = p_resource;
  1319. if (json.is_valid()) {
  1320. p_extensions->push_back("json");
  1321. }
  1322. }
  1323. bool ResourceFormatSaverJSON::recognize(const Ref<Resource> &p_resource) const {
  1324. return p_resource->get_class_name() == "JSON"; //only json, not inherited
  1325. }