xremap 0.15.0

Dynamic key remapp for X and Wayland
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

use crate::event_handler::{PRESS, RELEASE};
use crate::throttle_emit::ThrottleEmit;
use anyhow::Result;
use evdev::KeyCode;
use std::thread::sleep;
use std::time::{Duration, SystemTime};

const DELAY: Duration = Duration::from_millis(10);
/// Allow for inconsistency in test cases. Tests measure time
/// from event start to sleep_if_needed returns, but the time that
/// actually matters is from _previous_event_ start to sleep_if_needed returns.
const MINIMUM_DELAY: Duration = Duration::from_millis(9);

fn get_handler() -> ThrottleEmit {
    let handler = ThrottleEmit::new(DELAY);

    sleep(DELAY); // Ensure handler is in base state.

    handler
}

fn has_delay(handler: &mut ThrottleEmit, key: KeyCode, value: i32) -> Result<bool> {
    let time = SystemTime::now();
    handler.sleep_if_needed(key, value);
    Ok(time.elapsed()? > MINIMUM_DELAY)
}

#[test]
fn test_press_key_then_release_same_key_without_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    assert!(has_delay(&mut handler, KeyCode::KEY_A, RELEASE)?);

    Ok(())
}

#[test]
fn test_press_key_then_release_same_key_with_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    sleep(DELAY); // So no delay is needed

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, RELEASE)?);

    Ok(())
}

#[test]
fn test_press_key_then_release_other_key_without_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    assert!(!has_delay(&mut handler, KeyCode::KEY_B, RELEASE)?);

    Ok(())
}

#[test]
fn test_press_key_then_press_mod_without_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    assert!(has_delay(&mut handler, KeyCode::KEY_LEFTALT, PRESS)?);

    Ok(())
}

#[test]
fn test_press_key_then_press_mod_with_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    sleep(DELAY); // So no delay is needed

    assert!(!has_delay(&mut handler, KeyCode::KEY_LEFTALT, PRESS)?);

    Ok(())
}

#[test]
fn test_press_key_then_release_mod_without_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    assert!(has_delay(&mut handler, KeyCode::KEY_LEFTALT, RELEASE)?);

    Ok(())
}

#[test]
fn test_press_key_then_release_mod_with_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    sleep(DELAY); // So no delay is needed

    assert!(!has_delay(&mut handler, KeyCode::KEY_LEFTALT, RELEASE)?);

    Ok(())
}

#[test]
fn test_press_mod_then_press_key_without_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_LEFTALT, PRESS)?);

    assert!(has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);

    Ok(())
}

#[test]
fn test_press_mod_then_release_key_without_delay() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_LEFTALT, PRESS)?);

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, RELEASE)?);

    Ok(())
}

#[test]
fn test_both_press_and_release_delays_after_mod() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_LEFTCTRL, PRESS)?);
    assert!(has_delay(&mut handler, KeyCode::KEY_V, PRESS)?);
    assert!(has_delay(&mut handler, KeyCode::KEY_V, RELEASE)?);

    Ok(())
}

#[test]
fn test_two_different_keys_pressed_around_mod_press() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);
    assert!(has_delay(&mut handler, KeyCode::KEY_LEFTCTRL, PRESS)?);
    assert!(has_delay(&mut handler, KeyCode::KEY_B, PRESS)?);

    Ok(())
}

#[test]
fn test_two_different_keys_pressed_around_mod_release() -> Result<()> {
    let mut handler = get_handler();

    assert!(!has_delay(&mut handler, KeyCode::KEY_A, PRESS)?);
    assert!(has_delay(&mut handler, KeyCode::KEY_LEFTCTRL, RELEASE)?);
    assert!(has_delay(&mut handler, KeyCode::KEY_B, PRESS)?);

    Ok(())
}