Refactor Node::showTree*() functions.

third_party/WebKit/Source/core/dom/Node.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
  * Copyright (C) 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ skipping 1518 matching lines @@
 
 std::ostream& operator<<(std::ostream& ostream, const Node* node)
 {
     if (!node)
         return ostream << "null";
     return ostream << *node;
 }
 
 #ifndef NDEBUG
 
+String Node::toString() const
+{
+    // TODO(tkent): We implemented toString() with operator<<.  We should
+    // implement operator<< with toString() instead.
+    std::stringstream stream;
+    stream << *this;
+    return String(stream.str().c_str());
+}
+
 void Node::showNode(const char* prefix) const
 {
     std::stringstream stream;
     if (prefix)
         stream << prefix;
     stream << *this << "\n";
     // TODO(tkent): Replace WTFLogAlways with something else.
     WTFLogAlways("%s", stream.str().c_str());
 }
 
-void Node::showTreeForThis() const
+String Node::toTreeStringForThis() const
 {
-    showTreeAndMark(this, "*");
+    return toMarkedTreeString(this, "*");
 }
 
-void Node::showTreeForThisInFlatTree() const
+String Node::toFlatTreeStringForThis() const
 {
-    showTreeAndMarkInFlatTree(this, "*");
+    return toMarkedFlatTreeString(this, "*");
 }
 
 void Node::printNodePathTo(std::ostream& stream) const
 {
     HeapVector<Member<const Node>, 16> chain;
     const Node* node = this;
     while (node->parentOrShadowHostNode()) {
         chain.append(node);
         node = node->parentOrShadowHostNode();
     }
@@ skipping 35 matching lines @@
             break;
         case kAttributeNode:
             stream << "/@" << node->nodeName().utf8().data();
             break;
         default:
             break;
         }
     }
 }
 
-static void traverseTreeAndMark(const String& baseIndent, const Node* rootNode, const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2)
+static void appendMarkedTree(const String& baseIndent, const Node* rootNode, const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2, StringBuilder& builder)
 {
     for (const Node& node : NodeTraversal::inclusiveDescendantsOf(*rootNode)) {
         StringBuilder indent;
         if (node == markedNode1)
             indent.append(markedLabel1);
         if (node == markedNode2)
             indent.append(markedLabel2);
         indent.append(baseIndent);
         for (const Node* tmpNode = &node; tmpNode && tmpNode != rootNode; tmpNode = tmpNode->parentOrShadowHostNode())
             indent.append('\t');
-        node.showNode(indent.toString().utf8().data());
+        builder.append(indent);
+        builder.append(node.toString());
+        builder.append("\n");
         indent.append('\t');
 
         if (node.isElementNode()) {
             const Element& element = toElement(node);
             if (Element* pseudo = element.pseudoElement(PseudoIdBefore))
-                traverseTreeAndMark(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2);
+                appendMarkedTree(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
             if (Element* pseudo = element.pseudoElement(PseudoIdAfter))
-                traverseTreeAndMark(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2);
+                appendMarkedTree(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
             if (Element* pseudo = element.pseudoElement(PseudoIdFirstLetter))
-                traverseTreeAndMark(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2);
+                appendMarkedTree(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
             if (Element* pseudo = element.pseudoElement(PseudoIdBackdrop))
-                traverseTreeAndMark(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2);
+                appendMarkedTree(indent.toString(), pseudo, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
         }
 
         if (node.isShadowRoot()) {
             if (ShadowRoot* youngerShadowRoot = toShadowRoot(node).youngerShadowRoot())
-                traverseTreeAndMark(indent.toString(), youngerShadowRoot, markedNode1, markedLabel1, markedNode2, markedLabel2);
+                appendMarkedTree(indent.toString(), youngerShadowRoot, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
         } else if (ShadowRoot* oldestShadowRoot = oldestShadowRootFor(&node)) {
-            traverseTreeAndMark(indent.toString(), oldestShadowRoot, markedNode1, markedLabel1, markedNode2, markedLabel2);
+            appendMarkedTree(indent.toString(), oldestShadowRoot, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
         }
     }
 }
 
-static void traverseTreeAndMarkInFlatTree(const String& baseIndent, const Node* rootNode, const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2)
+static void appendMarkedFlatTree(const String& baseIndent, const Node* rootNode, const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2, StringBuilder& builder)
 {
     for (const Node* node = rootNode; node; node = FlatTreeTraversal::nextSibling(*node)) {
         StringBuilder indent;
         if (node == markedNode1)
             indent.append(markedLabel1);
         if (node == markedNode2)
             indent.append(markedLabel2);
         indent.append(baseIndent);
-        node->showNode(indent.toString().utf8().data());
+        builder.append(indent);
+        builder.append(node->toString());
+        builder.append("\n");
         indent.append('\t');
 
-        Node* child = FlatTreeTraversal::firstChild(*node);
-        if (child)
-            traverseTreeAndMarkInFlatTree(indent.toString(), child, markedNode1, markedLabel1, markedNode2, markedLabel2);
+        if (Node* child = FlatTreeTraversal::firstChild(*node))
+            appendMarkedFlatTree(indent.toString(), child, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
     }
 }
 
-void Node::showTreeAndMark(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2) const
+String Node::toMarkedTreeString(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2) const
 {
     const Node* rootNode;
     const Node* node = this;
     while (node->parentOrShadowHostNode() && !isHTMLBodyElement(*node))
         node = node->parentOrShadowHostNode();
     rootNode = node;
 
+    StringBuilder builder;
     String startingIndent;
-    traverseTreeAndMark(startingIndent, rootNode, markedNode1, markedLabel1, markedNode2, markedLabel2);
+    appendMarkedTree(startingIndent, rootNode, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
+    return builder.toString();
 }
 
-void Node::showTreeAndMarkInFlatTree(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2) const
+String Node::toMarkedFlatTreeString(const Node* markedNode1, const char* markedLabel1, const Node* markedNode2, const char* markedLabel2) const
 {
     const Node* rootNode;
     const Node* node = this;
     while (node->parentOrShadowHostNode() && !isHTMLBodyElement(*node))
         node = node->parentOrShadowHostNode();
     rootNode = node;
 
+    StringBuilder builder;
     String startingIndent;
-    traverseTreeAndMarkInFlatTree(startingIndent, rootNode, markedNode1, markedLabel1, markedNode2, markedLabel2);
+    appendMarkedFlatTree(startingIndent, rootNode, markedNode1, markedLabel1, markedNode2, markedLabel2, builder);
+    return builder.toString();
 }
 
 static ContainerNode* parentOrShadowHostOrFrameOwner(const Node* node)
 {
     ContainerNode* parent = node->parentOrShadowHostNode();
     if (!parent && node->document().frame())
         parent = node->document().frame()->deprecatedLocalOwner();
     return parent;
 }
 
@@ skipping 683 matching lines @@
 void showNode(const blink::Node* node)
 {
     if (node)
         node->showNode("");
     else
         fprintf(stderr, "Cannot showNode for (nil)\n");
 }
 
 void showTree(const blink::Node* node)
 {
-    if (node)
-        node->showTreeForThis();
-    else
-        fprintf(stderr, "Cannot showTree for (nil)\n");
+    // TODO(tkent): Replace WTFLogAlways with something else.
+    WTFLogAlways("%s", node ? node->toTreeStringForThis().utf8().data() : "Cannot showTree for <null>");
 }
 
 void showNodePath(const blink::Node* node)
 {
     std::stringstream stream;
     if (node)
         node->printNodePathTo(stream);
     else
         stream << "Cannot showNodePath for <null>";
     stream << "\n";
     // TODO(tkent): Replace WTFLogAlways with something else.
     WTFLogAlways("%s", stream.str().c_str());
 }
 
 #endif