Skip to content

fix(input): decode kitty key events with event type suffix for all keys #532

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
adi-IL wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(input): decode kitty key events with event type suffix for all keys #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 14 additions & 12 deletions src/ui/input/escape_parser.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,11 +566,11 @@ pub fn consumeInputEscapeByteWithMouse(
return null;
}

// Ghostty can report a Kitty key event type as a colon-qualified
// modifier, e.g. `ESC[27;1:1u` for an Escape key press.
if (byte == ':' and param2.* == 27) {
param2.* = if (param.* > 0) param.* - 1 else 0;
param.* = 0;
// Kitty keyboard protocol reports key event types as a colon-qualified
// modifier, e.g. `ESC[<keycode>;<modifier>:<event_type>u`.
if (byte == ':') {
const raw_modifiers = if (param.* > 0) param.* - 1 else 0;
param.* = raw_modifiers << 4;
setBaseEscapeStage(stage, kitty_escape_event_type_stage);
return null;
}
Expand Down Expand Up @@ -656,19 +656,21 @@ pub fn consumeInputEscapeByteWithMouse(

return beginControlSequenceDiscard(stage, param, param2, mouse, byte);
},
// Kitty key reports with an event type: `ESC[27;modifier:event-type u`.
// Only press and repeat are actionable; release must not close a panel.
// Kitty key reports with an event type: `ESC[<keycode>;modifier:event-type u`.
// Only press (1) and repeat (2) are actionable; release (3) must not trigger actions.
kitty_escape_event_type_stage => {
if (byte >= '0' and byte <= '9') {
appendCsiDigitSaturating(param, byte);
param.* = (param.* & 0xFFF0) | (byte - '0');
return null;
}
if (byte == 'u') {
const modifiers = param2.*;
const event_type = param.*;
const meta_prefixed = hasMetaPrefix(stage.*);
const keycode = param2.*;
const modifiers = param.* >> 4;
const event_type = param.* & 0x0F;
resetMouseEscapeDecode(stage, param, param2, mouse);
if (event_type == 1 or event_type == 2) {
return kittyUnicodeKeyAction(27, modifiers, false);
if (event_type == 1 or event_type == 2 or event_type == 0) {
return kittyUnicodeKeyAction(keycode, modifiers, meta_prefixed);
}
return .ignore;
}
Expand Down
8 changes: 8 additions & 0 deletions src/ui/input/runtime.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2322,12 +2322,20 @@ test "input escape parser resolves unmodified kitty Backspace to a delete byte"
try expectEscapeAction("[127u", .{ .remapped_byte = 127 });
// Modifier param is bitmask+1: ;1 = none, ;3 = Alt, ;9 = Super.
try expectEscapeAction("[127;1u", .{ .remapped_byte = 127 });
try expectEscapeAction("[127;1:1u", .{ .remapped_byte = 127 });
try expectEscapeAction("[127;1:2u", .{ .remapped_byte = 127 });
try expectEscapeAction("[127;1:3u", .ignore);
try expectEscapeAction("[127;3u", .delete_word_left);
try expectEscapeAction("[127;3:1u", .delete_word_left);
try expectEscapeAction("[127;9u", .delete_to_line_start);
try expectEscapeAction("[13u", .{ .remapped_byte = '\r' });
try expectEscapeAction("[13;1u", .{ .remapped_byte = '\r' });
try expectEscapeAction("[13;1:1u", .{ .remapped_byte = '\r' });
try expectEscapeAction("[13;1:3u", .ignore);
try expectEscapeAction("[9u", .{ .remapped_byte = '\t' });
try expectEscapeAction("[9;1u", .{ .remapped_byte = '\t' });
try expectEscapeAction("[9;1:1u", .{ .remapped_byte = '\t' });
try expectEscapeAction("[9;1:3u", .ignore);
}

test "input escape parser resolves unmapped single-parameter CSI u to ignore" {
Expand Down