1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425 |
- /**************************************************************************/
- /* resource_format_text.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "resource_format_text.h"
- #include "core/config/project_settings.h"
- #include "core/io/dir_access.h"
- #include "core/io/missing_resource.h"
- #include "core/io/resource_format_binary.h"
- #include "core/object/script_language.h"
- #include "core/version.h"
- // Version 2: Changed names for Basis, AABB, Vectors, etc.
- // Version 3: New string ID for ext/subresources, breaks forward compat.
- #define FORMAT_VERSION 3
- // Version 4: PackedByteArray can be base64 encoded, and PackedVector4Array was added.
- // Parsing only, for forward compat with 4.3+.
- #define FORMAT_VERSION_READABLE 4
- #define BINARY_FORMAT_VERSION 4
- #include "core/io/dir_access.h"
- #include "core/version.h"
- #define _printerr() ERR_PRINT(String(res_path + ":" + itos(lines) + " - Parse Error: " + error_text).utf8().get_data());
- ///
- Ref<Resource> ResourceLoaderText::get_resource() {
- return resource;
- }
- Error ResourceLoaderText::_parse_sub_resource_dummy(DummyReadData *p_data, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) {
- VariantParser::Token token;
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_NUMBER && token.type != VariantParser::TK_STRING) {
- r_err_str = "Expected number (old style) or string (sub-resource index)";
- return ERR_PARSE_ERROR;
- }
- if (p_data->no_placeholders) {
- r_res.unref();
- } else {
- String unique_id = token.value;
- if (!p_data->resource_map.has(unique_id)) {
- r_err_str = "Found unique_id reference before mapping, sub-resources stored out of order in resource file";
- return ERR_PARSE_ERROR;
- }
- r_res = p_data->resource_map[unique_id];
- }
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_PARENTHESIS_CLOSE) {
- r_err_str = "Expected ')'";
- return ERR_PARSE_ERROR;
- }
- return OK;
- }
- Error ResourceLoaderText::_parse_ext_resource_dummy(DummyReadData *p_data, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) {
- VariantParser::Token token;
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_NUMBER && token.type != VariantParser::TK_STRING) {
- r_err_str = "Expected number (old style sub-resource index) or String (ext-resource ID)";
- return ERR_PARSE_ERROR;
- }
- if (p_data->no_placeholders) {
- r_res.unref();
- } else {
- String id = token.value;
- ERR_FAIL_COND_V(!p_data->rev_external_resources.has(id), ERR_PARSE_ERROR);
- r_res = p_data->rev_external_resources[id];
- }
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_PARENTHESIS_CLOSE) {
- r_err_str = "Expected ')'";
- return ERR_PARSE_ERROR;
- }
- return OK;
- }
- Error ResourceLoaderText::_parse_sub_resource(VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) {
- VariantParser::Token token;
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_NUMBER && token.type != VariantParser::TK_STRING) {
- r_err_str = "Expected number (old style sub-resource index) or string";
- return ERR_PARSE_ERROR;
- }
- String id = token.value;
- ERR_FAIL_COND_V(!int_resources.has(id), ERR_INVALID_PARAMETER);
- r_res = int_resources[id];
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_PARENTHESIS_CLOSE) {
- r_err_str = "Expected ')'";
- return ERR_PARSE_ERROR;
- }
- return OK;
- }
- Error ResourceLoaderText::_parse_ext_resource(VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) {
- VariantParser::Token token;
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_NUMBER && token.type != VariantParser::TK_STRING) {
- r_err_str = "Expected number (old style sub-resource index) or String (ext-resource ID)";
- return ERR_PARSE_ERROR;
- }
- String id = token.value;
- Error err = OK;
- if (!ignore_resource_parsing) {
- if (!ext_resources.has(id)) {
- r_err_str = "Can't load cached ext-resource id: " + id;
- return ERR_PARSE_ERROR;
- }
- String path = ext_resources[id].path;
- String type = ext_resources[id].type;
- Ref<ResourceLoader::LoadToken> &load_token = ext_resources[id].load_token;
- if (load_token.is_valid()) { // If not valid, it's OK since then we know this load accepts broken dependencies.
- Ref<Resource> res = ResourceLoader::_load_complete(*load_token.ptr(), &err);
- if (res.is_null()) {
- if (!ResourceLoader::is_cleaning_tasks()) {
- if (ResourceLoader::get_abort_on_missing_resources()) {
- error = ERR_FILE_MISSING_DEPENDENCIES;
- error_text = "[ext_resource] referenced non-existent resource at: " + path;
- _printerr();
- err = error;
- } else {
- ResourceLoader::notify_dependency_error(local_path, path, type);
- }
- }
- } else {
- #ifdef TOOLS_ENABLED
- //remember ID for saving
- res->set_id_for_path(local_path, id);
- #endif
- r_res = res;
- }
- } else {
- r_res = Ref<Resource>();
- }
- }
- VariantParser::get_token(p_stream, token, line, r_err_str);
- if (token.type != VariantParser::TK_PARENTHESIS_CLOSE) {
- r_err_str = "Expected ')'";
- return ERR_PARSE_ERROR;
- }
- return err;
- }
- Ref<PackedScene> ResourceLoaderText::_parse_node_tag(VariantParser::ResourceParser &parser) {
- Ref<PackedScene> packed_scene;
- packed_scene.instantiate();
- while (true) {
- if (next_tag.name == "node") {
- int parent = -1;
- int owner = -1;
- int type = -1;
- int name = -1;
- int instance = -1;
- int index = -1;
- //int base_scene=-1;
- if (next_tag.fields.has("name")) {
- name = packed_scene->get_state()->add_name(next_tag.fields["name"]);
- }
- if (next_tag.fields.has("parent")) {
- NodePath np = next_tag.fields["parent"];
- np.prepend_period(); //compatible to how it manages paths internally
- parent = packed_scene->get_state()->add_node_path(np);
- }
- if (next_tag.fields.has("type")) {
- type = packed_scene->get_state()->add_name(next_tag.fields["type"]);
- } else {
- type = SceneState::TYPE_INSTANTIATED; //no type? assume this was instantiated
- }
- HashSet<StringName> path_properties;
- if (next_tag.fields.has("node_paths")) {
- Vector<String> paths = next_tag.fields["node_paths"];
- for (int i = 0; i < paths.size(); i++) {
- path_properties.insert(paths[i]);
- }
- }
- if (next_tag.fields.has("instance")) {
- instance = packed_scene->get_state()->add_value(next_tag.fields["instance"]);
- if (packed_scene->get_state()->get_node_count() == 0 && parent == -1) {
- packed_scene->get_state()->set_base_scene(instance);
- instance = -1;
- }
- }
- if (next_tag.fields.has("instance_placeholder")) {
- String path = next_tag.fields["instance_placeholder"];
- int path_v = packed_scene->get_state()->add_value(path);
- if (packed_scene->get_state()->get_node_count() == 0) {
- error = ERR_FILE_CORRUPT;
- error_text = "Instance Placeholder can't be used for inheritance.";
- _printerr();
- return Ref<PackedScene>();
- }
- instance = path_v | SceneState::FLAG_INSTANCE_IS_PLACEHOLDER;
- }
- if (next_tag.fields.has("owner")) {
- owner = packed_scene->get_state()->add_node_path(next_tag.fields["owner"]);
- } else {
- if (parent != -1 && !(type == SceneState::TYPE_INSTANTIATED && instance == -1)) {
- owner = 0; //if no owner, owner is root
- }
- }
- if (next_tag.fields.has("index")) {
- index = next_tag.fields["index"];
- }
- int node_id = packed_scene->get_state()->add_node(parent, owner, type, name, instance, index);
- if (next_tag.fields.has("groups")) {
- Array groups = next_tag.fields["groups"];
- for (int i = 0; i < groups.size(); i++) {
- packed_scene->get_state()->add_node_group(node_id, packed_scene->get_state()->add_name(groups[i]));
- }
- }
- while (true) {
- String assign;
- Variant value;
- error = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, &parser);
- if (error) {
- if (error == ERR_FILE_MISSING_DEPENDENCIES) {
- // Resource loading error, just skip it.
- } else if (error != ERR_FILE_EOF) {
- _printerr();
- return Ref<PackedScene>();
- } else {
- error = OK;
- return packed_scene;
- }
- }
- if (!assign.is_empty()) {
- StringName assign_name = assign;
- int nameidx = packed_scene->get_state()->add_name(assign_name);
- int valueidx = packed_scene->get_state()->add_value(value);
- packed_scene->get_state()->add_node_property(node_id, nameidx, valueidx, path_properties.has(assign_name));
- //it's assignment
- } else if (!next_tag.name.is_empty()) {
- break;
- }
- }
- } else if (next_tag.name == "connection") {
- if (!next_tag.fields.has("from")) {
- error = ERR_FILE_CORRUPT;
- error_text = "missing 'from' field from connection tag";
- return Ref<PackedScene>();
- }
- if (!next_tag.fields.has("to")) {
- error = ERR_FILE_CORRUPT;
- error_text = "missing 'to' field from connection tag";
- return Ref<PackedScene>();
- }
- if (!next_tag.fields.has("signal")) {
- error = ERR_FILE_CORRUPT;
- error_text = "missing 'signal' field from connection tag";
- return Ref<PackedScene>();
- }
- if (!next_tag.fields.has("method")) {
- error = ERR_FILE_CORRUPT;
- error_text = "missing 'method' field from connection tag";
- return Ref<PackedScene>();
- }
- NodePath from = next_tag.fields["from"];
- NodePath to = next_tag.fields["to"];
- StringName method = next_tag.fields["method"];
- StringName signal = next_tag.fields["signal"];
- int flags = Object::CONNECT_PERSIST;
- int unbinds = 0;
- Array binds;
- if (next_tag.fields.has("flags")) {
- flags = next_tag.fields["flags"];
- }
- if (next_tag.fields.has("binds")) {
- binds = next_tag.fields["binds"];
- }
- if (next_tag.fields.has("unbinds")) {
- unbinds = next_tag.fields["unbinds"];
- }
- Vector<int> bind_ints;
- for (int i = 0; i < binds.size(); i++) {
- bind_ints.push_back(packed_scene->get_state()->add_value(binds[i]));
- }
- packed_scene->get_state()->add_connection(
- packed_scene->get_state()->add_node_path(from.simplified()),
- packed_scene->get_state()->add_node_path(to.simplified()),
- packed_scene->get_state()->add_name(signal),
- packed_scene->get_state()->add_name(method),
- flags,
- unbinds,
- bind_ints);
- error = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &parser);
- if (error) {
- if (error != ERR_FILE_EOF) {
- _printerr();
- return Ref<PackedScene>();
- } else {
- error = OK;
- return packed_scene;
- }
- }
- } else if (next_tag.name == "editable") {
- if (!next_tag.fields.has("path")) {
- error = ERR_FILE_CORRUPT;
- error_text = "missing 'path' field from editable tag";
- _printerr();
- return Ref<PackedScene>();
- }
- NodePath path = next_tag.fields["path"];
- packed_scene->get_state()->add_editable_instance(path.simplified());
- error = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &parser);
- if (error) {
- if (error != ERR_FILE_EOF) {
- _printerr();
- return Ref<PackedScene>();
- } else {
- error = OK;
- return packed_scene;
- }
- }
- } else {
- error = ERR_FILE_CORRUPT;
- _printerr();
- return Ref<PackedScene>();
- }
- }
- }
- Error ResourceLoaderText::load() {
- if (error != OK) {
- return error;
- }
- while (true) {
- if (next_tag.name != "ext_resource") {
- break;
- }
- if (!next_tag.fields.has("path")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'path' in external resource tag";
- _printerr();
- return error;
- }
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return error;
- }
- if (!next_tag.fields.has("id")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'id' in external resource tag";
- _printerr();
- return error;
- }
- String path = next_tag.fields["path"];
- String type = next_tag.fields["type"];
- String id = next_tag.fields["id"];
- if (next_tag.fields.has("uid")) {
- String uidt = next_tag.fields["uid"];
- ResourceUID::ID uid = ResourceUID::get_singleton()->text_to_id(uidt);
- if (uid != ResourceUID::INVALID_ID && ResourceUID::get_singleton()->has_id(uid)) {
- // If a UID is found and the path is valid, it will be used, otherwise, it falls back to the path.
- path = ResourceUID::get_singleton()->get_id_path(uid);
- } else {
- #ifdef TOOLS_ENABLED
- // Silence a warning that can happen during the initial filesystem scan due to cache being regenerated.
- if (ResourceLoader::get_resource_uid(path) != uid) {
- WARN_PRINT(String(res_path + ":" + itos(lines) + " - ext_resource, invalid UID: " + uidt + " - using text path instead: " + path).utf8().get_data());
- }
- #else
- WARN_PRINT(String(res_path + ":" + itos(lines) + " - ext_resource, invalid UID: " + uidt + " - using text path instead: " + path).utf8().get_data());
- #endif
- }
- }
- if (!path.contains("://") && path.is_relative_path()) {
- // path is relative to file being loaded, so convert to a resource path
- path = ProjectSettings::get_singleton()->localize_path(local_path.get_base_dir().path_join(path));
- }
- if (remaps.has(path)) {
- path = remaps[path];
- }
- ext_resources[id].path = path;
- ext_resources[id].type = type;
- ext_resources[id].load_token = ResourceLoader::_load_start(path, type, use_sub_threads ? ResourceLoader::LOAD_THREAD_DISTRIBUTE : ResourceLoader::LOAD_THREAD_FROM_CURRENT, ResourceFormatLoader::CACHE_MODE_REUSE);
- if (!ext_resources[id].load_token.is_valid()) {
- if (ResourceLoader::get_abort_on_missing_resources()) {
- error = ERR_FILE_CORRUPT;
- error_text = "[ext_resource] referenced non-existent resource at: " + path;
- _printerr();
- return error;
- } else {
- ResourceLoader::notify_dependency_error(local_path, path, type);
- }
- }
- error = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &rp);
- if (error) {
- _printerr();
- return error;
- }
- resource_current++;
- }
- //these are the ones that count
- resources_total -= resource_current;
- resource_current = 0;
- while (true) {
- if (next_tag.name != "sub_resource") {
- break;
- }
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return error;
- }
- if (!next_tag.fields.has("id")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'id' in external resource tag";
- _printerr();
- return error;
- }
- String type = next_tag.fields["type"];
- String id = next_tag.fields["id"];
- String path = local_path + "::" + id;
- //bool exists=ResourceCache::has(path);
- Ref<Resource> res;
- bool do_assign = false;
- if (cache_mode == ResourceFormatLoader::CACHE_MODE_REPLACE && ResourceCache::has(path)) {
- //reuse existing
- Ref<Resource> cache = ResourceCache::get_ref(path);
- if (cache.is_valid() && cache->get_class() == type) {
- res = cache;
- res->reset_state();
- do_assign = true;
- }
- }
- MissingResource *missing_resource = nullptr;
- if (res.is_null()) { //not reuse
- Ref<Resource> cache = ResourceCache::get_ref(path);
- if (cache_mode != ResourceFormatLoader::CACHE_MODE_IGNORE && cache.is_valid()) { //only if it doesn't exist
- //cached, do not assign
- res = cache;
- } else {
- //create
- Object *obj = ClassDB::instantiate(type);
- if (!obj) {
- if (ResourceLoader::is_creating_missing_resources_if_class_unavailable_enabled()) {
- missing_resource = memnew(MissingResource);
- missing_resource->set_original_class(type);
- missing_resource->set_recording_properties(true);
- obj = missing_resource;
- } else {
- error_text += "Can't create sub resource of type: " + type;
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- }
- Resource *r = Object::cast_to<Resource>(obj);
- if (!r) {
- error_text += "Can't create sub resource of type, because not a resource: " + type;
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- res = Ref<Resource>(r);
- do_assign = true;
- }
- }
- resource_current++;
- if (progress && resources_total > 0) {
- *progress = resource_current / float(resources_total);
- }
- int_resources[id] = res; // Always assign int resources.
- if (do_assign) {
- if (cache_mode != ResourceFormatLoader::CACHE_MODE_IGNORE) {
- res->set_path(path, cache_mode == ResourceFormatLoader::CACHE_MODE_REPLACE);
- } else if (!path.is_resource_file()) {
- res->set_path_cache(path);
- }
- res->set_scene_unique_id(id);
- }
- Dictionary missing_resource_properties;
- while (true) {
- String assign;
- Variant value;
- error = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, &rp);
- if (error) {
- _printerr();
- return error;
- }
- if (!assign.is_empty()) {
- if (do_assign) {
- bool set_valid = true;
- if (value.get_type() == Variant::OBJECT && missing_resource != nullptr) {
- // If the property being set is a missing resource (and the parent is not),
- // then setting it will most likely not work.
- // Instead, save it as metadata.
- Ref<MissingResource> mr = value;
- if (mr.is_valid()) {
- missing_resource_properties[assign] = mr;
- set_valid = false;
- }
- }
- if (value.get_type() == Variant::ARRAY) {
- Array set_array = value;
- bool is_get_valid = false;
- Variant get_value = res->get(assign, &is_get_valid);
- if (is_get_valid && get_value.get_type() == Variant::ARRAY) {
- Array get_array = get_value;
- if (!set_array.is_same_typed(get_array)) {
- value = Array(set_array, get_array.get_typed_builtin(), get_array.get_typed_class_name(), get_array.get_typed_script());
- }
- }
- }
- if (set_valid) {
- res->set(assign, value);
- }
- }
- //it's assignment
- } else if (!next_tag.name.is_empty()) {
- error = OK;
- break;
- } else {
- error = ERR_FILE_CORRUPT;
- error_text = "Premature end of file while parsing [sub_resource]";
- _printerr();
- return error;
- }
- }
- if (missing_resource) {
- missing_resource->set_recording_properties(false);
- }
- if (!missing_resource_properties.is_empty()) {
- res->set_meta(META_MISSING_RESOURCES, missing_resource_properties);
- }
- }
- while (true) {
- if (next_tag.name != "resource") {
- break;
- }
- if (is_scene) {
- error_text += "found the 'resource' tag on a scene file!";
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- Ref<Resource> cache = ResourceCache::get_ref(local_path);
- if (cache_mode == ResourceFormatLoader::CACHE_MODE_REPLACE && cache.is_valid() && cache->get_class() == res_type) {
- cache->reset_state();
- resource = cache;
- }
- MissingResource *missing_resource = nullptr;
- if (!resource.is_valid()) {
- Object *obj = ClassDB::instantiate(res_type);
- if (!obj) {
- if (ResourceLoader::is_creating_missing_resources_if_class_unavailable_enabled()) {
- missing_resource = memnew(MissingResource);
- missing_resource->set_original_class(res_type);
- missing_resource->set_recording_properties(true);
- obj = missing_resource;
- } else {
- error_text += "Can't create sub resource of type: " + res_type;
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- }
- Resource *r = Object::cast_to<Resource>(obj);
- if (!r) {
- error_text += "Can't create sub resource of type, because not a resource: " + res_type;
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- resource = Ref<Resource>(r);
- }
- Dictionary missing_resource_properties;
- while (true) {
- String assign;
- Variant value;
- error = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, &rp);
- if (error) {
- if (error != ERR_FILE_EOF) {
- _printerr();
- } else {
- error = OK;
- if (cache_mode != ResourceFormatLoader::CACHE_MODE_IGNORE) {
- if (!ResourceCache::has(res_path)) {
- resource->set_path(res_path);
- }
- resource->set_as_translation_remapped(translation_remapped);
- }
- }
- return error;
- }
- if (!assign.is_empty()) {
- bool set_valid = true;
- if (value.get_type() == Variant::OBJECT && missing_resource != nullptr) {
- // If the property being set is a missing resource (and the parent is not),
- // then setting it will most likely not work.
- // Instead, save it as metadata.
- Ref<MissingResource> mr = value;
- if (mr.is_valid()) {
- missing_resource_properties[assign] = mr;
- set_valid = false;
- }
- }
- if (value.get_type() == Variant::ARRAY) {
- Array set_array = value;
- bool is_get_valid = false;
- Variant get_value = resource->get(assign, &is_get_valid);
- if (is_get_valid && get_value.get_type() == Variant::ARRAY) {
- Array get_array = get_value;
- if (!set_array.is_same_typed(get_array)) {
- value = Array(set_array, get_array.get_typed_builtin(), get_array.get_typed_class_name(), get_array.get_typed_script());
- }
- }
- }
- if (set_valid) {
- resource->set(assign, value);
- }
- //it's assignment
- } else if (!next_tag.name.is_empty()) {
- error = ERR_FILE_CORRUPT;
- error_text = "Extra tag found when parsing main resource file";
- _printerr();
- return error;
- } else {
- break;
- }
- }
- resource_current++;
- if (progress && resources_total > 0) {
- *progress = resource_current / float(resources_total);
- }
- if (missing_resource) {
- missing_resource->set_recording_properties(false);
- }
- if (!missing_resource_properties.is_empty()) {
- resource->set_meta(META_MISSING_RESOURCES, missing_resource_properties);
- }
- error = OK;
- return error;
- }
- //for scene files
- if (next_tag.name == "node") {
- if (!is_scene) {
- error_text += "found the 'node' tag on a resource file!";
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- Ref<PackedScene> packed_scene = _parse_node_tag(rp);
- if (!packed_scene.is_valid()) {
- return error;
- }
- error = OK;
- //get it here
- resource = packed_scene;
- if (cache_mode != ResourceFormatLoader::CACHE_MODE_IGNORE && !ResourceCache::has(res_path)) {
- packed_scene->set_path(res_path);
- }
- resource_current++;
- if (progress && resources_total > 0) {
- *progress = resource_current / float(resources_total);
- }
- return error;
- } else {
- error_text += "Unknown tag in file: " + next_tag.name;
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- }
- int ResourceLoaderText::get_stage() const {
- return resource_current;
- }
- int ResourceLoaderText::get_stage_count() const {
- return resources_total; //+ext_resources;
- }
- void ResourceLoaderText::set_translation_remapped(bool p_remapped) {
- translation_remapped = p_remapped;
- }
- ResourceLoaderText::ResourceLoaderText() :
- stream(false) {}
- void ResourceLoaderText::get_dependencies(Ref<FileAccess> p_f, List<String> *p_dependencies, bool p_add_types) {
- open(p_f);
- ignore_resource_parsing = true;
- ERR_FAIL_COND(error != OK);
- while (next_tag.name == "ext_resource") {
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return;
- }
- if (!next_tag.fields.has("id")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'id' in external resource tag";
- _printerr();
- return;
- }
- String path = next_tag.fields["path"];
- String type = next_tag.fields["type"];
- String fallback_path;
- bool using_uid = false;
- if (next_tag.fields.has("uid")) {
- // If uid exists, return uid in text format, not the path.
- String uidt = next_tag.fields["uid"];
- ResourceUID::ID uid = ResourceUID::get_singleton()->text_to_id(uidt);
- if (uid != ResourceUID::INVALID_ID) {
- fallback_path = path; // Used by Dependency Editor, in case uid path fails.
- path = ResourceUID::get_singleton()->id_to_text(uid);
- using_uid = true;
- }
- }
- if (!using_uid && !path.contains("://") && path.is_relative_path()) {
- // Path is relative to file being loaded, so convert to a resource path.
- path = ProjectSettings::get_singleton()->localize_path(local_path.get_base_dir().path_join(path));
- }
- if (p_add_types) {
- path += "::" + type;
- }
- if (!fallback_path.is_empty()) {
- if (!p_add_types) {
- path += "::"; // Ensure that path comes third, even if there is no type.
- }
- path += "::" + fallback_path;
- }
- p_dependencies->push_back(path);
- Error err = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &rp);
- if (err) {
- print_line(error_text + " - " + itos(lines));
- error_text = "Unexpected end of file";
- _printerr();
- error = ERR_FILE_CORRUPT;
- return;
- }
- }
- }
- Error ResourceLoaderText::rename_dependencies(Ref<FileAccess> p_f, const String &p_path, const HashMap<String, String> &p_map) {
- open(p_f, true);
- ERR_FAIL_COND_V(error != OK, error);
- ignore_resource_parsing = true;
- //FileAccess
- Ref<FileAccess> fw;
- String base_path = local_path.get_base_dir();
- uint64_t tag_end = f->get_position();
- while (true) {
- Error err = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &rp);
- if (err != OK) {
- error = ERR_FILE_CORRUPT;
- ERR_FAIL_V(error);
- }
- if (next_tag.name != "ext_resource") {
- //nothing was done
- if (fw.is_null()) {
- return OK;
- }
- break;
- } else {
- if (fw.is_null()) {
- fw = FileAccess::open(p_path + ".depren", FileAccess::WRITE);
- if (res_uid == ResourceUID::INVALID_ID) {
- res_uid = ResourceSaver::get_resource_id_for_path(p_path);
- }
- String uid_text = "";
- if (res_uid != ResourceUID::INVALID_ID) {
- uid_text = " uid=\"" + ResourceUID::get_singleton()->id_to_text(res_uid) + "\"";
- }
- if (is_scene) {
- fw->store_line("[gd_scene load_steps=" + itos(resources_total) + " format=" + itos(FORMAT_VERSION) + uid_text + "]\n");
- } else {
- String script_res_text;
- if (!script_class.is_empty()) {
- script_res_text = "script_class=\"" + script_class + "\" ";
- }
- fw->store_line("[gd_resource type=\"" + res_type + "\" " + script_res_text + "load_steps=" + itos(resources_total) + " format=" + itos(FORMAT_VERSION) + uid_text + "]\n");
- }
- }
- if (!next_tag.fields.has("path") || !next_tag.fields.has("id") || !next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- ERR_FAIL_V(error);
- }
- String path = next_tag.fields["path"];
- String id = next_tag.fields["id"];
- String type = next_tag.fields["type"];
- if (next_tag.fields.has("uid")) {
- String uidt = next_tag.fields["uid"];
- ResourceUID::ID uid = ResourceUID::get_singleton()->text_to_id(uidt);
- if (uid != ResourceUID::INVALID_ID && ResourceUID::get_singleton()->has_id(uid)) {
- // If a UID is found and the path is valid, it will be used, otherwise, it falls back to the path.
- path = ResourceUID::get_singleton()->get_id_path(uid);
- }
- }
- bool relative = false;
- if (!path.begins_with("res://")) {
- path = base_path.path_join(path).simplify_path();
- relative = true;
- }
- if (p_map.has(path)) {
- String np = p_map[path];
- path = np;
- }
- if (relative) {
- //restore relative
- path = base_path.path_to_file(path);
- }
- String s = "[ext_resource type=\"" + type + "\"";
- ResourceUID::ID uid = ResourceSaver::get_resource_id_for_path(path);
- if (uid != ResourceUID::INVALID_ID) {
- s += " uid=\"" + ResourceUID::get_singleton()->id_to_text(uid) + "\"";
- }
- s += " path=\"" + path + "\" id=\"" + id + "\"]";
- fw->store_line(s); // Bundled.
- tag_end = f->get_position();
- }
- }
- f->seek(tag_end);
- const uint32_t buffer_size = 2048;
- uint8_t *buffer = (uint8_t *)alloca(buffer_size);
- uint32_t num_read;
- num_read = f->get_buffer(buffer, buffer_size);
- ERR_FAIL_COND_V_MSG(num_read == UINT32_MAX, ERR_CANT_CREATE, "Failed to allocate memory for buffer.");
- ERR_FAIL_COND_V(num_read == 0, ERR_FILE_CORRUPT);
- if (*buffer == '\n') {
- // Skip first newline character since we added one.
- if (num_read > 1) {
- fw->store_buffer(buffer + 1, num_read - 1);
- }
- } else {
- fw->store_buffer(buffer, num_read);
- }
- while (!f->eof_reached()) {
- num_read = f->get_buffer(buffer, buffer_size);
- fw->store_buffer(buffer, num_read);
- }
- bool all_ok = fw->get_error() == OK;
- if (!all_ok) {
- return ERR_CANT_CREATE;
- }
- return OK;
- }
- void ResourceLoaderText::open(Ref<FileAccess> p_f, bool p_skip_first_tag) {
- error = OK;
- lines = 1;
- f = p_f;
- stream.f = f;
- is_scene = false;
- ignore_resource_parsing = false;
- resource_current = 0;
- VariantParser::Tag tag;
- Error err = VariantParser::parse_tag(&stream, lines, error_text, tag);
- if (err) {
- error = err;
- _printerr();
- return;
- }
- if (tag.fields.has("format")) {
- int fmt = tag.fields["format"];
- if (fmt > FORMAT_VERSION_READABLE) {
- error_text = "Saved with newer format version";
- _printerr();
- error = ERR_PARSE_ERROR;
- return;
- }
- }
- if (tag.name == "gd_scene") {
- is_scene = true;
- } else if (tag.name == "gd_resource") {
- if (!tag.fields.has("type")) {
- error_text = "Missing 'type' field in 'gd_resource' tag";
- _printerr();
- error = ERR_PARSE_ERROR;
- return;
- }
- if (tag.fields.has("script_class")) {
- script_class = tag.fields["script_class"];
- }
- res_type = tag.fields["type"];
- } else {
- error_text = "Unrecognized file type: " + tag.name;
- _printerr();
- error = ERR_PARSE_ERROR;
- return;
- }
- if (tag.fields.has("uid")) {
- res_uid = ResourceUID::get_singleton()->text_to_id(tag.fields["uid"]);
- } else {
- res_uid = ResourceUID::INVALID_ID;
- }
- if (tag.fields.has("load_steps")) {
- resources_total = tag.fields["load_steps"];
- } else {
- resources_total = 0;
- }
- if (!p_skip_first_tag) {
- err = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &rp);
- if (err) {
- error_text = "Unexpected end of file";
- _printerr();
- error = ERR_FILE_CORRUPT;
- }
- }
- rp.ext_func = _parse_ext_resources;
- rp.sub_func = _parse_sub_resources;
- rp.userdata = this;
- }
- static void bs_save_unicode_string(Ref<FileAccess> p_f, const String &p_string, bool p_bit_on_len = false) {
- CharString utf8 = p_string.utf8();
- if (p_bit_on_len) {
- p_f->store_32((utf8.length() + 1) | 0x80000000);
- } else {
- p_f->store_32(utf8.length() + 1);
- }
- p_f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
- }
- Error ResourceLoaderText::save_as_binary(const String &p_path) {
- if (error) {
- return error;
- }
- Ref<FileAccess> wf = FileAccess::open(p_path, FileAccess::WRITE);
- if (wf.is_null()) {
- return ERR_CANT_OPEN;
- }
- //save header compressed
- static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
- wf->store_buffer(header, 4);
- wf->store_32(0); //endianness, little endian
- wf->store_32(0); //64 bits file, false for now
- wf->store_32(VERSION_MAJOR);
- wf->store_32(VERSION_MINOR);
- static const int save_format_version = BINARY_FORMAT_VERSION;
- wf->store_32(save_format_version);
- bs_save_unicode_string(wf, is_scene ? "PackedScene" : resource_type);
- wf->store_64(0); //offset to import metadata, this is no longer used
- wf->store_32(ResourceFormatSaverBinaryInstance::FORMAT_FLAG_NAMED_SCENE_IDS | ResourceFormatSaverBinaryInstance::FORMAT_FLAG_UIDS);
- wf->store_64(res_uid);
- for (int i = 0; i < ResourceFormatSaverBinaryInstance::RESERVED_FIELDS; i++) {
- wf->store_32(0); // reserved
- }
- wf->store_32(0); //string table size, will not be in use
- uint64_t ext_res_count_pos = wf->get_position();
- wf->store_32(0); //zero ext resources, still parsing them
- //go with external resources
- DummyReadData dummy_read;
- VariantParser::ResourceParser rp_new;
- rp_new.ext_func = _parse_ext_resource_dummys;
- rp_new.sub_func = _parse_sub_resource_dummys;
- rp_new.userdata = &dummy_read;
- while (next_tag.name == "ext_resource") {
- if (!next_tag.fields.has("path")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'path' in external resource tag";
- _printerr();
- return error;
- }
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return error;
- }
- if (!next_tag.fields.has("id")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'id' in external resource tag";
- _printerr();
- return error;
- }
- String path = next_tag.fields["path"];
- String type = next_tag.fields["type"];
- String id = next_tag.fields["id"];
- ResourceUID::ID uid = ResourceUID::INVALID_ID;
- if (next_tag.fields.has("uid")) {
- String uidt = next_tag.fields["uid"];
- uid = ResourceUID::get_singleton()->text_to_id(uidt);
- }
- bs_save_unicode_string(wf, type);
- bs_save_unicode_string(wf, path);
- wf->store_64(uid);
- int lindex = dummy_read.external_resources.size();
- Ref<DummyResource> dr;
- dr.instantiate();
- dr->set_path("res://dummy" + itos(lindex)); //anything is good to detect it for saving as external
- dummy_read.external_resources[dr] = lindex;
- dummy_read.rev_external_resources[id] = dr;
- error = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &rp_new);
- if (error) {
- _printerr();
- return error;
- }
- }
- // save external resource table
- wf->seek(ext_res_count_pos);
- wf->store_32(dummy_read.external_resources.size());
- wf->seek_end();
- //now, save resources to a separate file, for now
- uint64_t sub_res_count_pos = wf->get_position();
- wf->store_32(0); //zero sub resources, still parsing them
- String temp_file = p_path + ".temp";
- Vector<uint64_t> local_offsets;
- Vector<uint64_t> local_pointers_pos;
- {
- Ref<FileAccess> wf2 = FileAccess::open(temp_file, FileAccess::WRITE);
- if (wf2.is_null()) {
- return ERR_CANT_OPEN;
- }
- while (next_tag.name == "sub_resource" || next_tag.name == "resource") {
- String type;
- String id;
- bool main_res;
- if (next_tag.name == "sub_resource") {
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return error;
- }
- if (!next_tag.fields.has("id")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'id' in external resource tag";
- _printerr();
- return error;
- }
- type = next_tag.fields["type"];
- id = next_tag.fields["id"];
- main_res = false;
- if (!dummy_read.resource_map.has(id)) {
- Ref<DummyResource> dr;
- dr.instantiate();
- dr->set_scene_unique_id(id);
- dummy_read.resource_map[id] = dr;
- uint32_t im_size = dummy_read.resource_index_map.size();
- dummy_read.resource_index_map.insert(dr, im_size);
- }
- } else {
- type = res_type;
- String uid_text = ResourceUID::get_singleton()->id_to_text(res_uid);
- id = type + "_" + uid_text.replace("uid://", "").replace("<invalid>", "0");
- main_res = true;
- }
- local_offsets.push_back(wf2->get_position());
- bs_save_unicode_string(wf, "local://" + id);
- local_pointers_pos.push_back(wf->get_position());
- wf->store_64(0); //temp local offset
- bs_save_unicode_string(wf2, type);
- uint64_t propcount_ofs = wf2->get_position();
- wf2->store_32(0);
- int prop_count = 0;
- while (true) {
- String assign;
- Variant value;
- error = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, &rp_new);
- if (error) {
- if (main_res && error == ERR_FILE_EOF) {
- next_tag.name = ""; //exit
- break;
- }
- _printerr();
- return error;
- }
- if (!assign.is_empty()) {
- HashMap<StringName, int> empty_string_map; //unused
- bs_save_unicode_string(wf2, assign, true);
- ResourceFormatSaverBinaryInstance::write_variant(wf2, value, dummy_read.resource_index_map, dummy_read.external_resources, empty_string_map);
- prop_count++;
- } else if (!next_tag.name.is_empty()) {
- error = OK;
- break;
- } else {
- error = ERR_FILE_CORRUPT;
- error_text = "Premature end of file while parsing [sub_resource]";
- _printerr();
- return error;
- }
- }
- wf2->seek(propcount_ofs);
- wf2->store_32(prop_count);
- wf2->seek_end();
- }
- if (next_tag.name == "node") {
- // This is a node, must save one more!
- if (!is_scene) {
- error_text += "found the 'node' tag on a resource file!";
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- Ref<PackedScene> packed_scene = _parse_node_tag(rp_new);
- if (!packed_scene.is_valid()) {
- return error;
- }
- error = OK;
- //get it here
- List<PropertyInfo> props;
- packed_scene->get_property_list(&props);
- String id = "PackedScene_" + ResourceUID::get_singleton()->id_to_text(res_uid).replace("uid://", "").replace("<invalid>", "0");
- bs_save_unicode_string(wf, "local://" + id);
- local_pointers_pos.push_back(wf->get_position());
- wf->store_64(0); //temp local offset
- local_offsets.push_back(wf2->get_position());
- bs_save_unicode_string(wf2, "PackedScene");
- uint64_t propcount_ofs = wf2->get_position();
- wf2->store_32(0);
- int prop_count = 0;
- for (const PropertyInfo &E : props) {
- if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
- continue;
- }
- String name = E.name;
- Variant value = packed_scene->get(name);
- HashMap<StringName, int> empty_string_map; //unused
- bs_save_unicode_string(wf2, name, true);
- ResourceFormatSaverBinaryInstance::write_variant(wf2, value, dummy_read.resource_index_map, dummy_read.external_resources, empty_string_map);
- prop_count++;
- }
- wf2->seek(propcount_ofs);
- wf2->store_32(prop_count);
- wf2->seek_end();
- }
- }
- uint64_t offset_from = wf->get_position();
- wf->seek(sub_res_count_pos); //plus one because the saved one
- wf->store_32(local_offsets.size());
- for (int i = 0; i < local_offsets.size(); i++) {
- wf->seek(local_pointers_pos[i]);
- wf->store_64(local_offsets[i] + offset_from);
- }
- wf->seek_end();
- Vector<uint8_t> data = FileAccess::get_file_as_bytes(temp_file);
- wf->store_buffer(data.ptr(), data.size());
- {
- Ref<DirAccess> dar = DirAccess::open(temp_file.get_base_dir());
- ERR_FAIL_COND_V(dar.is_null(), FAILED);
- dar->remove(temp_file);
- }
- wf->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
- return OK;
- }
- Error ResourceLoaderText::get_classes_used(HashSet<StringName> *r_classes) {
- if (error) {
- return error;
- }
- ignore_resource_parsing = true;
- DummyReadData dummy_read;
- dummy_read.no_placeholders = true;
- VariantParser::ResourceParser rp_new;
- rp_new.ext_func = _parse_ext_resource_dummys;
- rp_new.sub_func = _parse_sub_resource_dummys;
- rp_new.userdata = &dummy_read;
- while (next_tag.name == "ext_resource") {
- error = VariantParser::parse_tag(&stream, lines, error_text, next_tag, &rp_new);
- if (error) {
- _printerr();
- return error;
- }
- }
- while (next_tag.name == "sub_resource" || next_tag.name == "resource") {
- if (next_tag.name == "sub_resource") {
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return error;
- }
- r_classes->insert(next_tag.fields["type"]);
- } else {
- r_classes->insert(next_tag.fields["res_type"]);
- }
- while (true) {
- String assign;
- Variant value;
- error = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, &rp_new);
- if (error) {
- if (error == ERR_FILE_EOF) {
- return OK;
- }
- _printerr();
- return error;
- }
- if (!assign.is_empty()) {
- continue;
- } else if (!next_tag.name.is_empty()) {
- error = OK;
- break;
- } else {
- error = ERR_FILE_CORRUPT;
- error_text = "Premature end of file while parsing [sub_resource]";
- _printerr();
- return error;
- }
- }
- }
- while (next_tag.name == "node") {
- // This is a node, must save one more!
- if (!is_scene) {
- error_text += "found the 'node' tag on a resource file!";
- _printerr();
- error = ERR_FILE_CORRUPT;
- return error;
- }
- if (!next_tag.fields.has("type")) {
- error = ERR_FILE_CORRUPT;
- error_text = "Missing 'type' in external resource tag";
- _printerr();
- return error;
- }
- r_classes->insert(next_tag.fields["type"]);
- while (true) {
- String assign;
- Variant value;
- error = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, &rp_new);
- if (error) {
- if (error == ERR_FILE_MISSING_DEPENDENCIES) {
- // Resource loading error, just skip it.
- } else if (error != ERR_FILE_EOF) {
- _printerr();
- return error;
- } else {
- return OK;
- }
- }
- if (!assign.is_empty()) {
- continue;
- } else if (!next_tag.name.is_empty()) {
- error = OK;
- break;
- } else {
- error = ERR_FILE_CORRUPT;
- error_text = "Premature end of file while parsing [sub_resource]";
- _printerr();
- return error;
- }
- }
- }
- return OK;
- }
- String ResourceLoaderText::recognize_script_class(Ref<FileAccess> p_f) {
- error = OK;
- lines = 1;
- f = p_f;
- stream.f = f;
- ignore_resource_parsing = true;
- VariantParser::Tag tag;
- Error err = VariantParser::parse_tag(&stream, lines, error_text, tag);
- if (err) {
- _printerr();
- return "";
- }
- if (tag.fields.has("format")) {
- int fmt = tag.fields["format"];
- if (fmt > FORMAT_VERSION_READABLE) {
- error_text = "Saved with newer format version";
- _printerr();
- return "";
- }
- }
- if (tag.name != "gd_resource") {
- return "";
- }
- if (tag.fields.has("script_class")) {
- return tag.fields["script_class"];
- }
- return "";
- }
- String ResourceLoaderText::recognize(Ref<FileAccess> p_f) {
- error = OK;
- lines = 1;
- f = p_f;
- stream.f = f;
- ignore_resource_parsing = true;
- VariantParser::Tag tag;
- Error err = VariantParser::parse_tag(&stream, lines, error_text, tag);
- if (err) {
- _printerr();
- return "";
- }
- if (tag.fields.has("format")) {
- int fmt = tag.fields["format"];
- if (fmt > FORMAT_VERSION_READABLE) {
- error_text = "Saved with newer format version";
- _printerr();
- return "";
- }
- }
- if (tag.name == "gd_scene") {
- return "PackedScene";
- }
- if (tag.name != "gd_resource") {
- return "";
- }
- if (!tag.fields.has("type")) {
- error_text = "Missing 'type' field in 'gd_resource' tag";
- _printerr();
- return "";
- }
- return tag.fields["type"];
- }
- ResourceUID::ID ResourceLoaderText::get_uid(Ref<FileAccess> p_f) {
- error = OK;
- lines = 1;
- f = p_f;
- stream.f = f;
- ignore_resource_parsing = true;
- VariantParser::Tag tag;
- Error err = VariantParser::parse_tag(&stream, lines, error_text, tag);
- if (err) {
- _printerr();
- return ResourceUID::INVALID_ID;
- }
- if (tag.fields.has("uid")) { //field is optional
- String uidt = tag.fields["uid"];
- return ResourceUID::get_singleton()->text_to_id(uidt);
- }
- return ResourceUID::INVALID_ID;
- }
- /////////////////////
- Ref<Resource> ResourceFormatLoaderText::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
- if (r_error) {
- *r_error = ERR_CANT_OPEN;
- }
- Error err;
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
- ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Cannot open file '" + p_path + "'.");
- ResourceLoaderText loader;
- String path = !p_original_path.is_empty() ? p_original_path : p_path;
- loader.cache_mode = p_cache_mode;
- loader.use_sub_threads = p_use_sub_threads;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(path);
- loader.progress = r_progress;
- loader.res_path = loader.local_path;
- loader.open(f);
- err = loader.load();
- if (r_error) {
- *r_error = err;
- }
- if (err == OK) {
- return loader.get_resource();
- } else {
- return Ref<Resource>();
- }
- }
- void ResourceFormatLoaderText::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
- if (p_type.is_empty()) {
- get_recognized_extensions(p_extensions);
- return;
- }
- if (ClassDB::is_parent_class("PackedScene", p_type)) {
- p_extensions->push_back("tscn");
- }
- // Don't allow .tres for PackedScenes.
- if (p_type != "PackedScene") {
- p_extensions->push_back("tres");
- }
- }
- void ResourceFormatLoaderText::get_recognized_extensions(List<String> *p_extensions) const {
- p_extensions->push_back("tscn");
- p_extensions->push_back("tres");
- }
- bool ResourceFormatLoaderText::handles_type(const String &p_type) const {
- return true;
- }
- void ResourceFormatLoaderText::get_classes_used(const String &p_path, HashSet<StringName> *r_classes) {
- String ext = p_path.get_extension().to_lower();
- if (ext == "tscn") {
- r_classes->insert("PackedScene");
- }
- // ...for anything else must test...
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
- if (f.is_null()) {
- return; // Could not read.
- }
- ResourceLoaderText loader;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- loader.res_path = loader.local_path;
- loader.open(f);
- loader.get_classes_used(r_classes);
- }
- String ResourceFormatLoaderText::get_resource_type(const String &p_path) const {
- String ext = p_path.get_extension().to_lower();
- if (ext == "tscn") {
- return "PackedScene";
- } else if (ext != "tres") {
- return String();
- }
- // ...for anything else must test...
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
- if (f.is_null()) {
- return ""; //could not read
- }
- ResourceLoaderText loader;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- loader.res_path = loader.local_path;
- String r = loader.recognize(f);
- return ClassDB::get_compatibility_remapped_class(r);
- }
- String ResourceFormatLoaderText::get_resource_script_class(const String &p_path) const {
- String ext = p_path.get_extension().to_lower();
- if (ext != "tres") {
- return String();
- }
- // ...for anything else must test...
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
- if (f.is_null()) {
- return ""; //could not read
- }
- ResourceLoaderText loader;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- loader.res_path = loader.local_path;
- return loader.recognize_script_class(f);
- }
- ResourceUID::ID ResourceFormatLoaderText::get_resource_uid(const String &p_path) const {
- String ext = p_path.get_extension().to_lower();
- if (ext != "tscn" && ext != "tres") {
- return ResourceUID::INVALID_ID;
- }
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
- if (f.is_null()) {
- return ResourceUID::INVALID_ID; //could not read
- }
- ResourceLoaderText loader;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- loader.res_path = loader.local_path;
- return loader.get_uid(f);
- }
- void ResourceFormatLoaderText::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
- if (f.is_null()) {
- ERR_FAIL();
- }
- ResourceLoaderText loader;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- loader.res_path = loader.local_path;
- loader.get_dependencies(f, p_dependencies, p_add_types);
- }
- Error ResourceFormatLoaderText::rename_dependencies(const String &p_path, const HashMap<String, String> &p_map) {
- Error err = OK;
- {
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
- if (f.is_null()) {
- ERR_FAIL_V(ERR_CANT_OPEN);
- }
- ResourceLoaderText loader;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- loader.res_path = loader.local_path;
- err = loader.rename_dependencies(f, p_path, p_map);
- }
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- if (err == OK && da->file_exists(p_path + ".depren")) {
- da->remove(p_path);
- da->rename(p_path + ".depren", p_path);
- }
- return err;
- }
- ResourceFormatLoaderText *ResourceFormatLoaderText::singleton = nullptr;
- Error ResourceFormatLoaderText::convert_file_to_binary(const String &p_src_path, const String &p_dst_path) {
- Error err;
- Ref<FileAccess> f = FileAccess::open(p_src_path, FileAccess::READ, &err);
- ERR_FAIL_COND_V_MSG(err != OK, ERR_CANT_OPEN, "Cannot open file '" + p_src_path + "'.");
- ResourceLoaderText loader;
- const String &path = p_src_path;
- loader.local_path = ProjectSettings::get_singleton()->localize_path(path);
- loader.res_path = loader.local_path;
- loader.open(f);
- return loader.save_as_binary(p_dst_path);
- }
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- /*****************************************************************************************************/
- String ResourceFormatSaverTextInstance::_write_resources(void *ud, const Ref<Resource> &p_resource) {
- ResourceFormatSaverTextInstance *rsi = static_cast<ResourceFormatSaverTextInstance *>(ud);
- return rsi->_write_resource(p_resource);
- }
- String ResourceFormatSaverTextInstance::_write_resource(const Ref<Resource> &res) {
- if (res->get_meta(SNAME("_skip_save_"), false)) {
- return "null";
- }
- if (external_resources.has(res)) {
- return "ExtResource(\"" + external_resources[res] + "\")";
- } else {
- if (internal_resources.has(res)) {
- return "SubResource(\"" + internal_resources[res] + "\")";
- } else if (!res->is_built_in()) {
- if (res->get_path() == local_path) { //circular reference attempt
- return "null";
- }
- //external resource
- String path = relative_paths ? local_path.path_to_file(res->get_path()) : res->get_path();
- return "Resource(\"" + path + "\")";
- } else {
- ERR_FAIL_V_MSG("null", "Resource was not pre cached for the resource section, bug?");
- //internal resource
- }
- }
- }
- void ResourceFormatSaverTextInstance::_find_resources(const Variant &p_variant, bool p_main) {
- switch (p_variant.get_type()) {
- case Variant::OBJECT: {
- Ref<Resource> res = p_variant;
- if (res.is_null() || external_resources.has(res) || res->get_meta(SNAME("_skip_save_"), false)) {
- return;
- }
- if (!p_main && (!bundle_resources) && !res->is_built_in()) {
- if (res->get_path() == local_path) {
- ERR_PRINT("Circular reference to resource being saved found: '" + local_path + "' will be null next time it's loaded.");
- return;
- }
- // Use a numeric ID as a base, because they are sorted in natural order before saving.
- // This increases the chances of thread loading to fetch them first.
- String id = itos(external_resources.size() + 1) + "_" + Resource::generate_scene_unique_id();
- external_resources[res] = id;
- return;
- }
- if (resource_set.has(res)) {
- return;
- }
- resource_set.insert(res);
- List<PropertyInfo> property_list;
- res->get_property_list(&property_list);
- property_list.sort();
- List<PropertyInfo>::Element *I = property_list.front();
- while (I) {
- PropertyInfo pi = I->get();
- if (pi.usage & PROPERTY_USAGE_STORAGE) {
- Variant v = res->get(I->get().name);
- if (pi.usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
- NonPersistentKey npk;
- npk.base = res;
- npk.property = pi.name;
- non_persistent_map[npk] = v;
- Ref<Resource> sres = v;
- if (sres.is_valid()) {
- resource_set.insert(sres);
- saved_resources.push_back(sres);
- } else {
- _find_resources(v);
- }
- } else {
- _find_resources(v);
- }
- }
- I = I->next();
- }
- saved_resources.push_back(res); // Saved after, so the children it needs are available when loaded
- } break;
- case Variant::ARRAY: {
- Array varray = p_variant;
- int len = varray.size();
- for (int i = 0; i < len; i++) {
- const Variant &v = varray.get(i);
- _find_resources(v);
- }
- } break;
- case Variant::DICTIONARY: {
- Dictionary d = p_variant;
- List<Variant> keys;
- d.get_key_list(&keys);
- for (const Variant &E : keys) {
- // Of course keys should also be cached, after all we can't prevent users from using resources as keys, right?
- // See also ResourceFormatSaverBinaryInstance::_find_resources (when p_variant is of type Variant::DICTIONARY)
- _find_resources(E);
- Variant v = d[E];
- _find_resources(v);
- }
- } break;
- default: {
- }
- }
- }
- static String _resource_get_class(Ref<Resource> p_resource) {
- Ref<MissingResource> missing_resource = p_resource;
- if (missing_resource.is_valid()) {
- return missing_resource->get_original_class();
- } else {
- return p_resource->get_class();
- }
- }
- Error ResourceFormatSaverTextInstance::save(const String &p_path, const Ref<Resource> &p_resource, uint32_t p_flags) {
- if (p_path.ends_with(".tscn")) {
- packed_scene = p_resource;
- }
- Error err;
- Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::WRITE, &err);
- ERR_FAIL_COND_V_MSG(err, ERR_CANT_OPEN, "Cannot save file '" + p_path + "'.");
- Ref<FileAccess> _fref(f);
- local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
- skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
- bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
- takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
- if (!p_path.begins_with("res://")) {
- takeover_paths = false;
- }
- // Save resources.
- _find_resources(p_resource, true);
- if (packed_scene.is_valid()) {
- // Add instances to external resources if saving a packed scene.
- for (int i = 0; i < packed_scene->get_state()->get_node_count(); i++) {
- if (packed_scene->get_state()->is_node_instance_placeholder(i)) {
- continue;
- }
- Ref<PackedScene> instance = packed_scene->get_state()->get_node_instance(i);
- if (instance.is_valid() && !external_resources.has(instance)) {
- int index = external_resources.size() + 1;
- external_resources[instance] = itos(index) + "_" + Resource::generate_scene_unique_id(); // Keep the order for improved thread loading performance.
- }
- }
- }
- {
- String title = packed_scene.is_valid() ? "[gd_scene " : "[gd_resource ";
- if (packed_scene.is_null()) {
- title += "type=\"" + _resource_get_class(p_resource) + "\" ";
- Ref<Script> script = p_resource->get_script();
- if (script.is_valid() && script->get_global_name()) {
- title += "script_class=\"" + String(script->get_global_name()) + "\" ";
- }
- }
- int load_steps = saved_resources.size() + external_resources.size();
- if (load_steps > 1) {
- title += "load_steps=" + itos(load_steps) + " ";
- }
- title += "format=" + itos(FORMAT_VERSION) + "";
- ResourceUID::ID uid = ResourceSaver::get_resource_id_for_path(local_path, true);
- if (uid != ResourceUID::INVALID_ID) {
- title += " uid=\"" + ResourceUID::get_singleton()->id_to_text(uid) + "\"";
- }
- f->store_string(title);
- f->store_line("]\n"); // One empty line.
- }
- #ifdef TOOLS_ENABLED
- // Keep order from cached ids.
- HashSet<String> cached_ids_found;
- for (KeyValue<Ref<Resource>, String> &E : external_resources) {
- String cached_id = E.key->get_id_for_path(local_path);
- if (cached_id.is_empty() || cached_ids_found.has(cached_id)) {
- int sep_pos = E.value.find("_");
- if (sep_pos != -1) {
- E.value = E.value.substr(0, sep_pos + 1); // Keep the order found, for improved thread loading performance.
- } else {
- E.value = "";
- }
- } else {
- E.value = cached_id;
- cached_ids_found.insert(cached_id);
- }
- }
- // Create IDs for non cached resources.
- for (KeyValue<Ref<Resource>, String> &E : external_resources) {
- if (cached_ids_found.has(E.value)) { // Already cached, go on.
- continue;
- }
- String attempt;
- while (true) {
- attempt = E.value + Resource::generate_scene_unique_id();
- if (!cached_ids_found.has(attempt)) {
- break;
- }
- }
- cached_ids_found.insert(attempt);
- E.value = attempt;
- // Update also in resource.
- Ref<Resource> res = E.key;
- res->set_id_for_path(local_path, attempt);
- }
- #else
- // Make sure to start from one, as it makes format more readable.
- int counter = 1;
- for (KeyValue<Ref<Resource>, String> &E : external_resources) {
- E.value = itos(counter++);
- }
- #endif
- Vector<ResourceSort> sorted_er;
- for (const KeyValue<Ref<Resource>, String> &E : external_resources) {
- ResourceSort rs;
- rs.resource = E.key;
- rs.id = E.value;
- sorted_er.push_back(rs);
- }
- sorted_er.sort();
- for (int i = 0; i < sorted_er.size(); i++) {
- String p = sorted_er[i].resource->get_path();
- String s = "[ext_resource type=\"" + sorted_er[i].resource->get_save_class() + "\"";
- ResourceUID::ID uid = ResourceSaver::get_resource_id_for_path(p, false);
- if (uid != ResourceUID::INVALID_ID) {
- s += " uid=\"" + ResourceUID::get_singleton()->id_to_text(uid) + "\"";
- }
- s += " path=\"" + p + "\" id=\"" + sorted_er[i].id + "\"]\n";
- f->store_string(s); // Bundled.
- }
- if (external_resources.size()) {
- f->store_line(String()); // Separate.
- }
- HashSet<String> used_unique_ids;
- for (List<Ref<Resource>>::Element *E = saved_resources.front(); E; E = E->next()) {
- Ref<Resource> res = E->get();
- if (E->next() && res->is_built_in()) {
- if (!res->get_scene_unique_id().is_empty()) {
- if (used_unique_ids.has(res->get_scene_unique_id())) {
- res->set_scene_unique_id(""); // Repeated.
- } else {
- used_unique_ids.insert(res->get_scene_unique_id());
- }
- }
- }
- }
- for (List<Ref<Resource>>::Element *E = saved_resources.front(); E; E = E->next()) {
- Ref<Resource> res = E->get();
- ERR_CONTINUE(!resource_set.has(res));
- bool main = (E->next() == nullptr);
- if (main && packed_scene.is_valid()) {
- break; // Save as a scene.
- }
- if (main) {
- f->store_line("[resource]");
- } else {
- String line = "[sub_resource ";
- if (res->get_scene_unique_id().is_empty()) {
- String new_id;
- while (true) {
- new_id = _resource_get_class(res) + "_" + Resource::generate_scene_unique_id();
- if (!used_unique_ids.has(new_id)) {
- break;
- }
- }
- res->set_scene_unique_id(new_id);
- used_unique_ids.insert(new_id);
- }
- String id = res->get_scene_unique_id();
- line += "type=\"" + _resource_get_class(res) + "\" id=\"" + id;
- f->store_line(line + "\"]");
- if (takeover_paths) {
- res->set_path(p_path + "::" + id, true);
- }
- internal_resources[res] = id;
- #ifdef TOOLS_ENABLED
- res->set_edited(false);
- #endif
- }
- Dictionary missing_resource_properties = p_resource->get_meta(META_MISSING_RESOURCES, Dictionary());
- List<PropertyInfo> property_list;
- res->get_property_list(&property_list);
- for (List<PropertyInfo>::Element *PE = property_list.front(); PE; PE = PE->next()) {
- if (skip_editor && PE->get().name.begins_with("__editor")) {
- continue;
- }
- if (PE->get().name == META_PROPERTY_MISSING_RESOURCES) {
- continue;
- }
- if (PE->get().usage & PROPERTY_USAGE_STORAGE) {
- String name = PE->get().name;
- Variant value;
- if (PE->get().usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
- NonPersistentKey npk;
- npk.base = res;
- npk.property = name;
- if (non_persistent_map.has(npk)) {
- value = non_persistent_map[npk];
- }
- } else {
- value = res->get(name);
- }
- if (PE->get().type == Variant::OBJECT && missing_resource_properties.has(PE->get().name)) {
- // Was this missing resource overridden? If so do not save the old value.
- Ref<Resource> ures = value;
- if (ures.is_null()) {
- value = missing_resource_properties[PE->get().name];
- }
- }
- Variant default_value = ClassDB::class_get_default_property_value(res->get_class(), name);
- if (default_value.get_type() != Variant::NIL && bool(Variant::evaluate(Variant::OP_EQUAL, value, default_value))) {
- continue;
- }
- if (PE->get().type == Variant::OBJECT && value.is_zero() && !(PE->get().usage & PROPERTY_USAGE_STORE_IF_NULL)) {
- continue;
- }
- String vars;
- VariantWriter::write_to_string(value, vars, _write_resources, this);
- f->store_string(name.property_name_encode() + " = " + vars + "\n");
- }
- }
- if (E->next()) {
- f->store_line(String());
- }
- }
- if (packed_scene.is_valid()) {
- // If this is a scene, save nodes and connections!
- Ref<SceneState> state = packed_scene->get_state();
- for (int i = 0; i < state->get_node_count(); i++) {
- StringName type = state->get_node_type(i);
- StringName name = state->get_node_name(i);
- int index = state->get_node_index(i);
- NodePath path = state->get_node_path(i, true);
- NodePath owner = state->get_node_owner_path(i);
- Ref<PackedScene> instance = state->get_node_instance(i);
- String instance_placeholder = state->get_node_instance_placeholder(i);
- Vector<StringName> groups = state->get_node_groups(i);
- Vector<String> deferred_node_paths = state->get_node_deferred_nodepath_properties(i);
- String header = "[node";
- header += " name=\"" + String(name).c_escape() + "\"";
- if (type != StringName()) {
- header += " type=\"" + String(type) + "\"";
- }
- if (path != NodePath()) {
- header += " parent=\"" + String(path.simplified()).c_escape() + "\"";
- }
- if (owner != NodePath() && owner != NodePath(".")) {
- header += " owner=\"" + String(owner.simplified()).c_escape() + "\"";
- }
- if (index >= 0) {
- header += " index=\"" + itos(index) + "\"";
- }
- if (deferred_node_paths.size()) {
- header += " node_paths=" + Variant(deferred_node_paths).get_construct_string();
- }
- if (groups.size()) {
- // Write all groups on the same line as they're part of a section header.
- // This improves readability while not impacting VCS friendliness too much,
- // since it's rare to have more than 5 groups assigned to a single node.
- groups.sort_custom<StringName::AlphCompare>();
- String sgroups = " groups=[";
- for (int j = 0; j < groups.size(); j++) {
- sgroups += "\"" + String(groups[j]).c_escape() + "\"";
- if (j < groups.size() - 1) {
- sgroups += ", ";
- }
- }
- sgroups += "]";
- header += sgroups;
- }
- f->store_string(header);
- if (!instance_placeholder.is_empty()) {
- String vars;
- f->store_string(" instance_placeholder=");
- VariantWriter::write_to_string(instance_placeholder, vars, _write_resources, this);
- f->store_string(vars);
- }
- if (instance.is_valid()) {
- String vars;
- f->store_string(" instance=");
- VariantWriter::write_to_string(instance, vars, _write_resources, this);
- f->store_string(vars);
- }
- f->store_line("]");
- for (int j = 0; j < state->get_node_property_count(i); j++) {
- String vars;
- VariantWriter::write_to_string(state->get_node_property_value(i, j), vars, _write_resources, this);
- f->store_string(String(state->get_node_property_name(i, j)).property_name_encode() + " = " + vars + "\n");
- }
- if (i < state->get_node_count() - 1) {
- f->store_line(String());
- }
- }
- for (int i = 0; i < state->get_connection_count(); i++) {
- if (i == 0) {
- f->store_line("");
- }
- String connstr = "[connection";
- connstr += " signal=\"" + String(state->get_connection_signal(i)).c_escape() + "\"";
- connstr += " from=\"" + String(state->get_connection_source(i).simplified()).c_escape() + "\"";
- connstr += " to=\"" + String(state->get_connection_target(i).simplified()).c_escape() + "\"";
- connstr += " method=\"" + String(state->get_connection_method(i)).c_escape() + "\"";
- int flags = state->get_connection_flags(i);
- if (flags != Object::CONNECT_PERSIST) {
- connstr += " flags=" + itos(flags);
- }
- int unbinds = state->get_connection_unbinds(i);
- if (unbinds > 0) {
- connstr += " unbinds=" + itos(unbinds);
- }
- Array binds = state->get_connection_binds(i);
- f->store_string(connstr);
- if (binds.size()) {
- String vars;
- VariantWriter::write_to_string(binds, vars, _write_resources, this);
- f->store_string(" binds= " + vars);
- }
- f->store_line("]");
- }
- Vector<NodePath> editable_instances = state->get_editable_instances();
- for (int i = 0; i < editable_instances.size(); i++) {
- if (i == 0) {
- f->store_line("");
- }
- f->store_line("[editable path=\"" + editable_instances[i].operator String().c_escape() + "\"]");
- }
- }
- if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
- return ERR_CANT_CREATE;
- }
- return OK;
- }
- Error ResourceLoaderText::set_uid(Ref<FileAccess> p_f, ResourceUID::ID p_uid) {
- open(p_f, true);
- ERR_FAIL_COND_V(error != OK, error);
- ignore_resource_parsing = true;
- Ref<FileAccess> fw;
- fw = FileAccess::open(local_path + ".uidren", FileAccess::WRITE);
- if (is_scene) {
- fw->store_string("[gd_scene load_steps=" + itos(resources_total) + " format=" + itos(FORMAT_VERSION) + " uid=\"" + ResourceUID::get_singleton()->id_to_text(p_uid) + "\"]");
- } else {
- String script_res_text;
- if (!script_class.is_empty()) {
- script_res_text = "script_class=\"" + script_class + "\" ";
- }
- fw->store_string("[gd_resource type=\"" + res_type + "\" " + script_res_text + "load_steps=" + itos(resources_total) + " format=" + itos(FORMAT_VERSION) + " uid=\"" + ResourceUID::get_singleton()->id_to_text(p_uid) + "\"]");
- }
- uint8_t c = f->get_8();
- while (!f->eof_reached()) {
- fw->store_8(c);
- c = f->get_8();
- }
- bool all_ok = fw->get_error() == OK;
- if (!all_ok) {
- return ERR_CANT_CREATE;
- }
- return OK;
- }
- Error ResourceFormatSaverText::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
- if (p_path.ends_with(".tscn") && !Ref<PackedScene>(p_resource).is_valid()) {
- return ERR_FILE_UNRECOGNIZED;
- }
- ResourceFormatSaverTextInstance saver;
- return saver.save(p_path, p_resource, p_flags);
- }
- Error ResourceFormatSaverText::set_uid(const String &p_path, ResourceUID::ID p_uid) {
- String lc = p_path.to_lower();
- if (!lc.ends_with(".tscn") && !lc.ends_with(".tres")) {
- return ERR_FILE_UNRECOGNIZED;
- }
- String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
- Error err = OK;
- {
- Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::READ);
- if (file.is_null()) {
- ERR_FAIL_V(ERR_CANT_OPEN);
- }
- ResourceLoaderText loader;
- loader.local_path = local_path;
- loader.res_path = loader.local_path;
- err = loader.set_uid(file, p_uid);
- }
- if (err == OK) {
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- da->remove(local_path);
- da->rename(local_path + ".uidren", local_path);
- }
- return err;
- }
- bool ResourceFormatSaverText::recognize(const Ref<Resource> &p_resource) const {
- return true; // All resources recognized!
- }
- void ResourceFormatSaverText::get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const {
- if (Ref<PackedScene>(p_resource).is_valid()) {
- p_extensions->push_back("tscn"); // Text scene.
- } else {
- p_extensions->push_back("tres"); // Text resource.
- }
- }
- ResourceFormatSaverText *ResourceFormatSaverText::singleton = nullptr;
- ResourceFormatSaverText::ResourceFormatSaverText() {
- singleton = this;
- }
|