From 12d96eeaef123f50b1d96d480f1c62255235e24c Mon Sep 17 00:00:00 2001 From: Fredia Huya-Kouadio Date: Wed, 6 Sep 2023 02:59:44 -0700 Subject: [PATCH] Relax restriction on loading v1 Android plugins on Godot 4.2+ --- .../godotengine/godot/plugin/GodotPlugin.java | 34 ++++++++++++++++--- .../godot/plugin/GodotPluginRegistry.java | 31 +++++++++-------- 2 files changed, 46 insertions(+), 19 deletions(-) diff --git a/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPlugin.java b/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPlugin.java index b4f0f44df487..7f3a3ac7a3a8 100644 --- a/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPlugin.java +++ b/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPlugin.java @@ -61,12 +61,15 @@ *

* A Godot Android plugin is an Android library with the following requirements: *

- * - The library must have a 'compileOnly' dependency on the Godot Android library: `compileOnly "org.godotengine:godot:"` + * - The plugin must have a dependency on the Godot Android library: `implementation "org.godotengine:godot:"` *

- * - The library must include a tag in its Android manifest with the following format: + * - The plugin must include a tag in its Android manifest with the following format: * + *

* Where: + *

* - 'PluginName' is the name of the plugin. + *

* - 'plugin.init.ClassFullName' is the full name (package + class name) of the plugin init class * extending {@link GodotPlugin}. *

@@ -83,6 +86,10 @@ public abstract class GodotPlugin { private final Godot godot; private final ConcurrentHashMap registeredSignals = new ConcurrentHashMap<>(); + /** + * Base constructor passing a {@link Godot} instance through which the plugin can access Godot's + * APIs and lifecycle events. + */ public GodotPlugin(Godot godot) { this.godot = godot; } @@ -109,11 +116,11 @@ protected Activity getActivity() { */ public final void onRegisterPluginWithGodotNative() { registeredSignals.putAll( - registerPluginWithGodotNative(this, getPluginName(), getPluginSignals())); + registerPluginWithGodotNative(this, getPluginName(), getPluginMethods(), getPluginSignals())); } private static Map registerPluginWithGodotNative(Object pluginObject, - String pluginName, Set pluginSignals) { + String pluginName, List pluginMethods, Set pluginSignals) { nativeRegisterSingleton(pluginName, pluginObject); Set filteredMethods = new HashSet<>(); @@ -124,6 +131,14 @@ private static Map registerPluginWithGodotNative(Object plug // Check if the method is annotated with {@link UsedByGodot}. if (method.getAnnotation(UsedByGodot.class) != null) { filteredMethods.add(method); + } else { + // For backward compatibility, process the methods from the given argument. + for (String methodName : pluginMethods) { + if (methodName.equals(method.getName())) { + filteredMethods.add(method); + break; + } + } } } @@ -260,6 +275,17 @@ public void onVkSurfaceCreated(Surface surface) {} @NonNull public abstract String getPluginName(); + /** + * Returns the list of methods to be exposed to Godot. + * + * @deprecated Use the {@link UsedByGodot} annotation instead. + */ + @NonNull + @Deprecated + public List getPluginMethods() { + return Collections.emptyList(); + } + /** * Returns the list of signals to be exposed to Godot. */ diff --git a/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPluginRegistry.java b/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPluginRegistry.java index d81d996c426c..d338b724418e 100644 --- a/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPluginRegistry.java +++ b/platform/android/java/lib/src/org/godotengine/godot/plugin/GodotPluginRegistry.java @@ -53,11 +53,11 @@ public final class GodotPluginRegistry { private static final String TAG = GodotPluginRegistry.class.getSimpleName(); /** - * Prefix used for version 1 of the Godot plugin, compatible with Godot 3.x + * Prefix used for version 1 of the Godot plugin, mostly compatible with Godot 3.x */ private static final String GODOT_PLUGIN_V1_NAME_PREFIX = "org.godotengine.plugin.v1."; /** - * Prefix used for version 2 of the Godot plugin, compatible with Godot 4.x + * Prefix used for version 2 of the Godot plugin, compatible with Godot 4.2+ */ private static final String GODOT_PLUGIN_V2_NAME_PREFIX = "org.godotengine.plugin.v2."; @@ -130,12 +130,18 @@ private void loadPlugins(Godot godot) { return; } - int godotPluginV2NamePrefixLength = GODOT_PLUGIN_V2_NAME_PREFIX.length(); for (String metaDataName : metaData.keySet()) { // Parse the meta-data looking for entry with the Godot plugin name prefix. + String pluginName = null; if (metaDataName.startsWith(GODOT_PLUGIN_V2_NAME_PREFIX)) { - String pluginName = metaDataName.substring(godotPluginV2NamePrefixLength).trim(); - Log.i(TAG, "Initializing Godot v2 plugin " + pluginName); + pluginName = metaDataName.substring(GODOT_PLUGIN_V2_NAME_PREFIX.length()).trim(); + } else if (metaDataName.startsWith(GODOT_PLUGIN_V1_NAME_PREFIX)) { + pluginName = metaDataName.substring(GODOT_PLUGIN_V1_NAME_PREFIX.length()).trim(); + Log.w(TAG, "Godot v1 plugin are deprecated in Godot 4.2 and higher: " + pluginName); + } + + if (!TextUtils.isEmpty(pluginName)) { + Log.i(TAG, "Initializing Godot plugin " + pluginName); // Retrieve the plugin class full name. String pluginHandleClassFullName = metaData.getString(metaDataName); @@ -155,22 +161,17 @@ private void loadPlugins(Godot godot) { "Meta-data plugin name does not match the value returned by the plugin handle: " + pluginName + " =/= " + pluginHandle.getPluginName()); } registry.put(pluginName, pluginHandle); - Log.i(TAG, "Completed initialization for Godot v2 plugin " + pluginHandle.getPluginName()); - } catch (ClassNotFoundException | IllegalAccessException | - InstantiationException | NoSuchMethodException | - InvocationTargetException e) { - Log.w(TAG, "Unable to load Godot v2 plugin " + pluginName, e); + Log.i(TAG, "Completed initialization for Godot plugin " + pluginHandle.getPluginName()); + } catch (Exception e) { + Log.w(TAG, "Unable to load Godot plugin " + pluginName, e); } } else { Log.w(TAG, "Invalid plugin loader class for " + pluginName); } - } else if (metaDataName.startsWith(GODOT_PLUGIN_V1_NAME_PREFIX)) { - String v1PluginName = metaDataName.substring(GODOT_PLUGIN_V1_NAME_PREFIX.length()).trim(); - Log.w(TAG, "Godot 4 does not support Godot 3 (v1) plugin: " + v1PluginName); } } - } catch (PackageManager.NameNotFoundException e) { - Log.e(TAG, "Unable load Godot Android v2 plugins from the manifest file.", e); + } catch (Exception e) { + Log.e(TAG, "Unable load Godot Android plugins from the manifest file.", e); } } }