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

use std::{thread, time::Duration};

use super::utils::*;

const CONFIG: &str = include_str!("./config/combos.yaml");

#[test]
fn test_tap_combo() -> Result<()> {
    let mut proxy = EventProxyMock::default();
    let mut adapter = KeyAdapter::with_config(CONFIG, &mut proxy);

    adapter.process(InputBuffer::combo_press(KeyCode::KEY_D, KeyCode::KEY_F))?;

    thread::sleep(Duration::from_millis(20));

    adapter.process(InputBuffer::combo_release(KeyCode::KEY_D, KeyCode::KEY_F))?;

    let expected = InputBuffer::tap(KeyCode::KEY_LEFTCTRL);

    assert_eq!(proxy.queue(), expected.value());

    Ok(())
}

#[test]
fn test_macro_combo() -> Result<()> {
    let mut proxy = EventProxyMock::default();
    let mut adapter = KeyAdapter::with_config(CONFIG, &mut proxy);

    let expected = InputBuffer::new(KeyCode::KEY_H)
        .tap_then(KeyCode::KEY_E)
        .tap_then(KeyCode::KEY_Y)
        .tap();

    adapter.process(InputBuffer::combo_press(KeyCode::KEY_U, KeyCode::KEY_I))?;

    thread::sleep(Duration::from_millis(20));

    adapter.process(InputBuffer::combo_release(KeyCode::KEY_U, KeyCode::KEY_I))?;

    assert_eq!(proxy.queue(), expected.value());

    Ok(())
}

#[test]
fn test_macro_combo_hold() -> Result<()> {
    let mut proxy = EventProxyMock::default();
    let mut adapter = KeyAdapter::with_config(CONFIG, &mut proxy);

    let expected = InputBuffer::new(KeyCode::KEY_H)
        .tap_then(KeyCode::KEY_E)
        .tap_then(KeyCode::KEY_Y)
        .tap();

    adapter.process(InputBuffer::combo_press(KeyCode::KEY_U, KeyCode::KEY_I))?;

    thread::sleep(Duration::from_millis(90));

    adapter.process(InputBuffer::combo_hold(KeyCode::KEY_U, KeyCode::KEY_I))?;

    thread::sleep(Duration::from_millis(90));

    adapter.process(InputBuffer::combo_release(KeyCode::KEY_U, KeyCode::KEY_I))?;

    // macros should not repeat on hold
    assert_eq!(proxy.queue(), expected.value());

    Ok(())
}

#[test]
fn test_expired_combo_key() -> Result<()> {
    let mut proxy = EventProxyMock::default();
    let mut adapter = KeyAdapter::with_config(CONFIG, &mut proxy);

    adapter.process(InputBuffer::press(KeyCode::KEY_D))?;

    thread::sleep(Duration::from_millis(50));

    adapter.process(InputBuffer::release(KeyCode::KEY_D))?;

    let expected = InputBuffer::tap(KeyCode::KEY_D);

    assert_eq!(proxy.queue(), expected.value());

    proxy.clear();

    Ok(())
}

#[test]
fn test_derred_combo_key() -> Result<()> {
    let mut proxy = EventProxyMock::default();
    let mut adapter = KeyAdapter::with_config(CONFIG, &mut proxy);

    let expected = InputBuffer::new(KeyCode::KEY_D)
        .tap_then(KeyCode::KEY_A)
        .tap();

    adapter.process(InputBuffer::press(KeyCode::KEY_D))?;

    thread::sleep(Duration::from_millis(60));

    adapter.process(
        InputBuffer::new(KeyCode::KEY_D)
            .release_then(KeyCode::KEY_A)
            .tap(),
    )?;

    assert_eq!(proxy.queue(), expected.value());

    Ok(())
}