Skip to main content

sim_logic/application/input/
keyboard.rs

1//! Portable physical key catalog. Character entry/IME is a separate input concern.
2
3/// A portable physical keyboard key supported by the runtime.
4///
5/// Desktop adapters translate platform key codes into this enum before input
6/// reaches the headless runtime core.
7#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
8#[non_exhaustive]
9pub enum PhysicalKeyCode {
10    /// The physical W key.
11    KeyW,
12    /// The physical A key.
13    KeyA,
14    /// The physical S key.
15    KeyS,
16    /// The physical D key.
17    KeyD,
18    /// The main Enter key.
19    Enter,
20    /// The physical Space key.
21    Space,
22    /// The physical left-arrow key.
23    ArrowLeft,
24    /// The physical right-arrow key.
25    ArrowRight,
26    /// The physical down-arrow key.
27    ArrowDown,
28    /// The physical up-arrow key.
29    ArrowUp,
30    /// The physical Escape key.
31    Escape,
32    /// The physical P key.
33    KeyP,
34    /// The physical R key.
35    KeyR,
36    /// The physical N key.
37    KeyN,
38    /// The physical 1 key on the number row, not the numeric keypad.
39    Digit1,
40    /// The physical 2 key on the number row, not the numeric keypad.
41    Digit2,
42    /// The physical 3 key on the number row, not the numeric keypad.
43    Digit3,
44    /// The physical 4 key on the number row, not the numeric keypad.
45    Digit4,
46    /// The physical 5 key on the number row, not the numeric keypad.
47    Digit5,
48    /// The physical F3 function key.
49    F3,
50    /// The physical F4 function key.
51    F4,
52    /// The physical F5 function key.
53    F5,
54    /// The physical F6 function key.
55    F6,
56    /// The physical F8 function key.
57    F8,
58    /// The physical F9 function key.
59    F9,
60    /// The physical L key.
61    KeyL,
62    /// The physical F key.
63    KeyF,
64    /// The physical M key.
65    KeyM,
66    /// The physical T key.
67    KeyT,
68    /// The physical V key.
69    KeyV,
70    /// The physical 6 key on the number row.
71    Digit6,
72    /// The physical 7 key on the number row.
73    Digit7,
74    /// The physical 8 key on the number row.
75    Digit8,
76    /// The physical 9 key on the number row.
77    Digit9,
78    /// The physical F7 function key.
79    F7,
80    /// The physical E key.
81    KeyE,
82    /// The physical left Shift key.
83    ShiftLeft,
84    /// The physical Tab key (independent of keyboard layout).
85    Tab,
86    /// The physical Digit0 key (independent of keyboard layout).
87    Digit0,
88    /// The physical F1 key (independent of keyboard layout).
89    F1,
90    /// The physical F2 key (independent of keyboard layout).
91    F2,
92    /// The physical F10 key (independent of keyboard layout).
93    F10,
94    /// The physical F11 key (independent of keyboard layout).
95    F11,
96    /// The physical F12 key (independent of keyboard layout).
97    F12,
98    /// The physical ShiftRight key (independent of keyboard layout).
99    ShiftRight,
100    /// The physical ControlLeft key (independent of keyboard layout).
101    ControlLeft,
102    /// The physical ControlRight key (independent of keyboard layout).
103    ControlRight,
104    /// The physical AltLeft key (independent of keyboard layout).
105    AltLeft,
106    /// The physical AltRight key (independent of keyboard layout).
107    AltRight,
108    /// The physical SuperLeft key (independent of keyboard layout).
109    SuperLeft,
110    /// The physical SuperRight key (independent of keyboard layout).
111    SuperRight,
112    /// The physical Backspace key (independent of keyboard layout).
113    Backspace,
114    /// The physical Delete key (independent of keyboard layout).
115    Delete,
116    /// The physical Insert key (independent of keyboard layout).
117    Insert,
118    /// The physical Home key (independent of keyboard layout).
119    Home,
120    /// The physical End key (independent of keyboard layout).
121    End,
122    /// The physical PageUp key (independent of keyboard layout).
123    PageUp,
124    /// The physical PageDown key (independent of keyboard layout).
125    PageDown,
126    /// The physical CapsLock key (independent of keyboard layout).
127    CapsLock,
128    /// The physical NumLock key (independent of keyboard layout).
129    NumLock,
130    /// The physical ScrollLock key (independent of keyboard layout).
131    ScrollLock,
132    /// The physical PrintScreen key (independent of keyboard layout).
133    PrintScreen,
134    /// The physical Pause key (independent of keyboard layout).
135    Pause,
136    /// The physical ContextMenu key (independent of keyboard layout).
137    ContextMenu,
138    /// The physical Backquote key (independent of keyboard layout).
139    Backquote,
140    /// The physical Minus key (independent of keyboard layout).
141    Minus,
142    /// The physical Equal key (independent of keyboard layout).
143    Equal,
144    /// The physical BracketLeft key (independent of keyboard layout).
145    BracketLeft,
146    /// The physical BracketRight key (independent of keyboard layout).
147    BracketRight,
148    /// The physical Backslash key (independent of keyboard layout).
149    Backslash,
150    /// The physical Semicolon key (independent of keyboard layout).
151    Semicolon,
152    /// The physical Quote key (independent of keyboard layout).
153    Quote,
154    /// The physical Comma key (independent of keyboard layout).
155    Comma,
156    /// The physical Period key (independent of keyboard layout).
157    Period,
158    /// The physical Slash key (independent of keyboard layout).
159    Slash,
160    /// The physical KeyB key (independent of keyboard layout).
161    KeyB,
162    /// The physical KeyC key (independent of keyboard layout).
163    KeyC,
164    /// The physical KeyG key (independent of keyboard layout).
165    KeyG,
166    /// The physical KeyH key (independent of keyboard layout).
167    KeyH,
168    /// The physical KeyI key (independent of keyboard layout).
169    KeyI,
170    /// The physical KeyJ key (independent of keyboard layout).
171    KeyJ,
172    /// The physical KeyK key (independent of keyboard layout).
173    KeyK,
174    /// The physical KeyO key (independent of keyboard layout).
175    KeyO,
176    /// The physical KeyU key (independent of keyboard layout).
177    KeyU,
178    /// The physical KeyX key (independent of keyboard layout).
179    KeyX,
180    /// The physical KeyY key (independent of keyboard layout).
181    KeyY,
182    /// The physical KeyZ key (independent of keyboard layout).
183    KeyZ,
184    /// The physical Numpad0 key (independent of keyboard layout).
185    Numpad0,
186    /// The physical Numpad1 key (independent of keyboard layout).
187    Numpad1,
188    /// The physical Numpad2 key (independent of keyboard layout).
189    Numpad2,
190    /// The physical Numpad3 key (independent of keyboard layout).
191    Numpad3,
192    /// The physical Numpad4 key (independent of keyboard layout).
193    Numpad4,
194    /// The physical Numpad5 key (independent of keyboard layout).
195    Numpad5,
196    /// The physical Numpad6 key (independent of keyboard layout).
197    Numpad6,
198    /// The physical Numpad7 key (independent of keyboard layout).
199    Numpad7,
200    /// The physical Numpad8 key (independent of keyboard layout).
201    Numpad8,
202    /// The physical Numpad9 key (independent of keyboard layout).
203    Numpad9,
204    /// The physical NumpadEnter key (independent of keyboard layout).
205    NumpadEnter,
206    /// The physical NumpadAdd key (independent of keyboard layout).
207    NumpadAdd,
208    /// The physical NumpadSubtract key (independent of keyboard layout).
209    NumpadSubtract,
210    /// The physical NumpadMultiply key (independent of keyboard layout).
211    NumpadMultiply,
212    /// The physical NumpadDivide key (independent of keyboard layout).
213    NumpadDivide,
214    /// The physical NumpadDecimal key (independent of keyboard layout).
215    NumpadDecimal,
216    /// The physical NumpadEqual key (independent of keyboard layout).
217    NumpadEqual,
218    /// The physical IntlBackslash key (independent of keyboard layout).
219    IntlBackslash,
220    /// The physical IntlRo key (independent of keyboard layout).
221    IntlRo,
222    /// The physical IntlYen key (independent of keyboard layout).
223    IntlYen,
224    /// The physical Q key, independent of keyboard layout.
225    KeyQ,
226}
227
228pub(crate) const ALL_PHYSICAL_KEYS: [PhysicalKeyCode; 108] = [
229    PhysicalKeyCode::KeyW,
230    PhysicalKeyCode::KeyA,
231    PhysicalKeyCode::KeyS,
232    PhysicalKeyCode::KeyD,
233    PhysicalKeyCode::Enter,
234    PhysicalKeyCode::Space,
235    PhysicalKeyCode::ArrowLeft,
236    PhysicalKeyCode::ArrowRight,
237    PhysicalKeyCode::ArrowDown,
238    PhysicalKeyCode::ArrowUp,
239    PhysicalKeyCode::Escape,
240    PhysicalKeyCode::KeyP,
241    PhysicalKeyCode::KeyR,
242    PhysicalKeyCode::KeyN,
243    PhysicalKeyCode::Digit1,
244    PhysicalKeyCode::Digit2,
245    PhysicalKeyCode::Digit3,
246    PhysicalKeyCode::Digit4,
247    PhysicalKeyCode::Digit5,
248    PhysicalKeyCode::F3,
249    PhysicalKeyCode::F4,
250    PhysicalKeyCode::F5,
251    PhysicalKeyCode::F6,
252    PhysicalKeyCode::F8,
253    PhysicalKeyCode::F9,
254    PhysicalKeyCode::KeyL,
255    PhysicalKeyCode::KeyF,
256    PhysicalKeyCode::KeyM,
257    PhysicalKeyCode::KeyT,
258    PhysicalKeyCode::KeyV,
259    PhysicalKeyCode::Digit6,
260    PhysicalKeyCode::Digit7,
261    PhysicalKeyCode::Digit8,
262    PhysicalKeyCode::Digit9,
263    PhysicalKeyCode::F7,
264    PhysicalKeyCode::KeyE,
265    PhysicalKeyCode::ShiftLeft,
266    PhysicalKeyCode::Tab,
267    PhysicalKeyCode::Digit0,
268    PhysicalKeyCode::F1,
269    PhysicalKeyCode::F2,
270    PhysicalKeyCode::F10,
271    PhysicalKeyCode::F11,
272    PhysicalKeyCode::F12,
273    PhysicalKeyCode::ShiftRight,
274    PhysicalKeyCode::ControlLeft,
275    PhysicalKeyCode::ControlRight,
276    PhysicalKeyCode::AltLeft,
277    PhysicalKeyCode::AltRight,
278    PhysicalKeyCode::SuperLeft,
279    PhysicalKeyCode::SuperRight,
280    PhysicalKeyCode::Backspace,
281    PhysicalKeyCode::Delete,
282    PhysicalKeyCode::Insert,
283    PhysicalKeyCode::Home,
284    PhysicalKeyCode::End,
285    PhysicalKeyCode::PageUp,
286    PhysicalKeyCode::PageDown,
287    PhysicalKeyCode::CapsLock,
288    PhysicalKeyCode::NumLock,
289    PhysicalKeyCode::ScrollLock,
290    PhysicalKeyCode::PrintScreen,
291    PhysicalKeyCode::Pause,
292    PhysicalKeyCode::ContextMenu,
293    PhysicalKeyCode::Backquote,
294    PhysicalKeyCode::Minus,
295    PhysicalKeyCode::Equal,
296    PhysicalKeyCode::BracketLeft,
297    PhysicalKeyCode::BracketRight,
298    PhysicalKeyCode::Backslash,
299    PhysicalKeyCode::Semicolon,
300    PhysicalKeyCode::Quote,
301    PhysicalKeyCode::Comma,
302    PhysicalKeyCode::Period,
303    PhysicalKeyCode::Slash,
304    PhysicalKeyCode::KeyB,
305    PhysicalKeyCode::KeyC,
306    PhysicalKeyCode::KeyG,
307    PhysicalKeyCode::KeyH,
308    PhysicalKeyCode::KeyI,
309    PhysicalKeyCode::KeyJ,
310    PhysicalKeyCode::KeyK,
311    PhysicalKeyCode::KeyO,
312    PhysicalKeyCode::KeyU,
313    PhysicalKeyCode::KeyX,
314    PhysicalKeyCode::KeyY,
315    PhysicalKeyCode::KeyZ,
316    PhysicalKeyCode::Numpad0,
317    PhysicalKeyCode::Numpad1,
318    PhysicalKeyCode::Numpad2,
319    PhysicalKeyCode::Numpad3,
320    PhysicalKeyCode::Numpad4,
321    PhysicalKeyCode::Numpad5,
322    PhysicalKeyCode::Numpad6,
323    PhysicalKeyCode::Numpad7,
324    PhysicalKeyCode::Numpad8,
325    PhysicalKeyCode::Numpad9,
326    PhysicalKeyCode::NumpadEnter,
327    PhysicalKeyCode::NumpadAdd,
328    PhysicalKeyCode::NumpadSubtract,
329    PhysicalKeyCode::NumpadMultiply,
330    PhysicalKeyCode::NumpadDivide,
331    PhysicalKeyCode::NumpadDecimal,
332    PhysicalKeyCode::NumpadEqual,
333    PhysicalKeyCode::IntlBackslash,
334    PhysicalKeyCode::IntlRo,
335    PhysicalKeyCode::IntlYen,
336    PhysicalKeyCode::KeyQ,
337];
338
339pub(crate) const SUPPORTED_PHYSICAL_KEY_COUNT: usize = ALL_PHYSICAL_KEYS.len();
340
341pub(crate) const fn physical_key_index(key: PhysicalKeyCode) -> usize {
342    match key {
343        PhysicalKeyCode::KeyW => 0,
344        PhysicalKeyCode::KeyA => 1,
345        PhysicalKeyCode::KeyS => 2,
346        PhysicalKeyCode::KeyD => 3,
347        PhysicalKeyCode::Enter => 4,
348        PhysicalKeyCode::Space => 5,
349        PhysicalKeyCode::ArrowLeft => 6,
350        PhysicalKeyCode::ArrowRight => 7,
351        PhysicalKeyCode::ArrowDown => 8,
352        PhysicalKeyCode::ArrowUp => 9,
353        PhysicalKeyCode::Escape => 10,
354        PhysicalKeyCode::KeyP => 11,
355        PhysicalKeyCode::KeyR => 12,
356        PhysicalKeyCode::KeyN => 13,
357        PhysicalKeyCode::Digit1 => 14,
358        PhysicalKeyCode::Digit2 => 15,
359        PhysicalKeyCode::Digit3 => 16,
360        PhysicalKeyCode::Digit4 => 17,
361        PhysicalKeyCode::Digit5 => 18,
362        PhysicalKeyCode::F3 => 19,
363        PhysicalKeyCode::F4 => 20,
364        PhysicalKeyCode::F5 => 21,
365        PhysicalKeyCode::F6 => 22,
366        PhysicalKeyCode::F8 => 23,
367        PhysicalKeyCode::F9 => 24,
368        PhysicalKeyCode::KeyL => 25,
369        PhysicalKeyCode::KeyF => 26,
370        PhysicalKeyCode::KeyM => 27,
371        PhysicalKeyCode::KeyT => 28,
372        PhysicalKeyCode::KeyV => 29,
373        PhysicalKeyCode::Digit6 => 30,
374        PhysicalKeyCode::Digit7 => 31,
375        PhysicalKeyCode::Digit8 => 32,
376        PhysicalKeyCode::Digit9 => 33,
377        PhysicalKeyCode::F7 => 34,
378        PhysicalKeyCode::KeyE => 35,
379        PhysicalKeyCode::ShiftLeft => 36,
380        PhysicalKeyCode::Tab => 37,
381        PhysicalKeyCode::Digit0 => 38,
382        PhysicalKeyCode::F1 => 39,
383        PhysicalKeyCode::F2 => 40,
384        PhysicalKeyCode::F10 => 41,
385        PhysicalKeyCode::F11 => 42,
386        PhysicalKeyCode::F12 => 43,
387        PhysicalKeyCode::ShiftRight => 44,
388        PhysicalKeyCode::ControlLeft => 45,
389        PhysicalKeyCode::ControlRight => 46,
390        PhysicalKeyCode::AltLeft => 47,
391        PhysicalKeyCode::AltRight => 48,
392        PhysicalKeyCode::SuperLeft => 49,
393        PhysicalKeyCode::SuperRight => 50,
394        PhysicalKeyCode::Backspace => 51,
395        PhysicalKeyCode::Delete => 52,
396        PhysicalKeyCode::Insert => 53,
397        PhysicalKeyCode::Home => 54,
398        PhysicalKeyCode::End => 55,
399        PhysicalKeyCode::PageUp => 56,
400        PhysicalKeyCode::PageDown => 57,
401        PhysicalKeyCode::CapsLock => 58,
402        PhysicalKeyCode::NumLock => 59,
403        PhysicalKeyCode::ScrollLock => 60,
404        PhysicalKeyCode::PrintScreen => 61,
405        PhysicalKeyCode::Pause => 62,
406        PhysicalKeyCode::ContextMenu => 63,
407        PhysicalKeyCode::Backquote => 64,
408        PhysicalKeyCode::Minus => 65,
409        PhysicalKeyCode::Equal => 66,
410        PhysicalKeyCode::BracketLeft => 67,
411        PhysicalKeyCode::BracketRight => 68,
412        PhysicalKeyCode::Backslash => 69,
413        PhysicalKeyCode::Semicolon => 70,
414        PhysicalKeyCode::Quote => 71,
415        PhysicalKeyCode::Comma => 72,
416        PhysicalKeyCode::Period => 73,
417        PhysicalKeyCode::Slash => 74,
418        PhysicalKeyCode::KeyB => 75,
419        PhysicalKeyCode::KeyC => 76,
420        PhysicalKeyCode::KeyG => 77,
421        PhysicalKeyCode::KeyH => 78,
422        PhysicalKeyCode::KeyI => 79,
423        PhysicalKeyCode::KeyJ => 80,
424        PhysicalKeyCode::KeyK => 81,
425        PhysicalKeyCode::KeyO => 82,
426        PhysicalKeyCode::KeyU => 83,
427        PhysicalKeyCode::KeyX => 84,
428        PhysicalKeyCode::KeyY => 85,
429        PhysicalKeyCode::KeyZ => 86,
430        PhysicalKeyCode::Numpad0 => 87,
431        PhysicalKeyCode::Numpad1 => 88,
432        PhysicalKeyCode::Numpad2 => 89,
433        PhysicalKeyCode::Numpad3 => 90,
434        PhysicalKeyCode::Numpad4 => 91,
435        PhysicalKeyCode::Numpad5 => 92,
436        PhysicalKeyCode::Numpad6 => 93,
437        PhysicalKeyCode::Numpad7 => 94,
438        PhysicalKeyCode::Numpad8 => 95,
439        PhysicalKeyCode::Numpad9 => 96,
440        PhysicalKeyCode::NumpadEnter => 97,
441        PhysicalKeyCode::NumpadAdd => 98,
442        PhysicalKeyCode::NumpadSubtract => 99,
443        PhysicalKeyCode::NumpadMultiply => 100,
444        PhysicalKeyCode::NumpadDivide => 101,
445        PhysicalKeyCode::NumpadDecimal => 102,
446        PhysicalKeyCode::NumpadEqual => 103,
447        PhysicalKeyCode::IntlBackslash => 104,
448        PhysicalKeyCode::IntlRo => 105,
449        PhysicalKeyCode::IntlYen => 106,
450        PhysicalKeyCode::KeyQ => 107,
451    }
452}