willhook 0.6.3

Capture all keyboard and mouse input regardless of application focus on the active windows desktop
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

//! These tests inject programmatically keyboard events and verify if willhook's hook receive them properly.
//! It is important to keep in mind, that these injected events are going through Windows OS.
//! These injected events will appear in the context of the currently focused window.
//! Hence, it is best to invoke below tests in one-time CLI environment.
//! You may observe it by letters appearing in CLI input after test run finishes, like so:
//! PS C:\workspace\willhook> cfgklaa
//! It can become real mess especially if you run tests from GUI program

#[cfg(test)]
mod keyboard_hook_tests {
    use willhook::*;
    use willhook::event::KeyPress::*;
    use willhook::event::KeyboardKey::*;
    use willhook::event::IsSystemKeyPress::*;
    use mki::Keyboard;

    #[test]
    fn press_one_keyboard_key() {
        Keyboard::A.press();

        let h = keyboard_hook().unwrap();
        assert!(h.try_recv().is_err());

        Keyboard::A.press();

        assert_eq!(h.try_recv(), utils::a_key(A, Down(Normal)));
        assert!(h.try_recv().is_err());
    }    
    
    #[test]
    fn release_one_keyboard_key() {
        Keyboard::B.release();
    
        let h = keyboard_hook().unwrap();
        assert!(h.try_recv().is_err());

        Keyboard::B.release();

        assert_eq!(h.try_recv(), utils::a_key(B, Up(Normal)));
        assert!(h.try_recv().is_err());
    }
    
    #[test]
    fn click_one_keyboard_key() {
        let h = keyboard_hook().unwrap();
        assert!(h.try_recv().is_err());

        Keyboard::C.click();

        assert_eq!(h.try_recv(), utils::a_key(C, Down(Normal)));
        assert_eq!(h.try_recv(), utils::a_key(C, Up(Normal)));
        assert!(h.try_recv().is_err());
    }

    #[test]
    fn click_one_system_key() {
        let h = keyboard_hook().unwrap();
        assert!(h.try_recv().is_err());

        Keyboard::LeftAlt.press();
        Keyboard::D.click();
        Keyboard::LeftAlt.release();

        assert_eq!(h.try_recv(), utils::a_key(LeftAlt, Down(System)));
        assert_eq!(h.try_recv(), utils::a_key(D, Down(System)));
        assert_eq!(h.try_recv(), utils::a_key(D, Up(System)));
        assert_eq!(h.try_recv(), utils::a_key(LeftAlt, Up(Normal)));
        assert!(h.try_recv().is_err());
    }

    #[test]
    fn click_one_system_key_receive_interleaving() {
        let h = keyboard_hook().unwrap();
        assert!(h.try_recv().is_err());

        Keyboard::LeftAlt.press();
        assert_eq!(h.try_recv(), utils::a_key(LeftAlt, Down(System)));
        assert!(h.try_recv().is_err());

        Keyboard::E.press();
        Keyboard::E.release();
        assert_eq!(h.try_recv(), utils::a_key(E, Down(System)));
        assert_eq!(h.try_recv(), utils::a_key(E, Up(System)));
        assert!(h.try_recv().is_err());

        Keyboard::LeftAlt.release();
        assert_eq!(h.try_recv(), utils::a_key(LeftAlt, Up(Normal)));
        assert!(h.try_recv().is_err());

        assert!(h.try_recv().is_err());
    }

    #[test]
    fn multiple_keys() {        
        Keyboard::F.press();
        Keyboard::G.click();
        let h = keyboard_hook().unwrap();
        assert!(h.try_recv().is_err());

        Keyboard::LeftAlt.press();
        assert_eq!(h.try_recv(), utils::a_key(LeftAlt, Down(System)));
        assert!(h.try_recv().is_err());

        Keyboard::H.press();
        Keyboard::I.click();
        Keyboard::H.release();
        assert_eq!(h.try_recv(), utils::a_key(H, Down(System)));
        assert_eq!(h.try_recv(), utils::a_key(I, Down(System)));
        assert_eq!(h.try_recv(), utils::a_key(I, Up(System)));
        assert_eq!(h.try_recv(), utils::a_key(H, Up(System)));
        assert!(h.try_recv().is_err());

        Keyboard::LeftAlt.release();
        assert_eq!(h.try_recv(), utils::a_key(LeftAlt, Up(Normal)));
        assert!(h.try_recv().is_err());
        
        Keyboard::J.release();
        Keyboard::K.click();
        Keyboard::L.click();        
        assert_eq!(h.try_recv(), utils::a_key(J, Up(Normal)));
        assert_eq!(h.try_recv(), utils::a_key(K, Down(Normal)));
        assert_eq!(h.try_recv(), utils::a_key(K, Up(Normal)));
        assert_eq!(h.try_recv(), utils::a_key(L, Down(Normal)));
        assert_eq!(h.try_recv(), utils::a_key(L, Up(Normal)));
        assert!(h.try_recv().is_err());
    }

    #[test]
    fn multiple_hooks_test() {
        {
            Keyboard::F.press();
            Keyboard::G.click();
            let h1 = keyboard_hook().unwrap();
            assert!(h1.try_recv().is_err());

            Keyboard::LeftAlt.press();
            assert_eq!(h1.try_recv(), utils::a_key(LeftAlt, Down(System)));
            assert!(h1.try_recv().is_err());

            // These events are received by h1
            Keyboard::H.press();
            Keyboard::H.release();
        }

        {
            // But H press/release should not be received by h2
            let h2 = keyboard_hook().unwrap();
            assert!(h2.try_recv().is_err());

            Keyboard::I.click();
            assert_eq!(h2.try_recv(), utils::a_key(I, Down(System)));
            assert_eq!(h2.try_recv(), utils::a_key(I, Up(System)));
            assert!(h2.try_recv().is_err());

            Keyboard::LeftAlt.release();
            assert_eq!(h2.try_recv(), utils::a_key(LeftAlt, Up(Normal)));
            assert!(h2.try_recv().is_err());

            // This J release is captured by h2, but will not be seen by h3
            Keyboard::J.release();
        }
        let h3 = keyboard_hook().unwrap();
        assert!(h3.try_recv().is_err());
        
        Keyboard::K.click();
        Keyboard::L.click();        
        assert_eq!(h3.try_recv(), utils::a_key(K, Down(Normal)));
        assert_eq!(h3.try_recv(), utils::a_key(K, Up(Normal)));
        assert_eq!(h3.try_recv(), utils::a_key(L, Down(Normal)));
        assert_eq!(h3.try_recv(), utils::a_key(L, Up(Normal)));
        assert!(h3.try_recv().is_err());
    }

    #[test]
    fn keyboard_hook_does_not_capture_mouse() {
        let h1 = keyboard_hook().unwrap();
        assert!(h1.try_recv().is_err());

        use mki::Mouse;

        Mouse::Left.click();
        Mouse::Right.click();
        Keyboard::K.click();    
        Mouse::Left.click();
        assert_eq!(h1.try_recv(), utils::a_key(K, Down(Normal)));
        assert_eq!(h1.try_recv(), utils::a_key(K, Up(Normal)));
        assert!(h1.try_recv().is_err());
    }
}