d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
186 lines
7.1 KiB
C++
186 lines
7.1 KiB
C++
/**************************************************************************/
|
|
/* resource_format_binary.h */
|
|
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef RESOURCE_FORMAT_BINARY_H
|
|
#define RESOURCE_FORMAT_BINARY_H
|
|
|
|
#include "core/io/file_access.h"
|
|
#include "core/io/resource_loader.h"
|
|
#include "core/io/resource_saver.h"
|
|
|
|
class ResourceLoaderBinary {
|
|
bool translation_remapped = false;
|
|
String local_path;
|
|
String res_path;
|
|
String type;
|
|
Ref<Resource> resource;
|
|
uint32_t ver_format = 0;
|
|
|
|
Ref<FileAccess> f;
|
|
|
|
uint64_t importmd_ofs = 0;
|
|
|
|
ResourceUID::ID uid = ResourceUID::INVALID_ID;
|
|
|
|
Vector<char> str_buf;
|
|
List<Ref<Resource>> resource_cache;
|
|
|
|
Vector<StringName> string_map;
|
|
|
|
StringName _get_string();
|
|
|
|
struct ExtResource {
|
|
String path;
|
|
String type;
|
|
ResourceUID::ID uid = ResourceUID::INVALID_ID;
|
|
Ref<Resource> cache;
|
|
};
|
|
|
|
bool using_named_scene_ids = false;
|
|
bool using_uids = false;
|
|
bool use_sub_threads = false;
|
|
float *progress = nullptr;
|
|
Vector<ExtResource> external_resources;
|
|
|
|
struct IntResource {
|
|
String path;
|
|
uint64_t offset;
|
|
};
|
|
|
|
Vector<IntResource> internal_resources;
|
|
HashMap<String, Ref<Resource>> internal_index_cache;
|
|
|
|
String get_unicode_string();
|
|
void _advance_padding(uint32_t p_len);
|
|
|
|
HashMap<String, String> remaps;
|
|
Error error = OK;
|
|
|
|
ResourceFormatLoader::CacheMode cache_mode = ResourceFormatLoader::CACHE_MODE_REUSE;
|
|
|
|
friend class ResourceFormatLoaderBinary;
|
|
|
|
Error parse_variant(Variant &r_v);
|
|
|
|
HashMap<String, Ref<Resource>> dependency_cache;
|
|
|
|
public:
|
|
void set_local_path(const String &p_local_path);
|
|
Ref<Resource> get_resource();
|
|
Error load();
|
|
void set_translation_remapped(bool p_remapped);
|
|
|
|
void set_remaps(const HashMap<String, String> &p_remaps) { remaps = p_remaps; }
|
|
void open(Ref<FileAccess> p_f, bool p_no_resources = false, bool p_keep_uuid_paths = false);
|
|
String recognize(Ref<FileAccess> p_f);
|
|
void get_dependencies(Ref<FileAccess> p_f, List<String> *p_dependencies, bool p_add_types);
|
|
void get_classes_used(Ref<FileAccess> p_f, HashSet<StringName> *p_classes);
|
|
|
|
ResourceLoaderBinary() {}
|
|
};
|
|
|
|
class ResourceFormatLoaderBinary : public ResourceFormatLoader {
|
|
public:
|
|
virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE);
|
|
virtual void get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const;
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const;
|
|
virtual bool handles_type(const String &p_type) const;
|
|
virtual String get_resource_type(const String &p_path) const;
|
|
virtual void get_classes_used(const String &p_path, HashSet<StringName> *r_classes);
|
|
virtual ResourceUID::ID get_resource_uid(const String &p_path) const;
|
|
virtual void get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false);
|
|
virtual Error rename_dependencies(const String &p_path, const HashMap<String, String> &p_map);
|
|
};
|
|
|
|
class ResourceFormatSaverBinaryInstance {
|
|
String local_path;
|
|
String path;
|
|
|
|
bool relative_paths;
|
|
bool bundle_resources;
|
|
bool skip_editor;
|
|
bool big_endian;
|
|
bool takeover_paths;
|
|
String magic;
|
|
HashSet<Ref<Resource>> resource_set;
|
|
|
|
struct NonPersistentKey { //for resource properties generated on the fly
|
|
Ref<Resource> base;
|
|
StringName property;
|
|
bool operator<(const NonPersistentKey &p_key) const { return base == p_key.base ? property < p_key.property : base < p_key.base; }
|
|
};
|
|
|
|
RBMap<NonPersistentKey, Ref<Resource>> non_persistent_map;
|
|
HashMap<StringName, int> string_map;
|
|
Vector<StringName> strings;
|
|
|
|
HashMap<Ref<Resource>, int> external_resources;
|
|
List<Ref<Resource>> saved_resources;
|
|
|
|
struct Property {
|
|
int name_idx;
|
|
Variant value;
|
|
PropertyInfo pi;
|
|
};
|
|
|
|
struct ResourceData {
|
|
String type;
|
|
List<Property> properties;
|
|
};
|
|
|
|
static void _pad_buffer(Ref<FileAccess> f, int p_bytes);
|
|
void _find_resources(const Variant &p_variant, bool p_main = false);
|
|
static void save_unicode_string(Ref<FileAccess> f, const String &p_string, bool p_bit_on_len = false);
|
|
int get_string_index(const String &p_string);
|
|
|
|
public:
|
|
enum {
|
|
FORMAT_FLAG_NAMED_SCENE_IDS = 1,
|
|
FORMAT_FLAG_UIDS = 2,
|
|
FORMAT_FLAG_REAL_T_IS_DOUBLE = 4,
|
|
|
|
// Amount of reserved 32-bit fields in resource header
|
|
RESERVED_FIELDS = 11
|
|
};
|
|
Error save(const String &p_path, const Ref<Resource> &p_resource, uint32_t p_flags = 0);
|
|
static void write_variant(Ref<FileAccess> f, const Variant &p_property, HashMap<Ref<Resource>, int> &resource_map, HashMap<Ref<Resource>, int> &external_resources, HashMap<StringName, int> &string_map, const PropertyInfo &p_hint = PropertyInfo());
|
|
};
|
|
|
|
class ResourceFormatSaverBinary : public ResourceFormatSaver {
|
|
public:
|
|
static ResourceFormatSaverBinary *singleton;
|
|
virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0);
|
|
virtual bool recognize(const Ref<Resource> &p_resource) const;
|
|
virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
|
|
|
|
ResourceFormatSaverBinary();
|
|
};
|
|
|
|
#endif // RESOURCE_FORMAT_BINARY_H
|