slint/sixtyfps_runtime/corelib/abi/signals.rs
2020-07-13 18:49:06 +02:00

125 lines
3.4 KiB
Rust

/*!
Signal that can be connected to one sigle handler.
TODO: reconsider if we should rename that to `Event`
but then it should also be renamed everywhere, including in the language grammar
*/
use core::cell::Cell;
/// A Signal that can be connected to a handler.
///
/// The Arg represents the argument. It should always be a tuple
///
#[derive(Default)]
#[repr(C)]
pub struct Signal<Arg> {
/// FIXME: Box<dyn> is a fat object and we probaly want to put an erased type in there
handler: Cell<Option<Box<dyn Fn(Arg)>>>,
}
impl<Arg> Signal<Arg> {
/// Emit the signal with the given argument.
pub fn emit(&self, a: Arg) {
if let Some(h) = self.handler.take() {
h(a);
assert!(self.handler.take().is_none(), "Signal Handler set while emitted");
self.handler.set(Some(h))
}
}
/// Set an handler to be called when the signal is emited
///
/// There can only be one single handler per signal.
pub fn set_handler(&self, f: impl Fn(Arg) + 'static) {
self.handler.set(Some(Box::new(f)));
}
}
#[test]
fn signal_simple_test() {
use std::rc::Rc;
#[derive(Default)]
struct Component {
pressed: core::cell::Cell<bool>,
clicked: Signal<()>,
}
let c = Rc::new(Component::default());
let weak = Rc::downgrade(&c);
c.clicked.set_handler(move |()| weak.upgrade().unwrap().pressed.set(true));
c.clicked.emit(());
assert_eq!(c.pressed.get(), true);
}
#[allow(non_camel_case_types)]
type c_void = ();
#[repr(C)]
/// Has the same layout as Signal<()>
pub struct SignalOpaque(*const c_void, *const c_void);
static_assertions::assert_eq_align!(SignalOpaque, Signal<()>);
static_assertions::assert_eq_size!(SignalOpaque, Signal<()>);
/// Initialize the signal.
/// sixtyfps_signal_drop must be called.
#[no_mangle]
pub unsafe extern "C" fn sixtyfps_signal_init(out: *mut SignalOpaque) {
assert_eq!(core::mem::size_of::<SignalOpaque>(), core::mem::size_of::<Signal<()>>());
core::ptr::write(out as *mut Signal<()>, Default::default());
}
/// Emit the signal
#[no_mangle]
pub unsafe extern "C" fn sixtyfps_signal_emit(sig: *const SignalOpaque) {
let sig = &*(sig as *const Signal<()>);
sig.emit(());
}
/// Set signal handler.
///
/// The binding has signature fn(user_data)
#[no_mangle]
pub unsafe extern "C" fn sixtyfps_signal_set_handler(
sig: *mut SignalOpaque,
binding: extern "C" fn(user_data: *mut c_void),
user_data: *mut c_void,
drop_user_data: Option<extern "C" fn(*mut c_void)>,
) {
let sig = &mut *(sig as *mut Signal<()>);
struct UserData {
user_data: *mut c_void,
drop_user_data: Option<extern "C" fn(*mut c_void)>,
}
impl Drop for UserData {
fn drop(&mut self) {
if let Some(x) = self.drop_user_data {
x(self.user_data)
}
}
}
let ud = UserData { user_data, drop_user_data };
let real_binding = move |()| {
binding(ud.user_data);
};
sig.set_handler(real_binding);
}
/// Destroy signal
#[no_mangle]
pub unsafe extern "C" fn sixtyfps_signal_drop(handle: *mut SignalOpaque) {
core::ptr::read(handle as *mut Signal<()>);
}
/// Somehow this is required for the extern "C" things to be exported in a dependent dynlib
#[doc(hidden)]
pub fn dummy() {
#[derive(Clone)]
struct Foo;
foo(Foo);
fn foo(f: impl Clone) {
let _ = f.clone();
}
}