mirror of
https://github.com/godotengine/godot.git
synced 2024-12-17 00:22:49 +00:00
a7f49ac9a1
Happy new year to the wonderful Godot community! We're starting a new decade with a well-established, non-profit, free and open source game engine, and tons of further improvements in the pipeline from hundreds of contributors. Godot will keep getting better, and we're looking forward to all the games that the community will keep developing and releasing with it.
555 lines
18 KiB
C++
555 lines
18 KiB
C++
/*************************************************************************/
|
|
/* gdnative.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 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 "gdnative.h"
|
|
|
|
#include "core/global_constants.h"
|
|
#include "core/io/file_access_encrypted.h"
|
|
#include "core/os/file_access.h"
|
|
#include "core/os/os.h"
|
|
#include "core/project_settings.h"
|
|
|
|
#include "scene/main/scene_tree.h"
|
|
|
|
static const String init_symbol = "gdnative_init";
|
|
static const String terminate_symbol = "gdnative_terminate";
|
|
static const String default_symbol_prefix = "godot_";
|
|
static const bool default_singleton = false;
|
|
static const bool default_load_once = true;
|
|
static const bool default_reloadable = true;
|
|
|
|
// Defined in gdnative_api_struct.gen.cpp
|
|
extern const godot_gdnative_core_api_struct api_struct;
|
|
|
|
Map<String, Vector<Ref<GDNative> > > GDNativeLibrary::loaded_libraries;
|
|
|
|
GDNativeLibrary::GDNativeLibrary() {
|
|
config_file.instance();
|
|
|
|
symbol_prefix = default_symbol_prefix;
|
|
load_once = default_load_once;
|
|
singleton = default_singleton;
|
|
reloadable = default_reloadable;
|
|
}
|
|
|
|
GDNativeLibrary::~GDNativeLibrary() {
|
|
}
|
|
|
|
bool GDNativeLibrary::_set(const StringName &p_name, const Variant &p_property) {
|
|
|
|
String name = p_name;
|
|
|
|
if (name.begins_with("entry/")) {
|
|
String key = name.substr(6, name.length() - 6);
|
|
|
|
config_file->set_value("entry", key, p_property);
|
|
|
|
set_config_file(config_file);
|
|
|
|
return true;
|
|
}
|
|
|
|
if (name.begins_with("dependency/")) {
|
|
String key = name.substr(11, name.length() - 11);
|
|
|
|
config_file->set_value("dependencies", key, p_property);
|
|
|
|
set_config_file(config_file);
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
bool GDNativeLibrary::_get(const StringName &p_name, Variant &r_property) const {
|
|
String name = p_name;
|
|
|
|
if (name.begins_with("entry/")) {
|
|
String key = name.substr(6, name.length() - 6);
|
|
|
|
r_property = config_file->get_value("entry", key);
|
|
|
|
return true;
|
|
}
|
|
|
|
if (name.begins_with("dependency/")) {
|
|
String key = name.substr(11, name.length() - 11);
|
|
|
|
r_property = config_file->get_value("dependencies", key);
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void GDNativeLibrary::_get_property_list(List<PropertyInfo> *p_list) const {
|
|
// set entries
|
|
List<String> entry_key_list;
|
|
|
|
if (config_file->has_section("entry"))
|
|
config_file->get_section_keys("entry", &entry_key_list);
|
|
|
|
for (List<String>::Element *E = entry_key_list.front(); E; E = E->next()) {
|
|
String key = E->get();
|
|
|
|
PropertyInfo prop;
|
|
|
|
prop.type = Variant::STRING;
|
|
prop.name = "entry/" + key;
|
|
|
|
p_list->push_back(prop);
|
|
}
|
|
|
|
// set dependencies
|
|
List<String> dependency_key_list;
|
|
|
|
if (config_file->has_section("dependencies"))
|
|
config_file->get_section_keys("dependencies", &dependency_key_list);
|
|
|
|
for (List<String>::Element *E = dependency_key_list.front(); E; E = E->next()) {
|
|
String key = E->get();
|
|
|
|
PropertyInfo prop;
|
|
|
|
prop.type = Variant::STRING;
|
|
prop.name = "dependency/" + key;
|
|
|
|
p_list->push_back(prop);
|
|
}
|
|
}
|
|
|
|
void GDNativeLibrary::set_config_file(Ref<ConfigFile> p_config_file) {
|
|
|
|
set_singleton(p_config_file->get_value("general", "singleton", default_singleton));
|
|
set_load_once(p_config_file->get_value("general", "load_once", default_load_once));
|
|
set_symbol_prefix(p_config_file->get_value("general", "symbol_prefix", default_symbol_prefix));
|
|
set_reloadable(p_config_file->get_value("general", "reloadable", default_reloadable));
|
|
|
|
String entry_lib_path;
|
|
{
|
|
|
|
List<String> entry_keys;
|
|
|
|
if (p_config_file->has_section("entry"))
|
|
p_config_file->get_section_keys("entry", &entry_keys);
|
|
|
|
for (List<String>::Element *E = entry_keys.front(); E; E = E->next()) {
|
|
String key = E->get();
|
|
|
|
Vector<String> tags = key.split(".");
|
|
|
|
bool skip = false;
|
|
for (int i = 0; i < tags.size(); i++) {
|
|
bool has_feature = OS::get_singleton()->has_feature(tags[i]);
|
|
|
|
if (!has_feature) {
|
|
skip = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (skip) {
|
|
continue;
|
|
}
|
|
|
|
entry_lib_path = p_config_file->get_value("entry", key);
|
|
break;
|
|
}
|
|
}
|
|
|
|
Vector<String> dependency_paths;
|
|
{
|
|
|
|
List<String> dependency_keys;
|
|
|
|
if (p_config_file->has_section("dependencies"))
|
|
p_config_file->get_section_keys("dependencies", &dependency_keys);
|
|
|
|
for (List<String>::Element *E = dependency_keys.front(); E; E = E->next()) {
|
|
String key = E->get();
|
|
|
|
Vector<String> tags = key.split(".");
|
|
|
|
bool skip = false;
|
|
for (int i = 0; i < tags.size(); i++) {
|
|
bool has_feature = OS::get_singleton()->has_feature(tags[i]);
|
|
|
|
if (!has_feature) {
|
|
skip = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (skip) {
|
|
continue;
|
|
}
|
|
|
|
dependency_paths = p_config_file->get_value("dependencies", key);
|
|
break;
|
|
}
|
|
}
|
|
|
|
current_library_path = entry_lib_path;
|
|
current_dependencies = dependency_paths;
|
|
}
|
|
|
|
void GDNativeLibrary::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("get_config_file"), &GDNativeLibrary::get_config_file);
|
|
ClassDB::bind_method(D_METHOD("set_config_file", "config_file"), &GDNativeLibrary::set_config_file);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_current_library_path"), &GDNativeLibrary::get_current_library_path);
|
|
ClassDB::bind_method(D_METHOD("get_current_dependencies"), &GDNativeLibrary::get_current_dependencies);
|
|
|
|
ClassDB::bind_method(D_METHOD("should_load_once"), &GDNativeLibrary::should_load_once);
|
|
ClassDB::bind_method(D_METHOD("is_singleton"), &GDNativeLibrary::is_singleton);
|
|
ClassDB::bind_method(D_METHOD("get_symbol_prefix"), &GDNativeLibrary::get_symbol_prefix);
|
|
ClassDB::bind_method(D_METHOD("is_reloadable"), &GDNativeLibrary::is_reloadable);
|
|
|
|
ClassDB::bind_method(D_METHOD("set_load_once", "load_once"), &GDNativeLibrary::set_load_once);
|
|
ClassDB::bind_method(D_METHOD("set_singleton", "singleton"), &GDNativeLibrary::set_singleton);
|
|
ClassDB::bind_method(D_METHOD("set_symbol_prefix", "symbol_prefix"), &GDNativeLibrary::set_symbol_prefix);
|
|
ClassDB::bind_method(D_METHOD("set_reloadable", "reloadable"), &GDNativeLibrary::set_reloadable);
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "config_file", PROPERTY_HINT_RESOURCE_TYPE, "ConfigFile", 0), "set_config_file", "get_config_file");
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "load_once"), "set_load_once", "should_load_once");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "singleton"), "set_singleton", "is_singleton");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "symbol_prefix"), "set_symbol_prefix", "get_symbol_prefix");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "reloadable"), "set_reloadable", "is_reloadable");
|
|
}
|
|
|
|
GDNative::GDNative() {
|
|
native_handle = NULL;
|
|
initialized = false;
|
|
}
|
|
|
|
GDNative::~GDNative() {
|
|
}
|
|
|
|
void GDNative::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("set_library", "library"), &GDNative::set_library);
|
|
ClassDB::bind_method(D_METHOD("get_library"), &GDNative::get_library);
|
|
|
|
ClassDB::bind_method(D_METHOD("initialize"), &GDNative::initialize);
|
|
ClassDB::bind_method(D_METHOD("terminate"), &GDNative::terminate);
|
|
|
|
ClassDB::bind_method(D_METHOD("call_native", "calling_type", "procedure_name", "arguments"), &GDNative::call_native);
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "library", PROPERTY_HINT_RESOURCE_TYPE, "GDNativeLibrary"), "set_library", "get_library");
|
|
}
|
|
|
|
void GDNative::set_library(Ref<GDNativeLibrary> p_library) {
|
|
ERR_FAIL_COND_MSG(library.is_valid(), "Tried to change library of GDNative when it is already set.");
|
|
library = p_library;
|
|
}
|
|
|
|
Ref<GDNativeLibrary> GDNative::get_library() const {
|
|
return library;
|
|
}
|
|
|
|
extern "C" void _gdnative_report_version_mismatch(const godot_object *p_library, const char *p_ext, godot_gdnative_api_version p_want, godot_gdnative_api_version p_have);
|
|
extern "C" void _gdnative_report_loading_error(const godot_object *p_library, const char *p_what);
|
|
|
|
bool GDNative::initialize() {
|
|
if (library.is_null()) {
|
|
ERR_PRINT("No library set, can't initialize GDNative object");
|
|
return false;
|
|
}
|
|
|
|
String lib_path = library->get_current_library_path();
|
|
if (lib_path.empty()) {
|
|
ERR_PRINT("No library set for this platform");
|
|
return false;
|
|
}
|
|
#ifdef IPHONE_ENABLED
|
|
// on iOS we use static linking
|
|
String path = "";
|
|
#elif defined(ANDROID_ENABLED)
|
|
// On Android dynamic libraries are located separately from resource assets,
|
|
// we should pass library name to dlopen(). The library name is flattened
|
|
// during export.
|
|
String path = lib_path.get_file();
|
|
#elif defined(UWP_ENABLED)
|
|
// On UWP we use a relative path from the app
|
|
String path = lib_path.replace("res://", "");
|
|
#elif defined(OSX_ENABLED)
|
|
// On OSX the exported libraries are located under the Frameworks directory.
|
|
// So we need to replace the library path.
|
|
String path = ProjectSettings::get_singleton()->globalize_path(lib_path);
|
|
if (!FileAccess::exists(path)) {
|
|
path = OS::get_singleton()->get_executable_path().get_base_dir().plus_file("../Frameworks").plus_file(lib_path.get_file());
|
|
}
|
|
#else
|
|
String path = ProjectSettings::get_singleton()->globalize_path(lib_path);
|
|
#endif
|
|
|
|
if (library->should_load_once()) {
|
|
if (GDNativeLibrary::loaded_libraries.has(lib_path)) {
|
|
// already loaded. Don't load again.
|
|
// copy some of the stuff instead
|
|
this->native_handle = GDNativeLibrary::loaded_libraries[lib_path][0]->native_handle;
|
|
initialized = true;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
Error err = OS::get_singleton()->open_dynamic_library(path, native_handle, true);
|
|
if (err != OK) {
|
|
return false;
|
|
}
|
|
|
|
void *library_init;
|
|
|
|
// we cheat here a little bit. you saw nothing
|
|
initialized = true;
|
|
|
|
err = get_symbol(library->get_symbol_prefix() + init_symbol, library_init, false);
|
|
|
|
initialized = false;
|
|
|
|
if (err || !library_init) {
|
|
OS::get_singleton()->close_dynamic_library(native_handle);
|
|
native_handle = NULL;
|
|
ERR_PRINTS("Failed to obtain " + library->get_symbol_prefix() + "gdnative_init symbol");
|
|
return false;
|
|
}
|
|
|
|
godot_gdnative_init_fn library_init_fpointer;
|
|
library_init_fpointer = (godot_gdnative_init_fn)library_init;
|
|
|
|
static uint64_t core_api_hash = 0;
|
|
static uint64_t editor_api_hash = 0;
|
|
static uint64_t no_api_hash = 0;
|
|
|
|
if (!(core_api_hash || editor_api_hash || no_api_hash)) {
|
|
core_api_hash = ClassDB::get_api_hash(ClassDB::API_CORE);
|
|
editor_api_hash = ClassDB::get_api_hash(ClassDB::API_EDITOR);
|
|
no_api_hash = ClassDB::get_api_hash(ClassDB::API_NONE);
|
|
}
|
|
|
|
godot_gdnative_init_options options;
|
|
|
|
options.api_struct = &api_struct;
|
|
options.in_editor = Engine::get_singleton()->is_editor_hint();
|
|
options.core_api_hash = core_api_hash;
|
|
options.editor_api_hash = editor_api_hash;
|
|
options.no_api_hash = no_api_hash;
|
|
options.report_version_mismatch = &_gdnative_report_version_mismatch;
|
|
options.report_loading_error = &_gdnative_report_loading_error;
|
|
options.gd_native_library = (godot_object *)(get_library().ptr());
|
|
options.active_library_path = (godot_string *)&path;
|
|
|
|
library_init_fpointer(&options);
|
|
|
|
initialized = true;
|
|
|
|
if (library->should_load_once() && !GDNativeLibrary::loaded_libraries.has(lib_path)) {
|
|
Vector<Ref<GDNative> > gdnatives;
|
|
gdnatives.resize(1);
|
|
gdnatives.write[0] = Ref<GDNative>(this);
|
|
GDNativeLibrary::loaded_libraries.insert(lib_path, gdnatives);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool GDNative::terminate() {
|
|
|
|
if (!initialized) {
|
|
ERR_PRINT("No valid library handle, can't terminate GDNative object");
|
|
return false;
|
|
}
|
|
|
|
if (library->should_load_once()) {
|
|
Vector<Ref<GDNative> > *gdnatives = &GDNativeLibrary::loaded_libraries[library->get_current_library_path()];
|
|
if (gdnatives->size() > 1) {
|
|
// there are other GDNative's still using this library, so we actually don't terminate
|
|
gdnatives->erase(Ref<GDNative>(this));
|
|
initialized = false;
|
|
return true;
|
|
} else if (gdnatives->size() == 1) {
|
|
// we're the last one, terminate!
|
|
gdnatives->clear();
|
|
// whew this looks scary, but all it does is remove the entry completely
|
|
GDNativeLibrary::loaded_libraries.erase(GDNativeLibrary::loaded_libraries.find(library->get_current_library_path()));
|
|
}
|
|
}
|
|
|
|
void *library_terminate;
|
|
Error error = get_symbol(library->get_symbol_prefix() + terminate_symbol, library_terminate);
|
|
if (error || !library_terminate) {
|
|
OS::get_singleton()->close_dynamic_library(native_handle);
|
|
native_handle = NULL;
|
|
initialized = false;
|
|
return true;
|
|
}
|
|
|
|
godot_gdnative_terminate_fn library_terminate_pointer;
|
|
library_terminate_pointer = (godot_gdnative_terminate_fn)library_terminate;
|
|
|
|
godot_gdnative_terminate_options options;
|
|
options.in_editor = Engine::get_singleton()->is_editor_hint();
|
|
|
|
library_terminate_pointer(&options);
|
|
|
|
initialized = false;
|
|
|
|
// GDNativeScriptLanguage::get_singleton()->initialized_libraries.erase(p_native_lib->path);
|
|
|
|
OS::get_singleton()->close_dynamic_library(native_handle);
|
|
native_handle = NULL;
|
|
|
|
return true;
|
|
}
|
|
|
|
bool GDNative::is_initialized() const {
|
|
return initialized;
|
|
}
|
|
|
|
void GDNativeCallRegistry::register_native_call_type(StringName p_call_type, native_call_cb p_callback) {
|
|
native_calls.insert(p_call_type, p_callback);
|
|
}
|
|
|
|
Vector<StringName> GDNativeCallRegistry::get_native_call_types() {
|
|
Vector<StringName> call_types;
|
|
call_types.resize(native_calls.size());
|
|
|
|
size_t idx = 0;
|
|
for (Map<StringName, native_call_cb>::Element *E = native_calls.front(); E; E = E->next(), idx++) {
|
|
call_types.write[idx] = E->key();
|
|
}
|
|
|
|
return call_types;
|
|
}
|
|
|
|
Variant GDNative::call_native(StringName p_native_call_type, StringName p_procedure_name, Array p_arguments) {
|
|
|
|
Map<StringName, native_call_cb>::Element *E = GDNativeCallRegistry::singleton->native_calls.find(p_native_call_type);
|
|
if (!E) {
|
|
ERR_PRINT((String("No handler for native call type \"" + p_native_call_type) + "\" found").utf8().get_data());
|
|
return Variant();
|
|
}
|
|
|
|
void *procedure_handle;
|
|
|
|
Error err = OS::get_singleton()->get_dynamic_library_symbol_handle(
|
|
native_handle,
|
|
p_procedure_name,
|
|
procedure_handle);
|
|
|
|
if (err != OK || procedure_handle == NULL) {
|
|
return Variant();
|
|
}
|
|
|
|
godot_variant result = E->get()(procedure_handle, (godot_array *)&p_arguments);
|
|
|
|
Variant res = *(Variant *)&result;
|
|
godot_variant_destroy(&result);
|
|
return res;
|
|
}
|
|
|
|
Error GDNative::get_symbol(StringName p_procedure_name, void *&r_handle, bool p_optional) const {
|
|
|
|
if (!initialized) {
|
|
ERR_PRINT("No valid library handle, can't get symbol from GDNative object");
|
|
return ERR_CANT_OPEN;
|
|
}
|
|
|
|
Error result = OS::get_singleton()->get_dynamic_library_symbol_handle(
|
|
native_handle,
|
|
p_procedure_name,
|
|
r_handle,
|
|
p_optional);
|
|
|
|
return result;
|
|
}
|
|
|
|
RES GDNativeLibraryResourceLoader::load(const String &p_path, const String &p_original_path, Error *r_error) {
|
|
Ref<GDNativeLibrary> lib;
|
|
lib.instance();
|
|
|
|
Ref<ConfigFile> config = lib->get_config_file();
|
|
|
|
Error err = config->load(p_path);
|
|
|
|
if (r_error) {
|
|
*r_error = err;
|
|
}
|
|
|
|
lib->set_config_file(config);
|
|
|
|
return lib;
|
|
}
|
|
|
|
void GDNativeLibraryResourceLoader::get_recognized_extensions(List<String> *p_extensions) const {
|
|
p_extensions->push_back("gdnlib");
|
|
}
|
|
|
|
bool GDNativeLibraryResourceLoader::handles_type(const String &p_type) const {
|
|
return p_type == "GDNativeLibrary";
|
|
}
|
|
|
|
String GDNativeLibraryResourceLoader::get_resource_type(const String &p_path) const {
|
|
String el = p_path.get_extension().to_lower();
|
|
if (el == "gdnlib")
|
|
return "GDNativeLibrary";
|
|
return "";
|
|
}
|
|
|
|
Error GDNativeLibraryResourceSaver::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
|
|
|
|
Ref<GDNativeLibrary> lib = p_resource;
|
|
|
|
if (lib.is_null()) {
|
|
return ERR_INVALID_DATA;
|
|
}
|
|
|
|
Ref<ConfigFile> config = lib->get_config_file();
|
|
|
|
config->set_value("general", "singleton", lib->is_singleton());
|
|
config->set_value("general", "load_once", lib->should_load_once());
|
|
config->set_value("general", "symbol_prefix", lib->get_symbol_prefix());
|
|
config->set_value("general", "reloadable", lib->is_reloadable());
|
|
|
|
return config->save(p_path);
|
|
}
|
|
|
|
bool GDNativeLibraryResourceSaver::recognize(const RES &p_resource) const {
|
|
return Object::cast_to<GDNativeLibrary>(*p_resource) != NULL;
|
|
}
|
|
|
|
void GDNativeLibraryResourceSaver::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
|
|
if (Object::cast_to<GDNativeLibrary>(*p_resource) != NULL) {
|
|
p_extensions->push_back("gdnlib");
|
|
}
|
|
}
|