smart_keymap/keymap/
observed_eb_keymap.rs

1use core::fmt::Debug;
2use core::ops::Index;
3
4use crate::input;
5use crate::key;
6use crate::keymap;
7
8use keymap::Keymap;
9use keymap::SetKeymapContext;
10
11/// Wrapper around a [crate::keymap::Keymap] that also tracks distinct HID reports.
12#[derive(Debug)]
13pub struct ObservedKeymap<I: Index<usize, Output = R>, R, Ctx, Ev: Debug, PKS, KS, S> {
14    keymap: Keymap<I, R, Ctx, Ev, PKS, KS, S>,
15    distinct_reports: keymap::DistinctReports,
16}
17
18impl<
19        I: Debug + Index<usize, Output = R>,
20        R: Copy + Debug,
21        Ctx: Debug + key::Context<Event = Ev> + SetKeymapContext,
22        Ev: Copy + Debug,
23        PKS: Debug,
24        KS: Copy + Debug + From<key::NoOpKeyState>,
25        S: key::System<R, Ref = R, Context = Ctx, Event = Ev, PendingKeyState = PKS, KeyState = KS>,
26    > ObservedKeymap<I, R, Ctx, Ev, PKS, KS, S>
27{
28    /// Constructs an observed keymap with a new [keymap::DistinctReports].
29    pub fn new(keymap: Keymap<I, R, Ctx, Ev, PKS, KS, S>) -> Self {
30        ObservedKeymap {
31            keymap,
32            distinct_reports: keymap::DistinctReports::new(),
33        }
34    }
35
36    /// Proxies [keymap::Keymap::handle_input_after_time], `tick`'ing the keymap appropriately.
37    pub fn handle_input_after_time(&mut self, delta_ms: u32, ev: input::Event) -> Option<u32> {
38        let ObservedKeymap {
39            keymap,
40            distinct_reports,
41        } = self;
42
43        let next_ev = keymap.handle_input_after_time(delta_ms, ev);
44
45        distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
46
47        for _ in 0..keymap::INPUT_QUEUE_TICK_DELAY {
48            keymap.tick();
49            distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
50        }
51
52        next_ev
53    }
54
55    /// Proxies [keymap::Keymap::tick_to_next_scheduled_event], updating reports appropriately.
56    pub fn tick_to_next_scheduled_event(&mut self) -> Option<u32> {
57        let ObservedKeymap {
58            keymap,
59            distinct_reports,
60        } = self;
61
62        let next_ev = keymap.tick_to_next_scheduled_event();
63
64        distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
65
66        next_ev
67    }
68
69    /// Proxies [keymap::Keymap::boot_keyboard_report].
70    pub fn boot_keyboard_report(&self) -> [u8; 8] {
71        let ObservedKeymap { keymap, .. } = self;
72
73        keymap::KeymapOutput::new(keymap.pressed_keys()).as_hid_boot_keyboard_report()
74    }
75
76    /// Reference to distinct reports.
77    pub fn distinct_reports(&self) -> &keymap::DistinctReports {
78        &self.distinct_reports
79    }
80
81    /// Ticks the keymap until there are no scheduled events, updating reports appropriately.
82    pub fn tick_until_no_scheduled_events(&mut self) {
83        let ObservedKeymap {
84            keymap,
85            distinct_reports,
86        } = self;
87
88        while keymap.has_scheduled_events() {
89            keymap.tick();
90            distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
91        }
92    }
93}
smart_keymap/keymap/observed_eb_keymap.rs

smart_keymap/keymap/
observed_eb_keymap.rs
