fix: Expose dialogs in the platform adapters

Author: DataTriny

platforms/atspi-common/src/node.rs

@@ -279,7 +279,11 @@ impl NodeWrapper<'_> {
         let state = self.0;
         let atspi_role = self.role();
         let mut atspi_state = StateSet::empty();
-        if state.parent_id().is_none() && state.role() == Role::Window && is_window_focused {
+        if is_window_focused
+            && ((state.parent_id().is_none() && state.role() == Role::Window)
+                || (state.is_dialog()
+                    && state.tree_state.active_dialog().map(|d| d.id()) == Some(state.id())))
+        {
             atspi_state.insert(State::Active);
         }
         if state.is_text_input() && !state.is_read_only() {
@@ -309,6 +313,9 @@ impl NodeWrapper<'_> {
         if atspi_role != AtspiRole::ToggleButton && state.toggled().is_some() {
             atspi_state.insert(State::Checkable);
         }
+        if state.is_modal() {
+            atspi_state.insert(State::Modal);
+        }
         if let Some(selected) = state.is_selected() {
             if !state.is_disabled() {
                 atspi_state.insert(State::Selectable);

platforms/macos/src/node.rs

@@ -87,7 +87,7 @@ fn ns_role(node: &Node) -> &'static NSAccessibilityRole {
             Role::TimeInput => ns_string!("AXTimeField"),
             Role::Abbr => NSAccessibilityGroupRole,
             Role::Alert => NSAccessibilityGroupRole,
-            Role::AlertDialog => NSAccessibilityGroupRole,
+            Role::AlertDialog => NSAccessibilityWindowRole,
             Role::Application => NSAccessibilityGroupRole,
             Role::Article => NSAccessibilityGroupRole,
             Role::Audio => NSAccessibilityGroupRole,
@@ -108,7 +108,7 @@ fn ns_role(node: &Node) -> &'static NSAccessibilityRole {
             Role::Definition => NSAccessibilityGroupRole,
             Role::DescriptionList => NSAccessibilityListRole,
             Role::Details => NSAccessibilityGroupRole,
-            Role::Dialog => NSAccessibilityGroupRole,
+            Role::Dialog => NSAccessibilityWindowRole,
             Role::DisclosureTriangle => NSAccessibilityButtonRole,
             Role::Document => NSAccessibilityGroupRole,
             Role::EmbeddedObject => NSAccessibilityGroupRole,
@@ -235,7 +235,7 @@ fn ns_sub_role(node: &Node) -> &'static NSAccessibilitySubrole {
     unsafe {
         match role {
             Role::Alert => ns_string!("AXApplicationAlert"),
-            Role::AlertDialog => ns_string!("AXApplicationAlertDialog"),
+            Role::AlertDialog => NSAccessibilityDialogSubrole,
             Role::Article => ns_string!("AXDocumentArticle"),
             Role::Banner => ns_string!("AXLandmarkBanner"),
             Role::Button if node.toggled().is_some() => NSAccessibilityToggleSubrole,
@@ -996,6 +996,12 @@ declare_class!(
             .flatten()
         }
 
+        #[method(isAccessibilityModal)]
+        fn is_modal(&self) -> bool {
+            self.resolve(|node| node.is_modal())
+                .unwrap_or(false)
+        }
+
         // We discovered through experimentation that when mixing the newer
         // NSAccessibility protocols with the older informal protocol,
         // the platform uses both protocols to discover which actions are
@@ -1080,6 +1086,9 @@ declare_class!(
                 if selector == sel!(accessibilityTabs) {
                     return node.role() == Role::TabList;
                 }
+                if selector == sel!(isAccessibilityModal) {
+                    return node.is_dialog();
+                }
                 if selector == sel!(accessibilityAttributeValue:) {
                     return node.has_braille_label() || node.has_braille_role_description()
                 }

platforms/windows/src/adapter.rs

@@ -214,6 +214,14 @@ impl TreeChangeHandler for AdapterChangeHandler<'_> {
             return;
         }
         let wrapper = NodeWrapper(node);
+        if node.is_dialog() {
+            let platform_node = PlatformNode::new(self.context, node.id());
+            let element: IRawElementProviderSimple = platform_node.into();
+            self.queue.push(QueuedEvent::Simple {
+                element,
+                event_id: UIA_Window_WindowOpenedEventId,
+            });
+        }
         if wrapper.name().is_some() && node.live() != Live::Off {
             let platform_node = PlatformNode::new(self.context, node.id());
             let element: IRawElementProviderSimple = platform_node.into();
@@ -234,6 +242,14 @@ impl TreeChangeHandler for AdapterChangeHandler<'_> {
         let old_node_was_filtered_out = filter(old_node) != FilterResult::Include;
         if filter(new_node) != FilterResult::Include {
             if !old_node_was_filtered_out {
+                if old_node.is_dialog() {
+                    let platform_node = PlatformNode::new(self.context, old_node.id());
+                    let element: IRawElementProviderSimple = platform_node.into();
+                    self.queue.push(QueuedEvent::Simple {
+                        element,
+                        event_id: UIA_Window_WindowClosedEventId,
+                    });
+                }
                 let old_wrapper = NodeWrapper(old_node);
                 if old_wrapper.is_selection_item_pattern_supported() && old_wrapper.is_selected() {
                     self.handle_selection_state_change(old_node, false);
@@ -263,6 +279,14 @@ impl TreeChangeHandler for AdapterChangeHandler<'_> {
                 event_id: UIA_LiveRegionChangedEventId,
             });
         }
+        if old_node_was_filtered_out && new_node.is_dialog() {
+            let platform_node = PlatformNode::new(self.context, new_node.id());
+            let element: IRawElementProviderSimple = platform_node.into();
+            self.queue.push(QueuedEvent::Simple {
+                element,
+                event_id: UIA_Window_WindowOpenedEventId,
+            });
+        }
         if new_wrapper.is_selection_item_pattern_supported()
             && (new_wrapper.is_selected() != old_wrapper.is_selected()
                 || (old_node_was_filtered_out && new_wrapper.is_selected()))
@@ -282,6 +306,14 @@ impl TreeChangeHandler for AdapterChangeHandler<'_> {
         if filter(node) != FilterResult::Include {
             return;
         }
+        if node.is_dialog() {
+            let platform_node = PlatformNode::new(self.context, node.id());
+            let element: IRawElementProviderSimple = platform_node.into();
+            self.queue.push(QueuedEvent::Simple {
+                element,
+                event_id: UIA_Window_WindowClosedEventId,
+            });
+        }
         let wrapper = NodeWrapper(node);
         if wrapper.is_selection_item_pattern_supported() {
             self.handle_selection_state_change(node, false);

platforms/windows/src/node.rs

@@ -96,11 +96,10 @@ impl NodeWrapper<'_> {
             Role::Abbr => UIA_TextControlTypeId,
             Role::Alert => UIA_TextControlTypeId,
             Role::AlertDialog => {
-                // Chromium's implementation suggests the use of
-                // UIA_TextControlTypeId, not UIA_PaneControlTypeId, because some
-                // Windows screen readers are not compatible with
-                // Role::AlertDialog yet.
-                UIA_TextControlTypeId
+                // Documentation suggests the use of UIA_PaneControlTypeId,
+                // but Chromium's implementation uses UIA_WindowControlTypeId
+                // instead.
+                UIA_WindowControlTypeId
             }
             Role::Application => UIA_PaneControlTypeId,
             Role::Article => UIA_GroupControlTypeId,
@@ -121,7 +120,12 @@ impl NodeWrapper<'_> {
             Role::Definition => UIA_GroupControlTypeId,
             Role::DescriptionList => UIA_ListControlTypeId,
             Role::Details => UIA_GroupControlTypeId,
-            Role::Dialog => UIA_PaneControlTypeId,
+            Role::Dialog => {
+                // Documentation suggests the use of UIA_PaneControlTypeId,
+                // but Chromium's implementation uses UIA_WindowControlTypeId
+                // instead.
+                UIA_WindowControlTypeId
+            }
             Role::DisclosureTriangle => UIA_ButtonControlTypeId,
             Role::Document | Role::Terminal => UIA_DocumentControlTypeId,
             Role::EmbeddedObject => UIA_PaneControlTypeId,
@@ -256,6 +260,17 @@ impl NodeWrapper<'_> {
         self.0.role_description()
     }
 
+    fn aria_role(&self) -> Option<&str> {
+        match self.0.role() {
+            Role::AlertDialog => Some("alertdialog"),
+            Role::Dialog => Some("dialog"),
+            _ => {
+                // TODO: Expose more ARIA roles.
+                None
+            }
+        }
+    }
+
     pub(crate) fn name(&self) -> Option<WideString> {
         let mut result = WideString::default();
         if self.0.label_comes_from_value() {
@@ -467,6 +482,18 @@ impl NodeWrapper<'_> {
         self.0.role() == Role::PasswordInput
     }
 
+    fn is_dialog(&self) -> bool {
+        self.0.is_dialog()
+    }
+
+    fn is_window_pattern_supported(&self) -> bool {
+        self.0.is_dialog()
+    }
+
+    fn is_modal(&self) -> bool {
+        self.0.is_modal()
+    }
+
     pub(crate) fn enqueue_property_changes(
         &self,
         queue: &mut Vec<QueuedEvent>,
@@ -526,7 +553,8 @@ impl NodeWrapper<'_> {
     IScrollItemProvider,
     ISelectionItemProvider,
     ISelectionProvider,
-    ITextProvider
+    ITextProvider,
+    IWindowProvider
 )]
 pub(crate) struct PlatformNode {
     pub(crate) context: Weak<Context>,
@@ -980,6 +1008,7 @@ macro_rules! patterns {
 properties! {
     (UIA_ControlTypePropertyId, control_type),
     (UIA_LocalizedControlTypePropertyId, localized_control_type),
+    (UIA_AriaRolePropertyId, aria_role),
     (UIA_NamePropertyId, name),
     (UIA_FullDescriptionPropertyId, description),
     (UIA_CulturePropertyId, culture),
@@ -997,7 +1026,8 @@ properties! {
     (UIA_IsPasswordPropertyId, is_password),
     (UIA_PositionInSetPropertyId, position_in_set),
     (UIA_SizeOfSetPropertyId, size_of_set),
-    (UIA_AriaPropertiesPropertyId, aria_properties)
+    (UIA_AriaPropertiesPropertyId, aria_properties),
+    (UIA_IsDialogPropertyId, is_dialog)
 }
 
 patterns! {
@@ -1148,6 +1178,41 @@ patterns! {
                 }
             })
         }
+    )),
+    (UIA_WindowPatternId, IWindowProvider, IWindowProvider_Impl, is_window_pattern_supported, (
+        (UIA_WindowIsModalPropertyId, IsModal, is_modal, BOOL)
+    ), (
+        fn SetVisualState(&self, _: WindowVisualState) -> Result<()> {
+            Err(invalid_operation())
+        },
+
+        fn Close(&self) -> Result<()> {
+            Err(not_supported())
+        },
+
+        fn WaitForInputIdle(&self, _: i32) -> Result<BOOL> {
+            Err(not_supported())
+        },
+
+        fn CanMaximize(&self) -> Result<BOOL> {
+            Err(not_supported())
+        },
+
+        fn CanMinimize(&self) -> Result<BOOL> {
+            Err(not_supported())
+        },
+
+        fn WindowVisualState(&self) -> Result<WindowVisualState> {
+            Err(not_supported())
+        },
+
+        fn WindowInteractionState(&self) -> Result<WindowInteractionState> {
+            Ok(WindowInteractionState_ReadyForUserInteraction)
+        },
+
+        fn IsTopmost(&self) -> Result<BOOL> {
+            Err(not_supported())
+        }
     ))
 }
 

platforms/windows/src/util.rs

@@ -248,6 +248,10 @@ pub(crate) fn invalid_operation() -> Error {
     HRESULT(UIA_E_INVALIDOPERATION as _).into()
 }
 
+pub(crate) fn not_supported() -> Error {
+    HRESULT(UIA_E_NOTSUPPORTED as _).into()
+}
+
 pub(crate) fn client_top_left(hwnd: WindowHandle) -> Point {
     let mut result = POINT::default();
     // If ClientToScreen fails, that means the window is gone.