Add a setting to configure the audible bell

doc/cascadia/profiles.schema.json

@@ -26,6 +26,13 @@
       ],
       "type": "string"
     },
+    "BellStyle": {
+      "enum": [
+        "none",
+        "audible"
+      ],
+      "type": "string"
+    },
     "ProfileGuid": {
       "default": "{}",
       "pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
@@ -717,6 +724,11 @@
           ],
           "type": "string"
         },
+        "bellStyle": {
+          "default": "audible",
+          "description": "Controls what happens when the application emits a BEL character. When set to \"audible\", the Terminal will play a sound. When set to \"none\", nothing will happen.",
+          "$ref": "#/definitions/BellStyle"
+        },
         "closeOnExit": {
           "default": "graceful",
           "description": "Sets how the profile reacts to termination or failure to launch. Possible values:\n -\"graceful\" (close when exit is typed or the process exits normally)\n -\"always\" (always close)\n -\"never\" (never close).\ntrue and false are accepted as synonyms for \"graceful\" and \"never\" respectively.",

src/cascadia/TerminalApp/Pane.cpp

@@ -5,6 +5,8 @@
 #include "Pane.h"
 #include "AppLogic.h"
 
+#include <Mmsystem.h>
+
 using namespace winrt::Windows::Foundation;
 using namespace winrt::Windows::Graphics::Display;
 using namespace winrt::Windows::UI;
@@ -42,6 +44,7 @@ Pane::Pane(const GUID& profile, const TermControl& control, const bool lastFocus
     _border.Child(_control);
 
     _connectionStateChangedToken = _control.ConnectionStateChanged({ this, &Pane::_ControlConnectionStateChangedHandler });
+    _warningBellToken = _control.WarningBell({ this, &Pane::_ControlWarningBellHandler });
 
     // On the first Pane's creation, lookup resources we'll use to theme the
     // Pane, including the brushed to use for the focused/unfocused border
@@ -309,7 +312,8 @@ bool Pane::NavigateFocus(const Direction& direction)
 // - <none>
 // Return Value:
 // - <none>
-void Pane::_ControlConnectionStateChangedHandler(const TermControl& /*sender*/, const winrt::Windows::Foundation::IInspectable& /*args*/)
+void Pane::_ControlConnectionStateChangedHandler(const TermControl& /*sender*/,
+                                                 const winrt::Windows::Foundation::IInspectable& /*args*/)
 {
     std::unique_lock lock{ _createCloseLock };
     // It's possible that this event handler started being executed, then before
@@ -345,6 +349,31 @@ void Pane::_ControlConnectionStateChangedHandler(const TermControl& /*sender*/,
     }
 }
 
+// Method Description:
+// - Plays a warning note when triggered by the BEL control character,
+//   using the sound configured for the "Critical Stop" system event.`
+//   This matches the behavior of the Windows Console host.
+// Arguments:
+// - <unused>
+void Pane::_ControlWarningBellHandler(const winrt::Windows::Foundation::IInspectable& /*sender*/,
+                                      const winrt::Windows::Foundation::IInspectable& /*eventArgs*/)
+{
+    if (!_IsLeaf())
+    {
+        return;
+    }
+    const auto settings{ winrt::TerminalApp::implementation::AppLogic::CurrentAppSettings() };
+    auto paneProfile = settings.FindProfile(_profile.value());
+    if (paneProfile)
+    {
+        if (paneProfile.BellStyle() == winrt::Microsoft::Terminal::Settings::Model::BellStyle::Audible)
+        {
+            const auto soundAlias = reinterpret_cast<LPCTSTR>(SND_ALIAS_SYSTEMHAND);
+            PlaySound(soundAlias, NULL, SND_ALIAS_ID | SND_ASYNC | SND_SENTRY);
+        }
+    }
+}
+
 // Event Description:
 // - Called when our control gains focus. We'll use this to trigger our GotFocus
 //   callback. The tab that's hosting us should have registered a callback which
@@ -625,6 +654,7 @@ void Pane::_CloseChild(const bool closeFirst)
 
         // Add our new event handler before revoking the old one.
         _connectionStateChangedToken = _control.ConnectionStateChanged({ this, &Pane::_ControlConnectionStateChangedHandler });
+        _warningBellToken = _control.WarningBell({ this, &Pane::_ControlWarningBellHandler });
 
         // Revoke the old event handlers. Remove both the handlers for the panes
         // themselves closing, and remove their handlers for their controls
@@ -634,6 +664,8 @@ void Pane::_CloseChild(const bool closeFirst)
         _secondChild->Closed(_secondClosedToken);
         closedChild->_control.ConnectionStateChanged(closedChild->_connectionStateChangedToken);
         remainingChild->_control.ConnectionStateChanged(remainingChild->_connectionStateChangedToken);
+        closedChild->_control.WarningBell(closedChild->_warningBellToken);
+        remainingChild->_control.WarningBell(remainingChild->_warningBellToken);
 
         // If either of our children was focused, we want to take that focus from
         // them.
@@ -714,6 +746,7 @@ void Pane::_CloseChild(const bool closeFirst)
         oldFirst->Closed(oldFirstToken);
         oldSecond->Closed(oldSecondToken);
         closedChild->_control.ConnectionStateChanged(closedChild->_connectionStateChangedToken);
+        closedChild->_control.WarningBell(closedChild->_warningBellToken);
 
         // Reset our UI:
         _root.Children().Clear();
@@ -1412,6 +1445,8 @@ std::pair<std::shared_ptr<Pane>, std::shared_ptr<Pane>> Pane::_Split(SplitState
     // revoke our handler - the child will take care of the control now.
     _control.ConnectionStateChanged(_connectionStateChangedToken);
     _connectionStateChangedToken.value = 0;
+    _control.WarningBell(_warningBellToken);
+    _warningBellToken.value = 0;
 
     // Remove our old GotFocus handler from the control. We don't what the
     // control telling us that it's now focused, we want it telling its new

src/cascadia/TerminalApp/Pane.h

@@ -99,6 +99,7 @@ class Pane : public std::enable_shared_from_this<Pane>
     winrt::event_token _connectionStateChangedToken{ 0 };
     winrt::event_token _firstClosedToken{ 0 };
     winrt::event_token _secondClosedToken{ 0 };
+    winrt::event_token _warningBellToken{ 0 };
 
     winrt::Windows::UI::Xaml::UIElement::GotFocus_revoker _gotFocusRevoker;
 
@@ -130,6 +131,8 @@ class Pane : public std::enable_shared_from_this<Pane>
 
     void _FocusFirstChild();
     void _ControlConnectionStateChangedHandler(const winrt::Microsoft::Terminal::TerminalControl::TermControl& sender, const winrt::Windows::Foundation::IInspectable& /*args*/);
+    void _ControlWarningBellHandler(winrt::Windows::Foundation::IInspectable const& sender,
+                                    winrt::Windows::Foundation::IInspectable const& e);
     void _ControlGotFocusHandler(winrt::Windows::Foundation::IInspectable const& sender,
                                  winrt::Windows::UI::Xaml::RoutedEventArgs const& e);
 

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -7,7 +7,6 @@
 #include "AppLogic.h"
 #include "../../types/inc/utils.hpp"
 
-#include <Mmsystem.h>
 #include <LibraryResources.h>
 
 #include "TerminalPage.g.cpp"
@@ -1122,8 +1121,6 @@ namespace winrt::TerminalApp::implementation
         // Add an event handler when the terminal wants to paste data from the Clipboard.
         term.PasteFromClipboard({ this, &TerminalPage::_PasteFromClipboardHandler });
 
-        term.WarningBell({ this, &TerminalPage::_WarningBellHandler });
-
         term.OpenHyperlink({ this, &TerminalPage::_OpenHyperlinkHandler });
 
         // Bind Tab events to the TermControl and the Tab's Pane
@@ -1784,18 +1781,6 @@ namespace winrt::TerminalApp::implementation
         CATCH_LOG();
     }
 
-    // Method Description:
-    // - Plays a warning note when triggered by the BEL control character,
-    //   using the sound configured for the "Critical Stop" system event.
-    //   This matches the behavior of the Windows Console host.
-    // Arguments:
-    // - <none>
-    void TerminalPage::_WarningBellHandler(const IInspectable sender, const IInspectable eventArgs)
-    {
-        const auto soundAlias = reinterpret_cast<LPCTSTR>(SND_ALIAS_SYSTEMHAND);
-        PlaySound(soundAlias, NULL, SND_ALIAS_ID | SND_ASYNC | SND_SENTRY);
-    }
-
     void TerminalPage::_OpenHyperlinkHandler(const IInspectable /*sender*/, const Microsoft::Terminal::TerminalControl::OpenHyperlinkEventArgs eventArgs)
     {
         try

src/cascadia/TerminalApp/TerminalPage.h

@@ -174,7 +174,6 @@ namespace winrt::TerminalApp::implementation
         winrt::fire_and_forget _PasteFromClipboardHandler(const IInspectable sender,
                                                           const Microsoft::Terminal::TerminalControl::PasteFromClipboardEventArgs eventArgs);
 
-        void _WarningBellHandler(const IInspectable sender, const IInspectable eventArgs);
         void _OpenHyperlinkHandler(const IInspectable sender, const Microsoft::Terminal::TerminalControl::OpenHyperlinkEventArgs eventArgs);
         void _ShowCouldNotOpenDialog(winrt::hstring reason, winrt::hstring uri);
         bool _CopyText(const bool singleLine, const Windows::Foundation::IReference<Microsoft::Terminal::TerminalControl::CopyFormat>& formats);

src/cascadia/TerminalSettingsModel/Profile.cpp

@@ -57,6 +57,7 @@ static constexpr std::string_view BackgroundImageAlignmentKey{ "backgroundImageA
 static constexpr std::string_view RetroTerminalEffectKey{ "experimental.retroTerminalEffect" };
 static constexpr std::string_view AntialiasingModeKey{ "antialiasingMode" };
 static constexpr std::string_view TabColorKey{ "tabColor" };
+static constexpr std::string_view BellStyleKey{ "bellStyle" };
 
 static const winrt::hstring DesktopWallpaperEnum{ L"DesktopWallpaper" };
 
@@ -243,6 +244,8 @@ void Profile::LayerJson(const Json::Value& json)
     JsonUtils::GetValueForKey(json, AntialiasingModeKey, _AntialiasingMode);
 
     JsonUtils::GetValueForKey(json, TabColorKey, _TabColor);
+
+    JsonUtils::GetValueForKey(json, BellStyleKey, _BellStyle);
 }
 
 // Method Description:

src/cascadia/TerminalSettingsModel/Profile.h

@@ -115,6 +115,8 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         GETSET_PROPERTY(Microsoft::Terminal::TerminalControl::CursorStyle, CursorShape, Microsoft::Terminal::TerminalControl::CursorStyle::Bar);
         GETSET_PROPERTY(uint32_t, CursorHeight, DEFAULT_CURSOR_HEIGHT);
 
+        GETSET_PROPERTY(winrt::Microsoft::Terminal::Settings::Model::BellStyle, BellStyle, winrt::Microsoft::Terminal::Settings::Model::BellStyle::Audible);
+
     private:
         std::optional<winrt::guid> _Guid{ std::nullopt };
         std::optional<winrt::guid> _ConnectionType{ std::nullopt };

src/cascadia/TerminalSettingsModel/Profile.idl

@@ -10,6 +10,12 @@ namespace Microsoft.Terminal.Settings.Model
         Always
     };
 
+    enum BellStyle
+    {
+        None,
+        Audible
+    };
+
     [default_interface] runtimeclass Profile {
         Profile();
         Profile(Guid guid);
@@ -66,5 +72,7 @@ namespace Microsoft.Terminal.Settings.Model
 
         Microsoft.Terminal.TerminalControl.CursorStyle CursorShape;
         UInt32 CursorHeight;
+
+        BellStyle BellStyle;
     }
 }

src/cascadia/TerminalSettingsModel/TerminalSettingsSerializationHelpers.h

@@ -47,6 +47,14 @@ JSON_ENUM_MAPPER(::winrt::Microsoft::Terminal::TerminalControl::ScrollbarState)
     };
 };
 
+JSON_ENUM_MAPPER(::winrt::Microsoft::Terminal::Settings::Model::BellStyle)
+{
+    static constexpr std::array<pair_type, 2> mappings = {
+        pair_type{ "none", ValueType::None },
+        pair_type{ "audible", ValueType::Audible }
+    };
+};
+
 JSON_ENUM_MAPPER(std::tuple<::winrt::Windows::UI::Xaml::HorizontalAlignment, ::winrt::Windows::UI::Xaml::VerticalAlignment>)
 {
     // reduce repetition