keybindings-parser 0.1.0

library for parsing human keyboard shortcuts
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

use keybindings_parser::{KeyAction, Keybindings, ModMask};
use keysymdefs::keys;

#[allow(dead_code)]
#[derive(Eq, PartialEq)]
enum TestAction {
    Kill,
    ToggleFloat,
    ToggleFullscreen,
    ToggleTabBar,
    SwapWindows,
    Spawn(String),
}

impl KeyAction for TestAction {
    fn run(&self) -> Result<(), Box<dyn std::error::Error>> {
        match self {
            TestAction::Kill => {}
            TestAction::Spawn(_) => {}
            TestAction::SwapWindows => {}
            TestAction::ToggleFloat => {
                return Err("some error")?;
            }
            TestAction::ToggleFullscreen => {}
            TestAction::ToggleTabBar => {}
        };
        Ok(())
    }
}

#[test]
fn test_handle_single_1() -> Result<(), Box<dyn std::error::Error>> {
    let mut keyb = Keybindings::default();
    let origin = "ctrl + a";
    keyb.add(origin, Box::new(TestAction::ToggleFloat))?;

    if let Some(handler) = keyb.handle(ModMask::CONTROL, keysymdefs::keys::XK_a) {
        assert_eq!(handler.modifier(), ModMask::CONTROL);
        assert_eq!(handler.key(), keys::XK_a);
        assert_eq!(handler.origin(), origin);
        assert!(handler.action().run().is_err());
        assert_eq!(
            handler.action().run().err().unwrap().to_string(),
            "some error".to_string()
        );
    }

    Ok(())
}

#[test]
fn test_capital_letter() -> Result<(), Box<dyn std::error::Error>> {
    let mut keyb = Keybindings::default();

    keyb.add("command + A", Box::new(TestAction::Kill))?;

    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_A).is_some());
    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_a).is_none());

    Ok(())
}

#[test]
fn test_ghost_modificator() -> Result<(), Box<dyn std::error::Error>> {
    let mut keyb = Keybindings::default();
    keyb.add("command + a", Box::new(TestAction::Kill))?;

    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_a).is_some());
    assert!(keyb
        .handle(ModMask::MOD4 | ModMask::MOD2, keysymdefs::keys::XK_a)
        .is_some());
    assert!(keyb
        .handle(ModMask::MOD4 | ModMask::MOD5, keysymdefs::keys::XK_a)
        .is_some());
    assert!(keyb
        .handle(
            ModMask::MOD4 | ModMask::MOD5 | ModMask::MOD2,
            keysymdefs::keys::XK_a
        )
        .is_some());

    Ok(())
}

#[test]
fn test_no_ghost_modificators() {
    let mut keyb = Keybindings::new('+', ModMask::NONE);
    assert!(keyb.add("command + a", Box::new(TestAction::Kill)).is_ok());

    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_a).is_some());
    assert!(keyb
        .handle(ModMask::MOD4 | ModMask::MOD2, keysymdefs::keys::XK_a)
        .is_none());
    assert!(keyb
        .handle(ModMask::MOD4 | ModMask::MOD5, keysymdefs::keys::XK_a)
        .is_none());
    assert!(keyb
        .handle(
            ModMask::MOD4 | ModMask::MOD5 | ModMask::MOD2,
            keysymdefs::keys::XK_a
        )
        .is_none());
}

#[test]
fn test_custom_delimiter() {
    let mut keyb = Keybindings::new('/', ModMask::NONE);
    assert!(keyb.add("command / a", Box::new(TestAction::Kill)).is_ok());
    assert!(keyb.add("command + b", Box::new(TestAction::Kill)).is_err());
    assert!(keyb
        .add("command // b", Box::new(TestAction::Kill))
        .is_err());
    assert!(keyb
        .add("command \\// b", Box::new(TestAction::Kill))
        .is_err());

    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_a).is_some());
    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_b).is_none());
}

#[test]
fn test_no_modkey() {
    let mut keyb = Keybindings::default();
    assert!(keyb.add("command + a", Box::new(TestAction::Kill)).is_ok());
    assert!(keyb.add("b", Box::new(TestAction::Kill)).is_ok());

    assert!(keyb.handle(ModMask::MOD4, keysymdefs::keys::XK_a).is_some());
    assert!(keyb.handle(ModMask::NONE, keysymdefs::keys::XK_b).is_some());
}

#[test]
fn test_no_modkey_ghost_modkeys() {
    let mut keyb = Keybindings::default();
    assert!(keyb.add("command + a", Box::new(TestAction::Kill)).is_ok());
    assert!(keyb.add("b", Box::new(TestAction::Kill)).is_ok());

    assert!(keyb
        .handle(ModMask::MOD4 | ModMask::MOD2, keysymdefs::keys::XK_a)
        .is_some());
    assert!(keyb
        .handle(ModMask::NONE | ModMask::MOD5, keysymdefs::keys::XK_b)
        .is_some());
    assert!(keyb.handle(ModMask::MOD5, keysymdefs::keys::XK_b).is_some());
}