okey-cli 0.1.2

An advanced, easy-to-use key remapper for Linux
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
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

use std::{collections::HashMap, time::Instant};

use smallvec::SmallVec;

use crate::{
    config::schema::{DefaultTapDanceConfig, KeyAction, KeyCode, TapDanceConfig},
    core::buffer::InputBuffer,
};

use super::{adapter::InputResult, shared::RawKeyCode};

#[derive(Debug)]
pub struct TapDanceManager {
    tap_dances: HashMap<RawKeyCode, TapDanceConfig>,
    pressed_keys: SmallVec<[PressedKey; 4]>,
    supressed_keys: SmallVec<[RawKeyCode; 2]>,
    config: DefaultTapDanceConfig,
}

impl TapDanceManager {
    pub fn new(
        tap_dances: HashMap<KeyCode, TapDanceConfig>,
        config: DefaultTapDanceConfig,
    ) -> Self {
        let tap_dances = tap_dances
            .into_iter()
            .map(|(key, value)| (key.value(), value))
            .collect();

        Self {
            config,
            tap_dances,
            pressed_keys: SmallVec::default(),
            supressed_keys: SmallVec::default(),
        }
    }

    pub fn handle_press(&mut self, code: RawKeyCode) -> Option<InputResult> {
        if let Some(config) = self.tap_dances.get(&code) {
            self.pressed_keys
                .push(PressedKey::new(code, config, self.config.default_timeout));

            Some(InputResult::Pending(KeyCode::new(code)))
        } else {
            None
        }
    }

    pub fn handle_hold(&mut self, code: RawKeyCode) -> Option<InputResult> {
        self.tap_dances
            .contains_key(&code)
            .then_some(InputResult::None)
    }

    pub fn handle_release(&mut self, code: RawKeyCode) -> Option<InputResult> {
        let key = self.pressed_keys.iter_mut().find(|s| s.code == code);

        if !self.supressed_keys.is_empty() {
            self.supressed_keys.retain(|key| *key != code);
        }

        if let Some(key) = key {
            key.released = true;
            Some(InputResult::None)
        } else {
            None
        }
    }

    pub fn process(&mut self, buffer: &mut InputBuffer) {
        if self.pressed_keys.is_empty() {
            return;
        }

        let now = Instant::now();

        for (idx, state) in self.pressed_keys.iter().enumerate() {
            if self.supressed_keys.contains(&state.code) {
                continue;
            }

            let timeout = state.reached_timeout(now);
            let result = state.get_dance_result(timeout);
            let code = KeyCode::new(state.code);

            match &result {
                InputResult::Macro(_) => {
                    self.supressed_keys.push(state.code);
                }
                InputResult::DoubleSequence(inner) if !timeout => {
                    if let [InputResult::Press(out_code), _] = inner.as_ref() {
                        if *out_code != code {
                            buffer.clear_pending_key(&code);
                        }
                    }
                }
                _ => {}
            }

            if timeout {
                buffer.clear_pending_key(&code);
            }

            if state.released {
                buffer.push_key(idx as u16);
            }

            buffer.push_result(result);
        }

        while let Some(idx) = buffer.pop_key() {
            self.pressed_keys.remove(idx as usize);
        }
    }
}

#[derive(Debug)]
struct PressedKey {
    code: RawKeyCode,
    timeout: u16,
    timestamp: Instant,
    released: bool,
    tap: KeyAction,
    hold: KeyAction,
}

impl PressedKey {
    fn new(code: RawKeyCode, config: &TapDanceConfig, default_timeout: u16) -> Self {
        PressedKey {
            code,
            timeout: config.timeout.unwrap_or(default_timeout),
            timestamp: Instant::now(),
            released: false,
            tap: config.tap.clone(),
            hold: config.hold.clone(),
        }
    }

    fn reached_timeout(&self, now: Instant) -> bool {
        let elapsed = now.duration_since(self.timestamp).as_millis();
        let timeout = self.timeout as u128;
        elapsed > timeout
    }

    fn get_dance_result(&self, timeout: bool) -> InputResult {
        if self.released && timeout {
            self.get_release_result()
        } else if self.released {
            self.get_tap_result()
        } else if timeout {
            self.get_hold_result()
        } else {
            InputResult::None
        }
    }

    fn get_release_result(&self) -> InputResult {
        match &self.hold {
            KeyAction::KeyCode(code) => InputResult::Release(*code),
            KeyAction::Macro(_) => InputResult::None,
        }
    }

    fn get_tap_result(&self) -> InputResult {
        match &self.tap {
            KeyAction::KeyCode(code) => InputResult::DoubleSequence(Box::new([
                InputResult::Press(*code),
                InputResult::Release(*code),
            ])),
            KeyAction::Macro(codes) => InputResult::Macro(codes.clone()),
        }
    }

    fn get_hold_result(&self) -> InputResult {
        match &self.hold {
            KeyAction::KeyCode(code) => InputResult::DoubleSequence(Box::new([
                InputResult::Press(*code),
                InputResult::Hold(*code),
            ])),
            KeyAction::Macro(codes) => InputResult::Macro(codes.clone()),
        }
    }
}