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

use crate::handlers::{ProcessKeys, HandlerResult};
use crate::key_stream::{iter_unhandled_mut, Event, EventStatus};
use crate::USBKeyOut;

use no_std_compat::prelude::v1::*;

/// A layer that *only* supports replacing key codes
/// with other key codes.
///
/// The advantage of this is that you can/must use it with a const
/// array (slice), which greatly saves on ram compared to Layer
/// (e.g. premade::dvorak)
/// 
pub struct RewriteLayer {
    rewrites: &'static [(u32, u32)],
}

impl RewriteLayer {
    pub fn new(rewrites: &'static [(u32, u32)]) -> RewriteLayer {
        RewriteLayer { rewrites }
    }
}

impl<T: USBKeyOut> ProcessKeys<T> for RewriteLayer {
    fn process_keys(&mut self, events: &mut Vec<(Event, EventStatus)>, _output: &mut T)->HandlerResult {
        for (event, _status) in iter_unhandled_mut(events) {
            //events.iter_mut() {
            match event {
                Event::KeyRelease(kc) => {
                    for (from, to) in self.rewrites.iter() {
                        if *from == kc.keycode {
                            if (kc.flag & 2) == 0 {
                                kc.keycode = *to;
                                kc.flag |= 2;
                            }
                            break; //only one rewrite per layer
                        }
                    }
                }
                Event::KeyPress(kc) => {
                    for (from, to) in self.rewrites.iter() {
                        if *from == kc.keycode {
                            if (kc.flag & 2) == 0 {
                                kc.keycode = *to;
                                kc.flag |= 2;
                            }
                            break; //only one rewrite per layer
                        }
                    }
                }
                Event::TimeOut(_) => {}
            }
        }
        HandlerResult::NoOp
    }
    fn default_enabled(&self) -> bool {
        false
    }
}
#[cfg(test)]
//#[macro_use]
//extern crate std;
mod tests {
    use crate::handlers::{RewriteLayer, USBKeyboard, UnicodeKeyboard};
    use crate::key_codes::KeyCode;
    use crate::test_helpers::{check_output, KeyOutCatcher};
    use crate::{
        Keyboard, USBKeyOut, UnicodeSendMode,
    };
    #[allow(unused_imports)]
    use no_std_compat::prelude::v1::*;

    #[test]
    fn test_layer_rewrite() {
        const MAP: &[(u32, u32)] = &[(KeyCode::A.to_u32(), KeyCode::X.to_u32())];
        let l = RewriteLayer::new(&MAP);
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        let layer_id = keyboard.add_handler(Box::new(l));
        keyboard.add_handler(Box::new(USBKeyboard::new()));
        keyboard.output.state().enable_handler(layer_id);
        keyboard.add_keypress(KeyCode::B, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::B, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keypress(KeyCode::X, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::X, 0);
        keyboard.handle_keys().unwrap();
        check_output(
            &keyboard,
            &[&[KeyCode::B], &[], &[KeyCode::X], &[], &[KeyCode::X], &[]],
        );
        keyboard.output.clear();
        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keypress(KeyCode::B, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::B, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(
            &keyboard,
            &[&[KeyCode::X], &[KeyCode::X, KeyCode::B], &[KeyCode::X], &[]],
        );
        keyboard.output.clear();
        keyboard.output.state().disable_handler(layer_id);
        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::A], &[]]);
        keyboard.output.clear();
        keyboard.output.state().enable_handler(layer_id);
        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        keyboard.add_keyrelease(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::X], &[]]);
    }

    #[test]
    fn test_layer_double_rewrite() {
        const MAP: &[(u32, u32)] = &[
            (KeyCode::A.to_u32(), KeyCode::B.to_u32()),
            (KeyCode::B.to_u32(), KeyCode::C.to_u32()),
        ];
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        let l = RewriteLayer::new(&MAP);
        let layer_id = keyboard.add_handler(Box::new(l));
        assert!(!keyboard.output.state().is_handler_enabled(layer_id));
        keyboard.output.state().enable_handler(layer_id);
        keyboard.add_handler(Box::new(USBKeyboard::new()));
        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::B]]);
    }
    #[test]
    fn test_layer_disable_in_the_middle() {
        const MAP: &[(u32, u32)] = &[(KeyCode::A.to_u32(), KeyCode::B.to_u32())];
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        let l = RewriteLayer::new(&MAP);
        let layer_id = keyboard.add_handler(Box::new(l));
        assert!(!keyboard.output.state().is_handler_enabled(layer_id));
        keyboard.output.state().enable_handler(layer_id);
        keyboard.add_handler(Box::new(USBKeyboard::new()));

        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::B]]);
        keyboard.output.clear();

        keyboard.output.state().disable_handler(layer_id);
        keyboard.add_keyrelease(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        dbg!(&keyboard.output.reports);
        check_output(&keyboard, &[&[]]);
        keyboard.output.clear();
    }

    #[test]
    fn test_layer_rewrite_unicode() {
        const MAP: &[(u32, u32)] = &[(KeyCode::A.to_u32(), 0xDF)];
        let l = RewriteLayer::new(&MAP);
        let mut keyboard = Keyboard::new(KeyOutCatcher::new());
        keyboard.output.state().unicode_mode = UnicodeSendMode::Debug;
        let layer_id = keyboard.add_handler(Box::new(l));
        keyboard.add_handler(Box::new(UnicodeKeyboard::new()));
        keyboard.add_handler(Box::new(USBKeyboard::new()));
        keyboard.output.state().enable_handler(layer_id);
        keyboard.add_keypress(KeyCode::J, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::J]]);
        keyboard.output.clear();
        keyboard.add_keypress(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::J]]);
        keyboard.output.clear();
        keyboard.add_keyrelease(KeyCode::A, 0);
        keyboard.handle_keys().unwrap();
        check_output(&keyboard, &[&[KeyCode::D], &[KeyCode::F], &[KeyCode::J]]);
    }
}