Add support for OSC 104, 110, 111, 112 and 117 (resets) by DHowett · Pull Request #18767 · microsoft/terminal

DHowett · 2025-04-07T22:29:33Z

This pull request adds support for resetting the various color table entries and xterm resource values back to their defaults.

Building on the default color table James introduced in #17879, it was relatively straightforward to add support for resetting specific entries.

This implementation cleaves tightly to observed behavior in xterm(379) rather than observed behavior in libvte(0.70.6). They differ in the following ways:

xterm rejects any OSC [110..119] with any number of parameters; libvte accepts it but only resets the first color.
When passed a list of color indices to reset in 104, xterm resets any colors up until the first one which fails to parse as an integer and does not reset the rest; libvte resets all parseable color indices.

I was unable to verify how these reset commands interact with colors set via DECAC Assign Color so I went with the implementation that made the most sense:

Resetting the background color with 110 also restores the background color alias entry to its pre-DECAC value; this results in the perceived background color returning to e.g. index 0 in conhost and the background color in Terminal.
ibid. for the foreground color

Refs #18695
Refs #17879
Closes #3719

Refs #18695 Closes #3719

this makes resetting the background color the opposite of setting it: setting it changes the alias to DEFAULT_BACKGROUND, and resetting it changes it back to INDEX=0 (conhost). As a side effect, the value of DEFAULT_BACKGROUND is also destroyed. One could test this in xterm by using DECAC to set the background to their internal background color index and observing whether it, too, was preserved.

…lors

…table)

src/terminal/parser/OutputStateMachineEngine.cpp

j4james · 2025-04-08T15:58:28Z

src/renderer/base/RenderSettings.cpp

+// Routine Description:
+// - Returns one color table entry to the value saved in SaveDefaultSettings.
+void RenderSettings::RestoreDefaultColorTableEntries(const size_t startIndex, const size_t count)


This comment doesn't seem right.

Sure isn't! Last minute change to take {start, length} rather than just an index :) (thanks!)

src/renderer/base/RenderSettings.cpp

src/terminal/parser/ut_parser/OutputEngineTest.cpp

j4james

Other than the comment nits it looks good to me. I've done some manual testing of the branch and couldn't find any issues. I think matching the Xterm behavior on the edge cases is the right call.

ETA: Also agree with resetting the DECAC values.

DHowett · 2025-04-08T16:12:20Z

Thanks for the review, and for the testing! I appreciate it. :)

src/terminal/parser/OutputStateMachineEngine.cpp

lhecker

One nit.

lhecker · 2025-04-09T23:21:54Z

src/renderer/base/RenderSettings.cpp

+// - Restores a range of color table entries to the values saved in SaveDefaultSettings.
+void RenderSettings::RestoreDefaultColorTableEntries(const size_t startIndex, const size_t count)
+{
+    std::copy_n(&_defaultColorTable.at(startIndex), count, &_colorTable.at(startIndex));


This seems like it could use some bounds checks. Perhaps just a std::min together with a soft assert though? Not sure... Alternative we could make it two explicit reset-256-indexed and reset-specific-index functions.

So, yeah. I feel weird about this function.

Everywhere else in this file we use .at() and allow the SafeExecute handler to catch the exception. No bounds checks, no worries.

I was so averse to adding members to ITermDispatch that I forgot I could add members to RenderSettings with no real cost.

src/terminal/parser/OutputStateMachineEngine.cpp

This pull request adds support for resetting the various color table entries and xterm resource values back to their defaults. Building on the default color table James introduced in #17879, it was relatively straightforward to add support for resetting specific entries. This implementation cleaves tightly to observed behavior in xterm(379) rather than observed behavior in libvte(0.70.6). They differ in the following ways: - xterm rejects any OSC [110..119] with any number of parameters; libvte accepts it but only resets the first color. - When passed a list of color indices to reset in 104, xterm resets any colors up until the first one which fails to parse as an integer and does _not_ reset the rest; libvte resets all parseable color indices. I was unable to verify how these reset commands interact with colors set via `DECAC Assign Color` so I went with the implementation that made the most sense: - Resetting the background color with `110` also restores the background color alias entry to its pre-`DECAC` value; this results in the perceived background color returning to e.g. index 0 in conhost and the `background` color in Terminal. - _ibid._ for the foreground color Refs #18695 Refs #17879 Closes #3719 (cherry picked from commit 5f31150) Service-Card-Id: PVTI_lADOAF3p4s4AmhmQzgZOWsU Service-Version: 1.22

This pull request adds support for resetting the various color table entries and xterm resource values back to their defaults. Building on the default color table James introduced in #17879, it was relatively straightforward to add support for resetting specific entries. This implementation cleaves tightly to observed behavior in xterm(379) rather than observed behavior in libvte(0.70.6). They differ in the following ways: - xterm rejects any OSC [110..119] with any number of parameters; libvte accepts it but only resets the first color. - When passed a list of color indices to reset in 104, xterm resets any colors up until the first one which fails to parse as an integer and does _not_ reset the rest; libvte resets all parseable color indices. I was unable to verify how these reset commands interact with colors set via `DECAC Assign Color` so I went with the implementation that made the most sense: - Resetting the background color with `110` also restores the background color alias entry to its pre-`DECAC` value; this results in the perceived background color returning to e.g. index 0 in conhost and the `background` color in Terminal. - _ibid._ for the foreground color Refs #18695 Refs #17879 Closes #3719 (cherry picked from commit 5f31150) Service-Card-Id: PVTI_lADOAF3p4s4AxadtzgZOWsQ Service-Version: 1.23

DHowett and others added 8 commits March 27, 2025 15:28

WIP: Add support for resetting colors

0f23bc1

Refs #18695 Closes #3719

Add support for 104/reset color

a20aefd

Merge remote-tracking branch 'origin/main' into dev/duhowett/reset-co…

c8cbf43

…lors

Add support for resetting the entire color table (and only the color …

48f9400

…table)

meh, spellbot didn't like it

8ee702a

comment a bit better

9c53f79

add another test

f6a15c0

DHowett requested review from j4james and lhecker April 7, 2025 22:29

github-advanced-security bot found potential problems Apr 7, 2025

View reviewed changes

src/terminal/parser/OutputStateMachineEngine.cpp Fixed Show fixed Hide fixed

src/terminal/parser/OutputStateMachineEngine.cpp Fixed Show fixed Hide fixed

microsoft-github-policy-service bot added Issue-Task It's a feature request, but it doesn't really need a major design. Area-VT Virtual Terminal sequence support Product-Conhost For issues in the Console codebase labels Apr 7, 2025

This comment has been minimized.

Sign in to view

spellbot doesn't like vte either

5ecd223

j4james reviewed Apr 8, 2025

View reviewed changes

DHowett commented Apr 8, 2025

View reviewed changes

src/renderer/base/RenderSettings.cpp Outdated Show resolved Hide resolved

j4james reviewed Apr 8, 2025

View reviewed changes

src/terminal/parser/ut_parser/OutputEngineTest.cpp Outdated Show resolved Hide resolved

j4james approved these changes Apr 8, 2025

View reviewed changes

Apply suggestions from code review

60dab07

DHowett commented Apr 8, 2025

View reviewed changes

src/terminal/parser/OutputStateMachineEngine.cpp Show resolved Hide resolved

lhecker approved these changes Apr 9, 2025

View reviewed changes

Yeah, doing it by range was weird anyway

eb88d53

lhecker approved these changes Apr 9, 2025

View reviewed changes

DHowett enabled auto-merge (squash) April 9, 2025 23:54

DHowett added this to 1.22 Servicing Pipeline Apr 9, 2025

github-project-automation bot moved this to To Cherry Pick in 1.22 Servicing Pipeline Apr 9, 2025

DHowett added this to 1.23 Servicing Pipeline Apr 9, 2025

github-project-automation bot moved this to To Cherry Pick in 1.23 Servicing Pipeline Apr 9, 2025

DHowett moved this from To Cherry Pick to To Consider in 1.23 Servicing Pipeline Apr 9, 2025

DHowett moved this from To Cherry Pick to To Consider in 1.22 Servicing Pipeline Apr 9, 2025

DHowett merged commit 5f31150 into main Apr 10, 2025
17 of 19 checks passed

DHowett deleted the dev/duhowett/reset-colors branch April 10, 2025 00:11

DHowett moved this from To Consider to To Cherry Pick in 1.22 Servicing Pipeline Apr 21, 2025

DHowett moved this from To Consider to To Cherry Pick in 1.23 Servicing Pipeline Apr 21, 2025

DHowett moved this from To Cherry Pick to Cherry Picked in 1.22 Servicing Pipeline Apr 21, 2025

DHowett moved this from To Cherry Pick to Cherry Picked in 1.23 Servicing Pipeline Apr 21, 2025

DHowett moved this from Cherry Picked to Shipped in 1.23 Servicing Pipeline Sep 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for OSC 104, 110, 111, 112 and 117 (resets)#18767

Add support for OSC 104, 110, 111, 112 and 117 (resets)#18767
DHowett merged 11 commits intomainfrom
dev/duhowett/reset-colors

DHowett commented Apr 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

j4james Apr 8, 2025

Uh oh!

DHowett Apr 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

j4james left a comment •

edited

Loading

Uh oh!

DHowett commented Apr 8, 2025

Uh oh!

Uh oh!

lhecker left a comment

Uh oh!

lhecker Apr 9, 2025

Uh oh!

DHowett Apr 9, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

DHowett commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

j4james Apr 8, 2025

Choose a reason for hiding this comment

Uh oh!

DHowett Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

j4james left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DHowett commented Apr 8, 2025

Uh oh!

Uh oh!

lhecker left a comment

Choose a reason for hiding this comment

Uh oh!

lhecker Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

DHowett Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

DHowett commented Apr 7, 2025 •

edited

Loading

DHowett Apr 8, 2025 •

edited

Loading

j4james left a comment •

edited

Loading