resource_format_binary.cpp 48 KB

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