Properly initialize XamlUiaTextRange with ProviderFromPeer

src/cascadia/TerminalControl/InteractivityAutomationPeer.cpp

@@ -43,6 +43,10 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     {
         _controlPadding = padding;
     }
+    void InteractivityAutomationPeer::RegisterParentProvider(Control::TermControlAutomationPeer parentProvider)
+    {
+        _parentProvider = parentProvider;
+    }
 
     // Method Description:
     // - Signals the ui automation client that the terminal's selection has
@@ -110,30 +114,21 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         // ScreenInfoUiaProvider doesn't actually use parameter, so just pass in nullptr
         THROW_IF_FAILED(_uiaProvider->RangeFromChild(/* IRawElementProviderSimple */ nullptr,
                                                      &returnVal));
-
-        const auto parentProvider = this->ProviderFromPeer(*this);
-        const auto xutr = winrt::make_self<XamlUiaTextRange>(returnVal, parentProvider);
-        return xutr.as<XamlAutomation::ITextRangeProvider>();
+        return _CreateXamlUiaTextRange(returnVal);
     }
 
     XamlAutomation::ITextRangeProvider InteractivityAutomationPeer::RangeFromPoint(Windows::Foundation::Point screenLocation)
     {
         UIA::ITextRangeProvider* returnVal;
         THROW_IF_FAILED(_uiaProvider->RangeFromPoint({ screenLocation.X, screenLocation.Y }, &returnVal));
-
-        const auto parentProvider = this->ProviderFromPeer(*this);
-        const auto xutr = winrt::make_self<XamlUiaTextRange>(returnVal, parentProvider);
-        return xutr.as<XamlAutomation::ITextRangeProvider>();
+        return _CreateXamlUiaTextRange(returnVal);
     }
 
     XamlAutomation::ITextRangeProvider InteractivityAutomationPeer::DocumentRange()
     {
         UIA::ITextRangeProvider* returnVal;
         THROW_IF_FAILED(_uiaProvider->get_DocumentRange(&returnVal));
-
-        const auto parentProvider = this->ProviderFromPeer(*this);
-        const auto xutr = winrt::make_self<XamlUiaTextRange>(returnVal, parentProvider);
-        return xutr.as<XamlAutomation::ITextRangeProvider>();
+        return _CreateXamlUiaTextRange(returnVal);
     }
 
     XamlAutomation::SupportedTextSelection InteractivityAutomationPeer::SupportedTextSelection()
@@ -180,6 +175,20 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     }
 #pragma endregion
 
+    XamlAutomation::ITextRangeProvider InteractivityAutomationPeer::_CreateXamlUiaTextRange(UIA::ITextRangeProvider* returnVal) const
+    {
+        // LOAD-BEARING: use _parentProvider->ProviderFromPeer(_parentProvider) instead of this->ProviderFromPeer(*this).
+        // Since we split the automation peer into TermControlAutomationPeer and InteractivityAutomationPeer,
+        // the using "this" returns null. This can cause issues with some UIA Client scenarios like word navigation in Narrator.
+        const auto parent{ _parentProvider.get() };
+        if (!parent)
+        {
+            return nullptr;
+        }
+        const auto xutr = winrt::make_self<XamlUiaTextRange>(returnVal, parent.ProviderFromPeer(parent));
+        return xutr.as<XamlAutomation::ITextRangeProvider>();
+    };
+
     // Method Description:
     // - extracts the UiaTextRanges from the SAFEARRAY and converts them to Xaml ITextRangeProviders
     // Arguments:
@@ -194,11 +203,12 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         std::vector<XamlAutomation::ITextRangeProvider> vec;
         vec.reserve(count);
-        auto parentProvider = this->ProviderFromPeer(*this);
         for (int i = 0; i < count; i++)
         {
-            auto xutr = make_self<XamlUiaTextRange>(providers[i].detach(), parentProvider);
-            vec.emplace_back(xutr.as<XamlAutomation::ITextRangeProvider>());
+            if (auto xutr = _CreateXamlUiaTextRange(providers[i].detach()))
+            {
+                vec.emplace_back(std::move(xutr));
+            }
         }
 
         com_array<XamlAutomation::ITextRangeProvider> result{ vec };

src/cascadia/TerminalControl/InteractivityAutomationPeer.h

@@ -43,6 +43,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
         void SetControlBounds(const Windows::Foundation::Rect bounds);
         void SetControlPadding(const Core::Padding padding);
+        void RegisterParentProvider(Control::TermControlAutomationPeer parentProvider);
 
 #pragma region IUiaEventDispatcher
         void SignalSelectionChanged() override;
@@ -74,8 +75,11 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         TYPED_EVENT(CursorChanged, IInspectable, IInspectable);
 
     private:
+        Windows::UI::Xaml::Automation::Provider::ITextRangeProvider _CreateXamlUiaTextRange(::ITextRangeProvider* returnVal) const;
+
         ::Microsoft::WRL::ComPtr<::Microsoft::Terminal::TermControlUiaProvider> _uiaProvider;
         winrt::Microsoft::Terminal::Control::implementation::ControlInteractivity* _interactivity;
+        weak_ref<Control::TermControlAutomationPeer> _parentProvider;
 
         til::rectangle _controlBounds{};
         til::rectangle _controlPadding{};

src/cascadia/TerminalControl/InteractivityAutomationPeer.idl

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+import "TermControlAutomationPeer.idl";
+
 namespace Microsoft.Terminal.Control
 {
     [default_interface] runtimeclass InteractivityAutomationPeer :
@@ -10,6 +12,7 @@ namespace Microsoft.Terminal.Control
 
         void SetControlBounds(Windows.Foundation.Rect bounds);
         void SetControlPadding(Microsoft.Terminal.Core.Padding padding);
+        void RegisterParentProvider(TermControlAutomationPeer parentProvider);
 
         event Windows.Foundation.TypedEventHandler<Object, Object> SelectionChanged;
         event Windows.Foundation.TypedEventHandler<Object, Object> TextChanged;

src/cascadia/TerminalControl/TermControl.cpp

@@ -522,10 +522,15 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         // MSFT 33353327: We're purposefully not using _initializedTerminal to ensure we're fully initialized.
         // Doing so makes us return nullptr when XAML requests an automation peer.
         // Instead, we need to give XAML an automation peer, then fix it later.
-        if (!_IsClosing())
+        if (_IsClosing())
+        {
+            return nullptr;
+        }
+
+        // create a custom automation peer with this code pattern:
+        // (https://docs.microsoft.com/en-us/windows/uwp/design/accessibility/custom-automation-peers)
+        if (!_automationPeer)
         {
-            // create a custom automation peer with this code pattern:
-            // (https://docs.microsoft.com/en-us/windows/uwp/design/accessibility/custom-automation-peers)
             if (const auto& interactivityAutoPeer{ _interactivity.OnCreateAutomationPeer() })
             {
                 const auto margins{ SwapChainPanel().Margin() };
@@ -534,10 +539,9 @@ namespace winrt::Microsoft::Terminal::Control::implementation
                                              margins.Right,
                                              margins.Bottom };
                 _automationPeer = winrt::make<implementation::TermControlAutomationPeer>(this, padding, interactivityAutoPeer);
-                return _automationPeer;
             }
         }
-        return nullptr;
+        return _automationPeer;
     }
 
     // This is needed for TermControlAutomationPeer. We probably could find a

src/cascadia/TerminalControl/TermControlAutomationPeer.cpp

@@ -45,6 +45,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         _contentAutomationPeer.SelectionChanged([this](auto&&, auto&&) { SignalSelectionChanged(); });
         _contentAutomationPeer.TextChanged([this](auto&&, auto&&) { SignalTextChanged(); });
         _contentAutomationPeer.CursorChanged([this](auto&&, auto&&) { SignalCursorChanged(); });
+        _contentAutomationPeer.RegisterParentProvider(*this);
     };
 
     // Method Description:
@@ -226,30 +227,4 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     }
 
 #pragma endregion
-
-    // Method Description:
-    // - extracts the UiaTextRanges from the SAFEARRAY and converts them to Xaml ITextRangeProviders
-    // Arguments:
-    // - SAFEARRAY of UIA::UiaTextRange (ITextRangeProviders)
-    // Return Value:
-    // - com_array of Xaml Wrapped UiaTextRange (ITextRangeProviders)
-    com_array<XamlAutomation::ITextRangeProvider> TermControlAutomationPeer::WrapArrayOfTextRangeProviders(SAFEARRAY* textRanges)
-    {
-        // transfer ownership of UiaTextRanges to this new vector
-        auto providers = SafeArrayToOwningVector<::Microsoft::Terminal::TermControlUiaTextRange>(textRanges);
-        int count = gsl::narrow<int>(providers.size());
-
-        std::vector<XamlAutomation::ITextRangeProvider> vec;
-        vec.reserve(count);
-        auto parentProvider = this->ProviderFromPeer(*this);
-        for (int i = 0; i < count; i++)
-        {
-            auto xutr = make_self<XamlUiaTextRange>(providers[i].detach(), parentProvider);
-            vec.emplace_back(xutr.as<XamlAutomation::ITextRangeProvider>());
-        }
-
-        com_array<XamlAutomation::ITextRangeProvider> result{ vec };
-
-        return result;
-    }
 }

src/cascadia/TerminalControl/TermControlAutomationPeer.h

@@ -78,7 +78,5 @@ namespace winrt::Microsoft::Terminal::Control::implementation
     private:
         winrt::Microsoft::Terminal::Control::implementation::TermControl* _termControl;
         Control::InteractivityAutomationPeer _contentAutomationPeer;
-
-        winrt::com_array<Windows::UI::Xaml::Automation::Provider::ITextRangeProvider> WrapArrayOfTextRangeProviders(SAFEARRAY* textRanges);
     };
 }

src/cascadia/TerminalControl/XamlUiaTextRange.cpp

@@ -6,6 +6,7 @@
 #include "../types/TermControlUiaTextRange.hpp"
 #include <UIAutomationClient.h>
 #include <UIAutomationCoreApi.h>
+#include "../types/UiaTracing.h"
 
 // the same as COR_E_NOTSUPPORTED
 // we don't want to import the CLR headers to get it
@@ -182,6 +183,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
     XamlAutomation::IRawElementProviderSimple XamlUiaTextRange::GetEnclosingElement()
     {
+        ::Microsoft::Console::Types::UiaTracing::TextRange::GetEnclosingElement(*static_cast<::Microsoft::Console::Types::UiaTextRangeBase*>(_uiaProvider.get()));
         return _parentProvider;
     }