rustyline/
keys.rs

1//! Key constants
2
3/// Input key pressed and modifiers
4#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
5pub struct KeyEvent(pub KeyCode, pub Modifiers);
6
7impl KeyEvent {
8    /// Constant value representing an unmodified press of `KeyCode::Backspace`.
9    pub(crate) const BACKSPACE: Self = Self(KeyCode::Backspace, Modifiers::NONE);
10    /// Constant value representing an unmodified press of `KeyCode::Enter`.
11    pub(crate) const ENTER: Self = Self(KeyCode::Enter, Modifiers::NONE);
12    /// Constant value representing an unmodified press of `KeyCode::Esc`.
13    pub(crate) const ESC: Self = Self(KeyCode::Esc, Modifiers::NONE);
14
15    /// Constructor from `char` and modifiers
16    #[must_use]
17    pub fn new(c: char, mut mods: Modifiers) -> Self {
18        use {KeyCode as K, KeyEvent as E, Modifiers as M};
19
20        if !c.is_control() {
21            if !mods.is_empty() {
22                mods.remove(M::SHIFT); // TODO Validate: no SHIFT even if
23                                       // `c` is uppercase
24            }
25            return E(K::Char(c), mods);
26        }
27        match c {
28            '\x00' => E(K::Char('@'), mods | M::CTRL), // '\0'
29            '\x01' => E(K::Char('A'), mods | M::CTRL),
30            '\x02' => E(K::Char('B'), mods | M::CTRL),
31            '\x03' => E(K::Char('C'), mods | M::CTRL),
32            '\x04' => E(K::Char('D'), mods | M::CTRL),
33            '\x05' => E(K::Char('E'), mods | M::CTRL),
34            '\x06' => E(K::Char('F'), mods | M::CTRL),
35            '\x07' => E(K::Char('G'), mods | M::CTRL), // '\a'
36            #[cfg(unix)]
37            '\x08' => E(K::Backspace, mods), // '\b'
38            #[cfg(windows)]
39            '\x08' => E(K::Char('H'), mods | M::CTRL),
40            #[cfg(unix)]
41            '\x09' => {
42                // '\t'
43                if mods.contains(M::SHIFT) {
44                    mods.remove(M::SHIFT);
45                    E(K::BackTab, mods)
46                } else {
47                    E(K::Tab, mods)
48                }
49            }
50            #[cfg(windows)]
51            '\x09' => E(K::Char('I'), mods | M::CTRL),
52            '\x0a' => E(K::Char('J'), mods | M::CTRL), // '\n' (10)
53            '\x0b' => E(K::Char('K'), mods | M::CTRL),
54            '\x0c' => E(K::Char('L'), mods | M::CTRL),
55            #[cfg(unix)]
56            '\x0d' => E(K::Enter, mods), // '\r' (13)
57            #[cfg(windows)]
58            '\x0d' => E(K::Char('M'), mods | M::CTRL),
59            '\x0e' => E(K::Char('N'), mods | M::CTRL),
60            '\x0f' => E(K::Char('O'), mods | M::CTRL),
61            '\x10' => E(K::Char('P'), mods | M::CTRL),
62            '\x11' => E(K::Char('Q'), mods | M::CTRL),
63            '\x12' => E(K::Char('R'), mods | M::CTRL),
64            '\x13' => E(K::Char('S'), mods | M::CTRL),
65            '\x14' => E(K::Char('T'), mods | M::CTRL),
66            '\x15' => E(K::Char('U'), mods | M::CTRL),
67            '\x16' => E(K::Char('V'), mods | M::CTRL),
68            '\x17' => E(K::Char('W'), mods | M::CTRL),
69            '\x18' => E(K::Char('X'), mods | M::CTRL),
70            '\x19' => E(K::Char('Y'), mods | M::CTRL),
71            '\x1a' => E(K::Char('Z'), mods | M::CTRL),
72            '\x1b' => E(K::Esc, mods), // Ctrl-[, '\e'
73            '\x1c' => E(K::Char('\\'), mods | M::CTRL),
74            '\x1d' => E(K::Char(']'), mods | M::CTRL),
75            '\x1e' => E(K::Char('^'), mods | M::CTRL),
76            '\x1f' => E(K::Char('_'), mods | M::CTRL),
77            '\x7f' => E(K::Backspace, mods), // Rubout, Ctrl-?
78            '\u{9b}' => E(K::Esc, mods | M::SHIFT),
79            _ => E(K::Null, mods),
80        }
81    }
82
83    /// Constructor from `char` with Ctrl modifier
84    #[must_use]
85    pub fn ctrl(c: char) -> Self {
86        Self::new(c, Modifiers::CTRL)
87    }
88
89    /// Constructor from `char` with Alt modifier
90    #[must_use]
91    pub fn alt(c: char) -> Self {
92        Self::new(c, Modifiers::ALT)
93    }
94
95    /// ctrl-a => ctrl-A (uppercase)
96    /// shift-A => A (no SHIFT modifier)
97    /// shift-Tab => `BackTab`
98    #[must_use]
99    pub fn normalize(e: Self) -> Self {
100        use {KeyCode as K, KeyEvent as E, Modifiers as M};
101
102        match e {
103            E(K::Char(c), m) if c.is_ascii_control() => Self::new(c, m),
104            E(K::Char(c), m) if c.is_ascii_lowercase() && m.contains(M::CTRL) => {
105                E(K::Char(c.to_ascii_uppercase()), m)
106            }
107            E(K::Char(c), m) if c.is_ascii_uppercase() && m.contains(M::SHIFT) => {
108                E(K::Char(c), m ^ M::SHIFT)
109            }
110            E(K::Tab, m) if m.contains(M::SHIFT) => E(K::BackTab, m ^ M::SHIFT),
111            _ => e,
112        }
113    }
114}
115
116impl From<char> for KeyEvent {
117    fn from(c: char) -> Self {
118        Self::new(c, Modifiers::NONE)
119    }
120}
121
122/// Input key pressed
123#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
124#[non_exhaustive]
125pub enum KeyCode {
126    /// Unsupported escape sequence (on unix platform)
127    UnknownEscSeq,
128    /// ⌫ or Ctrl-H
129    Backspace,
130    /// ⇤ (usually Shift-Tab)
131    BackTab,
132    /// Paste (on unix platform)
133    BracketedPasteStart,
134    /// Paste (on unix platform)
135    BracketedPasteEnd,
136    /// Single char
137    Char(char),
138    /// ⌦
139    Delete,
140    /// ↓ arrow key
141    Down,
142    /// ⇲
143    End,
144    /// ↵ or Ctrl-M
145    Enter,
146    /// Escape or Ctrl-[
147    Esc,
148    /// Function key
149    F(u8),
150    /// ⇱
151    Home,
152    /// Insert key
153    Insert,
154    /// ← arrow key
155    Left,
156    /// \0
157    Null,
158    /// ⇟
159    PageDown,
160    /// ⇞
161    PageUp,
162    /// → arrow key
163    Right,
164    /// ⇥ or Ctrl-I
165    Tab,
166    /// ↑ arrow key
167    Up,
168}
169
170bitflags::bitflags! {
171    /// The set of modifier keys that were triggered along with a key press.
172    #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
173    pub struct Modifiers: u8 {
174        /// Control modifier
175        const CTRL  = 1<<3;
176        /// Escape or Alt modifier
177        const ALT  = 1<<2;
178        /// Shift modifier
179        const SHIFT = 1<<1;
180
181        /// No modifier
182        const NONE = 0;
183        /// Ctrl + Shift
184        const CTRL_SHIFT = Self::CTRL.bits() | Self::SHIFT.bits();
185        /// Alt + Shift
186        const ALT_SHIFT = Self::ALT.bits() | Self::SHIFT.bits();
187        /// Ctrl + Alt
188        const CTRL_ALT = Self::CTRL.bits() | Self::ALT.bits();
189        /// Ctrl + Alt + Shift
190        const CTRL_ALT_SHIFT = Self::CTRL.bits() | Self::ALT.bits() | Self::SHIFT.bits();
191    }
192}
193
194#[cfg(test)]
195mod tests {
196    use super::{KeyCode as K, KeyEvent as E, Modifiers as M};
197
198    #[test]
199    fn new() {
200        assert_eq!(E::ESC, E::new('\x1b', M::NONE));
201    }
202
203    #[test]
204    #[cfg(unix)]
205    fn from() {
206        assert_eq!(E(K::Tab, M::NONE), E::from('\t'));
207    }
208
209    #[test]
210    #[cfg(windows)]
211    fn from() {
212        assert_eq!(E(K::Char('I'), M::CTRL), E::from('\t'));
213    }
214
215    #[test]
216    fn normalize() {
217        assert_eq!(E::ctrl('A'), E::normalize(E(K::Char('\x01'), M::NONE)));
218        assert_eq!(E::ctrl('A'), E::normalize(E::ctrl('a')));
219        assert_eq!(E::from('A'), E::normalize(E(K::Char('A'), M::SHIFT)));
220        assert_eq!(E(K::BackTab, M::NONE), E::normalize(E(K::Tab, M::SHIFT)));
221    }
222}
rustyline/keys.rs

rustyline/
keys.rs
