GDExtension: Implement `GDExtensionLoader` concept
- Implements the concept of GDExtension loaders that can be used to customize how GDExtensions are loaded and initialized. - Moves the parsing of `.gdextension` config files to the new `GDExtensionLibraryLoader`. - `GDExtensionManager` is now meant to be the main way to load/unload extensions and can optionally take a `GDExtensionLoader`. - `EditorFileSystem` avoids unloading extensions if the file still exists, this should prevent unloading extensions that are outside the user project.
This commit is contained in:
parent
1bd740d18d
commit
4dd6e8eca5
|
@ -32,11 +32,9 @@
|
||||||
#include "gdextension.compat.inc"
|
#include "gdextension.compat.inc"
|
||||||
|
|
||||||
#include "core/config/project_settings.h"
|
#include "core/config/project_settings.h"
|
||||||
#include "core/io/dir_access.h"
|
|
||||||
#include "core/object/class_db.h"
|
#include "core/object/class_db.h"
|
||||||
#include "core/object/method_bind.h"
|
#include "core/object/method_bind.h"
|
||||||
#include "core/os/os.h"
|
#include "gdextension_library_loader.h"
|
||||||
#include "core/version.h"
|
|
||||||
#include "gdextension_manager.h"
|
#include "gdextension_manager.h"
|
||||||
|
|
||||||
extern void gdextension_setup_interface();
|
extern void gdextension_setup_interface();
|
||||||
|
@ -48,146 +46,6 @@ String GDExtension::get_extension_list_config_file() {
|
||||||
return ProjectSettings::get_singleton()->get_project_data_path().path_join("extension_list.cfg");
|
return ProjectSettings::get_singleton()->get_project_data_path().path_join("extension_list.cfg");
|
||||||
}
|
}
|
||||||
|
|
||||||
Vector<SharedObject> GDExtension::find_extension_dependencies(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature) {
|
|
||||||
Vector<SharedObject> dependencies_shared_objects;
|
|
||||||
if (p_config->has_section("dependencies")) {
|
|
||||||
List<String> config_dependencies;
|
|
||||||
p_config->get_section_keys("dependencies", &config_dependencies);
|
|
||||||
|
|
||||||
for (const String &dependency : config_dependencies) {
|
|
||||||
Vector<String> dependency_tags = dependency.split(".");
|
|
||||||
bool all_tags_met = true;
|
|
||||||
for (int i = 0; i < dependency_tags.size(); i++) {
|
|
||||||
String tag = dependency_tags[i].strip_edges();
|
|
||||||
if (!p_has_feature(tag)) {
|
|
||||||
all_tags_met = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (all_tags_met) {
|
|
||||||
Dictionary dependency_value = p_config->get_value("dependencies", dependency);
|
|
||||||
for (const Variant *key = dependency_value.next(nullptr); key; key = dependency_value.next(key)) {
|
|
||||||
String dependency_path = *key;
|
|
||||||
String target_path = dependency_value[*key];
|
|
||||||
if (dependency_path.is_relative_path()) {
|
|
||||||
dependency_path = p_path.get_base_dir().path_join(dependency_path);
|
|
||||||
}
|
|
||||||
dependencies_shared_objects.push_back(SharedObject(dependency_path, dependency_tags, target_path));
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return dependencies_shared_objects;
|
|
||||||
}
|
|
||||||
|
|
||||||
String GDExtension::find_extension_library(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature, PackedStringArray *r_tags) {
|
|
||||||
// First, check the explicit libraries.
|
|
||||||
if (p_config->has_section("libraries")) {
|
|
||||||
List<String> libraries;
|
|
||||||
p_config->get_section_keys("libraries", &libraries);
|
|
||||||
|
|
||||||
// Iterate the libraries, finding the best matching tags.
|
|
||||||
String best_library_path;
|
|
||||||
Vector<String> best_library_tags;
|
|
||||||
for (const String &E : libraries) {
|
|
||||||
Vector<String> tags = E.split(".");
|
|
||||||
bool all_tags_met = true;
|
|
||||||
for (int i = 0; i < tags.size(); i++) {
|
|
||||||
String tag = tags[i].strip_edges();
|
|
||||||
if (!p_has_feature(tag)) {
|
|
||||||
all_tags_met = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (all_tags_met && tags.size() > best_library_tags.size()) {
|
|
||||||
best_library_path = p_config->get_value("libraries", E);
|
|
||||||
best_library_tags = tags;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!best_library_path.is_empty()) {
|
|
||||||
if (best_library_path.is_relative_path()) {
|
|
||||||
best_library_path = p_path.get_base_dir().path_join(best_library_path);
|
|
||||||
}
|
|
||||||
if (r_tags != nullptr) {
|
|
||||||
r_tags->append_array(best_library_tags);
|
|
||||||
}
|
|
||||||
return best_library_path;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Second, try to autodetect
|
|
||||||
String autodetect_library_prefix;
|
|
||||||
if (p_config->has_section_key("configuration", "autodetect_library_prefix")) {
|
|
||||||
autodetect_library_prefix = p_config->get_value("configuration", "autodetect_library_prefix");
|
|
||||||
}
|
|
||||||
if (!autodetect_library_prefix.is_empty()) {
|
|
||||||
String autodetect_path = autodetect_library_prefix;
|
|
||||||
if (autodetect_path.is_relative_path()) {
|
|
||||||
autodetect_path = p_path.get_base_dir().path_join(autodetect_path);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Find the folder and file parts of the prefix.
|
|
||||||
String folder;
|
|
||||||
String file_prefix;
|
|
||||||
if (DirAccess::dir_exists_absolute(autodetect_path)) {
|
|
||||||
folder = autodetect_path;
|
|
||||||
} else if (DirAccess::dir_exists_absolute(autodetect_path.get_base_dir())) {
|
|
||||||
folder = autodetect_path.get_base_dir();
|
|
||||||
file_prefix = autodetect_path.get_file();
|
|
||||||
} else {
|
|
||||||
ERR_FAIL_V_MSG(String(), vformat("Error in extension: %s. Could not find folder for automatic detection of libraries files. autodetect_library_prefix=\"%s\"", p_path, autodetect_library_prefix));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Open the folder.
|
|
||||||
Ref<DirAccess> dir = DirAccess::open(folder);
|
|
||||||
ERR_FAIL_COND_V_MSG(!dir.is_valid(), String(), vformat("Error in extension: %s. Could not open folder for automatic detection of libraries files. autodetect_library_prefix=\"%s\"", p_path, autodetect_library_prefix));
|
|
||||||
|
|
||||||
// Iterate the files and check the prefixes, finding the best matching file.
|
|
||||||
String best_file;
|
|
||||||
Vector<String> best_file_tags;
|
|
||||||
dir->list_dir_begin();
|
|
||||||
String file_name = dir->_get_next();
|
|
||||||
while (file_name != "") {
|
|
||||||
if (!dir->current_is_dir() && file_name.begins_with(file_prefix)) {
|
|
||||||
// Check if the files matches all requested feature tags.
|
|
||||||
String tags_str = file_name.trim_prefix(file_prefix);
|
|
||||||
tags_str = tags_str.trim_suffix(tags_str.get_extension());
|
|
||||||
|
|
||||||
Vector<String> tags = tags_str.split(".", false);
|
|
||||||
bool all_tags_met = true;
|
|
||||||
for (int i = 0; i < tags.size(); i++) {
|
|
||||||
String tag = tags[i].strip_edges();
|
|
||||||
if (!p_has_feature(tag)) {
|
|
||||||
all_tags_met = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If all tags are found in the feature list, and we found more tags than before, use this file.
|
|
||||||
if (all_tags_met && tags.size() > best_file_tags.size()) {
|
|
||||||
best_file_tags = tags;
|
|
||||||
best_file = file_name;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
file_name = dir->_get_next();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!best_file.is_empty()) {
|
|
||||||
String library_path = folder.path_join(best_file);
|
|
||||||
if (r_tags != nullptr) {
|
|
||||||
r_tags->append_array(best_file_tags);
|
|
||||||
}
|
|
||||||
return library_path;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return String();
|
|
||||||
}
|
|
||||||
|
|
||||||
class GDExtensionMethodBind : public MethodBind {
|
class GDExtensionMethodBind : public MethodBind {
|
||||||
GDExtensionClassMethodCall call_func;
|
GDExtensionClassMethodCall call_func;
|
||||||
GDExtensionClassMethodValidatedCall validated_call_func;
|
GDExtensionClassMethodValidatedCall validated_call_func;
|
||||||
|
@ -755,7 +613,13 @@ void GDExtension::_unregister_extension_class(GDExtensionClassLibraryPtr p_libra
|
||||||
void GDExtension::_get_library_path(GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringPtr r_path) {
|
void GDExtension::_get_library_path(GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringPtr r_path) {
|
||||||
GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
|
GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
|
||||||
|
|
||||||
memnew_placement(r_path, String(self->library_path));
|
Ref<GDExtensionLibraryLoader> library_loader = self->loader;
|
||||||
|
String library_path;
|
||||||
|
if (library_loader.is_valid()) {
|
||||||
|
library_path = library_loader->library_path;
|
||||||
|
}
|
||||||
|
|
||||||
|
memnew_placement(r_path, String(library_path));
|
||||||
}
|
}
|
||||||
|
|
||||||
HashMap<StringName, GDExtensionInterfaceFunctionPtr> GDExtension::gdextension_interface_functions;
|
HashMap<StringName, GDExtensionInterfaceFunctionPtr> GDExtension::gdextension_interface_functions;
|
||||||
|
@ -771,55 +635,34 @@ GDExtensionInterfaceFunctionPtr GDExtension::get_interface_function(const String
|
||||||
return *function;
|
return *function;
|
||||||
}
|
}
|
||||||
|
|
||||||
Error GDExtension::open_library(const String &p_path, const String &p_entry_symbol, Vector<SharedObject> *p_dependencies) {
|
Error GDExtension::open_library(const String &p_path, const Ref<GDExtensionLoader> &p_loader) {
|
||||||
|
ERR_FAIL_NULL_V_MSG(p_loader, FAILED, "Can't open GDExtension without a loader.");
|
||||||
|
loader = p_loader;
|
||||||
|
|
||||||
String abs_path = ProjectSettings::get_singleton()->globalize_path(p_path);
|
String abs_path = ProjectSettings::get_singleton()->globalize_path(p_path);
|
||||||
|
|
||||||
Vector<String> abs_dependencies_paths;
|
Error err = loader->open_library(abs_path);
|
||||||
if (p_dependencies != nullptr && !p_dependencies->is_empty()) {
|
|
||||||
for (const SharedObject &dependency : *p_dependencies) {
|
|
||||||
abs_dependencies_paths.push_back(ProjectSettings::get_singleton()->globalize_path(dependency.path));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
OS::GDExtensionData data = {
|
|
||||||
true, // also_set_library_path
|
|
||||||
&library_path, // r_resolved_path
|
|
||||||
Engine::get_singleton()->is_editor_hint(), // generate_temp_files
|
|
||||||
&abs_dependencies_paths, // library_dependencies
|
|
||||||
};
|
|
||||||
Error err = OS::get_singleton()->open_dynamic_library(abs_path, library, &data);
|
|
||||||
|
|
||||||
ERR_FAIL_COND_V_MSG(err == ERR_FILE_NOT_FOUND, err, "GDExtension dynamic library not found: " + abs_path);
|
ERR_FAIL_COND_V_MSG(err == ERR_FILE_NOT_FOUND, err, "GDExtension dynamic library not found: " + abs_path);
|
||||||
ERR_FAIL_COND_V_MSG(err != OK, err, "Can't open GDExtension dynamic library: " + abs_path);
|
ERR_FAIL_COND_V_MSG(err != OK, err, "Can't open GDExtension dynamic library: " + abs_path);
|
||||||
|
|
||||||
void *entry_funcptr = nullptr;
|
err = loader->initialize(&gdextension_get_proc_address, this, &initialization);
|
||||||
|
|
||||||
err = OS::get_singleton()->get_dynamic_library_symbol_handle(library, p_entry_symbol, entry_funcptr, false);
|
|
||||||
|
|
||||||
if (err != OK) {
|
if (err != OK) {
|
||||||
ERR_PRINT("GDExtension entry point '" + p_entry_symbol + "' not found in library " + abs_path);
|
// Errors already logged in initialize().
|
||||||
OS::get_singleton()->close_dynamic_library(library);
|
loader->close_library();
|
||||||
return err;
|
return err;
|
||||||
}
|
}
|
||||||
|
|
||||||
GDExtensionInitializationFunction initialization_function = (GDExtensionInitializationFunction)entry_funcptr;
|
|
||||||
GDExtensionBool ret = initialization_function(&gdextension_get_proc_address, this, &initialization);
|
|
||||||
|
|
||||||
if (ret) {
|
|
||||||
level_initialized = -1;
|
level_initialized = -1;
|
||||||
|
|
||||||
return OK;
|
return OK;
|
||||||
} else {
|
|
||||||
ERR_PRINT("GDExtension initialization function '" + p_entry_symbol + "' returned an error.");
|
|
||||||
OS::get_singleton()->close_dynamic_library(library);
|
|
||||||
return FAILED;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void GDExtension::close_library() {
|
void GDExtension::close_library() {
|
||||||
ERR_FAIL_NULL(library);
|
ERR_FAIL_COND(!is_library_open());
|
||||||
OS::get_singleton()->close_dynamic_library(library);
|
loader->close_library();
|
||||||
|
|
||||||
library = nullptr;
|
|
||||||
class_icon_paths.clear();
|
class_icon_paths.clear();
|
||||||
|
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
|
@ -828,16 +671,16 @@ void GDExtension::close_library() {
|
||||||
}
|
}
|
||||||
|
|
||||||
bool GDExtension::is_library_open() const {
|
bool GDExtension::is_library_open() const {
|
||||||
return library != nullptr;
|
return loader.is_valid() && loader->is_library_open();
|
||||||
}
|
}
|
||||||
|
|
||||||
GDExtension::InitializationLevel GDExtension::get_minimum_library_initialization_level() const {
|
GDExtension::InitializationLevel GDExtension::get_minimum_library_initialization_level() const {
|
||||||
ERR_FAIL_NULL_V(library, INITIALIZATION_LEVEL_CORE);
|
ERR_FAIL_COND_V(!is_library_open(), INITIALIZATION_LEVEL_CORE);
|
||||||
return InitializationLevel(initialization.minimum_initialization_level);
|
return InitializationLevel(initialization.minimum_initialization_level);
|
||||||
}
|
}
|
||||||
|
|
||||||
void GDExtension::initialize_library(InitializationLevel p_level) {
|
void GDExtension::initialize_library(InitializationLevel p_level) {
|
||||||
ERR_FAIL_NULL(library);
|
ERR_FAIL_COND(!is_library_open());
|
||||||
ERR_FAIL_COND_MSG(p_level <= int32_t(level_initialized), vformat("Level '%d' must be higher than the current level '%d'", p_level, level_initialized));
|
ERR_FAIL_COND_MSG(p_level <= int32_t(level_initialized), vformat("Level '%d' must be higher than the current level '%d'", p_level, level_initialized));
|
||||||
|
|
||||||
level_initialized = int32_t(p_level);
|
level_initialized = int32_t(p_level);
|
||||||
|
@ -847,7 +690,7 @@ void GDExtension::initialize_library(InitializationLevel p_level) {
|
||||||
initialization.initialize(initialization.userdata, GDExtensionInitializationLevel(p_level));
|
initialization.initialize(initialization.userdata, GDExtensionInitializationLevel(p_level));
|
||||||
}
|
}
|
||||||
void GDExtension::deinitialize_library(InitializationLevel p_level) {
|
void GDExtension::deinitialize_library(InitializationLevel p_level) {
|
||||||
ERR_FAIL_NULL(library);
|
ERR_FAIL_COND(!is_library_open());
|
||||||
ERR_FAIL_COND(p_level > int32_t(level_initialized));
|
ERR_FAIL_COND(p_level > int32_t(level_initialized));
|
||||||
|
|
||||||
level_initialized = int32_t(p_level) - 1;
|
level_initialized = int32_t(p_level) - 1;
|
||||||
|
@ -871,7 +714,7 @@ GDExtension::GDExtension() {
|
||||||
}
|
}
|
||||||
|
|
||||||
GDExtension::~GDExtension() {
|
GDExtension::~GDExtension() {
|
||||||
if (library != nullptr) {
|
if (is_library_open()) {
|
||||||
close_library();
|
close_library();
|
||||||
}
|
}
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
|
@ -909,142 +752,15 @@ void GDExtension::finalize_gdextensions() {
|
||||||
Error GDExtensionResourceLoader::load_gdextension_resource(const String &p_path, Ref<GDExtension> &p_extension) {
|
Error GDExtensionResourceLoader::load_gdextension_resource(const String &p_path, Ref<GDExtension> &p_extension) {
|
||||||
ERR_FAIL_COND_V_MSG(p_extension.is_valid() && p_extension->is_library_open(), ERR_ALREADY_IN_USE, "Cannot load GDExtension resource into already opened library.");
|
ERR_FAIL_COND_V_MSG(p_extension.is_valid() && p_extension->is_library_open(), ERR_ALREADY_IN_USE, "Cannot load GDExtension resource into already opened library.");
|
||||||
|
|
||||||
Ref<ConfigFile> config;
|
GDExtensionManager *extension_manager = GDExtensionManager::get_singleton();
|
||||||
config.instantiate();
|
|
||||||
|
|
||||||
Error err = config->load(p_path);
|
GDExtensionManager::LoadStatus status = extension_manager->load_extension(p_path);
|
||||||
|
if (status != GDExtensionManager::LOAD_STATUS_OK && status != GDExtensionManager::LOAD_STATUS_ALREADY_LOADED) {
|
||||||
if (err != OK) {
|
// Errors already logged in load_extension().
|
||||||
ERR_PRINT("Error loading GDExtension configuration file: " + p_path);
|
return FAILED;
|
||||||
return err;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!config->has_section_key("configuration", "entry_symbol")) {
|
|
||||||
ERR_PRINT("GDExtension configuration file must contain a \"configuration/entry_symbol\" key: " + p_path);
|
|
||||||
return ERR_INVALID_DATA;
|
|
||||||
}
|
|
||||||
|
|
||||||
String entry_symbol = config->get_value("configuration", "entry_symbol");
|
|
||||||
|
|
||||||
uint32_t compatibility_minimum[3] = { 0, 0, 0 };
|
|
||||||
if (config->has_section_key("configuration", "compatibility_minimum")) {
|
|
||||||
String compat_string = config->get_value("configuration", "compatibility_minimum");
|
|
||||||
Vector<int> parts = compat_string.split_ints(".");
|
|
||||||
for (int i = 0; i < parts.size(); i++) {
|
|
||||||
if (i >= 3) {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
if (parts[i] >= 0) {
|
|
||||||
compatibility_minimum[i] = parts[i];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
ERR_PRINT("GDExtension configuration file must contain a \"configuration/compatibility_minimum\" key: " + p_path);
|
|
||||||
return ERR_INVALID_DATA;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (compatibility_minimum[0] < 4 || (compatibility_minimum[0] == 4 && compatibility_minimum[1] == 0)) {
|
|
||||||
ERR_PRINT(vformat("GDExtension's compatibility_minimum (%d.%d.%d) must be at least 4.1.0: %s", compatibility_minimum[0], compatibility_minimum[1], compatibility_minimum[2], p_path));
|
|
||||||
return ERR_INVALID_DATA;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool compatible = true;
|
|
||||||
// Check version lexicographically.
|
|
||||||
if (VERSION_MAJOR != compatibility_minimum[0]) {
|
|
||||||
compatible = VERSION_MAJOR > compatibility_minimum[0];
|
|
||||||
} else if (VERSION_MINOR != compatibility_minimum[1]) {
|
|
||||||
compatible = VERSION_MINOR > compatibility_minimum[1];
|
|
||||||
} else {
|
|
||||||
compatible = VERSION_PATCH >= compatibility_minimum[2];
|
|
||||||
}
|
|
||||||
if (!compatible) {
|
|
||||||
ERR_PRINT(vformat("GDExtension only compatible with Godot version %d.%d.%d or later: %s", compatibility_minimum[0], compatibility_minimum[1], compatibility_minimum[2], p_path));
|
|
||||||
return ERR_INVALID_DATA;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Optionally check maximum compatibility.
|
|
||||||
if (config->has_section_key("configuration", "compatibility_maximum")) {
|
|
||||||
uint32_t compatibility_maximum[3] = { 0, 0, 0 };
|
|
||||||
String compat_string = config->get_value("configuration", "compatibility_maximum");
|
|
||||||
Vector<int> parts = compat_string.split_ints(".");
|
|
||||||
for (int i = 0; i < 3; i++) {
|
|
||||||
if (i < parts.size() && parts[i] >= 0) {
|
|
||||||
compatibility_maximum[i] = parts[i];
|
|
||||||
} else {
|
|
||||||
// If a version part is missing, set the maximum to an arbitrary high value.
|
|
||||||
compatibility_maximum[i] = 9999;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
compatible = true;
|
|
||||||
if (VERSION_MAJOR != compatibility_maximum[0]) {
|
|
||||||
compatible = VERSION_MAJOR < compatibility_maximum[0];
|
|
||||||
} else if (VERSION_MINOR != compatibility_maximum[1]) {
|
|
||||||
compatible = VERSION_MINOR < compatibility_maximum[1];
|
|
||||||
}
|
|
||||||
#if VERSION_PATCH
|
|
||||||
// #if check to avoid -Wtype-limits warning when 0.
|
|
||||||
else {
|
|
||||||
compatible = VERSION_PATCH <= compatibility_maximum[2];
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
if (!compatible) {
|
|
||||||
ERR_PRINT(vformat("GDExtension only compatible with Godot version %s or earlier: %s", compat_string, p_path));
|
|
||||||
return ERR_INVALID_DATA;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
String library_path = GDExtension::find_extension_library(p_path, config, [](const String &p_feature) { return OS::get_singleton()->has_feature(p_feature); });
|
|
||||||
|
|
||||||
if (library_path.is_empty()) {
|
|
||||||
const String os_arch = OS::get_singleton()->get_name().to_lower() + "." + Engine::get_singleton()->get_architecture_name();
|
|
||||||
ERR_PRINT(vformat("No GDExtension library found for current OS and architecture (%s) in configuration file: %s", os_arch, p_path));
|
|
||||||
return ERR_FILE_NOT_FOUND;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool is_static_library = library_path.ends_with(".a") || library_path.ends_with(".xcframework");
|
|
||||||
|
|
||||||
if (!library_path.is_resource_file() && !library_path.is_absolute_path()) {
|
|
||||||
library_path = p_path.get_base_dir().path_join(library_path);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (p_extension.is_null()) {
|
|
||||||
p_extension.instantiate();
|
|
||||||
}
|
|
||||||
|
|
||||||
#ifdef TOOLS_ENABLED
|
|
||||||
p_extension->set_reloadable(config->get_value("configuration", "reloadable", false) && Engine::get_singleton()->is_extension_reloading_enabled());
|
|
||||||
|
|
||||||
p_extension->update_last_modified_time(
|
|
||||||
FileAccess::get_modified_time(p_path),
|
|
||||||
FileAccess::get_modified_time(library_path));
|
|
||||||
#endif
|
|
||||||
|
|
||||||
Vector<SharedObject> library_dependencies = GDExtension::find_extension_dependencies(p_path, config, [](const String &p_feature) { return OS::get_singleton()->has_feature(p_feature); });
|
|
||||||
err = p_extension->open_library(is_static_library ? String() : library_path, entry_symbol, &library_dependencies);
|
|
||||||
if (err != OK) {
|
|
||||||
// Unreference the extension so that this loading can be considered a failure.
|
|
||||||
p_extension.unref();
|
|
||||||
|
|
||||||
// Errors already logged in open_library()
|
|
||||||
return err;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle icons if any are specified.
|
|
||||||
if (config->has_section("icons")) {
|
|
||||||
List<String> keys;
|
|
||||||
config->get_section_keys("icons", &keys);
|
|
||||||
for (const String &key : keys) {
|
|
||||||
String icon_path = config->get_value("icons", key);
|
|
||||||
if (icon_path.is_relative_path()) {
|
|
||||||
icon_path = p_path.get_base_dir().path_join(icon_path);
|
|
||||||
}
|
|
||||||
|
|
||||||
p_extension->class_icon_paths[key] = icon_path;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
p_extension = extension_manager->get_extension(p_path);
|
||||||
return OK;
|
return OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1085,16 +801,7 @@ String GDExtensionResourceLoader::get_resource_type(const String &p_path) const
|
||||||
|
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
bool GDExtension::has_library_changed() const {
|
bool GDExtension::has_library_changed() const {
|
||||||
// Check only that the last modified time is different (rather than checking
|
return loader->has_library_changed();
|
||||||
// that it's newer) since some OS's (namely Windows) will preserve the modified
|
|
||||||
// time by default when copying files.
|
|
||||||
if (FileAccess::get_modified_time(get_path()) != resource_last_modified_time) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
if (FileAccess::get_modified_time(library_path) != library_last_modified_time) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void GDExtension::prepare_reload() {
|
void GDExtension::prepare_reload() {
|
||||||
|
|
|
@ -31,13 +31,11 @@
|
||||||
#ifndef GDEXTENSION_H
|
#ifndef GDEXTENSION_H
|
||||||
#define GDEXTENSION_H
|
#define GDEXTENSION_H
|
||||||
|
|
||||||
#include <functional>
|
|
||||||
|
|
||||||
#include "core/extension/gdextension_interface.h"
|
#include "core/extension/gdextension_interface.h"
|
||||||
|
#include "core/extension/gdextension_loader.h"
|
||||||
#include "core/io/config_file.h"
|
#include "core/io/config_file.h"
|
||||||
#include "core/io/resource_loader.h"
|
#include "core/io/resource_loader.h"
|
||||||
#include "core/object/ref_counted.h"
|
#include "core/object/ref_counted.h"
|
||||||
#include "core/os/shared_object.h"
|
|
||||||
|
|
||||||
class GDExtensionMethodBind;
|
class GDExtensionMethodBind;
|
||||||
|
|
||||||
|
@ -46,8 +44,8 @@ class GDExtension : public Resource {
|
||||||
|
|
||||||
friend class GDExtensionManager;
|
friend class GDExtensionManager;
|
||||||
|
|
||||||
void *library = nullptr; // pointer if valid,
|
Ref<GDExtensionLoader> loader;
|
||||||
String library_path;
|
|
||||||
bool reloadable = false;
|
bool reloadable = false;
|
||||||
|
|
||||||
struct Extension {
|
struct Extension {
|
||||||
|
@ -96,8 +94,6 @@ class GDExtension : public Resource {
|
||||||
int32_t level_initialized = -1;
|
int32_t level_initialized = -1;
|
||||||
|
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
uint64_t resource_last_modified_time = 0;
|
|
||||||
uint64_t library_last_modified_time = 0;
|
|
||||||
bool is_reloading = false;
|
bool is_reloading = false;
|
||||||
Vector<GDExtensionMethodBind *> invalid_methods;
|
Vector<GDExtensionMethodBind *> invalid_methods;
|
||||||
Vector<ObjectID> instance_bindings;
|
Vector<ObjectID> instance_bindings;
|
||||||
|
@ -124,11 +120,12 @@ public:
|
||||||
virtual bool editor_can_reload_from_file() override { return false; } // Reloading is handled in a special way.
|
virtual bool editor_can_reload_from_file() override { return false; } // Reloading is handled in a special way.
|
||||||
|
|
||||||
static String get_extension_list_config_file();
|
static String get_extension_list_config_file();
|
||||||
static String find_extension_library(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature, PackedStringArray *r_tags = nullptr);
|
|
||||||
static Vector<SharedObject> find_extension_dependencies(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature);
|
|
||||||
|
|
||||||
Error open_library(const String &p_path, const String &p_entry_symbol, Vector<SharedObject> *p_dependencies = nullptr);
|
const Ref<GDExtensionLoader> get_loader() const { return loader; }
|
||||||
|
|
||||||
|
Error open_library(const String &p_path, const Ref<GDExtensionLoader> &p_loader);
|
||||||
void close_library();
|
void close_library();
|
||||||
|
bool is_library_open() const;
|
||||||
|
|
||||||
enum InitializationLevel {
|
enum InitializationLevel {
|
||||||
INITIALIZATION_LEVEL_CORE = GDEXTENSION_INITIALIZATION_CORE,
|
INITIALIZATION_LEVEL_CORE = GDEXTENSION_INITIALIZATION_CORE,
|
||||||
|
@ -146,17 +143,11 @@ protected:
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
public:
|
public:
|
||||||
bool is_library_open() const;
|
|
||||||
|
|
||||||
#ifdef TOOLS_ENABLED
|
#ifdef TOOLS_ENABLED
|
||||||
bool is_reloadable() const { return reloadable; }
|
bool is_reloadable() const { return reloadable; }
|
||||||
void set_reloadable(bool p_reloadable) { reloadable = p_reloadable; }
|
void set_reloadable(bool p_reloadable) { reloadable = p_reloadable; }
|
||||||
|
|
||||||
bool has_library_changed() const;
|
bool has_library_changed() const;
|
||||||
void update_last_modified_time(uint64_t p_resource_last_modified_time, uint64_t p_library_last_modified_time) {
|
|
||||||
resource_last_modified_time = p_resource_last_modified_time;
|
|
||||||
library_last_modified_time = p_library_last_modified_time;
|
|
||||||
}
|
|
||||||
|
|
||||||
void track_instance_binding(Object *p_object);
|
void track_instance_binding(Object *p_object);
|
||||||
void untrack_instance_binding(Object *p_object);
|
void untrack_instance_binding(Object *p_object);
|
||||||
|
|
|
@ -0,0 +1,390 @@
|
||||||
|
/**************************************************************************/
|
||||||
|
/* gdextension_library_loader.cpp */
|
||||||
|
/**************************************************************************/
|
||||||
|
/* This file is part of: */
|
||||||
|
/* GODOT ENGINE */
|
||||||
|
/* https://godotengine.org */
|
||||||
|
/**************************************************************************/
|
||||||
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
||||||
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
||||||
|
/* */
|
||||||
|
/* 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 "gdextension_library_loader.h"
|
||||||
|
|
||||||
|
#include "core/config/project_settings.h"
|
||||||
|
#include "core/io/dir_access.h"
|
||||||
|
#include "core/version.h"
|
||||||
|
#include "gdextension.h"
|
||||||
|
|
||||||
|
Vector<SharedObject> GDExtensionLibraryLoader::find_extension_dependencies(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature) {
|
||||||
|
Vector<SharedObject> dependencies_shared_objects;
|
||||||
|
if (p_config->has_section("dependencies")) {
|
||||||
|
List<String> config_dependencies;
|
||||||
|
p_config->get_section_keys("dependencies", &config_dependencies);
|
||||||
|
|
||||||
|
for (const String &dependency : config_dependencies) {
|
||||||
|
Vector<String> dependency_tags = dependency.split(".");
|
||||||
|
bool all_tags_met = true;
|
||||||
|
for (int i = 0; i < dependency_tags.size(); i++) {
|
||||||
|
String tag = dependency_tags[i].strip_edges();
|
||||||
|
if (!p_has_feature(tag)) {
|
||||||
|
all_tags_met = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (all_tags_met) {
|
||||||
|
Dictionary dependency_value = p_config->get_value("dependencies", dependency);
|
||||||
|
for (const Variant *key = dependency_value.next(nullptr); key; key = dependency_value.next(key)) {
|
||||||
|
String dependency_path = *key;
|
||||||
|
String target_path = dependency_value[*key];
|
||||||
|
if (dependency_path.is_relative_path()) {
|
||||||
|
dependency_path = p_path.get_base_dir().path_join(dependency_path);
|
||||||
|
}
|
||||||
|
dependencies_shared_objects.push_back(SharedObject(dependency_path, dependency_tags, target_path));
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return dependencies_shared_objects;
|
||||||
|
}
|
||||||
|
|
||||||
|
String GDExtensionLibraryLoader::find_extension_library(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature, PackedStringArray *r_tags) {
|
||||||
|
// First, check the explicit libraries.
|
||||||
|
if (p_config->has_section("libraries")) {
|
||||||
|
List<String> libraries;
|
||||||
|
p_config->get_section_keys("libraries", &libraries);
|
||||||
|
|
||||||
|
// Iterate the libraries, finding the best matching tags.
|
||||||
|
String best_library_path;
|
||||||
|
Vector<String> best_library_tags;
|
||||||
|
for (const String &E : libraries) {
|
||||||
|
Vector<String> tags = E.split(".");
|
||||||
|
bool all_tags_met = true;
|
||||||
|
for (int i = 0; i < tags.size(); i++) {
|
||||||
|
String tag = tags[i].strip_edges();
|
||||||
|
if (!p_has_feature(tag)) {
|
||||||
|
all_tags_met = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (all_tags_met && tags.size() > best_library_tags.size()) {
|
||||||
|
best_library_path = p_config->get_value("libraries", E);
|
||||||
|
best_library_tags = tags;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!best_library_path.is_empty()) {
|
||||||
|
if (best_library_path.is_relative_path()) {
|
||||||
|
best_library_path = p_path.get_base_dir().path_join(best_library_path);
|
||||||
|
}
|
||||||
|
if (r_tags != nullptr) {
|
||||||
|
r_tags->append_array(best_library_tags);
|
||||||
|
}
|
||||||
|
return best_library_path;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Second, try to autodetect.
|
||||||
|
String autodetect_library_prefix;
|
||||||
|
if (p_config->has_section_key("configuration", "autodetect_library_prefix")) {
|
||||||
|
autodetect_library_prefix = p_config->get_value("configuration", "autodetect_library_prefix");
|
||||||
|
}
|
||||||
|
if (!autodetect_library_prefix.is_empty()) {
|
||||||
|
String autodetect_path = autodetect_library_prefix;
|
||||||
|
if (autodetect_path.is_relative_path()) {
|
||||||
|
autodetect_path = p_path.get_base_dir().path_join(autodetect_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find the folder and file parts of the prefix.
|
||||||
|
String folder;
|
||||||
|
String file_prefix;
|
||||||
|
if (DirAccess::dir_exists_absolute(autodetect_path)) {
|
||||||
|
folder = autodetect_path;
|
||||||
|
} else if (DirAccess::dir_exists_absolute(autodetect_path.get_base_dir())) {
|
||||||
|
folder = autodetect_path.get_base_dir();
|
||||||
|
file_prefix = autodetect_path.get_file();
|
||||||
|
} else {
|
||||||
|
ERR_FAIL_V_MSG(String(), vformat("Error in extension: %s. Could not find folder for automatic detection of libraries files. autodetect_library_prefix=\"%s\"", p_path, autodetect_library_prefix));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open the folder.
|
||||||
|
Ref<DirAccess> dir = DirAccess::open(folder);
|
||||||
|
ERR_FAIL_COND_V_MSG(dir.is_null(), String(), vformat("Error in extension: %s. Could not open folder for automatic detection of libraries files. autodetect_library_prefix=\"%s\"", p_path, autodetect_library_prefix));
|
||||||
|
|
||||||
|
// Iterate the files and check the prefixes, finding the best matching file.
|
||||||
|
String best_file;
|
||||||
|
Vector<String> best_file_tags;
|
||||||
|
dir->list_dir_begin();
|
||||||
|
String file_name = dir->_get_next();
|
||||||
|
while (file_name != "") {
|
||||||
|
if (!dir->current_is_dir() && file_name.begins_with(file_prefix)) {
|
||||||
|
// Check if the files matches all requested feature tags.
|
||||||
|
String tags_str = file_name.trim_prefix(file_prefix);
|
||||||
|
tags_str = tags_str.trim_suffix(tags_str.get_extension());
|
||||||
|
|
||||||
|
Vector<String> tags = tags_str.split(".", false);
|
||||||
|
bool all_tags_met = true;
|
||||||
|
for (int i = 0; i < tags.size(); i++) {
|
||||||
|
String tag = tags[i].strip_edges();
|
||||||
|
if (!p_has_feature(tag)) {
|
||||||
|
all_tags_met = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If all tags are found in the feature list, and we found more tags than before, use this file.
|
||||||
|
if (all_tags_met && tags.size() > best_file_tags.size()) {
|
||||||
|
best_file_tags = tags;
|
||||||
|
best_file = file_name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
file_name = dir->_get_next();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!best_file.is_empty()) {
|
||||||
|
String library_path = folder.path_join(best_file);
|
||||||
|
if (r_tags != nullptr) {
|
||||||
|
r_tags->append_array(best_file_tags);
|
||||||
|
}
|
||||||
|
return library_path;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return String();
|
||||||
|
}
|
||||||
|
|
||||||
|
Error GDExtensionLibraryLoader::open_library(const String &p_path) {
|
||||||
|
Error err = parse_gdextension_file(p_path);
|
||||||
|
if (err != OK) {
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
String abs_path = ProjectSettings::get_singleton()->globalize_path(library_path);
|
||||||
|
|
||||||
|
Vector<String> abs_dependencies_paths;
|
||||||
|
if (!library_dependencies.is_empty()) {
|
||||||
|
for (const SharedObject &dependency : library_dependencies) {
|
||||||
|
abs_dependencies_paths.push_back(ProjectSettings::get_singleton()->globalize_path(dependency.path));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
OS::GDExtensionData data = {
|
||||||
|
true, // also_set_library_path
|
||||||
|
&library_path, // r_resolved_path
|
||||||
|
Engine::get_singleton()->is_editor_hint(), // generate_temp_files
|
||||||
|
&abs_dependencies_paths, // library_dependencies
|
||||||
|
};
|
||||||
|
|
||||||
|
err = OS::get_singleton()->open_dynamic_library(is_static_library ? String() : abs_path, library, &data);
|
||||||
|
if (err != OK) {
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
return OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
Error GDExtensionLibraryLoader::initialize(GDExtensionInterfaceGetProcAddress p_get_proc_address, const Ref<GDExtension> &p_extension, GDExtensionInitialization *r_initialization) {
|
||||||
|
#ifdef TOOLS_ENABLED
|
||||||
|
p_extension->set_reloadable(is_reloadable && Engine::get_singleton()->is_extension_reloading_enabled());
|
||||||
|
#endif
|
||||||
|
|
||||||
|
for (const KeyValue<String, String> &icon : class_icon_paths) {
|
||||||
|
p_extension->class_icon_paths[icon.key] = icon.value;
|
||||||
|
}
|
||||||
|
|
||||||
|
void *entry_funcptr = nullptr;
|
||||||
|
|
||||||
|
Error err = OS::get_singleton()->get_dynamic_library_symbol_handle(library, entry_symbol, entry_funcptr, false);
|
||||||
|
|
||||||
|
if (err != OK) {
|
||||||
|
ERR_PRINT("GDExtension entry point '" + entry_symbol + "' not found in library " + library_path);
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
GDExtensionInitializationFunction initialization_function = (GDExtensionInitializationFunction)entry_funcptr;
|
||||||
|
|
||||||
|
GDExtensionBool ret = initialization_function(p_get_proc_address, p_extension.ptr(), r_initialization);
|
||||||
|
|
||||||
|
if (ret) {
|
||||||
|
return OK;
|
||||||
|
} else {
|
||||||
|
ERR_PRINT("GDExtension initialization function '" + entry_symbol + "' returned an error.");
|
||||||
|
return FAILED;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void GDExtensionLibraryLoader::close_library() {
|
||||||
|
OS::get_singleton()->close_dynamic_library(library);
|
||||||
|
library = nullptr;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool GDExtensionLibraryLoader::is_library_open() const {
|
||||||
|
return library != nullptr;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool GDExtensionLibraryLoader::has_library_changed() const {
|
||||||
|
#ifdef TOOLS_ENABLED
|
||||||
|
// Check only that the last modified time is different (rather than checking
|
||||||
|
// that it's newer) since some OS's (namely Windows) will preserve the modified
|
||||||
|
// time by default when copying files.
|
||||||
|
if (FileAccess::get_modified_time(resource_path) != resource_last_modified_time) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (FileAccess::get_modified_time(library_path) != library_last_modified_time) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
Error GDExtensionLibraryLoader::parse_gdextension_file(const String &p_path) {
|
||||||
|
resource_path = p_path;
|
||||||
|
|
||||||
|
Ref<ConfigFile> config;
|
||||||
|
config.instantiate();
|
||||||
|
|
||||||
|
Error err = config->load(p_path);
|
||||||
|
|
||||||
|
if (err != OK) {
|
||||||
|
ERR_PRINT("Error loading GDExtension configuration file: " + p_path);
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!config->has_section_key("configuration", "entry_symbol")) {
|
||||||
|
ERR_PRINT("GDExtension configuration file must contain a \"configuration/entry_symbol\" key: " + p_path);
|
||||||
|
return ERR_INVALID_DATA;
|
||||||
|
}
|
||||||
|
|
||||||
|
entry_symbol = config->get_value("configuration", "entry_symbol");
|
||||||
|
|
||||||
|
uint32_t compatibility_minimum[3] = { 0, 0, 0 };
|
||||||
|
if (config->has_section_key("configuration", "compatibility_minimum")) {
|
||||||
|
String compat_string = config->get_value("configuration", "compatibility_minimum");
|
||||||
|
Vector<int> parts = compat_string.split_ints(".");
|
||||||
|
for (int i = 0; i < parts.size(); i++) {
|
||||||
|
if (i >= 3) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
if (parts[i] >= 0) {
|
||||||
|
compatibility_minimum[i] = parts[i];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
ERR_PRINT("GDExtension configuration file must contain a \"configuration/compatibility_minimum\" key: " + p_path);
|
||||||
|
return ERR_INVALID_DATA;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (compatibility_minimum[0] < 4 || (compatibility_minimum[0] == 4 && compatibility_minimum[1] == 0)) {
|
||||||
|
ERR_PRINT(vformat("GDExtension's compatibility_minimum (%d.%d.%d) must be at least 4.1.0: %s", compatibility_minimum[0], compatibility_minimum[1], compatibility_minimum[2], p_path));
|
||||||
|
return ERR_INVALID_DATA;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool compatible = true;
|
||||||
|
// Check version lexicographically.
|
||||||
|
if (VERSION_MAJOR != compatibility_minimum[0]) {
|
||||||
|
compatible = VERSION_MAJOR > compatibility_minimum[0];
|
||||||
|
} else if (VERSION_MINOR != compatibility_minimum[1]) {
|
||||||
|
compatible = VERSION_MINOR > compatibility_minimum[1];
|
||||||
|
} else {
|
||||||
|
compatible = VERSION_PATCH >= compatibility_minimum[2];
|
||||||
|
}
|
||||||
|
if (!compatible) {
|
||||||
|
ERR_PRINT(vformat("GDExtension only compatible with Godot version %d.%d.%d or later: %s", compatibility_minimum[0], compatibility_minimum[1], compatibility_minimum[2], p_path));
|
||||||
|
return ERR_INVALID_DATA;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Optionally check maximum compatibility.
|
||||||
|
if (config->has_section_key("configuration", "compatibility_maximum")) {
|
||||||
|
uint32_t compatibility_maximum[3] = { 0, 0, 0 };
|
||||||
|
String compat_string = config->get_value("configuration", "compatibility_maximum");
|
||||||
|
Vector<int> parts = compat_string.split_ints(".");
|
||||||
|
for (int i = 0; i < 3; i++) {
|
||||||
|
if (i < parts.size() && parts[i] >= 0) {
|
||||||
|
compatibility_maximum[i] = parts[i];
|
||||||
|
} else {
|
||||||
|
// If a version part is missing, set the maximum to an arbitrary high value.
|
||||||
|
compatibility_maximum[i] = 9999;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compatible = true;
|
||||||
|
if (VERSION_MAJOR != compatibility_maximum[0]) {
|
||||||
|
compatible = VERSION_MAJOR < compatibility_maximum[0];
|
||||||
|
} else if (VERSION_MINOR != compatibility_maximum[1]) {
|
||||||
|
compatible = VERSION_MINOR < compatibility_maximum[1];
|
||||||
|
}
|
||||||
|
#if VERSION_PATCH
|
||||||
|
// #if check to avoid -Wtype-limits warning when 0.
|
||||||
|
else {
|
||||||
|
compatible = VERSION_PATCH <= compatibility_maximum[2];
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
if (!compatible) {
|
||||||
|
ERR_PRINT(vformat("GDExtension only compatible with Godot version %s or earlier: %s", compat_string, p_path));
|
||||||
|
return ERR_INVALID_DATA;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
library_path = find_extension_library(p_path, config, [](const String &p_feature) { return OS::get_singleton()->has_feature(p_feature); });
|
||||||
|
|
||||||
|
if (library_path.is_empty()) {
|
||||||
|
const String os_arch = OS::get_singleton()->get_name().to_lower() + "." + Engine::get_singleton()->get_architecture_name();
|
||||||
|
ERR_PRINT(vformat("No GDExtension library found for current OS and architecture (%s) in configuration file: %s", os_arch, p_path));
|
||||||
|
return ERR_FILE_NOT_FOUND;
|
||||||
|
}
|
||||||
|
|
||||||
|
is_static_library = library_path.ends_with(".a") || library_path.ends_with(".xcframework");
|
||||||
|
|
||||||
|
if (!library_path.is_resource_file() && !library_path.is_absolute_path()) {
|
||||||
|
library_path = p_path.get_base_dir().path_join(library_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef TOOLS_ENABLED
|
||||||
|
is_reloadable = config->get_value("configuration", "reloadable", false);
|
||||||
|
|
||||||
|
update_last_modified_time(
|
||||||
|
FileAccess::get_modified_time(resource_path),
|
||||||
|
FileAccess::get_modified_time(library_path));
|
||||||
|
#endif
|
||||||
|
|
||||||
|
library_dependencies = find_extension_dependencies(p_path, config, [](const String &p_feature) { return OS::get_singleton()->has_feature(p_feature); });
|
||||||
|
|
||||||
|
// Handle icons if any are specified.
|
||||||
|
if (config->has_section("icons")) {
|
||||||
|
List<String> keys;
|
||||||
|
config->get_section_keys("icons", &keys);
|
||||||
|
for (const String &key : keys) {
|
||||||
|
String icon_path = config->get_value("icons", key);
|
||||||
|
if (icon_path.is_relative_path()) {
|
||||||
|
icon_path = p_path.get_base_dir().path_join(icon_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
class_icon_paths[key] = icon_path;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return OK;
|
||||||
|
}
|
|
@ -0,0 +1,84 @@
|
||||||
|
/**************************************************************************/
|
||||||
|
/* gdextension_library_loader.h */
|
||||||
|
/**************************************************************************/
|
||||||
|
/* This file is part of: */
|
||||||
|
/* GODOT ENGINE */
|
||||||
|
/* https://godotengine.org */
|
||||||
|
/**************************************************************************/
|
||||||
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
||||||
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
||||||
|
/* */
|
||||||
|
/* 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 GDEXTENSION_LIBRARY_LOADER_H
|
||||||
|
#define GDEXTENSION_LIBRARY_LOADER_H
|
||||||
|
|
||||||
|
#include <functional>
|
||||||
|
|
||||||
|
#include "core/extension/gdextension_loader.h"
|
||||||
|
#include "core/io/config_file.h"
|
||||||
|
#include "core/os/shared_object.h"
|
||||||
|
|
||||||
|
class GDExtensionLibraryLoader : public GDExtensionLoader {
|
||||||
|
friend class GDExtensionManager;
|
||||||
|
friend class GDExtension;
|
||||||
|
|
||||||
|
private:
|
||||||
|
String resource_path;
|
||||||
|
|
||||||
|
void *library = nullptr; // pointer if valid.
|
||||||
|
String library_path;
|
||||||
|
String entry_symbol;
|
||||||
|
|
||||||
|
bool is_static_library = false;
|
||||||
|
|
||||||
|
#ifdef TOOLS_ENABLED
|
||||||
|
bool is_reloadable = false;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
Vector<SharedObject> library_dependencies;
|
||||||
|
|
||||||
|
HashMap<String, String> class_icon_paths;
|
||||||
|
|
||||||
|
#ifdef TOOLS_ENABLED
|
||||||
|
uint64_t resource_last_modified_time = 0;
|
||||||
|
uint64_t library_last_modified_time = 0;
|
||||||
|
|
||||||
|
void update_last_modified_time(uint64_t p_resource_last_modified_time, uint64_t p_library_last_modified_time) {
|
||||||
|
resource_last_modified_time = p_resource_last_modified_time;
|
||||||
|
library_last_modified_time = p_library_last_modified_time;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
public:
|
||||||
|
static String find_extension_library(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature, PackedStringArray *r_tags = nullptr);
|
||||||
|
static Vector<SharedObject> find_extension_dependencies(const String &p_path, Ref<ConfigFile> p_config, std::function<bool(String)> p_has_feature);
|
||||||
|
|
||||||
|
virtual Error open_library(const String &p_path) override;
|
||||||
|
virtual Error initialize(GDExtensionInterfaceGetProcAddress p_get_proc_address, const Ref<GDExtension> &p_extension, GDExtensionInitialization *r_initialization) override;
|
||||||
|
virtual void close_library() override;
|
||||||
|
virtual bool is_library_open() const override;
|
||||||
|
virtual bool has_library_changed() const override;
|
||||||
|
|
||||||
|
Error parse_gdextension_file(const String &p_path);
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // GDEXTENSION_LIBRARY_LOADER_H
|
|
@ -0,0 +1,47 @@
|
||||||
|
/**************************************************************************/
|
||||||
|
/* gdextension_loader.h */
|
||||||
|
/**************************************************************************/
|
||||||
|
/* This file is part of: */
|
||||||
|
/* GODOT ENGINE */
|
||||||
|
/* https://godotengine.org */
|
||||||
|
/**************************************************************************/
|
||||||
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
||||||
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
||||||
|
/* */
|
||||||
|
/* 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 GDEXTENSION_LOADER_H
|
||||||
|
#define GDEXTENSION_LOADER_H
|
||||||
|
|
||||||
|
#include "core/object/ref_counted.h"
|
||||||
|
|
||||||
|
class GDExtension;
|
||||||
|
|
||||||
|
class GDExtensionLoader : public RefCounted {
|
||||||
|
public:
|
||||||
|
virtual Error open_library(const String &p_path) = 0;
|
||||||
|
virtual Error initialize(GDExtensionInterfaceGetProcAddress p_get_proc_address, const Ref<GDExtension> &p_extension, GDExtensionInitialization *r_initialization) = 0;
|
||||||
|
virtual void close_library() = 0;
|
||||||
|
virtual bool is_library_open() const = 0;
|
||||||
|
virtual bool has_library_changed() const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // GDEXTENSION_LOADER_H
|
|
@ -31,6 +31,7 @@
|
||||||
#include "gdextension_manager.h"
|
#include "gdextension_manager.h"
|
||||||
|
|
||||||
#include "core/extension/gdextension_compat_hashes.h"
|
#include "core/extension/gdextension_compat_hashes.h"
|
||||||
|
#include "core/extension/gdextension_library_loader.h"
|
||||||
#include "core/io/file_access.h"
|
#include "core/io/file_access.h"
|
||||||
#include "core/object/script_language.h"
|
#include "core/object/script_language.h"
|
||||||
|
|
||||||
|
@ -69,11 +70,22 @@ GDExtensionManager::LoadStatus GDExtensionManager::_unload_extension_internal(co
|
||||||
}
|
}
|
||||||
|
|
||||||
GDExtensionManager::LoadStatus GDExtensionManager::load_extension(const String &p_path) {
|
GDExtensionManager::LoadStatus GDExtensionManager::load_extension(const String &p_path) {
|
||||||
|
Ref<GDExtensionLibraryLoader> loader;
|
||||||
|
loader.instantiate();
|
||||||
|
return GDExtensionManager::get_singleton()->load_extension_with_loader(p_path, loader);
|
||||||
|
}
|
||||||
|
|
||||||
|
GDExtensionManager::LoadStatus GDExtensionManager::load_extension_with_loader(const String &p_path, const Ref<GDExtensionLoader> &p_loader) {
|
||||||
|
DEV_ASSERT(p_loader.is_valid());
|
||||||
|
|
||||||
if (gdextension_map.has(p_path)) {
|
if (gdextension_map.has(p_path)) {
|
||||||
return LOAD_STATUS_ALREADY_LOADED;
|
return LOAD_STATUS_ALREADY_LOADED;
|
||||||
}
|
}
|
||||||
Ref<GDExtension> extension = ResourceLoader::load(p_path);
|
|
||||||
if (extension.is_null()) {
|
Ref<GDExtension> extension;
|
||||||
|
extension.instantiate();
|
||||||
|
Error err = extension->open_library(p_path, p_loader);
|
||||||
|
if (err != OK) {
|
||||||
return LOAD_STATUS_FAILED;
|
return LOAD_STATUS_FAILED;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -82,6 +94,7 @@ GDExtensionManager::LoadStatus GDExtensionManager::load_extension(const String &
|
||||||
return status;
|
return status;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
extension->set_path(p_path);
|
||||||
gdextension_map[p_path] = extension;
|
gdextension_map[p_path] = extension;
|
||||||
return LOAD_STATUS_OK;
|
return LOAD_STATUS_OK;
|
||||||
}
|
}
|
||||||
|
@ -117,7 +130,7 @@ GDExtensionManager::LoadStatus GDExtensionManager::reload_extension(const String
|
||||||
extension->close_library();
|
extension->close_library();
|
||||||
}
|
}
|
||||||
|
|
||||||
Error err = GDExtensionResourceLoader::load_gdextension_resource(p_path, extension);
|
Error err = extension->open_library(p_path, extension->loader);
|
||||||
if (err != OK) {
|
if (err != OK) {
|
||||||
return LOAD_STATUS_FAILED;
|
return LOAD_STATUS_FAILED;
|
||||||
}
|
}
|
||||||
|
|
|
@ -63,6 +63,7 @@ private:
|
||||||
|
|
||||||
public:
|
public:
|
||||||
LoadStatus load_extension(const String &p_path);
|
LoadStatus load_extension(const String &p_path);
|
||||||
|
LoadStatus load_extension_with_loader(const String &p_path, const Ref<GDExtensionLoader> &p_loader);
|
||||||
LoadStatus reload_extension(const String &p_path);
|
LoadStatus reload_extension(const String &p_path);
|
||||||
LoadStatus unload_extension(const String &p_path);
|
LoadStatus unload_extension(const String &p_path);
|
||||||
bool is_extension_loaded(const String &p_path) const;
|
bool is_extension_loaded(const String &p_path) const;
|
||||||
|
|
|
@ -2953,9 +2953,12 @@ bool EditorFileSystem::_scan_extensions() {
|
||||||
Vector<String> loaded_extensions = GDExtensionManager::get_singleton()->get_loaded_extensions();
|
Vector<String> loaded_extensions = GDExtensionManager::get_singleton()->get_loaded_extensions();
|
||||||
for (int i = 0; i < loaded_extensions.size(); i++) {
|
for (int i = 0; i < loaded_extensions.size(); i++) {
|
||||||
if (!extensions.has(loaded_extensions[i])) {
|
if (!extensions.has(loaded_extensions[i])) {
|
||||||
|
// The extension may not have a .gdextension file.
|
||||||
|
if (!FileAccess::exists(loaded_extensions[i])) {
|
||||||
extensions_removed.push_back(loaded_extensions[i]);
|
extensions_removed.push_back(loaded_extensions[i]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
String extension_list_config_file = GDExtension::get_extension_list_config_file();
|
String extension_list_config_file = GDExtension::get_extension_list_config_file();
|
||||||
if (extensions.size()) {
|
if (extensions.size()) {
|
||||||
|
|
|
@ -31,6 +31,7 @@
|
||||||
#ifndef GDEXTENSION_EXPORT_PLUGIN_H
|
#ifndef GDEXTENSION_EXPORT_PLUGIN_H
|
||||||
#define GDEXTENSION_EXPORT_PLUGIN_H
|
#define GDEXTENSION_EXPORT_PLUGIN_H
|
||||||
|
|
||||||
|
#include "core/extension/gdextension_library_loader.h"
|
||||||
#include "editor/export/editor_export.h"
|
#include "editor/export/editor_export.h"
|
||||||
|
|
||||||
class GDExtensionExportPlugin : public EditorExportPlugin {
|
class GDExtensionExportPlugin : public EditorExportPlugin {
|
||||||
|
@ -92,7 +93,7 @@ void GDExtensionExportPlugin::_export_file(const String &p_path, const String &p
|
||||||
|
|
||||||
for (const String &arch_tag : archs) {
|
for (const String &arch_tag : archs) {
|
||||||
PackedStringArray tags;
|
PackedStringArray tags;
|
||||||
String library_path = GDExtension::find_extension_library(
|
String library_path = GDExtensionLibraryLoader::find_extension_library(
|
||||||
p_path, config, [features_wo_arch, arch_tag](const String &p_feature) { return features_wo_arch.has(p_feature) || (p_feature == arch_tag); }, &tags);
|
p_path, config, [features_wo_arch, arch_tag](const String &p_feature) { return features_wo_arch.has(p_feature) || (p_feature == arch_tag); }, &tags);
|
||||||
if (libs_added.has(library_path)) {
|
if (libs_added.has(library_path)) {
|
||||||
continue; // Universal library, already added for another arch, do not duplicate.
|
continue; // Universal library, already added for another arch, do not duplicate.
|
||||||
|
@ -129,7 +130,7 @@ void GDExtensionExportPlugin::_export_file(const String &p_path, const String &p
|
||||||
ERR_FAIL_MSG(vformat("No suitable library found for GDExtension: %s. Possible feature flags for your platform: %s", p_path, String(", ").join(features_vector)));
|
ERR_FAIL_MSG(vformat("No suitable library found for GDExtension: %s. Possible feature flags for your platform: %s", p_path, String(", ").join(features_vector)));
|
||||||
}
|
}
|
||||||
|
|
||||||
Vector<SharedObject> dependencies_shared_objects = GDExtension::find_extension_dependencies(p_path, config, [p_features](String p_feature) { return p_features.has(p_feature); });
|
Vector<SharedObject> dependencies_shared_objects = GDExtensionLibraryLoader::find_extension_dependencies(p_path, config, [p_features](String p_feature) { return p_features.has(p_feature); });
|
||||||
for (const SharedObject &shared_object : dependencies_shared_objects) {
|
for (const SharedObject &shared_object : dependencies_shared_objects) {
|
||||||
_add_shared_object(shared_object);
|
_add_shared_object(shared_object);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue