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
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

//! RMLVO helpers and types.

use {crate::xkb::format::FormatFormat, std::fmt::Display};

#[macro_use]
mod macros;
#[cfg(test)]
mod formatter;
pub(crate) mod lexer;
pub(crate) mod parser;
pub(crate) mod resolver;
mod token;

/// An RMLVO group consisting of a layout and a variant.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct Group<'a> {
    /// The layout of the group.
    pub layout: &'a str,
    /// The variant of the group.
    pub variant: &'a str,
}

impl<'a> Group<'a> {
    /// Creates a Group iterator from comma-separated lists of layouts and variants.
    ///
    /// # Example
    ///
    /// ```
    /// # use kbvm::xkb::rmlvo::Group;
    /// let layout = "us,il,ru,de,jp";
    /// let variant = ",,phonetic,neo";
    /// let groups: Vec<_> = Group::from_layouts_and_variants(layout, variant).collect();
    /// assert_eq!(
    ///     groups,
    ///     [
    ///         Group { layout: "us", variant: "" },
    ///         Group { layout: "il", variant: "" },
    ///         Group { layout: "ru", variant: "phonetic" },
    ///         Group { layout: "de", variant: "neo" },
    ///         Group { layout: "jp", variant: "" },
    ///     ],
    /// );
    /// ```
    pub fn from_layouts_and_variants(
        layout: &'a str,
        variant: &'a str,
    ) -> impl Iterator<Item = Self> {
        let layouts = layout.split(',');
        let mut variants = variant.split(',');
        layouts.map(move |layout| Group {
            layout: layout.trim(),
            variant: variants.next().unwrap_or_default().trim(),
        })
    }
}

/// An include merge mode.
///
/// # Example
///
/// ```xkb
/// xkb_symbols {
///     override "pc"
///     override "de(neo)"
///     augment "inet(evdev)"
/// };
/// ```
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum MergeMode {
    /// In case of conflict, the previous definition is retained.
    Augment,
    /// In case of conflict, the new definition overrides the old one.
    Override,
    /// In case of conflict, the new definition replaces the old one.
    Replace,
}

/// An include statement in an XKB section.
///
/// This is part of [`Expanded`].
///
/// # Example
///
/// ```xkb
/// xkb_symbols {
///     override "pc"
///     override "de(neo)"
///     augment "inet(evdev)"
/// };
/// ```
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct Element {
    /// The merge mode.
    pub merge_mode: MergeMode,
    /// The include string.
    pub include: String,
}

/// Expanded RMLVO names.
///
/// # Example
///
/// ```xkb
/// xkb_keymap {
///     xkb_keycodes {
///         override "evdev"
///         override "aliases(qwertz)"
///     };
///     xkb_types {
///         override "complete"
///     };
///     xkb_compat {
///         override "complete"
///         override "caps(caps_lock)"
///         override "misc(assign_shift_left_action)"
///         override "level5(level5_lock)"
///     };
///     xkb_symbols {
///         override "pc"
///         override "de(neo)"
///         override "inet(evdev)"
///     };
///     xkb_geometry {
///         override "pc(pc105)"
///     };
/// };
/// ```
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct Expanded {
    /// The elements of the `xkb_keycodes` section.
    pub keycodes: Vec<Element>,
    /// The elements of the `xkb_types` section.
    pub types: Vec<Element>,
    /// The elements of the `xkb_compat` section.
    pub compat: Vec<Element>,
    /// The elements of the `xkb_symbols` section.
    pub symbols: Vec<Element>,
    /// The elements of the `xkb_geometry` section.
    pub geometry: Vec<Element>,
}

impl Expanded {
    /// Returns a type that can be used to format the expanded map in XKB text format.
    ///
    /// See the type documentation for an example.
    ///
    /// By default, the map will be formatted in a single line. You can enable multi-line
    /// formatting by using the alternate modifier `#`.
    pub fn format(&self) -> impl Display + use<'_> {
        FormatFormat(self)
    }
}