1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/accessibility/platform/inspect/ax_inspect_utils_mac.h"
#import <Cocoa/Cocoa.h>
#include <CoreGraphics/CoreGraphics.h>
#include <ostream>
#include "base/apple/bridging.h"
#include "base/apple/foundation_util.h"
#include "base/containers/fixed_flat_set.h"
#include "base/debug/stack_trace.h"
#include "base/functional/callback.h"
#include "base/logging.h"
#include "base/memory/scoped_policy.h"
#include "base/strings/pattern.h"
#include "base/strings/sys_string_conversions.h"
#include "ui/accessibility/platform/ax_platform_node.h"
#include "ui/accessibility/platform/ax_platform_tree_manager.h"
#include "ui/accessibility/platform/ax_private_attributes_mac.h"
#include "ui/accessibility/platform/inspect/ax_element_wrapper_mac.h"
// TODO(https://crbug.com/406190900): Remove this deprecation pragma.
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
namespace ui {
namespace {
const char kChromeTitle[] = "Google Chrome";
const char kChromiumTitle[] = "Chromium";
const char kFirefoxTitle[] = "Firefox";
const char kSafariTitle[] = "Safari";
NSArray* AXChildrenOf(id node) {
return AXElementWrapper(node).Children();
}
bool HasAXRole(const char* role, const AXUIElementRef node) {
AXElementWrapper ax_node((__bridge id)node);
NSString* node_role =
*ax_node.GetAttributeValue(NSAccessibilityRoleAttribute);
return base::SysNSStringToUTF8(node_role) == role;
}
bool HasIDOrClass(const std::string& idOrClass, const AXUIElementRef node) {
AXElementWrapper nsNode((__bridge id)node);
NSString* nsIDOrClass = base::SysUTF8ToNSString(idOrClass);
NSString* idValue =
*nsNode.GetAttributeValue(NSAccessibilityDOMIdentifierAttribute);
if ([idValue isEqualToString:nsIDOrClass]) {
return true;
}
NSArray* classList = *nsNode.GetAttributeValue(NSAccessibilityDOMClassList);
return [classList containsObject:nsIDOrClass];
}
} // namespace
bool IsValidAXAttribute(const std::string& attribute) {
static NSSet<NSString*>* valid_attributes = [NSSet setWithArray:@[
NSAccessibilityAccessKeyAttribute,
NSAccessibilityARIAAtomicAttribute,
NSAccessibilityARIABusyAttribute,
NSAccessibilityARIAColumnCountAttribute,
NSAccessibilityARIAColumnIndexAttribute,
NSAccessibilityARIACurrentAttribute,
NSAccessibilityARIALiveAttribute,
NSAccessibilityARIAPosInSetAttribute,
NSAccessibilityARIARelevantAttribute,
NSAccessibilityARIARowCountAttribute,
NSAccessibilityARIARowIndexAttribute,
NSAccessibilityARIASetSizeAttribute,
NSAccessibilityAutocompleteValueAttribute,
NSAccessibilityBlockQuoteLevelAttribute,
NSAccessibilityBrailleLabelAttribute,
NSAccessibilityBrailleRoleDescription,
NSAccessibilityChromeAXNodeIdAttribute,
NSAccessibilityColumnHeaderUIElementsAttribute,
NSAccessibilityDescriptionAttribute,
NSAccessibilityDetailsElementsAttribute,
NSAccessibilityDOMClassList,
NSAccessibilityDropEffectsAttribute,
NSAccessibilityElementBusyAttribute,
NSAccessibilityFocusableAncestorAttribute,
NSAccessibilityGrabbedAttribute,
NSAccessibilityHasPopupAttribute,
NSAccessibilityInvalidAttribute,
NSAccessibilityIsMultiSelectable,
NSAccessibilityKeyShortcutsValueAttribute,
NSAccessibilityLoadedAttribute,
NSAccessibilityLoadingProgressAttribute,
NSAccessibilityMathFractionNumeratorAttribute,
NSAccessibilityMathFractionDenominatorAttribute,
NSAccessibilityMathRootRadicandAttribute,
NSAccessibilityMathRootIndexAttribute,
NSAccessibilityMathBaseAttribute,
NSAccessibilityMathSubscriptAttribute,
NSAccessibilityMathSuperscriptAttribute,
NSAccessibilityMathUnderAttribute,
NSAccessibilityMathOverAttribute,
NSAccessibilityMathPostscriptsAttribute,
NSAccessibilityMathPrescriptsAttribute,
NSAccessibilityOwnsAttribute,
NSAccessibilityPopupValueAttribute,
NSAccessibilityRequiredAttribute,
NSAccessibilityRoleDescriptionAttribute,
NSAccessibilitySelectedAttribute,
NSAccessibilitySizeAttribute,
NSAccessibilityTitleAttribute,
NSAccessibilityTitleUIElementAttribute,
NSAccessibilityURLAttribute,
NSAccessibilityVisitedAttribute,
]];
return [valid_attributes containsObject:base::SysUTF8ToNSString(attribute)];
}
base::apple::ScopedCFTypeRef<AXUIElementRef> FindAXUIElement(
const AXUIElementRef node,
const char* role) {
return FindAXUIElement(node, base::BindRepeating(&HasAXRole, role));
}
base::apple::ScopedCFTypeRef<AXUIElementRef> FindAXUIElement(
const AXUIElementRef node,
const AXFindCriteria& criteria) {
if (criteria.Run(node)) {
return base::apple::ScopedCFTypeRef<AXUIElementRef>(
node, base::scoped_policy::RETAIN);
}
NSArray* children = AXChildrenOf((__bridge id)node);
for (id child in children) {
base::apple::ScopedCFTypeRef<AXUIElementRef> found =
FindAXUIElement((__bridge AXUIElementRef)child, criteria);
if (found) {
return found;
}
}
return base::apple::ScopedCFTypeRef<AXUIElementRef>();
}
std::pair<base::apple::ScopedCFTypeRef<AXUIElementRef>, int> FindAXUIElement(
const AXTreeSelector& selector) {
int pid;
base::apple::ScopedCFTypeRef<AXUIElementRef> node;
std::tie(node, pid) = FindAXApplication(selector);
// ActiveTab selector.
if (!node) {
return {node, pid};
}
if (selector.types & AXTreeSelector::ActiveTab) {
// Only active tab in exposed in browsers, thus find first
// AXWebArea role.
node = FindAXUIElement(node.get(), "AXWebArea");
}
if (selector.types & AXTreeSelector::IDOrClass) {
node = FindAXUIElement(
node.get(), base::BindRepeating(&HasIDOrClass, selector.pattern));
}
return {node, pid};
}
std::pair<base::apple::ScopedCFTypeRef<AXUIElementRef>, int> FindAXApplication(
const AXTreeSelector& selector) {
if (selector.widget) {
return {base::apple::ScopedCFTypeRef<AXUIElementRef>(
AXUIElementCreateApplication(selector.widget)),
selector.widget};
}
std::string title;
if (selector.types & AXTreeSelector::Chrome)
title = kChromeTitle;
else if (selector.types & AXTreeSelector::Chromium)
title = kChromiumTitle;
else if (selector.types & AXTreeSelector::Firefox)
title = kFirefoxTitle;
else if (selector.types & AXTreeSelector::Safari)
title = kSafariTitle;
else
return {base::apple::ScopedCFTypeRef<AXUIElementRef>(), 0};
NSArray* windows =
base::apple::CFToNSOwnershipCast(CGWindowListCopyWindowInfo(
kCGWindowListOptionOnScreenOnly | kCGWindowListExcludeDesktopElements,
kCGNullWindowID));
for (NSDictionary* window_info in windows) {
int pid = base::apple::ObjCCast<NSNumber>(window_info[@"kCGWindowOwnerPID"])
.intValue;
std::string window_name = base::SysNSStringToUTF8(
base::apple::ObjCCast<NSString>(window_info[@"kCGWindowOwnerName"]));
base::apple::ScopedCFTypeRef<AXUIElementRef> node;
// Application pre-defined selectors match or application title exact match.
bool app_title_match = window_name == selector.pattern;
if (window_name == title || app_title_match) {
node.reset(AXUIElementCreateApplication(pid));
}
// Window title match. Application contain an AXWindow accessible object as
// a first child, which accessible name contain a window title. For example:
// 'Inbox (2) - asurkov@igalia.com - Gmail'.
if (!selector.pattern.empty() && !app_title_match) {
if (!node) {
node.reset(AXUIElementCreateApplication(pid));
}
base::apple::ScopedCFTypeRef<AXUIElementRef> window =
FindAXWindowChild(node.get(), selector.pattern);
if (window) {
node = window;
}
}
// Found a match.
if (node)
return {node, pid};
}
return {base::apple::ScopedCFTypeRef<AXUIElementRef>(), 0};
}
base::apple::ScopedCFTypeRef<AXUIElementRef> FindAXWindowChild(
AXUIElementRef parent,
const std::string& pattern) {
NSArray* children = AXChildrenOf((__bridge id)parent);
if (children.count == 0) {
return base::apple::ScopedCFTypeRef<AXUIElementRef>();
}
id window = children.firstObject;
AXElementWrapper ax_window(window);
NSString* role = *ax_window.GetAttributeValue(NSAccessibilityRoleAttribute);
if (base::SysNSStringToUTF8(role) != "AXWindow") {
return base::apple::ScopedCFTypeRef<AXUIElementRef>();
}
NSString* window_title =
*ax_window.GetAttributeValue(NSAccessibilityTitleAttribute);
if (base::MatchPattern(base::SysNSStringToUTF8(window_title), pattern)) {
return base::apple::ScopedCFTypeRef<AXUIElementRef>(
(__bridge AXUIElementRef)window, base::scoped_policy::RETAIN);
}
return base::apple::ScopedCFTypeRef<AXUIElementRef>();
}
bool IsWebContent(AXUIElementRef element,
base::WeakPtr<AXPlatformTreeManager> manager) {
if (!element || !manager) {
return false;
}
AXElementWrapper wrapper((__bridge id)element);
NSString* chrome_node_id =
*wrapper.GetAttributeValue(NSAccessibilityChromeAXNodeIdAttribute);
if (!chrome_node_id) {
return false;
}
AXPlatformNode* ax_platform_node =
manager->GetPlatformNodeFromTree([chrome_node_id intValue]);
return ax_platform_node ? ax_platform_node->IsWebContent() : false;
}
} // namespace ui
#pragma clang diagnostic pop
|