Refactor BrowserAccessibility to prepare for AXNode (re-land)

content/browser/accessibility/browser_accessibility.h

 // 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.
 
 #ifndef CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_
 #define CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_
 
 #include <map>
 #include <utility>
 #include <vector>
@@ skipping 48 matching lines @@
   virtual void PostInitialize() {}
 
   // Returns true if this is a native platform-specific object, vs a
   // cross-platform generic object.
   virtual bool IsNative() const;
 
   // Initialize the tree structure of this object.
   void InitializeTreeStructure(
       BrowserAccessibilityManager* manager,
       BrowserAccessibility* parent,
-      int32 renderer_id,

[aboxhall, 2014/04/04 22:18:10]

I assume this is mostly for clarification? It was never that great a name.

[dmazzoni, 2014/04/04 23:27:39]

Yeah, this is to match AXNode. The "other" ID has now been renamed
unique_id_win(), it's only used on Windows.

+      int32 id,
       int32 index_in_parent);
 
   // Initialize this object's data.
   void InitializeData(const ui::AXNodeData& src);
 
   virtual void SwapChildren(std::vector<BrowserAccessibility*>& children);
 
   // Update the parent and index in parent if this node has been moved.
   void UpdateParent(BrowserAccessibility* parent, int index_in_parent);
 
   // Update this node's location, leaving everything else the same.
   virtual void SetLocation(const gfx::Rect& new_location);
 
   // Return true if this object is equal to or a descendant of |ancestor|.
   bool IsDescendantOf(BrowserAccessibility* ancestor);
 
-  // Returns the parent of this object, or NULL if it's the root.
-  BrowserAccessibility* parent() const { return parent_; }
-
-  // Returns the number of children of this object.
-  uint32 child_count() const { return children_.size(); }
-
   // Returns true if this is a leaf node on this platform, meaning any
   // children should not be exposed to this platform's native accessibility
   // layer. Each platform subclass should implement this itself.
   // The definition of a leaf may vary depending on the platform,
   // but a leaf node should never have children that are focusable or
   // that might send notifications.
   virtual bool PlatformIsLeaf() const;
 
   // Returns the number of children of this object, or 0 if PlatformIsLeaf()
   // returns true.
@@ skipping 45 matching lines @@
   // Subclasses should override this to support platform reference counting.
   virtual void NativeAddReference() { }
 
   // Subclasses should override this to support platform reference counting.
   virtual void NativeReleaseReference();
 
   //
   // Accessors
   //
 
-  const std::vector<BrowserAccessibility*>& children() const {
-    return children_;
-  }
-  const std::vector<std::pair<std::string, std::string> >&
-  html_attributes() const {
-    return html_attributes_;
-  }
-  int32 index_in_parent() const { return index_in_parent_; }
-  gfx::Rect location() const { return location_; }
   BrowserAccessibilityManager* manager() const { return manager_; }
+  bool instance_active() const { return instance_active_; }
   const std::string& name() const { return name_; }
   const std::string& value() const { return value_; }
-  int32 renderer_id() const { return renderer_id_; }
-  int32 role() const { return role_; }
-  int32 state() const { return state_; }
-  bool instance_active() const { return instance_active_; }
-
   void set_name(const std::string& name) { name_ = name; }
   void set_value(const std::string& value) { value_ = value; }
 
+  std::vector<BrowserAccessibility*>& deprecated_children() {
+    return deprecated_children_;
+  }
+
+  BrowserAccessibility* GetParent() const { return deprecated_parent_; }

[aboxhall, 2014/04/04 22:18:10]

How will the traversing logic work after the switch? i.e. why are these methods
this still implemented in terms of deprecated_children_ when everything else is
implemented in terms of data_?

[dmazzoni, 2014/04/04 23:27:39]

Afterwards, each BrowserAccessibility will have a pointer to its corresponding
AXNode, and it will use AXNode to get its data and its parent/child pointers.

BrowserAccessibility will contain little more than an AXNode and a pointer to
the BrowserAccessibilityManager. The platform subclasses of BrowserAccessibility
may contain additional platform-specific data and flags.
AXNodeData contains everything other than the tree structure pointers. AXNode
has the pointers to the parent and children. So after the switch, we'll access
AXNode's data() and AXNode's parent() and AXNode's children().

+  int32 GetIndexInParent() const { return deprecated_index_in_parent_; }
+  uint32 InternalChildCount() const { return deprecated_children_.size(); }

[aboxhall, 2014/04/04 22:18:10]

Why are this and the below method named 'Internal*'?

[dmazzoni, 2014/04/04 23:27:39]

To contrast with PlatformChildCount and PlatformGetChild, which return the right
platform-specific way to walk the tree - for example some nodes are leaf nodes
on some platforms but not others.

I added a comment.

+  BrowserAccessibility* InternalGetChild(uint32 child_index) const {
+    return deprecated_children_[child_index];
+  }
+
+  int32 GetId() const { return data_.id; }
+  gfx::Rect GetLocation() const { return data_.location; }
+  int32 GetRole() const { return data_.role; }
+  int32 GetState() const { return data_.state; }
+  const std::vector<std::pair<std::string, std::string> >& GetHtmlAttributes()
+      const {
+    return data_.html_attributes;
+  }
+
 #if defined(OS_MACOSX) && __OBJC__
   BrowserAccessibilityCocoa* ToBrowserAccessibilityCocoa();
 #elif defined(OS_WIN)
   BrowserAccessibilityWin* ToBrowserAccessibilityWin();
 #elif defined(TOOLKIT_GTK)
   BrowserAccessibilityGtk* ToBrowserAccessibilityGtk();
 #endif
 
   // Accessing accessibility attributes:
   //
@@ skipping 79 matching lines @@
   // Perform child independent initialization in this method.
   virtual void PreInitialize() {}
 
   BrowserAccessibility();
 
   // The manager of this tree of accessibility objects; needed for
   // global operations like focus tracking.
   BrowserAccessibilityManager* manager_;
 
   // The parent of this object, may be NULL if we're the root object.
-  BrowserAccessibility* parent_;
+  BrowserAccessibility* deprecated_parent_;
 
  private:
   // Return the sum of the lengths of all static text descendants,
   // including this object if it's static text.
   int GetStaticTextLenRecursive() const;
 
   // The index of this within its parent object.
-  int32 index_in_parent_;
-
-  // The ID of this object in the renderer process.
-  int32 renderer_id_;
+  int32 deprecated_index_in_parent_;
 
   // The children of this object.
-  std::vector<BrowserAccessibility*> children_;
+  std::vector<BrowserAccessibility*> deprecated_children_;
 
   // Accessibility metadata from the renderer
   std::string name_;
   std::string value_;
-  std::vector<std::pair<
-      ui::AXBoolAttribute, bool> > bool_attributes_;
-  std::vector<std::pair<
-      ui::AXFloatAttribute, float> > float_attributes_;
-  std::vector<std::pair<
-      ui::AXIntAttribute, int> > int_attributes_;
-  std::vector<std::pair<
-      ui::AXStringAttribute, std::string> > string_attributes_;
-  std::vector<std::pair<
-      ui::AXIntListAttribute, std::vector<int32> > >
-          intlist_attributes_;
-  std::vector<std::pair<std::string, std::string> > html_attributes_;
-  int32 role_;
-  int32 state_;
-  gfx::Rect location_;
+  ui::AXNodeData data_;
 
   // BrowserAccessibility objects are reference-counted on some platforms.
   // When we're done with this object and it's removed from our accessibility
   // tree, a client may still be holding onto a pointer to this object, so
   // we mark it as inactive so that calls to any of this object's methods
   // immediately return failure.
   bool instance_active_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(BrowserAccessibility);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_