Add an ENUM setting for disabling rendering "intense" text as bold (#10759)

This adds a new setting `intenseTextStyle`. It's a per-appearance, control setting, defaulting to `"all"`.
* When set to `"all"` or `["bold", "bright"]`, then we'll render text as both **bold** and bright (1.10 behavior)
* When set to `"bold"`, `["bold"]`, we'll render text formatted with `^[[1m` as **bold**, but not bright
* When set to `"bright"`, `["bright"]`, we'll render text formatted with `^[[1m` as bright, but not bold. This is the pre 1.10 behavior
* When set to `"none"`, we won't do anything special for it at all.

* I last did this in #10648. This time it's an enum, so we can add bright in the future. It's got positive wording this time.
* ~We will want to add `"bright"` as a value in the future, to disable the auto intense->bright conversion.~ I just did that now.
* #5682 is related

* [x] Closes #10576
* [x] I seriously don't think we have an issue for "disable intense is bright", but I'm not crazy, people wanted that, right? #2916 (comment) was the closest
* [x] I work here
* [x] Tests added/passed
* [x] MicrosoftDocs/terminal#381

<!-- ![image](https://user-images.githubusercontent.com/18356694/125480327-07f6b711-6bca-4c1b-9a76-75fc978c702d.png) -->
![image](https://user-images.githubusercontent.com/18356694/128929228-504933ee-cf50-43a2-9982-55110ba39191.png)

Yea that works. Printed some bold text, toggled it on, the text was no longer bold. hooray.

```json
"intenseTextStyle": "none",
"intenseTextStyle": "bold",
"intenseTextStyle": "bright",
"intenseTextStyle": "all",
"intenseTextStyle": ["bold", "bright"],
```

all work now. Repro script:
```sh
printf "\e[1m[bold]\e[m[normal]\e[34m[blue]\e[1m[bold blue]\e[m\n"
```

Author: zadjii-msft

doc/cascadia/profiles.schema.json

@@ -154,6 +154,17 @@
           "description": "Sets how the background image aligns to the boundaries of the window when unfocused. Possible values: \"center\", \"left\", \"top\", \"right\", \"bottom\", \"topLeft\", \"topRight\", \"bottomLeft\", \"bottomRight\"",
           "type": "string"
         },
+        "intenseTextStyle": {
+          "default": "all",
+          "description": "Controls how 'intense' text is rendered. Values are \"bold\", \"bright\", \"all\" and \"none\"",
+          "enum": [
+            "none",
+            "bold",
+            "bright",
+            "all"
+          ],
+          "type": "string"
+        },
         "experimental.retroTerminalEffect": {
           "description": "When set to true, enable retro terminal effects when unfocused. This is an experimental feature, and its continued existence is not guaranteed.",
           "type": "boolean"

src/buffer/out/TextAttribute.cpp

@@ -95,16 +95,18 @@ bool TextAttribute::IsLegacy() const noexcept
 // - defaultFgColor: the default foreground color rgb value.
 // - defaultBgColor: the default background color rgb value.
 // - reverseScreenMode: true if the screen mode is reversed.
-// - blinkingIsFaint: true if blinking should be interpreted as faint.
+// - blinkingIsFaint: true if blinking should be interpreted as faint. (defaults to false)
+// - boldIsBright: true if "bold" should be interpreted as bright. (defaults to true)
 // Return Value:
 // - the foreground and background colors that should be displayed.
 std::pair<COLORREF, COLORREF> TextAttribute::CalculateRgbColors(const gsl::span<const COLORREF> colorTable,
                                                                 const COLORREF defaultFgColor,
                                                                 const COLORREF defaultBgColor,
                                                                 const bool reverseScreenMode,
-                                                                const bool blinkingIsFaint) const noexcept
+                                                                const bool blinkingIsFaint,
+                                                                const bool boldIsBright) const noexcept
 {
-    auto fg = _foreground.GetColor(colorTable, defaultFgColor, IsBold());
+    auto fg = _foreground.GetColor(colorTable, defaultFgColor, boldIsBright && IsBold());
     auto bg = _background.GetColor(colorTable, defaultBgColor);
     if (IsFaint() || (IsBlinking() && blinkingIsFaint))
     {

src/buffer/out/TextAttribute.hpp

@@ -68,7 +68,8 @@ class TextAttribute final
                                                      const COLORREF defaultFgColor,
                                                      const COLORREF defaultBgColor,
                                                      const bool reverseScreenMode = false,
-                                                     const bool blinkingIsFaint = false) const noexcept;
+                                                     const bool blinkingIsFaint = false,
+                                                     const bool boldIsBright = true) const noexcept;
 
     bool IsLeadingByte() const noexcept;
     bool IsTrailingByte() const noexcept;

src/buffer/out/ut_textbuffer/TextAttributeTests.cpp

@@ -22,6 +22,7 @@ class TextAttributeTests
     TEST_METHOD(TestTextAttributeColorGetters);
     TEST_METHOD(TestReverseDefaultColors);
     TEST_METHOD(TestRoundtripDefaultColors);
+    TEST_METHOD(TestBoldAsBright);
 
     static const int COLOR_TABLE_SIZE = 16;
     COLORREF _colorTable[COLOR_TABLE_SIZE];
@@ -272,3 +273,56 @@ void TextAttributeTests::TestRoundtripDefaultColors()
     // Reset the legacy default colors to white on black.
     TextAttribute::SetLegacyDefaultAttributes(FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE);
 }
+
+void TextAttributeTests::TestBoldAsBright()
+{
+    const COLORREF darkBlack = til::at(_colorTable, 0);
+    const COLORREF brightBlack = til::at(_colorTable, 8);
+    const COLORREF darkGreen = til::at(_colorTable, 2);
+
+    TextAttribute attr{};
+
+    // verify that calculated foreground/background are the same as the direct
+    //      values when not bold
+    VERIFY_IS_FALSE(attr.IsBold());
+
+    VERIFY_ARE_EQUAL(_defaultFg, attr.GetForeground().GetColor(_colorTable, _defaultFg));
+    VERIFY_ARE_EQUAL(_defaultBg, attr.GetBackground().GetColor(_colorTable, _defaultBg));
+    VERIFY_ARE_EQUAL(std::make_pair(_defaultFg, _defaultBg), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, true));
+    VERIFY_ARE_EQUAL(std::make_pair(_defaultFg, _defaultBg), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, false));
+
+    // with bold set, calculated foreground/background values shouldn't change for the default colors.
+    attr.SetBold(true);
+    VERIFY_IS_TRUE(attr.IsBold());
+    VERIFY_ARE_EQUAL(std::make_pair(_defaultFg, _defaultBg), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, true));
+    VERIFY_ARE_EQUAL(std::make_pair(_defaultFg, _defaultBg), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, false));
+
+    attr.SetIndexedForeground(0);
+    VERIFY_IS_TRUE(attr.IsBold());
+
+    Log::Comment(L"Foreground should be bright black when bold is bright is enabled");
+    VERIFY_ARE_EQUAL(std::make_pair(brightBlack, _defaultBg), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, true));
+
+    Log::Comment(L"Foreground should be dark black when bold is bright is disabled");
+    VERIFY_ARE_EQUAL(std::make_pair(darkBlack, _defaultBg), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, false));
+
+    attr.SetIndexedBackground(2);
+    VERIFY_IS_TRUE(attr.IsBold());
+
+    Log::Comment(L"background should be unaffected by 'bold is bright'");
+    VERIFY_ARE_EQUAL(std::make_pair(brightBlack, darkGreen), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, true));
+    VERIFY_ARE_EQUAL(std::make_pair(darkBlack, darkGreen), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, false));
+
+    attr.SetBold(false);
+    VERIFY_IS_FALSE(attr.IsBold());
+    Log::Comment(L"when not bold, 'bold is bright' changes nothing");
+    VERIFY_ARE_EQUAL(std::make_pair(darkBlack, darkGreen), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, true));
+    VERIFY_ARE_EQUAL(std::make_pair(darkBlack, darkGreen), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, false));
+
+    Log::Comment(L"When set to a bright color, and bold, 'bold is bright' changes nothing");
+    attr.SetBold(true);
+    attr.SetIndexedForeground(8);
+    VERIFY_IS_TRUE(attr.IsBold());
+    VERIFY_ARE_EQUAL(std::make_pair(brightBlack, darkGreen), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, true));
+    VERIFY_ARE_EQUAL(std::make_pair(brightBlack, darkGreen), attr.CalculateRgbColors(_colorTable, _defaultFg, _defaultBg, false, false, false));
+}

src/cascadia/TerminalControl/ControlCore.cpp

@@ -198,6 +198,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
             dxEngine->SetPixelShaderPath(_settings.PixelShaderPath());
             dxEngine->SetForceFullRepaintRendering(_settings.ForceFullRepaintRendering());
             dxEngine->SetSoftwareRendering(_settings.SoftwareRendering());
+            dxEngine->SetIntenseIsBold(_settings.IntenseIsBold());
 
             _updateAntiAliasingMode(dxEngine.get());
 
@@ -526,6 +527,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         _renderEngine->SetForceFullRepaintRendering(_settings.ForceFullRepaintRendering());
         _renderEngine->SetSoftwareRendering(_settings.SoftwareRendering());
+
         _updateAntiAliasingMode(_renderEngine.get());
 
         // Refresh our font with the renderer
@@ -555,6 +557,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
             _renderEngine->SetSelectionBackground(til::color{ newAppearance.SelectionBackground() });
             _renderEngine->SetRetroTerminalEffect(newAppearance.RetroTerminalEffect());
             _renderEngine->SetPixelShaderPath(newAppearance.PixelShaderPath());
+            _renderEngine->SetIntenseIsBold(_settings.IntenseIsBold());
             _renderer->TriggerRedrawAll();
         }
     }

src/cascadia/TerminalControl/IControlAppearance.idl

@@ -11,6 +11,8 @@ namespace Microsoft.Terminal.Control
         Windows.UI.Xaml.Media.Stretch BackgroundImageStretchMode;
         Windows.UI.Xaml.HorizontalAlignment BackgroundImageHorizontalAlignment;
         Windows.UI.Xaml.VerticalAlignment BackgroundImageVerticalAlignment;
+        Boolean IntenseIsBold;
+        // IntenseIsBright is in Core Appearance
 
         // Experimental settings
         Boolean RetroTerminalEffect;

src/cascadia/TerminalCore/ICoreAppearance.idl

@@ -39,5 +39,6 @@ namespace Microsoft.Terminal.Core
         Microsoft.Terminal.Core.Color CursorColor;
         CursorStyle CursorShape;
         UInt32 CursorHeight;
+        Boolean IntenseIsBright;
     };
 }

src/cascadia/TerminalCore/Terminal.cpp

@@ -52,7 +52,8 @@ Terminal::Terminal() :
     _selection{ std::nullopt },
     _taskbarState{ 0 },
     _taskbarProgress{ 0 },
-    _trimBlockSelection{ false }
+    _trimBlockSelection{ false },
+    _intenseIsBright{ true }
 {
     auto dispatch = std::make_unique<TerminalDispatch>(*this);
     auto engine = std::make_unique<OutputStateMachineEngine>(std::move(dispatch));
@@ -173,6 +174,7 @@ void Terminal::UpdateAppearance(const ICoreAppearance& appearance)
     til::color newBackgroundColor{ appearance.DefaultBackground() };
     _defaultBg = newBackgroundColor.with_alpha(0);
     _defaultFg = appearance.DefaultForeground();
+    _intenseIsBright = appearance.IntenseIsBright();
 
     for (int i = 0; i < 16; i++)
     {

src/cascadia/TerminalCore/Terminal.hpp

@@ -271,6 +271,7 @@ class Microsoft::Terminal::Core::Terminal final :
     bool _suppressApplicationTitle;
     bool _bracketedPasteMode;
     bool _trimBlockSelection;
+    bool _intenseIsBright;
 
     size_t _taskbarState;
     size_t _taskbarProgress;

src/cascadia/TerminalCore/terminalrenderdata.cpp

@@ -49,7 +49,8 @@ std::pair<COLORREF, COLORREF> Terminal::GetAttributeColors(const TextAttribute&
                                           _defaultFg,
                                           _defaultBg,
                                           _screenReversed,
-                                          _blinkingState.IsBlinkingFaint());
+                                          _blinkingState.IsBlinkingFaint(),
+                                          _intenseIsBright);
     colors.first |= 0xff000000;
     // We only care about alpha for the default BG (which enables acrylic)
     // If the bg isn't the default bg color, or reverse video is enabled, make it fully opaque.

src/cascadia/TerminalSettingsEditor/Appearances.cpp

@@ -131,6 +131,8 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 
         const auto backgroundImgCheckboxTooltip{ ToolTipService::GetToolTip(UseDesktopImageCheckBox()) };
         Automation::AutomationProperties::SetFullDescription(UseDesktopImageCheckBox(), unbox_value<hstring>(backgroundImgCheckboxTooltip));
+
+        INITIALIZE_BINDABLE_ENUM_SETTING(IntenseTextStyle, IntenseTextStyle, winrt::Microsoft::Terminal::Settings::Model::IntenseStyle, L"Appearance_IntenseTextStyle", L"Content");
     }
 
     // Method Description:
@@ -256,6 +258,24 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
                     _PropertyChangedHandlers(*this, PropertyChangedEventArgs{ L"ShowAllFonts" });
                     _PropertyChangedHandlers(*this, PropertyChangedEventArgs{ L"UsingMonospaceFont" });
                 }
+                else if (settingName == L"IntenseTextStyle")
+                {
+                    _PropertyChangedHandlers(*this, PropertyChangedEventArgs{ L"CurrentIntenseTextStyle" });
+                }
+                // YOU THERE ADDING A NEW APPEARANCE SETTING
+                // Make sure you add a block like
+                //
+                //   else if (settingName == L"MyNewSetting")
+                //   {
+                //       _PropertyChangedHandlers(*this, PropertyChangedEventArgs{ L"CurrentMyNewSetting" });
+                //   }
+                //
+                // To make sure that changes to the AppearanceViewModel will
+                // propagate back up to the actual UI (in Appearances). The
+                // CurrentMyNewSetting properties are the ones that are bound in
+                // XAML. If you don't do this right (or only raise a property
+                // changed for "MyNewSetting"), then things like the reset
+                // button won't work right.
             });
         }
     }

src/cascadia/TerminalSettingsEditor/Appearances.h

@@ -78,6 +78,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         OBSERVABLE_PROJECTED_SETTING(_appearance, BackgroundImageOpacity);
         OBSERVABLE_PROJECTED_SETTING(_appearance, BackgroundImageStretchMode);
         OBSERVABLE_PROJECTED_SETTING(_appearance, BackgroundImageAlignment);
+        OBSERVABLE_PROJECTED_SETTING(_appearance, IntenseTextStyle);
 
     private:
         Model::AppearanceConfig _appearance;
@@ -122,6 +123,8 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 
         GETSET_BINDABLE_ENUM_SETTING(BackgroundImageStretchMode, Windows::UI::Xaml::Media::Stretch, Appearance, BackgroundImageStretchMode);
 
+        GETSET_BINDABLE_ENUM_SETTING(IntenseTextStyle, Microsoft::Terminal::Settings::Model::IntenseStyle, Appearance, IntenseTextStyle);
+
     private:
         bool _ShowAllFonts;
         void _UpdateBIAlignmentControl(const int32_t val);

src/cascadia/TerminalSettingsEditor/Appearances.idl

@@ -39,6 +39,7 @@ namespace Microsoft.Terminal.Settings.Editor
         OBSERVABLE_PROJECTED_APPEARANCE_SETTING(Double, BackgroundImageOpacity);
         OBSERVABLE_PROJECTED_APPEARANCE_SETTING(Windows.UI.Xaml.Media.Stretch, BackgroundImageStretchMode);
         OBSERVABLE_PROJECTED_APPEARANCE_SETTING(Microsoft.Terminal.Settings.Model.ConvergedAlignment, BackgroundImageAlignment);
+        OBSERVABLE_PROJECTED_APPEARANCE_SETTING(Microsoft.Terminal.Settings.Model.IntenseStyle, IntenseTextStyle);
     }
 
     [default_interface] runtimeclass Appearances : Windows.UI.Xaml.Controls.UserControl, Windows.UI.Xaml.Data.INotifyPropertyChanged
@@ -66,5 +67,8 @@ namespace Microsoft.Terminal.Settings.Editor
         Windows.Foundation.Collections.IObservableVector<Microsoft.Terminal.Settings.Editor.EnumEntry> FontWeightList { get; };
 
         IInspectable CurrentFontFace { get; };
+
+        IInspectable CurrentIntenseTextStyle;
+        Windows.Foundation.Collections.IObservableVector<Microsoft.Terminal.Settings.Editor.EnumEntry> IntenseTextStyleList { get; };
     }
 }

src/cascadia/TerminalSettingsEditor/Appearances.xaml

@@ -435,5 +435,23 @@
                 </Grid>
             </local:SettingContainer>
         </StackPanel>
+
+        <!--  Grouping: Text Formatting  -->
+        <StackPanel Style="{StaticResource PivotStackStyle}">
+            <TextBlock x:Uid="Appearance_TextFormattingHeader"
+                       Style="{StaticResource SubtitleTextBlockStyle}" />
+
+            <!--  Intense is bold, bright  -->
+            <local:SettingContainer x:Uid="Appearance_IntenseTextStyle"
+                                    Margin="0"
+                                    ClearSettingValue="{x:Bind Appearance.ClearIntenseTextStyle}"
+                                    HasSettingValue="{x:Bind Appearance.HasIntenseTextStyle, Mode=OneWay}"
+                                    SettingOverrideSource="{x:Bind Appearance.IntenseTextStyleOverrideSource, Mode=OneWay}">
+                <muxc:RadioButtons ItemTemplate="{StaticResource EnumRadioButtonTemplate}"
+                                   ItemsSource="{x:Bind IntenseTextStyleList, Mode=OneWay}"
+                                   SelectedItem="{x:Bind CurrentIntenseTextStyle, Mode=TwoWay}" />
+            </local:SettingContainer>
+        </StackPanel>
+
     </StackPanel>
 </UserControl>

src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw

@@ -1158,4 +1158,28 @@
     <value>Add new</value>
     <comment>Button label that creates a new action on the actions page.</comment>
   </data>
-</root>
+  <data name="Appearance_TextFormattingHeader.Text" xml:space="preserve">
+    <value>Text Formatting</value>
+    <comment>Header for a control to how text is formatted</comment>
+  </data>
+  <data name="Appearance_IntenseTextStyle.Header" xml:space="preserve">
+    <value>Intense Text Format</value>
+    <comment>Header for a control to select how "intense" text is formatted (bold, bright, both or none)</comment>
+  </data>
+  <data name="Appearance_IntenseTextStyleNone.Content" xml:space="preserve">
+    <value>None</value>
+    <comment>An option to choose from for the "intense text format" setting. When selected, "intense" text will not be rendered differently</comment>
+  </data>
+  <data name="Appearance_IntenseTextStyleBold.Content" xml:space="preserve">
+    <value>Bold</value>
+    <comment>An option to choose from for the "intense text format" setting. When selected, "intense" text will be rendered as bold text</comment>
+  </data>
+  <data name="Appearance_IntenseTextStyleBright.Content" xml:space="preserve">
+    <value>Bright</value>
+    <comment>An option to choose from for the "intense text format" setting. When selected, "intense" text will be rendered in a brighter color</comment>
+  </data>
+  <data name="Appearance_IntenseTextStyleAll.Content" xml:space="preserve">
+    <value>Both</value>
+    <comment>An option to choose from for the "intense text format" setting. When selected, "intense" text will be rendered as both bold text and in a brighter color</comment>
+  </data>
+</root>

src/cascadia/TerminalSettingsModel/AppearanceConfig.cpp

@@ -25,6 +25,7 @@ static constexpr std::string_view BackgroundImageStretchModeKey{ "backgroundImag
 static constexpr std::string_view BackgroundImageAlignmentKey{ "backgroundImageAlignment" };
 static constexpr std::string_view RetroTerminalEffectKey{ "experimental.retroTerminalEffect" };
 static constexpr std::string_view PixelShaderPathKey{ "experimental.pixelShaderPath" };
+static constexpr std::string_view IntenseTextStyleKey{ "intenseTextStyle" };
 
 winrt::Microsoft::Terminal::Settings::Model::implementation::AppearanceConfig::AppearanceConfig(const winrt::weak_ref<Profile> sourceProfile) :
     _sourceProfile(sourceProfile)
@@ -48,6 +49,7 @@ winrt::com_ptr<AppearanceConfig> AppearanceConfig::CopyAppearance(const winrt::c
     appearance->_BackgroundImageAlignment = sourceAppearance->_BackgroundImageAlignment;
     appearance->_RetroTerminalEffect = sourceAppearance->_RetroTerminalEffect;
     appearance->_PixelShaderPath = sourceAppearance->_PixelShaderPath;
+    appearance->_IntenseTextStyle = sourceAppearance->_IntenseTextStyle;
     return appearance;
 }
 
@@ -68,6 +70,7 @@ Json::Value AppearanceConfig::ToJson() const
     JsonUtils::SetValueForKey(json, BackgroundImageAlignmentKey, _BackgroundImageAlignment);
     JsonUtils::SetValueForKey(json, RetroTerminalEffectKey, _RetroTerminalEffect);
     JsonUtils::SetValueForKey(json, PixelShaderPathKey, _PixelShaderPath);
+    JsonUtils::SetValueForKey(json, IntenseTextStyleKey, _IntenseTextStyle);
 
     return json;
 }
@@ -98,6 +101,7 @@ void AppearanceConfig::LayerJson(const Json::Value& json)
     JsonUtils::GetValueForKey(json, BackgroundImageAlignmentKey, _BackgroundImageAlignment);
     JsonUtils::GetValueForKey(json, RetroTerminalEffectKey, _RetroTerminalEffect);
     JsonUtils::GetValueForKey(json, PixelShaderPathKey, _PixelShaderPath);
+    JsonUtils::GetValueForKey(json, IntenseTextStyleKey, _IntenseTextStyle);
 }
 
 winrt::Microsoft::Terminal::Settings::Model::Profile AppearanceConfig::SourceProfile()

src/cascadia/TerminalSettingsModel/AppearanceConfig.h

@@ -52,6 +52,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         INHERITABLE_SETTING(Model::IAppearanceConfig, bool, RetroTerminalEffect, false);
         INHERITABLE_SETTING(Model::IAppearanceConfig, hstring, PixelShaderPath, L"");
+        INHERITABLE_SETTING(Model::IAppearanceConfig, Model::IntenseStyle, IntenseTextStyle, Model::IntenseStyle::All);
 
     private:
         winrt::weak_ref<Profile> _sourceProfile;