1/**************************************************************************/
2/* resource_saver.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef RESOURCE_SAVER_H
32#define RESOURCE_SAVER_H
33
34#include "core/io/resource.h"
35#include "core/object/gdvirtual.gen.inc"
36
37class ResourceFormatSaver : public RefCounted {
38 GDCLASS(ResourceFormatSaver, RefCounted);
39
40protected:
41 static void _bind_methods();
42
43 GDVIRTUAL3R(Error, _save, Ref<Resource>, String, uint32_t)
44 GDVIRTUAL2R(Error, _set_uid, String, ResourceUID::ID)
45 GDVIRTUAL1RC(bool, _recognize, Ref<Resource>)
46 GDVIRTUAL1RC(Vector<String>, _get_recognized_extensions, Ref<Resource>)
47 GDVIRTUAL2RC(bool, _recognize_path, Ref<Resource>, String)
48
49public:
50 virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0);
51 virtual Error set_uid(const String &p_path, ResourceUID::ID p_uid);
52 virtual bool recognize(const Ref<Resource> &p_resource) const;
53 virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
54 virtual bool recognize_path(const Ref<Resource> &p_resource, const String &p_path) const;
55
56 virtual ~ResourceFormatSaver() {}
57};
58
59typedef void (*ResourceSavedCallback)(Ref<Resource> p_resource, const String &p_path);
60typedef ResourceUID::ID (*ResourceSaverGetResourceIDForPath)(const String &p_path, bool p_generate);
61
62class ResourceSaver {
63 enum {
64 MAX_SAVERS = 64
65 };
66
67 static Ref<ResourceFormatSaver> saver[MAX_SAVERS];
68 static int saver_count;
69 static bool timestamp_on_save;
70 static ResourceSavedCallback save_callback;
71 static ResourceSaverGetResourceIDForPath save_get_id_for_path;
72
73 static Ref<ResourceFormatSaver> _find_custom_resource_format_saver(String path);
74
75public:
76 enum SaverFlags {
77 FLAG_NONE = 0,
78 FLAG_RELATIVE_PATHS = 1,
79 FLAG_BUNDLE_RESOURCES = 2,
80 FLAG_CHANGE_PATH = 4,
81 FLAG_OMIT_EDITOR_PROPERTIES = 8,
82 FLAG_SAVE_BIG_ENDIAN = 16,
83 FLAG_COMPRESS = 32,
84 FLAG_REPLACE_SUBRESOURCE_PATHS = 64,
85 };
86
87 static Error save(const Ref<Resource> &p_resource, const String &p_path = "", uint32_t p_flags = (uint32_t)FLAG_NONE);
88 static void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions);
89 static void add_resource_format_saver(Ref<ResourceFormatSaver> p_format_saver, bool p_at_front = false);
90 static void remove_resource_format_saver(Ref<ResourceFormatSaver> p_format_saver);
91
92 static Error set_uid(const String &p_path, ResourceUID::ID p_uid);
93
94 static void set_timestamp_on_save(bool p_timestamp) { timestamp_on_save = p_timestamp; }
95 static bool get_timestamp_on_save() { return timestamp_on_save; }
96
97 static ResourceUID::ID get_resource_id_for_path(const String &p_path, bool p_generate = false);
98
99 static void set_save_callback(ResourceSavedCallback p_callback);
100 static void set_get_resource_id_for_path(ResourceSaverGetResourceIDForPath p_callback);
101
102 static bool add_custom_resource_format_saver(String script_path);
103 static void add_custom_savers();
104 static void remove_custom_savers();
105};
106
107#endif // RESOURCE_SAVER_H
108