ui/accessibility/platform/ax_platform_node_mac.mm

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #import "ui/accessibility/platform/ax_platform_node_mac.h"
   6
   7 #import <Cocoa/Cocoa.h>
   8
   9 #include "base/strings/sys_string_conversions.h"
  10 #import "ui/accessibility/ax_node_data.h"
  11 #import "ui/accessibility/platform/ax_platform_node_delegate.h"
  12 #import "ui/gfx/mac/coordinate_conversion.h"
  13
  14 namespace {
  15
  16 struct MapEntry {
  17   ui::AXRole value;
  18   NSString* nativeValue;
  19 };
  20
  21 typedef std::map<ui::AXRole, NSString*> RoleMap;
  22
  23 RoleMap BuildRoleMap() {
  24   const MapEntry roles[] = {
  25       {ui::AX_ROLE_ALERT, NSAccessibilityGroupRole},
  26       {ui::AX_ROLE_ALERT_DIALOG, NSAccessibilityGroupRole},
  27       {ui::AX_ROLE_ANNOTATION, NSAccessibilityUnknownRole},
  28       {ui::AX_ROLE_APPLICATION, NSAccessibilityGroupRole},
  29       {ui::AX_ROLE_ARTICLE, NSAccessibilityGroupRole},
  30       {ui::AX_ROLE_BANNER, NSAccessibilityGroupRole},
  31       {ui::AX_ROLE_BLOCKQUOTE, NSAccessibilityGroupRole},
  32       {ui::AX_ROLE_BUSY_INDICATOR, NSAccessibilityBusyIndicatorRole},
  33       {ui::AX_ROLE_BUTTON, NSAccessibilityButtonRole},
  34       {ui::AX_ROLE_CANVAS, NSAccessibilityImageRole},
  35       {ui::AX_ROLE_CAPTION, NSAccessibilityGroupRole},
  36       {ui::AX_ROLE_CELL, @"AXCell"},
  37       {ui::AX_ROLE_CHECK_BOX, NSAccessibilityCheckBoxRole},
  38       {ui::AX_ROLE_COLOR_WELL, NSAccessibilityColorWellRole},
  39       {ui::AX_ROLE_COLUMN, NSAccessibilityColumnRole},
  40       {ui::AX_ROLE_COLUMN_HEADER, @"AXCell"},
  41       {ui::AX_ROLE_COMBO_BOX, NSAccessibilityComboBoxRole},
  42       {ui::AX_ROLE_COMPLEMENTARY, NSAccessibilityGroupRole},
  43       {ui::AX_ROLE_CONTENT_INFO, NSAccessibilityGroupRole},
  44       {ui::AX_ROLE_DATE, @"AXDateField"},
  45       {ui::AX_ROLE_DATE_TIME, NSAccessibilityTextFieldRole},
  46       {ui::AX_ROLE_DEFINITION, NSAccessibilityGroupRole},
  47       {ui::AX_ROLE_DESCRIPTION_LIST_DETAIL, NSAccessibilityGroupRole},
  48       {ui::AX_ROLE_DESCRIPTION_LIST, NSAccessibilityListRole},
  49       {ui::AX_ROLE_DESCRIPTION_LIST_TERM, NSAccessibilityGroupRole},
  50       {ui::AX_ROLE_DIALOG, NSAccessibilityGroupRole},
  51       {ui::AX_ROLE_DETAILS, NSAccessibilityGroupRole},
  52       {ui::AX_ROLE_DIRECTORY, NSAccessibilityListRole},
  53       {ui::AX_ROLE_DISCLOSURE_TRIANGLE, NSAccessibilityDisclosureTriangleRole},
  54       {ui::AX_ROLE_DIV, NSAccessibilityGroupRole},
  55       {ui::AX_ROLE_DOCUMENT, NSAccessibilityGroupRole},
  56       {ui::AX_ROLE_FIGCAPTION, NSAccessibilityGroupRole},
  57       {ui::AX_ROLE_FIGURE, NSAccessibilityGroupRole},
  58       {ui::AX_ROLE_FOOTER, NSAccessibilityGroupRole},
  59       {ui::AX_ROLE_FORM, NSAccessibilityGroupRole},
  60       {ui::AX_ROLE_GRID, NSAccessibilityGridRole},
  61       {ui::AX_ROLE_GROUP, NSAccessibilityGroupRole},
  62       {ui::AX_ROLE_HEADING, @"AXHeading"},
  63       {ui::AX_ROLE_IFRAME, NSAccessibilityGroupRole},
  64       {ui::AX_ROLE_IFRAME_PRESENTATIONAL, NSAccessibilityGroupRole},
  65       {ui::AX_ROLE_IGNORED, NSAccessibilityUnknownRole},
  66       {ui::AX_ROLE_IMAGE, NSAccessibilityImageRole},
  67       {ui::AX_ROLE_IMAGE_MAP, NSAccessibilityGroupRole},
  68       {ui::AX_ROLE_IMAGE_MAP_LINK, NSAccessibilityLinkRole},
  69       {ui::AX_ROLE_INPUT_TIME, @"AXTimeField"},
  70       {ui::AX_ROLE_LABEL_TEXT, NSAccessibilityGroupRole},
  71       {ui::AX_ROLE_LEGEND, NSAccessibilityGroupRole},
  72       {ui::AX_ROLE_LINK, NSAccessibilityLinkRole},
  73       {ui::AX_ROLE_LIST, NSAccessibilityListRole},
  74       {ui::AX_ROLE_LIST_BOX, NSAccessibilityListRole},
  75       {ui::AX_ROLE_LIST_BOX_OPTION, NSAccessibilityStaticTextRole},
  76       {ui::AX_ROLE_LIST_ITEM, NSAccessibilityGroupRole},
  77       {ui::AX_ROLE_LIST_MARKER, @"AXListMarker"},
  78       {ui::AX_ROLE_LOG, NSAccessibilityGroupRole},
  79       {ui::AX_ROLE_MAIN, NSAccessibilityGroupRole},
  80       {ui::AX_ROLE_MARQUEE, NSAccessibilityGroupRole},
  81       {ui::AX_ROLE_MATH, NSAccessibilityGroupRole},
  82       {ui::AX_ROLE_MENU, NSAccessibilityMenuRole},
  83       {ui::AX_ROLE_MENU_BAR, NSAccessibilityMenuBarRole},
  84       {ui::AX_ROLE_MENU_BUTTON, NSAccessibilityButtonRole},
  85       {ui::AX_ROLE_MENU_ITEM, NSAccessibilityMenuItemRole},
  86       {ui::AX_ROLE_MENU_ITEM_CHECK_BOX, NSAccessibilityMenuItemRole},
  87       {ui::AX_ROLE_MENU_ITEM_RADIO, NSAccessibilityMenuItemRole},
  88       {ui::AX_ROLE_MENU_LIST_OPTION, NSAccessibilityMenuItemRole},
  89       {ui::AX_ROLE_MENU_LIST_POPUP, NSAccessibilityUnknownRole},
  90       {ui::AX_ROLE_METER, NSAccessibilityProgressIndicatorRole},
  91       {ui::AX_ROLE_NAVIGATION, NSAccessibilityGroupRole},
  92       {ui::AX_ROLE_NONE, NSAccessibilityGroupRole},
  93       {ui::AX_ROLE_NOTE, NSAccessibilityGroupRole},
  94       {ui::AX_ROLE_OUTLINE, NSAccessibilityOutlineRole},
  95       {ui::AX_ROLE_PARAGRAPH, NSAccessibilityGroupRole},
  96       {ui::AX_ROLE_POP_UP_BUTTON, NSAccessibilityPopUpButtonRole},
  97       {ui::AX_ROLE_PRE, NSAccessibilityGroupRole},
  98       {ui::AX_ROLE_PRESENTATIONAL, NSAccessibilityGroupRole},
  99       {ui::AX_ROLE_PROGRESS_INDICATOR, NSAccessibilityProgressIndicatorRole},
 100       {ui::AX_ROLE_RADIO_BUTTON, NSAccessibilityRadioButtonRole},
 101       {ui::AX_ROLE_RADIO_GROUP, NSAccessibilityRadioGroupRole},
 102       {ui::AX_ROLE_REGION, NSAccessibilityGroupRole},
 103       {ui::AX_ROLE_ROOT_WEB_AREA, @"AXWebArea"},
 104       {ui::AX_ROLE_ROW, NSAccessibilityRowRole},
 105       {ui::AX_ROLE_ROW_HEADER, @"AXCell"},
 106       {ui::AX_ROLE_RULER, NSAccessibilityRulerRole},
 107       {ui::AX_ROLE_SCROLL_BAR, NSAccessibilityScrollBarRole},
 108       {ui::AX_ROLE_SEARCH, NSAccessibilityGroupRole},
 109       {ui::AX_ROLE_SEARCH_BOX, NSAccessibilityTextFieldRole},
 110       {ui::AX_ROLE_SLIDER, NSAccessibilitySliderRole},
 111       {ui::AX_ROLE_SLIDER_THUMB, NSAccessibilityValueIndicatorRole},
 112       {ui::AX_ROLE_SPIN_BUTTON, NSAccessibilityIncrementorRole},
 113       {ui::AX_ROLE_SPLITTER, NSAccessibilitySplitterRole},
 114       {ui::AX_ROLE_STATIC_TEXT, NSAccessibilityStaticTextRole},
 115       {ui::AX_ROLE_STATUS, NSAccessibilityGroupRole},
 116       {ui::AX_ROLE_SVG_ROOT, NSAccessibilityGroupRole},
 117       {ui::AX_ROLE_SWITCH, NSAccessibilityCheckBoxRole},
 118       {ui::AX_ROLE_TAB, NSAccessibilityRadioButtonRole},
 119       {ui::AX_ROLE_TABLE, NSAccessibilityTableRole},
 120       {ui::AX_ROLE_TABLE_HEADER_CONTAINER, NSAccessibilityGroupRole},
 121       {ui::AX_ROLE_TAB_LIST, NSAccessibilityTabGroupRole},
 122       {ui::AX_ROLE_TAB_PANEL, NSAccessibilityGroupRole},
 123       {ui::AX_ROLE_TEXT_FIELD, NSAccessibilityTextFieldRole},
 124       {ui::AX_ROLE_TIME, NSAccessibilityGroupRole},
 125       {ui::AX_ROLE_TIMER, NSAccessibilityGroupRole},
 126       {ui::AX_ROLE_TOGGLE_BUTTON, NSAccessibilityCheckBoxRole},
 127       {ui::AX_ROLE_TOOLBAR, NSAccessibilityToolbarRole},
 128       {ui::AX_ROLE_TOOLTIP, NSAccessibilityGroupRole},
 129       {ui::AX_ROLE_TREE, NSAccessibilityOutlineRole},
 130       {ui::AX_ROLE_TREE_GRID, NSAccessibilityTableRole},
 131       {ui::AX_ROLE_TREE_ITEM, NSAccessibilityRowRole},
 132       {ui::AX_ROLE_WEB_AREA, @"AXWebArea"},
 133       {ui::AX_ROLE_WINDOW, NSAccessibilityWindowRole},
 134
 135       // TODO(dtseng): we don't correctly support the attributes for these
 136       // roles.
 137       // { ui::AX_ROLE_SCROLL_AREA, NSAccessibilityScrollAreaRole },
 138   };
 139
 140   RoleMap role_map;
 141   for (size_t i = 0; i < arraysize(roles); ++i)
 142     role_map[roles[i].value] = roles[i].nativeValue;
 143   return role_map;
 144 }
 145
 146 RoleMap BuildSubroleMap() {
 147   const MapEntry subroles[] = {
 148       {ui::AX_ROLE_ALERT, @"AXApplicationAlert"},
 149       {ui::AX_ROLE_ALERT_DIALOG, @"AXApplicationAlertDialog"},
 150       {ui::AX_ROLE_APPLICATION, @"AXLandmarkApplication"},
 151       {ui::AX_ROLE_ARTICLE, @"AXDocumentArticle"},
 152       {ui::AX_ROLE_BANNER, @"AXLandmarkBanner"},
 153       {ui::AX_ROLE_COMPLEMENTARY, @"AXLandmarkComplementary"},
 154       {ui::AX_ROLE_CONTENT_INFO, @"AXLandmarkContentInfo"},
 155       {ui::AX_ROLE_DEFINITION, @"AXDefinition"},
 156       {ui::AX_ROLE_DESCRIPTION_LIST_DETAIL, @"AXDefinition"},
 157       {ui::AX_ROLE_DESCRIPTION_LIST_TERM, @"AXTerm"},
 158       {ui::AX_ROLE_DIALOG, @"AXApplicationDialog"},
 159       {ui::AX_ROLE_DOCUMENT, @"AXDocument"},
 160       {ui::AX_ROLE_FOOTER, @"AXLandmarkContentInfo"},
 161       {ui::AX_ROLE_FORM, @"AXLandmarkForm"},
 162       {ui::AX_ROLE_LOG, @"AXApplicationLog"},
 163       {ui::AX_ROLE_MAIN, @"AXLandmarkMain"},
 164       {ui::AX_ROLE_MARQUEE, @"AXApplicationMarquee"},
 165       {ui::AX_ROLE_MATH, @"AXDocumentMath"},
 166       {ui::AX_ROLE_NAVIGATION, @"AXLandmarkNavigation"},
 167       {ui::AX_ROLE_NOTE, @"AXDocumentNote"},
 168       {ui::AX_ROLE_REGION, @"AXDocumentRegion"},
 169       {ui::AX_ROLE_SEARCH, @"AXLandmarkSearch"},
 170       {ui::AX_ROLE_SEARCH_BOX, @"AXSearchField"},
 171       {ui::AX_ROLE_STATUS, @"AXApplicationStatus"},
 172       {ui::AX_ROLE_SWITCH, @"AXSwitch"},
 173       {ui::AX_ROLE_TAB_PANEL, @"AXTabPanel"},
 174       {ui::AX_ROLE_TIMER, @"AXApplicationTimer"},
 175       {ui::AX_ROLE_TOGGLE_BUTTON, @"AXToggleButton"},
 176       {ui::AX_ROLE_TOOLTIP, @"AXUserInterfaceTooltip"},
 177       {ui::AX_ROLE_TREE_ITEM, NSAccessibilityOutlineRowSubrole},
 178   };
 179
 180   RoleMap subrole_map;
 181   for (size_t i = 0; i < arraysize(subroles); ++i)
 182     subrole_map[subroles[i].value] = subroles[i].nativeValue;
 183   return subrole_map;
 184 }
 185
 186 }  // namespace
 187
 188 @implementation AXPlatformNodeCocoa
 189
 190 // A mapping of AX roles to native roles.
 191 + (NSString*)nativeRoleFromAXRole:(ui::AXRole)role {
 192   CR_DEFINE_STATIC_LOCAL(RoleMap, role_map, (BuildRoleMap()));
 193   RoleMap::iterator it = role_map.find(role);
 194   return it != role_map.end() ? it->second : NSAccessibilityUnknownRole;
 195 }
 196
 197 // A mapping of AX roles to native subroles.
 198 + (NSString*)nativeSubroleFromAXRole:(ui::AXRole)role {
 199   CR_DEFINE_STATIC_LOCAL(RoleMap, subrole_map, (BuildSubroleMap()));
 200   RoleMap::iterator it = subrole_map.find(role);
 201   return it != subrole_map.end() ? it->second : nil;
 202 }
 203
 204 - (instancetype)initWithNode:(ui::AXPlatformNodeBase*)node {
 205   if ((self = [super init])) {
 206     node_ = node;
 207   }
 208   return self;
 209 }
 210
 211 - (void)detach {
 212   node_ = nil;
 213 }
 214
 215 - (NSRect)boundsInScreen {
 216   if (!node_)
 217     return NSZeroRect;
 218   return gfx::ScreenRectToNSRect(node_->GetBoundsInScreen());
 219 }
 220
 221 - (NSArray*)AXChildren {
 222   if (!node_)
 223     return nil;
 224   int count = node_->GetChildCount();
 225   NSMutableArray* children = [NSMutableArray arrayWithCapacity:count];
 226   for (int i = 0; i < count; ++i)
 227     [children addObject:node_->ChildAtIndex(i)];
 228   return NSAccessibilityUnignoredChildren(children);
 229 }
 230
 231 - (id)AXParent {
 232   if (!node_)
 233     return nil;
 234   return NSAccessibilityUnignoredAncestor(node_->GetParent());
 235 }
 236
 237 - (NSValue*)AXPosition {
 238   return [NSValue valueWithPoint:self.boundsInScreen.origin];
 239 }
 240
 241 - (NSString*)AXRole {
 242   if (!node_)
 243     return nil;
 244   return [[self class] nativeRoleFromAXRole:node_->GetData().role];
 245 }
 246
 247 - (NSValue*)AXSize {
 248   return [NSValue valueWithSize:self.boundsInScreen.size];
 249 }
 250
 251 - (NSString*)AXTitle {
 252   std::string value;
 253   if (node_->GetStringAttribute(ui::AX_ATTR_NAME, &value))
 254     return base::SysUTF8ToNSString(value);
 255   return nil;
 256 }
 257
 258 // NSAccessibility informal protocol implementation.
 259
 260 - (BOOL)accessibilityIsIgnored {
 261   return [[self AXRole] isEqualToString:NSAccessibilityUnknownRole];
 262 }
 263
 264 - (id)accessibilityHitTest:(NSPoint)point {
 265   for (AXPlatformNodeCocoa* child in [self AXChildren]) {
 266     if (NSPointInRect(point, child.boundsInScreen))
 267       return [child accessibilityHitTest:point];
 268   }
 269   return NSAccessibilityUnignoredAncestor(self);
 270 }
 271
 272 - (NSArray*)accessibilityActionNames {
 273   return nil;
 274 }
 275
 276 - (NSArray*)accessibilityAttributeNames {
 277   // These attributes are required on all accessibility objects.
 278   return @[
 279     NSAccessibilityChildrenAttribute,
 280     NSAccessibilityParentAttribute,
 281     NSAccessibilityPositionAttribute,
 282     NSAccessibilityRoleAttribute,
 283     NSAccessibilitySizeAttribute,
 284
 285     // Title is required for most elements. Cocoa asks for the value even if it
 286     // is omitted here, but won't present it to accessibility APIs without this.
 287     NSAccessibilityTitleAttribute,
 288   ];
 289   // TODO(tapted): Add additional attributes based on role.
 290 }
 291
 292 - (BOOL)accessibilityIsAttributeSettable:(NSString*)attribute {
 293   return NO;
 294 }
 295
 296 - (id)accessibilityAttributeValue:(NSString*)attribute {
 297   SEL selector = NSSelectorFromString(attribute);
 298   if ([self respondsToSelector:selector])
 299     return [self performSelector:selector];
 300   return nil;
 301 }
 302
 303 @end
 304
 305 namespace ui {
 306
 307 // static
 308 AXPlatformNode* AXPlatformNode::Create(AXPlatformNodeDelegate* delegate) {
 309   AXPlatformNodeBase* node = new AXPlatformNodeMac();
 310   node->Init(delegate);
 311   return node;
 312 }
 313
 314 AXPlatformNodeMac::AXPlatformNodeMac() {
 315 }
 316
 317 AXPlatformNodeMac::~AXPlatformNodeMac() {
 318 }
 319
 320 void AXPlatformNodeMac::Destroy() {
 321   if (native_node_)
 322     [native_node_ detach];
 323   delegate_ = nullptr;
 324   delete this;
 325 }
 326
 327 gfx::NativeViewAccessible AXPlatformNodeMac::GetNativeViewAccessible() {
 328   if (!native_node_)
 329     native_node_.reset([[AXPlatformNodeCocoa alloc] initWithNode:this]);
 330   return native_node_.get();
 331 }
 332
 333 void AXPlatformNodeMac::NotifyAccessibilityEvent(ui::AXEvent event_type) {
 334   // TODO(dmazzoni): implement this.  http://crbug.com/396137
 335 }
 336
 337 int AXPlatformNodeMac::GetIndexInParent() {
 338   // TODO(dmazzoni): implement this.  http://crbug.com/396137
 339   return -1;
 340 }
 341
 342 }  // namespace ui