From 3be7ec4162493d2fd16b64c443bf502e4a15d9c5 Mon Sep 17 00:00:00 2001 From: David Snopek Date: Mon, 14 Aug 2023 15:59:46 -0500 Subject: [PATCH] Check that GDExtension is opened by compatible Godot version (cherry picked from commit fecb2959b4e99393c86537cfe5a26c7b753bc11d) --- src/godot.cpp | 53 +++++++++++++++++++++++++++++--------- test/project/project.godot | 2 +- 2 files changed, 42 insertions(+), 13 deletions(-) diff --git a/src/godot.cpp b/src/godot.cpp index e6ad172b..419836a2 100644 --- a/src/godot.cpp +++ b/src/godot.cpp @@ -34,6 +34,7 @@ #include #include #include +#include #include #include @@ -192,9 +193,15 @@ GDExtensionBinding::Callback GDExtensionBinding::init_callback = nullptr; GDExtensionBinding::Callback GDExtensionBinding::terminate_callback = nullptr; GDExtensionInitializationLevel GDExtensionBinding::minimum_initialization_level = GDEXTENSION_INITIALIZATION_CORE; -#define LOAD_PROC_ADDRESS(m_name, m_type) \ - internal::gdextension_interface_##m_name = (m_type)p_get_proc_address(#m_name); \ - ERR_FAIL_NULL_V_MSG(internal::gdextension_interface_##m_name, false, "Unable to load GDExtension interface function " #m_name "()") +#define ERR_PRINT_EARLY(m_msg) \ + internal::gdextension_interface_print_error(m_msg, FUNCTION_STR, __FILE__, __LINE__, false) + +#define LOAD_PROC_ADDRESS(m_name, m_type) \ + internal::gdextension_interface_##m_name = (m_type)p_get_proc_address(#m_name); \ + if (!internal::gdextension_interface_##m_name) { \ + ERR_PRINT_EARLY("Unable to load GDExtension interface function " #m_name "()"); \ + return false; \ + } // Partial definition of the legacy interface so we can detect it and show an error. typedef struct { @@ -217,14 +224,15 @@ GDExtensionBool GDExtensionBinding::init(GDExtensionInterfaceGetProcAddress p_ge if (raw_interface[0] == 4 && raw_interface[1] == 0) { // Use the legacy interface only to give a nice error. LegacyGDExtensionInterface *legacy_interface = (LegacyGDExtensionInterface *)p_get_proc_address; - internal::gdextension_interface_print_error_with_message = (GDExtensionInterfacePrintErrorWithMessage)legacy_interface->print_error_with_message; - ERR_FAIL_V_MSG(false, "Cannot load a GDExtension built for Godot 4.1+ in Godot 4.0."); + internal::gdextension_interface_print_error = (GDExtensionInterfacePrintError)legacy_interface->print_error; + ERR_PRINT_EARLY("Cannot load a GDExtension built for Godot 4.1+ in Godot 4.0."); + return false; } - // Load the "print_error_with_message" function first (needed by the ERR_FAIL_NULL_V_MSG() macro). - internal::gdextension_interface_print_error_with_message = (GDExtensionInterfacePrintErrorWithMessage)p_get_proc_address("print_error_with_message"); - if (!internal::gdextension_interface_print_error_with_message) { - printf("ERROR: Unable to load GDExtension interface function print_error_with_message().\n"); + // Load the "print_error" function first (needed by the ERR_PRINT_EARLY() macro). + internal::gdextension_interface_print_error = (GDExtensionInterfacePrintError)p_get_proc_address("print_error"); + if (!internal::gdextension_interface_print_error) { + printf("ERROR: Unable to load GDExtension interface function print_error().\n"); return false; } @@ -233,6 +241,29 @@ GDExtensionBool GDExtensionBinding::init(GDExtensionInterfaceGetProcAddress p_ge internal::token = p_library; LOAD_PROC_ADDRESS(get_godot_version, GDExtensionInterfaceGetGodotVersion); + internal::gdextension_interface_get_godot_version(&internal::godot_version); + + // Check that godot-cpp was compiled using an extension_api.json older or at the + // same version as the Godot that is loading it. + bool compatible; + if (internal::godot_version.major != GODOT_VERSION_MAJOR) { + compatible = internal::godot_version.major > GODOT_VERSION_MAJOR; + } else if (internal::godot_version.minor != GODOT_VERSION_MINOR) { + compatible = internal::godot_version.minor > GODOT_VERSION_MINOR; + } else { + compatible = internal::godot_version.patch >= GODOT_VERSION_PATCH; + } + if (!compatible) { + // We need to use snprintf() here because vformat() uses Variant, and we haven't loaded + // the GDExtension interface far enough to use Variants yet. + char msg[128]; + snprintf(msg, 128, "Cannot load a GDExtension built for Godot %d.%d.%d using an older version of Godot (%d.%d.%d).", + GODOT_VERSION_MAJOR, GODOT_VERSION_MINOR, GODOT_VERSION_PATCH, + internal::godot_version.major, internal::godot_version.minor, internal::godot_version.patch); + ERR_PRINT_EARLY(msg); + return false; + } + LOAD_PROC_ADDRESS(mem_alloc, GDExtensionInterfaceMemAlloc); LOAD_PROC_ADDRESS(mem_realloc, GDExtensionInterfaceMemRealloc); LOAD_PROC_ADDRESS(mem_free, GDExtensionInterfaceMemFree); @@ -368,9 +399,6 @@ GDExtensionBool GDExtensionBinding::init(GDExtensionInterfaceGetProcAddress p_ge LOAD_PROC_ADDRESS(editor_add_plugin, GDExtensionInterfaceEditorAddPlugin); LOAD_PROC_ADDRESS(editor_remove_plugin, GDExtensionInterfaceEditorRemovePlugin); - // Load the Godot version. - internal::gdextension_interface_get_godot_version(&internal::godot_version); - r_initialization->initialize = initialize_level; r_initialization->deinitialize = deinitialize_level; r_initialization->minimum_initialization_level = minimum_initialization_level; @@ -384,6 +412,7 @@ GDExtensionBool GDExtensionBinding::init(GDExtensionInterfaceGetProcAddress p_ge } #undef LOAD_PROC_ADDRESS +#undef ERR_PRINT_EARLY void GDExtensionBinding::initialize_level(void *userdata, GDExtensionInitializationLevel p_level) { ClassDB::current_level = p_level; diff --git a/test/project/project.godot b/test/project/project.godot index 3ed679b4..eafcad30 100644 --- a/test/project/project.godot +++ b/test/project/project.godot @@ -12,7 +12,7 @@ config_version=5 config/name="GDExtension Test Project" run/main_scene="res://main.tscn" -config/features=PackedStringArray("4.2") +config/features=PackedStringArray("4.1") config/icon="res://icon.png" [native_extensions]