Add AXTreeDelegate and refactor other AXTree classes slightly.

ui/accessibility/ax_tree.cc

 // Copyright 2013 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 "ui/accessibility/ax_tree.h"
 
 #include <set>
 
 #include "base/logging.h"
 #include "base/strings/stringprintf.h"
 #include "ui/accessibility/ax_node.h"
 
 namespace ui {
 
 namespace {
 
 std::string TreeToStringHelper(AXNode* node, int indent) {
   std::string result;
   for (int i = 0; i < indent; i++)
     result += "  ";
   result += node->data().ToString() + "\n";
   for (int i = 0; i < node->child_count(); ++i)
     result += TreeToStringHelper(node->ChildAtIndex(i), indent + 1);
   return result;
 }
 
 }  // anonymous namespace
 
+// Intermediate state to keep track of during a tree update.
+struct AXTreeUpdateState {
+  // During an update, this keeps track of all nodes that have been
+  // implicitly referenced as part of this update, but haven't been
+  // updated yet. It's an error if there are any pending nodes at the
+  // end of Unserialize.
+  std::set<AXNode*> pending_nodes;
+
+  // Keeps track of new nodes created during this update.
+  std::set<AXNode*> new_nodes;
+};
+
+AXTreeDelegate::AXTreeDelegate() {
+}
+
+AXTreeDelegate::~AXTreeDelegate() {
+}
+
 AXTree::AXTree()
-    : root_(NULL) {
+    : delegate_(NULL), root_(NULL) {
   AXNodeData root;
   root.id = 0;
   root.role = AX_ROLE_ROOT_WEB_AREA;
 
   AXTreeUpdate initial_state;
   initial_state.nodes.push_back(root);
   CHECK(Unserialize(initial_state)) << error();
 }
 
 AXTree::AXTree(const AXTreeUpdate& initial_state)
-    : root_(NULL) {
+    : delegate_(NULL), root_(NULL) {
   CHECK(Unserialize(initial_state)) << error();
 }
 
 AXTree::~AXTree() {
   if (root_)
     DestroyNodeAndSubtree(root_);
 }
 
+void AXTree::SetDelegate(AXTreeDelegate* delegate) {
+  delegate_ = delegate;
+}
+
 AXNode* AXTree::GetRoot() const {
   return root_;
 }
 
 AXNode* AXTree::GetFromId(int32 id) const {
   base::hash_map<int32, AXNode*>::const_iterator iter = id_map_.find(id);
   return iter != id_map_.end() ? (iter->second) : NULL;
 }
 
 bool AXTree::Unserialize(const AXTreeUpdate& update) {
-  std::set<AXNode*> pending_nodes;
+  AXTreeUpdateState update_state;
+  int32 old_root_id = root_ ? root_->id() : 0;
 
   if (update.node_id_to_clear != 0) {
     AXNode* node = GetFromId(update.node_id_to_clear);
     if (!node) {
       error_ = base::StringPrintf("Bad node_id_to_clear: %d",
                                   update.node_id_to_clear);
       return false;
     }
     if (node == root_) {
       DestroyNodeAndSubtree(root_);
       root_ = NULL;
     } else {
       for (int i = 0; i < node->child_count(); ++i)
         DestroyNodeAndSubtree(node->ChildAtIndex(i));
       std::vector<AXNode*> children;
       node->SwapChildren(children);
-      pending_nodes.insert(node);
+      update_state.pending_nodes.insert(node);
     }
   }
 
   for (size_t i = 0; i < update.nodes.size(); ++i) {
-    if (!UpdateNode(update.nodes[i], &pending_nodes))
+    if (!UpdateNode(update.nodes[i], &update_state))
       return false;
   }
 
-  if (!pending_nodes.empty()) {
+  if (!update_state.pending_nodes.empty()) {
     error_ = "Nodes left pending by the update:";
-    for (std::set<AXNode*>::iterator iter = pending_nodes.begin();
-         iter != pending_nodes.end(); ++iter) {
+    for (std::set<AXNode*>::iterator iter = update_state.pending_nodes.begin();
+         iter != update_state.pending_nodes.end(); ++iter) {
       error_ += base::StringPrintf(" %d", (*iter)->id());
     }
     return false;
   }
 
+  if (delegate_) {
+    for (size_t i = 0; i < update.nodes.size(); ++i) {
+      AXNode* node = GetFromId(update.nodes[i].id);
+      if (update_state.new_nodes.find(node) != update_state.new_nodes.end()) {
+        delegate_->OnNodeCreated(node);
+        update_state.new_nodes.erase(node);
+      } else {
+        delegate_->OnNodeChanged(node);
+      }
+    }
+    if (root_->id() != old_root_id)
+      delegate_->OnRootChanged(root_);
+  }
+
   return true;
 }
 
 std::string AXTree::ToString() const {
   return TreeToStringHelper(root_, 0);
 }
 
 AXNode* AXTree::CreateNode(AXNode* parent, int32 id, int32 index_in_parent) {
   return new AXNode(parent, id, index_in_parent);
 }
 
 bool AXTree::UpdateNode(
-    const AXNodeData& src, std::set<AXNode*>* pending_nodes) {
+    const AXNodeData& src, AXTreeUpdateState* update_state) {
   // This method updates one node in the tree based on serialized data
   // received in an AXTreeUpdate. See AXTreeUpdate for pre and post
   // conditions.
 
   // Look up the node by id. If it's not found, then either the root
   // of the tree is being swapped, or we're out of sync with the source
   // and this is a serious error.
   AXNode* node = GetFromId(src.id);
   if (node) {
-    pending_nodes->erase(node);
+    update_state->pending_nodes.erase(node);
   } else {
     if (src.role != AX_ROLE_ROOT_WEB_AREA) {
       error_ = base::StringPrintf(
           "%d is not in the tree and not the new root", src.id);
       return false;
     }
     node = CreateAndInitializeNode(NULL, src.id, 0);
+    update_state->new_nodes.insert(node);
   }
 
   // Set the node's data.
   node->SetData(src);
 
   // First, delete nodes that used to be children of this node but aren't
   // anymore.
   if (!DeleteOldChildren(node, src.child_ids))
     return false;
 
   // Now build a new children vector, reusing nodes when possible,
   // and swap it in.
   std::vector<AXNode*> new_children;
   bool success = CreateNewChildVector(
-      node, src.child_ids, &new_children, pending_nodes);
+      node, src.child_ids, &new_children, update_state);
   node->SwapChildren(new_children);
 
   // Update the root of the tree if needed.
   if (src.role == AX_ROLE_ROOT_WEB_AREA &&
       (!root_ || root_->id() != src.id)) {
     if (root_)
       DestroyNodeAndSubtree(root_);
     root_ = node;
-    OnRootChanged();
   }
 
   return success;
 }
 
-void AXTree::OnRootChanged() {
-}
-
 AXNode* AXTree::CreateAndInitializeNode(
     AXNode* parent, int32 id, int32 index_in_parent) {
   AXNode* node = CreateNode(parent, id, index_in_parent);
   id_map_[node->id()] = node;
   return node;
 }
 
 void AXTree::DestroyNodeAndSubtree(AXNode* node) {
   id_map_.erase(node->id());
   for (int i = 0; i < node->child_count(); ++i)
     DestroyNodeAndSubtree(node->ChildAtIndex(i));
+  if (delegate_)
+    delegate_->OnNodeWillBeDeleted(node);
   node->Destroy();

[David Tseng, 2014/02/21 00:33:23]

Does this keep an AXNode's data valid for all platforms?

 }
 
 bool AXTree::DeleteOldChildren(AXNode* node,
                                const std::vector<int32> new_child_ids) {
   // Create a set of child ids in |src| for fast lookup, and return false
   // if a duplicate is found;
   std::set<int32> new_child_id_set;
   for (size_t i = 0; i < new_child_ids.size(); ++i) {
     if (new_child_id_set.find(new_child_ids[i]) != new_child_id_set.end()) {
       error_ = base::StringPrintf("Node %d has duplicate child id %d",
@@ skipping 10 matching lines @@
     if (new_child_id_set.find(old_id) == new_child_id_set.end())
       DestroyNodeAndSubtree(old_children[i]);
   }
 
   return true;
 }
 
 bool AXTree::CreateNewChildVector(AXNode* node,
                                   const std::vector<int32> new_child_ids,
                                   std::vector<AXNode*>* new_children,
-                                  std::set<AXNode*>* pending_nodes) {
+                                  AXTreeUpdateState* update_state) {
   bool success = true;
   for (size_t i = 0; i < new_child_ids.size(); ++i) {
     int32 child_id = new_child_ids[i];
     int32 index_in_parent = static_cast<int32>(i);
     AXNode* child = GetFromId(child_id);
     if (child) {
       if (child->parent() != node) {
         // This is a serious error - nodes should never be reparented.
         // If this case occurs, continue so this node isn't left in an
         // inconsistent state, but return failure at the end.
         error_ = base::StringPrintf(
             "Node %d reparented from %d to %d",
             child->id(),
             child->parent() ? child->parent()->id() : 0,
             node->id());
         success = false;
         continue;
       }
       child->SetIndexInParent(index_in_parent);
     } else {
       child = CreateAndInitializeNode(node, child_id, index_in_parent);
-      pending_nodes->insert(child);
+      update_state->pending_nodes.insert(child);
+      update_state->new_nodes.insert(child);
     }
     new_children->push_back(child);
   }
 
   return success;
 }
 
 }  // namespace ui