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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382

//! These tests inject programmatically mouse 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 strange behavior of your mouse if real mouse is present, beware.
//! Also, these tests do not distinguish injected or real mouse events. So running the tests while using the mouse will give random failures.

#[cfg(test)]
mod mouse_hook_tests {
    use willhook::*;
    use willhook::event::MouseButtonPress::*;
    use willhook::event::MouseButton::*;
    use willhook::event::MouseClick::*;
    use mki::{Keyboard, Mouse};

    mod mouse_clicks {
        use crate::mouse_hook_tests::*;

        #[test]
        fn press_one_mouse_key() {
            utils::fixme::press(Mouse::Left);

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

            utils::fixme::press(Mouse::Left);

            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert!(h.try_recv().is_err());
        }    
        
        #[test]
        fn release_one_mouse_key() {
            utils::fixme::release(Mouse::Left);
        
            let h = mouse_hook().unwrap();
            assert!(h.try_recv().is_err());

            utils::fixme::release(Mouse::Left);

            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert!(h.try_recv().is_err());
        }
        
        #[test]
        fn click_one_mouse_key() {
            let h = mouse_hook().unwrap();
            assert!(h.try_recv().is_err());

            utils::fixme::click(Mouse::Left);

            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert!(h.try_recv().is_err());
        }

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

            utils::fixme::press(Mouse::Right);
            utils::fixme::click(Mouse::Left);
            utils::fixme::release(Mouse::Right);

            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Up));
            assert!(h.try_recv().is_err());
        }

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

            utils::fixme::press(Mouse::Right);
            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Down));
            assert!(h.try_recv().is_err());

            utils::fixme::press(Mouse::Left);
            utils::fixme::release(Mouse::Left);
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert!(h.try_recv().is_err());

            utils::fixme::release(Mouse::Right);
            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Up));
            assert!(h.try_recv().is_err());

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

        #[test]
        fn multiple_buttons() {        
            utils::fixme::press(Mouse::Left);
            utils::fixme::click(Mouse::Right);
            let h = mouse_hook().unwrap();
            assert!(h.try_recv().is_err());

            utils::fixme::press(Mouse::Left);
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert!(h.try_recv().is_err());

            utils::fixme::press(Mouse::Right);
            utils::fixme::click(Mouse::Middle);
            utils::fixme::release(Mouse::Left);
            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Middle(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Middle(SingleClick), Up));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert!(h.try_recv().is_err());

            utils::fixme::release(Mouse::Extra);
            assert_eq!(h.try_recv(), utils::a_button(X2(SingleClick), Up));
            assert!(h.try_recv().is_err());
            
            utils::fixme::release(Mouse::Side);
            utils::fixme::click(Mouse::Left);
            utils::fixme::click(Mouse::Extra);
            assert_eq!(h.try_recv(), utils::a_button(X1(SingleClick), Up));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert_eq!(h.try_recv(), utils::a_button(X2(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(X2(SingleClick), Up));
            assert!(h.try_recv().is_err());
        }

        #[test]
        fn multiple_hooks_test() {
            {
                utils::fixme::press(Mouse::Left);
                utils::fixme::click(Mouse::Left);
                let h1 = mouse_hook().unwrap();
                assert!(h1.try_recv().is_err());

                utils::fixme::press(Mouse::Left);
                assert_eq!(h1.try_recv(), utils::a_button(Left(SingleClick), Down));
                assert!(h1.try_recv().is_err());

                // These events are received by h1
                utils::fixme::press(Mouse::Left);
                utils::fixme::release(Mouse::Left);
            }

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

                utils::fixme::click(Mouse::Left);
                assert_eq!(h2.try_recv(), utils::a_button(Left(SingleClick), Down));
                assert_eq!(h2.try_recv(), utils::a_button(Left(SingleClick), Up));
                assert!(h2.try_recv().is_err());

                utils::fixme::release(Mouse::Right);
                assert_eq!(h2.try_recv(), utils::a_button(Right(SingleClick), Up));
                assert!(h2.try_recv().is_err());

                // This J release is captured by h2, but will not be seen by h3
                utils::fixme::release(Mouse::Left);
            }
            let h3 = mouse_hook().unwrap();
            assert!(h3.try_recv().is_err());
            
            utils::fixme::click(Mouse::Left);
            utils::fixme::click(Mouse::Right);        
            assert_eq!(h3.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h3.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert_eq!(h3.try_recv(), utils::a_button(Right(SingleClick), Down));
            assert_eq!(h3.try_recv(), utils::a_button(Right(SingleClick), Up));
            assert!(h3.try_recv().is_err());
        }

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

            use mki::Keyboard;

            Keyboard::A.click();
            Keyboard::B.click();
            utils::fixme::click(Mouse::Left);    
            Keyboard::C.click();

            utils::fixme::delay_execution();

            assert_eq!(h1.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h1.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert!(h1.try_recv().is_err());
        }
    }

    mod mouse_moves {
        use crate::mouse_hook_tests::*;

        // Mouse move tests do not work properly on the GitHub CI Action.
        // I'm not sure why, because they pass locally.
        // Use `cargo test --tests -- --test-threads=1 --include-ignored` before publish.
        #[ignore]
        #[test]
        fn move_once() {
            utils::fixme::move_by(10, 10);

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

            let (new_x, new_y) = utils::fixme::move_by(10, 10);

            assert_eq!(h.try_recv(), utils::a_move(new_x, new_y));
            assert!(h.try_recv().is_err());
        }

        #[test]
        fn move_once_generates_mouse_move() {
            utils::fixme::move_by(10, 10);

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

            utils::fixme::move_by(10, 10);
            assert!(utils::is_mouse_move(h.try_recv()));
            assert!(h.try_recv().is_err());
        }

        // Mouse move tests do not work properly on the GitHub CI Action.S
        // I'm not sure why, because they pass locally.
        // Use `cargo test --tests -- --test-threads=1 --include-ignored` before publish.
        #[ignore]
        #[test]
        fn move_couple_of_times() {
            utils::fixme::move_by(10, 10);

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

            let new_pos = vec![
                utils::fixme::move_by(10, 15),
                utils::fixme::move_by(-10, 10),
                utils::fixme::move_by(-15, -15),
                utils::fixme::move_by(10, -10),
                utils::fixme::move_by(15, 0),
                utils::fixme::move_by(0, 10),
            ];

            for np in new_pos {
                let (new_x, new_y) = np;
                assert_eq!(h.try_recv(), utils::a_move(new_x, new_y));
            }
            assert!(h.try_recv().is_err());
        }

        #[test]
        fn move_couple_of_times_generates_mouse_move() {
            utils::fixme::move_by(10, 10);

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

            let new_pos = vec![
                utils::fixme::move_by(10, 15),
                utils::fixme::move_by(-10, 10),
                utils::fixme::move_by(-15, -15),
                utils::fixme::move_by(10, -10),
                utils::fixme::move_by(15, 0),
                utils::fixme::move_by(0, 10),
            ];

            // This test runs on the GitHub CI and tests only if we receive mouse move event
            // Mouse moves behave unpredictably on the GitHub CI (point values mismatch)
            for _ in new_pos {
                assert!(utils::is_mouse_move(h.try_recv()));
            }
            assert!(h.try_recv().is_err());
        }
    }

    mod mouse_wheel {
        use crate::mouse_hook_tests::*;

        #[test]
        pub fn wheels() {
            utils::fixme::horizontal_wheel_forward();
            utils::fixme::horizontal_wheel_backward();
            utils::fixme::vertical_wheel_forward();
            utils::fixme::vertical_wheel_backward();
            
            let h = willhook().unwrap();

            utils::fixme::vertical_wheel_backward();
            utils::fixme::vertical_wheel_forward();
            utils::fixme::horizontal_wheel_forward();
            utils::fixme::horizontal_wheel_backward();

            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Forward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Horizontal, MouseWheelDirection::Forward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Horizontal, MouseWheelDirection::Backward));
            assert!(h.try_recv().is_err());
        }

        #[test]
        pub fn wheels_interleaved_receive() {
            let h = willhook().unwrap();

            utils::fixme::vertical_wheel_backward();
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert!(h.try_recv().is_err());

            utils::fixme::horizontal_wheel_forward();
            utils::fixme::horizontal_wheel_backward();
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Horizontal, MouseWheelDirection::Forward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Horizontal, MouseWheelDirection::Backward));
            assert!(h.try_recv().is_err());

            utils::fixme::vertical_wheel_forward();
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Forward));
            assert!(h.try_recv().is_err());
        }
    }

    mod mixed {
        use crate::mouse_hook_tests::*;

        #[test]
        pub fn mixed_mouse_inputs() {            
            let h = mouse_hook().unwrap();

            utils::fixme::vertical_wheel_backward();
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert!(h.try_recv().is_err());

            Keyboard::A.click();
            utils::fixme::vertical_wheel_backward();
            utils::fixme::move_by(10, 15);
            utils::fixme::vertical_wheel_forward();
            Keyboard::B.click();
            utils::fixme::horizontal_wheel_forward();
            utils::fixme::move_by(-10, 10);
            utils::fixme::click(Mouse::Middle);
            utils::fixme::move_by(-15, -15);
            Keyboard::C.click();
            utils::fixme::move_by(10, -10);
            utils::fixme::horizontal_wheel_backward();
            utils::fixme::press(Mouse::Right);
            utils::fixme::move_by(15, 0);
            Keyboard::C.click();
            utils::fixme::release(Mouse::Right);
            utils::fixme::move_by(0, 10);
            utils::fixme::press(Mouse::Left);
            utils::fixme::release(Mouse::Left);

            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert!(utils::is_mouse_move(h.try_recv()));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Forward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Horizontal, MouseWheelDirection::Forward));
            assert!(utils::is_mouse_move(h.try_recv()));
            assert_eq!(h.try_recv(), utils::a_button(Middle(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Middle(SingleClick), Up));
            assert!(utils::is_mouse_move(h.try_recv()));
            assert!(utils::is_mouse_move(h.try_recv()));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Horizontal, MouseWheelDirection::Backward));
            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Down));
            assert!(utils::is_mouse_move(h.try_recv()));
            assert_eq!(h.try_recv(), utils::a_button(Right(SingleClick), Up));
            assert!(utils::is_mouse_move(h.try_recv()));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Down));
            assert_eq!(h.try_recv(), utils::a_button(Left(SingleClick), Up));
            assert!(h.try_recv().is_err());

            utils::fixme::vertical_wheel_backward();
            utils::fixme::vertical_wheel_backward();
            utils::fixme::vertical_wheel_backward();
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert_eq!(h.try_recv(), utils::a_wheel(MouseWheel::Vertical, MouseWheelDirection::Backward));
            assert!(h.try_recv().is_err());
        }
    }
}