2021-06-19 17:58:49 +02:00
/*************************************************************************/
/* native_extension.cpp */
/*************************************************************************/
/* 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. */
/*************************************************************************/
# include "native_extension.h"
2021-07-29 15:53:05 +02:00
# include "core/config/project_settings.h"
2021-06-19 17:58:49 +02:00
# include "core/io/config_file.h"
# include "core/object/class_db.h"
# include "core/object/method_bind.h"
# include "core/os/os.h"
2021-08-20 20:32:56 +02:00
const char * NativeExtension : : EXTENSION_LIST_CONFIG_FILE = " res://.godot/extension_list.cfg " ;
2021-06-19 17:58:49 +02:00
class NativeExtensionMethodBind : public MethodBind {
GDNativeExtensionClassMethodCall call_func ;
GDNativeExtensionClassMethodPtrCall ptrcall_func ;
GDNativeExtensionClassMethodGetArgumentType get_argument_type_func ;
GDNativeExtensionClassMethodGetArgumentInfo get_argument_info_func ;
GDNativeExtensionClassMethodGetArgumentMetadata get_argument_metadata_func ;
void * method_userdata ;
bool vararg ;
protected :
virtual Variant : : Type _gen_argument_type ( int p_arg ) const {
return Variant : : Type ( get_argument_type_func ( method_userdata , p_arg ) ) ;
}
virtual PropertyInfo _gen_argument_type_info ( int p_arg ) const {
GDNativePropertyInfo pinfo ;
get_argument_info_func ( method_userdata , p_arg , & pinfo ) ;
PropertyInfo ret ;
ret . type = Variant : : Type ( pinfo . type ) ;
ret . name = pinfo . name ;
ret . class_name = pinfo . class_name ;
ret . hint = PropertyHint ( pinfo . hint ) ;
ret . usage = pinfo . usage ;
ret . class_name = pinfo . class_name ;
return ret ;
}
public :
virtual GodotTypeInfo : : Metadata get_argument_meta ( int p_arg ) const {
return GodotTypeInfo : : Metadata ( get_argument_metadata_func ( method_userdata , p_arg ) ) ;
}
virtual Variant call ( Object * p_object , const Variant * * p_args , int p_arg_count , Callable : : CallError & r_error ) {
Variant ret ;
GDExtensionClassInstancePtr extension_instance = p_object - > _get_extension_instance ( ) ;
2021-08-17 22:01:38 +02:00
GDNativeCallError ce { GDNATIVE_CALL_OK , 0 , 0 } ;
2021-07-29 15:53:05 +02:00
call_func ( method_userdata , extension_instance , ( const GDNativeVariantPtr * ) p_args , p_arg_count , ( GDNativeVariantPtr ) & ret , & ce ) ;
2021-06-19 17:58:49 +02:00
r_error . error = Callable : : CallError : : Error ( ce . error ) ;
r_error . argument = ce . argument ;
r_error . expected = ce . expected ;
return ret ;
}
virtual void ptrcall ( Object * p_object , const void * * p_args , void * r_ret ) {
ERR_FAIL_COND_MSG ( vararg , " Vararg methods don't have ptrcall support. This is most likely an engine bug. " ) ;
GDExtensionClassInstancePtr extension_instance = p_object - > _get_extension_instance ( ) ;
2021-07-29 15:53:05 +02:00
ptrcall_func ( method_userdata , extension_instance , ( const GDNativeTypePtr * ) p_args , ( GDNativeTypePtr ) r_ret ) ;
2021-06-19 17:58:49 +02:00
}
virtual bool is_vararg ( ) const {
return false ;
}
NativeExtensionMethodBind ( const GDNativeExtensionClassMethodInfo * p_method_info ) {
method_userdata = p_method_info - > method_userdata ;
call_func = p_method_info - > call_func ;
ptrcall_func = p_method_info - > ptrcall_func ;
get_argument_type_func = p_method_info - > get_argument_type_func ;
get_argument_info_func = p_method_info - > get_argument_info_func ;
get_argument_metadata_func = p_method_info - > get_argument_metadata_func ;
2021-07-29 15:53:05 +02:00
set_name ( p_method_info - > name ) ;
2021-06-19 17:58:49 +02:00
vararg = p_method_info - > method_flags & GDNATIVE_EXTENSION_METHOD_FLAG_VARARG ;
_set_returns ( p_method_info - > has_return_value ) ;
_set_const ( p_method_info - > method_flags & GDNATIVE_EXTENSION_METHOD_FLAG_CONST ) ;
# ifdef DEBUG_METHODS_ENABLED
_generate_argument_types ( p_method_info - > argument_count ) ;
# endif
set_argument_count ( p_method_info - > argument_count ) ;
}
} ;
static GDNativeInterface gdnative_interface ;
void NativeExtension : : _register_extension_class ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const char * p_parent_class_name , const GDNativeExtensionClassCreationInfo * p_extension_funcs ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
2021-07-29 15:53:05 +02:00
ERR_FAIL_COND_MSG ( ! String ( class_name ) . is_valid_identifier ( ) , " Attempt to register extension class ' " + class_name + " ', which is not a valid class identifier. " ) ;
2021-06-19 17:58:49 +02:00
ERR_FAIL_COND_MSG ( ClassDB : : class_exists ( class_name ) , " Attempt to register extension class ' " + class_name + " ', which appears to be already registered. " ) ;
Extension * parent_extension = nullptr ;
StringName parent_class_name = p_parent_class_name ;
if ( self - > extension_classes . has ( parent_class_name ) ) {
parent_extension = & self - > extension_classes [ parent_class_name ] ;
} else if ( ClassDB : : class_exists ( parent_class_name ) ) {
if ( ClassDB : : get_api_type ( parent_class_name ) = = ClassDB : : API_EXTENSION | | ClassDB : : get_api_type ( parent_class_name ) = = ClassDB : : API_EDITOR_EXTENSION ) {
ERR_PRINT ( " Unimplemented yet " ) ;
//inheriting from another extension
} else {
//inheriting from engine class
}
} else {
ERR_FAIL_MSG ( " Attempt to register an extension class ' " + String ( class_name ) + " ' using non-existing parent class ' " + String ( parent_class_name ) + " ' " ) ;
}
self - > extension_classes [ class_name ] = Extension ( ) ;
Extension * extension = & self - > extension_classes [ class_name ] ;
if ( parent_extension ) {
extension - > native_extension . parent = & parent_extension - > native_extension ;
parent_extension - > native_extension . children . push_back ( & extension - > native_extension ) ;
}
extension - > native_extension . parent_class_name = parent_class_name ;
extension - > native_extension . class_name = class_name ;
extension - > native_extension . editor_class = self - > level_initialized = = INITIALIZATION_LEVEL_EDITOR ;
extension - > native_extension . set = p_extension_funcs - > set_func ;
extension - > native_extension . get = p_extension_funcs - > get_func ;
extension - > native_extension . get_property_list = p_extension_funcs - > get_property_list_func ;
extension - > native_extension . free_property_list = p_extension_funcs - > free_property_list_func ;
extension - > native_extension . notification = p_extension_funcs - > notification_func ;
extension - > native_extension . to_string = p_extension_funcs - > to_string_func ;
extension - > native_extension . reference = p_extension_funcs - > reference_func ;
extension - > native_extension . unreference = p_extension_funcs - > unreference_func ;
extension - > native_extension . class_userdata = p_extension_funcs - > class_userdata ;
extension - > native_extension . create_instance = p_extension_funcs - > create_instance_func ;
2021-07-29 15:53:05 +02:00
extension - > native_extension . set_object_instance = p_extension_funcs - > object_instance_func ;
2021-06-19 17:58:49 +02:00
extension - > native_extension . free_instance = p_extension_funcs - > free_instance_func ;
2021-08-18 03:11:11 +02:00
extension - > native_extension . get_virtual = p_extension_funcs - > get_virtual_func ;
2021-06-19 17:58:49 +02:00
ClassDB : : register_extension_class ( & extension - > native_extension ) ;
}
void NativeExtension : : _register_extension_class_method ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const GDNativeExtensionClassMethodInfo * p_method_info ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
StringName method_name = p_method_info - > name ;
2021-07-29 15:53:05 +02:00
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to register extension method ' " + String ( method_name ) + " ' for unexisting class ' " + class_name + " '. " ) ;
2021-06-19 17:58:49 +02:00
//Extension *extension = &self->extension_classes[class_name];
NativeExtensionMethodBind * method = memnew ( NativeExtensionMethodBind ( p_method_info ) ) ;
2021-07-29 15:53:05 +02:00
method - > set_instance_class ( class_name ) ;
2021-06-19 17:58:49 +02:00
ClassDB : : bind_method_custom ( class_name , method ) ;
}
2021-08-17 22:01:38 +02:00
void NativeExtension : : _register_extension_class_integer_constant ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const char * p_enum_name , const char * p_constant_name , GDNativeInt p_constant_value ) {
2021-06-19 17:58:49 +02:00
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
2021-07-29 15:53:05 +02:00
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to register extension constant ' " + String ( p_constant_name ) + " ' for unexisting class ' " + class_name + " '. " ) ;
2021-06-19 17:58:49 +02:00
//Extension *extension = &self->extension_classes[class_name];
ClassDB : : bind_integer_constant ( class_name , p_enum_name , p_constant_name , p_constant_value ) ;
}
2021-09-16 04:37:43 +02:00
2021-06-19 17:58:49 +02:00
void NativeExtension : : _register_extension_class_property ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const GDNativePropertyInfo * p_info , const char * p_setter , const char * p_getter ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
2021-07-29 15:53:05 +02:00
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to register extension class property ' " + String ( p_info - > name ) + " ' for unexisting class ' " + class_name + " '. " ) ;
2021-06-19 17:58:49 +02:00
//Extension *extension = &self->extension_classes[class_name];
PropertyInfo pinfo ;
pinfo . type = Variant : : Type ( p_info - > type ) ;
pinfo . name = p_info - > name ;
pinfo . class_name = p_info - > class_name ;
pinfo . hint = PropertyHint ( p_info - > hint ) ;
pinfo . hint_string = p_info - > hint_string ;
pinfo . usage = p_info - > usage ;
ClassDB : : add_property ( class_name , pinfo , p_setter , p_getter ) ;
}
2021-09-16 04:37:43 +02:00
void NativeExtension : : _register_extension_class_property_group ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const char * p_group_name , const char * p_prefix ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to register extension class property group ' " + String ( p_group_name ) + " ' for unexisting class ' " + class_name + " '. " ) ;
ClassDB : : add_property_group ( class_name , p_group_name , p_prefix ) ;
}
void NativeExtension : : _register_extension_class_property_subgroup ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const char * p_subgroup_name , const char * p_prefix ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to register extension class property subgroup ' " + String ( p_subgroup_name ) + " ' for unexisting class ' " + class_name + " '. " ) ;
ClassDB : : add_property_subgroup ( class_name , p_subgroup_name , p_prefix ) ;
}
2021-06-19 17:58:49 +02:00
void NativeExtension : : _register_extension_class_signal ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name , const char * p_signal_name , const GDNativePropertyInfo * p_argument_info , GDNativeInt p_argument_count ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
2021-07-29 15:53:05 +02:00
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to register extension class signal ' " + String ( p_signal_name ) + " ' for unexisting class ' " + class_name + " '. " ) ;
2021-06-19 17:58:49 +02:00
MethodInfo s ;
s . name = p_signal_name ;
for ( int i = 0 ; i < p_argument_count ; i + + ) {
PropertyInfo arg ;
arg . type = Variant : : Type ( p_argument_info [ i ] . type ) ;
arg . name = p_argument_info [ i ] . name ;
arg . class_name = p_argument_info [ i ] . class_name ;
arg . hint = PropertyHint ( p_argument_info [ i ] . hint ) ;
arg . hint_string = p_argument_info [ i ] . hint_string ;
arg . usage = p_argument_info [ i ] . usage ;
s . arguments . push_back ( arg ) ;
}
ClassDB : : add_signal ( class_name , s ) ;
}
void NativeExtension : : _unregister_extension_class ( const GDNativeExtensionClassLibraryPtr p_library , const char * p_class_name ) {
NativeExtension * self = ( NativeExtension * ) p_library ;
StringName class_name = p_class_name ;
2021-07-29 15:53:05 +02:00
ERR_FAIL_COND_MSG ( ! self - > extension_classes . has ( class_name ) , " Attempt to unregister unexisting extension class ' " + class_name + " '. " ) ;
2021-06-19 17:58:49 +02:00
Extension * ext = & self - > extension_classes [ class_name ] ;
ERR_FAIL_COND_MSG ( ext - > native_extension . children . size ( ) , " Attempt to unregister class ' " + class_name + " ' while other extension classes inherit from it. " ) ;
ClassDB : : unregister_extension_class ( class_name ) ;
if ( ext - > native_extension . parent ! = nullptr ) {
ext - > native_extension . parent - > children . erase ( & ext - > native_extension ) ;
}
self - > extension_classes . erase ( class_name ) ;
}
Error NativeExtension : : open_library ( const String & p_path , const String & p_entry_symbol ) {
Error err = OS : : get_singleton ( ) - > open_dynamic_library ( p_path , library , true ) ;
if ( err ! = OK ) {
return err ;
}
void * entry_funcptr = nullptr ;
err = OS : : get_singleton ( ) - > get_dynamic_library_symbol_handle ( library , p_entry_symbol , entry_funcptr , false ) ;
if ( err ! = OK ) {
OS : : get_singleton ( ) - > close_dynamic_library ( library ) ;
return err ;
}
GDNativeInitializationFunction initialization_function = ( GDNativeInitializationFunction ) entry_funcptr ;
initialization_function ( & gdnative_interface , this , & initialization ) ;
level_initialized = - 1 ;
return OK ;
}
void NativeExtension : : close_library ( ) {
ERR_FAIL_COND ( library = = nullptr ) ;
OS : : get_singleton ( ) - > close_dynamic_library ( library ) ;
library = nullptr ;
}
bool NativeExtension : : is_library_open ( ) const {
return library ! = nullptr ;
}
NativeExtension : : InitializationLevel NativeExtension : : get_minimum_library_initialization_level ( ) const {
ERR_FAIL_COND_V ( library = = nullptr , INITIALIZATION_LEVEL_CORE ) ;
return InitializationLevel ( initialization . minimum_initialization_level ) ;
}
void NativeExtension : : initialize_library ( InitializationLevel p_level ) {
ERR_FAIL_COND ( library = = nullptr ) ;
ERR_FAIL_COND ( p_level < = int32_t ( level_initialized ) ) ;
level_initialized = int32_t ( p_level ) ;
ERR_FAIL_COND ( initialization . initialize = = nullptr ) ;
initialization . initialize ( initialization . userdata , GDNativeInitializationLevel ( p_level ) ) ;
}
void NativeExtension : : deinitialize_library ( InitializationLevel p_level ) {
ERR_FAIL_COND ( library = = nullptr ) ;
ERR_FAIL_COND ( p_level > int32_t ( level_initialized ) ) ;
level_initialized = int32_t ( p_level ) - 1 ;
initialization . deinitialize ( initialization . userdata , GDNativeInitializationLevel ( p_level ) ) ;
}
void NativeExtension : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " open_library " , " path " , " entry_symbol " ) , & NativeExtension : : open_library ) ;
ClassDB : : bind_method ( D_METHOD ( " close_library " ) , & NativeExtension : : close_library ) ;
ClassDB : : bind_method ( D_METHOD ( " is_library_open " ) , & NativeExtension : : is_library_open ) ;
ClassDB : : bind_method ( D_METHOD ( " get_minimum_library_initialization_level " ) , & NativeExtension : : get_minimum_library_initialization_level ) ;
ClassDB : : bind_method ( D_METHOD ( " initialize_library " , " level " ) , & NativeExtension : : initialize_library ) ;
BIND_ENUM_CONSTANT ( INITIALIZATION_LEVEL_CORE ) ;
BIND_ENUM_CONSTANT ( INITIALIZATION_LEVEL_SERVERS ) ;
BIND_ENUM_CONSTANT ( INITIALIZATION_LEVEL_SCENE ) ;
BIND_ENUM_CONSTANT ( INITIALIZATION_LEVEL_EDITOR ) ;
}
NativeExtension : : NativeExtension ( ) {
}
NativeExtension : : ~ NativeExtension ( ) {
if ( library ! = nullptr ) {
close_library ( ) ;
}
}
extern void gdnative_setup_interface ( GDNativeInterface * p_interface ) ;
void NativeExtension : : initialize_native_extensions ( ) {
gdnative_setup_interface ( & gdnative_interface ) ;
gdnative_interface . classdb_register_extension_class = _register_extension_class ;
gdnative_interface . classdb_register_extension_class_method = _register_extension_class_method ;
gdnative_interface . classdb_register_extension_class_integer_constant = _register_extension_class_integer_constant ;
gdnative_interface . classdb_register_extension_class_property = _register_extension_class_property ;
2021-09-16 04:37:43 +02:00
gdnative_interface . classdb_register_extension_class_property_group = _register_extension_class_property_group ;
gdnative_interface . classdb_register_extension_class_property_subgroup = _register_extension_class_property_subgroup ;
2021-06-19 17:58:49 +02:00
gdnative_interface . classdb_register_extension_class_signal = _register_extension_class_signal ;
gdnative_interface . classdb_unregister_extension_class = _unregister_extension_class ;
}
RES NativeExtensionResourceLoader : : load ( const String & p_path , const String & p_original_path , Error * r_error , bool p_use_sub_threads , float * r_progress , CacheMode p_cache_mode ) {
Ref < ConfigFile > config ;
config . instantiate ( ) ;
Error err = config - > load ( p_path ) ;
if ( r_error ) {
* r_error = err ;
}
if ( err ! = OK ) {
return RES ( ) ;
}
if ( ! config - > has_section_key ( " configuration " , " entry_symbol " ) ) {
if ( r_error ) {
* r_error = ERR_INVALID_DATA ;
}
return RES ( ) ;
}
String entry_symbol = config - > get_value ( " configuration " , " entry_symbol " ) ;
List < String > libraries ;
config - > get_section_keys ( " libraries " , & libraries ) ;
String library_path ;
2021-07-24 15:46:25 +02:00
for ( const String & E : libraries ) {
2021-07-16 05:45:57 +02:00
Vector < String > tags = E . split ( " . " ) ;
2021-06-19 17:58:49 +02:00
bool all_tags_met = true ;
for ( int i = 0 ; i < tags . size ( ) ; i + + ) {
String tag = tags [ i ] . strip_edges ( ) ;
if ( ! OS : : get_singleton ( ) - > has_feature ( tag ) ) {
all_tags_met = false ;
break ;
}
}
if ( all_tags_met ) {
2021-07-16 05:45:57 +02:00
library_path = config - > get_value ( " libraries " , E ) ;
2021-06-19 17:58:49 +02:00
break ;
}
}
2021-07-29 15:53:05 +02:00
if ( library_path = = String ( ) ) {
2021-06-19 17:58:49 +02:00
if ( r_error ) {
* r_error = ERR_FILE_NOT_FOUND ;
}
return RES ( ) ;
}
if ( ! library_path . is_resource_file ( ) ) {
library_path = p_path . get_base_dir ( ) . plus_file ( library_path ) ;
}
Ref < NativeExtension > lib ;
lib . instantiate ( ) ;
2021-07-29 15:53:05 +02:00
String abs_path = ProjectSettings : : get_singleton ( ) - > globalize_path ( library_path ) ;
err = lib - > open_library ( abs_path , entry_symbol ) ;
2021-06-19 17:58:49 +02:00
if ( r_error ) {
* r_error = err ;
}
if ( err ! = OK ) {
return RES ( ) ;
}
return lib ;
}
void NativeExtensionResourceLoader : : get_recognized_extensions ( List < String > * p_extensions ) const {
p_extensions - > push_back ( " gdextension " ) ;
}
bool NativeExtensionResourceLoader : : handles_type ( const String & p_type ) const {
return p_type = = " NativeExtension " ;
}
String NativeExtensionResourceLoader : : get_resource_type ( const String & p_path ) const {
String el = p_path . get_extension ( ) . to_lower ( ) ;
if ( el = = " gdextension " ) {
return " NativeExtension " ;
}
return " " ;
}