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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
use crate::handlers::{OnOff, ProcessKeys, Action, HandlerResult};
use crate::key_codes::AcceptsKeycode;
use crate::key_stream::{iter_unhandled_mut, Event, EventStatus};
use crate::USBKeyOut;
use lazy_static::lazy_static;
use no_std_compat::prelude::v1::*;
use spin::RwLock;
#[repr(u8)]
#[derive(Debug)]
pub enum OneShotStatus {
    Held,
    HeldUsed,
    Triggered,
    TriggerUsed,
    Off,
}
/// A OneShot key.
/// Press it, on_activate will be called.
///
/// on_deactivate will be called after the next non-oneshot key release
/// or if the OneShot trigger is pressed again
///
/// Also, if the OneShot trigger is pressed again on_double_tap_trigger1/2 is called 
/// (after callbacks.on_deactivate, use ActionNone for no action)
///
/// If held_timeout is > 0 and the key is pressed for at least that many ms,
/// and on_deactivate will be called upon release. This typically is useful
/// for graphics work where the user presses the modifiers while interacting
/// with the mouse.
///
/// You may also define a released_timeout - after this time, without
/// a different keypress, the OneShot will also deactivate.
///
/// OneShots have two triggers to accomodate the usual left/right modifier keys,
/// just pass in Keycode::No if you want one trigger to be ignored.
///
/// Note that the oneshots always lead to the left variant of the modifier being sent,
/// even if they're being triggered by the right one.
pub struct OneShot<M1, M2, M3> {
    trigger1: u32,
    trigger2: u32,
    callbacks: M1,
    on_double_tap_trigger1: M2,
    on_double_tap_trigger2: M3,
    status: OneShotStatus,
    held_timeout: u16,
    released_timeout: u16,
}
lazy_static! {
    /// oneshots don't deactive on other oneshots - this stores the keycodes to ignore
    pub static ref ONESHOT_TRIGGERS: RwLock<Vec<u32>> = RwLock::new(Vec::new());
}
impl<M1: OnOff, M2: Action, M3: Action> OneShot<M1, M2, M3> {
    pub fn new(
        trigger1: impl AcceptsKeycode,
        trigger2: impl AcceptsKeycode,
        callbacks: M1,
        on_double_tap_trigger1: M2,
        on_double_tap_trigger2: M3,
        held_timeout: u16,
        released_timeout: u16,
    ) -> OneShot<M1, M2, M3> {
        ONESHOT_TRIGGERS.write().push(trigger1.to_u32());
        ONESHOT_TRIGGERS.write().push(trigger2.to_u32());
        OneShot {
            trigger1: trigger1.to_u32(),
            trigger2: trigger2.to_u32(),
            callbacks,
            on_double_tap_trigger1,
            on_double_tap_trigger2,
            status: OneShotStatus::Off,
            held_timeout,
            released_timeout,
        }
    }
}
impl<T: USBKeyOut, M1: OnOff, M2: Action, M3: Action> ProcessKeys<T> for OneShot<M1, M2, M3> {
    fn process_keys(&mut self, events: &mut Vec<(Event, EventStatus)>, output: &mut T) -> HandlerResult {
        for (event, status) in iter_unhandled_mut(events) {
            //a sticky key
            // on press if not active -> active
            // on other key release -> deactivate
            // on press if active -> deactive
            // on release -> noop?
            match event {
                Event::KeyPress(kc) => {
                    if kc.keycode == self.trigger1 || kc.keycode == self.trigger2 {
                        *status = EventStatus::Handled;
                        match self.status {
                            OneShotStatus::Triggered => {
                                self.status = OneShotStatus::Off;
                                self.callbacks.on_deactivate(output);
                                if kc.keycode == self.trigger1 {
                                    self.on_double_tap_trigger1.on_trigger(output);
                                } else if kc.keycode == self.trigger2 {
                                    self.on_double_tap_trigger2.on_trigger(output);
                                }
                            }
                            OneShotStatus::Off => {
                                self.status = OneShotStatus::Held;
                                self.callbacks.on_activate(output)
                            }
                            OneShotStatus::Held
                            | OneShotStatus::HeldUsed
                            | OneShotStatus::TriggerUsed => {}
                        }
                    } else if !ONESHOT_TRIGGERS.read().contains(&kc.keycode) {
                        match self.status {
                            OneShotStatus::Triggered => self.status = OneShotStatus::TriggerUsed,
                            OneShotStatus::TriggerUsed => {
                                self.status = OneShotStatus::Off;
                                self.callbacks.on_deactivate(output)
                            }
                            _ => {}
                        }
                    }
                }
                Event::KeyRelease(kc) => {
                    if kc.keycode == self.trigger1 || kc.keycode == self.trigger2 {
                        match self.status {
                            OneShotStatus::Held => {
                                if self.held_timeout > 0 && kc.ms_since_last > self.held_timeout {
                                    self.status = OneShotStatus::Off;
                                    self.callbacks.on_deactivate(output)
                                } else {
                                    self.status = OneShotStatus::Triggered;
                                }
                            }

                            OneShotStatus::HeldUsed => {
                                self.status = OneShotStatus::Off;
                                self.callbacks.on_deactivate(output)
                            }
                            _ => {}
                        }
                        *status = EventStatus::Handled;
                    } else if !ONESHOT_TRIGGERS.read().contains(&kc.keycode) {
                        match self.status {
                            OneShotStatus::Triggered => {
                                self.status = OneShotStatus::Off;
                                self.callbacks.on_deactivate(output)
                            }
                            OneShotStatus::Held => self.status = OneShotStatus::HeldUsed,
                            _ => {}
                        }
                    }
                }
                Event::TimeOut(ms) => {
                    if let OneShotStatus::Triggered = self.status {
                        if self.released_timeout > 0 && *ms >= self.released_timeout {
                            self.status = OneShotStatus::Off;
                            self.callbacks.on_deactivate(output)
                        }
                    }
                }
            }
        }
        HandlerResult::NoOp
    }
}

#[cfg(test)]
//#[macro_use]
//extern crate std;
mod tests {
    use crate::handlers::{OneShot, USBKeyboard};
    #[allow(unused_imports)]
    use crate::key_codes::{KeyCode, UserKey};
    #[allow(unused_imports)]
    use crate::test_helpers::{check_output, KeyOutCatcher, PressCounter};
    #[allow(unused_imports)]
    use crate::{
        Event, EventStatus, Keyboard, KeyboardState, ProcessKeys, USBKeyOut, UnicodeSendMode,
    };
    use crate::premade::ActionNone;
    use alloc::sync::Arc;
    #[allow(unused_imports)]
    use no_std_compat::prelude::v1::*;
    use spin::RwLock;
    #[test]
    fn test_oneshot() {
        let counter = Arc::new(RwLock::new(PressCounter {
            down_counter: 0,
            up_counter: 0,
        }));
        let t = OneShot::new(UserKey::UK0, UserKey::UK1, counter.clone(), ActionNone{}, ActionNone{}, 0, 0);
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        keyboard.add_handler(Box::new(t));
        keyboard.add_handler(Box::new(USBKeyboard::new()));
        for trigger in [UserKey::UK0, UserKey::UK1].iter() {
            counter.write().down_counter = 0;
            counter.write().up_counter = 0;
            keyboard.output.clear();
            //first press - sets
            keyboard.add_keypress(trigger, 0);
            keyboard.handle_keys().unwrap();
            dbg!(counter.read());
            assert!(counter.read().down_counter == 1);
            assert!(counter.read().up_counter == 0);
            assert!(keyboard.events.is_empty());
            check_output(&keyboard, &[&[KeyCode::H], &[]]);
            keyboard.output.clear();
            //first release - no change
            keyboard.add_keyrelease(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 1);
            assert!(counter.read().up_counter == 0);
            assert!(keyboard.events.is_empty());
            //second press - unsets
            keyboard.add_keypress(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 1);
            assert!(counter.read().up_counter == 1);
            assert!(keyboard.events.is_empty());
            //second release - no change
            keyboard.add_keyrelease(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 1);
            assert!(counter.read().up_counter == 1);
            assert!(keyboard.events.is_empty());
            //third press - sets
            keyboard.add_keypress(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 2);
            assert!(counter.read().up_counter == 1);
            assert!(keyboard.events.is_empty());
            keyboard.add_keypress(KeyCode::A, 20);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 2);
            assert!(counter.read().up_counter == 1);
            keyboard.add_keyrelease(KeyCode::A, 20);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 2);
            assert!(counter.read().up_counter == 1); //trigger is being held
                                                     //third release - release trigger after other
            keyboard.add_keyrelease(trigger, 0);
            keyboard.handle_keys().unwrap();
            dbg!(&counter);
            assert!(counter.read().down_counter == 2);
            assert!(counter.read().up_counter == 2);
            assert!(keyboard.events.is_empty());
            //fourth press - sets
            keyboard.add_keypress(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 3);
            assert!(counter.read().up_counter == 2);
            assert!(keyboard.events.is_empty());
            //fifth release - no change
            keyboard.add_keyrelease(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 3);
            assert!(counter.read().up_counter == 2);
            assert!(keyboard.events.is_empty());
            //sixth press - up
            keyboard.add_keypress(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 3);
            assert!(counter.read().up_counter == 3);
            assert!(keyboard.events.is_empty());
            //sixth release - no change
            keyboard.add_keyrelease(trigger, 0);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 3);
            assert!(counter.read().up_counter == 3);
            assert!(keyboard.events.is_empty());
        }
        //what happens if you use both triggers
        counter.write().down_counter = 0;
        counter.write().up_counter = 0;
        keyboard.output.clear();
        //first press - sets
        keyboard.add_keypress(UserKey::UK0, 0);
        keyboard.handle_keys().unwrap();
        dbg!(counter.read());
        assert!(counter.read().down_counter == 1);
        assert!(counter.read().up_counter == 0);
        assert!(keyboard.events.is_empty());
        check_output(&keyboard, &[&[KeyCode::H], &[]]);
        keyboard.output.clear();
        //first release - no change
        keyboard.add_keyrelease(UserKey::UK0, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 1);
        assert!(counter.read().up_counter == 0);
        assert!(keyboard.events.is_empty());
        //second press - unsets
        keyboard.add_keypress(UserKey::UK1, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 1);
        assert!(counter.read().up_counter == 1);
        assert!(keyboard.events.is_empty());
        //second release - no change
        keyboard.add_keyrelease(UserKey::UK1, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 1);
        assert!(counter.read().up_counter == 1);
        assert!(keyboard.events.is_empty());
        //third press - sets
        keyboard.add_keypress(UserKey::UK1, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 2);
        assert!(counter.read().up_counter == 1);
        assert!(keyboard.events.is_empty());
        keyboard.add_keypress(KeyCode::A, 20);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 2);
        assert!(counter.read().up_counter == 1);
        keyboard.add_keyrelease(KeyCode::A, 20);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 2);
        assert!(counter.read().up_counter == 1); // still being held
                                                 //third release - triggers deactivate
        keyboard.add_keyrelease(UserKey::UK1, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 2);
        assert!(counter.read().up_counter == 2);
        assert!(keyboard.events.is_empty());
        //fourth press - sets
        keyboard.add_keypress(UserKey::UK0, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 3);
        assert!(counter.read().up_counter == 2);
        assert!(keyboard.events.is_empty());
        //fifth release - no change
        keyboard.add_keyrelease(UserKey::UK0, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 3);
        assert!(counter.read().up_counter == 2);
        assert!(keyboard.events.is_empty());
        //sixth press - up
        keyboard.add_keypress(UserKey::UK1, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 3);
        assert!(counter.read().up_counter == 3);
        assert!(keyboard.events.is_empty());
        //sixth release - no change
        keyboard.add_keyrelease(UserKey::UK1, 0);
        keyboard.handle_keys().unwrap();
        assert!(counter.read().down_counter == 3);
        assert!(counter.read().up_counter == 3);
        assert!(keyboard.events.is_empty());
    }
    #[test]
    fn test_oneshot_timeout() {
        let counter = Arc::new(RwLock::new(PressCounter {
            down_counter: 0,
            up_counter: 0,
        }));
        let timeout = 1000;
        let t = OneShot::new(UserKey::UK0, UserKey::UK1, counter.clone(), ActionNone{}, ActionNone{}, timeout, 0);
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        keyboard.add_handler(Box::new(t));
        keyboard.add_handler(Box::new(USBKeyboard::new()));
        for trigger in [UserKey::UK0, UserKey::UK1].iter() {
            counter.write().down_counter = 0;
            counter.write().up_counter = 0;
            keyboard.output.clear();
            //first press - sets
            keyboard.add_keypress(trigger, 0);
            keyboard.handle_keys().unwrap();
            dbg!(counter.read());
            assert!(counter.read().down_counter == 1);
            assert!(counter.read().up_counter == 0);
            assert!(keyboard.events.is_empty());
            check_output(&keyboard, &[&[KeyCode::H], &[]]);
            keyboard.output.clear();
            //first release - no change
            keyboard.add_keyrelease(trigger, timeout + 1);
            keyboard.handle_keys().unwrap();
            assert!(counter.read().down_counter == 1);
            assert!(counter.read().up_counter == 1);
            assert!(keyboard.events.is_empty());
        }
    }

    #[test]
    fn test_oneshot_double_tap() {
        use crate::key_codes::KeyCode::*;
        use crate::handlers::Action;
        use crate::test_helpers::Checks;
        let counter = Arc::new(RwLock::new(PressCounter {
            down_counter: 0,
            up_counter: 0,
        }));
        let timeout = 1000;
        struct MyAction {
            keycode: KeyCode
        }
        impl Action for MyAction { 
            fn on_trigger(&mut self, output: &mut dyn USBKeyOut) {
                output.send_keys(&[self.keycode]);
            }
        }
        let t = OneShot::new(UserKey::UK0, UserKey::UK1, counter.clone(), MyAction{keycode: A}, MyAction{keycode:B}, timeout, 0);
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        keyboard.add_handler(Box::new(t));
        keyboard.add_handler(Box::new(USBKeyboard::new()));

        let trigger = UserKey::UK0;
        keyboard.pc(trigger, &[&[H], &[]]);
        keyboard.rc(trigger, &[&[]]);
        keyboard.pc(trigger, &[&[I], &[A], &[]]);
        keyboard.rc(trigger, &[&[]]);

        assert!(counter.read().down_counter == 1);
        assert!(counter.read().up_counter == 1);

        let trigger = UserKey::UK1;
        keyboard.pc(trigger, &[&[H], &[]]);
        keyboard.rc(trigger, &[&[]]);
        keyboard.pc(trigger, &[&[I], &[B], &[]]);
        keyboard.rc(trigger, &[&[]]);

        assert!(counter.read().down_counter == 2);
        assert!(counter.read().up_counter == 2);
    }

}