Post task updates to the loop instead of waking it
`WakeTaskQueue` becomes `TaskQueue`, which carries the update itself. Delivery and waking are then one act: the winit host sends it through the `EventLoopProxy` as a `DefaultEvent::Update`, so there is no channel beside the loop and nothing has to claim a redraw is needed in order to be looked at. `Window::request_redraw` is gone from this path; `event` applies the update and then asks the tree whether anything became dirty, which is the same question `window_event` already ended with -- now `schedule_redraw`, called from both. The loop's message type is `DefaultEvent<State>`, so `Proxy` becomes a wrapper that takes the application's own `Event` and requires it to be `Send`, since it now crosses to the task thread by that route. The harness supplies a channel-backed queue, which is what lets a test hold updates until it asks for them. Tests split by subject -- layout, pointer, scroll, tasks -- with the region helper in `tests/common`.
This commit is contained in:
1 parent
e97aba30e0
commit
3a74a04a5b
13 files changed
+266
-302
No files matched your search
+1
-5
@@ -10,11 +10,7 @@ struct State {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl DefaultAppState for State {
|
impl DefaultAppState for State {
|
||||||
fn new(
|
fn new(mut ui_state: DefaultUiState, rsc: &mut DefaultRsc<Self>, _: Proxy<Self>) -> Self {
|
||||||
mut ui_state: DefaultUiState,
|
|
||||||
rsc: &mut DefaultRsc<Self>,
|
|
||||||
_: Proxy<Self::Event>,
|
|
||||||
) -> Self {
|
|
||||||
rect(Color::RED).set_root(rsc, &mut ui_state);
|
rect(Color::RED).set_root(rsc, &mut ui_state);
|
||||||
Self { ui_state }
|
Self { ui_state }
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,11 +15,7 @@ pub struct Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl DefaultAppState for Client {
|
impl DefaultAppState for Client {
|
||||||
fn new(
|
fn new(mut ui_state: DefaultUiState, rsc: &mut DefaultRsc<Self>, _: Proxy<Self>) -> Self {
|
||||||
mut ui_state: DefaultUiState,
|
|
||||||
rsc: &mut DefaultRsc<Self>,
|
|
||||||
_: Proxy<Self::Event>,
|
|
||||||
) -> Self {
|
|
||||||
let rrect = rect(Color::WHITE).radius(20);
|
let rrect = rect(Color::WHITE).radius(20);
|
||||||
let pad_test = (
|
let pad_test = (
|
||||||
rrect.color(Color::BLUE),
|
rrect.color(Color::BLUE),
|
||||||
|
|||||||
+1
-5
@@ -11,11 +11,7 @@ struct State {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl DefaultAppState for State {
|
impl DefaultAppState for State {
|
||||||
fn new(
|
fn new(mut ui_state: DefaultUiState, rsc: &mut DefaultRsc<Self>, _: Proxy<Self>) -> Self {
|
||||||
mut ui_state: DefaultUiState,
|
|
||||||
rsc: &mut DefaultRsc<Self>,
|
|
||||||
_: Proxy<Self::Event>,
|
|
||||||
) -> Self {
|
|
||||||
let rect = rect(Color::RED).add(rsc);
|
let rect = rect(Color::RED).add(rsc);
|
||||||
rect.task_on(CursorSense::click(), async move |mut ctx| {
|
rect.task_on(CursorSense::click(), async move |mut ctx| {
|
||||||
tokio::time::sleep(Duration::from_secs(1)).await;
|
tokio::time::sleep(Duration::from_secs(1)).await;
|
||||||
|
|||||||
+1
-5
@@ -36,11 +36,7 @@ impl Test {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl DefaultAppState for State {
|
impl DefaultAppState for State {
|
||||||
fn new(
|
fn new(mut ui_state: DefaultUiState, rsc: &mut DefaultRsc<Self>, _: Proxy<Self>) -> Self {
|
||||||
mut ui_state: DefaultUiState,
|
|
||||||
rsc: &mut DefaultRsc<Self>,
|
|
||||||
_: Proxy<Self::Event>,
|
|
||||||
) -> Self {
|
|
||||||
let test = Test::new(rsc);
|
let test = Test::new(rsc);
|
||||||
|
|
||||||
test.on(CursorSense::click(), move |_, rsc| {
|
test.on(CursorSense::click(), move |_, rsc| {
|
||||||
|
|||||||
+64
-48
@@ -25,7 +25,37 @@ pub use sense::*;
|
|||||||
pub use state::*;
|
pub use state::*;
|
||||||
pub use task::*;
|
pub use task::*;
|
||||||
|
|
||||||
pub type Proxy<Event> = EventLoopProxy<Event>;
|
/// Sends an application's own events to its event loop. It wraps the proxy
|
||||||
|
/// rather than being one because task updates travel the same way: what an
|
||||||
|
/// application sends is its `Event`, not the loop's whole message type.
|
||||||
|
pub struct Proxy<State: DefaultAppState>(EventLoopProxy<DefaultEvent<State>>);
|
||||||
|
|
||||||
|
impl<State: DefaultAppState> Clone for Proxy<State> {
|
||||||
|
fn clone(&self) -> Self {
|
||||||
|
Self(self.0.clone())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<State: DefaultAppState> Proxy<State> {
|
||||||
|
pub fn send_event(&self, event: State::Event) {
|
||||||
|
let _ = self.0.send_event(DefaultEvent::User(event));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// What the event loop carries: the application's own events, and the
|
||||||
|
/// updates tasks send back to the ui thread.
|
||||||
|
pub enum DefaultEvent<State: DefaultAppState> {
|
||||||
|
User(State::Event),
|
||||||
|
Update(Box<dyn TaskUpdate<DefaultRsc<State>>>),
|
||||||
|
}
|
||||||
|
|
||||||
|
struct ProxyQueue<State: DefaultAppState>(EventLoopProxy<DefaultEvent<State>>);
|
||||||
|
|
||||||
|
impl<State: DefaultAppState> TaskQueue<DefaultRsc<State>> for ProxyQueue<State> {
|
||||||
|
fn send(&self, update: Box<dyn TaskUpdate<DefaultRsc<State>>>) {
|
||||||
|
let _ = self.0.send_event(DefaultEvent::Update(update));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub struct DefaultUiState {
|
pub struct DefaultUiState {
|
||||||
pub root: Option<StrongWidget>,
|
pub root: Option<StrongWidget>,
|
||||||
@@ -60,21 +90,14 @@ impl DefaultUiState {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WakeTaskQueue for Window {
|
|
||||||
fn wake(&self) {
|
|
||||||
self.request_redraw();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait HasDefaultUiState: Sized + 'static {
|
pub trait HasDefaultUiState: Sized + 'static {
|
||||||
fn default_state(&self) -> &DefaultUiState;
|
fn default_state(&self) -> &DefaultUiState;
|
||||||
fn default_state_mut(&mut self) -> &mut DefaultUiState;
|
fn default_state_mut(&mut self) -> &mut DefaultUiState;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait DefaultAppState: HasDefaultUiState {
|
pub trait DefaultAppState: HasDefaultUiState {
|
||||||
type Event = ();
|
type Event: Send = ();
|
||||||
fn new(ui_state: DefaultUiState, rsc: &mut DefaultRsc<Self>, proxy: Proxy<Self::Event>)
|
fn new(ui_state: DefaultUiState, rsc: &mut DefaultRsc<Self>, proxy: Proxy<Self>) -> Self;
|
||||||
-> Self;
|
|
||||||
#[allow(unused_variables)]
|
#[allow(unused_variables)]
|
||||||
fn event(
|
fn event(
|
||||||
&mut self,
|
&mut self,
|
||||||
@@ -107,18 +130,14 @@ pub struct DefaultRsc<State: 'static> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<State> DefaultRsc<State> {
|
impl<State> DefaultRsc<State> {
|
||||||
pub fn init(wake: Arc<dyn WakeTaskQueue>) -> (Self, TaskMsgReceiver<Self>) {
|
pub fn init(queue: Arc<dyn TaskQueue<Self>>) -> Self {
|
||||||
let (tasks, recv) = Tasks::init(wake);
|
Self {
|
||||||
(
|
ui: Default::default(),
|
||||||
Self {
|
events: Default::default(),
|
||||||
ui: Default::default(),
|
tasks: Tasks::init(queue),
|
||||||
events: Default::default(),
|
state: Default::default(),
|
||||||
tasks,
|
_state: Default::default(),
|
||||||
state: Default::default(),
|
}
|
||||||
_state: Default::default(),
|
|
||||||
},
|
|
||||||
recv,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn create_state<T: 'static>(&mut self, id: impl IdLike, data: T) -> WeakState<T> {
|
pub fn create_state<T: 'static>(&mut self, id: impl IdLike, data: T) -> WeakState<T> {
|
||||||
@@ -183,43 +202,34 @@ pub struct DefaultApp<State: DefaultAppState> {
|
|||||||
rsc: DefaultRsc<State>,
|
rsc: DefaultRsc<State>,
|
||||||
render: UiRenderState,
|
render: UiRenderState,
|
||||||
state: State,
|
state: State,
|
||||||
task_recv: TaskMsgReceiver<DefaultRsc<State>>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<State: DefaultAppState> AppState for DefaultApp<State> {
|
impl<State: DefaultAppState> AppState for DefaultApp<State> {
|
||||||
type Event = State::Event;
|
type Event = DefaultEvent<State>;
|
||||||
|
|
||||||
fn new(event_loop: &ActiveEventLoop, proxy: EventLoopProxy<Self::Event>) -> Self {
|
fn new(event_loop: &ActiveEventLoop, proxy: EventLoopProxy<Self::Event>) -> Self {
|
||||||
let window = event_loop
|
let window = event_loop
|
||||||
.create_window(State::window_attributes())
|
.create_window(State::window_attributes())
|
||||||
.unwrap();
|
.unwrap();
|
||||||
let default_state = DefaultUiState::new(window);
|
let default_state = DefaultUiState::new(window);
|
||||||
let (mut rsc, task_recv) = DefaultRsc::init(default_state.window.clone());
|
let mut rsc = DefaultRsc::init(Arc::new(ProxyQueue(proxy.clone())));
|
||||||
let state = State::new(default_state, &mut rsc, proxy);
|
let state = State::new(default_state, &mut rsc, Proxy(proxy));
|
||||||
let render = UiRenderState::new();
|
let render = UiRenderState::new();
|
||||||
Self {
|
Self { rsc, state, render }
|
||||||
rsc,
|
|
||||||
state,
|
|
||||||
render,
|
|
||||||
task_recv,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn event(&mut self, event: Self::Event, _: &ActiveEventLoop) {
|
fn event(&mut self, event: Self::Event, _: &ActiveEventLoop) {
|
||||||
self.state.event(event, &mut self.rsc, &mut self.render);
|
match event {
|
||||||
|
DefaultEvent::User(event) => self.state.event(event, &mut self.rsc, &mut self.render),
|
||||||
|
DefaultEvent::Update(update) => update(&mut self.state, &mut self.rsc),
|
||||||
|
}
|
||||||
|
// An update is not a reason to draw; whether it made anything dirty
|
||||||
|
// is. That is why a task posts here rather than asking for a redraw.
|
||||||
|
self.schedule_redraw();
|
||||||
}
|
}
|
||||||
|
|
||||||
fn window_event(&mut self, event: WindowEvent, event_loop: &ActiveEventLoop) {
|
fn window_event(&mut self, event: WindowEvent, event_loop: &ActiveEventLoop) {
|
||||||
let Self {
|
let Self { rsc, render, state } = self;
|
||||||
rsc,
|
|
||||||
render,
|
|
||||||
state,
|
|
||||||
task_recv,
|
|
||||||
} = self;
|
|
||||||
|
|
||||||
for update in task_recv.try_iter() {
|
|
||||||
update(state, rsc);
|
|
||||||
}
|
|
||||||
|
|
||||||
let ui_state = state.default_state_mut();
|
let ui_state = state.default_state_mut();
|
||||||
let input_changed = ui_state.input.event(&event);
|
let input_changed = ui_state.input.event(&event);
|
||||||
@@ -299,11 +309,8 @@ impl<State: DefaultAppState> AppState for DefaultApp<State> {
|
|||||||
_ => (),
|
_ => (),
|
||||||
}
|
}
|
||||||
state.window_event(event, rsc, render);
|
state.window_event(event, rsc, render);
|
||||||
let ui_state = self.state.default_state_mut();
|
self.schedule_redraw();
|
||||||
if render.needs_redraw(&ui_state.root, rsc.widgets()) {
|
self.state.default_state_mut().input.end_frame();
|
||||||
ui_state.renderer.window().request_redraw();
|
|
||||||
}
|
|
||||||
ui_state.input.end_frame();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn exit(&mut self) {
|
fn exit(&mut self) {
|
||||||
@@ -311,6 +318,15 @@ impl<State: DefaultAppState> AppState for DefaultApp<State> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<State: DefaultAppState> DefaultApp<State> {
|
||||||
|
fn schedule_redraw(&mut self) {
|
||||||
|
let ui_state = self.state.default_state_mut();
|
||||||
|
if self.render.needs_redraw(&ui_state.root, self.rsc.widgets()) {
|
||||||
|
ui_state.renderer.window().request_redraw();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub trait RscIdx<Rsc> {
|
pub trait RscIdx<Rsc> {
|
||||||
type Output;
|
type Output;
|
||||||
fn get(self, rsc: &Rsc) -> &Self::Output;
|
fn get(self, rsc: &Rsc) -> &Self::Output;
|
||||||
|
|||||||
+16
-87
@@ -1,11 +1,5 @@
|
|||||||
use iris_core::HasState;
|
use iris_core::HasState;
|
||||||
use std::{
|
use std::{pin::Pin, sync::Arc};
|
||||||
pin::Pin,
|
|
||||||
sync::{
|
|
||||||
Arc,
|
|
||||||
mpsc::{Receiver as SyncReceiver, Sender as SyncSender, channel as sync_channel},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
use tokio::{
|
use tokio::{
|
||||||
runtime::Runtime,
|
runtime::Runtime,
|
||||||
sync::mpsc::{
|
sync::mpsc::{
|
||||||
@@ -14,71 +8,51 @@ use tokio::{
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Wakes the host so it applies queued task updates. A task reaches the
|
|
||||||
/// application only through [`TaskCtx::update`], so this is all the queue
|
|
||||||
/// needs of a platform.
|
|
||||||
pub trait WakeTaskQueue: Send + Sync + 'static {
|
|
||||||
fn wake(&self);
|
|
||||||
}
|
|
||||||
|
|
||||||
pub type TaskMsgSender<Rsc> = SyncSender<Box<dyn TaskUpdate<Rsc>>>;
|
|
||||||
pub type TaskMsgReceiver<Rsc> = SyncReceiver<Box<dyn TaskUpdate<Rsc>>>;
|
|
||||||
|
|
||||||
pub trait TaskUpdate<Rsc: HasState>: FnOnce(&mut Rsc::State, &mut Rsc) + Send {}
|
pub trait TaskUpdate<Rsc: HasState>: FnOnce(&mut Rsc::State, &mut Rsc) + Send {}
|
||||||
impl<F: FnOnce(&mut Rsc::State, &mut Rsc) + Send, Rsc: HasState> TaskUpdate<Rsc> for F {}
|
impl<F: FnOnce(&mut Rsc::State, &mut Rsc) + Send, Rsc: HasState> TaskUpdate<Rsc> for F {}
|
||||||
|
|
||||||
|
/// Hands an update from a task to the thread that owns the ui. Delivery and
|
||||||
|
/// waking are one act: a host posts the update as a message its loop already
|
||||||
|
/// carries -- winit's `EventLoopProxy`, Android's looper -- so nothing has to
|
||||||
|
/// wake the loop separately, or claim a redraw to be looked at.
|
||||||
|
pub trait TaskQueue<Rsc: HasState>: Send + Sync + 'static {
|
||||||
|
fn send(&self, update: Box<dyn TaskUpdate<Rsc>>);
|
||||||
|
}
|
||||||
|
|
||||||
pub struct Tasks<Rsc: HasState> {
|
pub struct Tasks<Rsc: HasState> {
|
||||||
start: AsyncSender<BoxTask>,
|
start: AsyncSender<BoxTask>,
|
||||||
wake: Arc<dyn WakeTaskQueue>,
|
queue: Arc<dyn TaskQueue<Rsc>>,
|
||||||
msg_send: SyncSender<Box<dyn TaskUpdate<Rsc>>>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct TaskCtx<Rsc: HasState> {
|
pub struct TaskCtx<Rsc: HasState> {
|
||||||
send: TaskMsgSender<Rsc>,
|
queue: Arc<dyn TaskQueue<Rsc>>,
|
||||||
wake: Arc<dyn WakeTaskQueue>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<Rsc: HasState> TaskCtx<Rsc> {
|
impl<Rsc: HasState> TaskCtx<Rsc> {
|
||||||
pub fn update(&mut self, f: impl TaskUpdate<Rsc> + 'static) {
|
pub fn update(&mut self, f: impl TaskUpdate<Rsc> + 'static) {
|
||||||
if self.send.send(Box::new(f)).is_ok() {
|
self.queue.send(Box::new(f));
|
||||||
self.wake.wake();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
impl<Rsc: HasState + 'static> TaskCtx<Rsc> {
|
|
||||||
fn new(send: TaskMsgSender<Rsc>, wake: Arc<dyn WakeTaskQueue>) -> Self {
|
|
||||||
Self { send, wake }
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type BoxTask = Pin<Box<dyn Future<Output = ()> + Send>>;
|
type BoxTask = Pin<Box<dyn Future<Output = ()> + Send>>;
|
||||||
|
|
||||||
impl<Rsc: HasState> Tasks<Rsc> {
|
impl<Rsc: HasState> Tasks<Rsc> {
|
||||||
pub fn init(wake: Arc<dyn WakeTaskQueue>) -> (Self, TaskMsgReceiver<Rsc>) {
|
pub fn init(queue: Arc<dyn TaskQueue<Rsc>>) -> Self {
|
||||||
let (start, start_recv) = async_channel();
|
let (start, start_recv) = async_channel();
|
||||||
let (msgs, msgs_recv) = sync_channel();
|
|
||||||
std::thread::spawn(|| {
|
std::thread::spawn(|| {
|
||||||
let rt = Runtime::new().unwrap();
|
let rt = Runtime::new().unwrap();
|
||||||
rt.block_on(listen(start_recv))
|
rt.block_on(listen(start_recv))
|
||||||
});
|
});
|
||||||
(
|
Self { start, queue }
|
||||||
Self {
|
|
||||||
start,
|
|
||||||
msg_send: msgs,
|
|
||||||
wake,
|
|
||||||
},
|
|
||||||
msgs_recv,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn spawn<F: AsyncFnOnce(TaskCtx<Rsc>) + 'static + std::marker::Send>(&mut self, task: F)
|
pub fn spawn<F: AsyncFnOnce(TaskCtx<Rsc>) + 'static + std::marker::Send>(&mut self, task: F)
|
||||||
where
|
where
|
||||||
F::CallOnceFuture: Send,
|
F::CallOnceFuture: Send,
|
||||||
{
|
{
|
||||||
let send = self.msg_send.clone();
|
let queue = self.queue.clone();
|
||||||
let wake = self.wake.clone();
|
|
||||||
let _ = self.start.send(Box::pin(async move {
|
let _ = self.start.send(Box::pin(async move {
|
||||||
task(TaskCtx::new(send, wake)).await;
|
task(TaskCtx { queue }).await;
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -88,48 +62,3 @@ async fn listen(mut recv: AsyncReceiver<BoxTask>) {
|
|||||||
tokio::spawn(task);
|
tokio::spawn(task);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
use std::{sync::mpsc::sync_channel, time::Duration};
|
|
||||||
|
|
||||||
struct TestRsc;
|
|
||||||
|
|
||||||
impl HasState for TestRsc {
|
|
||||||
type State = usize;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Signals rather than counts, so the test waits for a wake instead of
|
|
||||||
/// racing the task thread to sample it.
|
|
||||||
struct WakeSignal(std::sync::mpsc::SyncSender<()>);
|
|
||||||
|
|
||||||
impl WakeTaskQueue for WakeSignal {
|
|
||||||
fn wake(&self) {
|
|
||||||
let _ = self.0.send(());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn every_update_wakes_the_host() {
|
|
||||||
let (woken, wakes) = sync_channel(8);
|
|
||||||
let (mut tasks, updates) = Tasks::<TestRsc>::init(Arc::new(WakeSignal(woken)));
|
|
||||||
|
|
||||||
tasks.spawn(async move |mut ctx| {
|
|
||||||
ctx.update(|state: &mut usize, _| *state += 1);
|
|
||||||
ctx.update(|state: &mut usize, _| *state += 2);
|
|
||||||
});
|
|
||||||
|
|
||||||
let second = Duration::from_secs(1);
|
|
||||||
let (mut state, mut rsc) = (0, TestRsc);
|
|
||||||
for _ in 0..2 {
|
|
||||||
wakes.recv_timeout(second).expect("no wake for an update");
|
|
||||||
updates.recv_timeout(second).unwrap()(&mut state, &mut rsc);
|
|
||||||
}
|
|
||||||
assert_eq!(state, 3);
|
|
||||||
assert!(
|
|
||||||
wakes.recv_timeout(Duration::from_millis(100)).is_err(),
|
|
||||||
"woken with nothing to apply"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+20
-7
@@ -4,13 +4,22 @@
|
|||||||
//! It does not draw. A claim about pixels still needs a real surface.
|
//! It does not draw. A claim about pixels still needs a real surface.
|
||||||
|
|
||||||
use crate::prelude::*;
|
use crate::prelude::*;
|
||||||
use std::{sync::Arc, time::Duration};
|
use std::{
|
||||||
|
sync::{
|
||||||
|
Arc,
|
||||||
|
mpsc::{Receiver, SyncSender, sync_channel},
|
||||||
|
},
|
||||||
|
time::Duration,
|
||||||
|
};
|
||||||
|
|
||||||
/// The harness drains the update queue itself, so there is no loop to wake.
|
/// There is no loop here to post to, so updates queue until the test asks
|
||||||
struct NoWake;
|
/// for them.
|
||||||
|
struct Queue(SyncSender<Box<dyn TaskUpdate<DefaultRsc<HarnessState>>>>);
|
||||||
|
|
||||||
impl WakeTaskQueue for NoWake {
|
impl TaskQueue<DefaultRsc<HarnessState>> for Queue {
|
||||||
fn wake(&self) {}
|
fn send(&self, update: Box<dyn TaskUpdate<DefaultRsc<HarnessState>>>) {
|
||||||
|
let _ = self.0.send(update);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Default)]
|
#[derive(Default)]
|
||||||
@@ -28,14 +37,18 @@ pub struct Harness {
|
|||||||
pub rsc: DefaultRsc<HarnessState>,
|
pub rsc: DefaultRsc<HarnessState>,
|
||||||
pub render: UiRenderState,
|
pub render: UiRenderState,
|
||||||
pub state: HarnessState,
|
pub state: HarnessState,
|
||||||
updates: TaskMsgReceiver<DefaultRsc<HarnessState>>,
|
updates: Receiver<Box<dyn TaskUpdate<DefaultRsc<HarnessState>>>>,
|
||||||
cursor: CursorState,
|
cursor: CursorState,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Harness {
|
impl Harness {
|
||||||
/// `size` is the output in physical pixels.
|
/// `size` is the output in physical pixels.
|
||||||
pub fn new(size: impl Into<Vec2>) -> Self {
|
pub fn new(size: impl Into<Vec2>) -> Self {
|
||||||
let (rsc, updates) = DefaultRsc::init(Arc::new(NoWake));
|
// A `TaskQueue` must be `Sync`, which `mpsc::Sender` is not; the
|
||||||
|
// bound that comes with `SyncSender` is far past anything a test
|
||||||
|
// leaves unread.
|
||||||
|
let (send, updates) = sync_channel(1024);
|
||||||
|
let rsc = DefaultRsc::init(Arc::new(Queue(send)));
|
||||||
let mut render = UiRenderState::new();
|
let mut render = UiRenderState::new();
|
||||||
render.resize(size);
|
render.resize(size);
|
||||||
Self {
|
Self {
|
||||||
|
|||||||
@@ -0,0 +1,13 @@
|
|||||||
|
use iris::harness::Harness;
|
||||||
|
use iris::prelude::*;
|
||||||
|
|
||||||
|
/// `PixelRegion` neither compares nor prints.
|
||||||
|
pub fn corners(h: &Harness, id: &impl IdLike) -> (f32, f32, f32, f32) {
|
||||||
|
let region = h.region(id).expect("widget drew nothing");
|
||||||
|
(
|
||||||
|
region.top_left.x,
|
||||||
|
region.top_left.y,
|
||||||
|
region.bot_right.x,
|
||||||
|
region.bot_right.y,
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -1,140 +0,0 @@
|
|||||||
//! Layout, hit testing and task updates, driven without a window.
|
|
||||||
|
|
||||||
use std::{cell::RefCell, rc::Rc, time::Duration};
|
|
||||||
|
|
||||||
use iris::harness::Harness;
|
|
||||||
use iris::prelude::*;
|
|
||||||
|
|
||||||
/// `PixelRegion` neither compares nor prints.
|
|
||||||
fn corners(h: &Harness, id: &impl IdLike) -> (f32, f32, f32, f32) {
|
|
||||||
let region = h.region(id).expect("widget drew nothing");
|
|
||||||
(
|
|
||||||
region.top_left.x,
|
|
||||||
region.top_left.y,
|
|
||||||
region.bot_right.x,
|
|
||||||
region.bot_right.y,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A fixed 100 wide, and the rest of the 400 to its neighbour.
|
|
||||||
fn two_rects(h: &mut Harness) -> (WidgetId, WidgetId) {
|
|
||||||
let left = rect(Color::RED).width(100).add(&mut h.rsc);
|
|
||||||
let right = rect(Color::BLUE).add(&mut h.rsc);
|
|
||||||
h.set_root((left, right).span(Dir::RIGHT));
|
|
||||||
(left.id(), right.id())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_span_gives_each_child_the_width_it_asked_for() {
|
|
||||||
let mut h = Harness::new((400, 200));
|
|
||||||
let (left, right) = two_rects(&mut h);
|
|
||||||
|
|
||||||
assert_eq!(corners(&h, &left), (0.0, 0.0, 100.0, 200.0));
|
|
||||||
assert_eq!(corners(&h, &right), (100.0, 0.0, 400.0, 200.0));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn resizing_relays_out_against_the_new_output() {
|
|
||||||
let mut h = Harness::new((400, 200));
|
|
||||||
let (left, right) = two_rects(&mut h);
|
|
||||||
|
|
||||||
h.resize((800, 100));
|
|
||||||
assert!(h.needs_redraw());
|
|
||||||
h.frame();
|
|
||||||
|
|
||||||
assert_eq!(corners(&h, &left), (0.0, 0.0, 100.0, 100.0));
|
|
||||||
assert_eq!(corners(&h, &right), (100.0, 0.0, 800.0, 100.0));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_press_reaches_only_the_widget_under_the_cursor() {
|
|
||||||
let mut h = Harness::new((400, 200));
|
|
||||||
let clicks = Rc::new(RefCell::new(Vec::new()));
|
|
||||||
|
|
||||||
let (on_left, on_right) = (clicks.clone(), clicks.clone());
|
|
||||||
let left = rect(Color::RED)
|
|
||||||
.width(100)
|
|
||||||
.on(CursorSense::click(), move |_, _| {
|
|
||||||
on_left.borrow_mut().push("left")
|
|
||||||
})
|
|
||||||
.add(&mut h.rsc);
|
|
||||||
let right = rect(Color::BLUE)
|
|
||||||
.on(CursorSense::click(), move |_, _| {
|
|
||||||
on_right.borrow_mut().push("right")
|
|
||||||
})
|
|
||||||
.add(&mut h.rsc);
|
|
||||||
h.set_root((left, right).span(Dir::RIGHT));
|
|
||||||
|
|
||||||
h.click((50, 100));
|
|
||||||
assert_eq!(*clicks.borrow(), ["left"]);
|
|
||||||
|
|
||||||
h.click((300, 100));
|
|
||||||
assert_eq!(*clicks.borrow(), ["left", "right"]);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn hover_ends_when_the_cursor_leaves_the_window() {
|
|
||||||
let mut h = Harness::new((400, 200));
|
|
||||||
let hovered = Rc::new(RefCell::new(0));
|
|
||||||
let ended = Rc::new(RefCell::new(0));
|
|
||||||
|
|
||||||
let (h_count, e_count) = (hovered.clone(), ended.clone());
|
|
||||||
let widget = rect(Color::RED)
|
|
||||||
.on(CursorSense::HoverStart, move |_, _| {
|
|
||||||
*h_count.borrow_mut() += 1
|
|
||||||
})
|
|
||||||
.on(CursorSense::HoverEnd, move |_, _| {
|
|
||||||
*e_count.borrow_mut() += 1
|
|
||||||
})
|
|
||||||
.add(&mut h.rsc);
|
|
||||||
h.set_root(widget);
|
|
||||||
|
|
||||||
h.move_to((200, 100));
|
|
||||||
assert_eq!((*hovered.borrow(), *ended.borrow()), (1, 0));
|
|
||||||
|
|
||||||
// A second sample inside the same widget is not a second hover.
|
|
||||||
h.move_to((210, 100));
|
|
||||||
assert_eq!((*hovered.borrow(), *ended.borrow()), (1, 0));
|
|
||||||
|
|
||||||
h.leave();
|
|
||||||
assert_eq!((*hovered.borrow(), *ended.borrow()), (1, 1));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_task_update_reaches_the_tree() {
|
|
||||||
let mut h = Harness::new((400, 200));
|
|
||||||
let widget = rect(Color::RED).add(&mut h.rsc);
|
|
||||||
h.set_root(widget.task_on(CursorSense::click(), async move |mut ctx| {
|
|
||||||
ctx.update(move |_, rsc| widget(rsc).color = Color::BLUE);
|
|
||||||
}));
|
|
||||||
|
|
||||||
h.click((200, 100));
|
|
||||||
|
|
||||||
assert!(
|
|
||||||
h.await_update(Duration::from_secs(5)),
|
|
||||||
"the task sent no update"
|
|
||||||
);
|
|
||||||
assert_eq!(h.rsc[widget].color, Color::BLUE);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn a_wheel_scrolls_the_content_and_stops_at_its_end() {
|
|
||||||
let mut h = Harness::new((400, 200));
|
|
||||||
// Twice the window's height, so there is 200 to scroll.
|
|
||||||
let top = rect(Color::RED).height(200).add(&mut h.rsc);
|
|
||||||
let bottom = rect(Color::BLUE).height(200).add(&mut h.rsc);
|
|
||||||
h.set_root((top, bottom).span(Dir::DOWN).scrollable());
|
|
||||||
h.move_to((200, 100));
|
|
||||||
|
|
||||||
// `Scroll` starts snapped to the end.
|
|
||||||
assert_eq!(corners(&h, &top).1, -200.0);
|
|
||||||
|
|
||||||
// The handler scales a wheel line by 50.
|
|
||||||
h.scroll((0, 1));
|
|
||||||
h.frame();
|
|
||||||
assert_eq!(corners(&h, &top).1, -150.0);
|
|
||||||
|
|
||||||
h.scroll((0, 10));
|
|
||||||
h.frame();
|
|
||||||
assert_eq!(corners(&h, &top).1, 0.0);
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
//! Where a frame puts things, with no window to put them in.
|
||||||
|
|
||||||
|
mod common;
|
||||||
|
|
||||||
|
use common::corners;
|
||||||
|
use iris::harness::Harness;
|
||||||
|
use iris::prelude::*;
|
||||||
|
|
||||||
|
/// A fixed 100 wide, and the rest of the 400 to its neighbour.
|
||||||
|
fn two_rects(h: &mut Harness) -> (WidgetId, WidgetId) {
|
||||||
|
let left = rect(Color::RED).width(100).add(&mut h.rsc);
|
||||||
|
let right = rect(Color::BLUE).add(&mut h.rsc);
|
||||||
|
h.set_root((left, right).span(Dir::RIGHT));
|
||||||
|
(left.id(), right.id())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_span_gives_each_child_the_width_it_asked_for() {
|
||||||
|
let mut h = Harness::new((400, 200));
|
||||||
|
let (left, right) = two_rects(&mut h);
|
||||||
|
|
||||||
|
assert_eq!(corners(&h, &left), (0.0, 0.0, 100.0, 200.0));
|
||||||
|
assert_eq!(corners(&h, &right), (100.0, 0.0, 400.0, 200.0));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resizing_relays_out_against_the_new_output() {
|
||||||
|
let mut h = Harness::new((400, 200));
|
||||||
|
let (left, right) = two_rects(&mut h);
|
||||||
|
|
||||||
|
h.resize((800, 100));
|
||||||
|
assert!(h.needs_redraw());
|
||||||
|
h.frame();
|
||||||
|
|
||||||
|
assert_eq!(corners(&h, &left), (0.0, 0.0, 100.0, 100.0));
|
||||||
|
assert_eq!(corners(&h, &right), (100.0, 0.0, 800.0, 100.0));
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
//! Which widget an input reaches.
|
||||||
|
|
||||||
|
use std::{cell::RefCell, rc::Rc};
|
||||||
|
|
||||||
|
use iris::harness::Harness;
|
||||||
|
use iris::prelude::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_press_reaches_only_the_widget_under_the_cursor() {
|
||||||
|
let mut h = Harness::new((400, 200));
|
||||||
|
let clicks = Rc::new(RefCell::new(Vec::new()));
|
||||||
|
|
||||||
|
let (on_left, on_right) = (clicks.clone(), clicks.clone());
|
||||||
|
let left = rect(Color::RED)
|
||||||
|
.width(100)
|
||||||
|
.on(CursorSense::click(), move |_, _| {
|
||||||
|
on_left.borrow_mut().push("left")
|
||||||
|
})
|
||||||
|
.add(&mut h.rsc);
|
||||||
|
let right = rect(Color::BLUE)
|
||||||
|
.on(CursorSense::click(), move |_, _| {
|
||||||
|
on_right.borrow_mut().push("right")
|
||||||
|
})
|
||||||
|
.add(&mut h.rsc);
|
||||||
|
h.set_root((left, right).span(Dir::RIGHT));
|
||||||
|
|
||||||
|
h.click((50, 100));
|
||||||
|
assert_eq!(*clicks.borrow(), ["left"]);
|
||||||
|
|
||||||
|
h.click((300, 100));
|
||||||
|
assert_eq!(*clicks.borrow(), ["left", "right"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hover_ends_when_the_cursor_leaves_the_window() {
|
||||||
|
let mut h = Harness::new((400, 200));
|
||||||
|
let hovered = Rc::new(RefCell::new(0));
|
||||||
|
let ended = Rc::new(RefCell::new(0));
|
||||||
|
|
||||||
|
let (h_count, e_count) = (hovered.clone(), ended.clone());
|
||||||
|
let widget = rect(Color::RED)
|
||||||
|
.on(CursorSense::HoverStart, move |_, _| {
|
||||||
|
*h_count.borrow_mut() += 1
|
||||||
|
})
|
||||||
|
.on(CursorSense::HoverEnd, move |_, _| {
|
||||||
|
*e_count.borrow_mut() += 1
|
||||||
|
})
|
||||||
|
.add(&mut h.rsc);
|
||||||
|
h.set_root(widget);
|
||||||
|
|
||||||
|
h.move_to((200, 100));
|
||||||
|
assert_eq!((*hovered.borrow(), *ended.borrow()), (1, 0));
|
||||||
|
|
||||||
|
// A second sample inside the same widget is not a second hover.
|
||||||
|
h.move_to((210, 100));
|
||||||
|
assert_eq!((*hovered.borrow(), *ended.borrow()), (1, 0));
|
||||||
|
|
||||||
|
h.leave();
|
||||||
|
assert_eq!((*hovered.borrow(), *ended.borrow()), (1, 1));
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
//! Scrolling moves content and stops at its ends.
|
||||||
|
|
||||||
|
mod common;
|
||||||
|
|
||||||
|
use common::corners;
|
||||||
|
use iris::harness::Harness;
|
||||||
|
use iris::prelude::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_wheel_scrolls_the_content_and_stops_at_its_end() {
|
||||||
|
let mut h = Harness::new((400, 200));
|
||||||
|
// Twice the window's height, so there is 200 to scroll.
|
||||||
|
let top = rect(Color::RED).height(200).add(&mut h.rsc);
|
||||||
|
let bottom = rect(Color::BLUE).height(200).add(&mut h.rsc);
|
||||||
|
h.set_root((top, bottom).span(Dir::DOWN).scrollable());
|
||||||
|
h.move_to((200, 100));
|
||||||
|
|
||||||
|
// `Scroll` starts snapped to the end.
|
||||||
|
assert_eq!(corners(&h, &top).1, -200.0);
|
||||||
|
|
||||||
|
// The handler scales a wheel line by 50.
|
||||||
|
h.scroll((0, 1));
|
||||||
|
h.frame();
|
||||||
|
assert_eq!(corners(&h, &top).1, -150.0);
|
||||||
|
|
||||||
|
h.scroll((0, 10));
|
||||||
|
h.frame();
|
||||||
|
assert_eq!(corners(&h, &top).1, 0.0);
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
//! What a background task can change, and how it gets back to the ui.
|
||||||
|
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use iris::harness::Harness;
|
||||||
|
use iris::prelude::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_task_update_reaches_the_tree() {
|
||||||
|
let mut h = Harness::new((400, 200));
|
||||||
|
let widget = rect(Color::RED).add(&mut h.rsc);
|
||||||
|
h.set_root(widget.task_on(CursorSense::click(), async move |mut ctx| {
|
||||||
|
ctx.update(move |_, rsc| widget(rsc).color = Color::BLUE);
|
||||||
|
}));
|
||||||
|
|
||||||
|
h.click((200, 100));
|
||||||
|
|
||||||
|
assert!(
|
||||||
|
h.await_update(Duration::from_secs(5)),
|
||||||
|
"the task sent no update"
|
||||||
|
);
|
||||||
|
assert_eq!(h.rsc[widget].color, Color::BLUE);
|
||||||
|
}
|
||||||
Reference in new issue
Block a user