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

[PR #2872] [MERGED] Improve debugging experience of key events... #25128

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

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/2872
Author: @miniksa
Created: 9/24/2019
Status: ✅ Merged
Merged: 9/24/2019
Merged by: @DHowett-MSFT

Base: master ← Head: dev/miniksa/input

📝 Commits (1)

  • 7d219e2 Improve debugging experience of key events by adding natvis rules for display and by typifying the flags field so the debugger presents it as flags naturally.

📊 Changes

4 files changed (+46 additions, -15 deletions)

View changed files

📝 src/types/IInputEventStreams.cpp (+1 -1)
📝 src/types/KeyEvent.cpp (+9 -5)
📝 src/types/inc/IInputEvent.hpp (+31 -9)
📝 tools/ConsoleTypes.natvis (+5 -0)

📄 Description

...by adding natvis rules for display and by typifying the flags field so the debugger presents it as flags naturally.

Summary of the Pull Request

I was investigating #2770 and needed to visualize some of the input records more easily.

PR Checklist

  • Closes nothing. It's a standalone debugging aid.
  • I work here.
  • No tests.
  • No documentation.
  • I'm a core contributor.

Detailed Description of the Pull Request / Additional comments

I added a natvis rule that helps present the contents of a KEY_EVENT in a condensed way that is easier to navigate in the debugger than expanding all of the fields from the structure.

I also changed the definition of the flags field inside the KEY_EVENT to be an enum class because the debugger will auto-visualize these. To reduce the scope of the change, I made it static_cast things in and out of the enum class type (since they're both just DWORD defined with the same thing anyway) and changed all complaining reads/writes to round through the existing constexpr methods.

Validation Steps Performed

Rebuilt it and looked at it under the debugger. Looks way better than before.

Everything else still runs.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/2872 **Author:** [@miniksa](https://github.com/miniksa) **Created:** 9/24/2019 **Status:** ✅ Merged **Merged:** 9/24/2019 **Merged by:** [@DHowett-MSFT](https://github.com/DHowett-MSFT) **Base:** `master` ← **Head:** `dev/miniksa/input` --- ### 📝 Commits (1) - [`7d219e2`](https://github.com/microsoft/terminal/commit/7d219e2ddb100d3a5c4b4b1b2cef075bb7cc2aa8) Improve debugging experience of key events by adding natvis rules for display and by typifying the flags field so the debugger presents it as flags naturally. ### 📊 Changes **4 files changed** (+46 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `src/types/IInputEventStreams.cpp` (+1 -1) 📝 `src/types/KeyEvent.cpp` (+9 -5) 📝 `src/types/inc/IInputEvent.hpp` (+31 -9) 📝 `tools/ConsoleTypes.natvis` (+5 -0) </details> ### 📄 Description ...by adding natvis rules for display and by typifying the flags field so the debugger presents it as flags naturally. <!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request I was investigating #2770 and needed to visualize some of the input records more easily. <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist * [X] Closes nothing. It's a standalone debugging aid. * [X] I work here. * [X] No tests. * [X] No documentation. * [X] I'm a core contributor. <!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments I added a natvis rule that helps present the contents of a `KEY_EVENT` in a condensed way that is easier to navigate in the debugger than expanding all of the fields from the structure. I also changed the definition of the flags field inside the `KEY_EVENT` to be an enum class because the debugger will auto-visualize these. To reduce the scope of the change, I made it static_cast things in and out of the enum class type (since they're both just DWORD defined with the same thing anyway) and changed all complaining reads/writes to round through the existing constexpr methods. <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed Rebuilt it and looked at it under the debugger. Looks way better than before. Everything else still runs. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:07:28 +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#25128
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?