Add tab width modes: equal and titleLength (#3876)

* tab sizing functionality

* Update doc/cascadia/SettingsSchema.md

Co-Authored-By: Carlos Zamora <[email protected]>

* updated variable names to match spec

* added to defaults.json

* fixed merge conflict

Co-authored-by: Carlos Zamora <[email protected]>

Author: cinnamon-msft

doc/cascadia/SettingsSchema.md

@@ -323,6 +323,15 @@
           "description": "When set to `true`, the window will snap to the nearest character boundary on resize. When `false`, the window will resize 'smoothly'",
           "type": "boolean"
         },
+        "tabWidthMode": {
+          "default": "equal",
+          "description": "Sets the width of the tabs.",
+          "enum": [
+            "equal",
+            "titleLength"
+          ],
+          "type": "string"
+        },
         "wordDelimiters": {
           "default": " ./\\()\"'-:,.;<>~!@#$%^&*|+=[]{}~?│",
           "description": "Determines the delimiters used in a double click selection.",

doc/cascadia/profiles.schema.json

@@ -15,6 +15,7 @@ using namespace winrt::TerminalApp;
 using namespace winrt::Windows::Data::Json;
 using namespace winrt::Windows::UI::Xaml;
 using namespace ::Microsoft::Console;
+using namespace winrt::Microsoft::UI::Xaml::Controls;
 
 static constexpr std::string_view KeybindingsKey{ "keybindings" };
 static constexpr std::string_view DefaultProfileKey{ "defaultProfile" };
@@ -25,6 +26,9 @@ static constexpr std::string_view RowsToScrollKey{ "rowsToScroll" };
 static constexpr std::string_view InitialPositionKey{ "initialPosition" };
 static constexpr std::string_view ShowTitleInTitlebarKey{ "showTerminalTitleInTitlebar" };
 static constexpr std::string_view RequestedThemeKey{ "requestedTheme" };
+static constexpr std::string_view TabWidthModeKey{ "tabWidthMode" };
+static constexpr std::wstring_view EqualTabWidthModeValue{ L"equal" };
+static constexpr std::wstring_view TitleLengthTabWidthModeValue{ L"titleLength" };
 static constexpr std::string_view ShowTabsInTitlebarKey{ "showTabsInTitlebar" };
 static constexpr std::string_view WordDelimitersKey{ "wordDelimiters" };
 static constexpr std::string_view CopyOnSelectKey{ "copyOnSelect" };
@@ -49,6 +53,7 @@ GlobalAppSettings::GlobalAppSettings() :
     _showTitleInTitlebar{ true },
     _showTabsInTitlebar{ true },
     _requestedTheme{ ElementTheme::Default },
+    _tabWidthMode{ TabViewWidthMode::Equal },
     _wordDelimiters{ DEFAULT_WORD_DELIMITERS },
     _copyOnSelect{ false },
     _launchMode{ LaunchMode::DefaultMode }
@@ -114,6 +119,16 @@ void GlobalAppSettings::SetRequestedTheme(const ElementTheme requestedTheme) noe
     _requestedTheme = requestedTheme;
 }
 
+TabViewWidthMode GlobalAppSettings::GetTabWidthMode() const noexcept
+{
+    return _tabWidthMode;
+}
+
+void GlobalAppSettings::SetTabWidthMode(const TabViewWidthMode tabWidthMode)
+{
+    _tabWidthMode = tabWidthMode;
+}
+
 std::wstring GlobalAppSettings::GetWordDelimiters() const noexcept
 {
     return _wordDelimiters;
@@ -206,6 +221,7 @@ Json::Value GlobalAppSettings::ToJson() const
     jsonObject[JsonKey(CopyOnSelectKey)] = _copyOnSelect;
     jsonObject[JsonKey(LaunchModeKey)] = winrt::to_string(_SerializeLaunchMode(_launchMode));
     jsonObject[JsonKey(RequestedThemeKey)] = winrt::to_string(_SerializeTheme(_requestedTheme));
+    jsonObject[JsonKey(TabWidthModeKey)] = winrt::to_string(_SerializeTabWidthMode(_tabWidthMode));
     jsonObject[JsonKey(KeybindingsKey)] = _keybindings->ToJson();
     jsonObject[JsonKey(SnapToGridOnResizeKey)] = _SnapToGridOnResize;
 
@@ -291,6 +307,11 @@ void GlobalAppSettings::LayerJson(const Json::Value& json)
         _requestedTheme = _ParseTheme(GetWstringFromJson(requestedTheme));
     }
 
+    if (auto tabWidthMode{ json[JsonKey(TabWidthModeKey)] })
+    {
+        _tabWidthMode = _ParseTabWidthMode(GetWstringFromJson(tabWidthMode));
+    }
+
     if (auto keybindings{ json[JsonKey(KeybindingsKey)] })
     {
         _keybindings->LayerJson(keybindings);
@@ -454,6 +475,41 @@ std::wstring_view GlobalAppSettings::_SerializeLaunchMode(const LaunchMode launc
     }
 }
 
+// Method Description:
+// - Helper function for converting the user-specified tab width
+//   to a TabViewWidthMode enum value
+// Arguments:
+// - tabWidthModeString: The string value from the settings file to parse
+// Return Value:
+// - The corresponding enum value which maps to the string provided by the user
+TabViewWidthMode GlobalAppSettings::_ParseTabWidthMode(const std::wstring& tabWidthModeString) noexcept
+{
+    if (tabWidthModeString == TitleLengthTabWidthModeValue)
+    {
+        return TabViewWidthMode::SizeToContent;
+    }
+    // default behavior for invalid data or EqualTabWidthValue
+    return TabViewWidthMode::Equal;
+}
+
+// Method Description:
+// - Helper function for converting a TabViewWidthMode to its corresponding string
+//   value.
+// Arguments:
+// - tabWidthMode: The enum value to convert to a string.
+// Return Value:
+// - The string value for the given TabWidthMode
+std::wstring_view GlobalAppSettings::_SerializeTabWidthMode(const TabViewWidthMode tabWidthMode) noexcept
+{
+    switch (tabWidthMode)
+    {
+    case TabViewWidthMode::SizeToContent:
+        return TitleLengthTabWidthModeValue;
+    default:
+        return EqualTabWidthModeValue;
+    }
+}
+
 // Method Description:
 // - Adds the given colorscheme to our map of schemes, using its name as the key.
 // Arguments:

src/cascadia/TerminalApp/GlobalAppSettings.cpp

@@ -52,6 +52,8 @@ class TerminalApp::GlobalAppSettings final
 
     void SetRequestedTheme(const winrt::Windows::UI::Xaml::ElementTheme requestedTheme) noexcept;
 
+    void SetTabWidthMode(const winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode tabWidthMode);
+
     bool GetShowTabsInTitlebar() const noexcept;
     void SetShowTabsInTitlebar(const bool showTabsInTitlebar) noexcept;
 
@@ -70,6 +72,8 @@ class TerminalApp::GlobalAppSettings final
 
     winrt::Windows::UI::Xaml::ElementTheme GetRequestedTheme() const noexcept;
 
+    winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode GetTabWidthMode() const noexcept;
+
     Json::Value ToJson() const;
     static GlobalAppSettings FromJson(const Json::Value& json);
     void LayerJson(const Json::Value& json);
@@ -100,12 +104,16 @@ class TerminalApp::GlobalAppSettings final
     std::wstring _wordDelimiters;
     bool _copyOnSelect;
     winrt::Windows::UI::Xaml::ElementTheme _requestedTheme;
+    winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode _tabWidthMode;
 
     winrt::TerminalApp::LaunchMode _launchMode;
 
     static winrt::Windows::UI::Xaml::ElementTheme _ParseTheme(const std::wstring& themeString) noexcept;
     static std::wstring_view _SerializeTheme(const winrt::Windows::UI::Xaml::ElementTheme theme) noexcept;
 
+    static std::wstring_view _SerializeTabWidthMode(const winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode tabWidthMode) noexcept;
+    static winrt::Microsoft::UI::Xaml::Controls::TabViewWidthMode _ParseTabWidthMode(const std::wstring& tabWidthModeString) noexcept;
+
     static void _ParseInitialPosition(const std::wstring& initialPosition,
                                       std::optional<int32_t>& initialX,
                                       std::optional<int32_t>& initialY) noexcept;

src/cascadia/TerminalApp/GlobalAppSettings.h

@@ -14,7 +14,7 @@ the MIT License. See LICENSE in the project root for license information. -->
                  VerticalAlignment="Bottom"
                  HorizontalContentAlignment="Stretch"
                  IsAddTabButtonVisible="false"
-                 TabWidthMode="SizeToContent"
+                 TabWidthMode="Equal"
                  CanReorderTabs="True"
                  CanDragTabs="True"
                  AllowDropTabs="True">

src/cascadia/TerminalApp/TabRowControl.xaml

@@ -127,6 +127,7 @@ namespace winrt::TerminalApp::implementation
         _tabView.TabItemsChanged({ this, &TerminalPage::_OnTabItemsChanged });
 
         _CreateNewTabFlyout();
+        _UpdateTabWidthMode();
         _OpenNewTab(nullptr);
 
         _tabContent.SizeChanged({ this, &TerminalPage::_OnContentSizeChanged });
@@ -695,6 +696,13 @@ namespace winrt::TerminalApp::implementation
         }
     }
 
+    // Method Description:
+    // - Handle changes to the tab width set by the user
+    void TerminalPage::_UpdateTabWidthMode()
+    {
+        _tabView.TabWidthMode(_settings->GlobalSettings().GetTabWidthMode());
+    }
+
     // Method Description:
     // - Handle changes in tab layout.
     void TerminalPage::_UpdateTabView()
@@ -1416,6 +1424,7 @@ namespace winrt::TerminalApp::implementation
             // profile, which might have changed
             if (auto page{ weakThis.get() })
             {
+                page->_UpdateTabWidthMode();
                 page->_CreateNewTabFlyout();
             }
         });

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -84,6 +84,7 @@ namespace winrt::TerminalApp::implementation
         void _UpdateTitle(std::shared_ptr<Tab> tab);
         void _UpdateTabIcon(std::shared_ptr<Tab> tab);
         void _UpdateTabView();
+        void _UpdateTabWidthMode();
         void _DuplicateTabViewItem();
         void _RemoveTabViewItem(const Microsoft::UI::Xaml::Controls::TabViewItem& tabViewItem);
         void _RemoveTabViewItemByIndex(uint32_t tabIndex);

src/cascadia/TerminalApp/TerminalPage.h

@@ -7,6 +7,7 @@
     "requestedTheme": "system",
     "showTabsInTitlebar": true,
     "showTerminalTitleInTitlebar": true,
+    "tabWidthMode": "equal",
     "snapToGridOnResize": false,
     "wordDelimiters": " /\\()\"'-.,:;<>~!@#$%^&*|+=[]{}~?\u2502",