Add support for setting tabColor on the command line

doc/cascadia/profiles.schema.json

@@ -161,6 +161,11 @@
         "index": {
           "type": "integer",
           "description": "The index of the profile in the new tab dropdown (starting at 0)"
+        },
+        "tabColor": {
+          "$ref": "#/definitions/Color",
+          "default": null,
+          "description": "If provided, will set the tab's color to the given value"
         }
       },
       "type": "object"

src/cascadia/LocalTests_SettingsModel/KeyBindingsTests.cpp

@@ -408,7 +408,7 @@ namespace SettingsModelLocalTests
             // Verify the args have the expected value
             VERIFY_IS_NOT_NULL(realArgs.TabColor());
             // Remember that COLORREFs are actually BBGGRR order, while the string is in #RRGGBB order
-            VERIFY_ARE_EQUAL(static_cast<uint32_t>(til::color(0x563412)), realArgs.TabColor().Value());
+            VERIFY_ARE_EQUAL(til::color(0x563412), til::color(realArgs.TabColor().Value()));
         }
         {
             KeyChord kc{ true, false, false, static_cast<int32_t>('F') };

src/cascadia/TerminalApp/AppActionHandlers.cpp

@@ -350,23 +350,20 @@ namespace winrt::TerminalApp::implementation
     void TerminalPage::_HandleSetTabColor(const IInspectable& /*sender*/,
                                           const ActionEventArgs& args)
     {
-        std::optional<til::color> tabColor;
+        Windows::Foundation::IReference<Windows::UI::Color> tabColor;
 
         if (const auto& realArgs = args.ActionArgs().try_as<SetTabColorArgs>())
         {
-            if (realArgs.TabColor() != nullptr)
-            {
-                tabColor = realArgs.TabColor().Value();
-            }
+            tabColor = realArgs.TabColor();
         }
 
         if (auto focusedTab = _GetFocusedTab())
         {
             if (auto activeTab = _GetTerminalTabImpl(focusedTab))
             {
-                if (tabColor.has_value())
+                if (tabColor)
                 {
-                    activeTab->SetRuntimeTabColor(tabColor.value());
+                    activeTab->SetRuntimeTabColor(tabColor.Value());
                 }
                 else
                 {

src/cascadia/TerminalApp/AppCommandlineArgs.cpp

@@ -4,6 +4,7 @@
 #include "pch.h"
 #include "AppLogic.h"
 #include "AppCommandlineArgs.h"
+#include "../types/inc/utils.hpp"
 #include <LibraryResources.h>
 
 using namespace winrt::TerminalApp;
@@ -367,6 +368,10 @@ void AppCommandlineArgs::_addNewTerminalArgs(AppCommandlineArgs::NewTerminalSubc
                                                                _startingTitle,
                                                                RS_A(L"CmdTitleArgDesc"));
 
+    subcommand.tabColorOption = subcommand.subcommand->add_option("--tabColor",
+                                                                  _startingTabColor,
+                                                                  RS_A(L"CmdTabColorArgDesc"));
+
     // Using positionals_at_end allows us to support "wt new-tab -d wsl -d Ubuntu"
     // without CLI11 thinking that we've specified -d twice.
     // There's an alternate construction where we make all subcommands "prefix commands",
@@ -428,6 +433,12 @@ NewTerminalArgs AppCommandlineArgs::_getNewTerminalArgs(AppCommandlineArgs::NewT
         args.TabTitle(winrt::to_hstring(_startingTitle));
     }
 
+    if (*subcommand.tabColorOption)
+    {
+        const auto tabColor = Microsoft::Console::Utils::ColorFromHexString(_startingTabColor);
+        args.TabColor(static_cast<winrt::Windows::UI::Color>(tabColor));
+    }
+
     return args;
 }
 
@@ -462,6 +473,7 @@ void AppCommandlineArgs::_resetStateToDefault()
     _profileName.clear();
     _startingDirectory.clear();
     _startingTitle.clear();
+    _startingTabColor.clear();
     _commandline.clear();
 
     _splitVertical = false;

src/cascadia/TerminalApp/AppCommandlineArgs.h

@@ -54,6 +54,7 @@ class TerminalApp::AppCommandlineArgs final
         CLI::Option* profileNameOption;
         CLI::Option* startingDirectoryOption;
         CLI::Option* titleOption;
+        CLI::Option* tabColorOption;
     };
 
     struct NewPaneSubcommand : public NewTerminalSubcommand
@@ -74,6 +75,7 @@ class TerminalApp::AppCommandlineArgs final
     std::string _profileName;
     std::string _startingDirectory;
     std::string _startingTitle;
+    std::string _startingTabColor;
 
     // _commandline will contain the command line with which we'll be spawning a new terminal
     std::vector<std::string> _commandline;

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

@@ -295,6 +295,9 @@
     <value>Open the terminal with the provided title instead of the profile's set "title"</value>
     <comment>{Locked="\"title\""}</comment>
   </data>
+  <data name="CmdTabColorArgDesc" xml:space="preserve">
+    <value>Open the terminal with the tab color, in #rrggbb format</value>
+  </data>
   <data name="CmdVersionDesc" xml:space="preserve">
     <value>Display the application version</value>
   </data>

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -603,7 +603,13 @@ namespace winrt::TerminalApp::implementation
     {
         auto [profileGuid, settings] = TerminalSettings::BuildSettings(_settings, newTerminalArgs, *_bindings);
 
-        _CreateNewTabFromSettings(profileGuid, settings);
+        const auto newTab = _CreateNewTabFromSettings(profileGuid, settings);
+        if (newTerminalArgs && newTerminalArgs.TabColor())
+        {
+            // We set the tab color we got from terminal arguments
+            // as runtime color so it won't be reset upon settings reload
+            _GetTerminalTabImpl(newTab)->SetRuntimeTabColor(newTerminalArgs.TabColor().Value());
+        }
 
         const uint32_t tabCount = _tabs.Size();
         const bool usedManualProfile = (newTerminalArgs != nullptr) &&
@@ -645,7 +651,7 @@ namespace winrt::TerminalApp::implementation
     //      currently displayed, it will be shown.
     // Arguments:
     // - settings: the TerminalSettings object to use to create the TerminalControl with.
-    void TerminalPage::_CreateNewTabFromSettings(GUID profileGuid, TerminalApp::TerminalSettings settings)
+    TerminalApp::TerminalTab TerminalPage::_CreateNewTabFromSettings(GUID profileGuid, TerminalApp::TerminalSettings settings)
     {
         // Initialize the new tab
 
@@ -733,6 +739,7 @@ namespace winrt::TerminalApp::implementation
         // This kicks off TabView::SelectionChanged, in response to which
         // we'll attach the terminal's Xaml control to the Xaml root.
         _tabView.SelectedItem(tabViewItem);
+        return *newTabImpl;
     }
 
     // Method Description:

src/cascadia/TerminalApp/TerminalPage.h

@@ -135,7 +135,7 @@ namespace winrt::TerminalApp::implementation
         void _CreateNewTabFlyout();
         void _OpenNewTabDropdown();
         void _OpenNewTab(const Microsoft::Terminal::Settings::Model::NewTerminalArgs& newTerminalArgs);
-        void _CreateNewTabFromSettings(GUID profileGuid, TerminalApp::TerminalSettings settings);
+        TerminalApp::TerminalTab _CreateNewTabFromSettings(GUID profileGuid, TerminalApp::TerminalSettings settings);
         winrt::Microsoft::Terminal::TerminalConnection::ITerminalConnection _CreateConnectionFromSettings(GUID profileGuid, TerminalApp::TerminalSettings settings);
 
         bool _displayingCloseDialog{ false };

src/cascadia/TerminalSettingsModel/ActionArgs.cpp

@@ -56,6 +56,13 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         {
             ss << fmt::format(L"title: {}, ", _TabTitle);
         }
+
+        if (_TabColor)
+        {
+            const til::color tabColor{ _TabColor.Value() };
+            ss << fmt::format(L"tabColor: {}, ", tabColor.ToHexString(true));
+        }
+
         auto s = ss.str();
         if (s.empty())
         {
@@ -300,10 +307,10 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         // "Reset tab color"
         if (_TabColor)
         {
-            til::color c{ _TabColor.Value() };
+            til::color tabColor{ _TabColor.Value() };
             return winrt::hstring{
                 fmt::format(std::wstring_view(RS_(L"SetTabColorCommandKey")),
-                            c.ToHexString(true))
+                            tabColor.ToHexString(true))
             };
         }
 

src/cascadia/TerminalSettingsModel/ActionArgs.h

@@ -60,12 +60,14 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         GETSET_PROPERTY(winrt::hstring, Commandline, L"");
         GETSET_PROPERTY(winrt::hstring, StartingDirectory, L"");
         GETSET_PROPERTY(winrt::hstring, TabTitle, L"");
+        GETSET_PROPERTY(Windows::Foundation::IReference<Windows::UI::Color>, TabColor, nullptr);
         GETSET_PROPERTY(Windows::Foundation::IReference<int32_t>, ProfileIndex, nullptr);
         GETSET_PROPERTY(winrt::hstring, Profile, L"");
 
         static constexpr std::string_view CommandlineKey{ "commandline" };
         static constexpr std::string_view StartingDirectoryKey{ "startingDirectory" };
         static constexpr std::string_view TabTitleKey{ "tabTitle" };
+        static constexpr std::string_view TabColorKey{ "tabColor" };
         static constexpr std::string_view ProfileIndexKey{ "index" };
         static constexpr std::string_view ProfileKey{ "profile" };
 
@@ -77,6 +79,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
             return other.Commandline() == _Commandline &&
                    other.StartingDirectory() == _StartingDirectory &&
                    other.TabTitle() == _TabTitle &&
+                   other.TabColor() == _TabColor &&
                    other.ProfileIndex() == _ProfileIndex &&
                    other.Profile() == _Profile;
         };
@@ -89,6 +92,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
             JsonUtils::GetValueForKey(json, TabTitleKey, args->_TabTitle);
             JsonUtils::GetValueForKey(json, ProfileIndexKey, args->_ProfileIndex);
             JsonUtils::GetValueForKey(json, ProfileKey, args->_Profile);
+            JsonUtils::GetValueForKey(json, TabColorKey, args->_TabColor);
             return *args;
         }
         Model::NewTerminalArgs Copy() const
@@ -97,6 +101,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
             copy->_Commandline = _Commandline;
             copy->_StartingDirectory = _StartingDirectory;
             copy->_TabTitle = _TabTitle;
+            copy->_TabColor = _TabColor;
             copy->_ProfileIndex = _ProfileIndex;
             copy->_Profile = _Profile;
             return *copy;
@@ -493,7 +498,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
     struct SetTabColorArgs : public SetTabColorArgsT<SetTabColorArgs>
     {
         SetTabColorArgs() = default;
-        GETSET_PROPERTY(Windows::Foundation::IReference<uint32_t>, TabColor, nullptr);
+        GETSET_PROPERTY(Windows::Foundation::IReference<Windows::UI::Color>, TabColor, nullptr);
 
         static constexpr std::string_view ColorKey{ "color" };
 
@@ -513,10 +518,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         {
             // LOAD BEARING: Not using make_self here _will_ break you in the future!
             auto args = winrt::make_self<SetTabColorArgs>();
-            if (const auto temp{ JsonUtils::GetValueForKey<std::optional<til::color>>(json, ColorKey) })
-            {
-                args->_TabColor = static_cast<uint32_t>(*temp);
-            }
+            JsonUtils::GetValueForKey(json, ColorKey, args->_TabColor);
             return { *args, {} };
         }
         IActionArgs Copy() const

src/cascadia/TerminalSettingsModel/ActionArgs.idl

@@ -54,6 +54,7 @@ namespace Microsoft.Terminal.Settings.Model
         String Commandline;
         String StartingDirectory;
         String TabTitle;
+        Windows.Foundation.IReference<Windows.UI.Color> TabColor;
         String Profile; // Either a GUID or a profile's name if the GUID isn't a match
         // ProfileIndex can be null (for "use the default"), so this needs to be
         // a IReference, so it's nullable
@@ -130,7 +131,7 @@ namespace Microsoft.Terminal.Settings.Model
 
     [default_interface] runtimeclass SetTabColorArgs : IActionArgs
     {
-        Windows.Foundation.IReference<UInt32> TabColor { get; };
+        Windows.Foundation.IReference<Windows.UI.Color> TabColor { get; };
     };
 
     [default_interface] runtimeclass RenameTabArgs : IActionArgs