Mac a11y: Add RoleDescription and Value attributes to accessibility information.

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"
 #import "ui/accessibility/ax_node_data.h"

[tapted, 2016/06/17 03:32:49]

nit: can you update this to #include while you're here

[Patti Lor, 2016/06/17 05:57:35]

Done.

+#include "ui/accessibility/ax_view_state.h"
 #import "ui/accessibility/platform/ax_platform_node_delegate.h"

[tapted, 2016/06/17 03:32:49]

this too - these are not objc headers

[Patti Lor, 2016/06/17 05:57:35]

Done, thanks for noticing :)

 #import "ui/gfx/mac/coordinate_conversion.h"
 
 namespace {
 
 struct MapEntry {
   ui::AXRole value;
   NSString* nativeValue;
 };
 
 typedef std::map<ui::AXRole, NSString*> RoleMap;
@@ skipping 159 matching lines @@
   };
 
   RoleMap subrole_map;
   for (size_t i = 0; i < arraysize(subroles); ++i)
     subrole_map[subroles[i].value] = subroles[i].nativeValue;
   return subrole_map;
 }
 
 }  // namespace
 
+@interface AXPlatformNodeCocoa ()
+// Helper function for string attributes that don't require extra processing.
+- (NSString*)getStringAttribute:(ui::AXStringAttribute)attribute;
+@end
+
 @implementation AXPlatformNodeCocoa
 
 // 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);
   return it != role_map.end() ? it->second : NSAccessibilityUnknownRole;
 }
 
 // A mapping of AX roles to native subroles.
@@ skipping 13 matching lines @@
 - (void)detach {
   node_ = nil;
 }
 
 - (NSRect)boundsInScreen {
   if (!node_)
     return NSZeroRect;
   return gfx::ScreenRectToNSRect(node_->GetBoundsInScreen());
 }
 
-- (NSArray*)AXChildren {
-  if (!node_)
-    return nil;
-  int count = node_->GetChildCount();
-  NSMutableArray* children = [NSMutableArray arrayWithCapacity:count];
-  for (int i = 0; i < count; ++i)
-    [children addObject:node_->ChildAtIndex(i)];
-  return NSAccessibilityUnignoredChildren(children);
-}
-
-- (id)AXParent {
-  if (!node_)
-    return nil;
-  return NSAccessibilityUnignoredAncestor(node_->GetParent());
-}
-
-- (NSValue*)AXPosition {
-  return [NSValue valueWithPoint:self.boundsInScreen.origin];
-}
-
-- (NSString*)AXRole {
-  if (!node_)
-    return nil;
-  return [[self class] nativeRoleFromAXRole:node_->GetData().role];
-}
-
-- (NSValue*)AXSize {
-  return [NSValue valueWithSize:self.boundsInScreen.size];
-}
-
-- (NSString*)AXTitle {
-  std::string value;
-  if (node_->GetStringAttribute(ui::AX_ATTR_NAME, &value))
-    return base::SysUTF8ToNSString(value);
+- (NSString*)getStringAttribute:(ui::AXStringAttribute)attribute {
+  std::string attributeValue;
+  if (node_->GetStringAttribute(attribute, &attributeValue))
+    return base::SysUTF8ToNSString(attributeValue);
   return nil;
 }
 
 // NSAccessibility informal protocol implementation.
 
 - (BOOL)accessibilityIsIgnored {
   return [[self AXRole] isEqualToString:NSAccessibilityUnknownRole];
 }
 
 - (id)accessibilityHitTest:(NSPoint)point {
   for (AXPlatformNodeCocoa* child in [self AXChildren]) {
     if (NSPointInRect(point, child.boundsInScreen))
       return [child accessibilityHitTest:point];
   }
   return NSAccessibilityUnignoredAncestor(self);
 }
 
 - (NSArray*)accessibilityActionNames {
   return nil;
 }
 
 - (NSArray*)accessibilityAttributeNames {
   // These attributes are required on all accessibility objects.
-  return @[
-    NSAccessibilityChildrenAttribute,
-    NSAccessibilityParentAttribute,
-    NSAccessibilityPositionAttribute,
-    NSAccessibilityRoleAttribute,
-    NSAccessibilitySizeAttribute,
+  NSArray* const kAllRoleAttributes = @[
+    NSAccessibilityChildrenAttribute, NSAccessibilityParentAttribute,
+    NSAccessibilityPositionAttribute, NSAccessibilityRoleAttribute,
+    NSAccessibilitySizeAttribute, NSAccessibilitySubroleAttribute,
 
     // Title is required for most elements. Cocoa asks for the value even if it
     // is omitted here, but won't present it to accessibility APIs without this.
     NSAccessibilityTitleAttribute,
+
+    // Attributes which are not required, but are general to all roles.
+    NSAccessibilityRoleDescriptionAttribute

[tapted, 2016/06/17 03:32:49]

nit: comma after

[Patti Lor, 2016/06/17 05:57:35]

Done.

   ];
-  // TODO(tapted): Add additional attributes based on role.
+
+  // Attributes required for user-editable controls.
+  NSArray* const kValueAttributes = @[ NSAccessibilityValueAttribute ];
+
+  base::scoped_nsobject<NSMutableArray> axAttributes(
+      [[NSMutableArray alloc] init]);
+  [axAttributes addObjectsFromArray:kAllRoleAttributes];

[tapted, 2016/06/17 03:32:49]

nit: blank line before

[Patti Lor, 2016/06/17 05:57:35]

Done.

+  switch (node_->GetData().role) {
+    case ui::AX_ROLE_CHECK_BOX:
+    case ui::AX_ROLE_COMBO_BOX:
+    case ui::AX_ROLE_MENU_ITEM_CHECK_BOX:
+    case ui::AX_ROLE_MENU_ITEM_RADIO:
+    case ui::AX_ROLE_RADIO_BUTTON:
+    case ui::AX_ROLE_SEARCH_BOX:
+    case ui::AX_ROLE_SLIDER:
+    case ui::AX_ROLE_SLIDER_THUMB:
+    case ui::AX_ROLE_TOGGLE_BUTTON:
+    case ui::AX_ROLE_TEXT_FIELD:
+      [axAttributes addObjectsFromArray:kValueAttributes];
+      break;
+    // TODO(tapted): Add additional attributes based on role.
+    default:
+      break;
+  }
+  return axAttributes.autorelease();
 }
 
 - (BOOL)accessibilityIsAttributeSettable:(NSString*)attribute {
   return NO;
 }
 
 - (id)accessibilityAttributeValue:(NSString*)attribute {
   SEL selector = NSSelectorFromString(attribute);
   if ([self respondsToSelector:selector])
     return [self performSelector:selector];
   return nil;
 }
 
+// NSAccessibility attributes.
+
+- (NSArray*)AXChildren {
+  if (!node_)
+    return nil;
+  int count = node_->GetChildCount();
+  NSMutableArray* children = [NSMutableArray arrayWithCapacity:count];
+  for (int i = 0; i < count; ++i)
+    [children addObject:node_->ChildAtIndex(i)];
+  return NSAccessibilityUnignoredChildren(children);
+}
+
+- (id)AXParent {
+  if (!node_)
+    return nil;
+  return NSAccessibilityUnignoredAncestor(node_->GetParent());
+}
+
+- (NSValue*)AXPosition {
+  return [NSValue valueWithPoint:self.boundsInScreen.origin];
+}
+
+- (NSString*)AXRole {
+  if (!node_)
+    return nil;
+  return [[self class] nativeRoleFromAXRole:node_->GetData().role];
+}
+
+- (NSString*)AXSubrole {
+  ui::AXRole role = node_->GetData().role;
+  switch (role) {
+    case ui::AX_ROLE_TEXT_FIELD:
+      if (ui::AXViewState::IsFlagSet(node_->GetData().state,
+                                     ui::AX_STATE_PROTECTED)) {
+        return NSAccessibilitySecureTextFieldSubrole;
+      }

[tapted, 2016/06/17 03:32:49]

nit: no curlies required

[Patti Lor, 2016/06/17 05:57:35]

Done.

+      break;
+    default:
+      break;
+  }
+  return [AXPlatformNodeCocoa nativeSubroleFromAXRole:role];
+}
+
+- (NSString*)AXRoleDescription {
+  NSString* description = [self getStringAttribute:ui::AX_ATTR_DESCRIPTION];
+  if (!description)
+    return NSAccessibilityRoleDescription([self AXRole], [self AXSubrole]);
+  return description;
+}
+
+- (NSValue*)AXSize {
+  return [NSValue valueWithSize:self.boundsInScreen.size];
+}
+
+- (NSString*)AXTitle {
+  return [self getStringAttribute:ui::AX_ATTR_NAME];
+}
+
+- (NSString*)AXValue {
+  return [self getStringAttribute:ui::AX_ATTR_VALUE];
+}
+
 @end
 
 namespace ui {
 
 // static
 AXPlatformNode* AXPlatformNode::Create(AXPlatformNodeDelegate* delegate) {
   AXPlatformNodeBase* node = new AXPlatformNodeMac();
   node->Init(delegate);
   return node;
 }
@@ skipping 19 matching lines @@
 void AXPlatformNodeMac::NotifyAccessibilityEvent(ui::AXEvent event_type) {
   // TODO(dmazzoni): implement this.  http://crbug.com/396137
 }
 
 int AXPlatformNodeMac::GetIndexInParent() {
   // TODO(dmazzoni): implement this.  http://crbug.com/396137
   return -1;
 }
 
 }  // namespace ui