fa7c1abdf8
This PR introduces a new `ColorType` to allow us to distinguish between `SGR` indexed colors from the 16 color table, the lower half of which can be brightened, and the ISO/ITU indexed colors from the 256 color table, which have a fixed brightness. Retaining the distinction between these two types will enable us to forward the correct `SGR` sequences to conpty when addressing issue #2661. The other benefit of retaining the color index (which we didn't previously do for ISO/ITU colors) is that it ensures that the colors are updated correctly when the color scheme is changed. ## References * This is another step towards fixing the conpty narrowing bugs in issue #2661. * This is technically a fix for issue #5384, but that won't be apparent until #2661 is complete. ## PR Checklist * [x] Closes #1223 * [x] CLA signed. * [x] Tests added/passed * [ ] Requires documentation to be updated * [x] I've discussed this with core contributors already. ## Detailed Description of the Pull Request / Additional comments The first part of this PR was the introduction of a new `ColorType` in the `TextColor` class. Instead of just the one `IsIndex` type, there is now an `IsIndex16` and an `IsIndex256`. `IsIndex16` covers the eight original ANSI colors set with `SGR 3x` and `SGR 4x`, as well as the brighter aixterm variants set with `SGR 9x` and `SGR 10x`. `IsIndex256` covers the 256 ISO/ITU indexed colors set with `SGR 38;5` and `SGR 48;5`. There are two reasons for this distinction. The first is that the ANSI colors have the potential to be brightened by the `SGR 1` bold attribute, while the ISO/ITO color do not. The second reason is that when forwarding an attributes through conpty, we want to try and preserve the original SGR sequence that generated each color (to the extent that that is possible). By having the two separate types, we can map the `IsIndex16` colors back to ANSI/aixterm values, and `IsIndex256` to the ISO/ITU sequences. In addition to the VT colors, we also have to deal with the legacy colors set by the Windows console APIs, but we don't really need a separate type for those. It seemed most appropriate to me to store them as `IsIndex256` colors, since it doesn't make sense to have them brightened by the `SGR 1` attribute (which is what would happen if they were stored as `IsIndex16`). If a console app wanted a bright color it would have selected one, so we shouldn't be messing with that choice. The second part of the PR was the unification of the two color tables. Originally we had a 16 color table for the legacy colors, and a separate table for the 256 ISO/ITU colors. These have now been merged into one, so color table lookups no longer need to decide which of the two tables they should be referencing. I've also updated all the methods that took a color table as a parameter to use a `basic_string_view` instead of separate pointer and length variables, which I think makes them a lot easier and safer to work with. With this new architecture in place, I could now update the `AdaptDispatch` SGR implementation to store the ISO/ITU indexed colors as `IsIndex256` values, where before they were mapped to RGB values (which prevented them reflecting any color scheme changes). I could also update the `TerminalDispatch` implementation to differentiate between the two index types, so that the `SGR 1` brightening would only be applied to the ANSI colors. I've also done a bit of code refactoring to try and minimise any direct access to the color tables, getting rid of a lot of places that were copying tables with `memmove` operations. I'm hoping this will make it easier for us to update the code in the future if we want to reorder the table entries (which is likely a requirement for unifying the `AdaptDispatch` and `TerminalDispatch` implementations). ## Validation Steps Performed For testing, I've just updated the existing unit tests to account for the API changes. The `TextColorTests` required an extra parameter specifying the index type when setting an index. And the `AdapterTest` and `ScreenBufferTests` required the use of the new `SetIndexedXXX` methods in order to be explicit about the index type, instead of relying on the `TextAttribute` constructor and the old `SetForeground` and `SetBackground` methods which didn't have a way to differentiate index types. I've manually tested the various console APIs (`SetConsoleTextAttribute`, `ReadConsoleOutputAttribute`, and `ReadConsoleOutput`), to make sure they are still setting and reading the attributes as well as they used to. And I've tested the `SetConsoleScreenBufferInfoEx` and `GetConsoleScreenBufferInfoEx` APIs to make sure they can read and write the color table correctly. I've also tested the color table in the properties dialog, made sure it was saved and restored from the registry correctly, and similarly saved and restored from a shortcut link. Note that there are still a bunch of issues with the color table APIs, but no new problems have been introduced by the changes in this PR, as far as I could tell. I've also done a bunch of manual tests of `OSC 4` to make sure it's updating all the colors correctly (at least in conhost), and confirmed that the test case in issue #1223 now works as expected.
62 lines
2.5 KiB
C++
62 lines
2.5 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
--*/
|
|
#pragma once
|
|
|
|
#define FG_ATTRS (FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY)
|
|
#define BG_ATTRS (BACKGROUND_BLUE | BACKGROUND_GREEN | BACKGROUND_RED | BACKGROUND_INTENSITY)
|
|
#define META_ATTRS (COMMON_LVB_LEADING_BYTE | COMMON_LVB_TRAILING_BYTE | COMMON_LVB_GRID_HORIZONTAL | COMMON_LVB_GRID_LVERTICAL | COMMON_LVB_GRID_RVERTICAL | COMMON_LVB_REVERSE_VIDEO | COMMON_LVB_UNDERSCORE)
|
|
|
|
enum class ExtendedAttributes : BYTE
|
|
{
|
|
Normal = 0x00,
|
|
Bold = 0x01,
|
|
Italics = 0x02,
|
|
Blinking = 0x04,
|
|
Invisible = 0x08,
|
|
CrossedOut = 0x10,
|
|
// TODO:GH#2916 add support for these to the parser as well.
|
|
Underlined = 0x20, // _technically_ different from LVB_UNDERSCORE, see TODO:GH#2915
|
|
DoublyUnderlined = 0x40, // Included for completeness, but not currently supported.
|
|
Faint = 0x80, // Included for completeness, but not currently supported.
|
|
};
|
|
DEFINE_ENUM_FLAG_OPERATORS(ExtendedAttributes);
|
|
|
|
WORD FindNearestTableIndex(const COLORREF Color,
|
|
const std::basic_string_view<COLORREF> ColorTable);
|
|
|
|
bool FindTableIndex(const COLORREF Color,
|
|
const std::basic_string_view<COLORREF> ColorTable,
|
|
_Out_ WORD* const pFoundIndex);
|
|
|
|
WORD XtermToWindowsIndex(const size_t index) noexcept;
|
|
WORD Xterm256ToWindowsIndex(const size_t index) noexcept;
|
|
WORD XtermToLegacy(const size_t xtermForeground, const size_t xtermBackground);
|
|
|
|
const WORD WINDOWS_RED_ATTR = FOREGROUND_RED;
|
|
const WORD WINDOWS_GREEN_ATTR = FOREGROUND_GREEN;
|
|
const WORD WINDOWS_BLUE_ATTR = FOREGROUND_BLUE;
|
|
const WORD WINDOWS_BRIGHT_ATTR = FOREGROUND_INTENSITY;
|
|
|
|
const WORD XTERM_RED_ATTR = 0x01;
|
|
const WORD XTERM_GREEN_ATTR = 0x02;
|
|
const WORD XTERM_BLUE_ATTR = 0x04;
|
|
const WORD XTERM_BRIGHT_ATTR = 0x08;
|
|
|
|
enum class CursorType : unsigned int
|
|
{
|
|
Legacy = 0x0, // uses the cursor's height value to range from underscore-like to full box
|
|
VerticalBar = 0x1, // A single vertical line, '|'
|
|
Underscore = 0x2, // a single horizontal underscore, smaller that the min height legacy cursor.
|
|
EmptyBox = 0x3, // Just the outline of a full box
|
|
FullBox = 0x4 // a full box, similar to legacy with height=100%
|
|
};
|
|
|
|
// Valid COLORREFs are of the pattern 0x00bbggrr. -1 works as an invalid color,
|
|
// as the highest byte of a valid color is always 0.
|
|
constexpr COLORREF INVALID_COLOR = 0xffffffff;
|
|
|
|
constexpr WORD COLOR_TABLE_SIZE = 16;
|
|
constexpr WORD XTERM_COLOR_TABLE_SIZE = 256;
|