1426cd3b3a
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". Backported from #70885.
172 lines
6.3 KiB
C++
172 lines
6.3 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/resource_loader.h"
|
|
#include "core/io/resource_saver.h"
|
|
#include "core/os/file_access.h"
|
|
|
|
class ResourceInteractiveLoaderBinary : public ResourceInteractiveLoader {
|
|
bool translation_remapped;
|
|
String local_path;
|
|
String res_path;
|
|
String type;
|
|
Ref<Resource> resource;
|
|
uint32_t ver_format;
|
|
|
|
FileAccess *f;
|
|
|
|
uint64_t importmd_ofs;
|
|
|
|
Vector<char> str_buf;
|
|
List<RES> resource_cache;
|
|
|
|
//Map<int,StringName> string_map;
|
|
Vector<StringName> string_map;
|
|
|
|
StringName _get_string();
|
|
|
|
struct ExtResource {
|
|
String path;
|
|
String type;
|
|
};
|
|
|
|
Vector<ExtResource> external_resources;
|
|
|
|
struct IntResource {
|
|
String path;
|
|
uint64_t offset;
|
|
};
|
|
|
|
Vector<IntResource> internal_resources;
|
|
Map<uint32_t, RES> internal_resources_cache;
|
|
|
|
String get_unicode_string();
|
|
void _advance_padding(uint32_t p_len);
|
|
|
|
Map<String, String> remaps;
|
|
Error error;
|
|
|
|
int stage;
|
|
|
|
friend class ResourceFormatLoaderBinary;
|
|
|
|
Error parse_variant(Variant &r_v);
|
|
|
|
public:
|
|
virtual void set_local_path(const String &p_local_path);
|
|
virtual Ref<Resource> get_resource();
|
|
virtual Error poll();
|
|
virtual int get_stage() const;
|
|
virtual int get_stage_count() const;
|
|
virtual void set_translation_remapped(bool p_remapped);
|
|
|
|
void set_remaps(const Map<String, String> &p_remaps) { remaps = p_remaps; }
|
|
void open(FileAccess *p_f);
|
|
String recognize(FileAccess *p_f);
|
|
void get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types);
|
|
|
|
ResourceInteractiveLoaderBinary();
|
|
~ResourceInteractiveLoaderBinary();
|
|
};
|
|
|
|
class ResourceFormatLoaderBinary : public ResourceFormatLoader {
|
|
public:
|
|
virtual Ref<ResourceInteractiveLoader> load_interactive(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_no_subresource_cache = false);
|
|
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_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false);
|
|
virtual Error rename_dependencies(const String &p_path, const Map<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;
|
|
FileAccess *f;
|
|
String magic;
|
|
Set<RES> resource_set;
|
|
|
|
struct NonPersistentKey { //for resource properties generated on the fly
|
|
RES base;
|
|
StringName property;
|
|
bool operator<(const NonPersistentKey &p_key) const { return base == p_key.base ? property < p_key.property : base < p_key.base; }
|
|
};
|
|
|
|
Map<NonPersistentKey, RES> non_persistent_map;
|
|
Map<StringName, int> string_map;
|
|
Vector<StringName> strings;
|
|
|
|
Map<RES, int> external_resources;
|
|
List<RES> saved_resources;
|
|
|
|
struct Property {
|
|
int name_idx;
|
|
Variant value;
|
|
PropertyInfo pi;
|
|
};
|
|
|
|
struct ResourceData {
|
|
String type;
|
|
List<Property> properties;
|
|
};
|
|
|
|
static void _pad_buffer(FileAccess *f, int p_bytes);
|
|
void _write_variant(const Variant &p_property, const PropertyInfo &p_hint = PropertyInfo());
|
|
void _find_resources(const Variant &p_variant, bool p_main = false);
|
|
static void save_unicode_string(FileAccess *f, const String &p_string, bool p_bit_on_len = false);
|
|
int get_string_index(const String &p_string);
|
|
|
|
public:
|
|
Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
|
|
static void write_variant(FileAccess *f, const Variant &p_property, Set<RES> &resource_set, Map<RES, int> &external_resources, Map<StringName, int> &string_map, const PropertyInfo &p_hint = PropertyInfo());
|
|
};
|
|
|
|
class ResourceFormatSaverBinary : public ResourceFormatSaver {
|
|
public:
|
|
static ResourceFormatSaverBinary *singleton;
|
|
virtual Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
|
|
virtual bool recognize(const RES &p_resource) const;
|
|
virtual void get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const;
|
|
|
|
ResourceFormatSaverBinary();
|
|
};
|
|
|
|
#endif // RESOURCE_FORMAT_BINARY_H
|