Merge pull request godot-rust#570 from TitanNano/jovan/signal

Implement builtin type `Signal`

godot-core/src/builtin/macros.rs

@@ -123,34 +123,6 @@ macro_rules! impl_builtin_traits {
     )
 }
 
-macro_rules! impl_builtin_stub {
-    // ($Class:ident, $OpaqueTy:ident $( ; )? $( $Traits:ident ),* ) => {
-    ($Class:ident, $OpaqueTy:ident) => {
-        #[repr(C)]
-        // #[derive(Copy, Clone)]
-        pub struct $Class {
-            opaque: sys::types::$OpaqueTy,
-        }
-
-        impl $Class {
-            fn from_opaque(opaque: sys::types::$OpaqueTy) -> Self {
-                Self { opaque }
-            }
-        }
-
-        // SAFETY:
-        // This is simply a wrapper around an `Opaque` value representing a value of the type.
-        // So this is safe.
-        unsafe impl GodotFfi for $Class {
-            fn variant_type() -> sys::VariantType {
-                sys::VariantType::$Class
-            }
-
-            ffi_methods! { type sys::GDExtensionTypePtr = *mut Opaque; .. }
-        }
-    };
-}
-
 macro_rules! impl_builtin_froms {
     ($To:ty; $($From:ty => $from_fn:ident),* $(,)?) => {
         $(impl From<&$From> for $To {

godot-core/src/builtin/mod.rs

@@ -42,7 +42,6 @@ pub use basis::*;
 pub use callable::*;
 pub use color::*;
 pub use dictionary_inner::Dictionary;
-pub use others::*;
 pub use packed_array::*;
 pub use plane::*;
 pub use projection::*;
@@ -51,6 +50,7 @@ pub use real_inner::*;
 pub use rect2::*;
 pub use rect2i::*;
 pub use rid::*;
+pub use signal::*;
 pub use string::*;
 pub use transform2d::*;
 pub use transform3d::*;
@@ -84,14 +84,14 @@ mod aabb;
 mod basis;
 mod callable;
 mod color;
-mod others;
 mod packed_array;
 mod plane;
 mod projection;
 mod quaternion;
 mod rect2;
 mod rect2i;
 mod rid;
+mod signal;
 mod string;
 mod transform2d;
 mod transform3d;

godot-core/src/builtin/signal.rs

@@ -0,0 +1,210 @@
+/*
+ * Copyright (c) godot-rust; Bromeon and contributors.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+use std::fmt;
+use std::ptr;
+
+use godot_ffi as sys;
+
+use super::meta::{impl_godot_as_self, FromGodot, GodotType};
+use crate::builtin::meta::ToGodot;
+use crate::builtin::{inner, Array, Callable, Dictionary, StringName, Variant};
+use crate::engine::{global::Error, Object};
+use crate::obj::bounds::DynMemory;
+use crate::obj::{Bounds, Gd, GodotClass, InstanceId};
+use sys::{ffi_methods, GodotFfi};
+
+/// A `Signal` represents a signal of an Object instance in Godot.
+///
+/// Signals are composed of a reference to an `Object` and the name of the signal on this object.
+#[repr(C, align(8))]
+pub struct Signal {
+    opaque: sys::types::OpaqueSignal,
+}
+
+impl Signal {
+    fn from_opaque(opaque: sys::types::OpaqueSignal) -> Self {
+        Self { opaque }
+    }
+
+    /// Create a signal for the signal `object::signal_name`.
+    ///
+    /// _Godot equivalent: `Signal(Object object, StringName signal)`_
+    pub fn from_object_signal<T, S>(object: &Gd<T>, signal_name: S) -> Self
+    where
+        T: GodotClass,
+        S: Into<StringName>,
+    {
+        let signal_name = signal_name.into();
+        unsafe {
+            sys::from_sys_init_or_init_default::<Self>(|self_ptr| {
+                let ctor = sys::builtin_fn!(signal_from_object_signal);
+                let raw = object.to_ffi();
+                let args = [raw.as_arg_ptr(), signal_name.sys_const()];
+                ctor(self_ptr, args.as_ptr());
+            })
+        }
+    }
+
+    /// Creates an invalid/empty signal that is not able to be called.
+    ///
+    /// _Godot equivalent: `Signal()`_
+    pub fn invalid() -> Self {
+        unsafe {
+            Self::from_sys_init(|self_ptr| {
+                let ctor = sys::builtin_fn!(signal_construct_default);
+                ctor(self_ptr, ptr::null_mut())
+            })
+        }
+    }
+
+    /// Connects this signal to the specified callable.
+    ///
+    /// Optional flags can be also added to configure the connection's behavior (see [`ConnectFlags`](crate::engine::object::ConnectFlags) constants).
+    /// You can provide additional arguments to the connected callable by using `Callable::bind`.
+    ///
+    /// A signal can only be connected once to the same [`Callable`]. If the signal is already connected,
+    /// returns [`Error::ERR_INVALID_PARAMETER`] and
+    /// pushes an error message, unless the signal is connected with [`ConnectFlags::REFERENCE_COUNTED`](crate::engine::object::ConnectFlags::REFERENCE_COUNTED).
+    /// To prevent this, use [`Self::is_connected`] first to check for existing connections.
+    pub fn connect(&self, callable: Callable, flags: i64) -> Error {
+        let error = self.as_inner().connect(callable, flags);
+
+        Error::from_godot(error as i32)
+    }
+
+    /// Disconnects this signal from the specified [`Callable`].
+    ///
+    /// If the connection does not exist, generates an error. Use [`Self::is_connected`] to make sure that the connection exists.
+    pub fn disconnect(&self, callable: Callable) {
+        self.as_inner().disconnect(callable);
+    }
+
+    /// Emits this signal.
+    ///
+    /// All Callables connected to this signal will be triggered.
+    pub fn emit(&self, varargs: &[Variant]) {
+        let Some(mut object) = self.object() else {
+            return;
+        };
+
+        object.emit_signal(self.name(), varargs);
+    }
+
+    /// Returns an [`Array`] of connections for this signal.
+    ///
+    /// Each connection is represented as a Dictionary that contains three entries:
+    ///  - `signal` is a reference to this [`Signal`];
+    ///  - `callable` is a reference to the connected [`Callable`];
+    ///  - `flags` is a combination of [`ConnectFlags`](crate::engine::object::ConnectFlags).
+    ///
+    /// _Godot equivalent: `get_connections`_
+    pub fn connections(&self) -> Array<Dictionary> {
+        self.as_inner()
+            .get_connections()
+            .iter_shared()
+            .map(|variant| variant.to())
+            .collect()
+    }
+
+    /// Returns the name of the signal.
+    pub fn name(&self) -> StringName {
+        self.as_inner().get_name()
+    }
+
+    /// Returns the object to which this signal belongs.
+    ///
+    /// Returns [`None`] when this signal doesn't have any object.
+    ///
+    /// _Godot equivalent: `get_object`_
+    pub fn object(&self) -> Option<Gd<Object>> {
+        self.as_inner().get_object().map(|mut object| {
+            <Object as Bounds>::DynMemory::maybe_inc_ref(&mut object.raw);
+            object
+        })
+    }
+
+    /// Returns the ID of this signal's object, see also [`Gd::instance_id`].
+    ///
+    /// Returns [`None`] when this signal doesn't have any object.
+    ///
+    /// _Godot equivalent: `get_object_id`_
+    pub fn object_id(&self) -> Option<InstanceId> {
+        let id = self.as_inner().get_object_id();
+        InstanceId::try_from_i64(id)
+    }
+
+    /// Returns `true` if the specified [`Callable`] is connected to this signal.
+    pub fn is_connected(&self, callable: Callable) -> bool {
+        self.as_inner().is_connected(callable)
+    }
+
+    /// Returns `true` if the signal's name does not exist in its object, or the object is not valid.
+    pub fn is_null(&self) -> bool {
+        self.as_inner().is_null()
+    }
+
+    #[doc(hidden)]
+    pub fn as_inner(&self) -> inner::InnerSignal {
+        inner::InnerSignal::from_outer(self)
+    }
+}
+
+// SAFETY:
+// The `opaque` in `Signal` is just a pair of pointers, and requires no special initialization or cleanup
+// beyond what is done in `from_opaque` and `drop`. So using `*mut Opaque` is safe.
+unsafe impl GodotFfi for Signal {
+    fn variant_type() -> sys::VariantType {
+        sys::VariantType::Signal
+    }
+
+    ffi_methods! { type sys::GDExtensionTypePtr = *mut Opaque;
+        fn from_sys;
+        fn sys;
+        fn from_sys_init;
+        fn move_return_ptr;
+    }
+
+    unsafe fn from_arg_ptr(ptr: sys::GDExtensionTypePtr, _call_type: sys::PtrcallType) -> Self {
+        Self::from_sys(ptr)
+    }
+
+    #[cfg(before_api = "4.1")]
+    unsafe fn from_sys_init_default(init_fn: impl FnOnce(sys::GDExtensionTypePtr)) -> Self {
+        let mut result = Self::invalid();
+        init_fn(result.sys_mut());
+        result
+    }
+}
+
+impl_builtin_traits! {
+    for Signal {
+        Clone => signal_construct_copy;
+        Drop => signal_destroy;
+        PartialEq => signal_operator_equal;
+    }
+}
+
+impl_godot_as_self!(Signal);
+
+impl fmt::Debug for Signal {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let name = self.name();
+        let object = self.object();
+
+        f.debug_struct("signal")
+            .field("name", &name)
+            .field("object", &object)
+            .finish()
+    }
+}
+
+impl fmt::Display for Signal {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{}", self.to_variant())
+    }
+}

godot-core/src/property.rs

@@ -431,9 +431,10 @@ mod export_impls {
     impl_property_by_clone!(u16 => Int; int);
     impl_property_by_clone!(u8 => Int; int);
 
-    // Callables are useless when exported to the editor, so we only need to make them available as
+    // Callables and Signals are useless when exported to the editor, so we only need to make them available as
     // properties.
     impl_property_by_clone!(Callable => Callable, no_export);
+    impl_property_by_clone!(Signal => Signal, no_export);
 
     // RIDs when exported act slightly weird. They are largely read-only, however you can reset them to their
     // default value. This seems to me very unintuitive. Since if we are storing an RID we would likely not

itest/rust/build.rs

@@ -127,6 +127,7 @@ fn collect_inputs() -> Vec<Input> {
     push!(inputs; Vector3i, Vector3i, Vector3i(-1, -2147483648, 2147483647), Vector3i::new(-1, -2147483648, 2147483647));
     push!(inputs; Vector4i, Vector4i, Vector4i(-1, -2147483648, 2147483647, 1000), Vector4i::new(-1, -2147483648, 2147483647, 100));
     pushs!(inputs; Callable, Callable, "Callable()", Callable::invalid(), true, false, Some(quote! { Callable::invalid() }));
+    pushs!(inputs; Signal, Signal, "Signal()", Signal::invalid(), true, false, Some(quote! { Signal::invalid() }));
     push!(inputs; Rect2, Rect2, Rect2(), Rect2::default());
     push!(inputs; Rect2i, Rect2i, Rect2i(), Rect2i::default());
     push!(inputs; Transform2D, Transform2D, Transform2D(), Transform2D::default());