Add a context field to the accessibility extension API.

chrome/browser/ui/views/accessibility_event_router_views.cc

 // Copyright (c) 2011 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.
 
 #include "chrome/browser/ui/views/accessibility_event_router_views.h"
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/message_loop.h"
 #include "base/utf_string_conversions.h"
@@ skipping 157 matching lines @@
     // caught so we can add accessibility extension API support.
     NOTREACHED();
   }
 }
 
 void AccessibilityEventRouterViews::SendButtonNotification(
     views::View* view,
     int type,
     Profile* profile) {
   AccessibilityButtonInfo info(profile, GetViewName(view));
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendLinkNotification(
     views::View* view,
     int type,
     Profile* profile) {
   AccessibilityLinkInfo info(profile, GetViewName(view));
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendMenuNotification(
     views::View* view,
     int type,
     Profile* profile) {
   AccessibilityMenuInfo info(profile, GetViewName(view));
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendMenuItemNotification(
     views::View* view,
     int type,
     Profile* profile) {
   std::string name = GetViewName(view);
 
   bool has_submenu = false;
   int index = -1;
   int count = -1;
 
   if (view->GetClassName() == views::MenuItemView::kViewClassName)
     has_submenu = static_cast<views::MenuItemView*>(view)->HasSubmenu();
 
   views::View* parent_menu = view->parent();
   while (parent_menu != NULL && parent_menu->GetClassName() !=
          views::SubmenuView::kViewClassName) {
     parent_menu = parent_menu->parent();
   }
   if (parent_menu) {
     count = 0;
     RecursiveGetMenuItemIndexAndCount(parent_menu, view, &index, &count);
   }
 
   AccessibilityMenuItemInfo info(profile, name, has_submenu, index, count);
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendTextfieldNotification(
     views::View* view,
     int type,
     Profile* profile) {
   ui::AccessibleViewState state;
   view->GetAccessibleState(&state);
   std::string name = UTF16ToUTF8(state.name);
   bool password =
       (state.state & ui::AccessibilityTypes::STATE_PROTECTED) != 0;
   AccessibilityTextBoxInfo info(profile, name, password);
   std::string value = UTF16ToUTF8(state.value);
   info.SetValue(value, state.selection_start, state.selection_end);
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendComboboxNotification(
     views::View* view,
     int type,
     Profile* profile) {
   ui::AccessibleViewState state;
   view->GetAccessibleState(&state);
   std::string name = UTF16ToUTF8(state.name);
   std::string value = UTF16ToUTF8(state.value);
   AccessibilityComboBoxInfo info(
       profile, name, value, state.index, state.count);
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendCheckboxNotification(
     views::View* view,
     int type,
     Profile* profile) {
   ui::AccessibleViewState state;
   view->GetAccessibleState(&state);
   std::string name = UTF16ToUTF8(state.name);
   std::string value = UTF16ToUTF8(state.value);
   AccessibilityCheckboxInfo info(
       profile, name, state.state == ui::AccessibilityTypes::STATE_CHECKED);
+  AddContextInfo(view, &info);
   SendAccessibilityNotification(type, &info);
 }
 
 void AccessibilityEventRouterViews::SendWindowNotification(
     views::View* view,
     int type,
     Profile* profile) {
   ui::AccessibleViewState state;
   view->GetAccessibleState(&state);
   std::string window_text;
@@ skipping 10 matching lines @@
   AccessibilityWindowInfo info(profile, window_text);
   SendAccessibilityNotification(type, &info);
 }
 
 std::string AccessibilityEventRouterViews::GetViewName(views::View* view) {
   ui::AccessibleViewState state;
   view->GetAccessibleState(&state);
   return UTF16ToUTF8(state.name);
 }
 
+void AccessibilityEventRouterViews::AddContextInfo(

[sky, 2011/12/07 22:01:55]

Order should match header.

[dmazzoni, 2011/12/07 23:13:49]

Done.

+    views::View* view, AccessibilityControlInfo* info) {
+  for (views::View* parent = view->parent();
+       parent;
+       parent = parent->parent()) {
+    ui::AccessibleViewState state;
+    parent->GetAccessibleState(&state);
+
+    // Two cases are handled right now. More could be added in the future
+    // depending on how the UI evolves.
+
+    // A control in a toolbar should use the toolbar's accessible name
+    // as the context.
+    if (state.role == ui::AccessibilityTypes::ROLE_TOOLBAR &&
+        !state.name.empty()) {
+      info->set_context(UTF16ToUTF8(state.name));
+      return;
+    }
+
+    // A control inside of an alert (like an infobar) should grab the
+    // first static text descendant as the context; that's the prompt.
+    if (state.role == ui::AccessibilityTypes::ROLE_ALERT) {
+      views::View* static_text_child = FindDescendantWithAccessibleRole(
+          parent, ui::AccessibilityTypes::ROLE_STATICTEXT);
+      if (static_text_child) {

[sky, 2011/12/07 22:01:55]

I don't know this code well enough, so this might not matter. But it seem if you
have a string of ROLE_ALERT ancestors you're going to revisit the same views
many times by way of FindDescendantWithAccessibleRole.

[dmazzoni, 2011/12/07 23:13:49]

That should never happen (multiple ALERTs in the parent chain). I moved the
return up one level so that only the first ALERT it hits matters.

+        ui::AccessibleViewState state;
+        static_text_child->GetAccessibleState(&state);
+        if (!state.name.empty()) {
+          info->set_context(UTF16ToUTF8(state.name));
+          return;
+        }
+      }
+    }
+  }
+}
+
+views::View* AccessibilityEventRouterViews::FindDescendantWithAccessibleRole(

[sky, 2011/12/07 22:01:55]

Neither of these methods look like they need any state from
AccessibilityEventRouterViews. I would be inclined to make them static.

[dmazzoni, 2011/12/07 23:13:49]

Done - made a few more methods static too.

+    views::View* view, ui::AccessibilityTypes::Role role) {
+  ui::AccessibleViewState state;
+  view->GetAccessibleState(&state);
+  if (state.role == role)
+    return view;
+
+  for (int i = 0; i < view->child_count(); i++) {
+    views::View* child = view->child_at(i);
+    views::View* result = FindDescendantWithAccessibleRole(child, role);
+    if (result)
+      return result;
+  }
+
+  return NULL;
+}
+
 bool AccessibilityEventRouterViews::IsMenuEvent(
     views::View* view,
     int type) {
   if (type == chrome::NOTIFICATION_ACCESSIBILITY_MENU_OPENED ||
       type == chrome::NOTIFICATION_ACCESSIBILITY_MENU_CLOSED)
     return true;
 
   while (view) {
     ui::AccessibleViewState state;
     view->GetAccessibleState(&state);
@@ skipping 38 matching lines @@
     return UTF16ToUTF8(state.name);
 
   for (int i = 0; i < view->child_count(); ++i) {
     views::View* child = view->child_at(i);
     std::string result = RecursiveGetStaticText(child);
     if (!result.empty())
       return result;
   }
   return std::string();
 }