Implement callable_mp() and callable_mp_static()

Author: dsnopek

gdextension/gdextension_interface.h

@@ -343,6 +343,47 @@ typedef struct {
 GDExtensionVariantPtr *default_arguments;
 } GDExtensionClassMethodInfo;
 
+typedef void (*GDExtensionCallableCustomCall)(void *callable_userdata, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
+typedef GDExtensionBool (*GDExtensionCallableCustomIsValid)(void *callable_userdata);
+typedef void (*GDExtensionCallableCustomFree)(void *callable_userdata);
+
+typedef uint32_t (*GDExtensionCallableCustomHash)(void *callable_userdata);
+typedef GDExtensionBool (*GDExtensionCallableCustomEqual)(void *callable_userdata_a, void *callable_userdata_b);
+typedef GDExtensionBool (*GDExtensionCallableCustomLessThan)(void *callable_userdata_a, void *callable_userdata_b);
+
+typedef void (*GDExtensionCallableCustomToString)(void *callable_userdata, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
+
+typedef struct {
+/* Only `call_func` and `token` are strictly required, however, `object` should be passed if its not a static method.
+ *
+ * `token` should point to an address that uniquely identifies the GDExtension (for example, the
+ * `GDExtensionClassLibraryPtr` passed to the entry symbol function.
+ *
+ * `hash_func`, `equal_func`, and `less_than_func` are optional. If not provided both `call_func` and
+ * `callable_userdata` together are used as the identity of the callable for hashing and comparison purposes.
+ *
+ * The hash returned by `hash_func` is cached, `hash_func` will not be called more than once per callable.
+ *
+ * `is_valid_func` is necessary if the validity of the callable can change before destruction.
+ *
+ * `free_func` is necessary if `callable_userdata` needs to be cleaned up when the callable is freed.
+ */
+void *callable_userdata;
+void *token;
+
+GDExtensionObjectPtr object;
+
+GDExtensionCallableCustomCall call_func;
+GDExtensionCallableCustomIsValid is_valid_func;
+GDExtensionCallableCustomFree free_func;
+
+GDExtensionCallableCustomHash hash_func;
+GDExtensionCallableCustomEqual equal_func;
+GDExtensionCallableCustomLessThan less_than_func;
+
+GDExtensionCallableCustomToString to_string_func;
+} GDExtensionCallableCustomInfo;
+
 /* SCRIPT INSTANCE EXTENSION */
 
 typedef void *GDExtensionScriptInstanceDataPtr; // Pointer to custom ScriptInstance native implementation.
@@ -1985,6 +2026,34 @@ typedef void (*GDExtensionInterfaceRefSetObject)(GDExtensionRefPtr p_ref, GDExte
  */
 typedef GDExtensionScriptInstancePtr (*GDExtensionInterfaceScriptInstanceCreate)(const GDExtensionScriptInstanceInfo *p_info, GDExtensionScriptInstanceDataPtr p_instance_data);
 
+/* INTERFACE: Callable */
+
+/**
+ * @name callable_custom_create
+ * @since 4.2
+ *
+ * Creates a custom Callable object from a function pointer.
+ *
+ * Provided struct can be safely freed once the function returns.
+ *
+ * @param r_callable A pointer that will receive the new Callable.
+ * @param p_callable_custom_info The info required to construct a Callable.
+ */
+typedef void (*GDExtensionInterfaceCallableCustomCreate)(GDExtensionUninitializedTypePtr r_callable, GDExtensionCallableCustomInfo *p_callable_custom_info);
+
+/**
+ * @name callable_custom_get_userdata
+ * @since 4.2
+ *
+ * Retrieves the userdata pointer from a custom Callable.
+ *
+ * If the Callable is not a custom Callable or the token does not match the one provided to callable_custom_create() via GDExtensionCallableCustomInfo then NULL will be returned.
+ *
+ * @param p_callable A pointer to a Callable.
+ * @param p_token A pointer to an address that uniquely identifies the GDExtension.
+ */
+typedef void *(*GDExtensionInterfaceCallableCustomGetUserData)(GDExtensionConstTypePtr p_callable, void *p_token);
+
 /* INTERFACE: ClassDB */
 
 /**

include/godot_cpp/core/binder_common.hpp

@@ -276,6 +276,60 @@ void call_with_variant_args_retc_helper(T *p_instance, R (T::*p_method)(P...) co
 (void)p_args;
 }
 
+template <class T, class... P>
+void call_with_variant_args(T *p_instance, void (T::*p_method)(P...), const Variant **p_args, int p_argcount, GDExtensionCallError &r_error) {
+#ifdef DEBUG_ENABLED
+if ((size_t)p_argcount > sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+
+if ((size_t)p_argcount < sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+#endif
+call_with_variant_args_helper<T, P...>(p_instance, p_method, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
+}
+
+template <class T, class R, class... P>
+void call_with_variant_args_ret(T *p_instance, R (T::*p_method)(P...), const Variant **p_args, int p_argcount, Variant &r_ret, GDExtensionCallError &r_error) {
+#ifdef DEBUG_ENABLED
+if ((size_t)p_argcount > sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+
+if ((size_t)p_argcount < sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+#endif
+call_with_variant_args_ret_helper<T, R, P...>(p_instance, p_method, p_args, r_ret, r_error, BuildIndexSequence<sizeof...(P)>{});
+}
+
+template <class T, class R, class... P>
+void call_with_variant_args_retc(T *p_instance, R (T::*p_method)(P...) const, const Variant **p_args, int p_argcount, Variant &r_ret, GDExtensionCallError &r_error) {
+#ifdef DEBUG_ENABLED
+if ((size_t)p_argcount > sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+
+if ((size_t)p_argcount < sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+#endif
+call_with_variant_args_retc_helper<T, R, P...>(p_instance, p_method, p_args, r_ret, r_error, BuildIndexSequence<sizeof...(P)>{});
+}
+
 template <class T, class... P>
 void call_with_variant_args_dv(T *p_instance, void (T::*p_method)(P...), const GDExtensionConstVariantPtr *p_args, int p_argcount, GDExtensionCallError &r_error, const std::vector<Variant> &default_values) {
 #ifdef DEBUG_ENABLED
@@ -538,6 +592,42 @@ void call_with_ptr_args_static_method(void (*p_method)(P...), const GDExtensionC
 call_with_ptr_args_static_method_helper<P...>(p_method, p_args, BuildIndexSequence<sizeof...(P)>{});
 }
 
+template <class R, class... P>
+void call_with_variant_args_static_ret(R (*p_method)(P...), const Variant **p_args, int p_argcount, Variant &r_ret, GDExtensionCallError &r_error) {
+#ifdef DEBUG_ENABLED
+if ((size_t)p_argcount > sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+
+if ((size_t)p_argcount < sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+#endif
+call_with_variant_args_static_ret<R, P...>(p_method, p_args, r_ret, r_error, BuildIndexSequence<sizeof...(P)>{});
+}
+
+template <class... P>
+void call_with_variant_args_static_ret(void (*p_method)(P...), const Variant **p_args, int p_argcount, Variant &r_ret, GDExtensionCallError &r_error) {
+#ifdef DEBUG_ENABLED
+if ((size_t)p_argcount > sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_MANY_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+
+if ((size_t)p_argcount < sizeof...(P)) {
+r_error.error = GDEXTENSION_CALL_ERROR_TOO_FEW_ARGUMENTS;
+r_error.argument = (int32_t)sizeof...(P);
+return;
+}
+#endif
+call_with_variant_args_static<P...>(p_method, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
+}
+
 template <class R, class... P, size_t... Is>
 void call_with_variant_args_static_ret(R (*p_method)(P...), const Variant **p_args, Variant &r_ret, GDExtensionCallError &r_error, IndexSequence<Is...>) {
 r_error.error = GDEXTENSION_CALL_OK;

include/godot_cpp/core/class_db.hpp

@@ -38,6 +38,10 @@
 #include <godot_cpp/core/method_bind.hpp>
 #include <godot_cpp/core/object.hpp>
 
+// Makes callable_mp readily available in all classes connecting signals.
+// Needs to come after method_bind and object have been included.
+#include <godot_cpp/variant/callable_method_pointer.hpp>
+
 #include <list>
 #include <set>
 #include <string>

include/godot_cpp/godot.hpp

@@ -163,6 +163,7 @@ extern "C" GDExtensionInterfaceObjectGetClassName gdextension_interface_object_g
 extern "C" GDExtensionInterfaceObjectCastTo gdextension_interface_object_cast_to;
 extern "C" GDExtensionInterfaceObjectGetInstanceFromId gdextension_interface_object_get_instance_from_id;
 extern "C" GDExtensionInterfaceObjectGetInstanceId gdextension_interface_object_get_instance_id;
+extern "C" GDExtensionInterfaceCallableCustomCreate gdextension_interface_callable_custom_create;
 extern "C" GDExtensionInterfaceRefGetObject gdextension_interface_ref_get_object;
 extern "C" GDExtensionInterfaceRefSetObject gdextension_interface_ref_set_object;
 extern "C" GDExtensionInterfaceScriptInstanceCreate gdextension_interface_script_instance_create;