starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-09-25 08:24:54 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #3963] [VT Mouse Mode] Translate SGR Mouse VT Sequences to MOUSE_EVENT_RECORD #25585

New Issue
Open
opened 2026-01-31 09:10:26 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:10:26 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/microsoft/terminal/pull/3963

State: closed
Merged: Yes

Summary of the Pull Request

Upgrades the InputStateMachineEngine to take SGR Mouse VT Sequences and translate them into MOUSE_EVENT_RECORDS.

References

https://docs.microsoft.com/en-us/windows/console/mouse-event-record-str
https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Extended-coordinates
#376

PR Checklist

Detailed Description of the Pull Request / Additional comments

Modifications to InputStateMachineEngine

I introduced various enum types...

  • CsiIntermediateCodes: our supported intermediate codes. Currently only <
  • CsiEndCodes: the last code used for SGR Mouse Mode
  • CsiMouseButtonCodes: which button was pressed. Mutually exclusive. Buttons beyond button 11 are ambiguous.
  • CsiMouseModifierCodes: bitfield of modifiers active for SGR Mouse Mode.

CsiIntermediateCodes is used first in ActionCsiDispatch to detect the VT Sequence. This kicks off a chain of function calls...

  • _GetXYPosition(): figure out where the mouse was clicked
  • _UpdateSGRMouseButtonState: read in what we found and update our internal state
  • _WriteMouseEvent(): generate an INPUT_RECORD and send it off

Modifications to Testing Suite

read below.
Also, made the test state a globally accessible/modifiable variable.

Validation Steps Performed

Added tests that cover...

  • button clicks
  • button clicks with modifiers
  • mouse movement
  • mouse movement and entering/exiting a state where multiple buttons were pressed
**Original Pull Request:** https://github.com/microsoft/terminal/pull/3963 **State:** closed **Merged:** Yes --- ## Summary of the Pull Request Upgrades the `InputStateMachineEngine` to take SGR Mouse VT Sequences and translate them into `MOUSE_EVENT_RECORDS`. ## References https://docs.microsoft.com/en-us/windows/console/mouse-event-record-str https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Extended-coordinates #376 ## PR Checklist * [X] Contributes to #376 * [X] CLA signed. * [X] Tests added/passed * [ ] Requires documentation to be updated ## Detailed Description of the Pull Request / Additional comments ### Modifications to `InputStateMachineEngine` I introduced various enum types... - `CsiIntermediateCodes`: our supported intermediate codes. Currently only `<` - `CsiEndCodes`: the last code used for SGR Mouse Mode - `CsiMouseButtonCodes`: which button was pressed. Mutually exclusive. Buttons beyond button 11 are ambiguous. - `CsiMouseModifierCodes`: bitfield of modifiers active for SGR Mouse Mode. `CsiIntermediateCodes` is used first in `ActionCsiDispatch` to detect the VT Sequence. This kicks off a chain of function calls... - `_GetXYPosition()`: figure out where the mouse was clicked - `_UpdateSGRMouseButtonState`: read in what we found and update our internal state - `_WriteMouseEvent()`: generate an INPUT_RECORD and send it off ### Modifications to Testing Suite read below. Also, made the test state a globally accessible/modifiable variable. ## Validation Steps Performed Added tests that cover... - button clicks - button clicks with modifiers - mouse movement - mouse movement and entering/exiting a state where multiple buttons were pressed
claunia added the pull-request label 2026-01-31 09:10:26 +00:00
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 pull-request
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#25585
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?