Merge pull request godotengine#97500 from m4gr3d/update_godot_plugin_to_use_javaclasswrapper

Remove the restriction on supported types for Godot Android plugins

Author: akien-mga

platform/android/api/api.cpp

@@ -41,13 +41,11 @@ static JavaClassWrapper *java_class_wrapper = nullptr;
 
 void register_android_api() {
 #if !defined(ANDROID_ENABLED)
-	// On Android platforms, the `java_class_wrapper` instantiation and the
-	// `JNISingleton` registration occurs in
+	// On Android platforms, the `java_class_wrapper` instantiation occurs in
 	// `platform/android/java_godot_lib_jni.cpp#Java_org_godotengine_godot_GodotLib_setup`
-	java_class_wrapper = memnew(JavaClassWrapper); // Dummy
-	GDREGISTER_CLASS(JNISingleton);
+	java_class_wrapper = memnew(JavaClassWrapper);
 #endif
-
+	GDREGISTER_CLASS(JNISingleton);
 	GDREGISTER_CLASS(JavaClass);
 	GDREGISTER_CLASS(JavaObject);
 	GDREGISTER_CLASS(JavaClassWrapper);
@@ -108,7 +106,7 @@ Ref<JavaClass> JavaObject::get_java_class() const {
 
 JavaClassWrapper *JavaClassWrapper::singleton = nullptr;
 
-Ref<JavaClass> JavaClassWrapper::wrap(const String &) {
+Ref<JavaClass> JavaClassWrapper::_wrap(const String &, bool) {
 	return Ref<JavaClass>();
 }
 

platform/android/api/java_class_wrapper.h

@@ -262,6 +262,8 @@ class JavaClassWrapper : public Object {
 	bool _get_type_sig(JNIEnv *env, jobject obj, uint32_t &sig, String &strsig);
 #endif
 
+	Ref<JavaClass> _wrap(const String &p_class, bool p_allow_private_methods_access);
+
 	static JavaClassWrapper *singleton;
 
 protected:
@@ -270,15 +272,14 @@ class JavaClassWrapper : public Object {
 public:
 	static JavaClassWrapper *get_singleton() { return singleton; }
 
-	Ref<JavaClass> wrap(const String &p_class);
+	Ref<JavaClass> wrap(const String &p_class) {
+		return _wrap(p_class, false);
+	}
 
 #ifdef ANDROID_ENABLED
-	Ref<JavaClass> wrap_jclass(jclass p_class);
-
-	JavaClassWrapper(jobject p_activity = nullptr);
-#else
-	JavaClassWrapper();
+	Ref<JavaClass> wrap_jclass(jclass p_class, bool p_allow_private_methods_access = false);
 #endif
+	JavaClassWrapper();
 };
 
 #endif // JAVA_CLASS_WRAPPER_H

platform/android/api/jni_singleton.h

@@ -31,193 +31,53 @@
 #ifndef JNI_SINGLETON_H
 #define JNI_SINGLETON_H
 
+#include "java_class_wrapper.h"
+
 #include "core/config/engine.h"
 #include "core/variant/variant.h"
 
-#ifdef ANDROID_ENABLED
-#include "jni_utils.h"
-#endif
-
 class JNISingleton : public Object {
 	GDCLASS(JNISingleton, Object);
 
-#ifdef ANDROID_ENABLED
 	struct MethodData {
-		jmethodID method;
 		Variant::Type ret_type;
 		Vector<Variant::Type> argtypes;
 	};
 
-	jobject instance;
 	RBMap<StringName, MethodData> method_map;
-#endif
+	Ref<JavaObject> wrapped_object;
 
 public:
 	virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override {
-#ifdef ANDROID_ENABLED
-		RBMap<StringName, MethodData>::Element *E = method_map.find(p_method);
-
-		// Check the method we're looking for is in the JNISingleton map and that
-		// the arguments match.
-		bool call_error = !E || E->get().argtypes.size() != p_argcount;
-		if (!call_error) {
-			for (int i = 0; i < p_argcount; i++) {
-				if (!Variant::can_convert(p_args[i]->get_type(), E->get().argtypes[i])) {
-					call_error = true;
-					break;
+		if (wrapped_object.is_valid()) {
+			RBMap<StringName, MethodData>::Element *E = method_map.find(p_method);
+
+			// Check the method we're looking for is in the JNISingleton map and that
+			// the arguments match.
+			bool call_error = !E || E->get().argtypes.size() != p_argcount;
+			if (!call_error) {
+				for (int i = 0; i < p_argcount; i++) {
+					if (!Variant::can_convert(p_args[i]->get_type(), E->get().argtypes[i])) {
+						call_error = true;
+						break;
+					}
 				}
 			}
-		}
-
-		if (call_error) {
-			// The method is not in this map, defaulting to the regular instance calls.
-			return Object::callp(p_method, p_args, p_argcount, r_error);
-		}
-
-		ERR_FAIL_NULL_V(instance, Variant());
-
-		r_error.error = Callable::CallError::CALL_OK;
-
-		jvalue *v = nullptr;
 
-		if (p_argcount) {
-			v = (jvalue *)alloca(sizeof(jvalue) * p_argcount);
-		}
-
-		JNIEnv *env = get_jni_env();
-
-		int res = env->PushLocalFrame(16);
-
-		ERR_FAIL_COND_V(res != 0, Variant());
-
-		List<jobject> to_erase;
-		for (int i = 0; i < p_argcount; i++) {
-			jvalret vr = _variant_to_jvalue(env, E->get().argtypes[i], p_args[i]);
-			v[i] = vr.val;
-			if (vr.obj) {
-				to_erase.push_back(vr.obj);
+			if (!call_error) {
+				return wrapped_object->callp(p_method, p_args, p_argcount, r_error);
 			}
 		}
 
-		Variant ret;
-
-		switch (E->get().ret_type) {
-			case Variant::NIL: {
-				env->CallVoidMethodA(instance, E->get().method, v);
-			} break;
-			case Variant::BOOL: {
-				ret = env->CallBooleanMethodA(instance, E->get().method, v) == JNI_TRUE;
-			} break;
-			case Variant::INT: {
-				ret = env->CallIntMethodA(instance, E->get().method, v);
-			} break;
-			case Variant::FLOAT: {
-				ret = env->CallFloatMethodA(instance, E->get().method, v);
-			} break;
-			case Variant::STRING: {
-				jobject o = env->CallObjectMethodA(instance, E->get().method, v);
-				ret = jstring_to_string((jstring)o, env);
-				env->DeleteLocalRef(o);
-			} break;
-			case Variant::PACKED_STRING_ARRAY: {
-				jobjectArray arr = (jobjectArray)env->CallObjectMethodA(instance, E->get().method, v);
-
-				ret = _jobject_to_variant(env, arr);
-
-				env->DeleteLocalRef(arr);
-			} break;
-			case Variant::PACKED_INT32_ARRAY: {
-				jintArray arr = (jintArray)env->CallObjectMethodA(instance, E->get().method, v);
-
-				int fCount = env->GetArrayLength(arr);
-				Vector<int> sarr;
-				sarr.resize(fCount);
-
-				int *w = sarr.ptrw();
-				env->GetIntArrayRegion(arr, 0, fCount, w);
-				ret = sarr;
-				env->DeleteLocalRef(arr);
-			} break;
-			case Variant::PACKED_INT64_ARRAY: {
-				jlongArray arr = (jlongArray)env->CallObjectMethodA(instance, E->get().method, v);
-
-				int fCount = env->GetArrayLength(arr);
-				Vector<int64_t> sarr;
-				sarr.resize(fCount);
-
-				int64_t *w = sarr.ptrw();
-				env->GetLongArrayRegion(arr, 0, fCount, w);
-				ret = sarr;
-				env->DeleteLocalRef(arr);
-			} break;
-			case Variant::PACKED_FLOAT32_ARRAY: {
-				jfloatArray arr = (jfloatArray)env->CallObjectMethodA(instance, E->get().method, v);
-
-				int fCount = env->GetArrayLength(arr);
-				Vector<float> sarr;
-				sarr.resize(fCount);
-
-				float *w = sarr.ptrw();
-				env->GetFloatArrayRegion(arr, 0, fCount, w);
-				ret = sarr;
-				env->DeleteLocalRef(arr);
-			} break;
-			case Variant::PACKED_FLOAT64_ARRAY: {
-				jdoubleArray arr = (jdoubleArray)env->CallObjectMethodA(instance, E->get().method, v);
-
-				int fCount = env->GetArrayLength(arr);
-				Vector<double> sarr;
-				sarr.resize(fCount);
-
-				double *w = sarr.ptrw();
-				env->GetDoubleArrayRegion(arr, 0, fCount, w);
-				ret = sarr;
-				env->DeleteLocalRef(arr);
-			} break;
-			case Variant::DICTIONARY: {
-				jobject obj = env->CallObjectMethodA(instance, E->get().method, v);
-				ret = _jobject_to_variant(env, obj);
-				env->DeleteLocalRef(obj);
-
-			} break;
-			case Variant::OBJECT: {
-				jobject obj = env->CallObjectMethodA(instance, E->get().method, v);
-				ret = _jobject_to_variant(env, obj);
-				env->DeleteLocalRef(obj);
-			} break;
-			default: {
-				env->PopLocalFrame(nullptr);
-				ERR_FAIL_V(Variant());
-			} break;
-		}
-
-		while (to_erase.size()) {
-			env->DeleteLocalRef(to_erase.front()->get());
-			to_erase.pop_front();
-		}
-
-		env->PopLocalFrame(nullptr);
-
-		return ret;
-#else // ANDROID_ENABLED
-
-		// Defaulting to the regular instance calls.
 		return Object::callp(p_method, p_args, p_argcount, r_error);
-#endif
 	}
 
-#ifdef ANDROID_ENABLED
-	jobject get_instance() const {
-		return instance;
+	Ref<JavaObject> get_wrapped_object() const {
+		return wrapped_object;
 	}
 
-	void set_instance(jobject p_instance) {
-		instance = p_instance;
-	}
-
-	void add_method(const StringName &p_name, jmethodID p_method, const Vector<Variant::Type> &p_args, Variant::Type p_ret_type) {
+	void add_method(const StringName &p_name, const Vector<Variant::Type> &p_args, Variant::Type p_ret_type) {
 		MethodData md;
-		md.method = p_method;
 		md.argtypes = p_args;
 		md.ret_type = p_ret_type;
 		method_map[p_name] = md;
@@ -232,24 +92,15 @@ class JNISingleton : public Object {
 		ADD_SIGNAL(mi);
 	}
 
-#endif
+	JNISingleton() {}
 
-	JNISingleton() {
-#ifdef ANDROID_ENABLED
-		instance = nullptr;
-#endif
+	JNISingleton(const Ref<JavaObject> &p_wrapped_object) {
+		wrapped_object = p_wrapped_object;
 	}
 
 	~JNISingleton() {
-#ifdef ANDROID_ENABLED
 		method_map.clear();
-		if (instance) {
-			JNIEnv *env = get_jni_env();
-			ERR_FAIL_NULL(env);
-
-			env->DeleteGlobalRef(instance);
-		}
-#endif
+		wrapped_object.unref();
 	}
 };
 

platform/android/export/export_plugin.cpp

@@ -3263,8 +3263,11 @@ Error EditorExportPlatformAndroid::export_project_helper(const Ref<EditorExportP
 			cmdline.push_back(apk_build_command);
 		}
 
+		String addons_directory = ProjectSettings::get_singleton()->globalize_path("res://addons");
+
 		cmdline.push_back("-p"); // argument to specify the start directory.
 		cmdline.push_back(build_path); // start directory.
+		cmdline.push_back("-Paddons_directory=" + addons_directory); // path to the addon directory as it may contain jar or aar dependencies
 		cmdline.push_back("-Pexport_package_name=" + package_name); // argument to specify the package name.
 		cmdline.push_back("-Pexport_version_code=" + version_code); // argument to specify the version code.
 		cmdline.push_back("-Pexport_version_name=" + version_name); // argument to specify the version name.

platform/android/java/app/build.gradle

@@ -63,6 +63,12 @@ dependencies {
         implementation files(pluginsBinaries)
     }
 
+    // Automatically pick up local dependencies in res://addons
+    String addonsDirectory = getAddonsDirectory()
+    if (addonsDirectory != null && !addonsDirectory.isBlank()) {
+        implementation fileTree(dir: "$addonsDirectory", include: ['*.jar', '*.aar'])
+    }
+
     // .NET dependencies
     String jar = '../../../../modules/mono/thirdparty/libSystem.Security.Cryptography.Native.Android.jar'
     if (file(jar).exists()) {

platform/android/java/app/config.gradle

@@ -408,3 +408,8 @@ ext.shouldUseLegacyPackaging = { ->
     // Default behavior for minSdk >= 23
     return false
 }
+
+ext.getAddonsDirectory = { ->
+    String addonsDirectory = project.hasProperty("addons_directory") ? project.property("addons_directory") : ""
+    return addonsDirectory
+}

platform/android/java/lib/src/org/godotengine/godot/Godot.kt

@@ -58,6 +58,8 @@ import org.godotengine.godot.input.GodotEditText
 import org.godotengine.godot.input.GodotInputHandler
 import org.godotengine.godot.io.directory.DirectoryAccessHandler
 import org.godotengine.godot.io.file.FileAccessHandler
+import org.godotengine.godot.plugin.AndroidRuntimePlugin
+import org.godotengine.godot.plugin.GodotPlugin
 import org.godotengine.godot.plugin.GodotPluginRegistry
 import org.godotengine.godot.tts.GodotTTS
 import org.godotengine.godot.utils.CommandLineFileParser
@@ -228,7 +230,9 @@ class Godot(private val context: Context) {
 			window.addFlags(WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON)
 
 			Log.v(TAG, "Initializing Godot plugin registry")
-			GodotPluginRegistry.initializePluginRegistry(this, primaryHost.getHostPlugins(this))
+			val runtimePlugins = mutableSetOf<GodotPlugin>(AndroidRuntimePlugin(this))
+			runtimePlugins.addAll(primaryHost.getHostPlugins(this))
+			GodotPluginRegistry.initializePluginRegistry(this, runtimePlugins)
 			if (io == null) {
 				io = GodotIO(activity)
 			}