marshalls.cpp 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196
  1. /**************************************************************************/
  2. /* marshalls.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 "marshalls.h"
  31. #include "core/io/resource_loader.h"
  32. #include "core/object/ref_counted.h"
  33. #include "core/object/script_language.h"
  34. #include <limits.h>
  35. #include <stdio.h>
  36. void EncodedObjectAsID::_bind_methods() {
  37. ClassDB::bind_method(D_METHOD("set_object_id", "id"), &EncodedObjectAsID::set_object_id);
  38. ClassDB::bind_method(D_METHOD("get_object_id"), &EncodedObjectAsID::get_object_id);
  39. ADD_PROPERTY(PropertyInfo(Variant::INT, "object_id"), "set_object_id", "get_object_id");
  40. }
  41. void EncodedObjectAsID::set_object_id(ObjectID p_id) {
  42. id = p_id;
  43. }
  44. ObjectID EncodedObjectAsID::get_object_id() const {
  45. return id;
  46. }
  47. #define ERR_FAIL_ADD_OF(a, b, err) ERR_FAIL_COND_V(((int32_t)(b)) < 0 || ((int32_t)(a)) < 0 || ((int32_t)(a)) > INT_MAX - ((int32_t)(b)), err)
  48. #define ERR_FAIL_MUL_OF(a, b, err) ERR_FAIL_COND_V(((int32_t)(a)) < 0 || ((int32_t)(b)) <= 0 || ((int32_t)(a)) > INT_MAX / ((int32_t)(b)), err)
  49. // Byte 0: `Variant::Type`, byte 1: unused, bytes 2 and 3: additional data.
  50. #define HEADER_TYPE_MASK 0xFF
  51. // For `Variant::INT`, `Variant::FLOAT` and other math types.
  52. #define HEADER_DATA_FLAG_64 (1 << 16)
  53. // For `Variant::OBJECT`.
  54. #define HEADER_DATA_FLAG_OBJECT_AS_ID (1 << 16)
  55. // For `Variant::ARRAY`.
  56. // Occupies bits 16 and 17.
  57. #define HEADER_DATA_FIELD_TYPED_ARRAY_MASK (0b11 << 16)
  58. #define HEADER_DATA_FIELD_TYPED_ARRAY_SHIFT 16
  59. // For `Variant::DICTIONARY`.
  60. // Occupies bits 16 and 17.
  61. #define HEADER_DATA_FIELD_TYPED_DICTIONARY_KEY_MASK (0b11 << 16)
  62. #define HEADER_DATA_FIELD_TYPED_DICTIONARY_KEY_SHIFT 16
  63. // Occupies bits 18 and 19.
  64. #define HEADER_DATA_FIELD_TYPED_DICTIONARY_VALUE_MASK (0b11 << 18)
  65. #define HEADER_DATA_FIELD_TYPED_DICTIONARY_VALUE_SHIFT 18
  66. enum ContainerTypeKind {
  67. CONTAINER_TYPE_KIND_NONE = 0b00,
  68. CONTAINER_TYPE_KIND_BUILTIN = 0b01,
  69. CONTAINER_TYPE_KIND_CLASS_NAME = 0b10,
  70. CONTAINER_TYPE_KIND_SCRIPT = 0b11,
  71. };
  72. struct ContainerType {
  73. Variant::Type builtin_type = Variant::NIL;
  74. StringName class_name;
  75. Ref<Script> script;
  76. };
  77. #define GET_CONTAINER_TYPE_KIND(m_header, m_field) \
  78. ((ContainerTypeKind)(((m_header) & HEADER_DATA_FIELD_##m_field##_MASK) >> HEADER_DATA_FIELD_##m_field##_SHIFT))
  79. static Error _decode_string(const uint8_t *&buf, int &len, int *r_len, String &r_string) {
  80. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  81. int32_t strlen = decode_uint32(buf);
  82. int32_t pad = 0;
  83. // Handle padding.
  84. if (strlen % 4) {
  85. pad = 4 - strlen % 4;
  86. }
  87. buf += 4;
  88. len -= 4;
  89. // Ensure buffer is big enough.
  90. ERR_FAIL_ADD_OF(strlen, pad, ERR_FILE_EOF);
  91. ERR_FAIL_COND_V(strlen < 0 || strlen + pad > len, ERR_FILE_EOF);
  92. String str;
  93. ERR_FAIL_COND_V(str.parse_utf8((const char *)buf, strlen) != OK, ERR_INVALID_DATA);
  94. r_string = str;
  95. // Add padding.
  96. strlen += pad;
  97. // Update buffer pos, left data count, and return size.
  98. buf += strlen;
  99. len -= strlen;
  100. if (r_len) {
  101. (*r_len) += 4 + strlen;
  102. }
  103. return OK;
  104. }
  105. static Error _decode_container_type(const uint8_t *&buf, int &len, int *r_len, bool p_allow_objects, ContainerTypeKind p_type_kind, ContainerType &r_type) {
  106. switch (p_type_kind) {
  107. case CONTAINER_TYPE_KIND_NONE: {
  108. return OK;
  109. } break;
  110. case CONTAINER_TYPE_KIND_BUILTIN: {
  111. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  112. int32_t bt = decode_uint32(buf);
  113. buf += 4;
  114. len -= 4;
  115. if (r_len) {
  116. (*r_len) += 4;
  117. }
  118. ERR_FAIL_INDEX_V(bt, Variant::VARIANT_MAX, ERR_INVALID_DATA);
  119. r_type.builtin_type = (Variant::Type)bt;
  120. if (!p_allow_objects && r_type.builtin_type == Variant::OBJECT) {
  121. r_type.class_name = EncodedObjectAsID::get_class_static();
  122. }
  123. return OK;
  124. } break;
  125. case CONTAINER_TYPE_KIND_CLASS_NAME: {
  126. String str;
  127. Error err = _decode_string(buf, len, r_len, str);
  128. if (err) {
  129. return err;
  130. }
  131. r_type.builtin_type = Variant::OBJECT;
  132. if (p_allow_objects) {
  133. r_type.class_name = str;
  134. } else {
  135. r_type.class_name = EncodedObjectAsID::get_class_static();
  136. }
  137. return OK;
  138. } break;
  139. case CONTAINER_TYPE_KIND_SCRIPT: {
  140. String path;
  141. Error err = _decode_string(buf, len, r_len, path);
  142. if (err) {
  143. return err;
  144. }
  145. r_type.builtin_type = Variant::OBJECT;
  146. if (p_allow_objects) {
  147. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://") || !ResourceLoader::exists(path, "Script"), ERR_INVALID_DATA, vformat("Invalid script path \"%s\".", path));
  148. r_type.script = ResourceLoader::load(path, "Script");
  149. ERR_FAIL_COND_V_MSG(r_type.script.is_null(), ERR_INVALID_DATA, vformat("Can't load script at path \"%s\".", path));
  150. r_type.class_name = r_type.script->get_instance_base_type();
  151. } else {
  152. r_type.class_name = EncodedObjectAsID::get_class_static();
  153. }
  154. return OK;
  155. } break;
  156. }
  157. ERR_FAIL_V_MSG(ERR_INVALID_DATA, "Invalid container type kind."); // Future proofing.
  158. }
  159. Error decode_variant(Variant &r_variant, const uint8_t *p_buffer, int p_len, int *r_len, bool p_allow_objects, int p_depth) {
  160. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ERR_OUT_OF_MEMORY, "Variant is too deep. Bailing.");
  161. const uint8_t *buf = p_buffer;
  162. int len = p_len;
  163. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  164. uint32_t header = decode_uint32(buf);
  165. ERR_FAIL_COND_V((header & HEADER_TYPE_MASK) >= Variant::VARIANT_MAX, ERR_INVALID_DATA);
  166. buf += 4;
  167. len -= 4;
  168. if (r_len) {
  169. *r_len = 4;
  170. }
  171. // NOTE: We cannot use `sizeof(real_t)` for decoding, in case a different size is encoded.
  172. // Decoding math types always checks for the encoded size, while encoding always uses compilation setting.
  173. // This does lead to some code duplication for decoding, but compatibility is the priority.
  174. switch (header & HEADER_TYPE_MASK) {
  175. case Variant::NIL: {
  176. r_variant = Variant();
  177. } break;
  178. case Variant::BOOL: {
  179. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  180. bool val = decode_uint32(buf);
  181. r_variant = val;
  182. if (r_len) {
  183. (*r_len) += 4;
  184. }
  185. } break;
  186. case Variant::INT: {
  187. if (header & HEADER_DATA_FLAG_64) {
  188. ERR_FAIL_COND_V(len < 8, ERR_INVALID_DATA);
  189. int64_t val = decode_uint64(buf);
  190. r_variant = val;
  191. if (r_len) {
  192. (*r_len) += 8;
  193. }
  194. } else {
  195. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  196. int32_t val = decode_uint32(buf);
  197. r_variant = val;
  198. if (r_len) {
  199. (*r_len) += 4;
  200. }
  201. }
  202. } break;
  203. case Variant::FLOAT: {
  204. if (header & HEADER_DATA_FLAG_64) {
  205. ERR_FAIL_COND_V((size_t)len < sizeof(double), ERR_INVALID_DATA);
  206. double val = decode_double(buf);
  207. r_variant = val;
  208. if (r_len) {
  209. (*r_len) += sizeof(double);
  210. }
  211. } else {
  212. ERR_FAIL_COND_V((size_t)len < sizeof(float), ERR_INVALID_DATA);
  213. float val = decode_float(buf);
  214. r_variant = val;
  215. if (r_len) {
  216. (*r_len) += sizeof(float);
  217. }
  218. }
  219. } break;
  220. case Variant::STRING: {
  221. String str;
  222. Error err = _decode_string(buf, len, r_len, str);
  223. if (err) {
  224. return err;
  225. }
  226. r_variant = str;
  227. } break;
  228. // Math types.
  229. case Variant::VECTOR2: {
  230. Vector2 val;
  231. if (header & HEADER_DATA_FLAG_64) {
  232. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 2, ERR_INVALID_DATA);
  233. val.x = decode_double(&buf[0]);
  234. val.y = decode_double(&buf[sizeof(double)]);
  235. if (r_len) {
  236. (*r_len) += sizeof(double) * 2;
  237. }
  238. } else {
  239. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 2, ERR_INVALID_DATA);
  240. val.x = decode_float(&buf[0]);
  241. val.y = decode_float(&buf[sizeof(float)]);
  242. if (r_len) {
  243. (*r_len) += sizeof(float) * 2;
  244. }
  245. }
  246. r_variant = val;
  247. } break;
  248. case Variant::VECTOR2I: {
  249. ERR_FAIL_COND_V(len < 4 * 2, ERR_INVALID_DATA);
  250. Vector2i val;
  251. val.x = decode_uint32(&buf[0]);
  252. val.y = decode_uint32(&buf[4]);
  253. r_variant = val;
  254. if (r_len) {
  255. (*r_len) += 4 * 2;
  256. }
  257. } break;
  258. case Variant::RECT2: {
  259. Rect2 val;
  260. if (header & HEADER_DATA_FLAG_64) {
  261. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 4, ERR_INVALID_DATA);
  262. val.position.x = decode_double(&buf[0]);
  263. val.position.y = decode_double(&buf[sizeof(double)]);
  264. val.size.x = decode_double(&buf[sizeof(double) * 2]);
  265. val.size.y = decode_double(&buf[sizeof(double) * 3]);
  266. if (r_len) {
  267. (*r_len) += sizeof(double) * 4;
  268. }
  269. } else {
  270. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 4, ERR_INVALID_DATA);
  271. val.position.x = decode_float(&buf[0]);
  272. val.position.y = decode_float(&buf[sizeof(float)]);
  273. val.size.x = decode_float(&buf[sizeof(float) * 2]);
  274. val.size.y = decode_float(&buf[sizeof(float) * 3]);
  275. if (r_len) {
  276. (*r_len) += sizeof(float) * 4;
  277. }
  278. }
  279. r_variant = val;
  280. } break;
  281. case Variant::RECT2I: {
  282. ERR_FAIL_COND_V(len < 4 * 4, ERR_INVALID_DATA);
  283. Rect2i val;
  284. val.position.x = decode_uint32(&buf[0]);
  285. val.position.y = decode_uint32(&buf[4]);
  286. val.size.x = decode_uint32(&buf[8]);
  287. val.size.y = decode_uint32(&buf[12]);
  288. r_variant = val;
  289. if (r_len) {
  290. (*r_len) += 4 * 4;
  291. }
  292. } break;
  293. case Variant::VECTOR3: {
  294. Vector3 val;
  295. if (header & HEADER_DATA_FLAG_64) {
  296. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 3, ERR_INVALID_DATA);
  297. val.x = decode_double(&buf[0]);
  298. val.y = decode_double(&buf[sizeof(double)]);
  299. val.z = decode_double(&buf[sizeof(double) * 2]);
  300. if (r_len) {
  301. (*r_len) += sizeof(double) * 3;
  302. }
  303. } else {
  304. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 3, ERR_INVALID_DATA);
  305. val.x = decode_float(&buf[0]);
  306. val.y = decode_float(&buf[sizeof(float)]);
  307. val.z = decode_float(&buf[sizeof(float) * 2]);
  308. if (r_len) {
  309. (*r_len) += sizeof(float) * 3;
  310. }
  311. }
  312. r_variant = val;
  313. } break;
  314. case Variant::VECTOR3I: {
  315. ERR_FAIL_COND_V(len < 4 * 3, ERR_INVALID_DATA);
  316. Vector3i val;
  317. val.x = decode_uint32(&buf[0]);
  318. val.y = decode_uint32(&buf[4]);
  319. val.z = decode_uint32(&buf[8]);
  320. r_variant = val;
  321. if (r_len) {
  322. (*r_len) += 4 * 3;
  323. }
  324. } break;
  325. case Variant::VECTOR4: {
  326. Vector4 val;
  327. if (header & HEADER_DATA_FLAG_64) {
  328. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 4, ERR_INVALID_DATA);
  329. val.x = decode_double(&buf[0]);
  330. val.y = decode_double(&buf[sizeof(double)]);
  331. val.z = decode_double(&buf[sizeof(double) * 2]);
  332. val.w = decode_double(&buf[sizeof(double) * 3]);
  333. if (r_len) {
  334. (*r_len) += sizeof(double) * 4;
  335. }
  336. } else {
  337. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 4, ERR_INVALID_DATA);
  338. val.x = decode_float(&buf[0]);
  339. val.y = decode_float(&buf[sizeof(float)]);
  340. val.z = decode_float(&buf[sizeof(float) * 2]);
  341. val.w = decode_float(&buf[sizeof(float) * 3]);
  342. if (r_len) {
  343. (*r_len) += sizeof(float) * 4;
  344. }
  345. }
  346. r_variant = val;
  347. } break;
  348. case Variant::VECTOR4I: {
  349. ERR_FAIL_COND_V(len < 4 * 4, ERR_INVALID_DATA);
  350. Vector4i val;
  351. val.x = decode_uint32(&buf[0]);
  352. val.y = decode_uint32(&buf[4]);
  353. val.z = decode_uint32(&buf[8]);
  354. val.w = decode_uint32(&buf[12]);
  355. r_variant = val;
  356. if (r_len) {
  357. (*r_len) += 4 * 4;
  358. }
  359. } break;
  360. case Variant::TRANSFORM2D: {
  361. Transform2D val;
  362. if (header & HEADER_DATA_FLAG_64) {
  363. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 6, ERR_INVALID_DATA);
  364. for (int i = 0; i < 3; i++) {
  365. for (int j = 0; j < 2; j++) {
  366. val.columns[i][j] = decode_double(&buf[(i * 2 + j) * sizeof(double)]);
  367. }
  368. }
  369. if (r_len) {
  370. (*r_len) += sizeof(double) * 6;
  371. }
  372. } else {
  373. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 6, ERR_INVALID_DATA);
  374. for (int i = 0; i < 3; i++) {
  375. for (int j = 0; j < 2; j++) {
  376. val.columns[i][j] = decode_float(&buf[(i * 2 + j) * sizeof(float)]);
  377. }
  378. }
  379. if (r_len) {
  380. (*r_len) += sizeof(float) * 6;
  381. }
  382. }
  383. r_variant = val;
  384. } break;
  385. case Variant::PLANE: {
  386. Plane val;
  387. if (header & HEADER_DATA_FLAG_64) {
  388. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 4, ERR_INVALID_DATA);
  389. val.normal.x = decode_double(&buf[0]);
  390. val.normal.y = decode_double(&buf[sizeof(double)]);
  391. val.normal.z = decode_double(&buf[sizeof(double) * 2]);
  392. val.d = decode_double(&buf[sizeof(double) * 3]);
  393. if (r_len) {
  394. (*r_len) += sizeof(double) * 4;
  395. }
  396. } else {
  397. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 4, ERR_INVALID_DATA);
  398. val.normal.x = decode_float(&buf[0]);
  399. val.normal.y = decode_float(&buf[sizeof(float)]);
  400. val.normal.z = decode_float(&buf[sizeof(float) * 2]);
  401. val.d = decode_float(&buf[sizeof(float) * 3]);
  402. if (r_len) {
  403. (*r_len) += sizeof(float) * 4;
  404. }
  405. }
  406. r_variant = val;
  407. } break;
  408. case Variant::QUATERNION: {
  409. Quaternion val;
  410. if (header & HEADER_DATA_FLAG_64) {
  411. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 4, ERR_INVALID_DATA);
  412. val.x = decode_double(&buf[0]);
  413. val.y = decode_double(&buf[sizeof(double)]);
  414. val.z = decode_double(&buf[sizeof(double) * 2]);
  415. val.w = decode_double(&buf[sizeof(double) * 3]);
  416. if (r_len) {
  417. (*r_len) += sizeof(double) * 4;
  418. }
  419. } else {
  420. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 4, ERR_INVALID_DATA);
  421. val.x = decode_float(&buf[0]);
  422. val.y = decode_float(&buf[sizeof(float)]);
  423. val.z = decode_float(&buf[sizeof(float) * 2]);
  424. val.w = decode_float(&buf[sizeof(float) * 3]);
  425. if (r_len) {
  426. (*r_len) += sizeof(float) * 4;
  427. }
  428. }
  429. r_variant = val;
  430. } break;
  431. case Variant::AABB: {
  432. AABB val;
  433. if (header & HEADER_DATA_FLAG_64) {
  434. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 6, ERR_INVALID_DATA);
  435. val.position.x = decode_double(&buf[0]);
  436. val.position.y = decode_double(&buf[sizeof(double)]);
  437. val.position.z = decode_double(&buf[sizeof(double) * 2]);
  438. val.size.x = decode_double(&buf[sizeof(double) * 3]);
  439. val.size.y = decode_double(&buf[sizeof(double) * 4]);
  440. val.size.z = decode_double(&buf[sizeof(double) * 5]);
  441. if (r_len) {
  442. (*r_len) += sizeof(double) * 6;
  443. }
  444. } else {
  445. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 6, ERR_INVALID_DATA);
  446. val.position.x = decode_float(&buf[0]);
  447. val.position.y = decode_float(&buf[sizeof(float)]);
  448. val.position.z = decode_float(&buf[sizeof(float) * 2]);
  449. val.size.x = decode_float(&buf[sizeof(float) * 3]);
  450. val.size.y = decode_float(&buf[sizeof(float) * 4]);
  451. val.size.z = decode_float(&buf[sizeof(float) * 5]);
  452. if (r_len) {
  453. (*r_len) += sizeof(float) * 6;
  454. }
  455. }
  456. r_variant = val;
  457. } break;
  458. case Variant::BASIS: {
  459. Basis val;
  460. if (header & HEADER_DATA_FLAG_64) {
  461. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 9, ERR_INVALID_DATA);
  462. for (int i = 0; i < 3; i++) {
  463. for (int j = 0; j < 3; j++) {
  464. val.rows[i][j] = decode_double(&buf[(i * 3 + j) * sizeof(double)]);
  465. }
  466. }
  467. if (r_len) {
  468. (*r_len) += sizeof(double) * 9;
  469. }
  470. } else {
  471. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 9, ERR_INVALID_DATA);
  472. for (int i = 0; i < 3; i++) {
  473. for (int j = 0; j < 3; j++) {
  474. val.rows[i][j] = decode_float(&buf[(i * 3 + j) * sizeof(float)]);
  475. }
  476. }
  477. if (r_len) {
  478. (*r_len) += sizeof(float) * 9;
  479. }
  480. }
  481. r_variant = val;
  482. } break;
  483. case Variant::TRANSFORM3D: {
  484. Transform3D val;
  485. if (header & HEADER_DATA_FLAG_64) {
  486. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 12, ERR_INVALID_DATA);
  487. for (int i = 0; i < 3; i++) {
  488. for (int j = 0; j < 3; j++) {
  489. val.basis.rows[i][j] = decode_double(&buf[(i * 3 + j) * sizeof(double)]);
  490. }
  491. }
  492. val.origin[0] = decode_double(&buf[sizeof(double) * 9]);
  493. val.origin[1] = decode_double(&buf[sizeof(double) * 10]);
  494. val.origin[2] = decode_double(&buf[sizeof(double) * 11]);
  495. if (r_len) {
  496. (*r_len) += sizeof(double) * 12;
  497. }
  498. } else {
  499. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 12, ERR_INVALID_DATA);
  500. for (int i = 0; i < 3; i++) {
  501. for (int j = 0; j < 3; j++) {
  502. val.basis.rows[i][j] = decode_float(&buf[(i * 3 + j) * sizeof(float)]);
  503. }
  504. }
  505. val.origin[0] = decode_float(&buf[sizeof(float) * 9]);
  506. val.origin[1] = decode_float(&buf[sizeof(float) * 10]);
  507. val.origin[2] = decode_float(&buf[sizeof(float) * 11]);
  508. if (r_len) {
  509. (*r_len) += sizeof(float) * 12;
  510. }
  511. }
  512. r_variant = val;
  513. } break;
  514. case Variant::PROJECTION: {
  515. Projection val;
  516. if (header & HEADER_DATA_FLAG_64) {
  517. ERR_FAIL_COND_V((size_t)len < sizeof(double) * 16, ERR_INVALID_DATA);
  518. for (int i = 0; i < 4; i++) {
  519. for (int j = 0; j < 4; j++) {
  520. val.columns[i][j] = decode_double(&buf[(i * 4 + j) * sizeof(double)]);
  521. }
  522. }
  523. if (r_len) {
  524. (*r_len) += sizeof(double) * 16;
  525. }
  526. } else {
  527. ERR_FAIL_COND_V((size_t)len < sizeof(float) * 16, ERR_INVALID_DATA);
  528. for (int i = 0; i < 4; i++) {
  529. for (int j = 0; j < 4; j++) {
  530. val.columns[i][j] = decode_float(&buf[(i * 4 + j) * sizeof(float)]);
  531. }
  532. }
  533. if (r_len) {
  534. (*r_len) += sizeof(float) * 16;
  535. }
  536. }
  537. r_variant = val;
  538. } break;
  539. // Misc types.
  540. case Variant::COLOR: {
  541. ERR_FAIL_COND_V(len < 4 * 4, ERR_INVALID_DATA);
  542. Color val;
  543. val.r = decode_float(&buf[0]);
  544. val.g = decode_float(&buf[4]);
  545. val.b = decode_float(&buf[8]);
  546. val.a = decode_float(&buf[12]);
  547. r_variant = val;
  548. if (r_len) {
  549. (*r_len) += 4 * 4; // Colors should always be in single-precision.
  550. }
  551. } break;
  552. case Variant::STRING_NAME: {
  553. String str;
  554. Error err = _decode_string(buf, len, r_len, str);
  555. if (err) {
  556. return err;
  557. }
  558. r_variant = StringName(str);
  559. } break;
  560. case Variant::NODE_PATH: {
  561. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  562. int32_t strlen = decode_uint32(buf);
  563. if (strlen & 0x80000000) {
  564. // New format.
  565. ERR_FAIL_COND_V(len < 12, ERR_INVALID_DATA);
  566. Vector<StringName> names;
  567. Vector<StringName> subnames;
  568. uint32_t namecount = strlen &= 0x7FFFFFFF;
  569. uint32_t subnamecount = decode_uint32(buf + 4);
  570. uint32_t np_flags = decode_uint32(buf + 8);
  571. len -= 12;
  572. buf += 12;
  573. if (np_flags & 2) { // Obsolete format with property separate from subpath.
  574. subnamecount++;
  575. }
  576. uint32_t total = namecount + subnamecount;
  577. if (r_len) {
  578. (*r_len) += 12;
  579. }
  580. for (uint32_t i = 0; i < total; i++) {
  581. String str;
  582. Error err = _decode_string(buf, len, r_len, str);
  583. if (err) {
  584. return err;
  585. }
  586. if (i < namecount) {
  587. names.push_back(str);
  588. } else {
  589. subnames.push_back(str);
  590. }
  591. }
  592. r_variant = NodePath(names, subnames, np_flags & 1);
  593. } else {
  594. // Old format, just a string.
  595. ERR_FAIL_V(ERR_INVALID_DATA);
  596. }
  597. } break;
  598. case Variant::RID: {
  599. ERR_FAIL_COND_V(len < 8, ERR_INVALID_DATA);
  600. uint64_t id = decode_uint64(buf);
  601. if (r_len) {
  602. (*r_len) += 8;
  603. }
  604. r_variant = RID::from_uint64(id);
  605. } break;
  606. case Variant::OBJECT: {
  607. if (header & HEADER_DATA_FLAG_OBJECT_AS_ID) {
  608. // This _is_ allowed.
  609. ERR_FAIL_COND_V(len < 8, ERR_INVALID_DATA);
  610. ObjectID val = ObjectID(decode_uint64(buf));
  611. if (r_len) {
  612. (*r_len) += 8;
  613. }
  614. if (val.is_null()) {
  615. r_variant = (Object *)nullptr;
  616. } else {
  617. Ref<EncodedObjectAsID> obj_as_id;
  618. obj_as_id.instantiate();
  619. obj_as_id->set_object_id(val);
  620. r_variant = obj_as_id;
  621. }
  622. } else {
  623. ERR_FAIL_COND_V(!p_allow_objects, ERR_UNAUTHORIZED);
  624. String str;
  625. Error err = _decode_string(buf, len, r_len, str);
  626. if (err) {
  627. return err;
  628. }
  629. if (str.is_empty()) {
  630. r_variant = (Object *)nullptr;
  631. } else {
  632. ERR_FAIL_COND_V(!ClassDB::can_instantiate(str), ERR_INVALID_DATA);
  633. Object *obj = ClassDB::instantiate(str);
  634. ERR_FAIL_NULL_V(obj, ERR_UNAVAILABLE);
  635. // Avoid premature free `RefCounted`. This must be done before properties are initialized,
  636. // since script functions (setters, implicit initializer) may be called. See GH-68666.
  637. Variant variant;
  638. if (Object::cast_to<RefCounted>(obj)) {
  639. Ref<RefCounted> ref = Ref<RefCounted>(Object::cast_to<RefCounted>(obj));
  640. variant = ref;
  641. } else {
  642. variant = obj;
  643. }
  644. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  645. int32_t count = decode_uint32(buf);
  646. buf += 4;
  647. len -= 4;
  648. if (r_len) {
  649. (*r_len) += 4; // Size of count number.
  650. }
  651. for (int i = 0; i < count; i++) {
  652. str = String();
  653. err = _decode_string(buf, len, r_len, str);
  654. if (err) {
  655. return err;
  656. }
  657. Variant value;
  658. int used;
  659. err = decode_variant(value, buf, len, &used, p_allow_objects, p_depth + 1);
  660. if (err) {
  661. return err;
  662. }
  663. buf += used;
  664. len -= used;
  665. if (r_len) {
  666. (*r_len) += used;
  667. }
  668. if (str == "script" && value.get_type() != Variant::NIL) {
  669. ERR_FAIL_COND_V_MSG(value.get_type() != Variant::STRING, ERR_INVALID_DATA, "Invalid value for \"script\" property, expected script path as String.");
  670. String path = value;
  671. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://") || !ResourceLoader::exists(path, "Script"), ERR_INVALID_DATA, vformat("Invalid script path \"%s\".", path));
  672. Ref<Script> script = ResourceLoader::load(path, "Script");
  673. ERR_FAIL_COND_V_MSG(script.is_null(), ERR_INVALID_DATA, vformat("Can't load script at path \"%s\".", path));
  674. obj->set_script(script);
  675. } else {
  676. obj->set(str, value);
  677. }
  678. }
  679. r_variant = variant;
  680. }
  681. }
  682. } break;
  683. case Variant::CALLABLE: {
  684. r_variant = Callable();
  685. } break;
  686. case Variant::SIGNAL: {
  687. String name;
  688. Error err = _decode_string(buf, len, r_len, name);
  689. if (err) {
  690. return err;
  691. }
  692. ERR_FAIL_COND_V(len < 8, ERR_INVALID_DATA);
  693. ObjectID id = ObjectID(decode_uint64(buf));
  694. if (r_len) {
  695. (*r_len) += 8;
  696. }
  697. r_variant = Signal(id, StringName(name));
  698. } break;
  699. case Variant::DICTIONARY: {
  700. ContainerType key_type;
  701. {
  702. ContainerTypeKind key_type_kind = GET_CONTAINER_TYPE_KIND(header, TYPED_DICTIONARY_KEY);
  703. Error err = _decode_container_type(buf, len, r_len, p_allow_objects, key_type_kind, key_type);
  704. if (err) {
  705. return err;
  706. }
  707. }
  708. ContainerType value_type;
  709. {
  710. ContainerTypeKind value_type_kind = GET_CONTAINER_TYPE_KIND(header, TYPED_DICTIONARY_VALUE);
  711. Error err = _decode_container_type(buf, len, r_len, p_allow_objects, value_type_kind, value_type);
  712. if (err) {
  713. return err;
  714. }
  715. }
  716. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  717. int32_t count = decode_uint32(buf);
  718. //bool shared = count & 0x80000000;
  719. count &= 0x7FFFFFFF;
  720. buf += 4;
  721. len -= 4;
  722. if (r_len) {
  723. (*r_len) += 4; // Size of count number.
  724. }
  725. Dictionary dict;
  726. if (key_type.builtin_type != Variant::NIL || value_type.builtin_type != Variant::NIL) {
  727. dict.set_typed(key_type.builtin_type, key_type.class_name, key_type.script, value_type.builtin_type, value_type.class_name, value_type.script);
  728. }
  729. for (int i = 0; i < count; i++) {
  730. Variant key, value;
  731. int used;
  732. Error err = decode_variant(key, buf, len, &used, p_allow_objects, p_depth + 1);
  733. ERR_FAIL_COND_V_MSG(err != OK, err, "Error when trying to decode Variant.");
  734. buf += used;
  735. len -= used;
  736. if (r_len) {
  737. (*r_len) += used;
  738. }
  739. err = decode_variant(value, buf, len, &used, p_allow_objects, p_depth + 1);
  740. ERR_FAIL_COND_V_MSG(err != OK, err, "Error when trying to decode Variant.");
  741. buf += used;
  742. len -= used;
  743. if (r_len) {
  744. (*r_len) += used;
  745. }
  746. dict[key] = value;
  747. }
  748. r_variant = dict;
  749. } break;
  750. case Variant::ARRAY: {
  751. ContainerType type;
  752. {
  753. ContainerTypeKind type_kind = GET_CONTAINER_TYPE_KIND(header, TYPED_ARRAY);
  754. Error err = _decode_container_type(buf, len, r_len, p_allow_objects, type_kind, type);
  755. if (err) {
  756. return err;
  757. }
  758. }
  759. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  760. int32_t count = decode_uint32(buf);
  761. //bool shared = count & 0x80000000;
  762. count &= 0x7FFFFFFF;
  763. buf += 4;
  764. len -= 4;
  765. if (r_len) {
  766. (*r_len) += 4; // Size of count number.
  767. }
  768. Array array;
  769. if (type.builtin_type != Variant::NIL) {
  770. array.set_typed(type.builtin_type, type.class_name, type.script);
  771. }
  772. for (int i = 0; i < count; i++) {
  773. int used = 0;
  774. Variant elem;
  775. Error err = decode_variant(elem, buf, len, &used, p_allow_objects, p_depth + 1);
  776. ERR_FAIL_COND_V_MSG(err != OK, err, "Error when trying to decode Variant.");
  777. buf += used;
  778. len -= used;
  779. array.push_back(elem);
  780. if (r_len) {
  781. (*r_len) += used;
  782. }
  783. }
  784. r_variant = array;
  785. } break;
  786. // Packed arrays.
  787. case Variant::PACKED_BYTE_ARRAY: {
  788. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  789. int32_t count = decode_uint32(buf);
  790. buf += 4;
  791. len -= 4;
  792. ERR_FAIL_COND_V(count < 0 || count > len, ERR_INVALID_DATA);
  793. Vector<uint8_t> data;
  794. if (count) {
  795. data.resize(count);
  796. uint8_t *w = data.ptrw();
  797. for (int32_t i = 0; i < count; i++) {
  798. w[i] = buf[i];
  799. }
  800. }
  801. r_variant = data;
  802. if (r_len) {
  803. if (count % 4) {
  804. (*r_len) += 4 - count % 4;
  805. }
  806. (*r_len) += 4 + count;
  807. }
  808. } break;
  809. case Variant::PACKED_INT32_ARRAY: {
  810. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  811. int32_t count = decode_uint32(buf);
  812. buf += 4;
  813. len -= 4;
  814. ERR_FAIL_MUL_OF(count, 4, ERR_INVALID_DATA);
  815. ERR_FAIL_COND_V(count < 0 || count * 4 > len, ERR_INVALID_DATA);
  816. Vector<int32_t> data;
  817. if (count) {
  818. //const int *rbuf = (const int *)buf;
  819. data.resize(count);
  820. int32_t *w = data.ptrw();
  821. for (int32_t i = 0; i < count; i++) {
  822. w[i] = decode_uint32(&buf[i * 4]);
  823. }
  824. }
  825. r_variant = Variant(data);
  826. if (r_len) {
  827. (*r_len) += 4 + count * sizeof(int32_t);
  828. }
  829. } break;
  830. case Variant::PACKED_INT64_ARRAY: {
  831. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  832. int32_t count = decode_uint32(buf);
  833. buf += 4;
  834. len -= 4;
  835. ERR_FAIL_MUL_OF(count, 8, ERR_INVALID_DATA);
  836. ERR_FAIL_COND_V(count < 0 || count * 8 > len, ERR_INVALID_DATA);
  837. Vector<int64_t> data;
  838. if (count) {
  839. //const int *rbuf = (const int *)buf;
  840. data.resize(count);
  841. int64_t *w = data.ptrw();
  842. for (int64_t i = 0; i < count; i++) {
  843. w[i] = decode_uint64(&buf[i * 8]);
  844. }
  845. }
  846. r_variant = Variant(data);
  847. if (r_len) {
  848. (*r_len) += 4 + count * sizeof(int64_t);
  849. }
  850. } break;
  851. case Variant::PACKED_FLOAT32_ARRAY: {
  852. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  853. int32_t count = decode_uint32(buf);
  854. buf += 4;
  855. len -= 4;
  856. ERR_FAIL_MUL_OF(count, 4, ERR_INVALID_DATA);
  857. ERR_FAIL_COND_V(count < 0 || count * 4 > len, ERR_INVALID_DATA);
  858. Vector<float> data;
  859. if (count) {
  860. //const float *rbuf = (const float *)buf;
  861. data.resize(count);
  862. float *w = data.ptrw();
  863. for (int32_t i = 0; i < count; i++) {
  864. w[i] = decode_float(&buf[i * 4]);
  865. }
  866. }
  867. r_variant = data;
  868. if (r_len) {
  869. (*r_len) += 4 + count * sizeof(float);
  870. }
  871. } break;
  872. case Variant::PACKED_FLOAT64_ARRAY: {
  873. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  874. int32_t count = decode_uint32(buf);
  875. buf += 4;
  876. len -= 4;
  877. ERR_FAIL_MUL_OF(count, 8, ERR_INVALID_DATA);
  878. ERR_FAIL_COND_V(count < 0 || count * 8 > len, ERR_INVALID_DATA);
  879. Vector<double> data;
  880. if (count) {
  881. data.resize(count);
  882. double *w = data.ptrw();
  883. for (int64_t i = 0; i < count; i++) {
  884. w[i] = decode_double(&buf[i * 8]);
  885. }
  886. }
  887. r_variant = data;
  888. if (r_len) {
  889. (*r_len) += 4 + count * sizeof(double);
  890. }
  891. } break;
  892. case Variant::PACKED_STRING_ARRAY: {
  893. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  894. int32_t count = decode_uint32(buf);
  895. Vector<String> strings;
  896. buf += 4;
  897. len -= 4;
  898. if (r_len) {
  899. (*r_len) += 4; // Size of count number.
  900. }
  901. for (int32_t i = 0; i < count; i++) {
  902. String str;
  903. Error err = _decode_string(buf, len, r_len, str);
  904. if (err) {
  905. return err;
  906. }
  907. strings.push_back(str);
  908. }
  909. r_variant = strings;
  910. } break;
  911. case Variant::PACKED_VECTOR2_ARRAY: {
  912. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  913. int32_t count = decode_uint32(buf);
  914. buf += 4;
  915. len -= 4;
  916. Vector<Vector2> varray;
  917. if (header & HEADER_DATA_FLAG_64) {
  918. ERR_FAIL_MUL_OF(count, sizeof(double) * 2, ERR_INVALID_DATA);
  919. ERR_FAIL_COND_V(count < 0 || count * sizeof(double) * 2 > (size_t)len, ERR_INVALID_DATA);
  920. if (r_len) {
  921. (*r_len) += 4; // Size of count number.
  922. }
  923. if (count) {
  924. varray.resize(count);
  925. Vector2 *w = varray.ptrw();
  926. for (int32_t i = 0; i < count; i++) {
  927. w[i].x = decode_double(buf + i * sizeof(double) * 2 + sizeof(double) * 0);
  928. w[i].y = decode_double(buf + i * sizeof(double) * 2 + sizeof(double) * 1);
  929. }
  930. int adv = sizeof(double) * 2 * count;
  931. if (r_len) {
  932. (*r_len) += adv;
  933. }
  934. len -= adv;
  935. buf += adv;
  936. }
  937. } else {
  938. ERR_FAIL_MUL_OF(count, sizeof(float) * 2, ERR_INVALID_DATA);
  939. ERR_FAIL_COND_V(count < 0 || count * sizeof(float) * 2 > (size_t)len, ERR_INVALID_DATA);
  940. if (r_len) {
  941. (*r_len) += 4; // Size of count number.
  942. }
  943. if (count) {
  944. varray.resize(count);
  945. Vector2 *w = varray.ptrw();
  946. for (int32_t i = 0; i < count; i++) {
  947. w[i].x = decode_float(buf + i * sizeof(float) * 2 + sizeof(float) * 0);
  948. w[i].y = decode_float(buf + i * sizeof(float) * 2 + sizeof(float) * 1);
  949. }
  950. int adv = sizeof(float) * 2 * count;
  951. if (r_len) {
  952. (*r_len) += adv;
  953. }
  954. }
  955. }
  956. r_variant = varray;
  957. } break;
  958. case Variant::PACKED_VECTOR3_ARRAY: {
  959. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  960. int32_t count = decode_uint32(buf);
  961. buf += 4;
  962. len -= 4;
  963. Vector<Vector3> varray;
  964. if (header & HEADER_DATA_FLAG_64) {
  965. ERR_FAIL_MUL_OF(count, sizeof(double) * 3, ERR_INVALID_DATA);
  966. ERR_FAIL_COND_V(count < 0 || count * sizeof(double) * 3 > (size_t)len, ERR_INVALID_DATA);
  967. if (r_len) {
  968. (*r_len) += 4; // Size of count number.
  969. }
  970. if (count) {
  971. varray.resize(count);
  972. Vector3 *w = varray.ptrw();
  973. for (int32_t i = 0; i < count; i++) {
  974. w[i].x = decode_double(buf + i * sizeof(double) * 3 + sizeof(double) * 0);
  975. w[i].y = decode_double(buf + i * sizeof(double) * 3 + sizeof(double) * 1);
  976. w[i].z = decode_double(buf + i * sizeof(double) * 3 + sizeof(double) * 2);
  977. }
  978. int adv = sizeof(double) * 3 * count;
  979. if (r_len) {
  980. (*r_len) += adv;
  981. }
  982. len -= adv;
  983. buf += adv;
  984. }
  985. } else {
  986. ERR_FAIL_MUL_OF(count, sizeof(float) * 3, ERR_INVALID_DATA);
  987. ERR_FAIL_COND_V(count < 0 || count * sizeof(float) * 3 > (size_t)len, ERR_INVALID_DATA);
  988. if (r_len) {
  989. (*r_len) += 4; // Size of count number.
  990. }
  991. if (count) {
  992. varray.resize(count);
  993. Vector3 *w = varray.ptrw();
  994. for (int32_t i = 0; i < count; i++) {
  995. w[i].x = decode_float(buf + i * sizeof(float) * 3 + sizeof(float) * 0);
  996. w[i].y = decode_float(buf + i * sizeof(float) * 3 + sizeof(float) * 1);
  997. w[i].z = decode_float(buf + i * sizeof(float) * 3 + sizeof(float) * 2);
  998. }
  999. int adv = sizeof(float) * 3 * count;
  1000. if (r_len) {
  1001. (*r_len) += adv;
  1002. }
  1003. len -= adv;
  1004. buf += adv;
  1005. }
  1006. }
  1007. r_variant = varray;
  1008. } break;
  1009. case Variant::PACKED_COLOR_ARRAY: {
  1010. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  1011. int32_t count = decode_uint32(buf);
  1012. buf += 4;
  1013. len -= 4;
  1014. ERR_FAIL_MUL_OF(count, 4 * 4, ERR_INVALID_DATA);
  1015. ERR_FAIL_COND_V(count < 0 || count * 4 * 4 > len, ERR_INVALID_DATA);
  1016. Vector<Color> carray;
  1017. if (r_len) {
  1018. (*r_len) += 4; // Size of count number.
  1019. }
  1020. if (count) {
  1021. carray.resize(count);
  1022. Color *w = carray.ptrw();
  1023. for (int32_t i = 0; i < count; i++) {
  1024. // Colors should always be in single-precision.
  1025. w[i].r = decode_float(buf + i * 4 * 4 + 4 * 0);
  1026. w[i].g = decode_float(buf + i * 4 * 4 + 4 * 1);
  1027. w[i].b = decode_float(buf + i * 4 * 4 + 4 * 2);
  1028. w[i].a = decode_float(buf + i * 4 * 4 + 4 * 3);
  1029. }
  1030. int adv = 4 * 4 * count;
  1031. if (r_len) {
  1032. (*r_len) += adv;
  1033. }
  1034. }
  1035. r_variant = carray;
  1036. } break;
  1037. case Variant::PACKED_VECTOR4_ARRAY: {
  1038. ERR_FAIL_COND_V(len < 4, ERR_INVALID_DATA);
  1039. int32_t count = decode_uint32(buf);
  1040. buf += 4;
  1041. len -= 4;
  1042. Vector<Vector4> varray;
  1043. if (header & HEADER_DATA_FLAG_64) {
  1044. ERR_FAIL_MUL_OF(count, sizeof(double) * 4, ERR_INVALID_DATA);
  1045. ERR_FAIL_COND_V(count < 0 || count * sizeof(double) * 4 > (size_t)len, ERR_INVALID_DATA);
  1046. if (r_len) {
  1047. (*r_len) += 4; // Size of count number.
  1048. }
  1049. if (count) {
  1050. varray.resize(count);
  1051. Vector4 *w = varray.ptrw();
  1052. for (int32_t i = 0; i < count; i++) {
  1053. w[i].x = decode_double(buf + i * sizeof(double) * 4 + sizeof(double) * 0);
  1054. w[i].y = decode_double(buf + i * sizeof(double) * 4 + sizeof(double) * 1);
  1055. w[i].z = decode_double(buf + i * sizeof(double) * 4 + sizeof(double) * 2);
  1056. w[i].w = decode_double(buf + i * sizeof(double) * 4 + sizeof(double) * 3);
  1057. }
  1058. int adv = sizeof(double) * 4 * count;
  1059. if (r_len) {
  1060. (*r_len) += adv;
  1061. }
  1062. len -= adv;
  1063. buf += adv;
  1064. }
  1065. } else {
  1066. ERR_FAIL_MUL_OF(count, sizeof(float) * 4, ERR_INVALID_DATA);
  1067. ERR_FAIL_COND_V(count < 0 || count * sizeof(float) * 4 > (size_t)len, ERR_INVALID_DATA);
  1068. if (r_len) {
  1069. (*r_len) += 4; // Size of count number.
  1070. }
  1071. if (count) {
  1072. varray.resize(count);
  1073. Vector4 *w = varray.ptrw();
  1074. for (int32_t i = 0; i < count; i++) {
  1075. w[i].x = decode_float(buf + i * sizeof(float) * 4 + sizeof(float) * 0);
  1076. w[i].y = decode_float(buf + i * sizeof(float) * 4 + sizeof(float) * 1);
  1077. w[i].z = decode_float(buf + i * sizeof(float) * 4 + sizeof(float) * 2);
  1078. w[i].w = decode_float(buf + i * sizeof(float) * 4 + sizeof(float) * 3);
  1079. }
  1080. int adv = sizeof(float) * 4 * count;
  1081. if (r_len) {
  1082. (*r_len) += adv;
  1083. }
  1084. len -= adv;
  1085. buf += adv;
  1086. }
  1087. }
  1088. r_variant = varray;
  1089. } break;
  1090. default: {
  1091. ERR_FAIL_V(ERR_BUG);
  1092. }
  1093. }
  1094. return OK;
  1095. }
  1096. static void _encode_string(const String &p_string, uint8_t *&buf, int &r_len) {
  1097. CharString utf8 = p_string.utf8();
  1098. if (buf) {
  1099. encode_uint32(utf8.length(), buf);
  1100. buf += 4;
  1101. memcpy(buf, utf8.get_data(), utf8.length());
  1102. buf += utf8.length();
  1103. }
  1104. r_len += 4 + utf8.length();
  1105. while (r_len % 4) {
  1106. r_len++; // Pad.
  1107. if (buf) {
  1108. *(buf++) = 0;
  1109. }
  1110. }
  1111. }
  1112. static void _encode_container_type_header(const ContainerType &p_type, uint32_t &header, uint32_t p_shift, bool p_full_objects) {
  1113. if (p_type.builtin_type != Variant::NIL) {
  1114. if (p_type.script.is_valid()) {
  1115. header |= (p_full_objects ? CONTAINER_TYPE_KIND_SCRIPT : CONTAINER_TYPE_KIND_CLASS_NAME) << p_shift;
  1116. } else if (p_type.class_name != StringName()) {
  1117. header |= CONTAINER_TYPE_KIND_CLASS_NAME << p_shift;
  1118. } else {
  1119. // No need to check `p_full_objects` since `class_name` should be non-empty for `builtin_type == Variant::OBJECT`.
  1120. header |= CONTAINER_TYPE_KIND_BUILTIN << p_shift;
  1121. }
  1122. }
  1123. }
  1124. static Error _encode_container_type(const ContainerType &p_type, uint8_t *&buf, int &r_len, bool p_full_objects) {
  1125. if (p_type.builtin_type != Variant::NIL) {
  1126. if (p_type.script.is_valid()) {
  1127. if (p_full_objects) {
  1128. String path = p_type.script->get_path();
  1129. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://"), ERR_UNAVAILABLE, "Failed to encode a path to a custom script for a container type.");
  1130. _encode_string(path, buf, r_len);
  1131. } else {
  1132. _encode_string(EncodedObjectAsID::get_class_static(), buf, r_len);
  1133. }
  1134. } else if (p_type.class_name != StringName()) {
  1135. _encode_string(p_full_objects ? p_type.class_name.operator String() : EncodedObjectAsID::get_class_static(), buf, r_len);
  1136. } else {
  1137. // No need to check `p_full_objects` since `class_name` should be non-empty for `builtin_type == Variant::OBJECT`.
  1138. if (buf) {
  1139. encode_uint32(p_type.builtin_type, buf);
  1140. buf += 4;
  1141. }
  1142. r_len += 4;
  1143. }
  1144. }
  1145. return OK;
  1146. }
  1147. Error encode_variant(const Variant &p_variant, uint8_t *r_buffer, int &r_len, bool p_full_objects, int p_depth) {
  1148. ERR_FAIL_COND_V_MSG(p_depth > Variant::MAX_RECURSION_DEPTH, ERR_OUT_OF_MEMORY, "Potential infinite recursion detected. Bailing.");
  1149. uint8_t *buf = r_buffer;
  1150. r_len = 0;
  1151. uint32_t header = p_variant.get_type();
  1152. switch (p_variant.get_type()) {
  1153. case Variant::INT: {
  1154. int64_t val = p_variant;
  1155. if (val > (int64_t)INT_MAX || val < (int64_t)INT_MIN) {
  1156. header |= HEADER_DATA_FLAG_64;
  1157. }
  1158. } break;
  1159. case Variant::FLOAT: {
  1160. double d = p_variant;
  1161. float f = d;
  1162. if (double(f) != d) {
  1163. header |= HEADER_DATA_FLAG_64;
  1164. }
  1165. } break;
  1166. case Variant::OBJECT: {
  1167. // Test for potential wrong values sent by the debugger when it breaks.
  1168. Object *obj = p_variant.get_validated_object();
  1169. if (!obj) {
  1170. // Object is invalid, send a nullptr instead.
  1171. if (buf) {
  1172. encode_uint32(Variant::NIL, buf);
  1173. }
  1174. r_len += 4;
  1175. return OK;
  1176. }
  1177. if (!p_full_objects) {
  1178. header |= HEADER_DATA_FLAG_OBJECT_AS_ID;
  1179. }
  1180. } break;
  1181. case Variant::DICTIONARY: {
  1182. Dictionary dict = p_variant;
  1183. ContainerType key_type;
  1184. key_type.builtin_type = (Variant::Type)dict.get_typed_key_builtin();
  1185. key_type.class_name = dict.get_typed_key_class_name();
  1186. key_type.script = dict.get_typed_key_script();
  1187. _encode_container_type_header(key_type, header, HEADER_DATA_FIELD_TYPED_DICTIONARY_KEY_SHIFT, p_full_objects);
  1188. ContainerType value_type;
  1189. value_type.builtin_type = (Variant::Type)dict.get_typed_value_builtin();
  1190. value_type.class_name = dict.get_typed_value_class_name();
  1191. value_type.script = dict.get_typed_value_script();
  1192. _encode_container_type_header(value_type, header, HEADER_DATA_FIELD_TYPED_DICTIONARY_VALUE_SHIFT, p_full_objects);
  1193. } break;
  1194. case Variant::ARRAY: {
  1195. Array array = p_variant;
  1196. ContainerType type;
  1197. type.builtin_type = (Variant::Type)array.get_typed_builtin();
  1198. type.class_name = array.get_typed_class_name();
  1199. type.script = array.get_typed_script();
  1200. _encode_container_type_header(type, header, HEADER_DATA_FIELD_TYPED_ARRAY_SHIFT, p_full_objects);
  1201. } break;
  1202. #ifdef REAL_T_IS_DOUBLE
  1203. case Variant::VECTOR2:
  1204. case Variant::VECTOR3:
  1205. case Variant::VECTOR4:
  1206. case Variant::PACKED_VECTOR2_ARRAY:
  1207. case Variant::PACKED_VECTOR3_ARRAY:
  1208. case Variant::PACKED_VECTOR4_ARRAY:
  1209. case Variant::TRANSFORM2D:
  1210. case Variant::TRANSFORM3D:
  1211. case Variant::PROJECTION:
  1212. case Variant::QUATERNION:
  1213. case Variant::PLANE:
  1214. case Variant::BASIS:
  1215. case Variant::RECT2:
  1216. case Variant::AABB: {
  1217. header |= HEADER_DATA_FLAG_64;
  1218. } break;
  1219. #endif // REAL_T_IS_DOUBLE
  1220. default: {
  1221. // Nothing to do at this stage.
  1222. } break;
  1223. }
  1224. if (buf) {
  1225. encode_uint32(header, buf);
  1226. buf += 4;
  1227. }
  1228. r_len += 4;
  1229. switch (p_variant.get_type()) {
  1230. case Variant::NIL: {
  1231. // Nothing to do.
  1232. } break;
  1233. case Variant::BOOL: {
  1234. if (buf) {
  1235. encode_uint32(p_variant.operator bool(), buf);
  1236. }
  1237. r_len += 4;
  1238. } break;
  1239. case Variant::INT: {
  1240. if (header & HEADER_DATA_FLAG_64) {
  1241. // 64 bits.
  1242. if (buf) {
  1243. encode_uint64(p_variant.operator int64_t(), buf);
  1244. }
  1245. r_len += 8;
  1246. } else {
  1247. if (buf) {
  1248. encode_uint32(p_variant.operator int32_t(), buf);
  1249. }
  1250. r_len += 4;
  1251. }
  1252. } break;
  1253. case Variant::FLOAT: {
  1254. if (header & HEADER_DATA_FLAG_64) {
  1255. if (buf) {
  1256. encode_double(p_variant.operator double(), buf);
  1257. }
  1258. r_len += 8;
  1259. } else {
  1260. if (buf) {
  1261. encode_float(p_variant.operator float(), buf);
  1262. }
  1263. r_len += 4;
  1264. }
  1265. } break;
  1266. case Variant::NODE_PATH: {
  1267. NodePath np = p_variant;
  1268. if (buf) {
  1269. encode_uint32(uint32_t(np.get_name_count()) | 0x80000000, buf); // For compatibility with the old format.
  1270. encode_uint32(np.get_subname_count(), buf + 4);
  1271. uint32_t np_flags = 0;
  1272. if (np.is_absolute()) {
  1273. np_flags |= 1;
  1274. }
  1275. encode_uint32(np_flags, buf + 8);
  1276. buf += 12;
  1277. }
  1278. r_len += 12;
  1279. int total = np.get_name_count() + np.get_subname_count();
  1280. for (int i = 0; i < total; i++) {
  1281. String str;
  1282. if (i < np.get_name_count()) {
  1283. str = np.get_name(i);
  1284. } else {
  1285. str = np.get_subname(i - np.get_name_count());
  1286. }
  1287. CharString utf8 = str.utf8();
  1288. int pad = 0;
  1289. if (utf8.length() % 4) {
  1290. pad = 4 - utf8.length() % 4;
  1291. }
  1292. if (buf) {
  1293. encode_uint32(utf8.length(), buf);
  1294. buf += 4;
  1295. memcpy(buf, utf8.get_data(), utf8.length());
  1296. buf += pad + utf8.length();
  1297. }
  1298. r_len += 4 + utf8.length() + pad;
  1299. }
  1300. } break;
  1301. case Variant::STRING:
  1302. case Variant::STRING_NAME: {
  1303. _encode_string(p_variant, buf, r_len);
  1304. } break;
  1305. // Math types.
  1306. case Variant::VECTOR2: {
  1307. if (buf) {
  1308. Vector2 v2 = p_variant;
  1309. encode_real(v2.x, &buf[0]);
  1310. encode_real(v2.y, &buf[sizeof(real_t)]);
  1311. }
  1312. r_len += 2 * sizeof(real_t);
  1313. } break;
  1314. case Variant::VECTOR2I: {
  1315. if (buf) {
  1316. Vector2i v2 = p_variant;
  1317. encode_uint32(v2.x, &buf[0]);
  1318. encode_uint32(v2.y, &buf[4]);
  1319. }
  1320. r_len += 2 * 4;
  1321. } break;
  1322. case Variant::RECT2: {
  1323. if (buf) {
  1324. Rect2 r2 = p_variant;
  1325. encode_real(r2.position.x, &buf[0]);
  1326. encode_real(r2.position.y, &buf[sizeof(real_t)]);
  1327. encode_real(r2.size.x, &buf[sizeof(real_t) * 2]);
  1328. encode_real(r2.size.y, &buf[sizeof(real_t) * 3]);
  1329. }
  1330. r_len += 4 * sizeof(real_t);
  1331. } break;
  1332. case Variant::RECT2I: {
  1333. if (buf) {
  1334. Rect2i r2 = p_variant;
  1335. encode_uint32(r2.position.x, &buf[0]);
  1336. encode_uint32(r2.position.y, &buf[4]);
  1337. encode_uint32(r2.size.x, &buf[8]);
  1338. encode_uint32(r2.size.y, &buf[12]);
  1339. }
  1340. r_len += 4 * 4;
  1341. } break;
  1342. case Variant::VECTOR3: {
  1343. if (buf) {
  1344. Vector3 v3 = p_variant;
  1345. encode_real(v3.x, &buf[0]);
  1346. encode_real(v3.y, &buf[sizeof(real_t)]);
  1347. encode_real(v3.z, &buf[sizeof(real_t) * 2]);
  1348. }
  1349. r_len += 3 * sizeof(real_t);
  1350. } break;
  1351. case Variant::VECTOR3I: {
  1352. if (buf) {
  1353. Vector3i v3 = p_variant;
  1354. encode_uint32(v3.x, &buf[0]);
  1355. encode_uint32(v3.y, &buf[4]);
  1356. encode_uint32(v3.z, &buf[8]);
  1357. }
  1358. r_len += 3 * 4;
  1359. } break;
  1360. case Variant::TRANSFORM2D: {
  1361. if (buf) {
  1362. Transform2D val = p_variant;
  1363. for (int i = 0; i < 3; i++) {
  1364. for (int j = 0; j < 2; j++) {
  1365. memcpy(&buf[(i * 2 + j) * sizeof(real_t)], &val.columns[i][j], sizeof(real_t));
  1366. }
  1367. }
  1368. }
  1369. r_len += 6 * sizeof(real_t);
  1370. } break;
  1371. case Variant::VECTOR4: {
  1372. if (buf) {
  1373. Vector4 v4 = p_variant;
  1374. encode_real(v4.x, &buf[0]);
  1375. encode_real(v4.y, &buf[sizeof(real_t)]);
  1376. encode_real(v4.z, &buf[sizeof(real_t) * 2]);
  1377. encode_real(v4.w, &buf[sizeof(real_t) * 3]);
  1378. }
  1379. r_len += 4 * sizeof(real_t);
  1380. } break;
  1381. case Variant::VECTOR4I: {
  1382. if (buf) {
  1383. Vector4i v4 = p_variant;
  1384. encode_uint32(v4.x, &buf[0]);
  1385. encode_uint32(v4.y, &buf[4]);
  1386. encode_uint32(v4.z, &buf[8]);
  1387. encode_uint32(v4.w, &buf[12]);
  1388. }
  1389. r_len += 4 * 4;
  1390. } break;
  1391. case Variant::PLANE: {
  1392. if (buf) {
  1393. Plane p = p_variant;
  1394. encode_real(p.normal.x, &buf[0]);
  1395. encode_real(p.normal.y, &buf[sizeof(real_t)]);
  1396. encode_real(p.normal.z, &buf[sizeof(real_t) * 2]);
  1397. encode_real(p.d, &buf[sizeof(real_t) * 3]);
  1398. }
  1399. r_len += 4 * sizeof(real_t);
  1400. } break;
  1401. case Variant::QUATERNION: {
  1402. if (buf) {
  1403. Quaternion q = p_variant;
  1404. encode_real(q.x, &buf[0]);
  1405. encode_real(q.y, &buf[sizeof(real_t)]);
  1406. encode_real(q.z, &buf[sizeof(real_t) * 2]);
  1407. encode_real(q.w, &buf[sizeof(real_t) * 3]);
  1408. }
  1409. r_len += 4 * sizeof(real_t);
  1410. } break;
  1411. case Variant::AABB: {
  1412. if (buf) {
  1413. AABB aabb = p_variant;
  1414. encode_real(aabb.position.x, &buf[0]);
  1415. encode_real(aabb.position.y, &buf[sizeof(real_t)]);
  1416. encode_real(aabb.position.z, &buf[sizeof(real_t) * 2]);
  1417. encode_real(aabb.size.x, &buf[sizeof(real_t) * 3]);
  1418. encode_real(aabb.size.y, &buf[sizeof(real_t) * 4]);
  1419. encode_real(aabb.size.z, &buf[sizeof(real_t) * 5]);
  1420. }
  1421. r_len += 6 * sizeof(real_t);
  1422. } break;
  1423. case Variant::BASIS: {
  1424. if (buf) {
  1425. Basis val = p_variant;
  1426. for (int i = 0; i < 3; i++) {
  1427. for (int j = 0; j < 3; j++) {
  1428. memcpy(&buf[(i * 3 + j) * sizeof(real_t)], &val.rows[i][j], sizeof(real_t));
  1429. }
  1430. }
  1431. }
  1432. r_len += 9 * sizeof(real_t);
  1433. } break;
  1434. case Variant::TRANSFORM3D: {
  1435. if (buf) {
  1436. Transform3D val = p_variant;
  1437. for (int i = 0; i < 3; i++) {
  1438. for (int j = 0; j < 3; j++) {
  1439. memcpy(&buf[(i * 3 + j) * sizeof(real_t)], &val.basis.rows[i][j], sizeof(real_t));
  1440. }
  1441. }
  1442. encode_real(val.origin.x, &buf[sizeof(real_t) * 9]);
  1443. encode_real(val.origin.y, &buf[sizeof(real_t) * 10]);
  1444. encode_real(val.origin.z, &buf[sizeof(real_t) * 11]);
  1445. }
  1446. r_len += 12 * sizeof(real_t);
  1447. } break;
  1448. case Variant::PROJECTION: {
  1449. if (buf) {
  1450. Projection val = p_variant;
  1451. for (int i = 0; i < 4; i++) {
  1452. for (int j = 0; j < 4; j++) {
  1453. memcpy(&buf[(i * 4 + j) * sizeof(real_t)], &val.columns[i][j], sizeof(real_t));
  1454. }
  1455. }
  1456. }
  1457. r_len += 16 * sizeof(real_t);
  1458. } break;
  1459. // Misc types.
  1460. case Variant::COLOR: {
  1461. if (buf) {
  1462. Color c = p_variant;
  1463. encode_float(c.r, &buf[0]);
  1464. encode_float(c.g, &buf[4]);
  1465. encode_float(c.b, &buf[8]);
  1466. encode_float(c.a, &buf[12]);
  1467. }
  1468. r_len += 4 * 4; // Colors should always be in single-precision.
  1469. } break;
  1470. case Variant::RID: {
  1471. RID rid = p_variant;
  1472. if (buf) {
  1473. encode_uint64(rid.get_id(), buf);
  1474. }
  1475. r_len += 8;
  1476. } break;
  1477. case Variant::OBJECT: {
  1478. if (p_full_objects) {
  1479. Object *obj = p_variant;
  1480. if (!obj) {
  1481. if (buf) {
  1482. encode_uint32(0, buf);
  1483. }
  1484. r_len += 4;
  1485. } else {
  1486. ERR_FAIL_COND_V(!ClassDB::can_instantiate(obj->get_class()), ERR_INVALID_PARAMETER);
  1487. _encode_string(obj->get_class(), buf, r_len);
  1488. List<PropertyInfo> props;
  1489. obj->get_property_list(&props);
  1490. int pc = 0;
  1491. for (const PropertyInfo &E : props) {
  1492. if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
  1493. continue;
  1494. }
  1495. pc++;
  1496. }
  1497. if (buf) {
  1498. encode_uint32(pc, buf);
  1499. buf += 4;
  1500. }
  1501. r_len += 4;
  1502. for (const PropertyInfo &E : props) {
  1503. if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
  1504. continue;
  1505. }
  1506. _encode_string(E.name, buf, r_len);
  1507. Variant value;
  1508. if (E.name == CoreStringName(script)) {
  1509. Ref<Script> script = obj->get_script();
  1510. if (script.is_valid()) {
  1511. String path = script->get_path();
  1512. ERR_FAIL_COND_V_MSG(path.is_empty() || !path.begins_with("res://"), ERR_UNAVAILABLE, "Failed to encode a path to a custom script.");
  1513. value = path;
  1514. }
  1515. } else {
  1516. value = obj->get(E.name);
  1517. }
  1518. int len;
  1519. Error err = encode_variant(value, buf, len, p_full_objects, p_depth + 1);
  1520. ERR_FAIL_COND_V(err, err);
  1521. ERR_FAIL_COND_V(len % 4, ERR_BUG);
  1522. r_len += len;
  1523. if (buf) {
  1524. buf += len;
  1525. }
  1526. }
  1527. }
  1528. } else {
  1529. if (buf) {
  1530. Object *obj = p_variant.get_validated_object();
  1531. ObjectID id;
  1532. if (obj) {
  1533. id = obj->get_instance_id();
  1534. }
  1535. encode_uint64(id, buf);
  1536. }
  1537. r_len += 8;
  1538. }
  1539. } break;
  1540. case Variant::CALLABLE: {
  1541. } break;
  1542. case Variant::SIGNAL: {
  1543. Signal signal = p_variant;
  1544. _encode_string(signal.get_name(), buf, r_len);
  1545. if (buf) {
  1546. encode_uint64(signal.get_object_id(), buf);
  1547. }
  1548. r_len += 8;
  1549. } break;
  1550. case Variant::DICTIONARY: {
  1551. Dictionary dict = p_variant;
  1552. {
  1553. ContainerType key_type;
  1554. key_type.builtin_type = (Variant::Type)dict.get_typed_key_builtin();
  1555. key_type.class_name = dict.get_typed_key_class_name();
  1556. key_type.script = dict.get_typed_key_script();
  1557. Error err = _encode_container_type(key_type, buf, r_len, p_full_objects);
  1558. if (err) {
  1559. return err;
  1560. }
  1561. }
  1562. {
  1563. ContainerType value_type;
  1564. value_type.builtin_type = (Variant::Type)dict.get_typed_value_builtin();
  1565. value_type.class_name = dict.get_typed_value_class_name();
  1566. value_type.script = dict.get_typed_value_script();
  1567. Error err = _encode_container_type(value_type, buf, r_len, p_full_objects);
  1568. if (err) {
  1569. return err;
  1570. }
  1571. }
  1572. if (buf) {
  1573. encode_uint32(uint32_t(dict.size()), buf);
  1574. buf += 4;
  1575. }
  1576. r_len += 4;
  1577. List<Variant> keys;
  1578. dict.get_key_list(&keys);
  1579. for (const Variant &key : keys) {
  1580. int len;
  1581. Error err = encode_variant(key, buf, len, p_full_objects, p_depth + 1);
  1582. ERR_FAIL_COND_V(err, err);
  1583. ERR_FAIL_COND_V(len % 4, ERR_BUG);
  1584. r_len += len;
  1585. if (buf) {
  1586. buf += len;
  1587. }
  1588. Variant *value = dict.getptr(key);
  1589. ERR_FAIL_NULL_V(value, ERR_BUG);
  1590. err = encode_variant(*value, buf, len, p_full_objects, p_depth + 1);
  1591. ERR_FAIL_COND_V(err, err);
  1592. ERR_FAIL_COND_V(len % 4, ERR_BUG);
  1593. r_len += len;
  1594. if (buf) {
  1595. buf += len;
  1596. }
  1597. }
  1598. } break;
  1599. case Variant::ARRAY: {
  1600. Array array = p_variant;
  1601. {
  1602. ContainerType type;
  1603. type.builtin_type = (Variant::Type)array.get_typed_builtin();
  1604. type.class_name = array.get_typed_class_name();
  1605. type.script = array.get_typed_script();
  1606. Error err = _encode_container_type(type, buf, r_len, p_full_objects);
  1607. if (err) {
  1608. return err;
  1609. }
  1610. }
  1611. if (buf) {
  1612. encode_uint32(uint32_t(array.size()), buf);
  1613. buf += 4;
  1614. }
  1615. r_len += 4;
  1616. for (const Variant &elem : array) {
  1617. int len;
  1618. Error err = encode_variant(elem, buf, len, p_full_objects, p_depth + 1);
  1619. ERR_FAIL_COND_V(err, err);
  1620. ERR_FAIL_COND_V(len % 4, ERR_BUG);
  1621. if (buf) {
  1622. buf += len;
  1623. }
  1624. r_len += len;
  1625. }
  1626. } break;
  1627. // Packed arrays.
  1628. case Variant::PACKED_BYTE_ARRAY: {
  1629. Vector<uint8_t> data = p_variant;
  1630. int datalen = data.size();
  1631. int datasize = sizeof(uint8_t);
  1632. if (buf) {
  1633. encode_uint32(datalen, buf);
  1634. buf += 4;
  1635. const uint8_t *r = data.ptr();
  1636. if (r) {
  1637. memcpy(buf, &r[0], datalen * datasize);
  1638. buf += datalen * datasize;
  1639. }
  1640. }
  1641. r_len += 4 + datalen * datasize;
  1642. while (r_len % 4) {
  1643. r_len++;
  1644. if (buf) {
  1645. *(buf++) = 0;
  1646. }
  1647. }
  1648. } break;
  1649. case Variant::PACKED_INT32_ARRAY: {
  1650. Vector<int32_t> data = p_variant;
  1651. int datalen = data.size();
  1652. int datasize = sizeof(int32_t);
  1653. if (buf) {
  1654. encode_uint32(datalen, buf);
  1655. buf += 4;
  1656. const int32_t *r = data.ptr();
  1657. for (int32_t i = 0; i < datalen; i++) {
  1658. encode_uint32(r[i], &buf[i * datasize]);
  1659. }
  1660. }
  1661. r_len += 4 + datalen * datasize;
  1662. } break;
  1663. case Variant::PACKED_INT64_ARRAY: {
  1664. Vector<int64_t> data = p_variant;
  1665. int datalen = data.size();
  1666. int datasize = sizeof(int64_t);
  1667. if (buf) {
  1668. encode_uint32(datalen, buf);
  1669. buf += 4;
  1670. const int64_t *r = data.ptr();
  1671. for (int64_t i = 0; i < datalen; i++) {
  1672. encode_uint64(r[i], &buf[i * datasize]);
  1673. }
  1674. }
  1675. r_len += 4 + datalen * datasize;
  1676. } break;
  1677. case Variant::PACKED_FLOAT32_ARRAY: {
  1678. Vector<float> data = p_variant;
  1679. int datalen = data.size();
  1680. int datasize = sizeof(float);
  1681. if (buf) {
  1682. encode_uint32(datalen, buf);
  1683. buf += 4;
  1684. const float *r = data.ptr();
  1685. for (int i = 0; i < datalen; i++) {
  1686. encode_float(r[i], &buf[i * datasize]);
  1687. }
  1688. }
  1689. r_len += 4 + datalen * datasize;
  1690. } break;
  1691. case Variant::PACKED_FLOAT64_ARRAY: {
  1692. Vector<double> data = p_variant;
  1693. int datalen = data.size();
  1694. int datasize = sizeof(double);
  1695. if (buf) {
  1696. encode_uint32(datalen, buf);
  1697. buf += 4;
  1698. const double *r = data.ptr();
  1699. for (int i = 0; i < datalen; i++) {
  1700. encode_double(r[i], &buf[i * datasize]);
  1701. }
  1702. }
  1703. r_len += 4 + datalen * datasize;
  1704. } break;
  1705. case Variant::PACKED_STRING_ARRAY: {
  1706. Vector<String> data = p_variant;
  1707. int len = data.size();
  1708. if (buf) {
  1709. encode_uint32(len, buf);
  1710. buf += 4;
  1711. }
  1712. r_len += 4;
  1713. for (int i = 0; i < len; i++) {
  1714. CharString utf8 = data.get(i).utf8();
  1715. if (buf) {
  1716. encode_uint32(utf8.length() + 1, buf);
  1717. buf += 4;
  1718. memcpy(buf, utf8.get_data(), utf8.length() + 1);
  1719. buf += utf8.length() + 1;
  1720. }
  1721. r_len += 4 + utf8.length() + 1;
  1722. while (r_len % 4) {
  1723. r_len++; // Pad.
  1724. if (buf) {
  1725. *(buf++) = 0;
  1726. }
  1727. }
  1728. }
  1729. } break;
  1730. case Variant::PACKED_VECTOR2_ARRAY: {
  1731. Vector<Vector2> data = p_variant;
  1732. int len = data.size();
  1733. if (buf) {
  1734. encode_uint32(len, buf);
  1735. buf += 4;
  1736. }
  1737. r_len += 4;
  1738. if (buf) {
  1739. for (int i = 0; i < len; i++) {
  1740. Vector2 v = data.get(i);
  1741. encode_real(v.x, &buf[0]);
  1742. encode_real(v.y, &buf[sizeof(real_t)]);
  1743. buf += sizeof(real_t) * 2;
  1744. }
  1745. }
  1746. r_len += sizeof(real_t) * 2 * len;
  1747. } break;
  1748. case Variant::PACKED_VECTOR3_ARRAY: {
  1749. Vector<Vector3> data = p_variant;
  1750. int len = data.size();
  1751. if (buf) {
  1752. encode_uint32(len, buf);
  1753. buf += 4;
  1754. }
  1755. r_len += 4;
  1756. if (buf) {
  1757. for (int i = 0; i < len; i++) {
  1758. Vector3 v = data.get(i);
  1759. encode_real(v.x, &buf[0]);
  1760. encode_real(v.y, &buf[sizeof(real_t)]);
  1761. encode_real(v.z, &buf[sizeof(real_t) * 2]);
  1762. buf += sizeof(real_t) * 3;
  1763. }
  1764. }
  1765. r_len += sizeof(real_t) * 3 * len;
  1766. } break;
  1767. case Variant::PACKED_COLOR_ARRAY: {
  1768. Vector<Color> data = p_variant;
  1769. int len = data.size();
  1770. if (buf) {
  1771. encode_uint32(len, buf);
  1772. buf += 4;
  1773. }
  1774. r_len += 4;
  1775. if (buf) {
  1776. for (int i = 0; i < len; i++) {
  1777. Color c = data.get(i);
  1778. encode_float(c.r, &buf[0]);
  1779. encode_float(c.g, &buf[4]);
  1780. encode_float(c.b, &buf[8]);
  1781. encode_float(c.a, &buf[12]);
  1782. buf += 4 * 4; // Colors should always be in single-precision.
  1783. }
  1784. }
  1785. r_len += 4 * 4 * len;
  1786. } break;
  1787. case Variant::PACKED_VECTOR4_ARRAY: {
  1788. Vector<Vector4> data = p_variant;
  1789. int len = data.size();
  1790. if (buf) {
  1791. encode_uint32(len, buf);
  1792. buf += 4;
  1793. }
  1794. r_len += 4;
  1795. if (buf) {
  1796. for (int i = 0; i < len; i++) {
  1797. Vector4 v = data.get(i);
  1798. encode_real(v.x, &buf[0]);
  1799. encode_real(v.y, &buf[sizeof(real_t)]);
  1800. encode_real(v.z, &buf[sizeof(real_t) * 2]);
  1801. encode_real(v.w, &buf[sizeof(real_t) * 3]);
  1802. buf += sizeof(real_t) * 4;
  1803. }
  1804. }
  1805. r_len += sizeof(real_t) * 4 * len;
  1806. } break;
  1807. default: {
  1808. ERR_FAIL_V(ERR_BUG);
  1809. }
  1810. }
  1811. return OK;
  1812. }
  1813. Vector<float> vector3_to_float32_array(const Vector3 *vecs, size_t count) {
  1814. // We always allocate a new array, and we don't `memcpy()`.
  1815. // We also don't consider returning a pointer to the passed vectors when `sizeof(real_t) == 4`.
  1816. // One reason is that we could decide to put a 4th component in `Vector3` for SIMD/mobile performance,
  1817. // which would cause trouble with these optimizations.
  1818. Vector<float> floats;
  1819. if (count == 0) {
  1820. return floats;
  1821. }
  1822. floats.resize(count * 3);
  1823. float *floats_w = floats.ptrw();
  1824. for (size_t i = 0; i < count; ++i) {
  1825. const Vector3 v = vecs[i];
  1826. floats_w[0] = v.x;
  1827. floats_w[1] = v.y;
  1828. floats_w[2] = v.z;
  1829. floats_w += 3;
  1830. }
  1831. return floats;
  1832. }