2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* resource_saver.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:11:45 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2017-01-01 22:01:57 +01:00
|
|
|
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
|
2017-04-08 00:45:00 +02:00
|
|
|
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* 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_SAVER_H
|
|
|
|
#define RESOURCE_SAVER_H
|
|
|
|
|
|
|
|
#include "resource.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
@author Juan Linietsky <reduzio@gmail.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
class ResourceFormatSaver {
|
|
|
|
public:
|
2017-03-19 00:36:26 +01:00
|
|
|
virtual Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0) = 0;
|
|
|
|
virtual bool recognize(const RES &p_resource) const = 0;
|
|
|
|
virtual void get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const = 0;
|
2015-08-24 01:15:56 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual ~ResourceFormatSaver() {}
|
|
|
|
};
|
|
|
|
|
2017-03-19 00:36:26 +01:00
|
|
|
typedef void (*ResourceSavedCallback)(const String &p_path);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-03-09 00:00:52 +01:00
|
|
|
class ResourceSaver {
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
enum {
|
2017-03-19 00:36:26 +01:00
|
|
|
MAX_SAVERS = 64
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
static ResourceFormatSaver *saver[MAX_SAVERS];
|
|
|
|
static int saver_count;
|
|
|
|
static bool timestamp_on_save;
|
|
|
|
static ResourceSavedCallback save_callback;
|
|
|
|
|
|
|
|
public:
|
|
|
|
enum SaverFlags {
|
|
|
|
|
2017-03-19 00:36:26 +01:00
|
|
|
FLAG_RELATIVE_PATHS = 1,
|
|
|
|
FLAG_BUNDLE_RESOURCES = 2,
|
|
|
|
FLAG_CHANGE_PATH = 4,
|
|
|
|
FLAG_OMIT_EDITOR_PROPERTIES = 8,
|
|
|
|
FLAG_SAVE_BIG_ENDIAN = 16,
|
|
|
|
FLAG_COMPRESS = 32,
|
|
|
|
FLAG_REPLACE_SUBRESOURCE_PATHS = 64,
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2017-03-19 00:36:26 +01:00
|
|
|
static Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
|
|
|
|
static void get_recognized_extensions(const RES &p_resource, List<String> *p_extensions);
|
|
|
|
static void add_resource_format_saver(ResourceFormatSaver *p_format_saver, bool p_at_front = false);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-19 00:36:26 +01:00
|
|
|
static void set_timestamp_on_save(bool p_timestamp) { timestamp_on_save = p_timestamp; }
|
2014-02-10 02:10:30 +01:00
|
|
|
static void set_save_callback(ResourceSavedCallback p_callback);
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|