Allow regex search

src/buffer/out/search.cpp

@@ -25,11 +25,14 @@ using namespace Microsoft::Console::Types;
 Search::Search(IUiaData& uiaData,
                const std::wstring& str,
                const Direction direction,
-               const Sensitivity sensitivity) :
+               const Sensitivity sensitivity,
+               bool regex) :
     _direction(direction),
     _sensitivity(sensitivity),
     _needle(s_CreateNeedleFromString(str)),
     _uiaData(uiaData),
+    _regex(regex),
+    _inputString(str),
     _coordAnchor(s_GetInitialAnchor(uiaData, direction))
 {
     _coordNext = _coordAnchor;
@@ -50,11 +53,14 @@ Search::Search(IUiaData& uiaData,
                const std::wstring& str,
                const Direction direction,
                const Sensitivity sensitivity,
-               const COORD anchor) :
+               const COORD anchor,
+               bool regex) :
     _direction(direction),
     _sensitivity(sensitivity),
     _needle(s_CreateNeedleFromString(str)),
     _coordAnchor(anchor),
+    _regex(regex),
+    _inputString(str),
     _uiaData(uiaData)
 {
     _coordNext = _coordAnchor;
@@ -75,20 +81,31 @@ bool Search::FindNext()
         return false;
     }
 
-    do
+    if (_regex)
     {
-        if (_FindNeedleInHaystackAt(_coordNext, _coordSelStart, _coordSelEnd))
-        {
-            _UpdateNextPosition();
-            _reachedEnd = _coordNext == _coordAnchor;
-            return true;
-        }
-        else
+        auto start = _direction == Direction::Forward ? _coordNext : COORD{ 0 };
+        auto end = _direction == Direction::Forward ? _uiaData.GetTextBufferEndPosition() : _coordNext;
+        auto wrapStart = _direction == Direction::Forward ? COORD{ 0 } : _coordNext;
+        auto wrapEnd = _direction == Direction::Forward ? _coordNext : _uiaData.GetTextBufferEndPosition();
+        return _RegexHelper(start, end) || _RegexHelper(wrapStart, wrapEnd);
+    }
+    else
+    {
+        do
         {
-            _UpdateNextPosition();
-        }
-
-    } while (_coordNext != _coordAnchor);
+            if (_FindNeedleInHaystackAt(_coordNext, _coordSelStart, _coordSelEnd))
+            {
+                _UpdateNextPosition();
+                _reachedEnd = _coordNext == _coordAnchor;
+                return true;
+            }
+            else
+            {
+                _UpdateNextPosition();
+            }
+
+        } while (_coordNext != _coordAnchor);
+    }
 
     return false;
 }
@@ -344,3 +361,57 @@ std::vector<std::vector<wchar_t>> Search::s_CreateNeedleFromString(const std::ws
     }
     return cells;
 }
+
+bool Search::_RegexHelper(COORD start, COORD end)
+{
+    std::wstring concatAll;
+    auto begin = start;
+    std::wsmatch match;
+
+    // To deal with text that spans multiple lines, we will first concatenate
+    // all the text into one string and find the regex in that string
+    while (begin != end)
+    {
+        concatAll += *_uiaData.GetTextBuffer().GetTextDataAt(begin);
+        _IncrementCoord(begin);
+    }
+
+    // Create the regex object and iterator
+    std::wregex regexObj{ _inputString };
+    auto matches_begin = std::wsregex_iterator(concatAll.begin(), concatAll.end(), regexObj);
+    auto matches_end = std::wsregex_iterator();
+
+    // If we found a match, get its position and length to update the selection coordinates
+    if (matches_begin != matches_end)
+    {
+        std::wsregex_iterator desired;
+        if (_direction == Direction::Forward)
+        {
+            desired = matches_begin;
+        }
+        else
+        {
+            // Regex iterators are not bidirectional, so we cannot create a reverse iterator out of one
+            // So, if we want to find the previous match, we need to manually progress the iterator
+            while (matches_begin != matches_end)
+            {
+                desired = matches_begin;
+                ++matches_begin;
+            }
+        }
+        const auto pos = desired->position();
+        for (auto i = 0; i < pos; ++i)
+        {
+            _IncrementCoord(start);
+        }
+        _coordSelStart = start;
+        const auto len = desired->length();
+        for (auto i = 0; i < (len - 1); ++i)
+        {
+            _IncrementCoord(start);
+        }
+        _coordSelEnd = start;
+        return true;
+    }
+    return false;
+}

src/buffer/out/search.h

@@ -43,13 +43,15 @@ class Search final
     Search(Microsoft::Console::Types::IUiaData& uiaData,
            const std::wstring& str,
            const Direction dir,
-           const Sensitivity sensitivity);
+           const Sensitivity sensitivity,
+           bool regex = false);
 
     Search(Microsoft::Console::Types::IUiaData& uiaData,
            const std::wstring& str,
            const Direction dir,
            const Sensitivity sensitivity,
-           const COORD anchor);
+           const COORD anchor,
+           bool regex = false);
 
     bool FindNext();
     void Select() const;
@@ -70,6 +72,8 @@ class Search final
 
     static std::vector<std::vector<wchar_t>> s_CreateNeedleFromString(const std::wstring& wstr);
 
+    bool _RegexHelper(COORD start, COORD end);
+
     bool _reachedEnd = false;
     COORD _coordNext = { 0 };
     COORD _coordSelStart = { 0 };
@@ -79,6 +83,8 @@ class Search final
     const std::vector<std::vector<wchar_t>> _needle;
     const Direction _direction;
     const Sensitivity _sensitivity;
+    const bool _regex;
+    const std::wstring _inputString;
     Microsoft::Console::Types::IUiaData& _uiaData;
 
 #ifdef UNIT_TESTING

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

@@ -121,6 +121,10 @@
     <value>Match Case</value>
     <comment>The tooltip text for the case sensitivity button on the search box control.</comment>
   </data>
+  <data name="SearchBox_Regex.ToolTipService.ToolTip" xml:space="preserve">
+    <value>Treat the search text as a regular expression</value>
+    <comment>The tooltip text for the regex button on the search box control.</comment>
+  </data>
   <data name="SearchBox_Close.ToolTipService.ToolTip" xml:space="preserve">
     <value>Close</value>
     <comment>The tooltip text for the close button on the search box control.</comment>
@@ -149,6 +153,10 @@
     <value>Case Sensitivity</value>
     <comment>The name of the case sensitivity button on the search box control for accessibility.</comment>
   </data>
+  <data name="SearchBox_Regex.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
+    <value>Regex</value>
+    <comment>The name of the regex button on the search box control for accessibility.</comment>
+  </data>
   <data name="SearchBox_SearchForwards.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name" xml:space="preserve">
     <value>Search Forward</value>
     <comment>The name of the search forward button for accessibility.</comment>

src/cascadia/TerminalControl/SearchBoxControl.cpp

@@ -22,6 +22,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         _focusableElements.insert(TextBox());
         _focusableElements.insert(CloseButton());
         _focusableElements.insert(CaseSensitivityButton());
+        _focusableElements.insert(RegexButton());
         _focusableElements.insert(GoForwardButton());
         _focusableElements.insert(GoBackwardButton());
     }
@@ -50,6 +51,16 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         return CaseSensitivityButton().IsChecked().GetBoolean();
     }
 
+    // Method Description:
+    // - Check if the current search is a regex one
+    // Return Value:
+    // - bool: whether the current search is case sensitive (case button is checked )
+    //   or not
+    bool SearchBoxControl::_IsRegex()
+    {
+        return RegexButton().IsChecked().GetBoolean();
+    }
+
     // Method Description:
     // - Handler for pressing Enter on TextBox, trigger
     //   text search
@@ -65,11 +76,11 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
             auto const state = CoreWindow::GetForCurrentThread().GetKeyState(winrt::Windows::System::VirtualKey::Shift);
             if (WI_IsFlagSet(state, CoreVirtualKeyStates::Down))
             {
-                _SearchHandlers(TextBox().Text(), !_GoForward(), _CaseSensitive());
+                _SearchHandlers(TextBox().Text(), !_GoForward(), _CaseSensitive(), _IsRegex());
             }
             else
             {
-                _SearchHandlers(TextBox().Text(), _GoForward(), _CaseSensitive());
+                _SearchHandlers(TextBox().Text(), _GoForward(), _CaseSensitive(), _IsRegex());
             }
             e.Handled(true);
         }
@@ -160,7 +171,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         }
 
         // kick off search
-        _SearchHandlers(TextBox().Text(), _GoForward(), _CaseSensitive());
+        _SearchHandlers(TextBox().Text(), _GoForward(), _CaseSensitive(), _IsRegex());
     }
 
     // Method Description:
@@ -181,7 +192,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         }
 
         // kick off search
-        _SearchHandlers(TextBox().Text(), _GoForward(), _CaseSensitive());
+        _SearchHandlers(TextBox().Text(), _GoForward(), _CaseSensitive(), _IsRegex());
     }
 
     // Method Description:

src/cascadia/TerminalControl/SearchBoxControl.h

@@ -44,6 +44,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
 
         bool _GoForward();
         bool _CaseSensitive();
+        bool _IsRegex();
         void _KeyDownHandler(winrt::Windows::Foundation::IInspectable const& sender, winrt::Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e);
         void _CharacterHandler(winrt::Windows::Foundation::IInspectable const& /*sender*/, winrt::Windows::UI::Xaml::Input::CharacterReceivedRoutedEventArgs const& e);
     };

src/cascadia/TerminalControl/SearchBoxControl.idl

@@ -3,7 +3,7 @@
 
 namespace Microsoft.Terminal.TerminalControl
 {
-    delegate void SearchHandler(String query, Boolean goForward, Boolean isCaseSensitive);
+    delegate void SearchHandler(String query, Boolean goForward, Boolean isCaseSensitive, Boolean isRegex);
 
     [default_interface] runtimeclass SearchBoxControl : Windows.UI.Xaml.Controls.UserControl
     {

src/cascadia/TerminalControl/SearchBoxControl.xaml

@@ -185,6 +185,12 @@
             <PathIcon Data="M8.87305 10H7.60156L6.5625 7.25195H2.40625L1.42871 10H0.150391L3.91016 0.197266H5.09961L8.87305 10ZM6.18652 6.21973L4.64844 2.04297C4.59831 1.90625 4.54818 1.6875 4.49805 1.38672H4.4707C4.42513 1.66471 4.37272 1.88346 4.31348 2.04297L2.78906 6.21973H6.18652ZM15.1826 10H14.0615V8.90625H14.0342C13.5465 9.74479 12.8288 10.1641 11.8809 10.1641C11.1836 10.1641 10.6367 9.97949 10.2402 9.61035C9.84831 9.24121 9.65234 8.7513 9.65234 8.14062C9.65234 6.83268 10.4225 6.07161 11.9629 5.85742L14.0615 5.56348C14.0615 4.37402 13.5807 3.7793 12.6191 3.7793C11.776 3.7793 11.015 4.06641 10.3359 4.64062V3.49219C11.0241 3.05469 11.8171 2.83594 12.7148 2.83594C14.36 2.83594 15.1826 3.70638 15.1826 5.44727V10ZM14.0615 6.45898L12.373 6.69141C11.8535 6.76432 11.4616 6.89421 11.1973 7.08105C10.9329 7.26335 10.8008 7.58919 10.8008 8.05859C10.8008 8.40039 10.9215 8.68066 11.1631 8.89941C11.4092 9.11361 11.735 9.2207 12.1406 9.2207C12.6966 9.2207 13.1546 9.02702 13.5146 8.63965C13.8792 8.24772 14.0615 7.75326 14.0615 7.15625V6.45898Z"/>
         </ToggleButton>
 
+        <ToggleButton x:Name="RegexButton"
+                      x:Uid="SearchBox_Regex"
+                      Style="{StaticResource ToggleButtonStyle}">
+            <PathIcon Data="M8.87305 10H7.60156L6.5625 7.25195H2.40625L1.42871 10H0.150391L3.91016 0.197266H5.09961L8.87305 10ZM6.18652 6.21973L4.64844 2.04297C4.59831 1.90625 4.54818 1.6875 4.49805 1.38672H4.4707C4.42513 1.66471 4.37272 1.88346 4.31348 2.04297L2.78906 6.21973H6.18652ZM15.1826 10H14.0615V8.90625H14.0342C13.5465 9.74479 12.8288 10.1641 11.8809 10.1641C11.1836 10.1641 10.6367 9.97949 10.2402 9.61035C9.84831 9.24121 9.65234 8.7513 9.65234 8.14062C9.65234 6.83268 10.4225 6.07161 11.9629 5.85742L14.0615 5.56348C14.0615 4.37402 13.5807 3.7793 12.6191 3.7793C11.776 3.7793 11.015 4.06641 10.3359 4.64062V3.49219C11.0241 3.05469 11.8171 2.83594 12.7148 2.83594C14.36 2.83594 15.1826 3.70638 15.1826 5.44727V10ZM14.0615 6.45898L12.373 6.69141C11.8535 6.76432 11.4616 6.89421 11.1973 7.08105C10.9329 7.26335 10.8008 7.58919 10.8008 8.05859C10.8008 8.40039 10.9215 8.68066 11.1631 8.89941C11.4092 9.11361 11.735 9.2207 12.1406 9.2207C12.6966 9.2207 13.1546 9.02702 13.5146 8.63965C13.8792 8.24772 14.0615 7.75326 14.0615 7.15625V6.45898Z"/>
+        </ToggleButton>
+
         <Button x:Name="CloseButton"
                 x:Uid="SearchBox_Close"
                 Padding="0"

src/cascadia/TerminalControl/TermControl.cpp

@@ -233,7 +233,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         }
         else
         {
-            _Search(_searchBox->TextBox().Text(), goForward, false);
+            _Search(_searchBox->TextBox().Text(), goForward, false, false);
         }
     }
 
@@ -248,7 +248,8 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
     // - <none>
     void TermControl::_Search(const winrt::hstring& text,
                               const bool goForward,
-                              const bool caseSensitive)
+                              const bool caseSensitive,
+                              const bool regex)
     {
         if (text.size() == 0 || _closing)
         {
@@ -263,7 +264,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
                                                     Search::Sensitivity::CaseSensitive :
                                                     Search::Sensitivity::CaseInsensitive;
 
-        Search search(*GetUiaData(), text.c_str(), direction, sensitivity);
+        Search search(*GetUiaData(), text.c_str(), direction, sensitivity, regex);
         auto lock = _terminal->LockForWriting();
         if (search.FindNext())
         {

src/cascadia/TerminalControl/TermControl.h

@@ -338,7 +338,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
         const unsigned int _NumberOfClicks(winrt::Windows::Foundation::Point clickPos, Timestamp clickTime);
         double _GetAutoScrollSpeed(double cursorDistanceFromBorder) const;
 
-        void _Search(const winrt::hstring& text, const bool goForward, const bool caseSensitive);
+        void _Search(const winrt::hstring& text, const bool goForward, const bool caseSensitive, const bool regex);
         void _CloseSearchBoxControl(const winrt::Windows::Foundation::IInspectable& sender, Windows::UI::Xaml::RoutedEventArgs const& args);
 
         // TSFInputControl Handlers