b5334d14f7
Happy new year to the wonderful Godot community!
2020 has been a tough year for most of us personally, but a good year for
Godot development nonetheless with a huge amount of work done towards Godot
4.0 and great improvements backported to the long-lived 3.2 branch.
We've had close to 400 contributors to engine code this year, authoring near
7,000 commit! (And that's only for the `master` branch and for the engine code,
there's a lot more when counting docs, demos and other first-party repos.)
Here's to a great year 2021 for all Godot users 🎆
202 lines
7.8 KiB
C++
202 lines
7.8 KiB
C++
/*************************************************************************/
|
|
/* resource_format_text.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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_TEXT_H
|
|
#define RESOURCE_FORMAT_TEXT_H
|
|
|
|
#include "core/io/resource_loader.h"
|
|
#include "core/io/resource_saver.h"
|
|
#include "core/os/file_access.h"
|
|
#include "core/variant/variant_parser.h"
|
|
#include "scene/resources/packed_scene.h"
|
|
|
|
class ResourceLoaderText {
|
|
bool translation_remapped;
|
|
String local_path;
|
|
String res_path;
|
|
String error_text;
|
|
|
|
FileAccess *f;
|
|
|
|
VariantParser::StreamFile stream;
|
|
|
|
struct ExtResource {
|
|
RES cache;
|
|
String path;
|
|
String type;
|
|
};
|
|
|
|
bool is_scene;
|
|
String res_type;
|
|
|
|
bool ignore_resource_parsing;
|
|
|
|
//Map<String,String> remaps;
|
|
|
|
Map<int, ExtResource> ext_resources;
|
|
Map<int, RES> int_resources;
|
|
|
|
int resources_total;
|
|
int resource_current;
|
|
String resource_type;
|
|
|
|
VariantParser::Tag next_tag;
|
|
|
|
bool use_nocache;
|
|
|
|
bool use_sub_threads;
|
|
float *progress;
|
|
|
|
mutable int lines;
|
|
|
|
Map<String, String> remaps;
|
|
//void _printerr();
|
|
|
|
static Error _parse_sub_resources(void *p_self, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) { return reinterpret_cast<ResourceLoaderText *>(p_self)->_parse_sub_resource(p_stream, r_res, line, r_err_str); }
|
|
static Error _parse_ext_resources(void *p_self, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) { return reinterpret_cast<ResourceLoaderText *>(p_self)->_parse_ext_resource(p_stream, r_res, line, r_err_str); }
|
|
|
|
Error _parse_sub_resource(VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str);
|
|
Error _parse_ext_resource(VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str);
|
|
|
|
// for converter
|
|
class DummyResource : public Resource {
|
|
public:
|
|
};
|
|
|
|
struct DummyReadData {
|
|
Map<RES, int> external_resources;
|
|
Map<int, RES> rev_external_resources;
|
|
Set<RES> resource_set;
|
|
Map<int, RES> resource_map;
|
|
};
|
|
|
|
static Error _parse_sub_resource_dummys(void *p_self, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) { return _parse_sub_resource_dummy((DummyReadData *)(p_self), p_stream, r_res, line, r_err_str); }
|
|
static Error _parse_ext_resource_dummys(void *p_self, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str) { return _parse_ext_resource_dummy((DummyReadData *)(p_self), p_stream, r_res, line, r_err_str); }
|
|
|
|
static Error _parse_sub_resource_dummy(DummyReadData *p_data, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str);
|
|
static Error _parse_ext_resource_dummy(DummyReadData *p_data, VariantParser::Stream *p_stream, Ref<Resource> &r_res, int &line, String &r_err_str);
|
|
|
|
VariantParser::ResourceParser rp;
|
|
|
|
friend class ResourceFormatLoaderText;
|
|
|
|
Error error;
|
|
|
|
RES resource;
|
|
|
|
Ref<PackedScene> _parse_node_tag(VariantParser::ResourceParser &parser);
|
|
|
|
public:
|
|
void set_local_path(const String &p_local_path);
|
|
Ref<Resource> get_resource();
|
|
Error load();
|
|
int get_stage() const;
|
|
int get_stage_count() const;
|
|
void set_translation_remapped(bool p_remapped);
|
|
|
|
void open(FileAccess *p_f, bool p_skip_first_tag = false);
|
|
String recognize(FileAccess *p_f);
|
|
void get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types);
|
|
Error rename_dependencies(FileAccess *p_f, const String &p_path, const Map<String, String> &p_map);
|
|
|
|
Error save_as_binary(FileAccess *p_f, const String &p_path);
|
|
ResourceLoaderText();
|
|
~ResourceLoaderText();
|
|
};
|
|
|
|
class ResourceFormatLoaderText : public ResourceFormatLoader {
|
|
public:
|
|
static ResourceFormatLoaderText *singleton;
|
|
virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, bool p_no_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);
|
|
|
|
static Error convert_file_to_binary(const String &p_src_path, const String &p_dst_path);
|
|
|
|
ResourceFormatLoaderText() { singleton = this; }
|
|
};
|
|
|
|
class ResourceFormatSaverTextInstance {
|
|
String local_path;
|
|
|
|
Ref<PackedScene> packed_scene;
|
|
|
|
bool takeover_paths;
|
|
bool relative_paths;
|
|
bool bundle_resources;
|
|
bool skip_editor;
|
|
FileAccess *f;
|
|
|
|
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;
|
|
|
|
Set<RES> resource_set;
|
|
List<RES> saved_resources;
|
|
Map<RES, int> external_resources;
|
|
Map<RES, int> internal_resources;
|
|
|
|
struct ResourceSort {
|
|
RES resource;
|
|
int index;
|
|
bool operator<(const ResourceSort &p_right) const {
|
|
return index < p_right.index;
|
|
}
|
|
};
|
|
|
|
void _find_resources(const Variant &p_variant, bool p_main = false);
|
|
|
|
static String _write_resources(void *ud, const RES &p_resource);
|
|
String _write_resource(const RES &res);
|
|
|
|
public:
|
|
Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
|
|
};
|
|
|
|
class ResourceFormatSaverText : public ResourceFormatSaver {
|
|
public:
|
|
static ResourceFormatSaverText *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;
|
|
|
|
ResourceFormatSaverText();
|
|
};
|
|
|
|
#endif // RESOURCE_FORMAT_TEXT_H
|