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

Refactor VT DEC/ANSI mode handling to avoid code duplication when we light up SM/RM #11651

New Issue
Closed
opened 2026-01-31 02:53:40 +00:00 by claunia · 2 comments
claunia commented 2026-01-31 02:53:40 +00:00
Owner
Copy Link

Originally created by @DHowett on GitHub (Dec 2, 2020).

Originally assigned to: @DHowett on GitHub.

I was about to add SetAnsiMode/ResetAnsiMode for SM and RM when I
realized that we probably don't need yet another enum of mode types, set and
reset functions, and a mode helper for ANSI standard modes when we already have
one for DEC Private modes.

I'm proposing:

  1. We change the enum PrivateModeParams to just be ModeParams
  2. We differentiate ANSI Standard modes (IRM, KAM, SRM, ...) from DEC Private modes
    (DECCOLM, DECCKM, ...) using a flag bit set in the enum value[1].
  3. We introduce a helper class for constructing these values much like @j4james'
    VTID.
    • (I've already prototyped a FlaggedEnumValue template helper[2])
  4. We dispatch all mode set/reset through a common Set/Reset and _ModeHelper
    that uses the existing enum values.

[1] These modes are in separate namespaces with some overlap. We should
differentiate them at dispatch time to ensure that \e[2h and \e[?2h are
given different treatment, and ensure that \e[1000h doesn't activate xterm
mouse mode.

[2]

template <typename T, template Mask>
class FlaggedEnumValue { ... };

using ANSIStandardMode = FlaggedEnumValue<size_t, 0x00000000>;
using DECPrivateMode = FlaggedEnumValue<size_t, 0x01000000>;

// ...

enum Modes : size_t {
	IRM_InsertReplaceMode = ANSIStandardMode(2),
	DECCKM_CursorKeys     = DECPrivateMode(1),
	// ...
};
Originally created by @DHowett on GitHub (Dec 2, 2020). Originally assigned to: @DHowett on GitHub. I was about to add `SetAnsiMode`/`ResetAnsiMode` for `SM` and `RM` when I realized that we probably don't need yet another enum of mode types, set and reset functions, and a mode helper for ANSI standard modes when we already have one for DEC Private modes. I'm proposing: 1. We change the enum `PrivateModeParams` to just be `ModeParams` 2. We differentiate ANSI Standard modes (IRM, KAM, SRM, ...) from DEC Private modes (DECCOLM, DECCKM, ...) using a flag bit set in the enum value[1]. 3. We introduce a helper class for constructing these values much like @j4james' `VTID`. * (I've already prototyped a `FlaggedEnumValue` template helper[2]) 4. We dispatch all mode set/reset through a common Set/Reset and `_ModeHelper` that uses the existing enum values. [1] These modes are in separate namespaces with some overlap. We should differentiate them at dispatch time to ensure that `\e[2h` and `\e[?2h` are given different treatment, and ensure that `\e[1000h` doesn't activate xterm mouse mode. [2] ```c++ template <typename T, template Mask> class FlaggedEnumValue { ... }; using ANSIStandardMode = FlaggedEnumValue<size_t, 0x00000000>; using DECPrivateMode = FlaggedEnumValue<size_t, 0x01000000>; // ... enum Modes : size_t { IRM_InsertReplaceMode = ANSIStandardMode(2), DECCKM_CursorKeys = DECPrivateMode(1), // ... }; ```
claunia added the Product-ConhostResolution-Fix-CommittedIssue-TaskArea-VT labels 2026-01-31 02:53:40 +00:00
claunia commented 2026-01-31 02:53:41 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Dec 2, 2020):

(I am particularly pleased with how well FlaggedEnumValue lends itself to using definitions that make it clear/easy on the enum authoring side what's happening. The decision to do constant conversion from a custom class type was based on James' VTID, which I love.)

@DHowett commented on GitHub (Dec 2, 2020): (I am particularly pleased with how well `FlaggedEnumValue` lends itself to `using` definitions that make it clear/easy on the enum authoring side what's happening. The decision to do constant conversion from a custom class type was based on James' `VTID`, which I _love_.)
claunia commented 2026-01-31 02:53:41 +00:00
Author
Owner
Copy Link

@j4james commented on GitHub (Dec 2, 2020):

I like this. I had the same idea about merging the two modes, but I just couldn't think of a good way to handle the two enum sets. This looks like it should work out nicely though.

@j4james commented on GitHub (Dec 2, 2020): I like this. I had the same idea about merging the two modes, but I just couldn't think of a good way to handle the two enum sets. This looks like it should work out nicely though.
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 Area-VT Issue-Task Product-Conhost Resolution-Fix-Committed
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#11651
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?