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 #3968] [MERGED] Add support for the DECALN escape sequence #25582

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

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/3968
Author: @j4james
Created: 12/14/2019
Status: ✅ Merged
Merged: 12/17/2019
Merged by: @undefined

Base: master ← Head: feature-decaln

📝 Commits (2)

  • eda9d08 Add support for the DECALN escape sequence.
  • cc8d0cc Add a screen buffer test to verify the DECALN behaviour.

📊 Changes

9 files changed (+118 additions, -1 deletions)

View changed files

📝 src/host/ut_host/ScreenBufferTests.cpp (+61 -0)
📝 src/terminal/adapter/ITermDispatch.hpp (+1 -0)
📝 src/terminal/adapter/adaptDispatch.cpp (+36 -0)
📝 src/terminal/adapter/adaptDispatch.hpp (+1 -0)
📝 src/terminal/adapter/termDispatch.hpp (+1 -0)
📝 src/terminal/parser/OutputStateMachineEngine.cpp (+14 -0)
📝 src/terminal/parser/OutputStateMachineEngine.hpp (+2 -1)
📝 src/terminal/parser/telemetry.cpp (+1 -0)
📝 src/terminal/parser/telemetry.hpp (+1 -0)

📄 Description

Summary of the Pull Request

This adds support for the DECALN escape sequence, which produces a kind of test pattern, originally used on VT terminals to adjust the screen alignment. It's needed to pass several of the tests in the Vttest suite.

PR Checklist

  • Closes How to run an executable in Terminal from a batch file (#3671)
  • CLA signed. If not, go over here and sign the CLA
  • Tests added/passed
  • Requires documentation to be updated
  • I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

Detailed Description of the Pull Request / Additional comments

To start with, the ActionEscDispatch method in the OutputStateMachineEngine needed to be extended to check for a new intermediate type (#). Then when that intermediate is followed by an 8, it dispatches to a new ScreenAlignmentPattern method in the ITermDispatch interface.

The implementation of the ScreenAlignmentPattern itself is fairly simple. It uses the recently added PrivateFillRegion API to fill the screen with the character E using default attributes. Then in addition to that, a bunch of VT properties are reset:

  • The meta/extended attributes are reset (although the active colors must be left unchanged).
  • The origin mode is set to absolute positioning.
  • The scrolling margins are cleared.
  • The cursor position is moved to home.

Validation Steps Performed

I've added a screen buffer test that makes sure the DECALN sequence fills the screen with the correct character and attributes, and that the above mentioned properties are all updated appropriately.

I've also tested in Vttest, and confirmed that the first two pages of the Test of cursor movements are now showing the frame of E's that are expected there.

🔄 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/3968 **Author:** [@j4james](https://github.com/j4james) **Created:** 12/14/2019 **Status:** ✅ Merged **Merged:** 12/17/2019 **Merged by:** [@undefined](undefined) **Base:** `master` ← **Head:** `feature-decaln` --- ### 📝 Commits (2) - [`eda9d08`](https://github.com/microsoft/terminal/commit/eda9d08832bca1474aec789f95612fc75315bd81) Add support for the DECALN escape sequence. - [`cc8d0cc`](https://github.com/microsoft/terminal/commit/cc8d0ccc8cd46941efd8faea2b5a0608554f0caf) Add a screen buffer test to verify the DECALN behaviour. ### 📊 Changes **9 files changed** (+118 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `src/host/ut_host/ScreenBufferTests.cpp` (+61 -0) 📝 `src/terminal/adapter/ITermDispatch.hpp` (+1 -0) 📝 `src/terminal/adapter/adaptDispatch.cpp` (+36 -0) 📝 `src/terminal/adapter/adaptDispatch.hpp` (+1 -0) 📝 `src/terminal/adapter/termDispatch.hpp` (+1 -0) 📝 `src/terminal/parser/OutputStateMachineEngine.cpp` (+14 -0) 📝 `src/terminal/parser/OutputStateMachineEngine.hpp` (+2 -1) 📝 `src/terminal/parser/telemetry.cpp` (+1 -0) 📝 `src/terminal/parser/telemetry.hpp` (+1 -0) </details> ### 📄 Description ## Summary of the Pull Request This adds support for the [`DECALN`](https://vt100.net/docs/vt510-rm/DECALN.html) escape sequence, which produces a kind of test pattern, originally used on VT terminals to adjust the screen alignment. It's needed to pass several of the tests in the [Vttest](https://invisible-island.net/vttest/) suite. ## PR Checklist * [x] Closes #3671 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] Tests added/passed * [ ] Requires documentation to be updated * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx ## Detailed Description of the Pull Request / Additional comments To start with, the `ActionEscDispatch` method in the `OutputStateMachineEngine` needed to be extended to check for a new intermediate type (`#`). Then when that intermediate is followed by an `8`, it dispatches to a new `ScreenAlignmentPattern` method in the `ITermDispatch` interface. The implementation of the `ScreenAlignmentPattern` itself is fairly simple. It uses the recently added `PrivateFillRegion` API to fill the screen with the character `E` using default attributes. Then in addition to that, a bunch of VT properties are reset: * The meta/extended attributes are reset (although the active colors must be left unchanged). * The origin mode is set to absolute positioning. * The scrolling margins are cleared. * The cursor position is moved to home. ## Validation Steps Performed I've added a screen buffer test that makes sure the `DECALN` sequence fills the screen with the correct character and attributes, and that the above mentioned properties are all updated appropriately. I've also tested in Vttest, and confirmed that the first two pages of the _Test of cursor movements_ are now showing the frame of E's that are expected there. --- <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:10:25 +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#25582
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?