Add initial GTK web accessibility framework (third attempt).

content/browser/accessibility/browser_accessibility_win.cc

 // Copyright (c) 2012 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_win.h"
 
 #include <UIAutomationClient.h>
 #include <UIAutomationCoreApi.h>
 
 #include "base/string_number_conversions.h"
@@ skipping 117 matching lines @@
     return E_INVALIDARG;
   }
 
   BrowserAccessibilityManager* manager = owner_->manager();
   BrowserAccessibility* result =
       manager->GetFromRendererID(target_ids_[target_index]);
   if (!result || !result->instance_active())
     return E_FAIL;
 
   *target = static_cast<IAccessible*>(
-      result->toBrowserAccessibilityWin()->NewReference());
+      result->ToBrowserAccessibilityWin()->NewReference());
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityRelation::get_targets(
     long max_targets, IUnknown** targets, long* n_targets) {
   if (!targets || !n_targets)
     return E_INVALIDARG;
 
   if (!owner_->instance_active())
     return E_FAIL;
@@ skipping 20 matching lines @@
 //
 
 // static
 BrowserAccessibility* BrowserAccessibility::Create() {
   CComObject<BrowserAccessibilityWin>* instance;
   HRESULT hr = CComObject<BrowserAccessibilityWin>::CreateInstance(&instance);
   DCHECK(SUCCEEDED(hr));
   return instance->NewReference();
 }
 
-BrowserAccessibilityWin* BrowserAccessibility::toBrowserAccessibilityWin() {
+BrowserAccessibilityWin* BrowserAccessibility::ToBrowserAccessibilityWin() {
   return static_cast<BrowserAccessibilityWin*>(this);
 }
 
 BrowserAccessibilityWin::BrowserAccessibilityWin()
     : ia_role_(0),
       ia_state_(0),
       ia2_role_(0),
       ia2_state_(0),
       first_time_(true),
       old_ia_state_(0) {
@@ skipping 41 matching lines @@
     return S_FALSE;
   }
 
   BrowserAccessibility* result = BrowserAccessibilityForPoint(point);
   if (result == this) {
     // Point is within this object.
     child->vt = VT_I4;
     child->lVal = CHILDID_SELF;
   } else {
     child->vt = VT_DISPATCH;
-    child->pdispVal = result->toBrowserAccessibilityWin()->NewReference();
+    child->pdispVal = result->ToBrowserAccessibilityWin()->NewReference();
   }
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::accLocation(LONG* x_left, LONG* y_top,
                                                   LONG* width, LONG* height,
                                                   VARIANT var_id) {
   if (!instance_active_)
     return E_FAIL;
 
@@ skipping 48 matching lines @@
       result = target->GetPreviousSibling();
       break;
   }
 
   if (!result) {
     end->vt = VT_EMPTY;
     return S_FALSE;
   }
 
   end->vt = VT_DISPATCH;
-  end->pdispVal = result->toBrowserAccessibilityWin()->NewReference();
+  end->pdispVal = result->ToBrowserAccessibilityWin()->NewReference();
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_accChild(VARIANT var_child,
                                                    IDispatch** disp_child) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!disp_child)
     return E_INVALIDARG;
@@ skipping 137 matching lines @@
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_accParent(IDispatch** disp_parent) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!disp_parent)
     return E_INVALIDARG;
 
-  IAccessible* parent = parent_->toBrowserAccessibilityWin();
+  IAccessible* parent = parent_->ToBrowserAccessibilityWin();
   if (parent == NULL) {
     // This happens if we're the root of the tree;
     // return the IAccessible for the window.
-    parent = manager_->toBrowserAccessibilityManagerWin()->
+    parent = manager_->ToBrowserAccessibilityManagerWin()->
              GetParentWindowIAccessible();
   }
 
   parent->AddRef();
   *disp_parent = parent;
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_accRole(
     VARIANT var_id, VARIANT* role) {
@@ skipping 76 matching lines @@
   if (selected_count == 0) {
     selected->vt = VT_EMPTY;
     return S_OK;
   }
 
   if (selected_count == 1) {
     for (size_t i = 0; i < children_.size(); ++i) {
       if (children_[i]->HasState(WebAccessibility::STATE_SELECTED)) {
         selected->vt = VT_DISPATCH;
         selected->pdispVal =
-            children_[i]->toBrowserAccessibilityWin()->NewReference();
+            children_[i]->ToBrowserAccessibilityWin()->NewReference();
         return S_OK;
       }
     }
   }
 
   // Multiple items are selected.
   base::win::EnumVariant* enum_variant =
       new base::win::EnumVariant(selected_count);
   enum_variant->AddRef();
   unsigned long index = 0;
   for (size_t i = 0; i < children_.size(); ++i) {
     if (children_[i]->HasState(WebAccessibility::STATE_SELECTED)) {
       enum_variant->ItemAt(index)->vt = VT_DISPATCH;
       enum_variant->ItemAt(index)->pdispVal =
-        children_[i]->toBrowserAccessibilityWin()->NewReference();
+        children_[i]->ToBrowserAccessibilityWin()->NewReference();
       ++index;
     }
   }
   selected->vt = VT_UNKNOWN;
   selected->punkVal = static_cast<IUnknown*>(
       static_cast<base::win::IUnknownImpl*>(enum_variant));
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::accSelect(
@@ skipping 471 matching lines @@
     return E_INVALIDARG;
 
   int cell_id_count = static_cast<int>(unique_cell_ids_.size());
   if (cell_index < 0)
     return E_INVALIDARG;
   if (cell_index >= cell_id_count)
     return S_FALSE;
 
   int cell_id = unique_cell_ids_[cell_index];
   BrowserAccessibilityWin* cell =
-      manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+      manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
   int col_index;
   if (cell &&
       cell->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_CELL_COLUMN_INDEX, &col_index)) {
     *column_index = col_index;
     return S_OK;
   }
 
   return S_FALSE;
 }
@@ skipping 86 matching lines @@
       rows <= 0) {
     return S_FALSE;
   }
 
   if (row < 0 || row >= rows)
     return E_INVALIDARG;
 
   for (int i = 0; i < columns; ++i) {
     int cell_id = cell_ids_[row * columns + i];
     BrowserAccessibilityWin* cell =
-        manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+        manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
     if (cell && cell->role_ == WebAccessibility::ROLE_ROW_HEADER) {
       if (cell->name_.size() > 0) {
         *description = SysAllocString(cell->name_.c_str());
         return S_OK;
       }
 
       return cell->GetStringAttributeAsBstr(
           WebAccessibility::ATTR_DESCRIPTION, description);
     }
   }
@@ skipping 18 matching lines @@
       columns <= 0 ||
       rows <= 0) {
     return S_FALSE;
   }
 
   if (row < 0 || row >= rows || column < 0 || column >= columns)
     return E_INVALIDARG;
 
   int cell_id = cell_ids_[row * columns + column];
   BrowserAccessibilityWin* cell =
-      manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+      manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
   int rowspan;
   if (cell &&
       cell->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_CELL_ROW_SPAN, &rowspan) &&
       rowspan >= 1) {
     *n_rows_spanned = rowspan;
     return S_OK;
   }
 
   return S_FALSE;
@@ skipping 16 matching lines @@
     return E_INVALIDARG;
 
   int cell_id_count = static_cast<int>(unique_cell_ids_.size());
   if (cell_index < 0)
     return E_INVALIDARG;
   if (cell_index >= cell_id_count)
     return S_FALSE;
 
   int cell_id = unique_cell_ids_[cell_index];
   BrowserAccessibilityWin* cell =
-      manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+      manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
   int cell_row_index;
   if (cell &&
       cell->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_CELL_ROW_INDEX, &cell_row_index)) {
     *row_index = cell_row_index;
     return S_OK;
   }
 
   return S_FALSE;
 }
@@ skipping 112 matching lines @@
     return E_INVALIDARG;
 
   int cell_id_count = static_cast<int>(unique_cell_ids_.size());
   if (index < 0)
     return E_INVALIDARG;
   if (index >= cell_id_count)
     return S_FALSE;
 
   int cell_id = unique_cell_ids_[index];
   BrowserAccessibilityWin* cell =
-      manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+      manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
   int rowspan;
   int colspan;
   if (cell &&
       cell->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_CELL_ROW_SPAN, &rowspan) &&
       cell->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_CELL_COLUMN_SPAN, &colspan) &&
       rowspan >= 1 &&
       colspan >= 1) {
     *row_extents = rowspan;
@@ skipping 117 matching lines @@
       !table->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_ROW_COUNT, &rows)) {
     return S_FALSE;
   }
   if (columns <= 0 || rows <= 0 || column < 0 || column >= columns)
     return S_FALSE;
 
   for (int i = 0; i < rows; ++i) {
     int cell_id = table->cell_ids()[i * columns + column];
     BrowserAccessibilityWin* cell =
-        manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+        manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
     if (cell && cell->role_ == WebAccessibility::ROLE_COLUMN_HEADER)
       (*n_column_header_cells)++;
   }
 
   *cell_accessibles = static_cast<IUnknown**>(CoTaskMemAlloc(
       (*n_column_header_cells) * sizeof(cell_accessibles[0])));
   int index = 0;
   for (int i = 0; i < rows; ++i) {
     int cell_id = table->cell_ids()[i * columns + column];
     BrowserAccessibilityWin* cell =
-        manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+        manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
     if (cell && cell->role_ == WebAccessibility::ROLE_COLUMN_HEADER) {
       (*cell_accessibles)[index] =
           static_cast<IAccessible*>(cell->NewReference());
       ++index;
     }
   }
 
   return S_OK;
 }
 
@@ skipping 66 matching lines @@
       !table->GetIntAttribute(
           WebAccessibility::ATTR_TABLE_ROW_COUNT, &rows)) {
     return S_FALSE;
   }
   if (columns <= 0 || rows <= 0 || row < 0 || row >= rows)
     return S_FALSE;
 
   for (int i = 0; i < columns; ++i) {
     int cell_id = table->cell_ids()[row * columns + i];
     BrowserAccessibilityWin* cell =
-        manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+        manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
     if (cell && cell->role_ == WebAccessibility::ROLE_ROW_HEADER)
       (*n_row_header_cells)++;
   }
 
   *cell_accessibles = static_cast<IUnknown**>(CoTaskMemAlloc(
       (*n_row_header_cells) * sizeof(cell_accessibles[0])));
   int index = 0;
   for (int i = 0; i < columns; ++i) {
     int cell_id = table->cell_ids()[row * columns + i];
     BrowserAccessibilityWin* cell =
-        manager_->GetFromRendererID(cell_id)->toBrowserAccessibilityWin();
+        manager_->GetFromRendererID(cell_id)->ToBrowserAccessibilityWin();
     if (cell && cell->role_ == WebAccessibility::ROLE_ROW_HEADER) {
       (*cell_accessibles)[index] =
           static_cast<IAccessible*>(cell->NewReference());
       ++index;
     }
   }
 
   return S_OK;
 }
 
@@ skipping 80 matching lines @@
 
   BrowserAccessibility* find_table = parent();
   while (find_table && find_table->role() != WebAccessibility::ROLE_TABLE)
     find_table = find_table->parent();
   if (!find_table) {
     NOTREACHED();
     return S_FALSE;
   }
 
   *table = static_cast<IAccessibleTable*>(
-      find_table->toBrowserAccessibilityWin()->NewReference());
+      find_table->ToBrowserAccessibilityWin()->NewReference());
 
   return S_OK;
 }
 
 //
 // IAccessibleText methods.
 //
 
 STDMETHODIMP BrowserAccessibilityWin::get_nCharacters(LONG* n_characters) {
   if (!instance_active_)
@@ skipping 337 matching lines @@
   if (!instance_active_)
     return E_FAIL;
 
   if (!hyperlink ||
       index < 0 ||
       index >= static_cast<long>(hyperlinks_.size())) {
     return E_INVALIDARG;
   }
 
   BrowserAccessibilityWin* child =
-      children_[hyperlinks_[index]]->toBrowserAccessibilityWin();
+      children_[hyperlinks_[index]]->ToBrowserAccessibilityWin();
   *hyperlink = static_cast<IAccessibleHyperlink*>(child->NewReference());
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_hyperlinkIndex(
     long char_index,
     long* hyperlink_index) {
   if (!instance_active_)
     return E_FAIL;
 
@@ skipping 281 matching lines @@
                   IA2_SCROLL_TYPE_ANYWHERE);
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_parentNode(ISimpleDOMNode** node) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
-  *node = parent_->toBrowserAccessibilityWin()->NewReference();
+  *node = parent_->ToBrowserAccessibilityWin()->NewReference();
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_firstChild(ISimpleDOMNode** node)  {
   if (!instance_active_)
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
   if (children_.size()) {
-    *node = children_[0]->toBrowserAccessibilityWin()->NewReference();
+    *node = children_[0]->ToBrowserAccessibilityWin()->NewReference();
     return S_OK;
   } else {
     *node = NULL;
     return S_FALSE;
   }
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_lastChild(ISimpleDOMNode** node) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
   if (children_.size()) {
-    *node = children_[children_.size() - 1]->toBrowserAccessibilityWin()->
+    *node = children_[children_.size() - 1]->ToBrowserAccessibilityWin()->
         NewReference();
     return S_OK;
   } else {
     *node = NULL;
     return S_FALSE;
   }
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_previousSibling(
     ISimpleDOMNode** node) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
   if (parent_ && index_in_parent_ > 0) {
     *node = parent_->children()[index_in_parent_ - 1]->
-        toBrowserAccessibilityWin()->NewReference();
+        ToBrowserAccessibilityWin()->NewReference();
     return S_OK;
   } else {
     *node = NULL;
     return S_FALSE;
   }
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_nextSibling(ISimpleDOMNode** node) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
   if (parent_ &&
       index_in_parent_ >= 0 &&
       index_in_parent_ < static_cast<int>(parent_->children().size()) - 1) {
     *node = parent_->children()[index_in_parent_ + 1]->
-        toBrowserAccessibilityWin()->NewReference();
+        ToBrowserAccessibilityWin()->NewReference();
     return S_OK;
   } else {
     *node = NULL;
     return S_FALSE;
   }
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_childAt(
     unsigned int child_index,
     ISimpleDOMNode** node) {
   if (!instance_active_)
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
   if (child_index < children_.size()) {
-    *node = children_[child_index]->toBrowserAccessibilityWin()->NewReference();
+    *node = children_[child_index]->ToBrowserAccessibilityWin()->NewReference();
     return S_OK;
   } else {
     *node = NULL;
     return S_FALSE;
   }
 }
 
 //
 // ISimpleDOMText methods.
 //
@@ skipping 331 matching lines @@
 }
 
 void BrowserAccessibilityWin::NativeAddReference() {
   AddRef();
 }
 
 void BrowserAccessibilityWin::NativeReleaseReference() {
   Release();
 }
 
+bool BrowserAccessibilityWin::IsNative() const {
+  return true;
+}
+
 BrowserAccessibilityWin* BrowserAccessibilityWin::NewReference() {
   AddRef();
   return this;
 }
 
 BrowserAccessibilityWin* BrowserAccessibilityWin::GetTargetFromChildID(
     const VARIANT& var_id) {
   if (var_id.vt != VT_I4)
     return NULL;
 
   LONG child_id = var_id.lVal;
   if (child_id == CHILDID_SELF)
     return this;
 
   if (child_id >= 1 && child_id <= static_cast<LONG>(children_.size()))
-    return children_[child_id - 1]->toBrowserAccessibilityWin();
+    return children_[child_id - 1]->ToBrowserAccessibilityWin();
 
-  return manager_->GetFromChildID(child_id)->toBrowserAccessibilityWin();
+  return manager_->GetFromChildID(child_id)->ToBrowserAccessibilityWin();
 }
 
 HRESULT BrowserAccessibilityWin::GetStringAttributeAsBstr(
     WebAccessibility::StringAttribute attribute, BSTR* value_bstr) {
   string16 str;
 
   if (!GetStringAttribute(attribute, &str))
     return S_FALSE;
 
   if (str.empty())
@@ skipping 73 matching lines @@
     LONG start_offset,
     ui::TextBoundaryDirection direction) {
   HandleSpecialTextOffset(text, &start_offset);
   ui::TextBoundaryType boundary = IA2TextBoundaryToTextBoundary(ia2_boundary);
   return ui::FindAccessibleTextBoundary(
       text, line_breaks_, boundary, start_offset, direction);
 }
 
 BrowserAccessibilityWin* BrowserAccessibilityWin::GetFromRendererID(
     int32 renderer_id) {
-  return manager_->GetFromRendererID(renderer_id)->toBrowserAccessibilityWin();
+  return manager_->GetFromRendererID(renderer_id)->ToBrowserAccessibilityWin();
 }
 
 void BrowserAccessibilityWin::InitRoleAndState() {
   ia_state_ = 0;
   ia2_state_ = IA2_STATE_OPAQUE;
   ia2_attributes_.clear();
 
   if (HasState(WebAccessibility::STATE_BUSY))
     ia_state_|= STATE_SYSTEM_BUSY;
   if (HasState(WebAccessibility::STATE_CHECKED))
@@ skipping 425 matching lines @@
   }
 
   // The role should always be set.
   DCHECK(!role_name_.empty() || ia_role_);
 
   // If we didn't explicitly set the IAccessible2 role, make it the same
   // as the MSAA role.
   if (!ia2_role_)
     ia2_role_ = ia_role_;
 }