Skip to content

Commit

Permalink
Additional fixes and improvements to JavaClassWrapper
Browse files Browse the repository at this point in the history
- Fix crashing bug when invoking class constructor with parameters
- Add support for Godot Callable arguments. A Godot Callable can be wrapped by a Java Runnable to allow Java logic to run arbitrary Godot lambdas
- Automatically convert java.lang.CharSequence to Godot String as needed
- Code cleanup
  • Loading branch information
m4gr3d committed Dec 18, 2024
1 parent 6e2cf2a commit 7995875
Show file tree
Hide file tree
Showing 18 changed files with 513 additions and 126 deletions.
1 change: 1 addition & 0 deletions platform/android/SCsub
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ android_files = [
"display_server_android.cpp",
"plugin/godot_plugin_jni.cpp",
"rendering_context_driver_vulkan_android.cpp",
"variant/callable_jni.cpp",
]

env_android = env.Clone()
Expand Down
8 changes: 8 additions & 0 deletions platform/android/api/java_class_wrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ class JavaClass : public RefCounted {
ARG_TYPE_FLOAT,
ARG_TYPE_DOUBLE,
ARG_TYPE_STRING, //special case
ARG_TYPE_CHARSEQUENCE,
ARG_TYPE_CALLABLE,
ARG_TYPE_CLASS,
ARG_ARRAY_BIT = 1 << 16,
ARG_NUMBER_CLASS_BIT = 1 << 17,
Expand Down Expand Up @@ -123,8 +125,12 @@ class JavaClass : public RefCounted {
likelihood = 0.5;
break;
case ARG_TYPE_STRING:
case ARG_TYPE_CHARSEQUENCE:
r_type = Variant::STRING;
break;
case ARG_TYPE_CALLABLE:
r_type = Variant::CALLABLE;
break;
case ARG_TYPE_CLASS:
r_type = Variant::OBJECT;
break;
Expand Down Expand Up @@ -163,9 +169,11 @@ class JavaClass : public RefCounted {
likelihood = 0.5;
break;
case ARG_ARRAY_BIT | ARG_TYPE_STRING:
case ARG_ARRAY_BIT | ARG_TYPE_CHARSEQUENCE:
r_type = Variant::PACKED_STRING_ARRAY;
break;
case ARG_ARRAY_BIT | ARG_TYPE_CLASS:
case ARG_ARRAY_BIT | ARG_TYPE_CALLABLE:
r_type = Variant::ARRAY;
break;
}
Expand Down
2 changes: 1 addition & 1 deletion platform/android/dir_access_jandroid.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

#include "dir_access_jandroid.h"

#include "string_android.h"
#include "jni_utils.h"
#include "thread_jandroid.h"

#include "core/string/print_string.h"
Expand Down
15 changes: 13 additions & 2 deletions platform/android/java/lib/src/org/godotengine/godot/GodotLib.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
import org.godotengine.godot.io.file.FileAccessHandler;
import org.godotengine.godot.tts.GodotTTS;
import org.godotengine.godot.utils.GodotNetUtils;
import org.godotengine.godot.variant.Callable;

import android.app.Activity;
import android.content.res.AssetManager;
Expand Down Expand Up @@ -200,16 +201,26 @@ public static native boolean initialize(Activity activity,
* @param p_id Id of the Godot object to invoke
* @param p_method Name of the method to invoke
* @param p_params Parameters to use for method invocation
*
* @deprecated Use {@link Callable#call(long, String, Object...)} instead.
*/
public static native void callobject(long p_id, String p_method, Object[] p_params);
@Deprecated
public static void callobject(long p_id, String p_method, Object[] p_params) {
Callable.call(p_id, p_method, p_params);
}

/**
* Invoke method |p_method| on the Godot object specified by |p_id| during idle time.
* @param p_id Id of the Godot object to invoke
* @param p_method Name of the method to invoke
* @param p_params Parameters to use for method invocation
*
* @deprecated Use {@link Callable#callDeferred(long, String, Object...)} instead.
*/
public static native void calldeferred(long p_id, String p_method, Object[] p_params);
@Deprecated
public static void calldeferred(long p_id, String p_method, Object[] p_params) {
Callable.callDeferred(p_id, p_method, p_params);
}

/**
* Forward the results from a permission request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,15 @@
package org.godotengine.godot.plugin

import org.godotengine.godot.Godot
import org.godotengine.godot.variant.Callable

/**
* Provides access to the Android runtime capabilities.
*
* For example, from gdscript, developers can use [getApplicationContext] to access system services
* and check if the device supports vibration.
*
* var android_runtime = Engine.get_singleton("AndroidRuntime")
* var android_runtime = Engine.get_singleton("AndroidRuntime")
* if android_runtime:
* print("Checking if the device supports vibration")
* var vibrator_service = android_runtime.getApplicationContext().getSystemService("vibrator")
Expand All @@ -51,13 +52,50 @@ import org.godotengine.godot.Godot
* printerr("Unable to retrieve the vibrator service")
* else:
* printerr("Couldn't find AndroidRuntime singleton")
*
*
* Or it can be used to display an Android native toast from gdscript
*
* var android_runtime = Engine.get_singleton("AndroidRuntime")
* if android_runtime:
* var activity = android_runtime.getActivity()
*
* var toastCallable = func ():
* var ToastClass = JavaClassWrapper.wrap("android.widget.Toast")
* ToastClass.makeText(activity, "This is a test", 1).show()
*
* activity.runOnUiThread(android_runtime.createRunnableFromGodotCallable(toastCallable))
* else:
* printerr("Unable to access android runtime")
*/
class AndroidRuntimePlugin(godot: Godot) : GodotPlugin(godot) {
override fun getPluginName() = "AndroidRuntime"

/**
* Provides access to the application context to GDScript
*/
@UsedByGodot
fun getApplicationContext() = activity?.applicationContext

/**
* Provides access to the host activity to GDScript
*/
@UsedByGodot
override fun getActivity() = super.getActivity()

/**
* Utility method used to create [Runnable] from Godot [Callable].
*/
@UsedByGodot
fun createRunnableFromGodotCallable(godotCallable: Callable): Runnable {
return Runnable { godotCallable.call() }
}

/**
* Utility method used to create [java.util.concurrent.Callable] from Godot [Callable].
*/
@UsedByGodot
fun createCallableFromGodotCallable(godotCallable: Callable): java.util.concurrent.Callable<Any> {
return java.util.concurrent.Callable { godotCallable.call() }
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**************************************************************************/
/* Callable.kt */
/**************************************************************************/
/* 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. */
/**************************************************************************/

package org.godotengine.godot.variant

import androidx.annotation.Keep

/**
* Android version of a Godot built-in Callable type representing a method or a standalone function.
*/
@Keep
class Callable private constructor(private val nativeCallablePointer: Long) {

companion object {
/**
* Invoke method [methodName] on the Godot object specified by [godotObjectId]
*/
@JvmStatic
fun call(godotObjectId: Long, methodName: String, vararg methodParameters: Any): Any? {
return nativeCallObject(godotObjectId, methodName, methodParameters)
}

/**
* Invoke method [methodName] on the Godot object specified by [godotObjectId] during idle time.
*/
@JvmStatic
fun callDeferred(godotObjectId: Long, methodName: String, vararg methodParameters: Any) {
nativeCallObjectDeferred(godotObjectId, methodName, methodParameters)
}

@JvmStatic
private external fun nativeCall(pointer: Long, params: Array<out Any>): Any?

@JvmStatic
private external fun nativeCallObject(godotObjectId: Long, methodName: String, params: Array<out Any>): Any?

@JvmStatic
private external fun nativeCallObjectDeferred(godotObjectId: Long, methodName: String, params: Array<out Any>)

@JvmStatic
private external fun releaseNativePointer(nativePointer: Long)
}

/**
* Calls the method represented by this [Callable]. Arguments can be passed and should match the method's signature.
*/
internal fun call(vararg params: Any): Any? {
if (nativeCallablePointer == 0L) {
return null
}

return nativeCall(nativeCallablePointer, params)
}

/**
* Used to provide access to the native callable pointer to the native logic.
*/
private fun getNativePointer() = nativeCallablePointer

/** Note that [finalize] is deprecated and shouldn't be used, unfortunately its replacement,
* [java.lang.ref.Cleaner], is only available on Android api 33 and higher.
* So we resort to using it for the time being until our min api catches up to api 33.
**/
protected fun finalize() {
releaseNativePointer(nativeCallablePointer)
}
}
Loading

0 comments on commit 7995875

Please sign in to comment.