kbvm 0.1.5

An implementation of the XKB specification
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

#[allow(unused_imports)]
use crate::builder::Redirect;
use std::{
    fmt::{Debug, Formatter},
    ops::Add,
};

/// A 0-based index into the groups of a keyboard.
///
/// Since different keys can have different numbers of groups, there is no such thing as
/// an invalid group index. Instead, when using the group index, it is brought into range
/// according to the [`Redirect`] setting of the key.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Default)]
#[repr(transparent)]
pub struct GroupIndex(pub u32);

/// A group delta.
///
/// This delta can be applied to a [`GroupIndex`] to get a new `GroupIndex`. This is the
/// type of the pressed and latched group.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Default)]
#[repr(transparent)]
pub struct GroupDelta(pub u32);

impl GroupIndex {
    pub const ZERO: GroupIndex = GroupIndex(0);
}

impl Debug for GroupDelta {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0 as i32)
    }
}

impl Debug for GroupIndex {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl Add<GroupDelta> for GroupIndex {
    type Output = Self;

    fn add(self, rhs: GroupDelta) -> Self::Output {
        Self(self.0.wrapping_add(rhs.0))
    }
}

impl Add<GroupDelta> for GroupDelta {
    type Output = Self;

    fn add(self, rhs: GroupDelta) -> Self::Output {
        Self(self.0.wrapping_add(rhs.0))
    }
}