Add a setting to flash the pane when BEL is emitted #9270

PankajBhojwani · 2021-02-24T18:16:11Z

Summary of the Pull Request

Adds a new bellStyle called window. When window is set and a BEL is emitted, we flash the pane that emitted it.

Additionally, changes bellStyle in the SUI to a list of checkboxes instead of radio buttons, to match bellStyle being a flag-enum. Deprecates 'BellStyle::Visual' in the schema, but still allows it to be set in the json (it maps to Window | Taskbar)

References

#6700

PR Checklist

Closes #xxx
CLA signed. If not, go over here and sign the CLA
Tests added/passed
Documentation updated. If checked, please file a pull request on our docs repo and link it here: #xxx
Schema updated.
I work here

Validation Steps Performed

GIF in Teams

…/pabhoj/bell_flash

zadjii-msft

I have no idea why this doesn't work. This should work - Terminal::SetScreenMode already does call TriggerRedrawAll().

Maybe InvertScreenColors/_InvertTimerTick need to take the write lock?

src/cascadia/TerminalControl/TermControl.cpp

PankajBhojwani · 2021-03-19T23:00:43Z

Maybe InvertScreenColors/_InvertTimerTick need to take the write lock?

That seems to have fixed it, tested by repeatedly sending a bunch of BELs and the screen reverted back properly

carlos-zamora

You have activated my trap card!

Since you updated the mapping for a setting, you are now forced to update the Settings UI. Otherwise, we'll crash when attempting to find the resw entry for these new values.

You also need to update the schema and the docs.

I see the gif in your PR description, but I don't understand what the difference between window and visual is. Also, taskbar is added, but not mentioned in the PR description above.

carlos-zamora · 2021-03-23T16:45:26Z

src/cascadia/TerminalApp/Pane.cpp

+                                      WI_IsFlagSet(paneProfile.BellStyle(), winrt::Microsoft::Terminal::Settings::Model::BellStyle::Taskbar);
+
+            // raise the event with the bool value corresponding to the taskbar or visual flag
+            _PaneRaiseBellHandlers(nullptr, flashTaskbar);


So, the settings now look like this?

window: flash terminal

taskbar: add bell icon to tab

visual = [ "window", "taskbar" ]

taskbar flashes the taskbar icon at the toolbar (if the terminal window is not focused)! The others are correct

src/cascadia/TerminalControl/TermControl.cpp

DHowett

I need to have a think about this :)

## Summary of the Pull Request This replaces `ThrottledFunc` with two variants: * `ThrottledFuncLeading` invokes the callback immediately and blocks further calls for the given duration * `ThrottledFuncTrailing` blocks calls for the given duration and then invokes the callback ## References * #9270 - `ThrottledFuncLeading` will allow the pane to flash immediately for a BEL, but block further BELs until the animation finished ## PR Checklist * [x] I work here * [ ] Tests added/passed ## Validation Steps Performed * [x] Ensured scrolling still works

src/cascadia/TerminalControl/XamlLights.cpp

DHowett · 2021-05-21T17:17:08Z

src/cascadia/TerminalApp/Pane.cpp

-            _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();


this seems like the wrong abstraction-- the app should not tell the control to blink after the control tells the app that there was a bell.

Your comment about the visual bell moving up into the application resonates with me. Thank you.

DHowett

abstraction concern. if you'd rather keep it this way, let me know!

PankajBhojwani · 2021-05-24T08:18:33Z

abstraction concern. if you'd rather keep it this way, let me know!

I think I like the idea of letting the app handle the flash. Though I think it'll be much smoother to do that after the pane refactor goes in - that way we can attach the xaml light to the pane instead of the control's grid. Thoughts?

If we want the control to handle the flash, 1. it'll have to know if BellStyle::Window is set and 2. we'll be in the situation where the app handles BellStyle::Taskbar and BellStyle::Audible but the control handles BellStyle::Window, which I guess is fine but I think its nicer to have it all be in one place.

zadjii-msft · 2021-05-24T13:59:39Z

src/cascadia/TerminalControl/TermControl.cpp

+        {
+            // Stop the timer and switch off the light
+            _bellLightTimer->Stop();
+            _bellLightTimer.reset();


Theoretically, once the timer's been initialized, we don't need to keep creating and destroying it each time. We could just re-use it, but I'm not gonna block over that.

Good notes for cleanup later. 😄

zadjii-msft

Okay, I have nits & questions, but nothing to block over

zadjii-msft · 2021-05-24T14:03:54Z

src/cascadia/TerminalControl/TermControl.cpp

+
+            // Switch on the light and animate the intensity to fade out
+            VisualBellLight::SetIsTarget(RootGrid(), true);
+            BellLight().CompositionLight().StartAnimation(L"Intensity", _bellLightAnimation);


Just to be clear, the animation runs from Intensity=2.0->1.0, then is switched off entirely at the end of the time. That's neat

zadjii-msft · 2021-05-24T14:05:14Z

src/cascadia/TerminalControl/TermControl.h

@@ -164,8 +167,11 @@ namespace winrt::Microsoft::Terminal::Control::implementation
        Windows::UI::Xaml::DispatcherTimer _autoScrollTimer;
        std::optional<std::chrono::high_resolution_clock::time_point> _lastAutoScrollUpdateTime;

+        winrt::Windows::UI::Composition::ScalarKeyFrameAnimation _bellLightAnimation;


meh that seems fine to me. In the future, we could always init this as

winrt::Windows::UI::Composition::ScalarKeyFrameAnimation _bellLightAnimation{ nullptr };

and only ctor it when actually requested in the settings, but again, meh

zadjii-msft · 2021-05-24T14:06:45Z

src/cascadia/TerminalSettingsEditor/Profiles.cpp

@@ -627,6 +626,32 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
        _State.Profile().ColorSchemeName(val.Name());
    }

+    bool Profiles::IsBellStyleFlagSet(const uint32_t flag)
+    {
+        return (WI_EnumValue(_State.Profile().BellStyle()) & flag) == flag;


Wait uh, what exactly is happening here? Is this just WI_IsFlagSet?

or WI_AreAllFlagsSet?

explained offline -- this is because the WI macros require a compile-time constant. We have to do it manually.

zadjii-msft · 2021-05-24T14:10:35Z

src/cascadia/TerminalSettingsModel/JsonUtils.h

@@ -630,7 +630,8 @@ namespace Microsoft::Terminal::Settings::Model::JsonUtils
                for (const auto& pair : TBase::mappings)
                {
                    if (pair.second != AllClear &&
-                        (val & pair.second) == pair.second)
+                        (val & pair.second) == pair.second &&


This again looks like a WI_IsFlagSet, which I think also does WI_IsSingleFlagSet

src/cascadia/TerminalSettingsModel/Profile.idl

zadjii-msft · 2021-05-24T14:38:13Z

src/cascadia/TerminalControl/XamlLights.cpp

+
+    void VisualBellLight::OnIsTargetChanged(DependencyObject const& d, DependencyPropertyChangedEventArgs const& e)
+    {
+        const auto uielem{ d.try_as<UIElement>() };


kinda surprised that uielem resolved as a word with spellcheck

zadjii-msft · 2021-05-24T14:45:44Z

src/cascadia/TerminalControl/XamlLights.cpp

+        return VisualBellLight::GetIdStatic();
+    }
+
+    void VisualBellLight::OnIsTargetChanged(DependencyObject const& d, DependencyPropertyChangedEventArgs const& e)


I don't think I totally understand what's going on with this method. This is a static function that's called when IsTarget changes on a VisualBellLight? And then d is either a UIElement, or a Brush... When is this ever a brush?

Or is this just forward thinking? All this seems like handy boilerplate around XamlLight, I'm kinda shocked (but also not surprised) that we need this much boilerplate just to add a light.

So yeah I think this is some cool stuff -- he's created an "attached property" (like Grid.Row -- a property that's about one object, stored in global storage, attached to another object). It looks like this one can be attached to either a brush or a UI Element, seamlessly.

Yep! I've mostly just adopted the code from the xaml light docs. Lights can only target a Brush or a UIElement, and yeah in our case we never use it for a brush but I feel like its probably a good idea to have that check anyway

DHowett · 2021-05-24T17:00:05Z

@carlos-zamora can you dismiss or re-review?

major changes

DHowett · 2021-05-24T17:00:43Z

src/cascadia/TerminalApp/Pane.cpp

-            _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();


Your comment about the visual bell moving up into the application resonates with me. Thank you.

DHowett · 2021-05-24T17:05:43Z

src/cascadia/TerminalControl/TermControl.cpp

+        {
+            // Stop the timer and switch off the light
+            _bellLightTimer->Stop();
+            _bellLightTimer.reset();


Good notes for cleanup later. 😄

DHowett · 2021-05-24T17:09:16Z

src/cascadia/TerminalControl/XamlLights.cpp

+        return VisualBellLight::GetIdStatic();
+    }
+
+    void VisualBellLight::OnIsTargetChanged(DependencyObject const& d, DependencyPropertyChangedEventArgs const& e)


So yeah I think this is some cool stuff -- he's created an "attached property" (like Grid.Row -- a property that's about one object, stored in global storage, attached to another object). It looks like this one can be attached to either a brush or a UI Element, seamlessly.

DHowett · 2021-05-24T17:10:16Z

src/cascadia/TerminalSettingsEditor/Profiles.cpp

@@ -627,6 +626,32 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
        _State.Profile().ColorSchemeName(val.Name());
    }

+    bool Profiles::IsBellStyleFlagSet(const uint32_t flag)
+    {
+        return (WI_EnumValue(_State.Profile().BellStyle()) & flag) == flag;


explained offline -- this is because the WI macros require a compile-time constant. We have to do it manually.

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

src/cascadia/TerminalSettingsModel/Profile.idl

This replaces `ThrottledFunc` with two variants: * `ThrottledFuncLeading` invokes the callback immediately and blocks further calls for the given duration * `ThrottledFuncTrailing` blocks calls for the given duration and then invokes the callback * #9270 - `ThrottledFuncLeading` will allow the pane to flash immediately for a BEL, but block further BELs until the animation finished * [x] I work here * [ ] Tests added/passed * [x] Ensured scrolling still works (cherry picked from commit 13f0b8e)

ghost · 2021-05-24T22:50:54Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

ghost · 2021-05-25T19:10:39Z

🎉Windows Terminal Preview v1.9.1445.0 has been released which incorporates this pull request.:tada:

Handy links:

Just come cleanup I did not manage to get to before #9270 merged. Specifically: - We only initialize the animation and timer if we need them - We don't repeatedly destroy/create the timer ## Validation Steps Performed It still works

Just come cleanup I did not manage to get to before #9270 merged. Specifically: - We only initialize the animation and timer if we need them - We don't repeatedly destroy/create the timer ## Validation Steps Performed It still works (cherry picked from commit 2fed4c4)

Adds a variable `_isBackgroundLight` that is updated when the background color is changed. When it is `true`, the BEL indicator flash will darken the screen instead of brightening. `_isColorLight(bg)` returns `true` if the average of `r`, `g`, and `b` is >127 I was unsure of an appropriate way to change the color of the `CompositionLight` based on the background, so I changed it to always be gray and adjusted the intensity values of the original animation to have roughly the same visual effect as the white. ## Validation Steps Performed * Tested the two flashes on the default color schemes and some custom background colors to see if they look consistent * Used tracepoints and visual to check that the right animation is used (including multiple tabs, split windows with different themes, and changing settings while window is open) References #9270 Closes #13450

PankajBhojwani added 4 commits February 18, 2021 10:27

initial

370e0c0

optional timer

3d7c9db

add setting

54a683d

Merge branch 'main' of https://github.com/microsoft/terminal into dev…

b4ae30c

…/pabhoj/bell_flash

This comment has been minimized.

Sign in to view

PankajBhojwani added 2 commits February 24, 2021 10:28

change timer

d59a432

format

c1172cd

zadjii-msft self-assigned this Mar 3, 2021

zadjii-msft reviewed Mar 17, 2021

View reviewed changes

src/cascadia/TerminalControl/TermControl.cpp Outdated Show resolved Hide resolved

zadjii-msft assigned PankajBhojwani and unassigned zadjii-msft Mar 17, 2021

stash, lock

e0c9f89

PankajBhojwani marked this pull request as ready for review March 19, 2021 23:01

weak this

e89f273

zadjii-msft previously approved these changes Mar 23, 2021

View reviewed changes

zadjii-msft unassigned PankajBhojwani Mar 23, 2021

zadjii-msft added the Needs-Second It's a PR that needs another sign-off label Mar 23, 2021

ghost requested review from miniksa, carlos-zamora, DHowett and leonMSFT March 23, 2021 13:40

carlos-zamora requested changes Mar 23, 2021

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Mar 23, 2021

DHowett requested changes Mar 23, 2021

View reviewed changes

PankajBhojwani added 2 commits May 20, 2021 20:15

Cleanup

b675b2a

== flag

6c9d8ef

DHowett reviewed May 21, 2021

View reviewed changes

src/cascadia/TerminalControl/XamlLights.cpp Outdated Show resolved Hide resolved

DHowett reviewed May 21, 2021

View reviewed changes

DHowett requested changes May 21, 2021

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label May 21, 2021

Ternary

730cf09

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label May 24, 2021

zadjii-msft reviewed May 24, 2021

View reviewed changes

zadjii-msft approved these changes May 24, 2021

View reviewed changes

DHowett approved these changes May 24, 2021

View reviewed changes

Apply suggestions from code review

f5bb54e

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label May 24, 2021

ghost merged commit 227ec37 into main May 24, 2021

ghost deleted the dev/pabhoj/bell_flash branch May 24, 2021 22:51

ghost removed the Needs-Second It's a PR that needs another sign-off label May 25, 2021

PankajBhojwani mentioned this pull request Jun 1, 2021

Cleanup from bell flash PR #10307

Merged

zadjii-msft mentioned this pull request Aug 19, 2021

Visual bell style should optionally affect the entire terminal pane #8889

Closed

yunruse mentioned this pull request Jul 7, 2022

Flash the pane dark when BEL is emitted and pane's appearance has a light background #13450

Closed

Fyrebright mentioned this pull request Aug 9, 2022

Flash the pane dark when BEL is emitted in a light terminal #13707

Merged

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a setting to flash the pane when BEL is emitted #9270

Add a setting to flash the pane when BEL is emitted #9270

PankajBhojwani commented Feb 24, 2021 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

zadjii-msft left a comment

PankajBhojwani commented Mar 19, 2021 •

edited

Loading

carlos-zamora left a comment

carlos-zamora Mar 23, 2021

PankajBhojwani Mar 24, 2021

DHowett left a comment

DHowett May 21, 2021

DHowett May 24, 2021

DHowett left a comment

PankajBhojwani commented May 24, 2021 •

edited

Loading

zadjii-msft May 24, 2021

DHowett May 24, 2021

zadjii-msft left a comment

zadjii-msft May 24, 2021

zadjii-msft May 24, 2021

zadjii-msft May 24, 2021

zadjii-msft May 24, 2021

DHowett May 24, 2021

zadjii-msft May 24, 2021

zadjii-msft May 24, 2021

zadjii-msft May 24, 2021

DHowett May 24, 2021

PankajBhojwani May 25, 2021

DHowett commented May 24, 2021

DHowett May 24, 2021

DHowett May 24, 2021

DHowett May 24, 2021

DHowett May 24, 2021

ghost commented May 24, 2021

ghost commented May 25, 2021

Add a setting to flash the pane when BEL is emitted #9270

Add a setting to flash the pane when BEL is emitted #9270

Conversation

PankajBhojwani commented Feb 24, 2021 • edited Loading

Summary of the Pull Request

References

PR Checklist

Validation Steps Performed

This comment has been minimized.

This comment has been minimized.

zadjii-msft left a comment

Choose a reason for hiding this comment

PankajBhojwani commented Mar 19, 2021 • edited Loading

carlos-zamora left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

PankajBhojwani commented May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zadjii-msft left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett commented May 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented May 24, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented May 25, 2021

PankajBhojwani commented Feb 24, 2021 •

edited

Loading

PankajBhojwani commented Mar 19, 2021 •

edited

Loading

PankajBhojwani commented May 24, 2021 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.