1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
mod state;
use std::{
sync::Arc,
thread::sleep,
time::{Duration, Instant},
};
use captur::capture;
pub(crate) use state::State;
use crate::{
input::{event::Event, event_provider::EventReaderFn},
runtime::{Installer, Threadable},
};
/// The name of the input thread.
pub(crate) const THREAD_NAME: &str = "input";
const MINIMUM_PAUSE_RATE: Duration = Duration::from_millis(250);
/// A thread for reading and handling input events.
#[derive(Debug)]
pub(crate) struct Thread<EventProvider, CustomEvent>
where
EventProvider: EventReaderFn,
CustomEvent: crate::input::CustomEvent + 'static,
{
event_provider: Arc<EventProvider>,
state: State<CustomEvent>,
}
impl<EventProvider, CustomEvent> Threadable for Thread<EventProvider, CustomEvent>
where
EventProvider: EventReaderFn,
CustomEvent: crate::input::CustomEvent + Send + Sync + 'static,
{
#[inline]
fn install(&self, installer: &Installer) {
let state = self.state();
let event_provider = Arc::clone(&self.event_provider);
installer.spawn(THREAD_NAME, |notifier| {
move || {
capture!(notifier, state, event_provider);
let mut time = Instant::now();
notifier.busy();
while !state.is_ended() {
while state.is_paused() {
notifier.wait();
sleep(time.saturating_duration_since(Instant::now()));
time += MINIMUM_PAUSE_RATE;
}
notifier.busy();
if let Ok(Some(event)) = (event_provider)() {
state.enqueue_event(Event::from(event));
}
}
notifier.end();
notifier.request_end();
}
});
}
#[inline]
fn pause(&self) {
self.state.pause();
}
#[inline]
fn resume(&self) {
self.state.resume();
}
#[inline]
fn end(&self) {
self.state.end();
}
}
impl<EventProvider, CustomEvent> Thread<EventProvider, CustomEvent>
where
EventProvider: EventReaderFn,
CustomEvent: crate::input::CustomEvent + 'static,
{
/// Create a new instance of a thread.
#[inline]
pub(crate) fn new(event_provider: EventProvider) -> Self {
Self {
event_provider: Arc::new(event_provider),
state: State::new(),
}
}
/// Get a cloned copy of the state of the thread.
#[inline]
#[must_use]
pub(crate) fn state(&self) -> State<CustomEvent> {
self.state.clone()
}
}
#[cfg(test)]
mod tests {
use anyhow::anyhow;
use crossterm::event::{KeyCode, KeyModifiers};
use super::*;
use crate::{
input::{
testutil::local::{create_event_reader, TestEvent},
KeyEvent,
},
runtime::{testutils::ThreadableTester, Status},
};
#[test]
fn set_pause_resume() {
let event_provider = create_event_reader(|| Ok(None));
let thread: Thread<_, TestEvent> = Thread::new(event_provider);
let state = thread.state();
thread.pause();
assert!(state.is_paused());
thread.resume();
assert!(!state.is_paused());
}
#[test]
fn set_end() {
let event_provider = create_event_reader(|| Ok(None));
let thread: Thread<_, TestEvent> = Thread::new(event_provider);
let state = thread.state();
thread.end();
assert!(state.is_ended());
}
#[test]
fn read_event_from_event_provider() {
let event_provider = create_event_reader(|| {
Ok(Some(Event::Key(KeyEvent::new(
KeyCode::Char('a'),
KeyModifiers::empty(),
))))
});
let thread: Thread<_, TestEvent> = Thread::new(event_provider);
let state = thread.state();
let tester = ThreadableTester::new();
tester.start_threadable(&thread, THREAD_NAME);
let event_received;
loop {
let event = state.read_event();
if event != Event::None {
event_received = event;
break;
}
}
state.end();
assert_eq!(event_received, Event::from('a'));
}
#[test]
fn read_none_event() {
let event_provider = create_event_reader(|| Ok(None));
let thread: Thread<_, TestEvent> = Thread::new(event_provider);
let state = thread.state();
let tester = ThreadableTester::new();
tester.start_threadable(&thread, THREAD_NAME);
tester.wait_for_status(&Status::Busy);
let event_received = state.read_event();
state.end();
tester.wait_for_finished();
assert_eq!(event_received, Event::None);
}
#[test]
fn read_error() {
let event_provider = create_event_reader(|| Err(anyhow!("Err")));
let thread: Thread<_, TestEvent> = Thread::new(event_provider);
let state = thread.state();
let tester = ThreadableTester::new();
tester.start_threadable(&thread, THREAD_NAME);
tester.wait_for_status(&Status::Busy);
let event_received = state.read_event();
state.end();
tester.wait_for_finished();
assert_eq!(event_received, Event::None);
}
#[test]
fn pause_resume() {
let event_provider = create_event_reader(|| Ok(None));
let thread: Thread<_, TestEvent> = Thread::new(event_provider);
let state = thread.state();
let tester = ThreadableTester::new();
tester.start_threadable(&thread, THREAD_NAME);
tester.wait_for_status(&Status::Busy);
state.pause();
tester.wait_for_status(&Status::Waiting);
state.resume();
tester.wait_for_status(&Status::Busy);
state.end();
tester.wait_for_finished();
}
}
|
