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

use crate::keyboard::{KeyCode, PhysicalKey};

// TODO: Describe what this value contains for each platform

/// Additional methods for the [`PhysicalKey`] type that allow the user to access the
/// platform-specific scancode.
///
/// [`PhysicalKey`]: crate::keyboard::PhysicalKey
pub trait PhysicalKeyExtScancode {
    /// The raw value of the platform-specific physical key identifier.
    ///
    /// Returns `Some(key_id)` if the conversion was successful; returns `None` otherwise.
    ///
    /// ## Platform-specific
    /// - **Windows:** A 16bit extended scancode
    /// - **Wayland/X11**: A 32-bit linux scancode, which is X11/Wayland keycode subtracted by 8.
    fn to_scancode(self) -> Option<u32>;

    /// Constructs a `PhysicalKey` from a platform-specific physical key identifier.
    ///
    /// Note that this conversion may be lossy, i.e. converting the returned `PhysicalKey` back
    /// using `to_scancode` might not yield the original value.
    ///
    /// ## Platform-specific
    /// - **Wayland/X11**: A 32-bit linux scancode. When building from X11/Wayland keycode subtract
    ///   `8` to get the value you wanted.
    fn from_scancode(scancode: u32) -> PhysicalKey;
}

impl PhysicalKeyExtScancode for PhysicalKey {
    fn to_scancode(self) -> Option<u32> {
        crate::platform_impl::physicalkey_to_scancode(self)
    }

    fn from_scancode(scancode: u32) -> PhysicalKey {
        crate::platform_impl::scancode_to_physicalkey(scancode)
    }
}

impl PhysicalKeyExtScancode for KeyCode {
    #[inline]
    fn to_scancode(self) -> Option<u32> {
        <PhysicalKey as PhysicalKeyExtScancode>::to_scancode(PhysicalKey::Code(self))
    }

    #[inline]
    fn from_scancode(scancode: u32) -> PhysicalKey {
        <PhysicalKey as PhysicalKeyExtScancode>::from_scancode(scancode)
    }
}