|
| 1 | +/* |
| 2 | + * Copyright (c) godot-rust; Bromeon and contributors. |
| 3 | + * This Source Code Form is subject to the terms of the Mozilla Public |
| 4 | + * License, v. 2.0. If a copy of the MPL was not distributed with this |
| 5 | + * file, You can obtain one at https://mozilla.org/MPL/2.0/. |
| 6 | + */ |
| 7 | + |
| 8 | +use std::ops::Deref; |
| 9 | + |
| 10 | +use godot::builtin::{Callable, Signal, Variant}; |
| 11 | +use godot::classes::{Object, RefCounted}; |
| 12 | +use godot::meta::ToGodot; |
| 13 | +use godot::obj::{Base, Gd, NewAlloc, NewGd}; |
| 14 | +use godot::prelude::{godot_api, GodotClass}; |
| 15 | +use godot::task::{self, SignalFuture, SignalFutureResolver, TaskHandle}; |
| 16 | + |
| 17 | +use crate::framework::{itest, TestContext}; |
| 18 | + |
| 19 | +#[derive(GodotClass)] |
| 20 | +#[class(init)] |
| 21 | +struct AsyncRefCounted { |
| 22 | + base: Base<RefCounted>, |
| 23 | +} |
| 24 | + |
| 25 | +#[godot_api] |
| 26 | +impl AsyncRefCounted { |
| 27 | + #[signal] |
| 28 | + fn custom_signal(value: u32); |
| 29 | +} |
| 30 | + |
| 31 | +#[itest(async)] |
| 32 | +fn start_async_task() -> TaskHandle { |
| 33 | + let mut object = RefCounted::new_gd(); |
| 34 | + let object_ref = object.clone(); |
| 35 | + let signal = Signal::from_object_signal(&object, "custom_signal"); |
| 36 | + |
| 37 | + object.add_user_signal("custom_signal"); |
| 38 | + |
| 39 | + let task_handle = task::spawn(async move { |
| 40 | + let signal_future: SignalFuture<(u8,)> = signal.to_future(); |
| 41 | + let (result,) = signal_future.await; |
| 42 | + |
| 43 | + assert_eq!(result, 10); |
| 44 | + drop(object_ref); |
| 45 | + }); |
| 46 | + |
| 47 | + object.emit_signal("custom_signal", &[10.to_variant()]); |
| 48 | + |
| 49 | + task_handle |
| 50 | +} |
| 51 | + |
| 52 | +#[itest] |
| 53 | +fn cancel_async_task(ctx: &TestContext) { |
| 54 | + let tree = ctx.scene_tree.get_tree().unwrap(); |
| 55 | + let signal = Signal::from_object_signal(&tree, "process_frame"); |
| 56 | + |
| 57 | + let handle = task::spawn(async move { |
| 58 | + let _: () = signal.to_future().await; |
| 59 | + |
| 60 | + unreachable!(); |
| 61 | + }); |
| 62 | + |
| 63 | + handle.cancel(); |
| 64 | +} |
| 65 | + |
| 66 | +#[itest(async)] |
| 67 | +fn async_task_fallible_signal_future() -> TaskHandle { |
| 68 | + let mut obj = Object::new_alloc(); |
| 69 | + |
| 70 | + let signal = Signal::from_object_signal(&obj, "script_changed"); |
| 71 | + |
| 72 | + let handle = task::spawn(async move { |
| 73 | + let result = signal.to_fallible_future::<()>().await; |
| 74 | + |
| 75 | + assert!(result.is_err()); |
| 76 | + }); |
| 77 | + |
| 78 | + obj.call_deferred("free", &[]); |
| 79 | + |
| 80 | + handle |
| 81 | +} |
| 82 | + |
| 83 | +// Test that two callables created from the same future resolver (but cloned) are equal, while they are not equal to an unrelated |
| 84 | +// callable. |
| 85 | +#[itest] |
| 86 | +fn resolver_callabable_equality() { |
| 87 | + let resolver = SignalFutureResolver::<(u8,)>::default(); |
| 88 | + |
| 89 | + let callable = Callable::from_custom(resolver.clone()); |
| 90 | + let cloned_callable = Callable::from_custom(resolver.clone()); |
| 91 | + let unrelated_callable = Callable::from_local_fn("unrelated", |_| Ok(Variant::nil())); |
| 92 | + |
| 93 | + assert_eq!(callable, cloned_callable); |
| 94 | + assert_ne!(callable, unrelated_callable); |
| 95 | + assert_ne!(cloned_callable, unrelated_callable); |
| 96 | +} |
| 97 | + |
| 98 | +#[itest(async)] |
| 99 | +fn async_typed_signal() -> TaskHandle { |
| 100 | + let object = AsyncRefCounted::new_gd(); |
| 101 | + let object_ref = object.clone(); |
| 102 | + |
| 103 | + let task_handle = task::spawn(async move { |
| 104 | + let (result,) = object.signals().custom_signal().deref().await; |
| 105 | + |
| 106 | + assert_eq!(result, 66); |
| 107 | + }); |
| 108 | + |
| 109 | + object_ref.signals().custom_signal().emit(66); |
| 110 | + |
| 111 | + task_handle |
| 112 | +} |
0 commit comments