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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
use {
crate::{
ModifierIndex,
builder::Redirect,
group_type,
lookup::LookupTable,
syms,
xkb::{
Keymap,
group::GroupIdx,
keymap::{
Indicator, Key, KeyGroup, KeyLevel, KeyType, KeyTypeMapping, Keycode, ModMapValue,
VirtualModifier,
},
level::Level,
resolved::GroupsRedirect,
},
},
hashbrown::{HashMap, hash_map::Entry},
std::sync::Arc,
};
impl LookupTable {
/// Creates a client-side XKB keymap from a lookup table.
///
/// The created keymap does not contain any actions. Clients trying to implement
/// how-to-type logic will not be able to determine which key presses trigger which
/// modifiers or groups.
///
/// The keymap will contain modmap entries mapping all keys producing `Alt_L` or
/// `Alt_R` to `Mod1`.
///
/// # Example
///
/// ```
/// # use kbvm::builder::{Builder, GroupBuilder, KeyBuilder, LevelBuilder};
/// # use kbvm::GroupType;
/// # use kbvm::syms;
/// # use kbvm::ModifierMask;
/// # use kbvm::Keycode;
/// let mut builder = Builder::default();
/// {
/// let gt = GroupType::builder(ModifierMask::SHIFT)
/// .map(ModifierMask::SHIFT, 1)
/// .build();
/// let mut gb = GroupBuilder::new(0, >);
/// let mut level = LevelBuilder::new(0);
/// level.keysyms(&[syms::a]);
/// gb.add_level(level);
/// let mut level = LevelBuilder::new(1);
/// level.keysyms(&[syms::A]);
/// gb.add_level(level);
/// let mut key = KeyBuilder::new(Keycode::from_x11(9));
/// key.repeats(true);
/// key.add_group(gb);
/// builder.add_key(key)
/// }
/// {
/// let gt = GroupType::builder(ModifierMask::NONE).build();
/// let mut level = LevelBuilder::new(0);
/// level.keysyms(&[syms::Alt_L]);
/// let mut gb = GroupBuilder::new(0, >);
/// gb.add_level(level);
/// let mut key = KeyBuilder::new(Keycode::from_x11(10));
/// key.add_group(gb);
/// builder.add_key(key)
/// }
/// let map = builder.build_lookup_table().to_xkb_keymap();
/// println!("{:#}", map.format());
/// ```
///
/// Outputs
///
/// ```xkb
/// xkb_keymap {
/// xkb_keycodes {
/// minimum = 8;
/// maximum = 255;
///
/// indicator 1 = "DUMMY";
///
/// <9> = 9;
/// <10> = 10;
/// };
///
/// xkb_types {
/// virtual_modifiers Dummy;
///
/// type "type0" {
/// modifiers = Shift;
/// map[Shift] = Level2;
/// };
///
/// type "type1" {
/// modifiers = None;
/// };
/// };
///
/// xkb_compat {
/// interpret VoidSymbol {
/// repeat = false;
/// };
/// };
///
/// xkb_symbols {
/// modmap Mod1 { <10> };
///
/// key.repeat = true;
///
/// key <9> {
/// type[Group1] = "type0",
/// symbols[Group1] = [ a, A ]
/// };
/// key <10> {
/// repeat = false,
/// type[Group1] = "type1",
/// symbols[Group1] = [ Alt_L ]
/// };
/// };
/// };
/// ```
pub fn to_xkb_keymap(&self) -> Keymap {
let mut max_keycode = 255;
let mut keycodes = Vec::with_capacity(self.keys.len());
let mut keys = Vec::with_capacity(self.keys.len());
let mut key_types = HashMap::<_, Arc<KeyType>>::new();
let mut mod_maps = vec![];
for (kc, kg) in &self.keys {
max_keycode = max_keycode.max(kc.0);
let name = Arc::new(kc.0.to_string());
keycodes.push(Keycode {
name: name.clone(),
keycode: kc,
});
let mut groups = Vec::with_capacity(kg.groups.len());
for group in kg.groups.iter() {
let Some(group) = group else {
groups.push(None);
continue;
};
let mut levels = Vec::with_capacity(group.levels.len());
macro_rules! syms_to_map {
($($syms:pat => $mask:ident,)*) => {{
for &sym in group.levels.iter().flat_map(|l| l.symbols.iter()) {
let idx = $(
if let $syms = sym {
ModifierIndex::$mask
} else
)* {
continue;
};
mod_maps.push((
idx,
ModMapValue {
key_name: name.clone(),
key_sym: None,
},
));
break;
}
}};
}
syms_to_map! {
syms::Shift_L | syms::Shift_R => SHIFT,
syms::Caps_Lock => LOCK,
syms::Control_L | syms::Control_R => CONTROL,
syms::Alt_L | syms::Alt_R => MOD1,
syms::Num_Lock => MOD2,
syms::Super_L | syms::Super_R => MOD4,
}
for level in &group.levels {
levels.push(KeyLevel {
symbols: level.symbols.clone(),
actions: Default::default(),
});
}
let num_key_types = key_types.len();
let key_type = match key_types.entry(&*group.ty.data as *const group_type::Data) {
Entry::Occupied(v) => v.get().clone(),
Entry::Vacant(v) => {
let mut mappings = Vec::with_capacity(group.ty.data.cases.len());
for case in &group.ty.data.cases {
if case.level <= u32::MAX as usize {
mappings.push(KeyTypeMapping {
modifiers: case.mods,
preserved: case.mods & !case.consumed,
level: Level::new(case.level as u32 + 1).unwrap(),
});
}
}
mappings.sort_unstable_by_key(|k| (k.level, k.modifiers.0));
let kt = KeyType {
name: Arc::new(format!("type{}", num_key_types)),
modifiers: group.ty.data.mask,
mappings,
level_names: vec![],
};
let kt = Arc::new(kt);
v.insert(kt.clone());
kt
}
};
groups.push(Some(KeyGroup { key_type, levels }));
}
if groups.last() == Some(&None) {
groups.pop();
}
let redirect = match kg.redirect {
Redirect::Wrap => GroupsRedirect::Wrap,
Redirect::Clamp => GroupsRedirect::Clamp,
Redirect::Fixed(f) => {
if f >= u32::MAX as usize {
GroupsRedirect::Redirect(GroupIdx::ONE)
} else {
GroupsRedirect::Redirect(
GroupIdx::new(f as u32 + 1).unwrap_or(GroupIdx::ONE),
)
}
}
};
let symbol = Key {
key_name: name.clone(),
keycode: kc,
groups,
repeat: kg.repeats,
behavior: None,
redirect,
};
keys.push((kc, symbol));
}
let mut types: Vec<_> = key_types.into_values().collect();
types.sort_unstable_by_key(|kt| kt.name.clone());
keys.sort_unstable_by(|l, r| l.1.key_name.cmp(&r.1.key_name));
keycodes.sort_unstable_by(|l, r| l.name.cmp(&r.name));
mod_maps.sort_unstable();
Keymap {
name: None,
max_keycode,
indicators: vec![Indicator::dummy()],
keycodes,
types,
virtual_modifiers: vec![VirtualModifier::dummy()],
mod_maps,
group_names: vec![],
keys: keys.into_iter().collect(),
}
}
}