Skip to content

Parse Kitty Keyboard Protocol esc codes to suport Ctrl-Shift-<Key> shortcuts #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Cal (UnnaturalTwilight) wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Parse Kitty Keyboard Protocol esc codes to suport Ctrl-Shift-<Key> shortcuts #887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73cafe0
fix: Kitty CSI u key inputs
UnnaturalTwilight Jun 11, 2026
35feec8
ctrl+shift+c copy
UnnaturalTwilight May 7, 2026
6d7b19f
Full kitty keyboard implementation for the first level of progressive
UnnaturalTwilight Jul 22, 2026
6bc7652
Parse the menu key and super mod
UnnaturalTwilight Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/edit/src/bin/edit/draw_menubar.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pub fn draw_menubar(ctx: &mut Context, state: &mut State) {
if ctx.menubar_menu_begin(loc(LocId::File), 'F') {
draw_menu_file(ctx, state);
}
if !contains_focus && ctx.consume_shortcut(vk::F10) {
if !contains_focus && (ctx.consume_shortcut(vk::F10) || ctx.consume_shortcut(vk::APPS)) {
ctx.steal_focus();
}
if state.documents.active().is_some() {
Expand Down
5 changes: 3 additions & 2 deletions crates/edit/src/bin/edit/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ impl Drop for RestoreModes {
// Same as in the beginning but in the reverse order.
// It also includes DECSCUSR 0 to reset the cursor style and DECTCEM to show the cursor.
// We specifically don't reset mode 1036, because most applications expect it to be set nowadays.
sys::write_stdout("\x1b[0 q\x1b[?25h\x1b]0;\x07\x1b[?1002;1006;2004l\x1b[?1049l");
sys::write_stdout("\x1b[<u\x1b[0 q\x1b[?25h\x1b]0;\x07\x1b[?1002;1006;2004l\x1b[?1049l");
}
}

Expand All @@ -593,7 +593,8 @@ fn setup_terminal(tui: &mut Tui, state: &mut State, vt_parser: &mut vt::Parser)
// 1006: SGR Mouse Mode
// 2004: Bracketed Paste Mode
// 1036: Xterm: "meta sends escape" (Alt keypresses should be encoded with ESC + char)
"\x1b[?1049h\x1b[?1002;1006;2004h\x1b[?1036h",
// CSI u: Kitty Keyboard Protocol: Push Disambiguate escape codes flag
"\x1b[?1049h\x1b[?1002;1006;2004h\x1b[?1036h\x1b[>1u",
// OSC 4 color table requests for indices 0 through 15 (base colors).
"\x1b]4;0;?;1;?;2;?;3;?;4;?;5;?;6;?;7;?\x07",
"\x1b]4;8;?;9;?;10;?;11;?;12;?;13;?;14;?;15;?\x07",
Expand Down
79 changes: 79 additions & 0 deletions crates/edit/src/input.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ pub mod vk {
pub const Y: InputKey = InputKey::new('Y' as u32);
pub const Z: InputKey = InputKey::new('Z' as u32);

pub const APPS: InputKey = InputKey::new(0x5D);
pub const NUMPAD0: InputKey = InputKey::new(0x60);
pub const NUMPAD1: InputKey = InputKey::new(0x61);
pub const NUMPAD2: InputKey = InputKey::new(0x62);
Expand Down Expand Up @@ -212,11 +213,19 @@ pub mod kbmod {
pub const CTRL: InputKeyMod = InputKeyMod::new(0x01000000);
pub const ALT: InputKeyMod = InputKeyMod::new(0x02000000);
pub const SHIFT: InputKeyMod = InputKeyMod::new(0x04000000);
pub const SUPER: InputKeyMod = InputKeyMod::new(0x08000000);

pub const CTRL_ALT: InputKeyMod = InputKeyMod::new(0x03000000);
pub const CTRL_SHIFT: InputKeyMod = InputKeyMod::new(0x05000000);
pub const ALT_SHIFT: InputKeyMod = InputKeyMod::new(0x06000000);
pub const CTRL_ALT_SHIFT: InputKeyMod = InputKeyMod::new(0x07000000);
pub const SUPER_CTRL: InputKeyMod = InputKeyMod::new(0x09000000);
pub const SUPER_ALT: InputKeyMod = InputKeyMod::new(0x0A000000);
pub const SUPER_CTRL_ALT: InputKeyMod = InputKeyMod::new(0x0B000000);
pub const SUPER_SHIFT: InputKeyMod = InputKeyMod::new(0x0C000000);
pub const SUPER_CTRL_SHIFT: InputKeyMod = InputKeyMod::new(0x0D000000);
pub const SUPER_ALT_SHIFT: InputKeyMod = InputKeyMod::new(0x0E000000);
pub const SUPER_CTRL_ALT_SHIFT: InputKeyMod = InputKeyMod::new(0x0F000000);
}

/// Mouse input state. Up/Down, Left/Right, etc.
Expand Down Expand Up @@ -454,6 +463,73 @@ impl<'input> Iterator for Stream<'_, '_, 'input> {
let height = (csi.params[1] as CoordType).clamp(1, 32767);
return Some(Input::Resize(Size { width, height }));
}
'u' => {
// Kitty keyboard events
let key = match csi.params[0] {
97 ..= 122 => Some(InputKey::new(csi.params[0] as u32 & !0x20)), // Shift a-z to A-Z
127 => Some(vk::BACK),

// F13-F24
57376 => Some(vk::F13),
57377 => Some(vk::F14),
57378 => Some(vk::F15),
57379 => Some(vk::F16),
57380 => Some(vk::F17),
57381 => Some(vk::F18),
57382 => Some(vk::F19),
57383 => Some(vk::F20),
57384 => Some(vk::F21),
57385 => Some(vk::F22),
57386 => Some(vk::F23),
57387 => Some(vk::F24),

// Number pad keys
57399 => Some(vk::NUMPAD0),
57400 => Some(vk::NUMPAD1),
57401 => Some(vk::NUMPAD2),
57402 => Some(vk::NUMPAD3),
57403 => Some(vk::NUMPAD4),
57404 => Some(vk::NUMPAD5),
57405 => Some(vk::NUMPAD6),
57406 => Some(vk::NUMPAD7),
57407 => Some(vk::NUMPAD8),
57408 => Some(vk::NUMPAD9),
57409 => Some(vk::DECIMAL),
57410 => Some(vk::DIVIDE),
57411 => Some(vk::MULTIPLY),
57412 => Some(vk::SUBTRACT),
57413 => Some(vk::ADD),
57414 => Some(vk::RETURN),
57415 => Some(InputKey::new('=' as u32)),
57416 => Some(vk::SEPARATOR),
57417 => Some(vk::LEFT),
57418 => Some(vk::RIGHT),
57419 => Some(vk::UP),
57420 => Some(vk::DOWN),
57421 => Some(vk::PRIOR),
57422 => Some(vk::NEXT),
57423 => Some(vk::HOME),
57424 => Some(vk::END),
57425 => Some(vk::INSERT),
57426 => Some(vk::DELETE),
57363 => Some(vk::APPS), // Menu

// Keys to Ignore
57358 => None, // Caps Lock
57359 => None, // Scroll Lock
57360 => None, // Num Lock
57361 => None, // Print Screen
57362 => None, // Pause
57388 ..= 57398 => None, // F25-F35
57428 ..= 57440 => None, // Media and Volume
57441 ..= 57454 => None, // Left/Right Modifiers

_ => Some(InputKey::new(csi.params[0] as u32)),
}?;
return Some(Input::Keyboard(
key | Self::parse_modifiers(csi),
));
}
_ => {}
}
}
Expand Down Expand Up @@ -543,6 +619,9 @@ impl<'input> Stream<'_, '_, 'input> {
if (p1 & 0x04) != 0 {
modifiers |= kbmod::CTRL;
}
if (p1 & 0x08) != 0 {
modifiers |= kbmod::SUPER;
}
modifiers
}

Expand Down
1 change: 1 addition & 0 deletions crates/edit/src/tui.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2759,6 +2759,7 @@ impl<'a> Context<'a, '_> {
},
vk::C => match modifiers {
kbmod::CTRL => tb.copy(self.clipboard_mut()),
kbmod::CTRL_SHIFT => tb.copy(self.clipboard_mut()),
_ => return false,
},
vk::V => match modifiers {
Expand Down