Skip to content

Implement support for Kitty Keyboard Protocol #4769

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
horkykuba wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Implement support for Kitty Keyboard Protocol #4769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2f08ad2
.gitignore: Ignore lib/stdckdint.h, *.log, and *.orig
Nov 15, 2025
d057c0b
lib/tty: Add tty_putp() and tty_tiparm()
Nov 7, 2025
34a216a
lib/tty/key.c: Replace paranoia code with parsing code
Nov 15, 2025
5097399
lib/tty/key.c: Fix typo in comment
Oct 22, 2025
06d5543
tests/lib/tty.c: Add key mocking support
Oct 23, 2025
3eb6be8
lib/tty/key.c: Add Kitty Keyboard Protocol support
Nov 15, 2025
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
*.la
*~
*.cache
*.log
*.orig
*.tar.gz
# autoconf runs "mktemp ./confXXXXXX"
/conf??????/
Expand Down Expand Up @@ -44,6 +46,7 @@ TAGS
doc/devel/
doc/html/
.deps
lib/stdckdint.h
Copy link
Contributor

@ossilator ossilator Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pedantically, all these entries are lacking the / prefix to anchor them at the root. but fixing that is for another commit.

libtool
make.log
make.clang
Expand Down
7 changes: 7 additions & 0 deletions doc/man/es/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3965,6 +3965,13 @@ For example:
.nf
autodetect_codeset=russian
.fi
.TP
.I kitty_keyboard_protocol
De forma predeterminada, Midnight Commander envía una secuencia de escape que habilita el
protocolo de teclado de Kitty, lo que permite un manejo preciso del teclado (incluyendo
combinaciones de teclas como C\-Enter o C\-S\-Enter) cuando se conecta desde terminales
que admiten este protocolo. Si se establece en falso, Midnight Commander no intentará
habilitar este protocolo.
.\"NODE "Parameters for external editor or viewer"
.SH "Parámetros para editor o visor externo"
Midnight Commander permite especificar opciones para editores y visores
Expand Down
8 changes: 8 additions & 0 deletions doc/man/hu/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3014,6 +3014,14 @@ utolsó fájl a panelben.
.IP
Ha ez a változó be van állítva (alapértelmezésben) meg foja jelölni azt
a fájl parancsot, amelyhez a
.PP
.I kitty_keyboard_protocol
Alapértelmezés szerint a Midnight Commander egy olyan escape szekvenciát
küld, amely engedélyezi a Kitty billentyűzetprotokollt. Ez lehetővé teszi
a billentyűzet pontos kezelését (beleértve az olyan billentyűkombinációkat
is, mint a C\-Enter vagy a C\-S\-Enter), amikor olyan terminálról
csatlakoznak, amely támogatja ezt a protokollt. Ha az érték hamisra van
állítva, a Midnight Commander nem próbálja meg engedélyezni ezt a protokollt.
.\"LINK2"
Társításokban
.\"Edit Extension File"
Expand Down
8 changes: 8 additions & 0 deletions doc/man/it/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3014,6 +3014,14 @@ pannello.
.I use_file_to_guess_type
Se questa variabile è abilitata (valore predefinito) userà il comando
file per trovare delle corrispondenze sui tipi di file elencati nel
.TP
.I kitty_keyboard_protocol
Per impostazione predefinita, Midnight Commander invia una sequenza di
escape che abilita il Kitty Keyboard Protocol, il quale consente una
gestione precisa della tastiera (incluse combinazioni di tasti come
C\-Enter o C\-S\-Enter) quando ci si connette da terminali che supportano
questo protocollo. Se impostato su false, Midnight Commander non tenterà
di abilitare questo protocollo.
.\"LINK2"
file mc.ext.ini\&.
.\"Edit Extension File"
Expand Down
7 changes: 7 additions & 0 deletions doc/man/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4208,6 +4208,13 @@ For example:
.nf
autodetect_codeset=russian
.fi
.TP
.I kitty_keyboard_protocol
By default, Midnight Commander sends an escape sequence that enables the Kitty
Keyboard Protocol, which allows precise keyboard handling (including key
combinations such as C\-Enter or C\-S\-Enter) when connected from terminals that
support this protocol. If set to false, Midnight Commander will not attempt to
Copy link
Contributor

@ossilator ossilator Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this probably should point out that it's expected to be harmless to attempt it on lame terminals, which makes this option mostly unnecessary.

enable this protocol.
.\"NODE "Parameters for external editor or viewer"
.SH "Parameters for external editor or viewer"
Midnight Commander provides a way for specify an options for external editors
Expand Down
7 changes: 7 additions & 0 deletions doc/man/pl/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2708,6 +2708,13 @@ Jeśli ta opcja jest włączona (standardowo tak nie jest) kiedy przeglądasz pl
w panelu drzewa, będzie on automatycznie przeładowywał drugi panel na
zawartość wybranego katalogu.
.PP
.I kitty_keyboard_protocol
Domyślnie Midnight Commander wysyła sekwencję escape, która włącza protokół
klawiatury Kitty. Umożliwia on precyzyjną obsługę klawiatury (w tym kombinacje
klawiszy takie jak C\-Enter czy C\-S\-Enter) podczas połączenia z terminalami
obsługującymi ten protokół. Jeśli ustawione na false, Midnight Commander
nie będzie próbował włączyć tego protokołu.
.PP
.\"NODE "Terminal databases"
.SH Baza danych terminali (Terminal databases)
Midnight Commander pozwala ci na naprawienie bazy danych terminali bez
Expand Down
7 changes: 7 additions & 0 deletions doc/man/ru/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4663,6 +4663,13 @@ clipboard_paste=xclip \-o
.nf
autodetect_codeset=russian
.fi
.PP
.I kitty_keyboard_protocol
По умолчанию Midnight Commander отправляет управляющую последовательность, которая
включает протокол клавиатуры Kitty. Этот протокол обеспечивает точную обработку
клавиатуры (включая такие комбинации клавиш, как C\-Enter или C\-S\-Enter) при
подключении из терминалов, поддерживающих данный протокол. Если установить значение
в false, Midnight Commander не будет пытаться включить этот протокол.
.\"NODE "Parameters for external editor or viewer"
.SH "Параметры для внешних редакторов и программ просмотра"
Midnight Commander позволяет задать некоторые параметрыы для внешних редакторов
Expand Down
8 changes: 8 additions & 0 deletions doc/man/sr/mc.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4044,6 +4044,14 @@ clipboard_paste=xclip \-o
.nf
autodetect_codeset=russian
.fi
.TP
.I kitty_keyboard_protocol
Подразумевано, Midnight Commander шаље escape секвенцу која омогућава
Kitty протокол тастатуре, што омогућава прецизно руковање тастатуром
(укључујући комбинације тастера као што су C\-Enter или C\-S\-Enter)
када се повезује са терминала који подржавају овај протокол. Ако је
постављено на false, Midnight Commander неће покушати да омогући овај
протокол.
.\"NODE "Parameters for external editor or viewer"
.SH "Параметри спољашњег уређивача или прегледача"
Поноћни наредник обезбеђује начин да се задају опције за спољашње уређиваче и
Expand Down
3 changes: 2 additions & 1 deletion lib/global.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ mc_global_t mc_global =
.disable_colors = FALSE,
.ugly_line_drawing = FALSE,
.old_mouse = FALSE,
.alternate_plus_minus = FALSE
.alternate_plus_minus = FALSE,
.kitty_keyboard_protocol = TRUE
},

.vfs =
Expand Down
4 changes: 4 additions & 0 deletions lib/global.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,10 @@ typedef struct
/* If true, use + and \ keys normally and select/unselect do if M-+ / M-\.
and M-- and keypad + / - */
gboolean alternate_plus_minus;

// If true, send Kitty Keyboard Protocol initialization string to the terminal
// Defaults to true, because terminals that don't support it simply do nothing
gboolean kitty_keyboard_protocol;
} tty;

struct
Expand Down
1 change: 1 addition & 0 deletions lib/terminal.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ parse_csi (csi_command_t *out, const char **sptr, const char *end)
{
out->private_mode = private_mode;
out->param_count = param_count;
out->final_byte = c;
}

invalid_sequence:
Expand Down
1 change: 1 addition & 0 deletions lib/terminal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ typedef struct
char private_mode;
uint32_t params[16][4];
size_t param_count;
char final_byte;
} csi_command_t;

/*** global variables defined in .c file *********************************************************/
Expand Down
Loading
Loading