virtualx-engine/core/io/resource.cpp

670 lines
19 KiB
C++
Raw Normal View History

/**************************************************************************/
/* resource.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. */
/**************************************************************************/
2014-02-10 02:10:30 +01:00
#include "resource.h"
#include "core/io/file_access.h"
#include "core/io/resource_loader.h"
#include "core/math/math_funcs.h"
#include "core/object/script_language.h"
#include "core/os/os.h"
#include "scene/main/node.h" //only so casting works
#include <stdio.h>
2014-02-10 02:10:30 +01:00
void Resource::emit_changed() {
if (ResourceLoader::is_within_load() && !Thread::is_main_thread()) {
ResourceLoader::resource_changed_emit(this);
return;
}
emit_signal(CoreStringName(changed));
2014-02-10 02:10:30 +01:00
}
void Resource::_resource_path_changed() {
}
2016-03-09 00:00:52 +01:00
void Resource::set_path(const String &p_path, bool p_take_over) {
if (path_cache == p_path) {
2014-02-10 02:10:30 +01:00
return;
}
2016-03-09 00:00:52 +01:00
if (p_path.is_empty()) {
p_take_over = false; // Can't take over an empty path
}
2024-08-28 11:27:01 +02:00
{
MutexLock lock(ResourceCache::lock);
2024-08-28 11:27:01 +02:00
if (!path_cache.is_empty()) {
ResourceCache::resources.erase(path_cache);
}
2014-02-10 02:10:30 +01:00
2024-08-28 11:27:01 +02:00
path_cache = "";
2024-08-28 11:27:01 +02:00
Ref<Resource> existing = ResourceCache::get_ref(p_path);
2024-08-28 11:27:01 +02:00
if (existing.is_valid()) {
if (p_take_over) {
existing->path_cache = String();
ResourceCache::resources.erase(p_path);
} else {
ERR_FAIL_MSG("Another resource is loaded from path '" + p_path + "' (possible cyclic resource inclusion).");
}
}
2024-08-28 11:27:01 +02:00
path_cache = p_path;
2016-03-09 00:00:52 +01:00
2024-08-28 11:27:01 +02:00
if (!path_cache.is_empty()) {
ResourceCache::resources[path_cache] = this;
}
2014-02-10 02:10:30 +01:00
}
_resource_path_changed();
}
String Resource::get_path() const {
return path_cache;
}
void Resource::set_path_cache(const String &p_path) {
path_cache = p_path;
}
String Resource::generate_scene_unique_id() {
// Generate a unique enough hash, but still user-readable.
// If it's not unique it does not matter because the saver will try again.
OS::DateTime dt = OS::get_singleton()->get_datetime();
uint32_t hash = hash_murmur3_one_32(OS::get_singleton()->get_ticks_usec());
hash = hash_murmur3_one_32(dt.year, hash);
hash = hash_murmur3_one_32(dt.month, hash);
hash = hash_murmur3_one_32(dt.day, hash);
hash = hash_murmur3_one_32(dt.hour, hash);
hash = hash_murmur3_one_32(dt.minute, hash);
hash = hash_murmur3_one_32(dt.second, hash);
hash = hash_murmur3_one_32(Math::rand(), hash);
static constexpr uint32_t characters = 5;
static constexpr uint32_t char_count = ('z' - 'a');
static constexpr uint32_t base = char_count + ('9' - '0');
String id;
for (uint32_t i = 0; i < characters; i++) {
uint32_t c = hash % base;
if (c < char_count) {
id += String::chr('a' + c);
} else {
id += String::chr('0' + (c - char_count));
}
hash /= base;
}
return id;
}
void Resource::set_scene_unique_id(const String &p_id) {
bool is_valid = true;
for (int i = 0; i < p_id.length(); i++) {
if (!is_ascii_identifier_char(p_id[i])) {
is_valid = false;
scene_unique_id = Resource::generate_scene_unique_id();
break;
}
}
ERR_FAIL_COND_MSG(!is_valid, "The scene unique ID must contain only letters, numbers, and underscores.");
scene_unique_id = p_id;
}
String Resource::get_scene_unique_id() const {
return scene_unique_id;
}
void Resource::set_name(const String &p_name) {
name = p_name;
2021-10-14 13:28:45 +02:00
emit_changed();
2014-02-10 02:10:30 +01:00
}
2014-02-10 02:10:30 +01:00
String Resource::get_name() const {
return name;
}
void Resource::update_configuration_warning() {
if (_update_configuration_warning) {
_update_configuration_warning();
}
}
bool Resource::editor_can_reload_from_file() {
return true; //by default yes
2014-02-10 02:10:30 +01:00
}
void Resource::connect_changed(const Callable &p_callable, uint32_t p_flags) {
if (ResourceLoader::is_within_load() && !Thread::is_main_thread()) {
ResourceLoader::resource_changed_connect(this, p_callable, p_flags);
return;
}
if (!is_connected(CoreStringName(changed), p_callable) || p_flags & CONNECT_REFERENCE_COUNTED) {
connect(CoreStringName(changed), p_callable, p_flags);
}
}
void Resource::disconnect_changed(const Callable &p_callable) {
if (ResourceLoader::is_within_load() && !Thread::is_main_thread()) {
ResourceLoader::resource_changed_disconnect(this, p_callable);
return;
}
if (is_connected(CoreStringName(changed), p_callable)) {
disconnect(CoreStringName(changed), p_callable);
}
}
void Resource::reset_state() {
}
Error Resource::copy_from(const Ref<Resource> &p_resource) {
ERR_FAIL_COND_V(p_resource.is_null(), ERR_INVALID_PARAMETER);
if (get_class() != p_resource->get_class()) {
return ERR_INVALID_PARAMETER;
}
reset_state(); // May want to reset state.
List<PropertyInfo> pi;
p_resource->get_property_list(&pi);
for (const PropertyInfo &E : pi) {
if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
continue;
}
if (E.name == "resource_path") {
continue; //do not change path
}
set(E.name, p_resource->get(E.name));
}
return OK;
}
void Resource::reload_from_file() {
String path = get_path();
if (!path.is_resource_file()) {
return;
}
Ref<Resource> s = ResourceLoader::load(ResourceLoader::path_remap(path), get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
if (!s.is_valid()) {
return;
}
copy_from(s);
2014-02-10 02:10:30 +01:00
}
void Resource::_dupe_sub_resources(Variant &r_variant, Node *p_for_scene, HashMap<Ref<Resource>, Ref<Resource>> &p_remap_cache) {
switch (r_variant.get_type()) {
case Variant::ARRAY: {
Array a = r_variant;
for (int i = 0; i < a.size(); i++) {
_dupe_sub_resources(a[i], p_for_scene, p_remap_cache);
}
} break;
case Variant::DICTIONARY: {
Dictionary d = r_variant;
List<Variant> keys;
d.get_key_list(&keys);
for (Variant &k : keys) {
if (k.get_type() == Variant::OBJECT) {
// Replace in dictionary key.
Ref<Resource> sr = k;
if (sr.is_valid() && sr->is_local_to_scene()) {
if (p_remap_cache.has(sr)) {
d[p_remap_cache[sr]] = d[k];
d.erase(k);
} else {
Ref<Resource> dupe = sr->duplicate_for_local_scene(p_for_scene, p_remap_cache);
d[dupe] = d[k];
d.erase(k);
p_remap_cache[sr] = dupe;
}
}
} else {
_dupe_sub_resources(k, p_for_scene, p_remap_cache);
}
_dupe_sub_resources(d[k], p_for_scene, p_remap_cache);
}
} break;
case Variant::OBJECT: {
Ref<Resource> sr = r_variant;
if (sr.is_valid() && sr->is_local_to_scene()) {
if (p_remap_cache.has(sr)) {
r_variant = p_remap_cache[sr];
} else {
Ref<Resource> dupe = sr->duplicate_for_local_scene(p_for_scene, p_remap_cache);
r_variant = dupe;
p_remap_cache[sr] = dupe;
}
}
} break;
default: {
}
}
}
Ref<Resource> Resource::duplicate_for_local_scene(Node *p_for_scene, HashMap<Ref<Resource>, Ref<Resource>> &p_remap_cache) {
List<PropertyInfo> plist;
get_property_list(&plist);
Ref<Resource> r = Object::cast_to<Resource>(ClassDB::instantiate(get_class()));
ERR_FAIL_COND_V(r.is_null(), Ref<Resource>());
r->local_scene = p_for_scene;
for (const PropertyInfo &E : plist) {
if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
continue;
}
Variant p = get(E.name).duplicate(true);
_dupe_sub_resources(p, p_for_scene, p_remap_cache);
r->set(E.name, p);
}
return r;
}
void Resource::_find_sub_resources(const Variant &p_variant, HashSet<Ref<Resource>> &p_resources_found) {
switch (p_variant.get_type()) {
case Variant::ARRAY: {
Array a = p_variant;
for (int i = 0; i < a.size(); i++) {
_find_sub_resources(a[i], p_resources_found);
}
} break;
case Variant::DICTIONARY: {
Dictionary d = p_variant;
List<Variant> keys;
d.get_key_list(&keys);
for (const Variant &k : keys) {
_find_sub_resources(k, p_resources_found);
_find_sub_resources(d[k], p_resources_found);
}
} break;
case Variant::OBJECT: {
Ref<Resource> r = p_variant;
if (r.is_valid()) {
p_resources_found.insert(r);
}
} break;
default: {
}
}
}
void Resource::configure_for_local_scene(Node *p_for_scene, HashMap<Ref<Resource>, Ref<Resource>> &p_remap_cache) {
List<PropertyInfo> plist;
get_property_list(&plist);
reset_local_to_scene();
local_scene = p_for_scene;
for (const PropertyInfo &E : plist) {
if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
continue;
}
Variant p = get(E.name);
HashSet<Ref<Resource>> sub_resources;
_find_sub_resources(p, sub_resources);
for (Ref<Resource> sr : sub_resources) {
if (sr->is_local_to_scene()) {
if (!p_remap_cache.has(sr)) {
sr->configure_for_local_scene(p_for_scene, p_remap_cache);
p_remap_cache[sr] = sr;
}
}
}
}
}
Ref<Resource> Resource::duplicate(bool p_subresources) const {
2014-02-10 02:10:30 +01:00
List<PropertyInfo> plist;
get_property_list(&plist);
2022-04-07 12:23:40 +02:00
Ref<Resource> r = static_cast<Resource *>(ClassDB::instantiate(get_class()));
2020-11-17 10:13:41 +01:00
ERR_FAIL_COND_V(r.is_null(), Ref<Resource>());
2014-02-10 02:10:30 +01:00
for (const PropertyInfo &E : plist) {
if (!(E.usage & PROPERTY_USAGE_STORAGE)) {
2014-02-10 02:10:30 +01:00
continue;
}
Variant p = get(E.name);
switch (p.get_type()) {
case Variant::Type::DICTIONARY:
case Variant::Type::ARRAY:
case Variant::Type::PACKED_BYTE_ARRAY:
case Variant::Type::PACKED_COLOR_ARRAY:
case Variant::Type::PACKED_INT32_ARRAY:
case Variant::Type::PACKED_INT64_ARRAY:
case Variant::Type::PACKED_FLOAT32_ARRAY:
case Variant::Type::PACKED_FLOAT64_ARRAY:
case Variant::Type::PACKED_STRING_ARRAY:
case Variant::Type::PACKED_VECTOR2_ARRAY:
case Variant::Type::PACKED_VECTOR3_ARRAY:
case Variant::Type::PACKED_VECTOR4_ARRAY: {
r->set(E.name, p.duplicate(p_subresources));
} break;
case Variant::Type::OBJECT: {
if (!(E.usage & PROPERTY_USAGE_NEVER_DUPLICATE) && (p_subresources || (E.usage & PROPERTY_USAGE_ALWAYS_DUPLICATE))) {
Ref<Resource> sr = p;
if (sr.is_valid()) {
r->set(E.name, sr->duplicate(p_subresources));
}
} else {
r->set(E.name, p);
}
} break;
default: {
r->set(E.name, p);
}
}
2014-02-10 02:10:30 +01:00
}
2020-11-17 10:13:41 +01:00
return r;
2014-02-10 02:10:30 +01:00
}
void Resource::_set_path(const String &p_path) {
set_path(p_path, false);
}
void Resource::_take_over_path(const String &p_path) {
set_path(p_path, true);
}
2014-02-10 02:10:30 +01:00
RID Resource::get_rid() const {
2024-01-17 15:03:52 +01:00
RID ret;
if (!GDVIRTUAL_CALL(_get_rid, ret)) {
#ifndef DISABLE_DEPRECATED
if (_get_extension() && _get_extension()->get_rid) {
ret = RID::from_uint64(_get_extension()->get_rid(_get_extension_instance()));
}
2024-01-17 15:03:52 +01:00
#endif
}
2024-01-17 15:03:52 +01:00
return ret;
2014-02-10 02:10:30 +01:00
}
#ifdef TOOLS_ENABLED
2024-03-07 17:45:13 +01:00
uint32_t Resource::hash_edited_version_for_preview() const {
uint32_t hash = hash_murmur3_one_32(get_edited_version());
List<PropertyInfo> plist;
get_property_list(&plist);
for (const PropertyInfo &E : plist) {
if (E.usage & PROPERTY_USAGE_STORAGE && E.type == Variant::OBJECT && E.hint == PROPERTY_HINT_RESOURCE_TYPE) {
Ref<Resource> res = get(E.name);
if (res.is_valid()) {
2024-03-07 17:45:13 +01:00
hash = hash_murmur3_one_32(res->hash_edited_version_for_preview(), hash);
}
}
}
return hash;
}
#endif
void Resource::set_local_to_scene(bool p_enable) {
local_to_scene = p_enable;
}
bool Resource::is_local_to_scene() const {
return local_to_scene;
}
Node *Resource::get_local_scene() const {
if (local_scene) {
return local_scene;
}
if (_get_local_scene_func) {
return _get_local_scene_func();
}
2020-04-02 01:20:12 +02:00
return nullptr;
}
void Resource::setup_local_to_scene() {
emit_signal(SNAME("setup_local_to_scene_requested"));
GDVIRTUAL_CALL(_setup_local_to_scene);
}
void Resource::reset_local_to_scene() {
// Restores the state as if setup_local_to_scene() hadn't been called.
}
2020-04-02 01:20:12 +02:00
Node *(*Resource::_get_local_scene_func)() = nullptr;
void (*Resource::_update_configuration_warning)() = nullptr;
void Resource::set_as_translation_remapped(bool p_remapped) {
if (remapped_list.in_list() == p_remapped) {
return;
}
2024-08-28 11:27:01 +02:00
MutexLock lock(ResourceCache::lock);
if (p_remapped) {
ResourceLoader::remapped_list.add(&remapped_list);
} else {
ResourceLoader::remapped_list.remove(&remapped_list);
}
}
#ifdef TOOLS_ENABLED
//helps keep IDs same number when loading/saving scenes. -1 clears ID and it Returns -1 when no id stored
void Resource::set_id_for_path(const String &p_path, const String &p_id) {
if (p_id.is_empty()) {
ResourceCache::path_cache_lock.write_lock();
ResourceCache::resource_path_cache[p_path].erase(get_path());
ResourceCache::path_cache_lock.write_unlock();
} else {
ResourceCache::path_cache_lock.write_lock();
ResourceCache::resource_path_cache[p_path][get_path()] = p_id;
ResourceCache::path_cache_lock.write_unlock();
}
}
String Resource::get_id_for_path(const String &p_path) const {
ResourceCache::path_cache_lock.read_lock();
if (ResourceCache::resource_path_cache[p_path].has(get_path())) {
String result = ResourceCache::resource_path_cache[p_path][get_path()];
ResourceCache::path_cache_lock.read_unlock();
return result;
} else {
ResourceCache::path_cache_lock.read_unlock();
return "";
}
}
#endif
void Resource::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_path", "path"), &Resource::_set_path);
ClassDB::bind_method(D_METHOD("take_over_path", "path"), &Resource::_take_over_path);
ClassDB::bind_method(D_METHOD("get_path"), &Resource::get_path);
ClassDB::bind_method(D_METHOD("set_name", "name"), &Resource::set_name);
ClassDB::bind_method(D_METHOD("get_name"), &Resource::get_name);
ClassDB::bind_method(D_METHOD("get_rid"), &Resource::get_rid);
ClassDB::bind_method(D_METHOD("set_local_to_scene", "enable"), &Resource::set_local_to_scene);
ClassDB::bind_method(D_METHOD("is_local_to_scene"), &Resource::is_local_to_scene);
ClassDB::bind_method(D_METHOD("get_local_scene"), &Resource::get_local_scene);
ClassDB::bind_method(D_METHOD("setup_local_to_scene"), &Resource::setup_local_to_scene);
ClassDB::bind_static_method("Resource", D_METHOD("generate_scene_unique_id"), &Resource::generate_scene_unique_id);
ClassDB::bind_method(D_METHOD("set_scene_unique_id", "id"), &Resource::set_scene_unique_id);
ClassDB::bind_method(D_METHOD("get_scene_unique_id"), &Resource::get_scene_unique_id);
ClassDB::bind_method(D_METHOD("emit_changed"), &Resource::emit_changed);
ClassDB::bind_method(D_METHOD("duplicate", "subresources"), &Resource::duplicate, DEFVAL(false));
ADD_SIGNAL(MethodInfo("changed"));
ADD_SIGNAL(MethodInfo("setup_local_to_scene_requested"));
ADD_GROUP("Resource", "resource_");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "resource_local_to_scene"), "set_local_to_scene", "is_local_to_scene");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "resource_path", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_EDITOR), "set_path", "get_path");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "resource_name"), "set_name", "get_name");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "resource_scene_unique_id", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_scene_unique_id", "get_scene_unique_id");
GDVIRTUAL_BIND(_setup_local_to_scene);
2024-01-17 15:03:52 +01:00
GDVIRTUAL_BIND(_get_rid);
}
2014-02-10 02:10:30 +01:00
Resource::Resource() :
remapped_list(this) {}
2014-02-10 02:10:30 +01:00
Resource::~Resource() {
if (unlikely(path_cache.is_empty())) {
return;
}
2024-08-28 11:27:01 +02:00
MutexLock lock(ResourceCache::lock);
// Only unregister from the cache if this is the actual resource listed there.
// (Other resources can have the same value in `path_cache` if loaded with `CACHE_IGNORE`.)
HashMap<String, Resource *>::Iterator E = ResourceCache::resources.find(path_cache);
if (likely(E && E->value == this)) {
ResourceCache::resources.remove(E);
}
2014-02-10 02:10:30 +01:00
}
HashMap<String, Resource *> ResourceCache::resources;
#ifdef TOOLS_ENABLED
HashMap<String, HashMap<String, String>> ResourceCache::resource_path_cache;
#endif
2014-02-10 02:10:30 +01:00
Mutex ResourceCache::lock;
#ifdef TOOLS_ENABLED
RWLock ResourceCache::path_cache_lock;
#endif
2014-02-10 02:10:30 +01:00
void ResourceCache::clear() {
if (!resources.is_empty()) {
if (OS::get_singleton()->is_stdout_verbose()) {
ERR_PRINT(vformat("%d resources still in use at exit.", resources.size()));
for (const KeyValue<String, Resource *> &E : resources) {
print_line(vformat("Resource still in use: %s (%s)", E.key, E.value->get_class()));
}
} else {
ERR_PRINT(vformat("%d resources still in use at exit (run with --verbose for details).", resources.size()));
}
}
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
resources.clear();
}
bool ResourceCache::has(const String &p_path) {
2024-08-28 11:27:01 +02:00
Resource **res = nullptr;
2024-08-28 11:27:01 +02:00
{
MutexLock mutex_lock(lock);
2024-08-28 11:27:01 +02:00
res = resources.getptr(p_path);
2024-08-28 11:27:01 +02:00
if (res && (*res)->get_reference_count() == 0) {
// This resource is in the process of being deleted, ignore its existence.
(*res)->path_cache = String();
resources.erase(p_path);
res = nullptr;
}
}
if (!res) {
return false;
}
return true;
2014-02-10 02:10:30 +01:00
}
Ref<Resource> ResourceCache::get_ref(const String &p_path) {
Ref<Resource> ref;
2024-08-28 11:27:01 +02:00
{
MutexLock mutex_lock(lock);
Resource **res = resources.getptr(p_path);
2024-08-28 11:27:01 +02:00
if (res) {
ref = Ref<Resource>(*res);
}
2024-08-28 11:27:01 +02:00
if (res && !ref.is_valid()) {
// This resource is in the process of being deleted, ignore its existence
(*res)->path_cache = String();
resources.erase(p_path);
res = nullptr;
}
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
return ref;
2014-02-10 02:10:30 +01:00
}
void ResourceCache::get_cached_resources(List<Ref<Resource>> *p_resources) {
2024-08-28 11:27:01 +02:00
MutexLock mutex_lock(lock);
LocalVector<String> to_remove;
for (KeyValue<String, Resource *> &E : resources) {
Ref<Resource> ref = Ref<Resource>(E.value);
if (!ref.is_valid()) {
// This resource is in the process of being deleted, ignore its existence
E.value->path_cache = String();
to_remove.push_back(E.key);
continue;
}
p_resources->push_back(ref);
}
for (const String &E : to_remove) {
resources.erase(E);
2014-02-10 02:10:30 +01:00
}
}
int ResourceCache::get_cached_resource_count() {
2024-08-28 11:27:01 +02:00
MutexLock mutex_lock(lock);
return resources.size();
2014-02-10 02:10:30 +01:00
}