/**************************************************************************/ /* 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/object/script_language.h" // Version 2: Changed names for Basis, AABB, Vectors, etc. // Version 3: New string ID for ext/subresources, breaks forward compat. // Version 4: PackedByteArray can be base64 encoded, and PackedVector4Array was added. #define FORMAT_VERSION 4 // For compat, save as version 3 if not using PackedVector4Array or no big PackedByteArray. #define FORMAT_VERSION_COMPAT 3 #define _printerr() ERR_PRINT(String(res_path + ":" + itos(lines) + " - Parse Error: " + error_text).utf8().get_data()); /// Ref ResourceLoaderText::get_resource() { return resource; } Error ResourceLoaderText::_parse_sub_resource_dummy(DummyReadData *p_data, VariantParser::Stream *p_stream, Ref &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 &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 &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 &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 &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 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(); } #ifdef TOOLS_ENABLED if (r_res.is_null()) { // Hack to allow checking original path. r_res.instantiate(); r_res->set_meta("__load_path__", ext_resources[id].path); } #endif } 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 ResourceLoaderText::_parse_node_tag(VariantParser::ResourceParser &parser) { Ref packed_scene = ResourceLoader::get_resource_ref_override(local_path); if (packed_scene.is_null()) { 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 path_properties; if (next_tag.fields.has("node_paths")) { Vector 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(); } 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 (const Variant &group : groups) { packed_scene->get_state()->add_node_group(node_id, packed_scene->get_state()->add_name(group)); } } 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) { ERR_PRINT(vformat("Parse Error: %s. [Resource file %s:%d]", error_names[error], res_path, lines)); return Ref(); } 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(); } if (!next_tag.fields.has("to")) { error = ERR_FILE_CORRUPT; error_text = "missing 'to' field from connection tag"; return Ref(); } if (!next_tag.fields.has("signal")) { error = ERR_FILE_CORRUPT; error_text = "missing 'signal' field from connection tag"; return Ref(); } if (!next_tag.fields.has("method")) { error = ERR_FILE_CORRUPT; error_text = "missing 'method' field from connection tag"; return Ref(); } 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 bind_ints; for (const Variant &bind : binds) { bind_ints.push_back(packed_scene->get_state()->add_value(bind)); } 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(); } 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(); } 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(); } else { error = OK; return packed_scene; } } } else { error = ERR_FILE_CORRUPT; _printerr(); return Ref(); } } } 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, cache_mode_for_external); 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 res; bool do_assign = false; if (cache_mode == ResourceFormatLoader::CACHE_MODE_REPLACE && ResourceCache::has(path)) { //reuse existing Ref 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 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(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(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 { 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 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; } MissingResource *missing_resource = nullptr; resource = ResourceLoader::get_resource_ref_override(local_path); if (resource.is_null()) { Ref 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; } 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(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(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); } else { resource->set_path_cache(res_path); } } 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 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 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) { if (!ResourceCache::has(res_path)) { packed_scene->set_path(res_path); } } else { packed_scene->get_state()->set_path(res_path); packed_scene->set_path_cache(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), format_version(FORMAT_VERSION) {} void ResourceLoaderText::get_dependencies(Ref p_f, List *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 p_f, const String &p_path, const HashMap &p_map) { open(p_f, true); ERR_FAIL_COND_V(error != OK, error); ignore_resource_parsing = true; //FileAccess Ref 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)) { path = p_map[path]; } 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 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")) { format_version = tag.fields["format"]; if (format_version > FORMAT_VERSION) { error_text = "Saved with newer format version"; _printerr(); error = ERR_FILE_UNRECOGNIZED; return; } } else { format_version = FORMAT_VERSION; } 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; } Error ResourceLoaderText::get_classes_used(HashSet *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 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) { 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 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) { 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 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 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 f = FileAccess::open(p_path, FileAccess::READ, &err); ERR_FAIL_COND_V_MSG(err != OK, Ref(), "Cannot open file '" + p_path + "'."); ResourceLoaderText loader; String path = !p_original_path.is_empty() ? p_original_path : p_path; switch (p_cache_mode) { case CACHE_MODE_IGNORE: case CACHE_MODE_REUSE: case CACHE_MODE_REPLACE: loader.cache_mode = p_cache_mode; loader.cache_mode_for_external = CACHE_MODE_REUSE; break; case CACHE_MODE_IGNORE_DEEP: loader.cache_mode = ResourceFormatLoader::CACHE_MODE_IGNORE; loader.cache_mode_for_external = p_cache_mode; break; case CACHE_MODE_REPLACE_DEEP: loader.cache_mode = ResourceFormatLoader::CACHE_MODE_REPLACE; loader.cache_mode_for_external = p_cache_mode; break; } 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(); } } void ResourceFormatLoaderText::get_recognized_extensions_for_type(const String &p_type, List *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 *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 *r_classes) { String ext = p_path.get_extension().to_lower(); if (ext == "tscn") { r_classes->insert("PackedScene"); } // ...for anything else must test... Ref 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 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 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 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 *p_dependencies, bool p_add_types) { Ref 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 &p_map) { Error err = OK; { Ref 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 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; /*****************************************************************************************************/ String ResourceFormatSaverTextInstance::_write_resources(void *ud, const Ref &p_resource) { ResourceFormatSaverTextInstance *rsi = static_cast(ud); return rsi->_write_resource(p_resource); } String ResourceFormatSaverTextInstance::_write_resource(const Ref &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 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 property_list; res->get_property_list(&property_list); property_list.sort(); List::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 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; _find_resources(varray.get_typed_script()); for (const Variant &var : varray) { _find_resources(var); } } break; case Variant::DICTIONARY: { Dictionary d = p_variant; List 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; case Variant::PACKED_BYTE_ARRAY: { // Balance between compatibility and performance. if (use_compat && p_variant.operator PackedByteArray().size() > 64) { use_compat = false; } } break; case Variant::PACKED_VECTOR4_ARRAY: { use_compat = false; } break; default: { } } } static String _resource_get_class(Ref p_resource) { Ref 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 &p_resource, uint32_t p_flags) { if (p_path.ends_with(".tscn")) { packed_scene = p_resource; } Error err; Ref f = FileAccess::open(p_path, FileAccess::WRITE, &err); ERR_FAIL_COND_V_MSG(err, ERR_CANT_OPEN, "Cannot save file '" + p_path + "'."); Ref _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. use_compat = true; // _find_resources() changes this. _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 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