resource_format_binary.cpp 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011
  1. /*************************************************************************/
  2. /* resource_format_binary.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  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 "resource_format_binary.h"
  31. #include "core/image.h"
  32. #include "core/io/file_access_compressed.h"
  33. #include "core/io/marshalls.h"
  34. #include "core/os/dir_access.h"
  35. #include "core/project_settings.h"
  36. #include "core/version.h"
  37. //#define print_bl(m_what) print_line(m_what)
  38. #define print_bl(m_what) (void)(m_what)
  39. enum {
  40. //numbering must be different from variant, in case new variant types are added (variant must be always contiguous for jumptable optimization)
  41. VARIANT_NIL = 1,
  42. VARIANT_BOOL = 2,
  43. VARIANT_INT = 3,
  44. VARIANT_REAL = 4,
  45. VARIANT_STRING = 5,
  46. VARIANT_VECTOR2 = 10,
  47. VARIANT_RECT2 = 11,
  48. VARIANT_VECTOR3 = 12,
  49. VARIANT_PLANE = 13,
  50. VARIANT_QUAT = 14,
  51. VARIANT_AABB = 15,
  52. VARIANT_MATRIX3 = 16,
  53. VARIANT_TRANSFORM = 17,
  54. VARIANT_MATRIX32 = 18,
  55. VARIANT_COLOR = 20,
  56. VARIANT_NODE_PATH = 22,
  57. VARIANT_RID = 23,
  58. VARIANT_OBJECT = 24,
  59. VARIANT_INPUT_EVENT = 25,
  60. VARIANT_DICTIONARY = 26,
  61. VARIANT_ARRAY = 30,
  62. VARIANT_RAW_ARRAY = 31,
  63. VARIANT_INT_ARRAY = 32,
  64. VARIANT_REAL_ARRAY = 33,
  65. VARIANT_STRING_ARRAY = 34,
  66. VARIANT_VECTOR3_ARRAY = 35,
  67. VARIANT_COLOR_ARRAY = 36,
  68. VARIANT_VECTOR2_ARRAY = 37,
  69. VARIANT_INT64 = 40,
  70. VARIANT_DOUBLE = 41,
  71. VARIANT_CALLABLE = 42,
  72. VARIANT_SIGNAL = 43,
  73. VARIANT_STRING_NAME = 44,
  74. VARIANT_VECTOR2I = 45,
  75. VARIANT_RECT2I = 46,
  76. VARIANT_VECTOR3I = 47,
  77. OBJECT_EMPTY = 0,
  78. OBJECT_EXTERNAL_RESOURCE = 1,
  79. OBJECT_INTERNAL_RESOURCE = 2,
  80. OBJECT_EXTERNAL_RESOURCE_INDEX = 3,
  81. //version 2: added 64 bits support for float and int
  82. //version 3: changed nodepath encoding
  83. FORMAT_VERSION = 3,
  84. FORMAT_VERSION_CAN_RENAME_DEPS = 1,
  85. FORMAT_VERSION_NO_NODEPATH_PROPERTY = 3,
  86. };
  87. void ResourceInteractiveLoaderBinary::_advance_padding(uint32_t p_len) {
  88. uint32_t extra = 4 - (p_len % 4);
  89. if (extra < 4) {
  90. for (uint32_t i = 0; i < extra; i++)
  91. f->get_8(); //pad to 32
  92. }
  93. }
  94. StringName ResourceInteractiveLoaderBinary::_get_string() {
  95. uint32_t id = f->get_32();
  96. if (id & 0x80000000) {
  97. uint32_t len = id & 0x7FFFFFFF;
  98. if ((int)len > str_buf.size()) {
  99. str_buf.resize(len);
  100. }
  101. if (len == 0)
  102. return StringName();
  103. f->get_buffer((uint8_t *)&str_buf[0], len);
  104. String s;
  105. s.parse_utf8(&str_buf[0]);
  106. return s;
  107. }
  108. return string_map[id];
  109. }
  110. Error ResourceInteractiveLoaderBinary::parse_variant(Variant &r_v) {
  111. uint32_t type = f->get_32();
  112. print_bl("find property of type: " + itos(type));
  113. switch (type) {
  114. case VARIANT_NIL: {
  115. r_v = Variant();
  116. } break;
  117. case VARIANT_BOOL: {
  118. r_v = bool(f->get_32());
  119. } break;
  120. case VARIANT_INT: {
  121. r_v = int(f->get_32());
  122. } break;
  123. case VARIANT_INT64: {
  124. r_v = int64_t(f->get_64());
  125. } break;
  126. case VARIANT_REAL: {
  127. r_v = f->get_real();
  128. } break;
  129. case VARIANT_DOUBLE: {
  130. r_v = f->get_double();
  131. } break;
  132. case VARIANT_STRING: {
  133. r_v = get_unicode_string();
  134. } break;
  135. case VARIANT_VECTOR2: {
  136. Vector2 v;
  137. v.x = f->get_real();
  138. v.y = f->get_real();
  139. r_v = v;
  140. } break;
  141. case VARIANT_VECTOR2I: {
  142. Vector2i v;
  143. v.x = f->get_32();
  144. v.y = f->get_32();
  145. r_v = v;
  146. } break;
  147. case VARIANT_RECT2: {
  148. Rect2 v;
  149. v.position.x = f->get_real();
  150. v.position.y = f->get_real();
  151. v.size.x = f->get_real();
  152. v.size.y = f->get_real();
  153. r_v = v;
  154. } break;
  155. case VARIANT_RECT2I: {
  156. Rect2i v;
  157. v.position.x = f->get_32();
  158. v.position.y = f->get_32();
  159. v.size.x = f->get_32();
  160. v.size.y = f->get_32();
  161. r_v = v;
  162. } break;
  163. case VARIANT_VECTOR3: {
  164. Vector3 v;
  165. v.x = f->get_real();
  166. v.y = f->get_real();
  167. v.z = f->get_real();
  168. r_v = v;
  169. } break;
  170. case VARIANT_VECTOR3I: {
  171. Vector3i v;
  172. v.x = f->get_32();
  173. v.y = f->get_32();
  174. v.z = f->get_32();
  175. r_v = v;
  176. } break;
  177. case VARIANT_PLANE: {
  178. Plane v;
  179. v.normal.x = f->get_real();
  180. v.normal.y = f->get_real();
  181. v.normal.z = f->get_real();
  182. v.d = f->get_real();
  183. r_v = v;
  184. } break;
  185. case VARIANT_QUAT: {
  186. Quat v;
  187. v.x = f->get_real();
  188. v.y = f->get_real();
  189. v.z = f->get_real();
  190. v.w = f->get_real();
  191. r_v = v;
  192. } break;
  193. case VARIANT_AABB: {
  194. AABB v;
  195. v.position.x = f->get_real();
  196. v.position.y = f->get_real();
  197. v.position.z = f->get_real();
  198. v.size.x = f->get_real();
  199. v.size.y = f->get_real();
  200. v.size.z = f->get_real();
  201. r_v = v;
  202. } break;
  203. case VARIANT_MATRIX32: {
  204. Transform2D v;
  205. v.elements[0].x = f->get_real();
  206. v.elements[0].y = f->get_real();
  207. v.elements[1].x = f->get_real();
  208. v.elements[1].y = f->get_real();
  209. v.elements[2].x = f->get_real();
  210. v.elements[2].y = f->get_real();
  211. r_v = v;
  212. } break;
  213. case VARIANT_MATRIX3: {
  214. Basis v;
  215. v.elements[0].x = f->get_real();
  216. v.elements[0].y = f->get_real();
  217. v.elements[0].z = f->get_real();
  218. v.elements[1].x = f->get_real();
  219. v.elements[1].y = f->get_real();
  220. v.elements[1].z = f->get_real();
  221. v.elements[2].x = f->get_real();
  222. v.elements[2].y = f->get_real();
  223. v.elements[2].z = f->get_real();
  224. r_v = v;
  225. } break;
  226. case VARIANT_TRANSFORM: {
  227. Transform v;
  228. v.basis.elements[0].x = f->get_real();
  229. v.basis.elements[0].y = f->get_real();
  230. v.basis.elements[0].z = f->get_real();
  231. v.basis.elements[1].x = f->get_real();
  232. v.basis.elements[1].y = f->get_real();
  233. v.basis.elements[1].z = f->get_real();
  234. v.basis.elements[2].x = f->get_real();
  235. v.basis.elements[2].y = f->get_real();
  236. v.basis.elements[2].z = f->get_real();
  237. v.origin.x = f->get_real();
  238. v.origin.y = f->get_real();
  239. v.origin.z = f->get_real();
  240. r_v = v;
  241. } break;
  242. case VARIANT_COLOR: {
  243. Color v;
  244. v.r = f->get_real();
  245. v.g = f->get_real();
  246. v.b = f->get_real();
  247. v.a = f->get_real();
  248. r_v = v;
  249. } break;
  250. case VARIANT_STRING_NAME: {
  251. r_v = StringName(get_unicode_string());
  252. } break;
  253. case VARIANT_NODE_PATH: {
  254. Vector<StringName> names;
  255. Vector<StringName> subnames;
  256. bool absolute;
  257. int name_count = f->get_16();
  258. uint32_t subname_count = f->get_16();
  259. absolute = subname_count & 0x8000;
  260. subname_count &= 0x7FFF;
  261. if (ver_format < FORMAT_VERSION_NO_NODEPATH_PROPERTY) {
  262. subname_count += 1; // has a property field, so we should count it as well
  263. }
  264. for (int i = 0; i < name_count; i++)
  265. names.push_back(_get_string());
  266. for (uint32_t i = 0; i < subname_count; i++)
  267. subnames.push_back(_get_string());
  268. NodePath np = NodePath(names, subnames, absolute);
  269. r_v = np;
  270. } break;
  271. case VARIANT_RID: {
  272. r_v = f->get_32();
  273. } break;
  274. case VARIANT_OBJECT: {
  275. uint32_t objtype = f->get_32();
  276. switch (objtype) {
  277. case OBJECT_EMPTY: {
  278. //do none
  279. } break;
  280. case OBJECT_INTERNAL_RESOURCE: {
  281. uint32_t index = f->get_32();
  282. String path = res_path + "::" + itos(index);
  283. RES res = ResourceLoader::load(path);
  284. if (res.is_null()) {
  285. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  286. }
  287. r_v = res;
  288. } break;
  289. case OBJECT_EXTERNAL_RESOURCE: {
  290. //old file format, still around for compatibility
  291. String exttype = get_unicode_string();
  292. String path = get_unicode_string();
  293. if (path.find("://") == -1 && path.is_rel_path()) {
  294. // path is relative to file being loaded, so convert to a resource path
  295. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  296. }
  297. if (remaps.find(path)) {
  298. path = remaps[path];
  299. }
  300. RES res = ResourceLoader::load(path, exttype);
  301. if (res.is_null()) {
  302. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  303. }
  304. r_v = res;
  305. } break;
  306. case OBJECT_EXTERNAL_RESOURCE_INDEX: {
  307. //new file format, just refers to an index in the external list
  308. int erindex = f->get_32();
  309. if (erindex < 0 || erindex >= external_resources.size()) {
  310. WARN_PRINT("Broken external resource! (index out of size)");
  311. r_v = Variant();
  312. } else {
  313. String exttype = external_resources[erindex].type;
  314. String path = external_resources[erindex].path;
  315. if (path.find("://") == -1 && path.is_rel_path()) {
  316. // path is relative to file being loaded, so convert to a resource path
  317. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  318. }
  319. RES res = ResourceLoader::load(path, exttype);
  320. if (res.is_null()) {
  321. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  322. }
  323. r_v = res;
  324. }
  325. } break;
  326. default: {
  327. ERR_FAIL_V(ERR_FILE_CORRUPT);
  328. } break;
  329. }
  330. } break;
  331. case VARIANT_CALLABLE: {
  332. r_v = Callable();
  333. } break;
  334. case VARIANT_SIGNAL: {
  335. r_v = Signal();
  336. } break;
  337. case VARIANT_DICTIONARY: {
  338. uint32_t len = f->get_32();
  339. Dictionary d; //last bit means shared
  340. len &= 0x7FFFFFFF;
  341. for (uint32_t i = 0; i < len; i++) {
  342. Variant key;
  343. Error err = parse_variant(key);
  344. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  345. Variant value;
  346. err = parse_variant(value);
  347. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  348. d[key] = value;
  349. }
  350. r_v = d;
  351. } break;
  352. case VARIANT_ARRAY: {
  353. uint32_t len = f->get_32();
  354. Array a; //last bit means shared
  355. len &= 0x7FFFFFFF;
  356. a.resize(len);
  357. for (uint32_t i = 0; i < len; i++) {
  358. Variant val;
  359. Error err = parse_variant(val);
  360. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  361. a[i] = val;
  362. }
  363. r_v = a;
  364. } break;
  365. case VARIANT_RAW_ARRAY: {
  366. uint32_t len = f->get_32();
  367. Vector<uint8_t> array;
  368. array.resize(len);
  369. uint8_t *w = array.ptrw();
  370. f->get_buffer(w, len);
  371. _advance_padding(len);
  372. r_v = array;
  373. } break;
  374. case VARIANT_INT_ARRAY: {
  375. uint32_t len = f->get_32();
  376. Vector<int> array;
  377. array.resize(len);
  378. int *w = array.ptrw();
  379. f->get_buffer((uint8_t *)w, len * 4);
  380. #ifdef BIG_ENDIAN_ENABLED
  381. {
  382. uint32_t *ptr = (uint32_t *)w.ptr();
  383. for (int i = 0; i < len; i++) {
  384. ptr[i] = BSWAP32(ptr[i]);
  385. }
  386. }
  387. #endif
  388. r_v = array;
  389. } break;
  390. case VARIANT_REAL_ARRAY: {
  391. uint32_t len = f->get_32();
  392. Vector<real_t> array;
  393. array.resize(len);
  394. real_t *w = array.ptrw();
  395. f->get_buffer((uint8_t *)w, len * sizeof(real_t));
  396. #ifdef BIG_ENDIAN_ENABLED
  397. {
  398. uint32_t *ptr = (uint32_t *)w.ptr();
  399. for (int i = 0; i < len; i++) {
  400. ptr[i] = BSWAP32(ptr[i]);
  401. }
  402. }
  403. #endif
  404. r_v = array;
  405. } break;
  406. case VARIANT_STRING_ARRAY: {
  407. uint32_t len = f->get_32();
  408. Vector<String> array;
  409. array.resize(len);
  410. String *w = array.ptrw();
  411. for (uint32_t i = 0; i < len; i++)
  412. w[i] = get_unicode_string();
  413. r_v = array;
  414. } break;
  415. case VARIANT_VECTOR2_ARRAY: {
  416. uint32_t len = f->get_32();
  417. Vector<Vector2> array;
  418. array.resize(len);
  419. Vector2 *w = array.ptrw();
  420. if (sizeof(Vector2) == 8) {
  421. f->get_buffer((uint8_t *)w, len * sizeof(real_t) * 2);
  422. #ifdef BIG_ENDIAN_ENABLED
  423. {
  424. uint32_t *ptr = (uint32_t *)w.ptr();
  425. for (int i = 0; i < len * 2; i++) {
  426. ptr[i] = BSWAP32(ptr[i]);
  427. }
  428. }
  429. #endif
  430. } else {
  431. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Vector2 size is NOT 8!");
  432. }
  433. r_v = array;
  434. } break;
  435. case VARIANT_VECTOR3_ARRAY: {
  436. uint32_t len = f->get_32();
  437. Vector<Vector3> array;
  438. array.resize(len);
  439. Vector3 *w = array.ptrw();
  440. if (sizeof(Vector3) == 12) {
  441. f->get_buffer((uint8_t *)w, len * sizeof(real_t) * 3);
  442. #ifdef BIG_ENDIAN_ENABLED
  443. {
  444. uint32_t *ptr = (uint32_t *)w.ptr();
  445. for (int i = 0; i < len * 3; i++) {
  446. ptr[i] = BSWAP32(ptr[i]);
  447. }
  448. }
  449. #endif
  450. } else {
  451. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Vector3 size is NOT 12!");
  452. }
  453. r_v = array;
  454. } break;
  455. case VARIANT_COLOR_ARRAY: {
  456. uint32_t len = f->get_32();
  457. Vector<Color> array;
  458. array.resize(len);
  459. Color *w = array.ptrw();
  460. if (sizeof(Color) == 16) {
  461. f->get_buffer((uint8_t *)w, len * sizeof(real_t) * 4);
  462. #ifdef BIG_ENDIAN_ENABLED
  463. {
  464. uint32_t *ptr = (uint32_t *)w.ptr();
  465. for (int i = 0; i < len * 4; i++) {
  466. ptr[i] = BSWAP32(ptr[i]);
  467. }
  468. }
  469. #endif
  470. } else {
  471. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Color size is NOT 16!");
  472. }
  473. r_v = array;
  474. } break;
  475. default: {
  476. ERR_FAIL_V(ERR_FILE_CORRUPT);
  477. } break;
  478. }
  479. return OK; //never reach anyway
  480. }
  481. void ResourceInteractiveLoaderBinary::set_local_path(const String &p_local_path) {
  482. res_path = p_local_path;
  483. }
  484. Ref<Resource> ResourceInteractiveLoaderBinary::get_resource() {
  485. return resource;
  486. }
  487. Error ResourceInteractiveLoaderBinary::poll() {
  488. if (error != OK)
  489. return error;
  490. int s = stage;
  491. if (s < external_resources.size()) {
  492. String path = external_resources[s].path;
  493. if (remaps.has(path)) {
  494. path = remaps[path];
  495. }
  496. RES res = ResourceLoader::load(path, external_resources[s].type);
  497. if (res.is_null()) {
  498. if (!ResourceLoader::get_abort_on_missing_resources()) {
  499. ResourceLoader::notify_dependency_error(local_path, path, external_resources[s].type);
  500. } else {
  501. error = ERR_FILE_MISSING_DEPENDENCIES;
  502. ERR_FAIL_V_MSG(error, "Can't load dependency: " + path + ".");
  503. }
  504. } else {
  505. resource_cache.push_back(res);
  506. }
  507. stage++;
  508. return error;
  509. }
  510. s -= external_resources.size();
  511. if (s >= internal_resources.size()) {
  512. error = ERR_BUG;
  513. ERR_FAIL_COND_V(s >= internal_resources.size(), error);
  514. }
  515. bool main = s == (internal_resources.size() - 1);
  516. //maybe it is loaded already
  517. String path;
  518. int subindex = 0;
  519. if (!main) {
  520. path = internal_resources[s].path;
  521. if (path.begins_with("local://")) {
  522. path = path.replace_first("local://", "");
  523. subindex = path.to_int();
  524. path = res_path + "::" + path;
  525. }
  526. if (ResourceCache::has(path)) {
  527. //already loaded, don't do anything
  528. stage++;
  529. error = OK;
  530. return error;
  531. }
  532. } else {
  533. if (!ResourceCache::has(res_path))
  534. path = res_path;
  535. }
  536. uint64_t offset = internal_resources[s].offset;
  537. f->seek(offset);
  538. String t = get_unicode_string();
  539. Object *obj = ClassDB::instance(t);
  540. if (!obj) {
  541. error = ERR_FILE_CORRUPT;
  542. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, local_path + ":Resource of unrecognized type in file: " + t + ".");
  543. }
  544. Resource *r = Object::cast_to<Resource>(obj);
  545. if (!r) {
  546. String obj_class = obj->get_class();
  547. error = ERR_FILE_CORRUPT;
  548. memdelete(obj); //bye
  549. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, local_path + ":Resource type in resource field not a resource, type is: " + obj_class + ".");
  550. }
  551. RES res = RES(r);
  552. r->set_path(path);
  553. r->set_subindex(subindex);
  554. int pc = f->get_32();
  555. //set properties
  556. for (int i = 0; i < pc; i++) {
  557. StringName name = _get_string();
  558. if (name == StringName()) {
  559. error = ERR_FILE_CORRUPT;
  560. ERR_FAIL_V(ERR_FILE_CORRUPT);
  561. }
  562. Variant value;
  563. error = parse_variant(value);
  564. if (error)
  565. return error;
  566. res->set(name, value);
  567. }
  568. #ifdef TOOLS_ENABLED
  569. res->set_edited(false);
  570. #endif
  571. stage++;
  572. resource_cache.push_back(res);
  573. if (main) {
  574. f->close();
  575. resource = res;
  576. resource->set_as_translation_remapped(translation_remapped);
  577. error = ERR_FILE_EOF;
  578. } else {
  579. error = OK;
  580. }
  581. return OK;
  582. }
  583. int ResourceInteractiveLoaderBinary::get_stage() const {
  584. return stage;
  585. }
  586. int ResourceInteractiveLoaderBinary::get_stage_count() const {
  587. return external_resources.size() + internal_resources.size();
  588. }
  589. void ResourceInteractiveLoaderBinary::set_translation_remapped(bool p_remapped) {
  590. translation_remapped = p_remapped;
  591. }
  592. static void save_ustring(FileAccess *f, const String &p_string) {
  593. CharString utf8 = p_string.utf8();
  594. f->store_32(utf8.length() + 1);
  595. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  596. }
  597. static String get_ustring(FileAccess *f) {
  598. int len = f->get_32();
  599. Vector<char> str_buf;
  600. str_buf.resize(len);
  601. f->get_buffer((uint8_t *)&str_buf[0], len);
  602. String s;
  603. s.parse_utf8(&str_buf[0]);
  604. return s;
  605. }
  606. String ResourceInteractiveLoaderBinary::get_unicode_string() {
  607. int len = f->get_32();
  608. if (len > str_buf.size()) {
  609. str_buf.resize(len);
  610. }
  611. if (len == 0)
  612. return String();
  613. f->get_buffer((uint8_t *)&str_buf[0], len);
  614. String s;
  615. s.parse_utf8(&str_buf[0]);
  616. return s;
  617. }
  618. void ResourceInteractiveLoaderBinary::get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types) {
  619. open(p_f);
  620. if (error)
  621. return;
  622. for (int i = 0; i < external_resources.size(); i++) {
  623. String dep = external_resources[i].path;
  624. if (p_add_types && external_resources[i].type != String()) {
  625. dep += "::" + external_resources[i].type;
  626. }
  627. p_dependencies->push_back(dep);
  628. }
  629. }
  630. void ResourceInteractiveLoaderBinary::open(FileAccess *p_f) {
  631. error = OK;
  632. f = p_f;
  633. uint8_t header[4];
  634. f->get_buffer(header, 4);
  635. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  636. // Compressed.
  637. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  638. error = fac->open_after_magic(f);
  639. if (error != OK) {
  640. memdelete(fac);
  641. f->close();
  642. ERR_FAIL_MSG("Failed to open binary resource file: " + local_path + ".");
  643. }
  644. f = fac;
  645. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  646. // Not normal.
  647. error = ERR_FILE_UNRECOGNIZED;
  648. f->close();
  649. ERR_FAIL_MSG("Unrecognized binary resource file: " + local_path + ".");
  650. }
  651. bool big_endian = f->get_32();
  652. bool use_real64 = f->get_32();
  653. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  654. uint32_t ver_major = f->get_32();
  655. uint32_t ver_minor = f->get_32();
  656. ver_format = f->get_32();
  657. print_bl("big endian: " + itos(big_endian));
  658. #ifdef BIG_ENDIAN_ENABLED
  659. print_bl("endian swap: " + itos(!big_endian));
  660. #else
  661. print_bl("endian swap: " + itos(big_endian));
  662. #endif
  663. print_bl("real64: " + itos(use_real64));
  664. print_bl("major: " + itos(ver_major));
  665. print_bl("minor: " + itos(ver_minor));
  666. print_bl("format: " + itos(ver_format));
  667. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  668. f->close();
  669. ERR_FAIL_MSG("File format '" + itos(FORMAT_VERSION) + "." + itos(ver_major) + "." + itos(ver_minor) + "' is too new! Please upgrade to a new engine version: " + local_path + ".");
  670. }
  671. type = get_unicode_string();
  672. print_bl("type: " + type);
  673. importmd_ofs = f->get_64();
  674. for (int i = 0; i < 14; i++)
  675. f->get_32(); //skip a few reserved fields
  676. uint32_t string_table_size = f->get_32();
  677. string_map.resize(string_table_size);
  678. for (uint32_t i = 0; i < string_table_size; i++) {
  679. StringName s = get_unicode_string();
  680. string_map.write[i] = s;
  681. }
  682. print_bl("strings: " + itos(string_table_size));
  683. uint32_t ext_resources_size = f->get_32();
  684. for (uint32_t i = 0; i < ext_resources_size; i++) {
  685. ExtResource er;
  686. er.type = get_unicode_string();
  687. er.path = get_unicode_string();
  688. external_resources.push_back(er);
  689. }
  690. print_bl("ext resources: " + itos(ext_resources_size));
  691. uint32_t int_resources_size = f->get_32();
  692. for (uint32_t i = 0; i < int_resources_size; i++) {
  693. IntResource ir;
  694. ir.path = get_unicode_string();
  695. ir.offset = f->get_64();
  696. internal_resources.push_back(ir);
  697. }
  698. print_bl("int resources: " + itos(int_resources_size));
  699. if (f->eof_reached()) {
  700. error = ERR_FILE_CORRUPT;
  701. f->close();
  702. ERR_FAIL_MSG("Premature end of file (EOF): " + local_path + ".");
  703. }
  704. }
  705. String ResourceInteractiveLoaderBinary::recognize(FileAccess *p_f) {
  706. error = OK;
  707. f = p_f;
  708. uint8_t header[4];
  709. f->get_buffer(header, 4);
  710. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  711. // Compressed.
  712. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  713. error = fac->open_after_magic(f);
  714. if (error != OK) {
  715. memdelete(fac);
  716. f->close();
  717. return "";
  718. }
  719. f = fac;
  720. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  721. // Not normal.
  722. error = ERR_FILE_UNRECOGNIZED;
  723. f->close();
  724. return "";
  725. }
  726. bool big_endian = f->get_32();
  727. f->get_32(); // use_real64
  728. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  729. uint32_t ver_major = f->get_32();
  730. f->get_32(); // ver_minor
  731. uint32_t ver_format = f->get_32();
  732. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  733. f->close();
  734. return "";
  735. }
  736. String type = get_unicode_string();
  737. return type;
  738. }
  739. ResourceInteractiveLoaderBinary::ResourceInteractiveLoaderBinary() :
  740. translation_remapped(false),
  741. f(NULL),
  742. error(OK),
  743. stage(0) {
  744. }
  745. ResourceInteractiveLoaderBinary::~ResourceInteractiveLoaderBinary() {
  746. if (f)
  747. memdelete(f);
  748. }
  749. Ref<ResourceInteractiveLoader> ResourceFormatLoaderBinary::load_interactive(const String &p_path, const String &p_original_path, Error *r_error) {
  750. if (r_error)
  751. *r_error = ERR_FILE_CANT_OPEN;
  752. Error err;
  753. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  754. ERR_FAIL_COND_V_MSG(err != OK, Ref<ResourceInteractiveLoader>(), "Cannot open file '" + p_path + "'.");
  755. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  756. String path = p_original_path != "" ? p_original_path : p_path;
  757. ria->local_path = ProjectSettings::get_singleton()->localize_path(path);
  758. ria->res_path = ria->local_path;
  759. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  760. ria->open(f);
  761. return ria;
  762. }
  763. void ResourceFormatLoaderBinary::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
  764. if (p_type == "") {
  765. get_recognized_extensions(p_extensions);
  766. return;
  767. }
  768. List<String> extensions;
  769. ClassDB::get_extensions_for_type(p_type, &extensions);
  770. extensions.sort();
  771. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  772. String ext = E->get().to_lower();
  773. p_extensions->push_back(ext);
  774. }
  775. }
  776. void ResourceFormatLoaderBinary::get_recognized_extensions(List<String> *p_extensions) const {
  777. List<String> extensions;
  778. ClassDB::get_resource_base_extensions(&extensions);
  779. extensions.sort();
  780. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  781. String ext = E->get().to_lower();
  782. p_extensions->push_back(ext);
  783. }
  784. }
  785. bool ResourceFormatLoaderBinary::handles_type(const String &p_type) const {
  786. return true; //handles all
  787. }
  788. void ResourceFormatLoaderBinary::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  789. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  790. ERR_FAIL_COND_MSG(!f, "Cannot open file '" + p_path + "'.");
  791. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  792. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  793. ria->res_path = ria->local_path;
  794. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  795. ria->get_dependencies(f, p_dependencies, p_add_types);
  796. }
  797. Error ResourceFormatLoaderBinary::rename_dependencies(const String &p_path, const Map<String, String> &p_map) {
  798. //Error error=OK;
  799. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  800. ERR_FAIL_COND_V_MSG(!f, ERR_CANT_OPEN, "Cannot open file '" + p_path + "'.");
  801. FileAccess *fw = NULL; //=FileAccess::open(p_path+".depren");
  802. String local_path = p_path.get_base_dir();
  803. uint8_t header[4];
  804. f->get_buffer(header, 4);
  805. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  806. // Compressed.
  807. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  808. Error err = fac->open_after_magic(f);
  809. if (err != OK) {
  810. memdelete(fac);
  811. memdelete(f);
  812. ERR_FAIL_V_MSG(err, "Cannot open file '" + p_path + "'.");
  813. }
  814. f = fac;
  815. FileAccessCompressed *facw = memnew(FileAccessCompressed);
  816. facw->configure("RSCC");
  817. err = facw->_open(p_path + ".depren", FileAccess::WRITE);
  818. if (err) {
  819. memdelete(fac);
  820. memdelete(facw);
  821. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Cannot create file '" + p_path + ".depren'.");
  822. }
  823. fw = facw;
  824. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  825. // Not normal.
  826. memdelete(f);
  827. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, "Unrecognized binary resource file '" + local_path + "'.");
  828. } else {
  829. fw = FileAccess::open(p_path + ".depren", FileAccess::WRITE);
  830. if (!fw) {
  831. memdelete(f);
  832. }
  833. ERR_FAIL_COND_V_MSG(!fw, ERR_CANT_CREATE, "Cannot create file '" + p_path + ".depren'.");
  834. uint8_t magic[4] = { 'R', 'S', 'R', 'C' };
  835. fw->store_buffer(magic, 4);
  836. }
  837. bool big_endian = f->get_32();
  838. bool use_real64 = f->get_32();
  839. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  840. #ifdef BIG_ENDIAN_ENABLED
  841. fw->store_32(!big_endian);
  842. #else
  843. fw->store_32(big_endian);
  844. #endif
  845. fw->set_endian_swap(big_endian != 0);
  846. fw->store_32(use_real64); //use real64
  847. uint32_t ver_major = f->get_32();
  848. uint32_t ver_minor = f->get_32();
  849. uint32_t ver_format = f->get_32();
  850. if (ver_format < FORMAT_VERSION_CAN_RENAME_DEPS) {
  851. memdelete(f);
  852. memdelete(fw);
  853. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  854. da->remove(p_path + ".depren");
  855. memdelete(da);
  856. //use the old approach
  857. WARN_PRINT("This file is old, so it can't refactor dependencies, opening and resaving '" + p_path + "'.");
  858. Error err;
  859. f = FileAccess::open(p_path, FileAccess::READ, &err);
  860. ERR_FAIL_COND_V_MSG(err != OK, ERR_FILE_CANT_OPEN, "Cannot open file '" + p_path + "'.");
  861. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  862. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  863. ria->res_path = ria->local_path;
  864. ria->remaps = p_map;
  865. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  866. ria->open(f);
  867. err = ria->poll();
  868. while (err == OK) {
  869. err = ria->poll();
  870. }
  871. ERR_FAIL_COND_V(err != ERR_FILE_EOF, ERR_FILE_CORRUPT);
  872. RES res = ria->get_resource();
  873. ERR_FAIL_COND_V(!res.is_valid(), ERR_FILE_CORRUPT);
  874. return ResourceFormatSaverBinary::singleton->save(p_path, res);
  875. }
  876. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  877. memdelete(f);
  878. memdelete(fw);
  879. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, "File format '" + itos(FORMAT_VERSION) + "." + itos(ver_major) + "." + itos(ver_minor) + "' is too new! Please upgrade to a new engine version: " + local_path + ".");
  880. }
  881. // Since we're not actually converting the file contents, leave the version
  882. // numbers in the file untouched.
  883. fw->store_32(ver_major);
  884. fw->store_32(ver_minor);
  885. fw->store_32(ver_format);
  886. save_ustring(fw, get_ustring(f)); //type
  887. size_t md_ofs = f->get_position();
  888. size_t importmd_ofs = f->get_64();
  889. fw->store_64(0); //metadata offset
  890. for (int i = 0; i < 14; i++) {
  891. fw->store_32(0);
  892. f->get_32();
  893. }
  894. //string table
  895. uint32_t string_table_size = f->get_32();
  896. fw->store_32(string_table_size);
  897. for (uint32_t i = 0; i < string_table_size; i++) {
  898. String s = get_ustring(f);
  899. save_ustring(fw, s);
  900. }
  901. //external resources
  902. uint32_t ext_resources_size = f->get_32();
  903. fw->store_32(ext_resources_size);
  904. for (uint32_t i = 0; i < ext_resources_size; i++) {
  905. String type = get_ustring(f);
  906. String path = get_ustring(f);
  907. bool relative = false;
  908. if (!path.begins_with("res://")) {
  909. path = local_path.plus_file(path).simplify_path();
  910. relative = true;
  911. }
  912. if (p_map.has(path)) {
  913. String np = p_map[path];
  914. path = np;
  915. }
  916. if (relative) {
  917. //restore relative
  918. path = local_path.path_to_file(path);
  919. }
  920. save_ustring(fw, type);
  921. save_ustring(fw, path);
  922. }
  923. int64_t size_diff = (int64_t)fw->get_position() - (int64_t)f->get_position();
  924. //internal resources
  925. uint32_t int_resources_size = f->get_32();
  926. fw->store_32(int_resources_size);
  927. for (uint32_t i = 0; i < int_resources_size; i++) {
  928. String path = get_ustring(f);
  929. uint64_t offset = f->get_64();
  930. save_ustring(fw, path);
  931. fw->store_64(offset + size_diff);
  932. }
  933. //rest of file
  934. uint8_t b = f->get_8();
  935. while (!f->eof_reached()) {
  936. fw->store_8(b);
  937. b = f->get_8();
  938. }
  939. bool all_ok = fw->get_error() == OK;
  940. fw->seek(md_ofs);
  941. fw->store_64(importmd_ofs + size_diff);
  942. memdelete(f);
  943. memdelete(fw);
  944. if (!all_ok) {
  945. return ERR_CANT_CREATE;
  946. }
  947. DirAccess *da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  948. da->remove(p_path);
  949. da->rename(p_path + ".depren", p_path);
  950. memdelete(da);
  951. return OK;
  952. }
  953. String ResourceFormatLoaderBinary::get_resource_type(const String &p_path) const {
  954. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  955. if (!f) {
  956. return ""; //could not rwead
  957. }
  958. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  959. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  960. ria->res_path = ria->local_path;
  961. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  962. String r = ria->recognize(f);
  963. return ClassDB::get_compatibility_remapped_class(r);
  964. }
  965. ///////////////////////////////////////////////////////////
  966. ///////////////////////////////////////////////////////////
  967. ///////////////////////////////////////////////////////////
  968. void ResourceFormatSaverBinaryInstance::_pad_buffer(FileAccess *f, int p_bytes) {
  969. int extra = 4 - (p_bytes % 4);
  970. if (extra < 4) {
  971. for (int i = 0; i < extra; i++)
  972. f->store_8(0); //pad to 32
  973. }
  974. }
  975. void ResourceFormatSaverBinaryInstance::_write_variant(const Variant &p_property, const PropertyInfo &p_hint) {
  976. write_variant(f, p_property, resource_set, external_resources, string_map, p_hint);
  977. }
  978. void ResourceFormatSaverBinaryInstance::write_variant(FileAccess *f, const Variant &p_property, Set<RES> &resource_set, Map<RES, int> &external_resources, Map<StringName, int> &string_map, const PropertyInfo &p_hint) {
  979. switch (p_property.get_type()) {
  980. case Variant::NIL: {
  981. f->store_32(VARIANT_NIL);
  982. // don't store anything
  983. } break;
  984. case Variant::BOOL: {
  985. f->store_32(VARIANT_BOOL);
  986. bool val = p_property;
  987. f->store_32(val);
  988. } break;
  989. case Variant::INT: {
  990. int64_t val = p_property;
  991. if (val > 0x7FFFFFFF || val < -(int64_t)0x80000000) {
  992. f->store_32(VARIANT_INT64);
  993. f->store_64(val);
  994. } else {
  995. f->store_32(VARIANT_INT);
  996. f->store_32(int32_t(p_property));
  997. }
  998. } break;
  999. case Variant::REAL: {
  1000. double d = p_property;
  1001. float fl = d;
  1002. if (double(fl) != d) {
  1003. f->store_32(VARIANT_DOUBLE);
  1004. f->store_double(d);
  1005. } else {
  1006. f->store_32(VARIANT_REAL);
  1007. f->store_real(fl);
  1008. }
  1009. } break;
  1010. case Variant::STRING: {
  1011. f->store_32(VARIANT_STRING);
  1012. String val = p_property;
  1013. save_unicode_string(f, val);
  1014. } break;
  1015. case Variant::VECTOR2: {
  1016. f->store_32(VARIANT_VECTOR2);
  1017. Vector2 val = p_property;
  1018. f->store_real(val.x);
  1019. f->store_real(val.y);
  1020. } break;
  1021. case Variant::VECTOR2I: {
  1022. f->store_32(VARIANT_VECTOR2I);
  1023. Vector2i val = p_property;
  1024. f->store_32(val.x);
  1025. f->store_32(val.y);
  1026. } break;
  1027. case Variant::RECT2: {
  1028. f->store_32(VARIANT_RECT2);
  1029. Rect2 val = p_property;
  1030. f->store_real(val.position.x);
  1031. f->store_real(val.position.y);
  1032. f->store_real(val.size.x);
  1033. f->store_real(val.size.y);
  1034. } break;
  1035. case Variant::RECT2I: {
  1036. f->store_32(VARIANT_RECT2I);
  1037. Rect2i val = p_property;
  1038. f->store_32(val.position.x);
  1039. f->store_32(val.position.y);
  1040. f->store_32(val.size.x);
  1041. f->store_32(val.size.y);
  1042. } break;
  1043. case Variant::VECTOR3: {
  1044. f->store_32(VARIANT_VECTOR3);
  1045. Vector3 val = p_property;
  1046. f->store_real(val.x);
  1047. f->store_real(val.y);
  1048. f->store_real(val.z);
  1049. } break;
  1050. case Variant::VECTOR3I: {
  1051. f->store_32(VARIANT_VECTOR3I);
  1052. Vector3i val = p_property;
  1053. f->store_32(val.x);
  1054. f->store_32(val.y);
  1055. f->store_32(val.z);
  1056. } break;
  1057. case Variant::PLANE: {
  1058. f->store_32(VARIANT_PLANE);
  1059. Plane val = p_property;
  1060. f->store_real(val.normal.x);
  1061. f->store_real(val.normal.y);
  1062. f->store_real(val.normal.z);
  1063. f->store_real(val.d);
  1064. } break;
  1065. case Variant::QUAT: {
  1066. f->store_32(VARIANT_QUAT);
  1067. Quat val = p_property;
  1068. f->store_real(val.x);
  1069. f->store_real(val.y);
  1070. f->store_real(val.z);
  1071. f->store_real(val.w);
  1072. } break;
  1073. case Variant::AABB: {
  1074. f->store_32(VARIANT_AABB);
  1075. AABB val = p_property;
  1076. f->store_real(val.position.x);
  1077. f->store_real(val.position.y);
  1078. f->store_real(val.position.z);
  1079. f->store_real(val.size.x);
  1080. f->store_real(val.size.y);
  1081. f->store_real(val.size.z);
  1082. } break;
  1083. case Variant::TRANSFORM2D: {
  1084. f->store_32(VARIANT_MATRIX32);
  1085. Transform2D val = p_property;
  1086. f->store_real(val.elements[0].x);
  1087. f->store_real(val.elements[0].y);
  1088. f->store_real(val.elements[1].x);
  1089. f->store_real(val.elements[1].y);
  1090. f->store_real(val.elements[2].x);
  1091. f->store_real(val.elements[2].y);
  1092. } break;
  1093. case Variant::BASIS: {
  1094. f->store_32(VARIANT_MATRIX3);
  1095. Basis val = p_property;
  1096. f->store_real(val.elements[0].x);
  1097. f->store_real(val.elements[0].y);
  1098. f->store_real(val.elements[0].z);
  1099. f->store_real(val.elements[1].x);
  1100. f->store_real(val.elements[1].y);
  1101. f->store_real(val.elements[1].z);
  1102. f->store_real(val.elements[2].x);
  1103. f->store_real(val.elements[2].y);
  1104. f->store_real(val.elements[2].z);
  1105. } break;
  1106. case Variant::TRANSFORM: {
  1107. f->store_32(VARIANT_TRANSFORM);
  1108. Transform val = p_property;
  1109. f->store_real(val.basis.elements[0].x);
  1110. f->store_real(val.basis.elements[0].y);
  1111. f->store_real(val.basis.elements[0].z);
  1112. f->store_real(val.basis.elements[1].x);
  1113. f->store_real(val.basis.elements[1].y);
  1114. f->store_real(val.basis.elements[1].z);
  1115. f->store_real(val.basis.elements[2].x);
  1116. f->store_real(val.basis.elements[2].y);
  1117. f->store_real(val.basis.elements[2].z);
  1118. f->store_real(val.origin.x);
  1119. f->store_real(val.origin.y);
  1120. f->store_real(val.origin.z);
  1121. } break;
  1122. case Variant::COLOR: {
  1123. f->store_32(VARIANT_COLOR);
  1124. Color val = p_property;
  1125. f->store_real(val.r);
  1126. f->store_real(val.g);
  1127. f->store_real(val.b);
  1128. f->store_real(val.a);
  1129. } break;
  1130. case Variant::STRING_NAME: {
  1131. f->store_32(VARIANT_STRING_NAME);
  1132. String val = p_property;
  1133. save_unicode_string(f, val);
  1134. } break;
  1135. case Variant::NODE_PATH: {
  1136. f->store_32(VARIANT_NODE_PATH);
  1137. NodePath np = p_property;
  1138. f->store_16(np.get_name_count());
  1139. uint16_t snc = np.get_subname_count();
  1140. if (np.is_absolute())
  1141. snc |= 0x8000;
  1142. f->store_16(snc);
  1143. for (int i = 0; i < np.get_name_count(); i++) {
  1144. if (string_map.has(np.get_name(i))) {
  1145. f->store_32(string_map[np.get_name(i)]);
  1146. } else {
  1147. save_unicode_string(f, np.get_name(i), true);
  1148. }
  1149. }
  1150. for (int i = 0; i < np.get_subname_count(); i++) {
  1151. if (string_map.has(np.get_subname(i))) {
  1152. f->store_32(string_map[np.get_subname(i)]);
  1153. } else {
  1154. save_unicode_string(f, np.get_subname(i), true);
  1155. }
  1156. }
  1157. } break;
  1158. case Variant::_RID: {
  1159. f->store_32(VARIANT_RID);
  1160. WARN_PRINT("Can't save RIDs.");
  1161. RID val = p_property;
  1162. f->store_32(val.get_id());
  1163. } break;
  1164. case Variant::OBJECT: {
  1165. f->store_32(VARIANT_OBJECT);
  1166. RES res = p_property;
  1167. if (res.is_null()) {
  1168. f->store_32(OBJECT_EMPTY);
  1169. return; // don't save it
  1170. }
  1171. if (res->get_path().length() && res->get_path().find("::") == -1) {
  1172. f->store_32(OBJECT_EXTERNAL_RESOURCE_INDEX);
  1173. f->store_32(external_resources[res]);
  1174. } else {
  1175. if (!resource_set.has(res)) {
  1176. f->store_32(OBJECT_EMPTY);
  1177. ERR_FAIL_MSG("Resource was not pre cached for the resource section, most likely due to circular reference.");
  1178. }
  1179. f->store_32(OBJECT_INTERNAL_RESOURCE);
  1180. f->store_32(res->get_subindex());
  1181. //internal resource
  1182. }
  1183. } break;
  1184. case Variant::CALLABLE: {
  1185. f->store_32(VARIANT_CALLABLE);
  1186. WARN_PRINT("Can't save Callables.");
  1187. } break;
  1188. case Variant::SIGNAL: {
  1189. f->store_32(VARIANT_SIGNAL);
  1190. WARN_PRINT("Can't save Signals.");
  1191. } break;
  1192. case Variant::DICTIONARY: {
  1193. f->store_32(VARIANT_DICTIONARY);
  1194. Dictionary d = p_property;
  1195. f->store_32(uint32_t(d.size()));
  1196. List<Variant> keys;
  1197. d.get_key_list(&keys);
  1198. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1199. /*
  1200. if (!_check_type(dict[E->get()]))
  1201. continue;
  1202. */
  1203. write_variant(f, E->get(), resource_set, external_resources, string_map);
  1204. write_variant(f, d[E->get()], resource_set, external_resources, string_map);
  1205. }
  1206. } break;
  1207. case Variant::ARRAY: {
  1208. f->store_32(VARIANT_ARRAY);
  1209. Array a = p_property;
  1210. f->store_32(uint32_t(a.size()));
  1211. for (int i = 0; i < a.size(); i++) {
  1212. write_variant(f, a[i], resource_set, external_resources, string_map);
  1213. }
  1214. } break;
  1215. case Variant::PACKED_BYTE_ARRAY: {
  1216. f->store_32(VARIANT_RAW_ARRAY);
  1217. Vector<uint8_t> arr = p_property;
  1218. int len = arr.size();
  1219. f->store_32(len);
  1220. const uint8_t *r = arr.ptr();
  1221. f->store_buffer(r, len);
  1222. _pad_buffer(f, len);
  1223. } break;
  1224. case Variant::PACKED_INT_ARRAY: {
  1225. f->store_32(VARIANT_INT_ARRAY);
  1226. Vector<int> arr = p_property;
  1227. int len = arr.size();
  1228. f->store_32(len);
  1229. const int *r = arr.ptr();
  1230. for (int i = 0; i < len; i++)
  1231. f->store_32(r[i]);
  1232. } break;
  1233. case Variant::PACKED_REAL_ARRAY: {
  1234. f->store_32(VARIANT_REAL_ARRAY);
  1235. Vector<real_t> arr = p_property;
  1236. int len = arr.size();
  1237. f->store_32(len);
  1238. const real_t *r = arr.ptr();
  1239. for (int i = 0; i < len; i++) {
  1240. f->store_real(r[i]);
  1241. }
  1242. } break;
  1243. case Variant::PACKED_STRING_ARRAY: {
  1244. f->store_32(VARIANT_STRING_ARRAY);
  1245. Vector<String> arr = p_property;
  1246. int len = arr.size();
  1247. f->store_32(len);
  1248. const String *r = arr.ptr();
  1249. for (int i = 0; i < len; i++) {
  1250. save_unicode_string(f, r[i]);
  1251. }
  1252. } break;
  1253. case Variant::PACKED_VECTOR3_ARRAY: {
  1254. f->store_32(VARIANT_VECTOR3_ARRAY);
  1255. Vector<Vector3> arr = p_property;
  1256. int len = arr.size();
  1257. f->store_32(len);
  1258. const Vector3 *r = arr.ptr();
  1259. for (int i = 0; i < len; i++) {
  1260. f->store_real(r[i].x);
  1261. f->store_real(r[i].y);
  1262. f->store_real(r[i].z);
  1263. }
  1264. } break;
  1265. case Variant::PACKED_VECTOR2_ARRAY: {
  1266. f->store_32(VARIANT_VECTOR2_ARRAY);
  1267. Vector<Vector2> arr = p_property;
  1268. int len = arr.size();
  1269. f->store_32(len);
  1270. const Vector2 *r = arr.ptr();
  1271. for (int i = 0; i < len; i++) {
  1272. f->store_real(r[i].x);
  1273. f->store_real(r[i].y);
  1274. }
  1275. } break;
  1276. case Variant::PACKED_COLOR_ARRAY: {
  1277. f->store_32(VARIANT_COLOR_ARRAY);
  1278. Vector<Color> arr = p_property;
  1279. int len = arr.size();
  1280. f->store_32(len);
  1281. const Color *r = arr.ptr();
  1282. for (int i = 0; i < len; i++) {
  1283. f->store_real(r[i].r);
  1284. f->store_real(r[i].g);
  1285. f->store_real(r[i].b);
  1286. f->store_real(r[i].a);
  1287. }
  1288. } break;
  1289. default: {
  1290. ERR_FAIL_MSG("Invalid variant.");
  1291. }
  1292. }
  1293. }
  1294. void ResourceFormatSaverBinaryInstance::_find_resources(const Variant &p_variant, bool p_main) {
  1295. switch (p_variant.get_type()) {
  1296. case Variant::OBJECT: {
  1297. RES res = p_variant;
  1298. if (res.is_null() || external_resources.has(res))
  1299. return;
  1300. if (!p_main && (!bundle_resources) && res->get_path().length() && res->get_path().find("::") == -1) {
  1301. if (res->get_path() == path) {
  1302. ERR_PRINT("Circular reference to resource being saved found: '" + local_path + "' will be null next time it's loaded.");
  1303. return;
  1304. }
  1305. int idx = external_resources.size();
  1306. external_resources[res] = idx;
  1307. return;
  1308. }
  1309. if (resource_set.has(res))
  1310. return;
  1311. List<PropertyInfo> property_list;
  1312. res->get_property_list(&property_list);
  1313. for (List<PropertyInfo>::Element *E = property_list.front(); E; E = E->next()) {
  1314. if (E->get().usage & PROPERTY_USAGE_STORAGE) {
  1315. Variant value = res->get(E->get().name);
  1316. if (E->get().usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
  1317. RES sres = value;
  1318. if (sres.is_valid()) {
  1319. NonPersistentKey npk;
  1320. npk.base = res;
  1321. npk.property = E->get().name;
  1322. non_persistent_map[npk] = sres;
  1323. resource_set.insert(sres);
  1324. saved_resources.push_back(sres);
  1325. }
  1326. } else {
  1327. _find_resources(value);
  1328. }
  1329. }
  1330. }
  1331. resource_set.insert(res);
  1332. saved_resources.push_back(res);
  1333. } break;
  1334. case Variant::ARRAY: {
  1335. Array varray = p_variant;
  1336. int len = varray.size();
  1337. for (int i = 0; i < len; i++) {
  1338. const Variant &v = varray.get(i);
  1339. _find_resources(v);
  1340. }
  1341. } break;
  1342. case Variant::DICTIONARY: {
  1343. Dictionary d = p_variant;
  1344. List<Variant> keys;
  1345. d.get_key_list(&keys);
  1346. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1347. _find_resources(E->get());
  1348. Variant v = d[E->get()];
  1349. _find_resources(v);
  1350. }
  1351. } break;
  1352. case Variant::NODE_PATH: {
  1353. //take the chance and save node path strings
  1354. NodePath np = p_variant;
  1355. for (int i = 0; i < np.get_name_count(); i++)
  1356. get_string_index(np.get_name(i));
  1357. for (int i = 0; i < np.get_subname_count(); i++)
  1358. get_string_index(np.get_subname(i));
  1359. } break;
  1360. default: {
  1361. }
  1362. }
  1363. }
  1364. void ResourceFormatSaverBinaryInstance::save_unicode_string(FileAccess *f, const String &p_string, bool p_bit_on_len) {
  1365. CharString utf8 = p_string.utf8();
  1366. if (p_bit_on_len) {
  1367. f->store_32((utf8.length() + 1) | 0x80000000);
  1368. } else {
  1369. f->store_32(utf8.length() + 1);
  1370. }
  1371. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  1372. }
  1373. int ResourceFormatSaverBinaryInstance::get_string_index(const String &p_string) {
  1374. StringName s = p_string;
  1375. if (string_map.has(s))
  1376. return string_map[s];
  1377. string_map[s] = strings.size();
  1378. strings.push_back(s);
  1379. return strings.size() - 1;
  1380. }
  1381. Error ResourceFormatSaverBinaryInstance::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1382. Error err;
  1383. if (p_flags & ResourceSaver::FLAG_COMPRESS) {
  1384. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  1385. fac->configure("RSCC");
  1386. f = fac;
  1387. err = fac->_open(p_path, FileAccess::WRITE);
  1388. if (err)
  1389. memdelete(f);
  1390. } else {
  1391. f = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1392. }
  1393. ERR_FAIL_COND_V_MSG(err != OK, err, "Cannot create file '" + p_path + "'.");
  1394. relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
  1395. skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
  1396. bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
  1397. big_endian = p_flags & ResourceSaver::FLAG_SAVE_BIG_ENDIAN;
  1398. takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
  1399. if (!p_path.begins_with("res://"))
  1400. takeover_paths = false;
  1401. local_path = p_path.get_base_dir();
  1402. path = ProjectSettings::get_singleton()->localize_path(p_path);
  1403. _find_resources(p_resource, true);
  1404. if (!(p_flags & ResourceSaver::FLAG_COMPRESS)) {
  1405. //save header compressed
  1406. static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
  1407. f->store_buffer(header, 4);
  1408. }
  1409. if (big_endian) {
  1410. f->store_32(1);
  1411. f->set_endian_swap(true);
  1412. } else
  1413. f->store_32(0);
  1414. f->store_32(0); //64 bits file, false for now
  1415. f->store_32(VERSION_MAJOR);
  1416. f->store_32(VERSION_MINOR);
  1417. f->store_32(FORMAT_VERSION);
  1418. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1419. f->close();
  1420. memdelete(f);
  1421. return ERR_CANT_CREATE;
  1422. }
  1423. save_unicode_string(f, p_resource->get_class());
  1424. f->store_64(0); //offset to import metadata
  1425. for (int i = 0; i < 14; i++)
  1426. f->store_32(0); // reserved
  1427. List<ResourceData> resources;
  1428. {
  1429. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1430. ResourceData &rd = resources.push_back(ResourceData())->get();
  1431. rd.type = E->get()->get_class();
  1432. List<PropertyInfo> property_list;
  1433. E->get()->get_property_list(&property_list);
  1434. for (List<PropertyInfo>::Element *F = property_list.front(); F; F = F->next()) {
  1435. if (skip_editor && F->get().name.begins_with("__editor"))
  1436. continue;
  1437. if ((F->get().usage & PROPERTY_USAGE_STORAGE)) {
  1438. Property p;
  1439. p.name_idx = get_string_index(F->get().name);
  1440. if (F->get().usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
  1441. NonPersistentKey npk;
  1442. npk.base = E->get();
  1443. npk.property = F->get().name;
  1444. if (non_persistent_map.has(npk)) {
  1445. p.value = non_persistent_map[npk];
  1446. }
  1447. } else {
  1448. p.value = E->get()->get(F->get().name);
  1449. }
  1450. Variant default_value = ClassDB::class_get_default_property_value(E->get()->get_class(), F->get().name);
  1451. if (default_value.get_type() != Variant::NIL && bool(Variant::evaluate(Variant::OP_EQUAL, p.value, default_value))) {
  1452. continue;
  1453. }
  1454. p.pi = F->get();
  1455. rd.properties.push_back(p);
  1456. }
  1457. }
  1458. }
  1459. }
  1460. f->store_32(strings.size()); //string table size
  1461. for (int i = 0; i < strings.size(); i++) {
  1462. save_unicode_string(f, strings[i]);
  1463. }
  1464. // save external resource table
  1465. f->store_32(external_resources.size()); //amount of external resources
  1466. Vector<RES> save_order;
  1467. save_order.resize(external_resources.size());
  1468. for (Map<RES, int>::Element *E = external_resources.front(); E; E = E->next()) {
  1469. save_order.write[E->get()] = E->key();
  1470. }
  1471. for (int i = 0; i < save_order.size(); i++) {
  1472. save_unicode_string(f, save_order[i]->get_save_class());
  1473. String path = save_order[i]->get_path();
  1474. path = relative_paths ? local_path.path_to_file(path) : path;
  1475. save_unicode_string(f, path);
  1476. }
  1477. // save internal resource table
  1478. f->store_32(saved_resources.size()); //amount of internal resources
  1479. Vector<uint64_t> ofs_pos;
  1480. Set<int> used_indices;
  1481. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1482. RES r = E->get();
  1483. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1484. if (r->get_subindex() != 0) {
  1485. if (used_indices.has(r->get_subindex())) {
  1486. r->set_subindex(0); //repeated
  1487. } else {
  1488. used_indices.insert(r->get_subindex());
  1489. }
  1490. }
  1491. }
  1492. }
  1493. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1494. RES r = E->get();
  1495. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1496. if (r->get_subindex() == 0) {
  1497. int new_subindex = 1;
  1498. if (used_indices.size()) {
  1499. new_subindex = used_indices.back()->get() + 1;
  1500. }
  1501. r->set_subindex(new_subindex);
  1502. used_indices.insert(new_subindex);
  1503. }
  1504. save_unicode_string(f, "local://" + itos(r->get_subindex()));
  1505. if (takeover_paths) {
  1506. r->set_path(p_path + "::" + itos(r->get_subindex()), true);
  1507. }
  1508. #ifdef TOOLS_ENABLED
  1509. r->set_edited(false);
  1510. #endif
  1511. } else {
  1512. save_unicode_string(f, r->get_path()); //actual external
  1513. }
  1514. ofs_pos.push_back(f->get_position());
  1515. f->store_64(0); //offset in 64 bits
  1516. }
  1517. Vector<uint64_t> ofs_table;
  1518. //now actually save the resources
  1519. for (List<ResourceData>::Element *E = resources.front(); E; E = E->next()) {
  1520. ResourceData &rd = E->get();
  1521. ofs_table.push_back(f->get_position());
  1522. save_unicode_string(f, rd.type);
  1523. f->store_32(rd.properties.size());
  1524. for (List<Property>::Element *F = rd.properties.front(); F; F = F->next()) {
  1525. Property &p = F->get();
  1526. f->store_32(p.name_idx);
  1527. _write_variant(p.value, F->get().pi);
  1528. }
  1529. }
  1530. for (int i = 0; i < ofs_table.size(); i++) {
  1531. f->seek(ofs_pos[i]);
  1532. f->store_64(ofs_table[i]);
  1533. }
  1534. f->seek_end();
  1535. f->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
  1536. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1537. f->close();
  1538. memdelete(f);
  1539. return ERR_CANT_CREATE;
  1540. }
  1541. f->close();
  1542. memdelete(f);
  1543. return OK;
  1544. }
  1545. Error ResourceFormatSaverBinary::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1546. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1547. ResourceFormatSaverBinaryInstance saver;
  1548. return saver.save(local_path, p_resource, p_flags);
  1549. }
  1550. bool ResourceFormatSaverBinary::recognize(const RES &p_resource) const {
  1551. return true; //all recognized
  1552. }
  1553. void ResourceFormatSaverBinary::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1554. String base = p_resource->get_base_extension().to_lower();
  1555. p_extensions->push_back(base);
  1556. if (base != "res")
  1557. p_extensions->push_back("res");
  1558. }
  1559. ResourceFormatSaverBinary *ResourceFormatSaverBinary::singleton = NULL;
  1560. ResourceFormatSaverBinary::ResourceFormatSaverBinary() {
  1561. singleton = this;
  1562. }