diff options
Diffstat (limited to 'vendor/libghostty-vt/src/input/function_keys.zig')
| -rw-r--r-- | vendor/libghostty-vt/src/input/function_keys.zig | 312 |
1 files changed, 312 insertions, 0 deletions
diff --git a/vendor/libghostty-vt/src/input/function_keys.zig b/vendor/libghostty-vt/src/input/function_keys.zig new file mode 100644 index 00000000..efe86d9e --- /dev/null +++ b/vendor/libghostty-vt/src/input/function_keys.zig @@ -0,0 +1,312 @@ +//! This is the list of "PC style function keys" that xterm supports for +//! the legacy keyboard protocols. These always take priority since at the +//! time of writing this, even the most modern keyboard protocols still +//! are backwards compatible with regards to these sequences. +//! +//! This is based on a variety of sources cross-referenced but mostly +//! based on foot's keymap.h: https://codeberg.org/dnkl/foot/src/branch/master/keymap.h + +const std = @import("std"); +const key = @import("key.zig"); + +pub const CursorMode = enum { any, normal, application }; +pub const KeypadMode = enum { any, normal, application }; + +/// A bit confusing so I'll document this one: this is the "modify other keys" +/// setting. We only change behavior for "set_other" which is ESC [ > 4; 2 m. +/// So this can be "any" which means we don't care what's going on. Or it +/// can be "set" which means modify keys must be set EXCEPT FOR "other keys" +/// mode, and "set_other" which means modify keys must be set to "other keys" +/// mode. +/// +/// See: https://invisible-island.net/xterm/modified-keys.html +pub const ModifyKeys = enum { + any, + set, + set_other, +}; + +/// A single entry in the table of keys. +pub const Entry = struct { + /// The exact set of modifiers that must be active for this entry to match. + /// If mods_empty_is_any is true then empty mods means any set of mods can + /// match. Otherwise, empty mods means no mods must be active. + mods: key.Mods = .{}, + mods_empty_is_any: bool = true, + + /// The state required for cursor/keypad mode. + cursor: CursorMode = .any, + keypad: KeypadMode = .any, + + /// Whether or not this entry should be used + modify_other_keys: ModifyKeys = .any, + + /// The sequence to send to the pty if this entry matches. + sequence: []const u8, +}; + +/// The list of modifier combinations for modify other key sequences. +/// The mode value is index + 2. +pub const modifiers: []const key.Mods = &.{ + .{ .shift = true }, + .{ .alt = true }, + .{ .shift = true, .alt = true }, + .{ .ctrl = true }, + .{ .shift = true, .ctrl = true }, + .{ .alt = true, .ctrl = true }, + .{ .shift = true, .alt = true, .ctrl = true }, + .{ .super = true }, + .{ .shift = true, .super = true }, + .{ .alt = true, .super = true }, + .{ .shift = true, .alt = true, .super = true }, + .{ .ctrl = true, .super = true }, + .{ .shift = true, .ctrl = true, .super = true }, + .{ .alt = true, .ctrl = true, .super = true }, + .{ .shift = true, .alt = true, .ctrl = true, .super = true }, +}; + +/// This is the array of entries for the PC style function keys as mapped to +/// our set of possible key codes. Not every key has any entries. +pub const KeyEntryArray = std.EnumArray(key.Key, []const Entry); + +// The list of keys that we support and their entry values. It is expected +// that you'll just use a for loop through the entry values, there are never +// more than a couple dozen or so. +pub const keys = keys: { + var result = KeyEntryArray.initFill(&.{}); + + result.set(.arrow_up, pcStyle("\x1b[1;{}A") ++ cursorKey("\x1b[A", "\x1bOA")); + result.set(.arrow_down, pcStyle("\x1b[1;{}B") ++ cursorKey("\x1b[B", "\x1bOB")); + result.set(.arrow_right, pcStyle("\x1b[1;{}C") ++ cursorKey("\x1b[C", "\x1bOC")); + result.set(.arrow_left, pcStyle("\x1b[1;{}D") ++ cursorKey("\x1b[D", "\x1bOD")); + result.set(.home, pcStyle("\x1b[1;{}H") ++ cursorKey("\x1b[H", "\x1bOH")); + result.set(.end, pcStyle("\x1b[1;{}F") ++ cursorKey("\x1b[F", "\x1bOF")); + result.set(.insert, pcStyle("\x1b[2;{}~") ++ .{Entry{ .sequence = "\x1B[2~" }}); + result.set(.delete, pcStyle("\x1b[3;{}~") ++ .{Entry{ .sequence = "\x1B[3~" }}); + result.set(.page_up, pcStyle("\x1b[5;{}~") ++ .{Entry{ .sequence = "\x1B[5~" }}); + result.set(.page_down, pcStyle("\x1b[6;{}~") ++ .{Entry{ .sequence = "\x1B[6~" }}); + + // Function Keys. todo: f13-f35 but we need to add to input.Key + result.set(.f1, pcStyle("\x1b[1;{}P") ++ .{Entry{ .sequence = "\x1BOP" }}); + result.set(.f2, pcStyle("\x1b[1;{}Q") ++ .{Entry{ .sequence = "\x1BOQ" }}); + result.set(.f3, pcStyle("\x1b[13;{}~") ++ .{Entry{ .sequence = "\x1BOR" }}); + result.set(.f4, pcStyle("\x1b[1;{}S") ++ .{Entry{ .sequence = "\x1BOS" }}); + result.set(.f5, pcStyle("\x1b[15;{}~") ++ .{Entry{ .sequence = "\x1B[15~" }}); + result.set(.f6, pcStyle("\x1b[17;{}~") ++ .{Entry{ .sequence = "\x1B[17~" }}); + result.set(.f7, pcStyle("\x1b[18;{}~") ++ .{Entry{ .sequence = "\x1B[18~" }}); + result.set(.f8, pcStyle("\x1b[19;{}~") ++ .{Entry{ .sequence = "\x1B[19~" }}); + result.set(.f9, pcStyle("\x1b[20;{}~") ++ .{Entry{ .sequence = "\x1B[20~" }}); + result.set(.f10, pcStyle("\x1b[21;{}~") ++ .{Entry{ .sequence = "\x1B[21~" }}); + result.set(.f11, pcStyle("\x1b[23;{}~") ++ .{Entry{ .sequence = "\x1B[23~" }}); + result.set(.f12, pcStyle("\x1b[24;{}~") ++ .{Entry{ .sequence = "\x1B[24~" }}); + + // Keypad keys + result.set(.numpad_0, kpKeys("p")); + result.set(.numpad_1, kpKeys("q")); + result.set(.numpad_2, kpKeys("r")); + result.set(.numpad_3, kpKeys("s")); + result.set(.numpad_4, kpKeys("t")); + result.set(.numpad_5, kpKeys("u")); + result.set(.numpad_6, kpKeys("v")); + result.set(.numpad_7, kpKeys("w")); + result.set(.numpad_8, kpKeys("x")); + result.set(.numpad_9, kpKeys("y")); + result.set(.numpad_decimal, kpKeys("n")); + result.set(.numpad_divide, kpKeys("o")); + result.set(.numpad_multiply, kpKeys("j")); + result.set(.numpad_subtract, kpKeys("m")); + result.set(.numpad_add, kpKeys("k")); + result.set(.numpad_enter, kpKeys("M") ++ .{Entry{ .sequence = "\r" }}); + result.set(.numpad_up, pcStyle("\x1b[1;{}A") ++ cursorKey("\x1b[A", "\x1bOA")); + result.set(.numpad_down, pcStyle("\x1b[1;{}B") ++ cursorKey("\x1b[B", "\x1bOB")); + result.set(.numpad_right, pcStyle("\x1b[1;{}C") ++ cursorKey("\x1b[C", "\x1bOC")); + result.set(.numpad_left, pcStyle("\x1b[1;{}D") ++ cursorKey("\x1b[D", "\x1bOD")); + result.set(.numpad_begin, pcStyle("\x1b[1;{}E") ++ cursorKey("\x1b[E", "\x1bOE")); + result.set(.numpad_home, pcStyle("\x1b[1;{}H") ++ cursorKey("\x1b[H", "\x1bOH")); + result.set(.numpad_end, pcStyle("\x1b[1;{}F") ++ cursorKey("\x1b[F", "\x1bOF")); + result.set(.numpad_insert, pcStyle("\x1b[2;{}~") ++ .{Entry{ .sequence = "\x1B[2~" }}); + result.set(.numpad_delete, pcStyle("\x1b[3;{}~") ++ .{Entry{ .sequence = "\x1B[3~" }}); + result.set(.numpad_page_up, pcStyle("\x1b[5;{}~") ++ .{Entry{ .sequence = "\x1B[5~" }}); + result.set(.numpad_page_down, pcStyle("\x1b[6;{}~") ++ .{Entry{ .sequence = "\x1B[6~" }}); + + result.set(.backspace, &.{ + // Modify Keys Normal + .{ .mods = .{ .shift = true }, .modify_other_keys = .set, .sequence = "\x7f" }, + .{ .mods = .{ .alt = true }, .modify_other_keys = .set, .sequence = "\x1b\x7f" }, + .{ .mods = .{ .alt = true, .shift = true }, .modify_other_keys = .set, .sequence = "\x1b\x7f" }, + .{ .mods = .{ .ctrl = true, .shift = true }, .modify_other_keys = .set, .sequence = "\x08" }, + .{ .mods = .{ .alt = true, .ctrl = true }, .modify_other_keys = .set, .sequence = "\x1b\x08" }, + .{ .mods = .{ .super = true }, .modify_other_keys = .set, .sequence = "\x7f" }, + .{ .mods = .{ .super = true, .shift = true }, .modify_other_keys = .set, .sequence = "\x7f" }, + .{ .mods = .{ .alt = true, .super = true }, .modify_other_keys = .set, .sequence = "\x1b\x7f" }, + .{ .mods = .{ .alt = true, .super = true, .shift = true }, .modify_other_keys = .set, .sequence = "\x1b\x7f" }, + .{ .mods = .{ .super = true, .ctrl = true }, .modify_other_keys = .set, .sequence = "\x08" }, + .{ .mods = .{ .super = true, .ctrl = true, .shift = true }, .modify_other_keys = .set, .sequence = "\x08" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true }, .modify_other_keys = .set, .sequence = "\x1b\x08" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true, .shift = true }, .modify_other_keys = .set, .sequence = "\x1b\x08" }, + + // Modify Keys Other + .{ .mods = .{ .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;2;127~" }, + .{ .mods = .{ .alt = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;3;127~" }, + .{ .mods = .{ .alt = true, .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;4;127~" }, + .{ .mods = .{ .ctrl = true, .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;6;127~" }, + .{ .mods = .{ .alt = true, .ctrl = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;7;127~" }, + .{ .mods = .{ .alt = true, .shift = true, .ctrl = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;8;127~" }, + .{ .mods = .{ .super = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;9;127~" }, + .{ .mods = .{ .super = true, .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;10;127~" }, + .{ .mods = .{ .alt = true, .super = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;11;127~" }, + .{ .mods = .{ .alt = true, .super = true, .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;12;127~" }, + .{ .mods = .{ .super = true, .ctrl = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;13;127~" }, + .{ .mods = .{ .super = true, .ctrl = true, .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;14;127~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;15;127~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true, .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;16;127~" }, + + .{ .mods = .{ .ctrl = true }, .sequence = "\x08" }, + .{ .sequence = "\x7f" }, + }); + + result.set(.tab, &.{ + // Modify Keys Normal + .{ .mods = .{ .shift = true }, .modify_other_keys = .set, .sequence = "\x1b[Z" }, + .{ .mods = .{ .alt = true }, .modify_other_keys = .set, .sequence = "\x1b\t" }, + + // Modify Keys Other + .{ .mods = .{ .shift = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;2;9~" }, + .{ .mods = .{ .alt = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;3;9~" }, + + // Everything else + .{ .mods = .{ .alt = true, .shift = true }, .sequence = "\x1b[27;4;9~" }, + .{ .mods = .{ .ctrl = true }, .sequence = "\x1b[27;5;9~" }, + .{ .mods = .{ .ctrl = true, .shift = true }, .sequence = "\x1b[27;6;9~" }, + .{ .mods = .{ .alt = true, .ctrl = true }, .sequence = "\x1b[27;7;9~" }, + .{ .mods = .{ .alt = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;8;9~" }, + .{ .mods = .{ .super = true }, .sequence = "\x1b[27;9;9~" }, + .{ .mods = .{ .super = true, .shift = true }, .sequence = "\x1b[27;10;9~" }, + .{ .mods = .{ .alt = true, .super = true }, .sequence = "\x1b[27;11;9~" }, + .{ .mods = .{ .alt = true, .super = true, .shift = true }, .sequence = "\x1b[27;12;9~" }, + .{ .mods = .{ .super = true, .ctrl = true }, .sequence = "\x1b[27;13;9~" }, + .{ .mods = .{ .super = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;14;9~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true }, .sequence = "\x1b[27;15;9~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;16;9~" }, + + .{ .sequence = "\t" }, + }); + + result.set(.enter, &.{ + .{ .mods = .{ .shift = true }, .sequence = "\x1b[27;2;13~" }, + + // Modify Keys Normal + .{ .mods = .{ .alt = true }, .modify_other_keys = .set, .sequence = "\x1b\r" }, + + // Modify Keys Other + .{ .mods = .{ .alt = true }, .modify_other_keys = .set_other, .sequence = "\x1b[27;3;13~" }, + + // Everything else + .{ .mods = .{ .alt = true, .shift = true }, .sequence = "\x1b[27;4;13~" }, + .{ .mods = .{ .ctrl = true }, .sequence = "\x1b[27;5;13~" }, + .{ .mods = .{ .ctrl = true, .shift = true }, .sequence = "\x1b[27;6;13~" }, + .{ .mods = .{ .alt = true, .ctrl = true }, .sequence = "\x1b[27;7;13~" }, + .{ .mods = .{ .alt = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;8;13~" }, + .{ .mods = .{ .super = true }, .sequence = "\x1b[27;9;13~" }, + .{ .mods = .{ .super = true, .shift = true }, .sequence = "\x1b[27;10;13~" }, + .{ .mods = .{ .alt = true, .super = true }, .sequence = "\x1b[27;11;13~" }, + .{ .mods = .{ .alt = true, .super = true, .shift = true }, .sequence = "\x1b[27;12;13~" }, + .{ .mods = .{ .super = true, .ctrl = true }, .sequence = "\x1b[27;13;13~" }, + .{ .mods = .{ .super = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;14;13~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true }, .sequence = "\x1b[27;15;13~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;16;13~" }, + + .{ .sequence = "\r" }, + }); + + result.set(.escape, &.{ + .{ .mods = .{ .shift = true }, .sequence = "\x1b[27;2;27~" }, + .{ .mods = .{ .alt = true }, .sequence = "\x1b\x1b" }, + .{ .mods = .{ .alt = true, .shift = true }, .sequence = "\x1b[27;4;27~" }, + .{ .mods = .{ .ctrl = true }, .sequence = "\x1b[27;5;27~" }, + .{ .mods = .{ .ctrl = true, .shift = true }, .sequence = "\x1b[27;6;27~" }, + .{ .mods = .{ .alt = true, .ctrl = true }, .sequence = "\x1b[27;7;27~" }, + .{ .mods = .{ .alt = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;8;27~" }, + .{ .mods = .{ .super = true }, .sequence = "\x1b[27;9;27~" }, + .{ .mods = .{ .super = true, .shift = true }, .sequence = "\x1b[27;10;27~" }, + .{ .mods = .{ .alt = true, .super = true }, .sequence = "\x1b[27;11;27~" }, + .{ .mods = .{ .alt = true, .super = true, .shift = true }, .sequence = "\x1b[27;12;27~" }, + .{ .mods = .{ .super = true, .ctrl = true }, .sequence = "\x1b[27;13;27~" }, + .{ .mods = .{ .super = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;14;27~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true }, .sequence = "\x1b[27;15;27~" }, + .{ .mods = .{ .alt = true, .super = true, .ctrl = true, .shift = true }, .sequence = "\x1b[27;16;27~" }, + .{ .sequence = "\x1b" }, + }); + + break :keys result; +}; + +/// Returns the default keypad application mode entry. +fn kpDefault(comptime suffix: []const u8) []const Entry { + return &.{ + .{ + .mods_empty_is_any = false, + .keypad = .application, + .sequence = "\x1bO" ++ suffix, + }, + }; +} + +/// Returns the entries for a keypad key. The suffix is the final character +/// of the sent sequence, such as "r" for kp_2. +fn kpKeys(comptime suffix: []const u8) []const Entry { + const pc = pcStyle("\x1bO{}" ++ suffix); + for (pc) |*entry| entry.keypad = .application; + return kpDefault(suffix) ++ pc; +} + +/// Returns entries that are dependent on cursor key settings. +fn cursorKey( + comptime normal: []const u8, + comptime application: []const u8, +) []const Entry { + return &.{ + .{ .cursor = .normal, .sequence = normal }, + .{ .cursor = .application, .sequence = application }, + }; +} + +/// Constructs a set of pcStyle function keys using the given format. The +/// format should have exactly one "hole" for the mods code. +/// Example: "\x1b[11;{}~" for F1. +fn pcStyle(comptime fmt: []const u8) []Entry { + // The comptime {} wrapper is superfluous but it prevents us from + // accidentally running this function at runtime. + comptime { + @setEvalBranchQuota(500_000); + var entries: [modifiers.len]Entry = undefined; + for (modifiers, 2.., 0..) |mods, code, i| { + entries[i] = .{ + .mods = mods, + .sequence = std.fmt.comptimePrint(fmt, .{code}), + }; + } + + return &entries; + } +} + +test "keys" { + const testing = std.testing; + switch (@import("terminal_options").artifact) { + .ghostty => {}, + // Don't want to bring in termio into libghostty-vt + .lib => return error.SkipZigTest, + } + + // Force resolution for comptime evaluation. + _ = keys; + + // All key sequences must fit into a termio array. + const max = @import("../termio.zig").Message.WriteReq.Small.Max; + for (keys.values) |entries| { + for (entries) |entry| { + try testing.expect(entry.sequence.len <= max); + } + } +} |