Add Profile.BellSound to Settings UI

.github/actions/spelling/allow/allow.txt

@@ -21,6 +21,7 @@ dzhe
 Emacspeak
 Fitt
 FTCS
+flac
 gantt
 ghe
 gje

src/cascadia/TerminalSettingsEditor/CommonResources.xaml

@@ -106,6 +106,17 @@
         <Setter Property="TextWrapping" Value="Wrap" />
     </Style>
 
+    <!--  Text Block  -->
+    <Style x:Key="TextBlockSettingStyle"
+           BasedOn="{StaticResource BaseTextBlockStyle}"
+           TargetType="TextBlock">
+        <Setter Property="MinWidth" Value="{StaticResource StandardBoxMinWidth}" />
+        <Setter Property="MaxWidth" Value="400" />
+        <Setter Property="HorizontalAlignment" Value="Left" />
+        <Setter Property="VerticalAlignment" Value="Center" />
+        <Setter Property="TextWrapping" Value="Wrap" />
+    </Style>
+
     <Style x:Key="TextBlockSubHeaderStyle"
            BasedOn="{StaticResource SubtitleTextBlockStyle}"
            TargetType="TextBlock">

src/cascadia/TerminalSettingsEditor/MainPage.cpp

@@ -350,7 +350,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
                 }
                 else if (currentPage == ProfileSubPage::Advanced)
                 {
-                    contentFrame().Navigate(xaml_typename<Editor::Profiles_Advanced>(), profile);
+                    contentFrame().Navigate(xaml_typename<Editor::Profiles_Advanced>(), winrt::make<implementation::NavigateToProfileArgs>(profile, *this));
                     const auto crumb = winrt::make<Breadcrumb>(breadcrumbTag, RS_(L"Profile_Advanced/Header"), BreadcrumbSubPage::Profile_Advanced);
                     _breadcrumbs.Append(crumb);
                     SettingsMainPage_ScrollViewer().ScrollToVerticalOffset(0);

src/cascadia/TerminalSettingsEditor/ProfileViewModel.cpp

@@ -40,6 +40,8 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         INITIALIZE_BINDABLE_ENUM_SETTING_REVERSE_ORDER(CloseOnExitMode, CloseOnExitMode, winrt::Microsoft::Terminal::Settings::Model::CloseOnExitMode, L"Profile_CloseOnExit", L"Content");
         INITIALIZE_BINDABLE_ENUM_SETTING(ScrollState, ScrollbarState, winrt::Microsoft::Terminal::Control::ScrollbarState, L"Profile_ScrollbarVisibility", L"Content");
 
+        _InitializeCurrentBellSounds();
+
         // Add a property changed handler to our own property changed event.
         // This propagates changes from the settings model to anybody listening to our
         //  unique view model members.
@@ -76,6 +78,21 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
             {
                 _NotifyChanges(L"HideIcon");
             }
+            else if (viewModelProperty == L"CurrentBellSounds")
+            {
+                // we already have infrastructure in place to
+                // propagate changes from the CurrentBellSounds
+                // to the model. Refer to...
+                // - _InitializeCurrentBellSounds() --> _CurrentBellSounds.VectorChanged()
+                // - RequestAddBellSound()
+                // - RequestDeleteBellSound()
+                _MarkDuplicateBellSoundDirectories();
+                _NotifyChanges(L"BellSoundPreview", L"HasBellSound");
+            }
+            else if (viewModelProperty == L"BellSound")
+            {
+                _InitializeCurrentBellSounds();
+            }
         });
 
         // Do the same for the starting directory
@@ -374,6 +391,150 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         BellStyle(currentStyle);
     }
 
+    // Method Description:
+    // - Construct _CurrentBellSounds by importing the _inherited_ value from the model
+    // - Adds a PropertyChanged handler to each BellSoundViewModel to propagate changes to the model
+    void ProfileViewModel::_InitializeCurrentBellSounds()
+    {
+        _CurrentBellSounds = winrt::single_threaded_observable_vector<Editor::BellSoundViewModel>();
+        if (const auto soundList = _profile.BellSound())
+        {
+            for (const auto&& bellSound : soundList)
+            {
+                auto vm = winrt::make<BellSoundViewModel>(bellSound);
+                vm.PropertyChanged({ this, &ProfileViewModel::_BellSoundVMPropertyChanged });
+                _CurrentBellSounds.Append(vm);
+            }
+        }
+        _MarkDuplicateBellSoundDirectories();
+        _NotifyChanges(L"CurrentBellSounds");
+    }
+
+    // Method Description:
+    // - If the current layer is inheriting the bell sound from its parent,
+    //   we need to copy the _inherited_ bell sound list to the current layer
+    //   so that we can then apply modifications to it
+    void ProfileViewModel::_PrepareModelForBellSoundModification()
+    {
+        if (const auto inheritedSounds = _profile.BellSound(); !_profile.HasBellSound() && inheritedSounds)
+        {
+            auto newSounds{ winrt::single_threaded_vector<winrt::hstring>() };
+            for (const auto sound : inheritedSounds)
+            {
+                newSounds.Append(sound);
+            }
+            _profile.BellSound(newSounds);
+        }
+    }
+
+    void ProfileViewModel::_MarkDuplicateBellSoundDirectories()
+    {
+        for (uint32_t i = 0; i < _CurrentBellSounds.Size(); i++)
+        {
+            auto soundA = _CurrentBellSounds.GetAt(i);
+            for (uint32_t j = i + 1; j < _CurrentBellSounds.Size(); j++)
+            {
+                auto soundB = _CurrentBellSounds.GetAt(j);
+                if (soundA.DisplayPath() == soundB.DisplayPath())
+                {
+                    get_self<BellSoundViewModel>(_CurrentBellSounds.GetAt(i))->ShowDirectory(true);
+                    get_self<BellSoundViewModel>(_CurrentBellSounds.GetAt(j))->ShowDirectory(true);
+                }
+            }
+        }
+    }
+
+    hstring BellSoundViewModel::DisplayPath() const
+    {
+        if (FileExists())
+        {
+            // filename
+            std::filesystem::path filePath{ std::wstring_view{ _Path } };
+            return hstring{ filePath.filename().wstring() };
+        }
+        return _Path;
+    }
+
+    hstring BellSoundViewModel::SubText() const
+    {
+        if (FileExists())
+        {
+            // Directory
+            std::filesystem::path filePath{ std::wstring_view{ _Path } };
+            return hstring{ filePath.parent_path().wstring() };
+        }
+        return RS_(L"Profile_BellSoundNotFound");
+    }
+
+    bool BellSoundViewModel::FileExists() const
+    {
+        return std::filesystem::exists(std::wstring_view{ _Path });
+    }
+
+    hstring ProfileViewModel::BellSoundPreview()
+    {
+        const auto& currentSound = BellSound();
+        if (!currentSound || currentSound.Size() == 0)
+        {
+            return RS_(L"Profile_BellSoundPreviewDefault");
+        }
+        else if (currentSound.Size() == 1)
+        {
+            std::filesystem::path filePath{ std::wstring_view{ currentSound.GetAt(0) } };
+            return hstring{ filePath.filename().wstring() };
+        }
+        return RS_(L"Profile_BellSoundPreviewMultiple");
+    }
+
+    void ProfileViewModel::_BellSoundVMPropertyChanged(const IInspectable& sender, const PropertyChangedEventArgs& args)
+    {
+        if (args.PropertyName() == L"Path")
+        {
+            auto senderVM = sender.as<Editor::BellSoundViewModel>();
+
+            // propagate changes to model
+            uint32_t index;
+            if (_CurrentBellSounds.IndexOf(senderVM, index))
+            {
+                // if current layer is inheriting,
+                // we should copy the bell sound then apply changes
+                _PrepareModelForBellSoundModification();
+
+                _profile.BellSound().SetAt(index, senderVM.Path());
+                _NotifyChanges(L"CurrentBellSounds");
+            }
+        }
+    }
+
+    void ProfileViewModel::RequestAddBellSound(hstring path)
+    {
+        // If we were inheriting our bell sound,
+        // copy it over to the current layer and apply modifications
+        _PrepareModelForBellSoundModification();
+
+        auto vm = winrt::make<BellSoundViewModel>();
+        vm.Path(path);
+        vm.PropertyChanged({ this, &ProfileViewModel::_BellSoundVMPropertyChanged });
+        _CurrentBellSounds.Append(vm);
+        _profile.BellSound().Append(path);
+        _NotifyChanges(L"CurrentBellSounds");
+    }
+
+    void ProfileViewModel::RequestDeleteBellSound(const Editor::BellSoundViewModel& vm)
+    {
+        uint32_t index;
+        if (_CurrentBellSounds.IndexOf(vm, index))
+        {
+            // If we were inheriting our bell sound,
+            // copy it over to the current layer and apply modifications
+            _PrepareModelForBellSoundModification();
+
+            _CurrentBellSounds.RemoveAt(index);
+            _profile.BellSound().RemoveAt(index);
+            _NotifyChanges(L"CurrentBellSounds");
+        }
+    }
+
     void ProfileViewModel::DeleteProfile()
     {
         auto deleteProfileArgs{ winrt::make_self<DeleteProfileEventArgs>(Guid()) };

src/cascadia/TerminalSettingsEditor/ProfileViewModel.h

@@ -5,6 +5,7 @@
 
 #include "DeleteProfileEventArgs.g.h"
 #include "NavigateToProfileArgs.g.h"
+#include "BellSoundViewModel.g.h"
 #include "ProfileViewModel.g.h"
 #include "Utils.h"
 #include "ViewModelHelpers.h"
@@ -26,6 +27,28 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         Editor::ProfileViewModel _Profile{ nullptr };
     };
 
+    struct BellSoundViewModel : BellSoundViewModelT<BellSoundViewModel>, ViewModelHelper<BellSoundViewModel>
+    {
+    public:
+        BellSoundViewModel() = default;
+        BellSoundViewModel(hstring path) :
+            _Path{ path }
+        {
+            PropertyChanged([this](auto&&, auto&& e) {
+                if (e.PropertyName() == L"Path")
+                {
+                    _NotifyChanges(L"DisplayPath", L"SubText", L"FileExists", L"ShowSubText");
+                }
+            });
+        }
+
+        hstring DisplayPath() const;
+        hstring SubText() const;
+        bool FileExists() const;
+        VIEW_MODEL_OBSERVABLE_PROPERTY(hstring, Path);
+        VIEW_MODEL_OBSERVABLE_PROPERTY(bool, ShowDirectory);
+    };
+
     struct ProfileViewModel : ProfileViewModelT<ProfileViewModel>, ViewModelHelper<ProfileViewModel>
     {
     public:
@@ -46,6 +69,10 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         void SetBellStyleWindow(winrt::Windows::Foundation::IReference<bool> on);
         void SetBellStyleTaskbar(winrt::Windows::Foundation::IReference<bool> on);
 
+        hstring BellSoundPreview();
+        void RequestAddBellSound(hstring path);
+        void RequestDeleteBellSound(const Editor::BellSoundViewModel& vm);
+
         void SetAcrylicOpacityPercentageValue(double value)
         {
             Opacity(static_cast<float>(value) / 100.0f);
@@ -88,6 +115,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         til::typed_event<Editor::ProfileViewModel, Editor::DeleteProfileEventArgs> DeleteProfileRequested;
 
         VIEW_MODEL_OBSERVABLE_PROPERTY(ProfileSubPage, CurrentPage);
+        VIEW_MODEL_OBSERVABLE_PROPERTY(Windows::Foundation::Collections::IObservableVector<Editor::BellSoundViewModel>, CurrentBellSounds);
 
         PERMANENT_OBSERVABLE_PROJECTED_SETTING(_profile, Guid);
         PERMANENT_OBSERVABLE_PROJECTED_SETTING(_profile, ConnectionType);
@@ -114,6 +142,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         OBSERVABLE_PROJECTED_SETTING(_profile, SnapOnInput);
         OBSERVABLE_PROJECTED_SETTING(_profile, AltGrAliasing);
         OBSERVABLE_PROJECTED_SETTING(_profile, BellStyle);
+        OBSERVABLE_PROJECTED_SETTING(_profile, BellSound);
         OBSERVABLE_PROJECTED_SETTING(_profile, Elevate);
         OBSERVABLE_PROJECTED_SETTING(_profile, ReloadEnvironmentVariables);
         OBSERVABLE_PROJECTED_SETTING(_profile, RightClickContextMenu);
@@ -139,6 +168,10 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         winrt::hstring _lastIcon;
         Editor::AppearanceViewModel _defaultAppearanceViewModel;
 
+        void _InitializeCurrentBellSounds();
+        void _PrepareModelForBellSoundModification();
+        void _MarkDuplicateBellSoundDirectories();
+        void _BellSoundVMPropertyChanged(const Windows::Foundation::IInspectable& sender, const Windows::UI::Xaml::Data::PropertyChangedEventArgs& args);
         static Windows::Foundation::Collections::IObservableVector<Editor::Font> _MonospaceFontList;
         static Windows::Foundation::Collections::IObservableVector<Editor::Font> _FontList;
 

src/cascadia/TerminalSettingsEditor/ProfileViewModel.idl

@@ -25,6 +25,15 @@ namespace Microsoft.Terminal.Settings.Editor
         Guid ProfileGuid { get; };
     }
 
+    runtimeclass BellSoundViewModel : Windows.UI.Xaml.Data.INotifyPropertyChanged
+    {
+        String Path;
+        String DisplayPath { get; };
+        String SubText { get; };
+        Boolean ShowDirectory { get; };
+        Boolean FileExists { get; };
+    }
+
     enum ProfileSubPage
     {
         Base = 0,
@@ -49,6 +58,11 @@ namespace Microsoft.Terminal.Settings.Editor
         void SetBellStyleWindow(Windows.Foundation.IReference<Boolean> on);
         void SetBellStyleTaskbar(Windows.Foundation.IReference<Boolean> on);
 
+        String BellSoundPreview { get; };
+        Windows.Foundation.Collections.IObservableVector<BellSoundViewModel> CurrentBellSounds { get; };
+        void RequestAddBellSound(String path);
+        void RequestDeleteBellSound(BellSoundViewModel vm);
+
         IInspectable CurrentAntiAliasingMode;
         Windows.Foundation.Collections.IObservableVector<Microsoft.Terminal.Settings.Editor.EnumEntry> AntiAliasingModeList { get; };
 
@@ -106,6 +120,7 @@ namespace Microsoft.Terminal.Settings.Editor
         OBSERVABLE_PROJECTED_PROFILE_SETTING(Boolean, SnapOnInput);
         OBSERVABLE_PROJECTED_PROFILE_SETTING(Boolean, AltGrAliasing);
         OBSERVABLE_PROJECTED_PROFILE_SETTING(Microsoft.Terminal.Settings.Model.BellStyle, BellStyle);
+        OBSERVABLE_PROJECTED_PROFILE_SETTING(Windows.Foundation.Collections.IVector<String>, BellSound);
         OBSERVABLE_PROJECTED_PROFILE_SETTING(Boolean, Elevate);
         OBSERVABLE_PROJECTED_PROFILE_SETTING(Boolean, ReloadEnvironmentVariables);
         OBSERVABLE_PROJECTED_PROFILE_SETTING(Boolean, RightClickContextMenu);