starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Reporting window size events in stdin #19492

New Issue
Closed
opened 2026-01-31 06:44:57 +00:00 by claunia · 2 comments
claunia commented 2026-01-31 06:44:57 +00:00
Owner
Copy Link

Originally created by @ShrykeWindgrace on GitHub (Mar 6, 2023).

Originally assigned to: @DHowett on GitHub.

Windows Terminal version

1.16.10261.0

Windows build number

10.0.19044.0 (21H2)

Other Software

Steps to reproduce

I am setting my input handle with ENABLE_VIRTUAL_TERMINAL_INPUT | ENABLE_WINDOW_INPUT | ENABLE_MOUSE_INPUT | ENABLE_EXTENDED_FLAGS,

Stdout's mode is left as default (0x7) with requests for focus reporting, mouse button reporting, and disabling mouse_any reporting: \ESC[?1004h\ESC[?1003l\ESC[?1002h.

Then I read from my stdin.

Expected Behavior

Some sort of binary/VT sequence of bytes to represent a window resize event.

Actual Behavior

Keyboard events are present in stdin (in their VT form), as are mouse and focus events. However, I have nothing when I resize the WT window (both via mouse or via fullscreen toggle via F11).

The phrase "User interactions that change the size of the console screen buffer are reported in the console's input buffer" for ENABLE_WINDOW_INPUT on the page https://learn.microsoft.com/en-us/windows/console/high-level-console-modes has lead me to believe that I should get at least something - maybe not a VT escape sequence per se, but something.

Is there anything in my configuration amiss? Is there a gentle \ESC[?10XXh equivalent of "please give me window resize events, too"?

The example in https://learn.microsoft.com/en-us/windows/console/reading-input-buffer-events works fine without additional configuration.

Cheers!

Originally created by @ShrykeWindgrace on GitHub (Mar 6, 2023). Originally assigned to: @DHowett on GitHub. ### Windows Terminal version 1.16.10261.0 ### Windows build number 10.0.19044.0 (21H2) ### Other Software ### Steps to reproduce I am setting my input handle with `ENABLE_VIRTUAL_TERMINAL_INPUT | ENABLE_WINDOW_INPUT | ENABLE_MOUSE_INPUT | ENABLE_EXTENDED_FLAGS`, Stdout's mode is left as default (`0x7`) with requests for focus reporting, mouse button reporting, and disabling `mouse_any` reporting: `\ESC[?1004h\ESC[?1003l\ESC[?1002h`. Then I read from my `stdin`. ### Expected Behavior Some sort of binary/VT sequence of bytes to represent a window resize event. ### Actual Behavior Keyboard events are present in `stdin` (in their VT form), as are mouse and focus events. However, I have nothing when I resize the WT window (both via mouse or via fullscreen toggle via F11). The phrase `"User interactions that change the size of the console screen buffer are reported in the console's input buffer"` for `ENABLE_WINDOW_INPUT` on the page https://learn.microsoft.com/en-us/windows/console/high-level-console-modes has lead me to believe that I should get at least something - maybe not a VT escape sequence per se, but something. Is there anything in my configuration amiss? Is there a gentle `\ESC[?10XXh` equivalent of "please give me window resize events, too"? The example in https://learn.microsoft.com/en-us/windows/console/reading-input-buffer-events works fine without additional configuration. Cheers!
claunia added the Issue-QuestionNeeds-Tag-FixResolution-Answered labels 2026-01-31 06:44:58 +00:00
claunia commented 2026-01-31 06:44:59 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Mar 9, 2023):

Hey @ShrykeWindgrace! This is one place where we could seriously do better. Alright, here goes.

Right now, the window size events come in in the form of INPUT_RECORD structures when you use ReadConsoleInputW. Even in VT mode.

We don't have a VT encoding for window size events for one really annoying reason: nobody does! On non-Windows platforms, these things come in via an asynchronous signal SIGWINCH, and are read out of the tty via the TIOCGSZ IOCTL. We don't have either of those things on which to build a good window size notification primitive, so instead it comes in as raw events in the input stream.

So, I can give you these two things:

  1. A "template" for how we deal with it, when all we want is a simple application that reads VT and knows when the window changes size. class ConsoleInputReader sort-of encapsulates all of that annoying stuff and turns your input stream into (1) a buffer of raw VT and (2) callbacks for window size events.
  2. A link to #281, one of our oldest open issues, which tracks (despite the name) teasing apart how and where and when we generate window input events.

I briefly had a prototype (branch on this repo that mentions l9 and hax) for how the console host could deliver asynchronous signals to client applications for things like this, but it felt too dangerous x low-priority to invest in.

Hope that helps! I'm gonna mark this issue up as a question with resolution=answered and later convert it to discussion. Please feel free to come back with any followups!

@DHowett commented on GitHub (Mar 9, 2023): Hey @ShrykeWindgrace! This is one place where we could seriously do better. _Alright, here goes._ Right now, the window size events come in in the form of [`INPUT_RECORD`](https://learn.microsoft.com/en-us/windows/console/input-record-str) structures when you use [`ReadConsoleInputW`](https://learn.microsoft.com/en-us/windows/console/readconsoleinput). _Even in VT mode._ We don't have a VT encoding for window size events for one really annoying reason: nobody does! On non-Windows platforms, these things come in via an asynchronous signal `SIGWINCH`, and are read out of the tty via the `TIOCGSZ` IOCTL. We don't have either of those things on which to build a good window size notification primitive, so instead it comes in as raw events in the input stream. So, I can give you these two things: 1. A "template" for how we deal with it, when all we want is a simple application that reads VT and knows when the window changes size. [`class ConsoleInputReader`](https://github.com/microsoft/terminal/blob/main/src/cascadia/TerminalAzBridge/ConsoleInputReader.cpp) sort-of encapsulates all of that annoying stuff and turns your input stream into (1) a buffer of raw VT and (2) _callbacks_ for window size events. 2. A link to #281, one of our oldest open issues, which tracks (despite the name) teasing apart how and where and when we generate window input events. _I briefly had a prototype (branch on this repo that mentions `l9` and `hax`) for how the console host could deliver asynchronous signals to client applications for things like this, but it felt too dangerous x low-priority to invest in._ Hope that helps! I'm gonna mark this issue up as a question with resolution=answered and later convert it to discussion. Please feel free to come back with any followups!
claunia commented 2026-01-31 06:45:00 +00:00
Author
Owner
Copy Link

@ShrykeWindgrace commented on GitHub (Mar 9, 2023):

Thanks a lot for the comprehensive answer! I'll see what I can do with this info =)

@ShrykeWindgrace commented on GitHub (Mar 9, 2023): Thanks a lot for the comprehensive answer! I'll see what I can do with this info =)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Issue-Question Needs-Tag-Fix Resolution-Answered
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#19492
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?