starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Add support for the "concealed" graphic rendition attribute #9567

New Issue
Closed
opened 2026-01-31 01:57:59 +00:00 by claunia · 6 comments
claunia commented 2026-01-31 01:57:59 +00:00
Owner
Copy Link

Originally created by @j4james on GitHub (Jul 11, 2020).

Description of the new feature/enhancement

The ANSI SGR 8 rendition attribute is used to indicate that text to which it's applied should be rendered invisible. I'm not sure how widely it's used, but it is supported by most terminal emulators, so I think it's probably worth doing. And most of the framework is already in place, so it's an easy addition for us.

Proposed technical implementation details (optional)

I think all that's required is an update to the TextAttribute::CalculateRgbColors method, adjusting the colors to make the foreground and background the same when the attribute is set. Something like:

if (IsInvisible())
{
    fg = bg;
}

In testing this on other terminals, I found that XTerm also prevented the invisible content being copied to the clipboard. However, pretty much everyone else allowed it to be copied, so I'm more inclined to follow the majority behaviour.

I have a PR ready to submit for this if you're happy with the idea and the proposed approach, but it'd be best if #6873 is merged first, otherwise there'll probably be conflicts in the unit tests.

Originally created by @j4james on GitHub (Jul 11, 2020). # Description of the new feature/enhancement The ANSI `SGR 8` rendition attribute is used to indicate that text to which it's applied should be rendered invisible. I'm not sure how widely it's used, but it is supported by most terminal emulators, so I think it's probably worth doing. And most of the framework is already in place, so it's an easy addition for us. # Proposed technical implementation details (optional) I think all that's required is an update to the `TextAttribute::CalculateRgbColors` method, adjusting the colors to make the foreground and background the same when the attribute is set. Something like: if (IsInvisible()) { fg = bg; } In testing this on other terminals, I found that XTerm also prevented the invisible content being copied to the clipboard. However, pretty much everyone else allowed it to be copied, so I'm more inclined to follow the majority behaviour. I have a PR ready to submit for this if you're happy with the idea and the proposed approach, but it'd be best if #6873 is merged first, otherwise there'll probably be conflicts in the unit tests.
claunia commented 2026-01-31 01:58:00 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Jul 11, 2020):

Philosophically, if it's not copyable and not rendered in xterm, is there any meaningful difference between it being concealed and it simply not existing?

For us, matching the colors and leaving it copyable sounds great. I'm r+ on this proposal!

@DHowett commented on GitHub (Jul 11, 2020): Philosophically, if it's not copyable and not rendered in xterm, is there any meaningful difference between it being concealed and it simply not existing? For us, matching the colors and leaving it copyable sounds great. I'm r+ on this proposal!
claunia commented 2026-01-31 01:58:00 +00:00
Author
Owner
Copy Link

@j4james commented on GitHub (Jul 11, 2020):

Philosophically, if it's not copyable and not rendered in xterm, is there any meaningful difference between it being concealed and it simply not existing?

That depends on the implementation. If they're still writing the text to the buffer, then it could potentially be revealed through other means, e.g. by changing the attributes with DECARA, or reading the content back via DECRQCRA. I couldn't get DECARA to work, but I'm not sure if that's just a bug. And I didn't try DECRQCRA, but I suspect it wouldn't work either - my guess is they're not actually storing anything.

Anyway I don't think it matters much. This is one of those things that doesn't have a clear right answer, because the ANSI/ECMA specs don't go into any detail, and the DEC terminals never had this functionality. I figure as long as we're doing what most others are doing then we're probably OK.

@j4james commented on GitHub (Jul 11, 2020): > Philosophically, if it's not copyable and not rendered in xterm, is there any meaningful difference between it being concealed and it simply not existing? That depends on the implementation. If they're still writing the text to the buffer, then it could potentially be revealed through other means, e.g. by changing the attributes with `DECARA`, or reading the content back via `DECRQCRA`. I couldn't get `DECARA` to work, but I'm not sure if that's just a bug. And I didn't try `DECRQCRA`, but I suspect it wouldn't work either - my guess is they're not actually storing anything. Anyway I don't think it matters much. This is one of those things that doesn't have a clear right answer, because the ANSI/ECMA specs don't go into any detail, and the DEC terminals never had this functionality. I figure as long as we're doing what most others are doing then we're probably OK.
claunia commented 2026-01-31 01:58:00 +00:00
Author
Owner
Copy Link

@jdebp commented on GitHub (Jul 13, 2020):

DECCARA is documented as only affecting specific attributes, of which this is not one. But the DEC doco does state that invisibility is rendered by making the foreground colour the same as the background colour.

Observe, furthermore, that kitty extends DECCARA to cover this attribute.

@jdebp commented on GitHub (Jul 13, 2020): `DECCARA` is documented as only affecting specific attributes, of which this is not one. But the DEC doco does state that invisibility is rendered by making the foreground colour the same as the background colour. Observe, furthermore, that kitty extends `DECCARA` to cover this attribute.
claunia commented 2026-01-31 01:58:01 +00:00
Author
Owner
Copy Link

@j4james commented on GitHub (Jul 13, 2020):

But the DEC doco does state that invisibility is rendered by making the foreground colour the same as the background colour.

That's good to know - thanks for pointing that out. I was under the impression that none of the DEC terminals supported the concealed/invisible attribute, possibly because it's not listed in the functions summary table of the VT520 Programmer Reference. But I see now that even the VT420 supported it.

DECCARA is documented as only affecting specific attributes, of which this is not one.

Yeah I saw that, but I thought (incorrectly) that that was just because they didn't support the concealed attribute in general. I suppose it's still possible that was an oversight in the docs.

Observe, furthermore, that kitty extends DECCARA to cover this attribute.

I thought XTerm did that too (see here), but as I mentioned above I couldn't get it to work. I don't think I tested DECCARA on kitty. Not that it matters much at the moment. We can figure out those details when we actually implement those ops.

@j4james commented on GitHub (Jul 13, 2020): > But the DEC doco does state that invisibility is rendered by making the foreground colour the same as the background colour. That's good to know - thanks for pointing that out. I was under the impression that none of the DEC terminals supported the concealed/invisible attribute, possibly because it's not listed in the functions summary table of the VT520 Programmer Reference. But I see now that even the VT420 supported it. > `DECCARA` is documented as only affecting specific attributes, of which this is not one. Yeah I saw that, but I thought (incorrectly) that that was just because they didn't support the concealed attribute in general. I suppose it's still possible that was an oversight in the docs. > Observe, furthermore, that kitty extends `DECCARA` to cover this attribute. I thought XTerm did that too (see [here](https://github.com/ThomasDickey/xterm-snapshots/blob/153d0ccc03242cd2844255a7e03e8683a17132f3/screen.c#L2722-L2724)), but as I mentioned above I couldn't get it to work. I don't think I tested `DECCARA` on kitty. Not that it matters much at the moment. We can figure out those details when we actually implement those ops.
claunia commented 2026-01-31 01:58:01 +00:00
Author
Owner
Copy Link

@ghost commented on GitHub (Jul 22, 2020):

:tada:This issue was addressed in #6907, which has now been successfully released as Windows Terminal Preview v1.2.2022.0.🎉

Handy links:

@ghost commented on GitHub (Jul 22, 2020): :tada:This issue was addressed in #6907, which has now been successfully released as `Windows Terminal Preview v1.2.2022.0`.:tada: Handy links: * [Release Notes](https://github.com/microsoft/terminal/releases/tag/v1.2.2022.0) * [Store Download](https://www.microsoft.com/store/apps/9n8g5rfz9xk3?cid=storebadge&ocid=badge)
claunia commented 2026-01-31 01:58:01 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Aug 21, 2020):

🎉 As of Windows Insider build 20197, this is also supported in the traditional console.

@DHowett commented on GitHub (Aug 21, 2020): 🎉 As of Windows Insider build 20197, this is also supported in the traditional console.
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 Priority-2 Product-Conhost Product-Terminal 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#9567
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?