smart_keymap_core/keymap/
observed_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::init] and clears observed reports.
37    pub fn init(&mut self) {
38        self.keymap.init();
39        self.distinct_reports = keymap::DistinctReports::new();
40    }
41
42    /// Proxies [keymap::Keymap::handle_input], `tick`'ing the keymap appropriately.
43    pub fn handle_input(&mut self, ev: input::Event) {
44        let ObservedKeymap {
45            keymap,
46            distinct_reports,
47        } = self;
48
49        keymap.handle_input(ev);
50        distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
51
52        // Clear input-queue pacing so a follow-up handle_input can process next.
53        keymap.tick();
54        distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
55    }
56
57    /// Proxies [keymap::Keymap::tick], updating reports appropriately.
58    pub fn tick(&mut self) {
59        let ObservedKeymap {
60            keymap,
61            distinct_reports,
62        } = self;
63
64        keymap.tick();
65        distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
66    }
67
68    /// Proxies [keymap::Keymap::boot_keyboard_report].
69    pub fn boot_keyboard_report(&self) -> [u8; 8] {
70        let ObservedKeymap { keymap, .. } = self;
71
72        keymap::KeymapOutput::new(keymap.pressed_keys()).as_hid_boot_keyboard_report()
73    }
74
75    /// Reference to distinct reports.
76    pub fn distinct_reports(&self) -> &keymap::DistinctReports {
77        &self.distinct_reports
78    }
79
80    /// Ticks the keymap until there are no scheduled events, updating reports appropriately.
81    pub fn tick_until_no_scheduled_events(&mut self) {
82        let ObservedKeymap {
83            keymap,
84            distinct_reports,
85        } = self;
86
87        while keymap.has_scheduled_events() {
88            keymap.tick();
89            distinct_reports.update(keymap.report_output().as_hid_boot_keyboard_report());
90        }
91    }
92}
smart_keymap_core/keymap/observed_keymap.rs

smart_keymap_core/keymap/
observed_keymap.rs
