Rename BrowserAccessibility::GetParent to PlatformGetParent.

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 <algorithm>
@@ skipping 664 matching lines @@
 
   if (!name)
     return E_INVALIDARG;
 
   BrowserAccessibilityWin* target = GetTargetFromChildID(var_id);
   if (!target)
     return E_INVALIDARG;
 
   base::string16 name_str = target->name();
   if (name_str.empty()) {
-    if (target->ia2_role() == ROLE_SYSTEM_DOCUMENT && GetParent()) {
+    if (target->ia2_role() == ROLE_SYSTEM_DOCUMENT &&
+        GetAccessibilityParent()) {
       // Hack: Some versions of JAWS crash if they get an empty name on
       // a document that's the child of an iframe, so always return a
       // nonempty string for this role.  https://crbug.com/583057
       name_str = L" ";
     } else {
       return S_FALSE;
     }
   }
 
   *name = SysAllocString(name_str.c_str());
 
   DCHECK(*name);
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_accParent(IDispatch** disp_parent) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_ACC_PARENT);
   if (!instance_active())
     return E_FAIL;
 
   if (!disp_parent)
     return E_INVALIDARG;
 
-  IAccessible* parent_obj = ToBrowserAccessibilityWin(GetParent());
+  IAccessible* parent_obj = ToBrowserAccessibilityWin(GetAccessibilityParent());
   if (parent_obj == NULL) {
     // This happens if we're the root of the tree;
     // return the IAccessible for the window.
     parent_obj =
         manager_->ToBrowserAccessibilityManagerWin()->GetParentIAccessible();
     // |parent| can only be NULL if the manager was created before the parent
     // IAccessible was known and it wasn't subsequently set before a client
     // requested it. This has been fixed. |parent| may also be NULL during
     // destruction. Possible cases where this could occur include tabs being
     // dragged to a new window, etc.
@@ skipping 370 matching lines @@
     LONG y) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_SCROLL_TO_POINT);
   if (!instance_active())
     return E_FAIL;
 
   gfx::Point scroll_to(x, y);
 
   if (coordinate_type == IA2_COORDTYPE_SCREEN_RELATIVE) {
     scroll_to -= manager_->GetViewBounds().OffsetFromOrigin();
   } else if (coordinate_type == IA2_COORDTYPE_PARENT_RELATIVE) {
-    if (GetParent())
-      scroll_to += GetParent()->GetFrameBoundsRect().OffsetFromOrigin();
+    if (GetAccessibilityParent())
+      scroll_to +=
+          GetAccessibilityParent()->GetFrameBoundsRect().OffsetFromOrigin();
   } else {
     return E_INVALIDARG;
   }
 
   manager_->ScrollToPoint(*this, scroll_to);
 
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_groupPosition(
@@ skipping 181 matching lines @@
   if (!x || !y)
     return E_INVALIDARG;
 
   if (coordinate_type == IA2_COORDTYPE_SCREEN_RELATIVE) {
     gfx::Rect bounds = GetScreenBoundsRect();
     *x = bounds.x();
     *y = bounds.y();
   } else if (coordinate_type == IA2_COORDTYPE_PARENT_RELATIVE) {
     gfx::Rect bounds = GetPageBoundsRect();
     gfx::Rect parent_bounds =
-        GetParent() ? GetParent()->GetPageBoundsRect() : gfx::Rect();
+        GetAccessibilityParent() ? GetAccessibilityParent()->GetPageBoundsRect()
+                                 : gfx::Rect();
     *x = bounds.x() - parent_bounds.x();
     *y = bounds.y() - parent_bounds.y();
   } else {
     return E_INVALIDARG;
   }
 
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_imageSize(LONG* height, LONG* width) {
@@ skipping 719 matching lines @@
     return E_INVALIDARG;
 
   *n_column_header_cells = 0;
 
   int column;
   if (!GetIntAttribute(
           ui::AX_ATTR_TABLE_CELL_COLUMN_INDEX, &column)) {
     return S_FALSE;
   }
 
-  BrowserAccessibility* table = GetParent();
+  BrowserAccessibility* table = GetAccessibilityParent();
   while (table && table->GetRole() != ui::AX_ROLE_TABLE)
-    table = table->GetParent();
+    table = table->GetAccessibilityParent();
   if (!table) {
     NOTREACHED();
     return S_FALSE;
   }
 
   int columns;
   int rows;
   if (!table->GetIntAttribute(
           ui::AX_ATTR_TABLE_COLUMN_COUNT, &columns) ||
       !table->GetIntAttribute(
@@ skipping 80 matching lines @@
     return E_INVALIDARG;
 
   *n_row_header_cells = 0;
 
   int row;
   if (!GetIntAttribute(
           ui::AX_ATTR_TABLE_CELL_ROW_INDEX, &row)) {
     return S_FALSE;
   }
 
-  BrowserAccessibility* table = GetParent();
+  BrowserAccessibility* table = GetAccessibilityParent();
   while (table && table->GetRole() != ui::AX_ROLE_TABLE)
-    table = table->GetParent();
+    table = table->GetAccessibilityParent();
   if (!table) {
     NOTREACHED();
     return S_FALSE;
   }
 
   int columns;
   int rows;
   if (!table->GetIntAttribute(
           ui::AX_ATTR_TABLE_COLUMN_COUNT, &columns) ||
       !table->GetIntAttribute(
@@ skipping 108 matching lines @@
 
   if (!table)
     return E_INVALIDARG;
 
 
   int row;
   int column;
   GetIntAttribute(ui::AX_ATTR_TABLE_CELL_ROW_INDEX, &row);
   GetIntAttribute(ui::AX_ATTR_TABLE_CELL_COLUMN_INDEX, &column);
 
-  BrowserAccessibility* find_table = GetParent();
+  BrowserAccessibility* find_table = GetAccessibilityParent();
   while (find_table && find_table->GetRole() != ui::AX_ROLE_TABLE)
-    find_table = find_table->GetParent();
+    find_table = find_table->GetAccessibilityParent();
   if (!find_table) {
     NOTREACHED();
     return S_FALSE;
   }
 
   *table = static_cast<IAccessibleTable*>(
       ToBrowserAccessibilityWin(find_table)->NewReference());
 
   return S_OK;
 }
@@ skipping 57 matching lines @@
   const base::string16& text_str = GetText();
   HandleSpecialTextOffset(&offset);
   if (offset < 0 || offset > static_cast<LONG>(text_str.size()))
     return E_INVALIDARG;
 
   gfx::Rect character_bounds;
   if (coordinate_type == IA2_COORDTYPE_SCREEN_RELATIVE) {
     character_bounds = GetScreenBoundsForRange(offset, 1);
   } else if (coordinate_type == IA2_COORDTYPE_PARENT_RELATIVE) {
     character_bounds = GetPageBoundsForRange(offset, 1);
-    if (GetParent())
-      character_bounds -= GetParent()->GetPageBoundsRect().OffsetFromOrigin();
+    if (GetAccessibilityParent())
+      character_bounds -=
+          GetAccessibilityParent()->GetPageBoundsRect().OffsetFromOrigin();
   } else {
     return E_INVALIDARG;
   }
 
   *out_x = character_bounds.x();
   *out_y = character_bounds.y();
   *out_width = character_bounds.width();
   *out_height = character_bounds.height();
 
   return S_OK;
@@ skipping 532 matching lines @@
 STDMETHODIMP BrowserAccessibilityWin::get_startIndex(long* index) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_START_INDEX);
   AddAccessibilityModeFlags(AccessibilityMode::kScreenReader);
   if (!instance_active() || !IsHyperlink())
     return E_FAIL;
 
   if (!index)
     return E_INVALIDARG;
 
   int32_t hypertext_offset = 0;
-  auto* parent = GetParent();
+  auto* parent = GetAccessibilityParent();
   if (parent) {
     hypertext_offset =
         ToBrowserAccessibilityWin(parent)->GetHypertextOffsetFromChild(*this);
   }
   *index = static_cast<LONG>(hypertext_offset);
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_endIndex(long* index) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_END_INDEX);
@@ skipping 460 matching lines @@
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_parentNode(ISimpleDOMNode** node) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_PARENT_NODE);
   if (!instance_active())
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
-  *node = ToBrowserAccessibilityWin(GetParent())->NewReference();
+  *node = ToBrowserAccessibilityWin(GetAccessibilityParent())->NewReference();
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_firstChild(ISimpleDOMNode** node)  {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_FIRST_CHILD);
   if (!instance_active())
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
@@ skipping 27 matching lines @@
 
 STDMETHODIMP BrowserAccessibilityWin::get_previousSibling(
     ISimpleDOMNode** node) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_PREVIOUS_SIBLING);
   if (!instance_active())
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
-  if (!GetParent() || GetIndexInParent() <= 0) {
+  if (!GetAccessibilityParent() || GetIndexInParent() <= 0) {
     *node = NULL;
     return S_FALSE;
   }
 
-  *node = ToBrowserAccessibilityWin(
-      GetParent()->InternalGetChild(GetIndexInParent() - 1))->NewReference();
+  *node = ToBrowserAccessibilityWin(GetAccessibilityParent()->InternalGetChild(
+                                        GetIndexInParent() - 1))
+              ->NewReference();
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_nextSibling(ISimpleDOMNode** node) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_NEXT_SIBLING);
   if (!instance_active())
     return E_FAIL;
 
   if (!node)
     return E_INVALIDARG;
 
-  if (!GetParent() ||
-      GetIndexInParent() < 0 ||
-      GetIndexInParent() >= static_cast<int>(
-          GetParent()->InternalChildCount()) - 1) {
+  if (!GetAccessibilityParent() || GetIndexInParent() < 0 ||
+      GetIndexInParent() >=
+          static_cast<int>(GetAccessibilityParent()->InternalChildCount()) -
+              1) {
     *node = NULL;
     return S_FALSE;
   }
 
-  *node = ToBrowserAccessibilityWin(
-      GetParent()->InternalGetChild(GetIndexInParent() + 1))->NewReference();
+  *node = ToBrowserAccessibilityWin(GetAccessibilityParent()->InternalGetChild(
+                                        GetIndexInParent() + 1))
+              ->NewReference();
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibilityWin::get_childAt(
     unsigned int child_index,
     ISimpleDOMNode** node) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_GET_CHILD_AT);
   if (!instance_active())
     return E_FAIL;
 
@@ skipping 168 matching lines @@
                                                    void** object) {
   WIN_ACCESSIBILITY_API_HISTOGRAM(UMA_API_QUERY_SERVICE);
   if (!instance_active())
     return E_FAIL;
 
   if (guid_service == GUID_IAccessibleContentDocument) {
     // Special Mozilla extension: return the accessible for the root document.
     // Screen readers use this to distinguish between a document loaded event
     // on the root document vs on an iframe.
     BrowserAccessibility* node = this;
-    while (node->GetParent())
-      node = node->GetParent()->manager()->GetRoot();
+    while (node->GetAccessibilityParent())
+      node = node->GetAccessibilityParent()->manager()->GetRoot();
     return ToBrowserAccessibilityWin(node)->QueryInterface(
         IID_IAccessible2, object);
   }
 
   if (guid_service == IID_IAccessible ||
       guid_service == IID_IAccessible2 ||
       guid_service == IID_IAccessibleAction ||
       guid_service == IID_IAccessibleApplication ||
       guid_service == IID_IAccessibleHyperlink ||
       guid_service == IID_IAccessibleHypertext ||
@@ skipping 338 matching lines @@
         win_attributes_->ia2_attributes.push_back(L"current:date");
         break;
       case ui::AX_ARIA_CURRENT_STATE_TIME:
         win_attributes_->ia2_attributes.push_back(L"current:time");
         break;
     }
   }
 
   // Expose table cell index.
   if (IsCellOrTableHeaderRole()) {
-    BrowserAccessibility* table = GetParent();
+    BrowserAccessibility* table = GetAccessibilityParent();
     while (table && table->GetRole() != ui::AX_ROLE_TABLE)
-      table = table->GetParent();
+      table = table->GetAccessibilityParent();
     if (table) {
       const std::vector<int32_t>& unique_cell_ids =
           table->GetIntListAttribute(ui::AX_ATTR_UNIQUE_CELL_IDS);
       for (size_t i = 0; i < unique_cell_ids.size(); ++i) {
         if (unique_cell_ids[i] == GetId()) {
           win_attributes_->ia2_attributes.push_back(
               base::string16(L"table-cell-index:") + base::IntToString16(i));
         }
       }
     }
@@ skipping 146 matching lines @@
       FireNativeEvent(EVENT_OBJECT_VALUECHANGE);
     if (ia_state() != old_win_attributes_->ia_state)
       FireNativeEvent(EVENT_OBJECT_STATECHANGE);
 
     // Handle selection being added or removed.
     bool is_selected_now = (ia_state() & STATE_SYSTEM_SELECTED) != 0;
     bool was_selected_before =
         (old_win_attributes_->ia_state & STATE_SYSTEM_SELECTED) != 0;
     if (is_selected_now || was_selected_before) {
       bool multiselect = false;
-      if (GetParent() && GetParent()->HasState(ui::AX_STATE_MULTISELECTABLE))
+      if (GetAccessibilityParent() &&
+          GetAccessibilityParent()->HasState(ui::AX_STATE_MULTISELECTABLE))
         multiselect = true;
 
       if (multiselect) {
         // In a multi-select box, fire SELECTIONADD and SELECTIONREMOVE events.
         if (is_selected_now && !was_selected_before) {
           FireNativeEvent(EVENT_OBJECT_SELECTIONADD);
         } else if (!is_selected_now && was_selected_before) {
           FireNativeEvent(EVENT_OBJECT_SELECTIONREMOVE);
         }
       } else if (is_selected_now && !was_selected_before) {
@@ skipping 22 matching lines @@
       FireNativeEvent(IA2_EVENT_TEXT_REMOVED);
     }
     if (new_len > 0) {
       // In-process screen readers may call IAccessibleText::get_newText
       // in reaction to this event to retrieve the text that was inserted.
       FireNativeEvent(IA2_EVENT_TEXT_INSERTED);
     }
 
     // Changing a static text node can affect the IAccessibleText hypertext
     // of the parent node, so force an update on the parent.
-    BrowserAccessibilityWin* parent = ToBrowserAccessibilityWin(GetParent());
+    BrowserAccessibilityWin* parent =
+        ToBrowserAccessibilityWin(GetAccessibilityParent());
     if (parent && IsTextOnlyObject() &&
         name() != old_win_attributes_->name) {
       parent->UpdatePlatformAttributes();
     }
   }
 
   old_win_attributes_.reset(nullptr);
 }
 
 void BrowserAccessibilityWin::UpdatePlatformAttributes() {
@@ skipping 344 matching lines @@
   int value;
   if (GetIntAttribute(attribute, &value)) {
     win_attributes_->ia2_attributes.push_back(
         base::ASCIIToUTF16(ia2_attr) + L":" +
         base::IntToString16(value));
   }
 }
 
 bool BrowserAccessibilityWin::IsHyperlink() const {
   int32_t hyperlink_index = -1;
-  auto* parent = GetParent();
+  auto* parent = GetAccessibilityParent();
   if (parent) {
     hyperlink_index =
         ToBrowserAccessibilityWin(parent)->GetHyperlinkIndexFromChild(*this);
   }
 
   if (hyperlink_index >= 0)
     return true;
   return false;
 }
 
@@ skipping 33 matching lines @@
   for (auto& offset_index : hyperlink_offset_to_index()) {
     if (offset_index.second == hyperlink_index)
       return offset_index.first;
   }
 
   return -1;
 }
 
 int32_t BrowserAccessibilityWin::GetHypertextOffsetFromChild(
     const BrowserAccessibilityWin& child) const {
-  DCHECK(child.GetParent() == this);
+  DCHECK(child.GetAccessibilityParent() == this);
 
   // Handle the case when we are dealing with a direct text-only child.
   // (Note that this object might be a platform leaf, e.g. an ARIA searchbox,
   // and so |InternalChild...| functions need to be used. Also, direct text-only
   // children should not be present at tree roots and so no cross-tree traversal
   // is necessary.)
   if (child.IsTextOnlyObject()) {
     int32_t hypertextOffset = 0;
     int32_t index_in_parent = child.GetIndexInParent();
     DCHECK_GE(index_in_parent, 0);
@@ skipping 12 matching lines @@
 
   int32_t hyperlink_index = GetHyperlinkIndexFromChild(child);
   if (hyperlink_index < 0)
     return -1;
 
   return GetHypertextOffsetFromHyperlinkIndex(hyperlink_index);
 }
 
 int32_t BrowserAccessibilityWin::GetHypertextOffsetFromDescendant(
     const BrowserAccessibilityWin& descendant) const {
-  auto* parent_object = ToBrowserAccessibilityWin(descendant.GetParent());
+  auto* parent_object =
+      ToBrowserAccessibilityWin(descendant.GetAccessibilityParent());
   auto* current_object = const_cast<BrowserAccessibilityWin*>(&descendant);
   while (parent_object && parent_object != this) {
     current_object = parent_object;
-    parent_object = ToBrowserAccessibilityWin(current_object->GetParent());
+    parent_object =
+        ToBrowserAccessibilityWin(current_object->GetAccessibilityParent());
   }
   if (!parent_object)
     return -1;
 
   return parent_object->GetHypertextOffsetFromChild(*current_object);
 }
 
 int BrowserAccessibilityWin::GetHypertextOffsetFromEndpoint(
     const BrowserAccessibilityWin& endpoint_object,
     int endpoint_offset) const {
@@ skipping 10 matching lines @@
   // Case 1.
   //
   // IsDescendantOf includes the case when endpoint_object == this.
   if (IsDescendantOf(&endpoint_object))
     return endpoint_offset;
 
   const BrowserAccessibility* common_parent = this;
   int32_t index_in_common_parent = GetIndexInParent();
   while (common_parent && !endpoint_object.IsDescendantOf(common_parent)) {
     index_in_common_parent = common_parent->GetIndexInParent();
-    common_parent = common_parent->GetParent();
+    common_parent = common_parent->GetAccessibilityParent();
   }
   if (!common_parent)
     return -1;
 
   DCHECK_GE(index_in_common_parent, 0);
   DCHECK(!(common_parent->IsTextOnlyObject()));
 
   // Case 2.
   //
   // We already checked in case 1 if our endpoint is inside this object.
   // We can safely assume that it is a descendant or in a completely different
   // part of the tree.
   if (common_parent == this) {
     int32_t hypertext_offset =
         GetHypertextOffsetFromDescendant(endpoint_object);
-    if (endpoint_object.GetParent() == this &&
+    if (endpoint_object.GetAccessibilityParent() == this &&
         endpoint_object.IsTextOnlyObject()) {
       hypertext_offset += endpoint_offset;
     }
 
     return hypertext_offset;
   }
 
   // Case 3.
   //
   // We can safely assume that the endpoint is in another part of the tree or
@@ skipping 255 matching lines @@
   return start_offset;
 }
 
 BrowserAccessibilityWin* BrowserAccessibilityWin::GetFromID(int32_t id) const {
   if (!instance_active())
     return nullptr;
   return ToBrowserAccessibilityWin(manager_->GetFromID(id));
 }
 
 bool BrowserAccessibilityWin::IsListBoxOptionOrMenuListOption() {
-  if (!GetParent())
+  if (!GetAccessibilityParent())
     return false;
 
   int32_t role = GetRole();
-  int32_t parent_role = GetParent()->GetRole();
+  int32_t parent_role = GetAccessibilityParent()->GetRole();
 
   if (role == ui::AX_ROLE_LIST_BOX_OPTION &&
       parent_role == ui::AX_ROLE_LIST_BOX) {
     return true;
   }
 
   if (role == ui::AX_ROLE_MENU_LIST_OPTION &&
       parent_role == ui::AX_ROLE_MENU_LIST_POPUP) {
     return true;
   }
@@ skipping 780 matching lines @@
   return static_cast<BrowserAccessibilityWin*>(obj);
 }
 
 const BrowserAccessibilityWin*
 ToBrowserAccessibilityWin(const BrowserAccessibility* obj) {
   DCHECK(!obj || obj->IsNative());
   return static_cast<const BrowserAccessibilityWin*>(obj);
 }
 
 }  // namespace content