move logic to SearchBoxControl for better handling

Author: carlos-zamora

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

@@ -335,7 +335,15 @@ Please either install the missing font or choose another one.</value>
     <comment>{Locked="{0}"} {0} will be replaced with a string of input that is suggested for the user to input</comment>
   </data>
   <data name="TermControl_NumResultsAccessible" xml:space="preserve">
-    <value>{} of {}</value>
-    <comment>{Locked="{}"} Read out by the screen reader to announce number of results from a search query. First "{}" is replaced with index of search result. Second "{}" is replaced by total number of results.</comment>
+    <value>{0} of {1}</value>
+    <comment>{Locked="{0}"}{Locked="{1}"} Read out by the screen reader to announce number of results from a search query. First "{}" is replaced with index of search result. Second "{}" is replaced by total number of results.</comment>
+  </data>
+  <data name="TermControl_UnknownSearchResultIndex" xml:space="preserve">
+    <value>unknown</value>
+    <comment>Will be read out by a screen reader when a value for the index of a search result is mismatched and unclear. Displayed as a part of TermControl_NumResultsAccessible.</comment>
+  </data>
+  <data name="TermControl_TooManySearchResults" xml:space="preserve">
+    <value>over 999</value>
+    <comment>Will be read out by a screen reader when a search returns over 999 search results.</comment>
   </data>
 </root>

src/cascadia/TerminalControl/SearchBoxControl.cpp

@@ -463,9 +463,10 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     // Arguments:
     // - totalMatches - total number of matches (search results)
     // - currentMatch - the index of the current match (0-based)
+    // - isAccessible - if true, format the string for screen readers. Defaults to false.
     // Return Value:
     // - status message
-    winrt::hstring SearchBoxControl::_FormatStatus(int32_t totalMatches, int32_t currentMatch)
+    winrt::hstring SearchBoxControl::_FormatStatus(int32_t totalMatches, int32_t currentMatch, bool isAccessible)
     {
         if (totalMatches < 0)
         {
@@ -482,7 +483,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         if (currentMatch < 0 || currentMatch > (MaximumTotalResultsToShowInStatus - 1))
         {
-            currentString = CurrentIndexTooHighStatus;
+            currentString = isAccessible ? RS_(L"TermControl_UnknownSearchResultIndex") : CurrentIndexTooHighStatus;
         }
         else
         {
@@ -491,13 +492,17 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         if (totalMatches > MaximumTotalResultsToShowInStatus)
         {
-            totalString = TotalResultsTooHighStatus;
+            totalString = isAccessible ? RS_(L"TermControl_TooManySearchResults") : TotalResultsTooHighStatus;
         }
         else
         {
             totalString = fmt::to_wstring(totalMatches);
         }
 
+        if (isAccessible)
+        {
+            return winrt::hstring{ RS_fmt(L"TermControl_NumResultsAccessible", currentString, totalString) };
+        }
         return winrt::hstring{ RS_fmt(L"TermControl_NumResults", currentString, totalString) };
     }
 
@@ -535,11 +540,6 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         return maxLength;
     }
 
-    winrt::hstring SearchBoxControl::GetStatusText()
-    {
-        return StatusBox().Text();
-    }
-
     // Method Description:
     // - Formats and sets the status message in the status box.
     // Increases the size of the box if required.
@@ -562,6 +562,18 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         StatusBox().Text(status);
     }
 
+    // Method Description:
+    // - Formats and returns an accessible status message representing the search state.
+    // - Similar to SetStatus but returns a more descriptive string for screen readers.
+    hstring SearchBoxControl::GetAccessibleStatus(int32_t totalMatches, int32_t currentMatch, bool searchRegexInvalid)
+    {
+        if (searchRegexInvalid)
+        {
+            return RS_(L"SearchRegexInvalid");
+        }
+        return _FormatStatus(totalMatches, currentMatch, true);
+    }
+
     // Method Description:
     // - Removes the status message in the status box.
     void SearchBoxControl::ClearStatus()

src/cascadia/TerminalControl/SearchBoxControl.h

@@ -43,8 +43,8 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         void SetFocusOnTextbox();
         void PopulateTextbox(const winrt::hstring& text);
         bool ContainsFocus();
-        winrt::hstring GetStatusText();
         void SetStatus(int32_t totalMatches, int32_t currentMatch, bool searchRegexInvalid);
+        winrt::hstring GetAccessibleStatus(int32_t totalMatches, int32_t currentMatch, bool searchRegexInvalid);
         void ClearStatus();
 
         void GoBackwardClicked(const winrt::Windows::Foundation::IInspectable& /*sender*/, const winrt::Windows::UI::Xaml::RoutedEventArgs& /*e*/);
@@ -78,7 +78,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         void _PlayCloseAnimation();
         bool _AnimationEnabled();
 
-        static winrt::hstring _FormatStatus(int32_t totalMatches, int32_t currentMatch);
+        static winrt::hstring _FormatStatus(int32_t totalMatches, int32_t currentMatch, bool isAccessible = false);
         static double _TextWidth(winrt::hstring text, double fontSize);
         double _GetStatusMaxWidth();
 

src/cascadia/TerminalControl/TermControl.cpp

@@ -3758,12 +3758,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         if (auto automationPeer{ FrameworkElementAutomationPeer::FromElement(*this) })
         {
-            auto status = _searchBox->GetStatusText();
-            if (const auto i = status.size() / 2; !status.empty() && status[i] == '/')
-            {
-                status = RS_fmt(L"TermControl_NumResultsAccessible", results.CurrentMatch + 1, results.TotalMatches);
-            }
-
+            const auto status = _searchBox->GetAccessibleStatus(results.TotalMatches, results.CurrentMatch, results.SearchRegexInvalid);
             if (!status.empty())
             {
                 automationPeer.RaiseNotificationEvent(