Flesh out Callable functions

Author: lilizoey

godot-codegen/src/special_cases/special_cases.rs

@@ -241,6 +241,14 @@ pub fn is_builtin_method_exposed(builtin_ty: &TyName, godot_method_name: &str) -
 
         // NodePath
 
+        // Callable
+        | ("Callable", "call")
+        | ("Callable", "call_deferred")
+        | ("Callable", "bind")
+        | ("Callable", "get_bound_arguments")
+        | ("Callable", "rpc")
+        | ("Callable", "rpc_id")
+
         // (add more builtin types below)
 
         => true, _ => false

godot-core/src/builtin/callable.rs

@@ -335,6 +335,20 @@ impl Callable {
         self.as_inner().is_valid()
     }
 
+    pub fn unbind(&self, args: usize) -> Callable {
+        self.as_inner().unbind(args as i64)
+    }
+
+    #[doc(alias = "get_argument_count")]
+    pub fn arg_len(&self) -> usize {
+        self.as_inner().get_argument_count() as usize
+    }
+
+    #[doc(alias = "get_bound_arguments_count")]
+    pub fn bound_args_len(&self) -> i64 {
+        self.as_inner().get_bound_arguments_count()
+    }
+
     #[doc(hidden)]
     pub fn as_inner(&self) -> inner::InnerCallable {
         inner::InnerCallable::from_outer(self)

itest/rust/src/builtin_tests/containers/callable_test.rs

@@ -6,10 +6,12 @@
  */
 
 use godot::builtin::inner::InnerCallable;
-use godot::builtin::{varray, Callable, GString, StringName, Variant};
-use godot::classes::{Node2D, Object};
+use godot::builtin::{
+    array, varray, Array, Callable, GString, NodePath, StringName, Variant, VariantArray,
+};
+use godot::classes::{Node2D, Object, RefCounted};
 use godot::meta::ToGodot;
-use godot::obj::{NewAlloc, NewGd};
+use godot::obj::{Gd, NewAlloc, NewGd};
 use godot::register::{godot_api, GodotClass};
 use std::hash::Hasher;
 use std::sync::atomic::{AtomicU32, Ordering};
@@ -33,6 +35,11 @@ impl CallableTestObj {
     fn bar(&self, b: i32) -> GString {
         b.to_variant().stringify()
     }
+
+    #[func]
+    fn baz(&self, a: i32, b: GString, c: Array<NodePath>, d: Gd<RefCounted>) -> VariantArray {
+        varray![a, b, c, d]
+    }
 }
 
 #[itest]
@@ -86,7 +93,7 @@ fn callable_object_method() {
 }
 
 #[itest]
-fn callable_call() {
+fn callable_callv() {
     let obj = CallableTestObj::new_gd();
     let callable = obj.callable("foo");
 
@@ -106,6 +113,30 @@ fn callable_call() {
     assert_eq!(Callable::invalid().callv(&varray![1, 2, 3]), Variant::nil());
 }
 
+#[itest]
+fn callable_call() {
+    let obj = CallableTestObj::new_gd();
+    let callable = obj.callable("foo");
+
+    assert_eq!(obj.bind().value, 0);
+    callable.call(&[10.to_variant()]);
+    assert_eq!(obj.bind().value, 10);
+
+    // Too many arguments: this call fails, its logic is not applied.
+    // In the future, panic should be propagated to caller.
+    callable.call(&[20.to_variant(), 30.to_variant()]);
+    assert_eq!(obj.bind().value, 10);
+
+    // TODO(bromeon): this causes a Rust panic, but since call() is routed to Godot, the panic is handled at the FFI boundary.
+    // Can there be a way to notify the caller about failed calls like that?
+    assert_eq!(callable.call(&["string".to_variant()]), Variant::nil());
+
+    assert_eq!(
+        Callable::invalid().call(&[1.to_variant(), 2.to_variant(), 3.to_variant()]),
+        Variant::nil()
+    );
+}
+
 #[itest]
 fn callable_call_return() {
     let obj = CallableTestObj::new_gd();
@@ -151,24 +182,90 @@ fn callable_bindv() {
     );
 }
 
-// This is also testing that using works at all.
 #[itest]
-#[cfg(since_api = "4.2")]
-fn callable_varargs() {
-    // TODO: Replace with proper apis instead of using `InnerCallable`.
-    use godot::builtin::inner;
+fn callable_bind() {
     let obj = CallableTestObj::new_gd();
     let callable = obj.callable("bar");
-    let inner_callable = inner::InnerCallable::from_outer(&callable);
-    let callable_bound = inner_callable.bind(&[10.to_variant()]);
-    let inner_callable_bound = inner::InnerCallable::from_outer(&callable_bound);
+    let callable_bound = callable.bind(&[10.to_variant()]);
 
     assert_eq!(
-        inner_callable_bound.call(&[]),
+        callable_bound.call(&[]),
         10.to_variant().stringify().to_variant()
     );
 }
 
+#[itest]
+fn callable_unbind() {
+    let obj = CallableTestObj::new_gd();
+    let callable = obj.callable("bar");
+    let callable_unbound = callable.unbind(3);
+
+    assert_eq!(
+        callable_unbound.call(&[
+            121.to_variant(),
+            20.to_variant(),
+            30.to_variant(),
+            40.to_variant()
+        ]),
+        121.to_variant().stringify().to_variant()
+    );
+}
+
+#[itest]
+fn callable_arg_len() {
+    let obj = CallableTestObj::new_gd();
+
+    assert_eq!(obj.callable("foo").arg_len(), 1);
+    assert_eq!(obj.callable("bar").arg_len(), 1);
+    assert_eq!(obj.callable("baz").arg_len(), 4);
+    assert_eq!(obj.callable("foo").unbind(10).arg_len(), 11);
+    assert_eq!(
+        obj.callable("baz")
+            .bind(&[10.to_variant(), "hello".to_variant()])
+            .arg_len(),
+        2
+    );
+}
+
+#[itest]
+fn callable_bound_args_len() {
+    let obj = CallableTestObj::new_gd();
+
+    assert_eq!(obj.callable("foo").bound_args_len(), 0);
+    assert_eq!(
+        obj.callable("foo")
+            .bind(&[10.to_variant()])
+            .bound_args_len(),
+        1
+    );
+    assert_eq!(obj.callable("foo").unbind(28).bound_args_len(), -28);
+    assert_eq!(
+        obj.callable("foo")
+            .bind(&[10.to_variant()])
+            .unbind(5)
+            .bound_args_len(),
+        -4
+    );
+}
+
+#[itest]
+fn callable_get_bound_arguments() {
+    let obj = CallableTestObj::new_gd();
+
+    let a = 10.to_variant();
+    let b = "hello!".to_variant();
+    let c: Array<NodePath> = array!["my/node/path"];
+    let c = c.to_variant();
+    let d = RefCounted::new_gd().to_variant();
+
+    let callable = obj.callable("baz");
+    let callable_bound = callable.bind(&[a.clone(), b.clone(), c.clone(), d.clone()]);
+
+    assert_eq!(callable_bound.get_bound_arguments(), varray![a, b, c, d]);
+}
+
+// TODO: Add tests for `Callable::rpc` and `Callable::rpc_id`.
+
 // Testing https://github.com/godot-rust/gdext/issues/410
 
 #[derive(GodotClass)]