Implement ATK Action & Document interface for WebContent Accessibility.

content/browser/accessibility/browser_accessibility_auralinux.cc

 // Copyright (c) 2015 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 "content/browser/accessibility/browser_accessibility_auralinux.h"
 
 #include "base/strings/utf_string_conversions.h"
 #include "content/browser/accessibility/browser_accessibility_manager_auralinux.h"
 #include "content/common/accessibility_messages.h"
 
 namespace content {
 
 static gpointer browser_accessibility_parent_class = NULL;
 
 static BrowserAccessibilityAuraLinux* ToBrowserAccessibilityAuraLinux(
     BrowserAccessibilityAtk* atk_object) {
   if (!atk_object)
     return NULL;
 
   return atk_object->m_object;
 }
 
 //
+// AtkAction interface.
+//
+
+static BrowserAccessibilityAuraLinux* ToBrowserAccessibilityAuraLinux(
+    AtkAction* atk_action) {
+  if (!IS_BROWSER_ACCESSIBILITY(atk_action))
+    return NULL;
+
+  return ToBrowserAccessibilityAuraLinux(BROWSER_ACCESSIBILITY(atk_action));
+}
+
+static gboolean browser_accessibility_do_action(AtkAction* atk_action,
+                                                gint index) {
+  g_return_val_if_fail(ATK_IS_ACTION(atk_action), FALSE);
+  g_return_val_if_fail(!index, FALSE);
+
+  BrowserAccessibilityAuraLinux* obj =
+      ToBrowserAccessibilityAuraLinux(atk_action);
+  if (!obj)
+    return FALSE;
+
+  obj->manager()->DoDefaultAction(*obj);
+
+  return TRUE;
+}
+
+static gint browser_accessibility_get_n_actions(AtkAction* atk_action) {
+  g_return_val_if_fail(ATK_IS_ACTION(atk_action), 0);
+
+  BrowserAccessibilityAuraLinux* obj =
+      ToBrowserAccessibilityAuraLinux(atk_action);
+  if (!obj)
+    return 0;
+
+  return 1;
+}
+
+static const gchar* browser_accessibility_get_description(AtkAction* atk_action,

[dmazzoni, 2015/07/27 18:09:04]

This function is to return a description of the *action*, but you're returning a
description of the *object*.

I think you can just leave this function out, or if it's required, just return
the empty string.

+                                                          gint) {
+  g_return_val_if_fail(ATK_IS_ACTION(atk_action), 0);
+  BrowserAccessibilityAuraLinux* obj =
+      ToBrowserAccessibilityAuraLinux(atk_action);
+  if (!obj)
+    return 0;
+
+  return obj->GetStringAttribute(ui::AX_ATTR_DESCRIPTION).c_str();
+}
+
+static const gchar* browser_accessibility_get_name(AtkAction* atk_action,
+                                                   gint index) {
+  g_return_val_if_fail(ATK_IS_ACTION(atk_action), 0);
+  g_return_val_if_fail(!index, 0);
+  BrowserAccessibilityAuraLinux* obj =
+      ToBrowserAccessibilityAuraLinux(atk_action);
+  if (!obj)
+    return 0;
+
+  return obj->GetStringAttribute(ui::AX_ATTR_ACTION).c_str();
+}
+
+static const gchar* browser_accessibility_get_keybinding(AtkAction* atk_action,
+                                                         gint index) {
+  g_return_val_if_fail(ATK_IS_ACTION(atk_action), 0);
+  g_return_val_if_fail(!index, 0);
+  BrowserAccessibilityAuraLinux* obj =
+      ToBrowserAccessibilityAuraLinux(atk_action);
+  if (!obj)
+    return 0;
+
+  return obj->GetStringAttribute(ui::AX_ATTR_ACCESS_KEY).c_str();
+}
+
+static void ActionInterfaceInit(AtkActionIface* iface) {
+  iface->do_action = browser_accessibility_do_action;
+  iface->get_n_actions = browser_accessibility_get_n_actions;
+  iface->get_description = browser_accessibility_get_description;
+  iface->get_name = browser_accessibility_get_name;
+  iface->get_keybinding = browser_accessibility_get_keybinding;
+}
+
+static const GInterfaceInfo ActionInfo = {
+    reinterpret_cast<GInterfaceInitFunc>(ActionInterfaceInit), 0, 0};
+
+//
 // AtkComponent interface.
 //
 
 static BrowserAccessibilityAuraLinux* ToBrowserAccessibilityAuraLinux(
     AtkComponent* atk_component) {
   if (!IS_BROWSER_ACCESSIBILITY(atk_component))
     return NULL;
 
   return ToBrowserAccessibilityAuraLinux(BROWSER_ACCESSIBILITY(atk_component));
 }
@@ skipping 65 matching lines @@
   iface->get_extents = browser_accessibility_get_extents;
   iface->grab_focus = browser_accessibility_grab_focus;
 }
 
 static const GInterfaceInfo ComponentInfo = {
     reinterpret_cast<GInterfaceInitFunc>(ComponentInterfaceInit),
     0,
     0};
 
 //
+// AtkDocument interface.
+//
+
+static BrowserAccessibilityAuraLinux* ToBrowserAccessibilityAuraLinux(
+    AtkDocument* atk_doc) {
+  if (!IS_BROWSER_ACCESSIBILITY(atk_doc))
+    return NULL;
+
+  return ToBrowserAccessibilityAuraLinux(BROWSER_ACCESSIBILITY(atk_doc));
+}
+
+static const gchar* GetDocumentAttributeValue(
+    BrowserAccessibilityAuraLinux* obj,
+    const gchar* attribute) {
+  if (!g_ascii_strcasecmp(attribute, "DocType"))
+    return obj->GetStringAttribute(ui::AX_ATTR_DOC_DOCTYPE).c_str();
+  else if (!g_ascii_strcasecmp(attribute, "MimeType"))
+    return obj->GetStringAttribute(ui::AX_ATTR_DOC_MIMETYPE).c_str();
+  else if (!g_ascii_strcasecmp(attribute, "Title"))
+    return obj->GetStringAttribute(ui::AX_ATTR_DOC_TITLE).c_str();
+  else if (!g_ascii_strcasecmp(attribute, "URI"))
+    return obj->GetStringAttribute(ui::AX_ATTR_DOC_URL).c_str();
+
+  return 0;
+}
+
+AtkAttributeSet* SetAtkAttributeSet(AtkAttributeSet* attributeSet,

[dmazzoni, 2015/07/27 18:09:04]

nit: attributeSet -> attribute_set

+                                    const char* name,
+                                    const char* value) {
+  AtkAttribute* attribute =
+      static_cast<AtkAttribute*>(g_malloc(sizeof(AtkAttribute)));
+  attribute->name = g_strdup(name);
+  attribute->value = g_strdup(value);
+  attributeSet = g_slist_prepend(attributeSet, attribute);
+  return attributeSet;
+}
+
+static const gchar* browser_accessibility_get_attribute_value(
+    AtkDocument* atk_doc,
+    const gchar* attribute) {
+  g_return_val_if_fail(ATK_IS_DOCUMENT(atk_doc), 0);
+  BrowserAccessibilityAuraLinux* obj = ToBrowserAccessibilityAuraLinux(atk_doc);
+  if (!obj)
+    return 0;
+
+  return GetDocumentAttributeValue(obj, attribute);
+}
+
+static AtkAttributeSet* browser_accessibility_get_attributes(
+    AtkDocument* atk_doc) {
+  g_return_val_if_fail(ATK_IS_DOCUMENT(atk_doc), 0);
+  BrowserAccessibilityAuraLinux* obj = ToBrowserAccessibilityAuraLinux(atk_doc);
+  if (!obj)
+    return 0;
+
+  AtkAttributeSet* attributeSet = 0;
+  const gchar* doc_attributes[] = {"DocType", "MimeType", "Title", "URI"};
+  const gchar* value = 0;
+
+  for (unsigned i = 0; i < G_N_ELEMENTS(doc_attributes); i++) {
+    value = GetDocumentAttributeValue(obj, doc_attributes[i]);
+    if (value)
+      attributeSet = SetAtkAttributeSet(attributeSet, doc_attributes[i], value);
+  }
+
+  return attributeSet;
+}
+
+static void DocumentInterfaceInit(AtkDocumentIface* iface) {
+  iface->get_document_attribute_value =
+      browser_accessibility_get_attribute_value;
+  iface->get_document_attributes = browser_accessibility_get_attributes;
+}
+
+static const GInterfaceInfo DocumentInfo = {
+    reinterpret_cast<GInterfaceInitFunc>(DocumentInterfaceInit), 0, 0};
+
+//
 // AtkValue interface.
 //
 
 static BrowserAccessibilityAuraLinux* ToBrowserAccessibilityAuraLinux(
     AtkValue* atk_object) {
   if (!IS_BROWSER_ACCESSIBILITY(atk_object))
     return NULL;
 
   return ToBrowserAccessibilityAuraLinux(BROWSER_ACCESSIBILITY(atk_object));
 }
@@ skipping 285 matching lines @@
   ATK_TEXT_INTERFACE,
   ATK_VALUE_INTERFACE,
 };
 
 static int GetInterfaceMaskFromObject(BrowserAccessibilityAuraLinux* obj) {
   int interface_mask = 0;
 
   // Component interface is always supported.
   interface_mask |= 1 << ATK_COMPONENT_INTERFACE;
 
+  // Action interface is basic one. It just relays on executing default action
+  // for each object.
+  interface_mask |= 1 << ATK_ACTION_INTERFACE;
+
+  // Value Interface
   int role = obj->GetRole();
   if (role == ui::AX_ROLE_PROGRESS_INDICATOR ||
       role == ui::AX_ROLE_SCROLL_BAR || role == ui::AX_ROLE_SLIDER) {
     interface_mask |= 1 << ATK_VALUE_INTERFACE;
   }
 
+  // Document Interface
+  if (role == ui::AX_ROLE_DOCUMENT || role == ui::AX_ROLE_ROOT_WEB_AREA ||
+      role == ui::AX_ROLE_WEB_AREA)
+    interface_mask |= 1 << ATK_DOCUMENT_INTERFACE;
+
   return interface_mask;
 }
 
 static GType GetAccessibilityTypeFromObject(
     BrowserAccessibilityAuraLinux* obj) {
   static const GTypeInfo type_info = {
       sizeof(BrowserAccessibilityAtkClass),
       (GBaseInitFunc)0,
       (GBaseFinalizeFunc)0,
       (GClassInitFunc)0,
       (GClassFinalizeFunc)0,
       0,                               /* class data */
       sizeof(BrowserAccessibilityAtk), /* instance size */
       0,                               /* nb preallocs */
       (GInstanceInitFunc)0,
       0 /* value table */
   };
 
   int interface_mask = GetInterfaceMaskFromObject(obj);
   const char* atk_type_name = GetUniqueAccessibilityTypeName(interface_mask);
   GType type = g_type_from_name(atk_type_name);
   if (type)
     return type;
 
   type = g_type_register_static(BROWSER_ACCESSIBILITY_TYPE, atk_type_name,
                                 &type_info, GTypeFlags(0));
+  if (interface_mask & (1 << ATK_ACTION_INTERFACE))
+    g_type_add_interface_static(type, ATK_TYPE_ACTION, &ActionInfo);
   if (interface_mask & (1 << ATK_COMPONENT_INTERFACE))
     g_type_add_interface_static(type, ATK_TYPE_COMPONENT, &ComponentInfo);
+  if (interface_mask & (1 << ATK_DOCUMENT_INTERFACE))
+    g_type_add_interface_static(type, ATK_TYPE_DOCUMENT, &DocumentInfo);
   if (interface_mask & (1 << ATK_VALUE_INTERFACE))
     g_type_add_interface_static(type, ATK_TYPE_VALUE, &ValueInfo);
 
   return type;
 }
 
 BrowserAccessibilityAtk* browser_accessibility_new(
     BrowserAccessibilityAuraLinux* obj) {
   GType type = GetAccessibilityTypeFromObject(obj);
   AtkObject* atk_object = static_cast<AtkObject*>(g_object_new(type, 0));
@@ skipping 205 matching lines @@
     case ui::AX_ROLE_TREE_ITEM:
       atk_role_ = ATK_ROLE_TREE_ITEM;
       break;
     default:
       atk_role_ = ATK_ROLE_UNKNOWN;
       break;
   }
 }
 
 }  // namespace content