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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

#[cfg(test)]
mod tests;

use {
    crate::xkb::Keymap,
    std::fmt::{Debug, Display},
};

/// A formatter for keymaps.
///
/// # Example
///
/// ```
/// # use kbvm::xkb::Keymap;
/// fn create_keymap_for_xwayland(keymap: &Keymap) -> String {
///     format!("{}\n", keymap.format().lookup_only(true).rename_long_keys(true))
/// }
/// ```
pub struct Formatter<'a> {
    pub(crate) keymap: &'a Keymap,
    pub(crate) single_line: bool,
    pub(crate) lookup_only: bool,
    pub(crate) multiple_actions_per_level: bool,
    pub(crate) rename_long_keys: bool,
}

impl Formatter<'_> {
    /// Enables or disables formatting the keymap as a single line.
    ///
    /// By default, the keymap is pretty-printed in multiple lines.
    pub fn single_line(mut self, val: bool) -> Self {
        self.single_line = val;
        self
    }

    /// Enables or disables formatting of key behaviors and key actions.
    ///
    /// By default, key behaviors and key actions are included in the map.
    ///
    /// This should be enabled for keymaps sent by compositors to Xwayland to work around
    /// an Xwayland bug. See [`Keymap::format`].
    pub fn lookup_only(mut self, val: bool) -> Self {
        self.lookup_only = val;
        self
    }

    /// Enables or disables the automatic renaming of key names longer than 4 bytes.
    ///
    /// By default, key names are used unchanged.
    ///
    /// This should be enabled for keymaps sent by compositors to Xwayland since Xwayland
    /// cannot handle key names longer than 4 bytes.
    pub fn rename_long_keys(mut self, val: bool) -> Self {
        self.rename_long_keys = val;
        self
    }

    /// Enables or disables formatting of levels containing more than one action.
    ///
    /// By default, such actions are not formatted.
    ///
    /// This should almost always be disabled. Xwayland and libxkbcommon \<1.8 will fail
    /// to parse keymaps that contain levels with multiple actions.
    pub fn multiple_actions_per_level(mut self, val: bool) -> Self {
        self.multiple_actions_per_level = val;
        self
    }
}

impl Debug for Formatter<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Display::fmt(self, f)
    }
}