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
|
use crossterm::event::{KeyCode, KeyEvent, KeyModifiers, KeyboardEnhancementFlags};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct TerminalKey {
pub code: KeyCode,
pub modifiers: KeyModifiers,
pub kind: crossterm::event::KeyEventKind,
pub shifted_codepoint: Option<u32>,
}
impl TerminalKey {
pub fn new(code: KeyCode, modifiers: KeyModifiers) -> Self {
Self {
code,
modifiers,
kind: crossterm::event::KeyEventKind::Press,
shifted_codepoint: None,
}
}
pub fn with_kind(mut self, kind: crossterm::event::KeyEventKind) -> Self {
self.kind = kind;
self
}
#[allow(dead_code)] // Reserved for the upcoming raw input parser to preserve shifted/base key pairs.
pub fn with_shifted_codepoint(mut self, shifted_codepoint: u32) -> Self {
self.shifted_codepoint = Some(shifted_codepoint);
self
}
pub fn as_key_event(self) -> KeyEvent {
KeyEvent::new_with_kind(self.code, self.modifiers, self.kind)
}
}
impl From<KeyEvent> for TerminalKey {
fn from(value: KeyEvent) -> Self {
Self::new(value.code, value.modifiers).with_kind(value.kind)
}
}
pub fn ime_compatible_keyboard_enhancement_flags() -> KeyboardEnhancementFlags {
KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES
| KeyboardEnhancementFlags::REPORT_EVENT_TYPES
| KeyboardEnhancementFlags::REPORT_ALTERNATE_KEYS
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KeyboardProtocol {
Legacy,
Kitty { flags: u16 },
}
impl KeyboardProtocol {
pub fn from_kitty_flags(flags: u16) -> Self {
if flags == 0 {
Self::Legacy
} else {
Self::Kitty { flags }
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MouseProtocolMode {
None,
Press,
PressRelease,
ButtonMotion,
AnyMotion,
}
impl MouseProtocolMode {
pub fn reporting_enabled(self) -> bool {
self != Self::None
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MouseProtocolEncoding {
Default,
Utf8,
Sgr,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn protocol_from_zero_flags_is_legacy() {
assert_eq!(
KeyboardProtocol::from_kitty_flags(0),
KeyboardProtocol::Legacy
);
}
#[test]
fn protocol_from_nonzero_flags_is_kitty() {
assert_eq!(
KeyboardProtocol::from_kitty_flags(7),
KeyboardProtocol::Kitty { flags: 7 }
);
}
#[test]
fn keyboard_enhancement_flags_stay_ime_compatible() {
let flags = ime_compatible_keyboard_enhancement_flags();
assert!(flags.contains(KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES));
assert!(flags.contains(KeyboardEnhancementFlags::REPORT_EVENT_TYPES));
assert!(flags.contains(KeyboardEnhancementFlags::REPORT_ALTERNATE_KEYS));
assert!(!flags.contains(KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES));
}
}
|
