Replace New Tab Menu Match Profiles functionality with regex support

Author: carlos-zamora

Diff for: src/cascadia/TerminalApp/Resources/en-US/Resources.resw

@@ -944,4 +944,7 @@
   <data name="TabMoveRight" xml:space="preserve">
     <value>Move right</value>
   </data>
+  <data name="InvalidRegex" xml:space="preserve">
+    <value>An invalid regex was found.</value>
+  </data>
 </root>

Diff for: src/cascadia/TerminalApp/TerminalWindow.cpp

@@ -55,6 +55,7 @@ static const std::array settingsLoadWarningsLabels{
     USES_RESOURCE(L"UnknownTheme"),
     USES_RESOURCE(L"DuplicateRemainingProfilesEntry"),
     USES_RESOURCE(L"InvalidUseOfContent"),
+    USES_RESOURCE(L"InvalidRegex"),
 };
 
 static_assert(settingsLoadWarningsLabels.size() == static_cast<size_t>(SettingsLoadWarnings::WARNINGS_SIZE));

Diff for: src/cascadia/TerminalSettingsEditor/NewTabMenu.xaml

@@ -449,6 +449,8 @@
                                     FontIconGlyph=""
                                     Style="{StaticResource ExpanderSettingContainerStyleWithIcon}">
                 <StackPanel Spacing="10">
+                    <HyperlinkButton x:Uid="NewTabMenu_AddMatchProfiles_Help"
+                                     NavigateUri="https://learn.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference" />
                     <TextBox x:Uid="NewTabMenu_AddMatchProfiles_Name"
                              Text="{x:Bind ViewModel.ProfileMatcherName, Mode=TwoWay}" />
                     <TextBox x:Uid="NewTabMenu_AddMatchProfiles_Source"

Diff for: src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw

@@ -2105,7 +2105,7 @@
     <comment>Header for a control that adds any remaining profiles to the new tab menu.</comment>
   </data>
   <data name="NewTabMenu_AddMatchProfiles.HelpText" xml:space="preserve">
-    <value>Add a group of profiles that match at least one of the defined properties</value>
+    <value>Add a group of profiles that match at least one of the defined regex properties</value>
     <comment>Additional information for a control that adds a terminal profile matcher to the new tab menu. Presented near "NewTabMenu_AddMatchProfiles".</comment>
   </data>
   <data name="NewTabMenu_AddRemainingProfiles.HelpText" xml:space="preserve">
@@ -2121,15 +2121,15 @@
     <comment>Header for a control that adds a folder to the new tab menu.</comment>
   </data>
   <data name="NewTabMenu_AddMatchProfiles_Name.Header" xml:space="preserve">
-    <value>Profile name</value>
+    <value>Profile name (Regex)</value>
     <comment>Header for a text box used to define a regex for the names of profiles to add.</comment>
   </data>
   <data name="NewTabMenu_AddMatchProfiles_Source.Header" xml:space="preserve">
-    <value>Profile source</value>
+    <value>Profile source (Regex)</value>
     <comment>Header for a text box used to define a regex for the sources of profiles to add.</comment>
   </data>
   <data name="NewTabMenu_AddMatchProfiles_Commandline.Header" xml:space="preserve">
-    <value>Commandline</value>
+    <value>Commandline (Regex)</value>
     <comment>Header for a text box used to define a regex for the commandlines of profiles to add.</comment>
   </data>
   <data name="NewTabMenu_AddMatchProfilesTextBlock.Text" xml:space="preserve">
@@ -2340,4 +2340,7 @@
     <value>This option is managed by enterprise policy and cannot be changed here.</value>
     <comment>This is displayed in concordance with Globals_StartOnUserLogin if the enterprise administrator has taken control of this setting.</comment>
   </data>
+  <data name="NewTabMenu_AddMatchProfiles_Help.Content" xml:space="preserve">
+    <value>Learn more about regular expressions</value>
+  </data>
 </root>

Diff for: src/cascadia/TerminalSettingsModel/CascadiaSettings.cpp

@@ -429,6 +429,7 @@ void CascadiaSettings::_validateSettings()
     _validateColorSchemesInCommands();
     _validateThemeExists();
     _validateProfileEnvironmentVariables();
+    _validateRegexes();
 }
 
 // Method Description:
@@ -583,6 +584,49 @@ void CascadiaSettings::_validateProfileEnvironmentVariables()
     }
 }
 
+static void _validateRegex(const winrt::hstring& regex, IVector<Model::SettingsLoadWarnings>& warnings)
+{
+    try
+    {
+        std::wregex{ regex.cbegin(), regex.cend() };
+    }
+    catch (std::regex_error)
+    {
+        warnings.Append(Model::SettingsLoadWarnings::InvalidRegex);
+    }
+}
+
+static void _validateNTMEntries(const IVector<Model::NewTabMenuEntry>& entries, IVector<Model::SettingsLoadWarnings>& warnings)
+{
+    for (const auto& ntmEntry : entries)
+    {
+        if (const auto& folderEntry = ntmEntry.try_as<Model::FolderEntry>())
+        {
+            _validateNTMEntries(folderEntry.RawEntries(), warnings);
+        }
+        if (const auto& matchProfilesEntry = ntmEntry.try_as<Model::MatchProfilesEntry>())
+        {
+            if (const auto nameRegex = matchProfilesEntry.Name(); !nameRegex.empty())
+            {
+                _validateRegex(nameRegex, warnings);
+            }
+            if (const auto commandlineRegex = matchProfilesEntry.Commandline(); !commandlineRegex.empty())
+            {
+                _validateRegex(commandlineRegex, warnings);
+            }
+            if (const auto sourceRegex = matchProfilesEntry.Source(); !sourceRegex.empty())
+            {
+                _validateRegex(sourceRegex, warnings);
+            }
+        }
+    }
+}
+
+void CascadiaSettings::_validateRegexes()
+{
+    _validateNTMEntries(_globals->NewTabMenu(), _warnings);
+}
+
 // Method Description:
 // - Helper to get the GUID of a profile, given an optional index and a possible
 //   "profile" value to override that.

Diff for: src/cascadia/TerminalSettingsModel/CascadiaSettings.h

@@ -175,6 +175,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         void _validateColorSchemesInCommands() const;
         bool _hasInvalidColorScheme(const Model::Command& command) const;
         void _validateThemeExists();
+        void _validateRegexes();
 
         void _researchOnLoad();
 

Diff for: src/cascadia/TerminalSettingsModel/MatchProfilesEntry.cpp

@@ -55,19 +55,39 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         // value of the function we consider the null value to be "false".
         auto isMatching = std::optional<bool>{};
 
+        auto isMatch = [](std::wstring_view regex, std::wstring_view text) {
+            if (text.empty())
+            {
+                return false;
+            }
+
+            std::wregex re;
+            try
+            {
+                re = { regex.cbegin(), regex.cend() };
+            }
+            catch (std::regex_error)
+            {
+                // invalid regex
+                return false;
+            }
+
+            return std::regex_match(text.cbegin(), text.cend(), re);
+        };
+
         if (!_Name.empty())
         {
-            isMatching = { isMatching.value_or(true) && _Name == profile.Name() };
+            isMatching = { isMatching.value_or(true) && isMatch(_Name, profile.Name()) };
         }
 
         if (!_Source.empty())
         {
-            isMatching = { isMatching.value_or(true) && _Source == profile.Source() };
+            isMatching = { isMatching.value_or(true) && isMatch(_Source, profile.Source()) };
         }
 
         if (!_Commandline.empty())
         {
-            isMatching = { isMatching.value_or(true) && _Commandline == profile.Commandline() };
+            isMatching = { isMatching.value_or(true) && isMatch(_Commandline, profile.Commandline()) };
         }
 
         return isMatching.value_or(false);

Diff for: src/cascadia/TerminalSettingsModel/TerminalWarnings.idl

@@ -25,6 +25,7 @@ namespace Microsoft.Terminal.Settings.Model
         UnknownTheme,
         DuplicateRemainingProfilesEntry,
         InvalidUseOfContent,
+        InvalidRegex,
         WARNINGS_SIZE // IMPORTANT: This MUST be the last value in this enum. It's an unused placeholder.
     };