MacViews a11y: Support the "Show menu" action in Textfield and Combobox.

ui/accessibility/platform/ax_platform_node_mac.mm

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "ui/accessibility/platform/ax_platform_node_mac.h"
 
 #import <Cocoa/Cocoa.h>
 #include <stddef.h>
 
 #include "base/macros.h"
 #include "base/strings/sys_string_conversions.h"
 #include "ui/accessibility/ax_action_data.h"
 #include "ui/accessibility/ax_node_data.h"
 #include "ui/accessibility/ax_role_properties.h"
 #include "ui/accessibility/platform/ax_platform_node.h"
 #include "ui/accessibility/platform/ax_platform_node_delegate.h"
 #include "ui/base/l10n/l10n_util.h"
 #import "ui/gfx/mac/coordinate_conversion.h"
 #include "ui/strings/grit/ui_strings.h"
 
 namespace {
 
-struct RoleMapEntry {
-  ui::AXRole value;
-  NSString* nativeValue;
-};
+using RoleMap = std::map<ui::AXRole, NSString*>;
+using EventMap = std::map<ui::AXEvent, NSString*>;
+using ActionMap = std::map<ui::AXAction, NSString*>;
 
-struct EventMapEntry {
-  ui::AXEvent value;
-  NSString* nativeValue;
-};
-
-typedef std::map<ui::AXRole, NSString*> RoleMap;
-typedef std::map<ui::AXEvent, NSString*> EventMap;
+// The AXAction for NSAccessibilityPressAction, which needs special handling.
+constexpr ui::AXAction kActionForPress = ui::AX_ACTION_DO_DEFAULT;
 
 RoleMap BuildRoleMap() {
-  const RoleMapEntry roles[] = {
+  const RoleMap::value_type roles[] = {
       {ui::AX_ROLE_ABBR, NSAccessibilityGroupRole},
       {ui::AX_ROLE_ALERT, NSAccessibilityGroupRole},
       {ui::AX_ROLE_ALERT_DIALOG, NSAccessibilityGroupRole},
       {ui::AX_ROLE_ANCHOR, NSAccessibilityGroupRole},
       {ui::AX_ROLE_ANNOTATION, NSAccessibilityUnknownRole},
       {ui::AX_ROLE_APPLICATION, NSAccessibilityGroupRole},
       {ui::AX_ROLE_ARTICLE, NSAccessibilityGroupRole},
       {ui::AX_ROLE_AUDIO, NSAccessibilityGroupRole},
       {ui::AX_ROLE_BANNER, NSAccessibilityGroupRole},
       {ui::AX_ROLE_BLOCKQUOTE, NSAccessibilityGroupRole},
@@ skipping 102 matching lines @@
       {ui::AX_ROLE_TREE_ITEM, NSAccessibilityRowRole},
       {ui::AX_ROLE_VIDEO, NSAccessibilityGroupRole},
       {ui::AX_ROLE_WEB_AREA, @"AXWebArea"},
       {ui::AX_ROLE_WINDOW, NSAccessibilityWindowRole},
 
       // TODO(dtseng): we don't correctly support the attributes for these
       // roles.
       // { ui::AX_ROLE_SCROLL_AREA, NSAccessibilityScrollAreaRole },
   };
 
-  RoleMap role_map;
-  for (size_t i = 0; i < arraysize(roles); ++i)
-    role_map[roles[i].value] = roles[i].nativeValue;
-  return role_map;
+  return RoleMap(begin(roles), end(roles));
 }
 
 RoleMap BuildSubroleMap() {
-  const RoleMapEntry subroles[] = {
+  const RoleMap::value_type subroles[] = {
       {ui::AX_ROLE_ALERT, @"AXApplicationAlert"},
       {ui::AX_ROLE_ALERT_DIALOG, @"AXApplicationAlertDialog"},
       {ui::AX_ROLE_APPLICATION, @"AXLandmarkApplication"},
       {ui::AX_ROLE_ARTICLE, @"AXDocumentArticle"},
       {ui::AX_ROLE_BANNER, @"AXLandmarkBanner"},
       {ui::AX_ROLE_COMPLEMENTARY, @"AXLandmarkComplementary"},
       {ui::AX_ROLE_CONTENT_INFO, @"AXLandmarkContentInfo"},
       {ui::AX_ROLE_DEFINITION, @"AXDefinition"},
       {ui::AX_ROLE_DESCRIPTION_LIST_DETAIL, @"AXDefinition"},
       {ui::AX_ROLE_DESCRIPTION_LIST_TERM, @"AXTerm"},
@@ skipping 13 matching lines @@
       {ui::AX_ROLE_STATUS, @"AXApplicationStatus"},
       {ui::AX_ROLE_SWITCH, @"AXSwitch"},
       {ui::AX_ROLE_TAB_PANEL, @"AXTabPanel"},
       {ui::AX_ROLE_TERM, @"AXTerm"},
       {ui::AX_ROLE_TIMER, @"AXApplicationTimer"},
       {ui::AX_ROLE_TOGGLE_BUTTON, @"AXToggleButton"},
       {ui::AX_ROLE_TOOLTIP, @"AXUserInterfaceTooltip"},
       {ui::AX_ROLE_TREE_ITEM, NSAccessibilityOutlineRowSubrole},
   };
 
-  RoleMap subrole_map;
-  for (size_t i = 0; i < arraysize(subroles); ++i)
-    subrole_map[subroles[i].value] = subroles[i].nativeValue;
-  return subrole_map;
+  return RoleMap(begin(subroles), end(subroles));
 }
 
 EventMap BuildEventMap() {
-  const EventMapEntry events[] = {
+  const EventMap::value_type events[] = {
       {ui::AX_EVENT_FOCUS, NSAccessibilityFocusedUIElementChangedNotification},
       {ui::AX_EVENT_TEXT_CHANGED, NSAccessibilityTitleChangedNotification},
       {ui::AX_EVENT_VALUE_CHANGED, NSAccessibilityValueChangedNotification},
       {ui::AX_EVENT_TEXT_SELECTION_CHANGED,
        NSAccessibilitySelectedTextChangedNotification},
       // TODO(patricialor): Add more events.
   };
 
-  EventMap event_map;
-  for (size_t i = 0; i < arraysize(events); ++i)
-    event_map[events[i].value] = events[i].nativeValue;
-  return event_map;
+  return EventMap(begin(events), end(events));
+}
+
+ActionMap BuildActionMap() {
+  const ActionMap::value_type entries[] = {
+      {ui::AX_ACTION_DECREMENT, NSAccessibilityDecrementAction},
+      {kActionForPress, NSAccessibilityPressAction},
+      {ui::AX_ACTION_INCREMENT, NSAccessibilityIncrementAction},
+      {ui::AX_ACTION_SHOW_CONTEXT_MENU, NSAccessibilityShowMenuAction},
+  };
+  return ActionMap(begin(entries), end(entries));
+}
+
+const ActionMap& GetActionMap() {
+  CR_DEFINE_STATIC_LOCAL(const ActionMap, action_map, (BuildActionMap()));
+  return action_map;
 }
 
 void NotifyMacEvent(AXPlatformNodeCocoa* target, ui::AXEvent event_type) {
   NSAccessibilityPostNotification(
       target, [AXPlatformNodeCocoa nativeNotificationFromAXEvent:event_type]);
 }
 
 }  // namespace
 
 @interface AXPlatformNodeCocoa ()
 // Helper function for string attributes that don't require extra processing.
 - (NSString*)getStringAttribute:(ui::AXStringAttribute)attribute;
 // Returns AXValue, or nil if AXValue isn't an NSString.
 - (NSString*)getAXValueAsString;
 @end
 
 @implementation AXPlatformNodeCocoa {
   ui::AXPlatformNodeBase* node_;  // Weak. Retains us.
 }
 
 @synthesize node = node_;
 
-// A mapping of AX roles to native roles.
 + (NSString*)nativeRoleFromAXRole:(ui::AXRole)role {
-  CR_DEFINE_STATIC_LOCAL(RoleMap, role_map, (BuildRoleMap()));
-  RoleMap::iterator it = role_map.find(role);
+  CR_DEFINE_STATIC_LOCAL(const RoleMap, role_map, (BuildRoleMap()));
+  RoleMap::const_iterator it = role_map.find(role);
   return it != role_map.end() ? it->second : NSAccessibilityUnknownRole;
 }
 
-// A mapping of AX roles to native subroles.
 + (NSString*)nativeSubroleFromAXRole:(ui::AXRole)role {
-  CR_DEFINE_STATIC_LOCAL(RoleMap, subrole_map, (BuildSubroleMap()));
-  RoleMap::iterator it = subrole_map.find(role);
+  CR_DEFINE_STATIC_LOCAL(const RoleMap, subrole_map, (BuildSubroleMap()));
+  RoleMap::const_iterator it = subrole_map.find(role);
   return it != subrole_map.end() ? it->second : nil;
 }
 
-// A mapping of AX events to native notifications.
 + (NSString*)nativeNotificationFromAXEvent:(ui::AXEvent)event {
-  CR_DEFINE_STATIC_LOCAL(EventMap, event_map, (BuildEventMap()));
-  EventMap::iterator it = event_map.find(event);
+  CR_DEFINE_STATIC_LOCAL(const EventMap, event_map, (BuildEventMap()));
+  EventMap::const_iterator it = event_map.find(event);
   return it != event_map.end() ? it->second : nil;
 }
 
 - (instancetype)initWithNode:(ui::AXPlatformNodeBase*)node {
   if ((self = [super init])) {
     node_ = node;
   }
   return self;
 }
 
@@ skipping 45 matching lines @@
 }
 
 - (id)accessibilityFocusedUIElement {
   return node_->GetDelegate()->GetFocus();
 }
 
 - (NSArray*)accessibilityActionNames {
   base::scoped_nsobject<NSMutableArray> axActions(
       [[NSMutableArray alloc] init]);
 
+  const ui::AXNodeData& data = node_->GetData();
+
   // VoiceOver expects the "press" action to be first.
-  if (ui::IsRoleClickable(node_->GetData().role))
+  if (ui::IsRoleClickable(data.role) || data.HasAction(kActionForPress))
     [axActions addObject:NSAccessibilityPressAction];
 
+  for (const ActionMap::value_type& entry : GetActionMap()) {
+    if (entry.first == kActionForPress)
+      continue;
+
+    DCHECK(![entry.second isEqualToString:NSAccessibilityPressAction]);
+
+    if (data.HasAction(entry.first))
+      [axActions addObject:entry.second];
+  }
+
   return axActions.autorelease();
 }
 
 - (void)accessibilityPerformAction:(NSString*)action {
   DCHECK([[self accessibilityActionNames] containsObject:action]);
   ui::AXActionData data;
-  if ([action isEqualToString:NSAccessibilityPressAction])
-    data.action = ui::AX_ACTION_DO_DEFAULT;
+  for (const ActionMap::value_type& entry : GetActionMap()) {

[dmazzoni, 2017/06/21 06:09:35]

It doesn't look like you're ever using ActionMap as a map, i.e.
looking up a key and getting a value.

If you reversed it, you could look up the Mac action and retrieve
the Chrome action.

Alternatively, if you made it a vector of pairs, you could just enforce
that kActionForPress is first and not have to have any special cases
in accessibilityActionNames

[tapted, 2017/06/21 06:52:55]

Indeed! good catch. and it's as easy as changing the typedef (I had tried, but
was on the fence). I settled for a map in case we wanted a
+(NSString*)nativeActionFromAXAction:(ui::AXAction)action; to go with the others
in future. I had that on earlier CLs but I couldn't find a use for that now in
browser_accessibility_mac so deleted it. I'll put up a CL using vector, and with
the press action first.

[tapted, 2017/06/21 11:13:11]

Well.. everything _compiled_ fine with just the typedef change, but it needed a
bit more. Not as elegant as I was hoping - happy to try other things.

+    if ([action isEqualToString:entry.second]) {
+      data.action = entry.first;
+      break;
+    }
+  }
 
   // Note ui::AX_ACTIONs which are just overwriting an accessibility attribute
   // are already implemented in -accessibilitySetValue:forAttribute:, so ignore
   // those here.
 
   if (data.action != ui::AX_ACTION_NONE)
     node_->GetDelegate()->AccessibilityPerformAction(data);
 }
 
 - (NSArray*)accessibilityAttributeNames {
@@ skipping 339 matching lines @@
   }
   NotifyMacEvent(native_node_, event_type);
 }
 
 int AXPlatformNodeMac::GetIndexInParent() {
   // TODO(dmazzoni): implement this.  http://crbug.com/396137
   return -1;
 }
 
 }  // namespace ui