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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
use bitmask_enum::bitmask;
use core::mem::{size_of, transmute};
use static_assertions::const_assert_eq;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::{Class, StateChange, ValueChange};

/// Mouse HID class
#[derive(Clone, Copy, Debug)]
pub struct Mouse;

impl Class for Mouse {
    type Input = MouseInput;
    type Output = MouseOutput;

    fn input(&self) -> Self::Input {
        Self::Input::default()
    }

    fn output(&self) -> Self::Output {
        Self::Output::default()
    }
}

impl AsRef<str> for Mouse {
    fn as_ref(&self) -> &str {
        "mouse"
    }
}

impl core::fmt::Display for Mouse {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.write_str(self.as_ref())
    }
}

/// Button mask
#[bitmask(u8)]
pub enum Buttons {
    /// Primary button
    ///
    /// Usually left for right hand.
    Primary = 0x01,

    /// Secondary button
    ///
    /// Usually right for right hand.
    Secondary = 0x02,

    /// Tertiary button
    ///
    /// Usually middle.
    Tertiary = 0x04,
}

const_assert_eq!(size_of::<Buttons>(), 1);

impl Default for Buttons {
    fn default() -> Self {
        Self::none()
    }
}

impl Buttons {
    /// Converts from raw value safely
    pub fn safe_from(raw: u8) -> Option<Self> {
        Some(Self::from(raw))
    }
}

code_enum! {
    /// Button code
    Button: u8 {
        /// No button
        None = 0x00 => "none" | "0",

        /// Primary button
        ///
        /// Usually left for right hand.
        Primary = 0x01 => "primary" | "first" | "1",

        /// Secondary button
        ///
        /// Usually right for right hand.
        Secondary = 0x02 => "secondary" | "second" | "2",

        /// Tertiary button
        ///
        /// Usually middle.
        Tertiary = 0x03 => "tertiary" | "third" | "3",
    }
}

impl From<Buttons> for Button {
    fn from(mods: Buttons) -> Self {
        let off = mods.bits.trailing_zeros() as u8;
        if off < 3 {
            Button::from(off + 1)
        } else {
            Button::None
        }
    }
}

impl From<Button> for Buttons {
    fn from(key: Button) -> Self {
        let code = key as u8;
        Buttons::from(if code != 0 { 1 << (code - 1) } else { 0 })
    }
}

impl Button {
    /// Converts from raw value safely
    pub fn safe_from(raw: u8) -> Option<Self> {
        if raw <= 3 {
            Some(From::from(raw))
        } else {
            None
        }
    }
}

impl Default for Button {
    fn default() -> Self {
        Self::None
    }
}

serde_num! {
    Buttons: u8, "a button mask";
    Button: u8, "a numeric button code";
}

/// Mouse input report
#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[repr(C, packed)]
pub struct MouseInput {
    /// Pressed buttons
    #[cfg_attr(feature = "serde", serde(rename = "b"))]
    button: Buttons,
    /// Pointer coordinates
    #[cfg_attr(feature = "serde", serde(rename = "p"))]
    pointer: (i16, i16),
    /// Mouse wheel coordinate
    #[cfg_attr(feature = "serde", serde(rename = "w"))]
    wheel: i8,
}

const_assert_eq!(size_of::<MouseInput>(), 6);

impl MouseInput {
    /// Get button mask
    pub fn mods(&self) -> Buttons {
        self.button
    }

    /// Get number of pressed buttons
    pub fn count_pressed(&self) -> usize {
        self.button.bits.count_ones() as _
    }

    /// Get iterator over pressed buttons
    pub fn pressed(&self) -> PressedButtons<'_> {
        PressedButtons {
            report: self,
            element: 0,
        }
    }

    /// Press or release buttons
    pub fn change_buttons(&mut self, mask: Buttons, state: bool) {
        if state {
            self.button |= mask;
        } else {
            self.button &= !mask;
        }
    }

    /// Press buttons
    pub fn press_buttons(&mut self, mask: Buttons) {
        self.change_buttons(mask, true);
    }

    /// Release buttons
    pub fn release_buttons(&mut self, mask: Buttons) {
        self.change_buttons(mask, false);
    }

    /// Press or release button
    pub fn change_button(&mut self, code: Button, state: bool) {
        self.change_buttons(code.into(), state);
    }

    /// Press button
    pub fn press_button(&mut self, code: Button) {
        self.change_button(code, true);
    }

    /// Release button
    pub fn release_button(&mut self, code: Button) {
        self.change_button(code, false);
    }

    /// Get XY coordinates
    pub fn pointer(&self) -> (i16, i16) {
        self.pointer
    }

    /// Set XY coordinates
    pub fn set_pointer(&mut self, pointer: (i16, i16)) {
        self.pointer = pointer;
    }

    /// Change XY coordinates
    pub fn change_pointer(&mut self, pointer: (i16, i16), relative: bool) {
        if relative {
            self.pointer = (self.pointer.0 + pointer.0, self.pointer.1 + pointer.1);
        } else {
            self.pointer = pointer;
        }
    }

    /// Get wheel value
    pub fn wheel(&self) -> i8 {
        self.wheel
    }

    /// Set wheel value
    pub fn set_wheel(&mut self, wheel: i8) {
        self.wheel = wheel;
    }

    /// Change wheel value
    pub fn change_wheel(&mut self, wheel: i8, relative: bool) {
        if relative {
            self.wheel += wheel;
        } else {
            self.wheel = wheel;
        }
    }

    /// Change mouse input
    pub fn change(&mut self, change: &MouseInputChange) {
        match change {
            MouseInputChange::Button(change) => self.change_button(**change, change.state()),
            MouseInputChange::Pointer(change) => {
                self.change_pointer(**change, change.is_relative())
            }
            MouseInputChange::Wheel(change) => self.change_wheel(**change, change.is_relative()),
        }
    }

    /// Get changes between two reports
    ///
    /// Difference of two reports
    pub fn diff<'i>(
        &'i self,
        other: &'i Self,
        relative_pointer: bool,
        relative_wheel: bool,
    ) -> MouseInputChanges<'i> {
        MouseInputChanges {
            new: self,
            old: other,
            element: 0,
            relative_pointer,
            relative_wheel,
        }
    }
}

impl<'i> core::ops::Sub<&'i MouseInput> for &'i MouseInput {
    type Output = MouseInputChanges<'i>;

    fn sub(self, other: Self) -> Self::Output {
        self.diff(other, false, false)
    }
}

/// Change between mouse input reports
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum MouseInputChange {
    /// Button state change
    Button(StateChange<Button>),
    /// Pointer coordinates change
    Pointer(ValueChange<(i16, i16)>),
    /// Wheel value change
    Wheel(ValueChange<i8>),
}

/// Changes between mouse input reports
pub struct MouseInputChanges<'i> {
    new: &'i MouseInput,
    old: &'i MouseInput,
    element: u8,
    relative_pointer: bool,
    relative_wheel: bool,
}

impl<'i> Iterator for MouseInputChanges<'i> {
    type Item = MouseInputChange;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            if self.element < 8 {
                // find changed buttons
                let buttons = Buttons::from(1 << self.element);
                self.element += 1;
                if Buttons::none() != ((self.new.button ^ self.old.button) & buttons) {
                    let button = Button::from(buttons);
                    let old_button = Button::from(self.old.button & buttons);
                    return Some(MouseInputChange::Button(StateChange::new(
                        button,
                        matches!(old_button, Button::None),
                    )));
                }
            } else if self.element < 9 {
                // changed pointer coords
                self.element += 1;
                if self.new.pointer.0 != self.old.pointer.0
                    || self.new.pointer.1 != self.old.pointer.1
                {
                    return Some(MouseInputChange::Pointer(ValueChange::new(
                        if self.relative_pointer {
                            (
                                self.new.pointer.0 - self.old.pointer.0,
                                self.new.pointer.1 - self.old.pointer.1,
                            )
                        } else {
                            (self.new.pointer.0, self.new.pointer.1)
                        },
                        self.relative_pointer,
                    )));
                }
            } else if self.element < 10 {
                self.element += 1;
                if self.new.wheel != self.old.wheel {
                    return Some(MouseInputChange::Wheel(ValueChange::new(
                        if self.relative_wheel {
                            self.new.wheel - self.old.wheel
                        } else {
                            self.new.wheel
                        },
                        self.relative_wheel,
                    )));
                }
            } else {
                return None;
            }
        }
    }
}

impl Extend<StateChange<Buttons>> for MouseInput {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = StateChange<Buttons>>,
    {
        for StateChange { data, state } in iter {
            self.change_buttons(data, state);
        }
    }
}

impl Extend<StateChange<Button>> for MouseInput {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = StateChange<Button>>,
    {
        for StateChange { data, state } in iter {
            self.change_button(data, state);
        }
    }
}

impl Extend<ValueChange<(i16, i16)>> for MouseInput {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = ValueChange<(i16, i16)>>,
    {
        for ValueChange { data, relative } in iter {
            self.change_pointer(data, relative);
        }
    }
}

impl Extend<(i16, i16)> for MouseInput {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = (i16, i16)>,
    {
        for data in iter {
            self.set_pointer(data);
        }
    }
}

impl Extend<ValueChange<i8>> for MouseInput {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = ValueChange<i8>>,
    {
        for ValueChange { data, relative } in iter {
            self.change_wheel(data, relative)
        }
    }
}

impl Extend<MouseInput> for MouseInput {
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = MouseInput>,
    {
        for item in iter {
            *self = item;
        }
    }
}

/// An iterator over pressed buttons
pub struct PressedButtons<'i> {
    report: &'i MouseInput,
    element: u8,
}

impl<'i> Iterator for PressedButtons<'i> {
    type Item = Button;

    fn next(&mut self) -> Option<Self::Item> {
        while self.element < 8 {
            let mask = Buttons::from(1u8 << self.element);
            self.element += 1;
            if self.report.button.contains(mask) {
                return Some(mask.into());
            }
        }
        None
    }
}

/// Keyboard output report
#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[repr(C, packed)]
pub struct MouseOutput {}

const_assert_eq!(size_of::<MouseOutput>(), 0);

raw_ref! {
    Buttons;
    Button;
    MouseInput;
    MouseOutput;
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn button_mask_to_code() {
        assert_eq!(Button::from(Buttons::default()), Button::None);
        assert_eq!(Button::from(Buttons::from(0)), Button::None);
        assert_eq!(Button::from(Buttons::Primary), Button::Primary);
        assert_eq!(Button::from(Buttons::Secondary), Button::Secondary);
        assert_eq!(Button::from(Buttons::Tertiary), Button::Tertiary);
    }

    #[test]
    fn button_code_to_mask() {
        assert_eq!(Buttons::from(Button::None), Buttons::default());
        assert_eq!(Buttons::from(Button::Primary), Buttons::Primary);
        assert_eq!(Buttons::from(Button::Secondary), Buttons::Secondary);
        assert_eq!(Buttons::from(Button::Tertiary), Buttons::Tertiary);
    }

    #[test]
    fn mouse_input_diff() {
        let mut old = MouseInput::default();

        old.press_button(Button::Primary);
        old.press_button(Button::Tertiary);
        old.set_pointer((120, 450));
        old.set_wheel(7);

        let mut new = MouseInput::default();

        new.press_button(Button::Tertiary);
        new.press_button(Button::Secondary);
        new.set_pointer((120, 150));
        new.set_wheel(-1);

        let mut changes = &new - &old;

        assert_eq!(
            changes.next(),
            Some(MouseInputChange::Button(StateChange::release(
                Button::Primary
            )))
        );
        assert_eq!(
            changes.next(),
            Some(MouseInputChange::Button(StateChange::press(
                Button::Secondary
            )))
        );
        assert_eq!(
            changes.next(),
            Some(MouseInputChange::Pointer(ValueChange::new(
                (120, 150),
                false
            )))
        );
        assert_eq!(
            changes.next(),
            Some(MouseInputChange::Wheel(ValueChange::new(-1, false)))
        );
        assert_eq!(changes.next(), None);

        new.release_button(Button::Secondary);
        new.set_wheel(7);

        let mut changes = new.diff(&old, true, true);

        assert_eq!(
            changes.next(),
            Some(MouseInputChange::Button(StateChange::release(
                Button::Primary
            )))
        );
        assert_eq!(
            changes.next(),
            Some(MouseInputChange::Pointer(ValueChange::new((0, -300), true)))
        );
        assert_eq!(changes.next(), None);
    }
}