2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* resource_saver.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00: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. */
/*************************************************************************/
2018-01-04 23:50:27 +00:00
2014-02-10 01:10:30 +00:00
# include "resource_saver.h"
2020-11-07 22:33:38 +00:00
# include "core/config/project_settings.h"
2021-06-11 12:51:48 +00:00
# include "core/io/file_access.h"
2018-09-11 16:13:45 +00:00
# include "core/io/resource_loader.h"
2020-11-07 22:33:38 +00:00
# include "core/object/script_language.h"
2014-02-10 01:10:30 +00:00
2018-06-11 00:59:53 +00:00
Ref < ResourceFormatSaver > ResourceSaver : : saver [ MAX_SAVERS ] ;
2014-02-10 01:10:30 +00:00
2017-03-05 15:44:50 +00:00
int ResourceSaver : : saver_count = 0 ;
bool ResourceSaver : : timestamp_on_save = false ;
2020-04-01 23:20:12 +00:00
ResourceSavedCallback ResourceSaver : : save_callback = nullptr ;
2021-07-23 19:01:18 +00:00
ResourceSaverGetResourceIDForPath ResourceSaver : : save_get_id_for_path = nullptr ;
2014-02-10 01:10:30 +00:00
2022-06-02 23:33:42 +00:00
Error ResourceFormatSaver : : save ( const Ref < Resource > & p_resource , const String & p_path , uint32_t p_flags ) {
2021-08-22 01:52:44 +00:00
int64_t res ;
2022-06-02 23:33:42 +00:00
if ( GDVIRTUAL_CALL ( _save , p_resource , p_path , p_flags , res ) ) {
2021-08-22 01:52:44 +00:00
return ( Error ) res ;
2018-06-11 00:59:53 +00:00
}
return ERR_METHOD_NOT_FOUND ;
}
2022-05-02 23:43:50 +00:00
bool ResourceFormatSaver : : recognize ( const Ref < Resource > & p_resource ) const {
2021-08-22 01:52:44 +00:00
bool success ;
if ( GDVIRTUAL_CALL ( _recognize , p_resource , success ) ) {
return success ;
2018-06-11 00:59:53 +00:00
}
return false ;
}
2022-05-02 23:43:50 +00:00
void ResourceFormatSaver : : get_recognized_extensions ( const Ref < Resource > & p_resource , List < String > * p_extensions ) const {
2021-08-22 01:52:44 +00:00
PackedStringArray exts ;
if ( GDVIRTUAL_CALL ( _get_recognized_extensions , p_resource , exts ) ) {
const String * r = exts . ptr ( ) ;
for ( int i = 0 ; i < exts . size ( ) ; + + i ) {
p_extensions - > push_back ( r [ i ] ) ;
2018-06-11 00:59:53 +00:00
}
}
}
void ResourceFormatSaver : : _bind_methods ( ) {
2022-08-24 10:11:34 +00:00
GDVIRTUAL_BIND ( _save , " resource " , " path " , " flags " ) ;
2021-08-22 01:52:44 +00:00
GDVIRTUAL_BIND ( _recognize , " resource " ) ;
GDVIRTUAL_BIND ( _get_recognized_extensions , " resource " ) ;
2018-06-11 00:59:53 +00:00
}
2022-06-02 23:33:42 +00:00
Error ResourceSaver : : save ( const Ref < Resource > & p_resource , const String & p_path , uint32_t p_flags ) {
String path = p_path ;
if ( path . is_empty ( ) ) {
path = p_resource - > get_path ( ) ;
}
2022-07-30 09:08:40 +00:00
ERR_FAIL_COND_V_MSG ( path . is_empty ( ) , ERR_INVALID_PARAMETER , " Can't save resource to empty path. Provide non-empty path or a Resource with non-empty resource_path. " ) ;
2022-06-02 23:33:42 +00:00
String extension = path . get_extension ( ) ;
2017-03-05 15:44:50 +00:00
Error err = ERR_FILE_UNRECOGNIZED ;
2014-02-10 01:10:30 +00:00
2017-03-05 15:44:50 +00:00
for ( int i = 0 ; i < saver_count ; i + + ) {
2020-05-14 14:41:43 +00:00
if ( ! saver [ i ] - > recognize ( p_resource ) ) {
2014-02-10 01:10:30 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
List < String > extensions ;
2017-03-05 15:44:50 +00:00
bool recognized = false ;
saver [ i ] - > get_recognized_extensions ( p_resource , & extensions ) ;
2016-03-08 23:00:52 +00:00
2021-07-24 13:46:25 +00:00
for ( const String & E : extensions ) {
2021-07-16 03:45:57 +00:00
if ( E . nocasecmp_to ( extension ) = = 0 ) {
2017-03-05 15:44:50 +00:00
recognized = true ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
}
2020-05-14 14:41:43 +00:00
if ( ! recognized ) {
2014-02-10 01:10:30 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2016-03-08 23:00:52 +00:00
2017-03-05 15:44:50 +00:00
String old_path = p_resource - > get_path ( ) ;
2016-03-08 23:00:52 +00:00
2022-06-02 23:33:42 +00:00
String local_path = ProjectSettings : : get_singleton ( ) - > localize_path ( path ) ;
2014-02-10 01:10:30 +00:00
2022-05-02 23:43:50 +00:00
Ref < Resource > rwcopy = p_resource ;
2020-05-14 14:41:43 +00:00
if ( p_flags & FLAG_CHANGE_PATH ) {
2014-02-10 01:10:30 +00:00
rwcopy - > set_path ( local_path ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
2022-06-02 23:33:42 +00:00
err = saver [ i ] - > save ( p_resource , path , p_flags ) ;
2014-02-10 01:10:30 +00:00
2017-03-05 15:44:50 +00:00
if ( err = = OK ) {
2014-02-10 01:10:30 +00:00
# ifdef TOOLS_ENABLED
2017-03-05 15:44:50 +00:00
( ( Resource * ) p_resource . ptr ( ) ) - > set_edited ( false ) ;
2014-02-10 01:10:30 +00:00
if ( timestamp_on_save ) {
2022-06-02 23:33:42 +00:00
uint64_t mt = FileAccess : : get_modified_time ( path ) ;
2014-02-10 01:10:30 +00:00
2017-03-05 15:44:50 +00:00
( ( Resource * ) p_resource . ptr ( ) ) - > set_last_modified_time ( mt ) ;
2014-02-10 01:10:30 +00:00
}
# endif
2020-05-14 14:41:43 +00:00
if ( p_flags & FLAG_CHANGE_PATH ) {
2014-02-10 01:10:30 +00:00
rwcopy - > set_path ( old_path ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
2022-06-02 23:33:42 +00:00
if ( save_callback & & path . begins_with ( " res:// " ) ) {
save_callback ( p_resource , path ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
return OK ;
}
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
return err ;
}
void ResourceSaver : : set_save_callback ( ResourceSavedCallback p_callback ) {
2017-03-05 15:44:50 +00:00
save_callback = p_callback ;
2014-02-10 01:10:30 +00:00
}
2022-05-02 23:43:50 +00:00
void ResourceSaver : : get_recognized_extensions ( const Ref < Resource > & p_resource , List < String > * p_extensions ) {
2017-03-05 15:44:50 +00:00
for ( int i = 0 ; i < saver_count ; i + + ) {
saver [ i ] - > get_recognized_extensions ( p_resource , p_extensions ) ;
2014-02-10 01:10:30 +00:00
}
}
2018-06-11 00:59:53 +00:00
void ResourceSaver : : add_resource_format_saver ( Ref < ResourceFormatSaver > p_format_saver , bool p_at_front ) {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG ( p_format_saver . is_null ( ) , " It's not a reference to a valid ResourceFormatSaver object. " ) ;
2017-03-05 15:44:50 +00:00
ERR_FAIL_COND ( saver_count > = MAX_SAVERS ) ;
2016-07-20 00:40:05 +00:00
if ( p_at_front ) {
2017-03-05 15:44:50 +00:00
for ( int i = saver_count ; i > 0 ; i - - ) {
saver [ i ] = saver [ i - 1 ] ;
2016-07-20 00:40:05 +00:00
}
2017-03-05 15:44:50 +00:00
saver [ 0 ] = p_format_saver ;
2016-07-20 00:40:05 +00:00
saver_count + + ;
} else {
2017-03-05 15:44:50 +00:00
saver [ saver_count + + ] = p_format_saver ;
2016-07-20 00:40:05 +00:00
}
2014-02-10 01:10:30 +00:00
}
2018-06-11 00:59:53 +00:00
void ResourceSaver : : remove_resource_format_saver ( Ref < ResourceFormatSaver > p_format_saver ) {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG ( p_format_saver . is_null ( ) , " It's not a reference to a valid ResourceFormatSaver object. " ) ;
2018-06-11 00:59:53 +00:00
// Find saver
int i = 0 ;
for ( ; i < saver_count ; + + i ) {
2020-05-14 14:41:43 +00:00
if ( saver [ i ] = = p_format_saver ) {
2018-06-11 00:59:53 +00:00
break ;
2020-05-14 14:41:43 +00:00
}
2018-06-11 00:59:53 +00:00
}
ERR_FAIL_COND ( i > = saver_count ) ; // Not found
// Shift next savers up
for ( ; i < saver_count - 1 ; + + i ) {
saver [ i ] = saver [ i + 1 ] ;
}
saver [ saver_count - 1 ] . unref ( ) ;
- - saver_count ;
}
Ref < ResourceFormatSaver > ResourceSaver : : _find_custom_resource_format_saver ( String path ) {
for ( int i = 0 ; i < saver_count ; + + i ) {
if ( saver [ i ] - > get_script_instance ( ) & & saver [ i ] - > get_script_instance ( ) - > get_script ( ) - > get_path ( ) = = path ) {
return saver [ i ] ;
}
}
return Ref < ResourceFormatSaver > ( ) ;
}
bool ResourceSaver : : add_custom_resource_format_saver ( String script_path ) {
2020-05-14 14:41:43 +00:00
if ( _find_custom_resource_format_saver ( script_path ) . is_valid ( ) ) {
2018-06-11 00:59:53 +00:00
return false ;
2020-05-14 14:41:43 +00:00
}
2018-06-11 00:59:53 +00:00
Ref < Resource > res = ResourceLoader : : load ( script_path ) ;
ERR_FAIL_COND_V ( res . is_null ( ) , false ) ;
ERR_FAIL_COND_V ( ! res - > is_class ( " Script " ) , false ) ;
Ref < Script > s = res ;
StringName ibt = s - > get_instance_base_type ( ) ;
bool valid_type = ClassDB : : is_parent_class ( ibt , " ResourceFormatSaver " ) ;
2019-08-15 02:57:49 +00:00
ERR_FAIL_COND_V_MSG ( ! valid_type , false , " Script does not inherit a CustomResourceSaver: " + script_path + " . " ) ;
2018-06-11 00:59:53 +00:00
2021-06-17 22:03:09 +00:00
Object * obj = ClassDB : : instantiate ( ibt ) ;
2018-06-11 00:59:53 +00:00
2020-04-01 23:20:12 +00:00
ERR_FAIL_COND_V_MSG ( obj = = nullptr , false , " Cannot instance script as custom resource saver, expected 'ResourceFormatSaver' inheritance, got: " + String ( ibt ) + " . " ) ;
2018-06-11 00:59:53 +00:00
2020-11-15 14:14:06 +00:00
Ref < ResourceFormatSaver > crl = Object : : cast_to < ResourceFormatSaver > ( obj ) ;
2020-02-13 19:03:10 +00:00
crl - > set_script ( s ) ;
2018-06-11 00:59:53 +00:00
ResourceSaver : : add_resource_format_saver ( crl ) ;
return true ;
}
void ResourceSaver : : remove_custom_resource_format_saver ( String script_path ) {
2019-02-12 20:10:08 +00:00
Ref < ResourceFormatSaver > custom_saver = _find_custom_resource_format_saver ( script_path ) ;
2020-05-14 14:41:43 +00:00
if ( custom_saver . is_valid ( ) ) {
2019-02-12 20:10:08 +00:00
remove_resource_format_saver ( custom_saver ) ;
2020-05-14 14:41:43 +00:00
}
2018-06-11 00:59:53 +00:00
}
void ResourceSaver : : add_custom_savers ( ) {
// Custom resource savers exploits global class names
String custom_saver_base_class = ResourceFormatSaver : : get_class_static ( ) ;
List < StringName > global_classes ;
ScriptServer : : get_global_class_list ( & global_classes ) ;
2021-07-24 13:46:25 +00:00
for ( const StringName & class_name : global_classes ) {
2019-03-09 03:47:27 +00:00
StringName base_class = ScriptServer : : get_global_class_native_base ( class_name ) ;
2018-06-11 00:59:53 +00:00
if ( base_class = = custom_saver_base_class ) {
String path = ScriptServer : : get_global_class_path ( class_name ) ;
add_custom_resource_format_saver ( path ) ;
}
}
}
void ResourceSaver : : remove_custom_savers ( ) {
2020-03-17 06:33:00 +00:00
Vector < Ref < ResourceFormatSaver > > custom_savers ;
2018-06-11 00:59:53 +00:00
for ( int i = 0 ; i < saver_count ; + + i ) {
if ( saver [ i ] - > get_script_instance ( ) ) {
custom_savers . push_back ( saver [ i ] ) ;
}
}
for ( int i = 0 ; i < custom_savers . size ( ) ; + + i ) {
remove_resource_format_saver ( custom_savers [ i ] ) ;
}
}
2021-07-23 19:01:18 +00:00
ResourceUID : : ID ResourceSaver : : get_resource_id_for_path ( const String & p_path , bool p_generate ) {
if ( save_get_id_for_path ) {
return save_get_id_for_path ( p_path , p_generate ) ;
}
return ResourceUID : : INVALID_ID ;
}
void ResourceSaver : : set_get_resource_id_for_path ( ResourceSaverGetResourceIDForPath p_callback ) {
save_get_id_for_path = p_callback ;
}