Add a setting to flash the pane when BEL is emitted

doc/cascadia/profiles.schema.json

@@ -37,7 +37,8 @@
             "type": "string",
             "enum": [
               "audible",
-              "visual"
+              "window",
+              "taskbar"
             ]
           }
         },
@@ -46,6 +47,8 @@
           "enum": [
             "audible",
             "visual",
+            "taskbar",
+            "window",
             "all",
             "none"
           ]
@@ -1171,7 +1174,7 @@
         },
         "bellStyle": {
           "default": "audible",
-          "description": "Controls what happens when the application emits a BEL character. When set to \"all\", the Terminal will play a sound and flash the taskbar icon. An array of specific behaviors can also be used. Supported array values include `audible` and `visual`. When set to \"none\", nothing will happen.",
+          "description": "Controls what happens when the application emits a BEL character. When set to \"all\", the Terminal will play a sound, flash the taskbar icon (if the terminal window is not in focus) and flash the window. An array of specific behaviors can also be used. Supported array values include `audible`, `window` and `taskbar`. When set to \"none\", nothing will happen.",
           "$ref": "#/definitions/BellStyle"
         },
         "closeOnExit": {

src/cascadia/TerminalApp/Pane.cpp

@@ -378,8 +378,13 @@ void Pane::_ControlWarningBellHandler(const winrt::Windows::Foundation::IInspect
                 PlaySound(soundAlias, NULL, SND_ALIAS_ID | SND_ASYNC | SND_SENTRY);
             }
 
-            // raise the event with the bool value corresponding to the visual flag
-            _PaneRaiseBellHandlers(nullptr, WI_IsFlagSet(paneProfile.BellStyle(), winrt::Microsoft::Terminal::Settings::Model::BellStyle::Visual));
+            if (WI_IsFlagSet(paneProfile.BellStyle(), winrt::Microsoft::Terminal::Settings::Model::BellStyle::Window))
+            {
+                _control.BellLightOn();
+            }
+
+            // raise the event with the bool value corresponding to the taskbar flag
+            _PaneRaiseBellHandlers(nullptr, WI_IsFlagSet(paneProfile.BellStyle(), winrt::Microsoft::Terminal::Settings::Model::BellStyle::Taskbar));
         }
     }
 }

src/cascadia/TerminalControl/TermControl.cpp

@@ -14,6 +14,7 @@
 #include "../../types/inc/Utils.hpp"
 
 #include "TermControl.g.cpp"
+#include "VisualBellLight.g.cpp"
 #include "TermControlAutomationPeer.h"
 
 using namespace ::Microsoft::Console::Types;
@@ -58,6 +59,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         _lastAutoScrollUpdateTime{ std::nullopt },
         _cursorTimer{},
         _blinkTimer{},
+        _bellLightTimer{},
         _searchBox{ nullptr }
     {
         InitializeComponent();
@@ -2358,6 +2360,34 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         return _core->TaskbarProgress();
     }
 
+    void TermControl::BellLightOn()
+    {
+        if (!_bellLightTimer)
+        {
+            // Start the timer, when the timer ticks we switch off the light
+            DispatcherTimer invertTimer;
+            invertTimer.Interval(std::chrono::milliseconds(2000));
+            invertTimer.Tick({ get_weak(), &TermControl::_BellLightOff });
+            invertTimer.Start();
+            _bellLightTimer.emplace(std::move(invertTimer));
+
+            // Switch on the light
+            VisualBellLight::SetIsTarget(RootGrid(), true);
+        }
+    }
+
+    void TermControl::_BellLightOff(Windows::Foundation::IInspectable const& /* sender */,
+                                    Windows::Foundation::IInspectable const& /* e */)
+    {
+        if (_bellLightTimer && !_closing)
+        {
+            // Stop the timer and switch off the light
+            _bellLightTimer.value().Stop();
+            _bellLightTimer = std::nullopt;
+            VisualBellLight::SetIsTarget(RootGrid(), false);
+        }
+    }
+
     // Method Description:
     // - Checks whether the control is in a read-only mode (in this mode node input is sent to connection).
     // Return Value:
@@ -2492,4 +2522,68 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     {
         _playWarningBell->Run();
     }
+
+    Windows::UI::Xaml::DependencyProperty VisualBellLight::m_isTargetProperty =
+        Windows::UI::Xaml::DependencyProperty::RegisterAttached(
+            L"IsTarget",
+            winrt::xaml_typename<bool>(),
+            winrt::xaml_typename<winrt::Microsoft::Terminal::Control::VisualBellLight>(),
+            Windows::UI::Xaml::PropertyMetadata{ winrt::box_value(false), Windows::UI::Xaml::PropertyChangedCallback{ &VisualBellLight::OnIsTargetChanged } });
+
+    void VisualBellLight::OnConnected(Windows::UI::Xaml::UIElement const& /* newElement */)
+    {
+        if (!CompositionLight())
+        {
+            // OnConnected is called when the first target UIElement is shown on the screen. This enables delaying composition object creation until it's actually necessary.
+            auto spotLight2{ Windows::UI::Xaml::Window::Current().Compositor().CreateAmbientLight() };
+            spotLight2.Color(Windows::UI::Colors::WhiteSmoke());
+            spotLight2.Intensity(static_cast<float>(1.5));
+            CompositionLight(spotLight2);
+        }
+    }
+
+    void VisualBellLight::OnDisconnected(Windows::UI::Xaml::UIElement const& /* oldElement */)
+    {
+        // OnDisconnected is called when there are no more target UIElements on the screen.
+        // Dispose of composition resources when no longer in use.
+        if (CompositionLight())
+        {
+            CompositionLight(nullptr);
+        }
+    }
+
+    winrt::hstring VisualBellLight::GetId()
+    {
+        return VisualBellLight::GetIdStatic();
+    }
+
+    void VisualBellLight::OnIsTargetChanged(Windows::UI::Xaml::DependencyObject const& d, Windows::UI::Xaml::DependencyPropertyChangedEventArgs const& e)
+    {
+        auto uielem{ d.try_as<Windows::UI::Xaml::UIElement>() };
+        auto brush{ d.try_as<Windows::UI::Xaml::Media::Brush>() };
+
+        auto isAdding = winrt::unbox_value<bool>(e.NewValue());
+        if (isAdding)
+        {
+            if (uielem)
+            {
+                Windows::UI::Xaml::Media::XamlLight::AddTargetElement(VisualBellLight::GetIdStatic(), uielem);
+            }
+            else if (brush)
+            {
+                Windows::UI::Xaml::Media::XamlLight::AddTargetBrush(VisualBellLight::GetIdStatic(), brush);
+            }
+        }
+        else
+        {
+            if (uielem)
+            {
+                Windows::UI::Xaml::Media::XamlLight::RemoveTargetElement(VisualBellLight::GetIdStatic(), uielem);
+            }
+            else if (brush)
+            {
+                Windows::UI::Xaml::Media::XamlLight::RemoveTargetBrush(VisualBellLight::GetIdStatic(), brush);
+            }
+        }
+    }
 }

src/cascadia/TerminalControl/TermControl.h

@@ -4,6 +4,7 @@
 #pragma once
 
 #include "TermControl.g.h"
+#include "VisualBellLight.g.h"
 #include "EventArgs.h"
 #include "../../renderer/base/Renderer.hpp"
 #include "../../renderer/dx/DxRenderer.hpp"
@@ -98,6 +99,8 @@ namespace winrt::Microsoft::Terminal::Control::implementation
                                                                const winrt::hstring& padding,
                                                                const uint32_t dpi);
 
+        void BellLightOn();
+
         bool ReadOnly() const noexcept;
         void ToggleReadOnly();
 
@@ -129,6 +132,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
     private:
         friend struct TermControlT<TermControl>; // friend our parent so it can bind private event handlers
+        bool _termScreenReversed;
 
         winrt::com_ptr<ControlCore> _core;
         winrt::com_ptr<ControlInteractivity> _interactivity;
@@ -166,6 +170,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         std::optional<Windows::UI::Xaml::DispatcherTimer> _cursorTimer;
         std::optional<Windows::UI::Xaml::DispatcherTimer> _blinkTimer;
+        std::optional<Windows::UI::Xaml::DispatcherTimer> _bellLightTimer;
 
         event_token _coreOutputEventToken;
 
@@ -202,6 +207,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         void _CursorTimerTick(Windows::Foundation::IInspectable const& sender, Windows::Foundation::IInspectable const& e);
         void _BlinkTimerTick(Windows::Foundation::IInspectable const& sender, Windows::Foundation::IInspectable const& e);
+        void _BellLightOff(Windows::Foundation::IInspectable const& sender, Windows::Foundation::IInspectable const& e);
 
         void _SetEndSelectionPointAtCursor(Windows::Foundation::Point const& cursorPosition);
 
@@ -249,9 +255,43 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         void _coreRaisedNotice(const IInspectable& s, const Control::NoticeEventArgs& args);
         void _coreWarningBell(const IInspectable& sender, const IInspectable& args);
     };
+
+    struct VisualBellLight : VisualBellLightT<VisualBellLight>
+    {
+        VisualBellLight() = default;
+
+        winrt::hstring GetId();
+
+        static Windows::UI::Xaml::DependencyProperty IsTargetProperty() { return m_isTargetProperty; }
+
+        static bool GetIsTarget(Windows::UI::Xaml::DependencyObject const& target)
+        {
+            return winrt::unbox_value<bool>(target.GetValue(m_isTargetProperty));
+        }
+
+        static void SetIsTarget(Windows::UI::Xaml::DependencyObject const& target, bool value)
+        {
+            target.SetValue(m_isTargetProperty, winrt::box_value(value));
+        }
+
+        void OnConnected(Windows::UI::Xaml::UIElement const& newElement);
+        void OnDisconnected(Windows::UI::Xaml::UIElement const& oldElement);
+
+        static void OnIsTargetChanged(Windows::UI::Xaml::DependencyObject const& d, Windows::UI::Xaml::DependencyPropertyChangedEventArgs const& e);
+
+        inline static winrt::hstring GetIdStatic()
+        {
+            // This specifies the unique name of the light. In most cases you should use the type's full name.
+            return winrt::xaml_typename<winrt::Microsoft::Terminal::Control::VisualBellLight>().Name;
+        }
+
+    private:
+        static Windows::UI::Xaml::DependencyProperty m_isTargetProperty;
+    };
 }
 
 namespace winrt::Microsoft::Terminal::Control::factory_implementation
 {
     BASIC_FACTORY(TermControl);
+    BASIC_FACTORY(VisualBellLight);
 }

src/cascadia/TerminalControl/TermControl.idl

@@ -63,7 +63,17 @@ namespace Microsoft.Terminal.Control
         void ToggleShaderEffects();
         void SendInput(String input);
 
+        void BellLightOn();
+
         Boolean ReadOnly { get; };
         void ToggleReadOnly();
     }
+
+    [default_interface] runtimeclass VisualBellLight : Windows.UI.Xaml.Media.XamlLight
+    {
+        VisualBellLight();
+        static Windows.UI.Xaml.DependencyProperty IsTargetProperty { get; };
+        static Boolean GetIsTarget(Windows.UI.Xaml.DependencyObject target);
+        static void SetIsTarget(Windows.UI.Xaml.DependencyObject target, Boolean value);
+    }
 }

src/cascadia/TerminalControl/TermControl.xaml

@@ -33,6 +33,9 @@
     -->
 
     <Grid x:Name="RootGrid">
+        <Grid.Lights>
+            <local:VisualBellLight />
+        </Grid.Lights>
         <Image x:Name="BackgroundImage"
                AutomationProperties.AccessibilityView="Raw" />
         <Grid>

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

@@ -899,9 +899,13 @@
     <value>All</value>
     <comment>An option to choose from for the "bell style" setting. When selected, a combination of the other bell styles is used to notify the user.</comment>
   </data>
-  <data name="Profile_BellStyleVisual.Content" xml:space="preserve">
-    <value>Visual (flash taskbar)</value>
-    <comment>An option to choose from for the "bell style" setting. When selected, a visual notification is used to notify the user. In this case, the taskbar is flashed.</comment>
+  <data name="Profile_BellStyleTaskbar.Content" xml:space="preserve">
+    <value>Flash taskbar</value>
+    <comment>An option to choose from for the "bell style" setting. When selected, a visual notification is used to notify the user. In this case, the taskbar is flashed (only if the terminal window is not in focus).</comment>
+  </data>
+  <data name="Profile_BellStyleWindow.Content" xml:space="preserve">
+    <value>Flash window</value>
+    <comment>An option to choose from for the "bell style" setting. When selected, a visual notification is used to notify the user. In this case, the window is flashed.</comment>
   </data>
   <data name="ColorScheme_AddNewButton.Text" xml:space="preserve">
     <value>Add new</value>

src/cascadia/TerminalSettingsModel/Profile.idl

@@ -31,7 +31,8 @@ namespace Microsoft.Terminal.Settings.Model
     enum BellStyle
     {
         Audible = 0x1,
-        Visual = 0x2,
+        Window = 0x2,
+        Taskbar = 0x4,
         All = 0xffffffff
     };
 

src/cascadia/TerminalSettingsModel/TerminalSettingsSerializationHelpers.h

@@ -50,10 +50,11 @@ JSON_ENUM_MAPPER(::winrt::Microsoft::Terminal::Control::ScrollbarState)
 
 JSON_FLAG_MAPPER(::winrt::Microsoft::Terminal::Settings::Model::BellStyle)
 {
-    static constexpr std::array<pair_type, 4> mappings = {
+    static constexpr std::array<pair_type, 5> mappings = {
         pair_type{ "none", AllClear },
         pair_type{ "audible", ValueType::Audible },
-        pair_type{ "visual", ValueType::Visual },
+        pair_type{ "window", ValueType::Window },
+        pair_type{ "taskbar", ValueType::Taskbar },
         pair_type{ "all", AllSet },
     };