Implement the Kitty Keyboard Protocol #19817

lhecker · 2026-01-29T23:00:21Z

TBD

Validation Steps Performed

kitten show-key -m kitty ✅
TBD
TODO: https://github.com/unxed/kitty2vte

src/terminal/input/terminalInput.cpp

+uint32_t TerminalInput::_codepointToLower(uint32_t cp) noexcept
+{
+    auto cb = _codepointToBuffer(cp);
+    // NOTE: MSDN states that `lpSrcStr == lpDestStr` is valid for LCMAP_LOWERCASE.


src/terminal/input/terminalInput.cpp

+{
+    auto cb = _codepointToBuffer(cp);
+    // NOTE: MSDN states that `lpSrcStr == lpDestStr` is valid for LCMAP_LOWERCASE.
+    const auto len = LCMapStringW(LOCALE_INVARIANT, LCMAP_LOWERCASE, cb.buf, cb.len, cb.buf, gsl::narrow_cast<int>(std::size(cb.buf)));


src/terminal/parser/OutputStateMachineEngine.cpp

    case CsiActionCodes::ANSISYSRC_CursorRestore:
        _dispatch->CursorRestoreState();
        break;
+    case CsiActionCodes::KKP_KittyKeyboardSet:


src/terminal/parser/OutputStateMachineEngine.cpp

+    case CsiActionCodes::KKP_KittyKeyboardSet:
+        _dispatch->SetKittyKeyboardProtocol(parameters.at(0), parameters.at(1));
+        break;
+    case CsiActionCodes::KKP_KittyKeyboardQuery:


src/terminal/parser/OutputStateMachineEngine.cpp

+    case CsiActionCodes::KKP_KittyKeyboardQuery:
+        _dispatch->QueryKittyKeyboardProtocol();
+        break;
+    case CsiActionCodes::KKP_KittyKeyboardPush:


src/terminal/parser/OutputStateMachineEngine.cpp

+    case CsiActionCodes::KKP_KittyKeyboardPush:
+        _dispatch->PushKittyKeyboardProtocol(parameters.at(0));
+        break;
+    case CsiActionCodes::KKP_KittyKeyboardPop:


src/terminal/parser/OutputStateMachineEngine.hpp

            DECSLRM_SetLeftRightMargins = VTID("s"),
            DTTERM_WindowManipulation = VTID("t"), // NOTE: Overlaps with DECSLPP. Fix when/if implemented.
            ANSISYSRC_CursorRestore = VTID("u"),
+            KKP_KittyKeyboardSet = VTID("=u"),


lhecker · 2026-01-29T23:02:45Z

src/cascadia/TerminalCore/Terminal.cpp

    }

    _getTerminalInput().ForceDisableWin32InputMode(settings.ForceVTInput());
+    _getTerminalInput().ForceDisableKittyKeyboardProtocol(!settings.AllowKittyKeyboardMode());


This doesn't work because OpenConsole still turns the Win32 events into Kitty ones. I don't understand why that happens and don't like that it happens. 🫩

DHowett · 2026-01-29T23:05:52Z

src/common.build.pre.props

  <!-- For ALL build types-->
  <PropertyGroup Label="Configuration">
-    <PlatformToolset>v143</PlatformToolset>
+    <PlatformToolset>v145</PlatformToolset>


Shouldn't have done the git add -A, eh? 🫠

DHowett

we are unfortunately going to need some tests. or something. of the weird corner cases.

DHowett · 2026-01-29T23:06:34Z

src/terminal/input/mouseInputState.cpp

-#include <windows.h>
-#include "terminalInput.hpp"
-
-using namespace Microsoft::Console::VirtualTerminal;


lol a 30 line file to maintain ... one boolean

DHowett · 2026-01-29T23:07:28Z

src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw

    <comment>Header for a control to toggle legacy input encoding for the terminal.</comment>
  </data>
+  <data name="Profile_AllowKittyKeyboardMode.Header" xml:space="preserve">
+    <value>Kitty keyboard protocol mode</value>


probably want to lock this term

DHowett · 2026-01-29T23:08:01Z

src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw

+    <comment>Header for a control to set the kitty keyboard protocol mode.</comment>
+  </data>
+  <data name="Profile_AllowKittyKeyboardMode.HelpText" xml:space="preserve">
+    <value>Sets the baseline flags for the kitty keyboard protocol. Value is a sum of: 1=Disambiguate, 2=Report event types, 4=Report alternate keys, 8=Report all keys, 16=Report text.</value>


also it's a boolean right now

Ah thanks forgot about that one.

carlos-zamora · 2026-01-29T23:32:55Z

src/cascadia/TerminalSettingsEditor/Profiles_Terminal.xaml

            </local:SettingContainer>

+            <!--  Kitty Keyboard Mode  -->
+            <local:SettingContainer x:Uid="Profile_AllowKittyKeyboardMode"


Suggested change

<local:SettingContainer x:Uid="Profile_AllowKittyKeyboardMode"

<local:SettingContainer x:Name="AllowKittyKeyboardMode"

x:Uid="Profile_AllowKittyKeyboardMode"

(when settings search merges) if you add a name here, it'll automatically get added to the search index 😉

DHowett

Almost all the way done. Can you explain the conhost win32im thing? Should we actually use Kitty as our internal protocol?

DHowett · 2026-01-29T23:14:01Z

src/terminal/input/terminalInput.cpp

+    // Pop the requested number of entries, restoring flags from last popped
+    for (size_t i = 0; i < count; ++i)
+    {
+        _kittyFlags = stack.back();
+        stack.pop_back();


can we just, like, _kittyFlags = stack.at(count + 1); and erase the first count entries?

DHowett · 2026-01-29T23:26:07Z

src/terminal/input/terminalInput.cpp

+
+// Generates kitty keyboard protocol output for a key event.
+// https://sw.kovidgoyal.net/kitty/keyboard-protocol/
+TerminalInput::OutputType TerminalInput::_makeKittyOutput(const KEY_EVENT_RECORD& key, const DWORD controlKeyState)


lord, it's 400 lines

Unfortunately, even my upcoming, more readable version, won't make it any shorter...

lhecker · 2026-01-30T14:38:58Z

I'm working on a version that's a lot easier to read. The problem is that it also doesn't quite work. 😄 Still working on that.

Implement the Kitty Keyboard Protocol

0779277

github-advanced-security bot found potential problems Jan 29, 2026

View reviewed changes

Spel

5d0e8c2

microsoft-github-policy-service bot added Issue-Task It's a feature request, but it doesn't really need a major design. Area-Input Related to input processing (key presses, mouse, etc.) Product-Conhost For issues in the Console codebase Product-Terminal The new Windows Terminal. labels Jan 29, 2026

lhecker commented Jan 29, 2026

View reviewed changes

DHowett reviewed Jan 29, 2026

View reviewed changes

DHowett requested changes Jan 29, 2026

View reviewed changes

microsoft-github-policy-service bot added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Jan 29, 2026

carlos-zamora reviewed Jan 29, 2026

View reviewed changes

carlos-zamora added a commit that referenced this pull request Jan 29, 2026

PRE-MERGE #19817 Implement the Kitty Keyboard Protocol

91dbd65

DHowett reviewed Jan 30, 2026

View reviewed changes

lhecker marked this pull request as draft January 30, 2026 14:38

	<local:SettingContainer x:Uid="Profile_AllowKittyKeyboardMode"
	<local:SettingContainer x:Name="AllowKittyKeyboardMode"
	x:Uid="Profile_AllowKittyKeyboardMode"

Implement the Kitty Keyboard Protocol #19817

Are you sure you want to change the base?

Implement the Kitty Keyboard Protocol #19817

Uh oh!

Conversation

lhecker commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Validation Steps Performed

Uh oh!

Check failure

Check failure

Check failure

Check failure

Check failure

Check failure

Check failure

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DHowett left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DHowett left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhecker commented Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lhecker commented Jan 29, 2026 •

edited

Loading