Implement kitty's keyboard protocol - #7125
Merged
Merged
Conversation
Closed
raphamorim
added a commit
to raphamorim/rio
that referenced
this pull request
Aug 28, 2023
changes retired by alacritty/alacritty#7125
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as off-topic.
This comment was marked as off-topic.
kchibisov
force-pushed
the
kitty-keyboard
branch
from
October 9, 2023 15:51
c39c3c9 to
89e5477
Compare
kchibisov
marked this pull request as ready for review
October 9, 2023 15:51
chrisduerr
requested changes
Oct 14, 2023
kchibisov
force-pushed
the
kitty-keyboard
branch
2 times, most recently
from
November 11, 2023 16:33
22b1af1 to
69c66ed
Compare
kchibisov
force-pushed
the
kitty-keyboard
branch
from
November 12, 2023 05:23
69c66ed to
d9f82e2
Compare
kchibisov
force-pushed
the
kitty-keyboard
branch
2 times, most recently
from
November 24, 2023 20:41
ada954a to
6ba6b01
Compare
chrisduerr
requested changes
Nov 25, 2023
kchibisov
force-pushed
the
kitty-keyboard
branch
2 times, most recently
from
November 25, 2023 02:48
6e25fc4 to
b8a634e
Compare
chrisduerr
requested changes
Nov 26, 2023
kchibisov
force-pushed
the
kitty-keyboard
branch
3 times, most recently
from
November 26, 2023 22:20
b7a8d63 to
a59e12d
Compare
chrisduerr
requested changes
Nov 30, 2023
chrisduerr
requested changes
Dec 1, 2023
| NamedKey::F1 => (one_based, SequenceTerminator::Normal('P')), | ||
| NamedKey::F2 => (one_based, SequenceTerminator::Normal('Q')), | ||
| NamedKey::F3 => { | ||
| // F3 in kitty protocol diverges from alacritty's terminfo. |
Member
There was a problem hiding this comment.
Why is this? Is Kitty's default reply different without the protocol enabled?
Member
Author
There was a problem hiding this comment.
Kitty uses different values to us by default.
kchibisov
force-pushed
the
kitty-keyboard
branch
from
December 2, 2023 00:57
ef97f21 to
cdbdb1e
Compare
kchibisov
force-pushed
the
kitty-keyboard
branch
2 times, most recently
from
December 3, 2023 06:17
e219fa0 to
13f4e31
Compare
chrisduerr
requested changes
Dec 5, 2023
|
|
||
| impl SequenceBuildingContext { | ||
| /// Try building sequence from the event's emitting text. | ||
| fn try_from_textual(&self, key: &KeyEvent) -> Option<SequenceBase> { |
Member
There was a problem hiding this comment.
I've just noticed this, but why do all these try_from impls not return Self?
Member
Author
There was a problem hiding this comment.
That's because we use Context to build common concepts, it's not really a builder. Alternatively we'd need to carry the value inside this builder, which is not good.
The design is simply to have common args passed across the functions. I had a version with Self but I wasn't sure about it, since it was less clear.
Member
There was a problem hiding this comment.
It's just the name that doesn't make sense here, I'm not opposed to the mechanism.
A try_from method that takes self and doesn't return Self is just nonsense. Maybe just rename the struct to SequenceBuilder and make it try_build_textual etc?
Member
Author
There was a problem hiding this comment.
A try_from method that takes self and doesn't return Self is just nonsense. Maybe just rename the struct to SequenceBuilder and make it try_build_textual etc?
I guess, I applied the suggestion.
kchibisov
force-pushed
the
kitty-keyboard
branch
from
December 5, 2023 20:02
959aa36 to
8dd63da
Compare
chrisduerr
approved these changes
Dec 6, 2023
The protocol enables robust key reporting for the applications, so they could bind more keys and the user won't have collisions with the normal control keys. Links: https://sw.kovidgoyal.net/kitty/keyboard-protocol Fixes alacritty#6378.
kchibisov
force-pushed
the
kitty-keyboard
branch
from
December 6, 2023 04:39
8dd63da to
8f4cc26
Compare
|
Thank you @kchibisov, I'm very excited to try this out! |
Closed
1 task
listx
added a commit
to listx/syscfg
that referenced
this pull request
Jul 28, 2024
We've been using WezTerm for almost two years now (since 0c09547 (add wezterm, 2022-09-27)) as the main terminal program. The only drawbacks of using WezTerm are performance and increased memory usage. However neither of these drawbacks mean much in practice. Performance is more than fast enough and memory usage, though high, is stable. Interestingly, since we've switched away to WezTerm, Alacritty has merged support for the Kitty Keyboard Protocol (KKP) [1], which would presumably allow binding "C-," which was the original blocker for us [2]. If we go back to Alacritty we could also use the kkp.el Emacs package [3] so that we could use terminal Emacs with it. Sadly, this won't work for us because we always use tmux everywhere (terminal + tmux + Emacs), and tmux would itself need to understand KKP for it to seamlessly send those keyboard events over to Emacs from KKP-aware Alacritty. And tmux does not yet support KKP [4]. When tmux starts supporting KKP, we should be able to revisit this area and perhaps move back to Alacritty to pick up the performance/memory benefits and also retire our rather extensive CSI-u customizations across WezTerm [5], tmux [6] [7], and Emacs [8] in order to support "C-," and other exotic bindings inside terminal Emacs. We leave the machinery around switching terminal colors, such as script/terminal-themes/install_alacritty_colors.sh script/terminal-themes/renderAlacrittyColorYaml.dhall in place because when the time comes for switching back to Alacritty, those scripts might still be useful. [1] alacritty/alacritty#7125 [2] alacritty/alacritty#6354 [3] https://github.com/benjaminor/kkp [4] tmux/tmux#3335 [5] https://github.com/listx/syscfg/blame/07442d9f40569e55e34478e7214b5a13f46d8126/wezterm/README.org#L270 [6] https://github.com/listx/syscfg/blob/07442d9f40569e55e34478e7214b5a13f46d8126/tmux/.tmux.conf#L98 [7] tmux/tmux#2705 (comment) [8] https://github.com/listx/syscfg/blame/master/emacs/doom-cfg/README.org#L462
This was referenced Feb 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The protocol enables robust key reporting for the applications, so they could bind more keys and the user won't have collisions with the legacy control keys.
Fixes #6378.
Links: https://sw.kovidgoyal.net/kitty/keyboard-protocol
--
Only draft because of vte. I've also hasn't updated man pages, because the modes could be renamed. Besides everything should work...