rktk-keymanager 0.2.0

Keymap/state manager for self-made keyboard firmware
Documentation 
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

use crate::{
    interface::state::config::TapDanceConfig,
    keycode::KeyCode,
    keymap::{TapDanceDefinition, TapDanceDefinitions},
    time::{Duration, Instant},
};

use super::EventType;

#[derive(Debug)]
enum TapDanceKeyState {
    None,
    PressedPending {
        tap_count: u8,
        hold_start: Instant,
    },
    ReleasedPending {
        tap_count: u8,
        last_release: Instant,
    },
    Holding {
        tap_count: u8,
    },
}

struct TapDanceUnit<const MAX_REPEATS: usize> {
    state: TapDanceKeyState,
    config: Option<TapDanceDefinition<MAX_REPEATS>>,
}

impl<const MAX_REPEATS: usize> TapDanceUnit<MAX_REPEATS> {
    fn get_tap_key(&self, tap_count: u8) -> Option<KeyCode> {
        self.config
            .as_ref()
            .and_then(|def| def.tap.get(tap_count as usize).copied().flatten())
    }

    fn get_hold_key(&self, tap_count: u8) -> Option<KeyCode> {
        self.config
            .as_ref()
            .and_then(|def| def.hold.get(tap_count as usize).copied().flatten())
    }
}

pub struct TapDanceState<const MAX_DEFINITIONS: usize, const MAX_REPEATS: usize> {
    state: [TapDanceUnit<MAX_REPEATS>; MAX_DEFINITIONS],
    threshold: Duration,
}

impl<const MAX_DEFINITIONS: usize, const MAX_REPEATS: usize>
    TapDanceState<MAX_DEFINITIONS, MAX_REPEATS>
{
    pub fn new(
        def: TapDanceDefinitions<MAX_DEFINITIONS, MAX_REPEATS>,
        config: TapDanceConfig,
    ) -> Self {
        Self {
            state: def.map(|def| TapDanceUnit {
                state: TapDanceKeyState::None,
                config: def,
            }),
            threshold: Duration::from_millis(config.threshold),
        }
    }

    pub fn post_resolve(&mut self, now: Instant, mut cb: impl FnMut(EventType, KeyCode)) {
        for td in &mut self.state {
            match td.state {
                TapDanceKeyState::None => {}
                TapDanceKeyState::PressedPending {
                    tap_count,
                    hold_start,
                } => {
                    // If the Pending state continues for a while (if it remains pressed), it will become Hold.
                    if now - hold_start > self.threshold {
                        if let Some(hkc) = td.get_hold_key(tap_count) {
                            cb(EventType::Pressed, hkc);
                        }
                        td.state = TapDanceKeyState::Holding { tap_count };
                    }
                }
                TapDanceKeyState::ReleasedPending {
                    tap_count,
                    last_release,
                } => {
                    // If the Pending state continues for a while (if it remains released), it will become Tap.
                    if now - last_release > self.threshold {
                        if let Some(tkc) = td.get_tap_key(tap_count) {
                            cb(EventType::Pressed, tkc);
                            cb(EventType::Released, tkc);
                        }
                        td.state = TapDanceKeyState::None;
                    }
                }
                TapDanceKeyState::Holding { tap_count } => {
                    if let Some(hkc) = td.get_tap_key(tap_count) {
                        cb(EventType::Pressing, hkc);
                    }
                }
            }
        }
    }

    pub fn process_event(
        &mut self,
        id: u8,
        now: Instant,
        pressed: bool,
        mut cb: impl FnMut(EventType, KeyCode),
    ) {
        if let Some(td) = self.state.get_mut(id as usize) {
            match (pressed, &td.state) {
                (true, TapDanceKeyState::None) => {
                    td.state = TapDanceKeyState::PressedPending {
                        tap_count: 0,
                        hold_start: now,
                    };
                }
                (true, TapDanceKeyState::ReleasedPending { tap_count, .. }) => {
                    td.state = TapDanceKeyState::PressedPending {
                        tap_count: tap_count + 1,
                        hold_start: now,
                    };
                }
                (false, TapDanceKeyState::Holding { tap_count }) => {
                    if let Some(hkc) = td.get_hold_key(*tap_count) {
                        cb(EventType::Released, hkc);
                    }
                    td.state = TapDanceKeyState::None;
                }
                (false, TapDanceKeyState::PressedPending { tap_count, .. }) => {
                    td.state = TapDanceKeyState::ReleasedPending {
                        tap_count: *tap_count,
                        last_release: now,
                    };
                }
                _ => {}
            }
        }
    }
}