Add a progress ring indicator to the tab header

src/cascadia/TerminalApp/TabHeaderControl.h

@@ -23,6 +23,9 @@ namespace winrt::TerminalApp::implementation
         WINRT_CALLBACK(PropertyChanged, Windows::UI::Xaml::Data::PropertyChangedEventHandler);
         OBSERVABLE_GETSET_PROPERTY(winrt::hstring, Title, _PropertyChangedHandlers);
         OBSERVABLE_GETSET_PROPERTY(bool, IsPaneZoomed, _PropertyChangedHandlers);
+        OBSERVABLE_GETSET_PROPERTY(bool, IsProgressRingActive, _PropertyChangedHandlers);
+        OBSERVABLE_GETSET_PROPERTY(bool, IsProgressRingIndeterminate, _PropertyChangedHandlers);
+        OBSERVABLE_GETSET_PROPERTY(uint32_t, ProgressValue, _PropertyChangedHandlers);
 
     private:
         bool _receivedKeyDown{ false };

src/cascadia/TerminalApp/TabHeaderControl.idl

@@ -9,6 +9,9 @@ namespace TerminalApp
     {
         String Title { get; set; };
         Boolean IsPaneZoomed { get; set; };
+        Boolean IsProgressRingActive { get; set; };
+        Boolean IsProgressRingIndeterminate { get; set; };
+        UInt32 ProgressValue { get; set; };
 
         TabHeaderControl();
         void BeginRename();

src/cascadia/TerminalApp/TabHeaderControl.xaml

@@ -1,16 +1,31 @@
 <!-- Copyright (c) Microsoft Corporation. All rights reserved. Licensed under
 the MIT License. See LICENSE in the project root for license information. -->
+
 <UserControl
     x:Class="TerminalApp.TabHeaderControl"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
     xmlns:local="using:TerminalApp"
+    xmlns:mux="using:Microsoft.UI.Xaml.Controls"
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
     xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
     mc:Ignorable="d">
 
     <StackPanel x:Name="HeaderStackPanel"
                 Orientation="Horizontal">
+        <mux:ProgressRing x:Name="HeaderProgressRing"
+                          IsActive="{x:Bind IsProgressRingActive, Mode=OneWay}"
+                          Visibility="{x:Bind IsProgressRingActive, Mode=OneWay}"
+                          IsIndeterminate="{x:Bind IsProgressRingIndeterminate, Mode=OneWay}"
+                          Value="{x:Bind ProgressValue, Mode=OneWay}"
+                          MinHeight="0"
+                          MinWidth="0"
+                          Height="15"
+                          Width="15"
+                          Margin="-7.5,0,8,0"/>
+        <!--We want the progress ring to 'replace' the tab icon, but we don't have control
+        over the tab icon here (the tab view item does) - so we hide the tab icon there
+        and use a negative margin for the progress ring here to put it where the icon would be-->
         <FontIcon x:Name="HeaderZoomIcon"
                   FontFamily="Segoe MDL2 Assets"
                   Visibility="{x:Bind IsPaneZoomed, Mode=OneWay}"

src/cascadia/TerminalApp/TerminalSettings.cpp

@@ -208,6 +208,7 @@ namespace winrt::TerminalApp::implementation
         _ForceFullRepaintRendering = globalSettings.ForceFullRepaintRendering();
         _SoftwareRendering = globalSettings.SoftwareRendering();
         _ForceVTInput = globalSettings.ForceVTInput();
+        _DisableProgressRing = globalSettings.DisableProgressRing();
     }
 
     // Method Description:

src/cascadia/TerminalApp/TerminalSettings.h

@@ -120,6 +120,7 @@ namespace winrt::TerminalApp::implementation
         GETSET_PROPERTY(bool, ForceFullRepaintRendering, false);
         GETSET_PROPERTY(bool, SoftwareRendering, false);
         GETSET_PROPERTY(bool, ForceVTInput, false);
+        GETSET_PROPERTY(bool, DisableProgressRing, false);
 
 #pragma warning(pop)
 

src/cascadia/TerminalApp/TerminalTab.cpp

@@ -176,6 +176,13 @@ namespace winrt::TerminalApp::implementation
 
         _lastIconPath = iconPath;
 
+        // If the icon is currently hidden, just return here (but only after setting _lastIconPath to the new path
+        // for when we show the icon again)
+        if (_iconHidden)
+        {
+            return;
+        }
+
         auto weakThis{ get_weak() };
 
         co_await winrt::resume_foreground(TabViewItem().Dispatcher());
@@ -191,6 +198,34 @@ namespace winrt::TerminalApp::implementation
         }
     }
 
+    // Method Description:
+    // - Hide or show the tab icon for this tab
+    // - Used when we want to show the progress ring, which should replace the icon
+    // Arguments:
+    // - hide: if true, we hide the icon; if false, we show the icon
+    winrt::fire_and_forget TerminalTab::HideIcon(const bool hide)
+    {
+        auto weakThis{ get_weak() };
+
+        co_await winrt::resume_foreground(TabViewItem().Dispatcher());
+
+        if (auto tab{ weakThis.get() })
+        {
+            if (hide)
+            {
+                Icon({});
+                TabViewItem().IconSource(IconPathConverter::IconSourceMUX({}));
+                tab->_iconHidden = true;
+            }
+            else
+            {
+                Icon(_lastIconPath);
+                TabViewItem().IconSource(IconPathConverter::IconSourceMUX(_lastIconPath));
+                tab->_iconHidden = false;
+            }
+        }
+    }
+
     // Method Description:
     // - Gets the title string of the last focused terminal control in our tree.
     //   Returns the empty string if there is no such control.
@@ -430,6 +465,39 @@ namespace winrt::TerminalApp::implementation
                 tab->_RecalculateAndApplyTabColor();
             }
         });
+
+        control.SetTaskbarProgress([weakThis](auto&&, auto&&) {
+            // Check if Tab's lifetime has expired
+            if (auto tab{ weakThis.get() })
+            {
+                // The progress of the control changed, but not necessarily the progress of the tab.
+                // Set the tab's progress ring to the active pane's progress
+                if (!tab->GetActiveTerminalControl().Settings().DisableProgressRing())
+                {
+                    if (tab->GetActiveTerminalControl().TaskbarState() > 0)
+                    {
+                        if (tab->GetActiveTerminalControl().TaskbarState() == 3)
+                        {
+                            // 3 is the indeterminate state, set the progress ring as such
+                            tab->_headerControl.IsProgressRingIndeterminate(true);
+                        }
+                        else
+                        {
+                            // any non-indeterminate state has a value, set the progress ring as such
+                            tab->_headerControl.IsProgressRingIndeterminate(false);
+                            tab->_headerControl.ProgressValue(gsl::narrow<uint32_t>(tab->GetActiveTerminalControl().TaskbarProgress()));
+                        }
+                        tab->HideIcon(true);
+                        tab->_headerControl.IsProgressRingActive(true);
+                    }
+                    else
+                    {
+                        tab->HideIcon(false);
+                        tab->_headerControl.IsProgressRingActive(false);
+                    }
+                }
+            }
+        });
     }
 
     // Method Description:

src/cascadia/TerminalApp/TerminalTab.h

@@ -34,6 +34,7 @@ namespace winrt::TerminalApp::implementation
         void SplitPane(winrt::Microsoft::Terminal::Settings::Model::SplitState splitType, const GUID& profile, winrt::Microsoft::Terminal::TerminalControl::TermControl& control);
 
         winrt::fire_and_forget UpdateIcon(const winrt::hstring iconPath);
+        winrt::fire_and_forget HideIcon(const bool hide);
 
         float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
         winrt::Microsoft::Terminal::Settings::Model::SplitState PreCalculateAutoSplit(winrt::Windows::Foundation::Size rootSize) const;
@@ -84,6 +85,7 @@ namespace winrt::TerminalApp::implementation
         winrt::TerminalApp::TabHeaderControl _headerControl{};
 
         bool _receivedKeyDown{ false };
+        bool _iconHidden{ false };
 
         winrt::hstring _runtimeTabText{};
         bool _inRename{ false };

src/cascadia/TerminalControl/IControlSettings.idl

@@ -57,5 +57,7 @@ namespace Microsoft.Terminal.TerminalControl
         Boolean RetroTerminalEffect;
         Boolean ForceFullRepaintRendering;
         Boolean SoftwareRendering;
+
+        Boolean DisableProgressRing;
     };
 }

src/cascadia/TerminalSettingsModel/GlobalAppSettings.cpp

@@ -40,6 +40,7 @@ static constexpr std::string_view AlwaysOnTopKey{ "alwaysOnTop" };
 static constexpr std::string_view LegacyUseTabSwitcherModeKey{ "useTabSwitcher" };
 static constexpr std::string_view TabSwitcherModeKey{ "tabSwitcherMode" };
 static constexpr std::string_view DisableAnimationsKey{ "disableAnimations" };
+static constexpr std::string_view DisableProgressRingKey{ "disableProgressRing" };
 
 static constexpr std::string_view DebugFeaturesKey{ "debugFeatures" };
 
@@ -114,6 +115,7 @@ winrt::com_ptr<GlobalAppSettings> GlobalAppSettings::Copy() const
     globals->_AlwaysOnTop = _AlwaysOnTop;
     globals->_TabSwitcherMode = _TabSwitcherMode;
     globals->_DisableAnimations = _DisableAnimations;
+    globals->_DisableProgressRing = _DisableProgressRing;
 
     globals->_UnparsedDefaultProfile = _UnparsedDefaultProfile;
     globals->_validDefaultProfile = _validDefaultProfile;
@@ -299,6 +301,8 @@ void GlobalAppSettings::LayerJson(const Json::Value& json)
 
     JsonUtils::GetValueForKey(json, DisableAnimationsKey, _DisableAnimations);
 
+    JsonUtils::GetValueForKey(json, DisableProgressRingKey, _DisableProgressRing);
+
     // This is a helper lambda to get the keybindings and commands out of both
     // and array of objects. We'll use this twice, once on the legacy
     // `keybindings` key, and again on the newer `bindings` key.

src/cascadia/TerminalSettingsModel/GlobalAppSettings.h

@@ -85,6 +85,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         GETSET_SETTING(bool, AlwaysOnTop, false);
         GETSET_SETTING(Model::TabSwitcherMode, TabSwitcherMode, Model::TabSwitcherMode::InOrder);
         GETSET_SETTING(bool, DisableAnimations, false);
+        GETSET_SETTING(bool, DisableProgressRing, false);
 
     private:
         guid _defaultProfile;

src/cascadia/TerminalSettingsModel/GlobalAppSettings.idl

@@ -135,6 +135,10 @@ namespace Microsoft.Terminal.Settings.Model
         void ClearDisableAnimations();
         Boolean DisableAnimations;
 
+        Boolean HasDisableProgressRing();
+        void ClearDisableProgressRing();
+        Boolean DisableProgressRing;
+
         Windows.Foundation.Collections.IMapView<String, ColorScheme> ColorSchemes();
         void AddColorScheme(ColorScheme scheme);
 

src/cascadia/TerminalSettingsModel/defaults.json

@@ -26,6 +26,7 @@
     "theme": "system",
     "snapToGridOnResize": true,
     "disableAnimations": false,
+    "disableProgressRing": false,
 
     "profiles":
     [