colpetto 0.7.0

Async libinput wrapper
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

//! Key events are generated when a key changes its logical state, usually by being pressed or released.

use crate::sys::{
    self, libinput_event_get_keyboard_event, libinput_event_keyboard,
    libinput_event_keyboard_get_base_event,
};

super::define_events!(
    /// A keyboard event representing a key press/release.
    Keyboard,
    libinput_event_keyboard,
    libinput_event_keyboard_get_base_event,
    libinput_event_get_keyboard_event,
    /// Signals that a device has been removed. No more events from the associated device will be in the queue or be queued after this event.
    Key,
);

impl KeyboardKeyEvent {
    /// The keycode that triggered this key event
    pub fn key(&self) -> u32 {
        unsafe { sys::libinput_event_keyboard_get_key(self.raw) }
    }

    /// The state change of the key
    pub fn key_state(&self) -> KeyState {
        KeyState::from_raw(unsafe { sys::libinput_event_keyboard_get_key_state(self.raw) })
    }

    /// The seat wide pressed key count for the key of this event
    pub fn seat_key_count(&self) -> u32 {
        unsafe { sys::libinput_event_keyboard_get_seat_key_count(self.raw) }
    }

    /// The event time for this event
    ///
    /// # Note
    ///
    /// Timestamps may not always increase. See the libinput documentation for more details.
    pub fn time(&self) -> u32 {
        unsafe { sys::libinput_event_keyboard_get_time(self.raw) }
    }

    /// The event time for this event in microseconds
    ///
    /// # Note
    ///
    /// Timestamps may not always increase. See the libinput documentation for more details.
    pub fn time_usec(&self) -> u64 {
        unsafe { sys::libinput_event_keyboard_get_time_usec(self.raw) }
    }
}

/// Logical state of a key. Note that the logical state may not represent the physical state of the key.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum KeyState {
    /// Logical released state
    Released,
    /// Logical pressed state
    Pressed,
}

impl std::fmt::Display for KeyState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            KeyState::Released => write!(f, "released"),
            KeyState::Pressed => write!(f, "pressed"),
        }
    }
}

impl KeyState {
    /// Builds a new keystate from a raw libinput one
    pub const fn from_raw(raw: sys::libinput_key_state) -> Self {
        match raw {
            sys::libinput_key_state::LIBINPUT_KEY_STATE_RELEASED => Self::Released,
            sys::libinput_key_state::LIBINPUT_KEY_STATE_PRESSED => Self::Pressed,
            _ => panic!("libinput returned an invalid keystate"), // FIXME: I dont think panicking is a good idea. Maybe we could return an option?
        }
    }
}