xremap 0.15.7

Dynamic key remap 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
165
166
167
168
169
170
171
172

use crate::config::key_press::parse_modifier_alias;
use crate::event_handler::{DISGUISED_EVENT_OFFSETTER, KEY_MATCH_ANY};
use anyhow::Context;
use evdev::KeyCode as Key;
use serde::{Deserialize, Deserializer};
use std::error::Error;
use std::str::FromStr;

pub fn deserialize_key<'de, D>(deserializer: D) -> Result<Key, D::Error>
where
    D: Deserializer<'de>,
{
    let key = String::deserialize(deserializer)?;
    parse_key(&key).map_err(serde::de::Error::custom)
}

// Correspondence between pseudo keys created by xremap and evdev relative events
// Alias for pseudo key is disguised relative event.
//
//    evdev event code  | xremap pseudo key   | xremap pseudo key
//                      | when positive value | when negative value
//                      |                     |
//    REL_X             | XRightCursor        | XLeftCursor
//    REL_Y             | XDownCursor         | XUpCursor
//    REL_Z             | XREL_Z_AXIS_1       | XREL_Z_AXIS_2
//    REL_RX            | XREL_RX_AXIS_1      | XREL_RX_AXIS_2
//    REL_RY            | XREL_RY_AXIS_1      | XREL_RY_AXIS_2
//    REL_RZ            | XREL_RZ_AXIS_1      | XREL_RZ_AXIS_2
//    REL_HWHEEL        | XRightScroll        | XLeftScroll
//    REL_DIAL          | XREL_DIAL_1         | XREL_DIAL_2
//    REL_WHEEL         | XUpScroll           | XDownScroll
//    REL_MISC          | XREL_MISC_1         | XREL_MISC_2
//    REL_RESERVED      | XREL_RESERVED_1     | XREL_RESERVED_2
//    REL_WHEEL_HI_RES  | XHIRES_UPSCROLL     | XHIRES_DOWNSCROLL
//    REL_HWHEEL_HI_RES | XHIRES_RIGHTSCROLL  | XHIRES_LEFTSCROLL
//
pub fn parse_key(input: &str) -> Result<Key, Box<dyn Error>> {
    // Everything is case-insensitive
    let name = input.to_uppercase();

    // Original evdev scancodes should always work
    if let Ok(key) = Key::from_str(&name) {
        return Ok(key);
    }

    // You can abbreviate "KEY_" of any "KEY_*" scancodes.
    if let Ok(key) = Key::from_str(&format!("KEY_{name}")) {
        return Ok(key);
    }

    // By key code, (e.g. CODE_123)
    if name.starts_with("CODE_") {
        let key_code = name.replacen("CODE_", "", 1);
        let key_code = u16::from_str_radix(&key_code, 10).context(format!("Invalid key_code in: {name}"))?;
        return Ok(Key(key_code));
    }

    // xremap's custom aliases like k0kubun/karabiner-dsl
    match &name[..] {
        // Shift
        "SHIFT_R" => Ok(Key::KEY_RIGHTSHIFT),
        "SHIFT_L" => Ok(Key::KEY_LEFTSHIFT),
        "S_R" => Ok(Key::KEY_RIGHTSHIFT),
        "S_L" => Ok(Key::KEY_LEFTSHIFT),
        // Control
        "CONTROL_R" => Ok(Key::KEY_RIGHTCTRL),
        "CONTROL_L" => Ok(Key::KEY_LEFTCTRL),
        "CTRL_R" => Ok(Key::KEY_RIGHTCTRL),
        "CTRL_L" => Ok(Key::KEY_LEFTCTRL),
        "C_R" => Ok(Key::KEY_RIGHTCTRL),
        "C_L" => Ok(Key::KEY_LEFTCTRL),
        // Alt
        "ALT_R" => Ok(Key::KEY_RIGHTALT),
        "ALT_L" => Ok(Key::KEY_LEFTALT),
        "A_R" => Ok(Key::KEY_RIGHTALT),
        "A_L" => Ok(Key::KEY_LEFTALT),
        "M_R" => Ok(Key::KEY_RIGHTALT),
        "M_L" => Ok(Key::KEY_LEFTALT),
        // Windows
        "SUPER_R" => Ok(Key::KEY_RIGHTMETA),
        "SUPER_L" => Ok(Key::KEY_LEFTMETA),
        "WINDOWS_R" => Ok(Key::KEY_RIGHTMETA),
        "WINDOWS_L" => Ok(Key::KEY_LEFTMETA),
        "WIN_R" => Ok(Key::KEY_RIGHTMETA),
        "WIN_L" => Ok(Key::KEY_LEFTMETA),
        "W_R" => Ok(Key::KEY_RIGHTMETA),
        "W_L" => Ok(Key::KEY_LEFTMETA),

        // Pseudo keys for evdev relative events.
        // REL_X
        "XRIGHTCURSOR" => Ok(Key(DISGUISED_EVENT_OFFSETTER)),
        "XLEFTCURSOR" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 1)),
        // REL_Y
        "XDOWNCURSOR" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 2)),
        "XUPCURSOR" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 3)),
        // REL_Z
        "XREL_Z_AXIS_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 4)),
        "XREL_Z_AXIS_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 5)),
        // REL_RX
        "XREL_RX_AXIS_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 6)),
        "XREL_RX_AXIS_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 7)),
        // REL_RY
        "XREL_RY_AXIS_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 8)),
        "XREL_RY_AXIS_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 9)),
        // REL_RZ
        "XREL_RZ_AXIS_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 10)),
        "XREL_RZ_AXIS_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 11)),
        // REL_HWHEEL
        "XRIGHTSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 12)),
        "XLEFTSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 13)),
        // REL_DIAL
        "XREL_DIAL_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 14)),
        "XREL_DIAL_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 15)),
        // REL_WHEEL
        "XUPSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 16)),
        "XDOWNSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 17)),
        // REL_MISC
        "XREL_MISC_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 18)),
        "XREL_MISC_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 19)),
        // REL_RESERVED
        "XREL_RESERVED_1" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 20)),
        "XREL_RESERVED_2" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 21)),
        // REL_WHEEL_HI_RES
        "XHIRES_UPSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 22)),
        "XHIRES_DOWNSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 23)),
        // REL_HWHEEL_HI_RES
        "XHIRES_RIGHTSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 24)),
        "XHIRES_LEFTSCROLL" => Ok(Key(DISGUISED_EVENT_OFFSETTER + 25)),

        // Any key
        "ANY" => Ok(KEY_MATCH_ANY),

        _ => {
            // Give warning if it's nearly correct
            if parse_modifier_alias(input).is_some() {
                Err(format!("Modifiers must have left/right specified when used as key: '{input}'").into())
            } else {
                Err(format!("Unknown key '{input}'").into())
            }
        }
    }
}

#[test]
fn test_parse_key() {
    // Can omit the 'KEY_' prefex
    assert_eq!(parse_key("Enter").unwrap(), Key::KEY_ENTER);

    // Can use lower case
    assert_eq!(parse_key("key_enter").unwrap(), Key::KEY_ENTER);

    // Can use uppercase keys
    assert_eq!(parse_key("KEY_ENTER").unwrap(), Key::KEY_ENTER);

    // S is KEY_S, not shift.
    assert_eq!(parse_key("S").unwrap(), Key::KEY_S);

    // Modifier without sidedness can't be a key.
    assert_eq!(
        parse_key("Shift").unwrap_err().to_string(),
        "Modifiers must have left/right specified when used as key: 'Shift'"
    );
}

#[test]
fn test_parse_literal_key_code() {
    assert_eq!(parse_key("Code_123").unwrap(), Key(123));
    assert_eq!(parse_key("Code_0012").unwrap(), Key(12));

    assert_eq!(parse_key("Code_abc").unwrap_err().to_string(), "Invalid key_code in: CODE_ABC");
    assert_eq!(parse_key("Code_70000").unwrap_err().to_string(), "Invalid key_code in: CODE_70000");
}