New Prettyprinter class that converts Node-tree to string.

lib/compiler/implementation/tree/prettyprint.dart

+// Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+/**
+ * Pretty-prints Node tree in XML-like format.
+ *
+ * TODO(smok): Add main() to run from command-line to print out tree for given
+ * .dart file.
+ */
+class PrettyPrinter implements Visitor {
+  StringBuffer sb;
+  int depth;
+  
+  PrettyPrinter() : sb = new StringBuffer(), depth = 0;
+
+  void add(SourceString string) {
+    string.printOn(sb);
+  }
+
+  void addInNode(String type, [Map params]) {

[ahe, 2012/06/01 12:52:57]

What does the method name mean?

[Roman, 2012/06/05 09:28:54]

Changed to "openNode"

+    addCurrentIndent();
+    sb.add("<");
+    addTypeWithParams(type, params);
+    sb.add(">\n");
+    depth++;
+  }
+
+  void addInOutNode(String type, [Map params]) {

[ahe, 2012/06/01 12:52:57]

Ditto.

[Roman, 2012/06/05 09:28:54]

Changed to openAndCloseNode(), not sure if it's the best name. Any suggestions?

+    addCurrentIndent();
+    sb.add("<");
+    addTypeWithParams(type, params);
+    sb.add("/>\n");
+  }
+
+  void addOutNode(String type, [Map params]) {

[ahe, 2012/06/01 12:52:57]

Ditto.

[Roman, 2012/06/05 09:28:54]

Changed to "closeNode"

+    depth--;
+    addCurrentIndent();
+    sb.add("</");
+    addTypeWithParams(type, params);
+    sb.add(">\n");
+  }
+
+  void addTypeWithParams(String type, [Map params]) {
+    sb.add("${type}");
+    if (params != null) {
+      // TODO(smok): Escape doublequotes in values.

[ahe, 2012/06/01 12:52:57]

When you get to address this TODO, we have code for that, somewhere.

+      params.forEach((k, v) => sb.add(' $k="$v"'));
+    }
+  }
+
+  void addCurrentIndent() {
+    for (int i = 0; i < depth; i++) {
+      if (i % 4 == 0) {
+        sb.add(". ");

[ahe, 2012/06/01 12:52:57]

I'd prefer if you didn't add the periods. If you make this proper XML, you can
display it in your favorite XML editor or browser.

[Roman, 2012/06/05 09:28:54]

Done.

+      } else {
+        sb.add("  ");

[ahe, 2012/06/01 12:52:57]

Perhaps make this a static constant in the beginning of the file. This way it is
"easy" to change the indentation level.

[Roman, 2012/06/05 09:28:54]

Created static final String _INDENT = "  ";
Or did you mean const out of the class definition? I would prefer keeping the
scope of the constant inside the class.

+      }
+    }
+  }
+
+  /**
+   * Pretty-prints given node tree into string.
+   */
+  String prettyPrint(Node node) {
+    depth = 0;
+    sb = new StringBuffer();

[ahe, 2012/06/01 12:52:57]

How do you expect to use this method and class? Are you planning on allocating
two StringBuffers every time you use it?

[Roman, 2012/06/05 09:28:54]

What do you mean by two StringBuffers?
I was thinking about this usage:
new PrettyPrinter().prettyPrint(node);

It may be useful to provide method like this one:
void prettyPrintTo(Node node, StringBuffer buffer);

to use in Node.toDebugString() for example.

Another idea is to provide simple static method:
static String prettyPrint(Node node);
and private constructor (starting with underscore).

[ahe, 2012/06/08 07:37:36]

The constructor always creates a string buffer. So you end up creating two. Not
terrible, but not necessary. 

On 2012/06/05 09:28:54, Roman wrote:

[Roman, 2012/06/08 09:10:15]

Ah, I see now. Yeah, that's dumb. Changed to just clear the buffer here.

+    node.accept(this);
+    return sb.toString();
+  }
+
+  visitNodeWithChildren(Node node, String type) {
+    addInNode(type);
+    node.visitChildren(this);
+    addOutNode(type);
+  }
+
+  visitBlock(Block node) {
+    visitNodeWithChildren(node, "Block");
+  }
+
+  visitBreakStatement(BreakStatement node) {
+    visitNodeWithChildren(node, "BreakStatement");
+  }
+
+  visitCascade(Cascade node) {
+    visitNodeWithChildren(node, "Cascade");
+  }
+
+  visitCascadeReceiver(CascadeReceiver node) {
+    visitNodeWithChildren(node, "CascadeReceiver");
+  }
+
+  visitCaseMatch(CaseMatch node) {
+    visitNodeWithChildren(node, "CaseMatch");
+  }
+
+  visitCatchBlock(CatchBlock node) {
+    visitNodeWithChildren(node, "CatchBlock");
+  }
+
+  visitClassNode(ClassNode node) {
+    visitNodeWithChildren(node, "ClassNode");
+  }
+
+  visitConditional(Conditional node) {
+    visitNodeWithChildren(node, "Conditional");
+  }
+
+  visitContinueStatement(ContinueStatement node) {
+    visitNodeWithChildren(node, "ContinueStatement");
+  }
+
+  visitDoWhile(DoWhile node) {
+    visitNodeWithChildren(node, "DoWhile");
+  }
+
+  visitEmptyStatement(EmptyStatement node) {
+    visitNodeWithChildren(node, "EmptyStatement");
+  }
+
+  visitExpressionStatement(ExpressionStatement node) {
+    visitNodeWithChildren(node, "ExpressionStatement");
+  }
+
+  visitFor(For node) {
+    visitNodeWithChildren(node, "For");
+  }
+
+  visitForIn(ForIn node) {
+    visitNodeWithChildren(node, "ForIn");
+  }
+
+  visitFunctionDeclaration(FunctionDeclaration node) {
+    visitNodeWithChildren(node, "FunctionDeclaration");
+  }
+
+  visitFunctionExpression(FunctionExpression node) {
+    visitNodeWithChildren(node, "FunctionExpression");
+  }
+
+  visitIdentifier(Identifier node) {
+    addInOutNode("Identifier", {"token" : node.token.slowToString()});
+  }
+
+  visitIf(If node) {
+    visitNodeWithChildren(node, "If");
+  }
+
+  visitLabel(Label node) {
+    visitNodeWithChildren(node, "Label");
+  }
+
+  visitLabeledStatement(LabeledStatement node) {
+    visitNodeWithChildren(node, "LabeledStatement");
+  }
+
+  // Custom.
+  visitLiteral(Literal node, String type) {
+    addInOutNode(type, {"value" : node.value.toString()});
+  }
+
+  visitLiteralBool(LiteralBool node) {
+    visitLiteral(node, "LiteralBool");
+  }
+
+  visitLiteralDouble(LiteralDouble node) {
+    visitLiteral(node, "LiteralDouble");
+  }
+
+  visitLiteralInt(LiteralInt node) {
+    visitLiteral(node, "LiteralInt");
+  }
+
+  visitLiteralList(LiteralList node) {
+    visitNodeWithChildren(node, "LiteralList");
+  }
+
+  visitLiteralMap(LiteralMap node) {
+    visitNodeWithChildren(node, "LiteralMap");
+  }
+
+  visitLiteralMapEntry(LiteralMapEntry node) {
+    visitNodeWithChildren(node, "LiteralMapEntry");
+  }
+
+  visitLiteralNull(LiteralNull node) {
+    visitLiteral(node, "LiteralNull");
+  }
+
+  visitLiteralString(LiteralString node) {
+    addInOutNode("LiteralString", {"value" : node.token.slowToString()});
+  }
+
+  visitModifiers(Modifiers node) {
+    visitNodeWithChildren(node, "Modifiers");
+  }
+
+  visitNamedArgument(NamedArgument node) {
+    visitNodeWithChildren(node, "NamedArgument");
+  }
+
+  visitNewExpression(NewExpression node) {
+    visitNodeWithChildren(node, "NewExpression");
+  }
+
+  visitNodeList(NodeList node) {
+    if (node.nodes.toList().length == 0) {
+      addInOutNode("NodeList");
+    } else {
+      visitNodeWithChildren(node, "NodeList");
+    }
+  }
+
+  visitOperator(Operator node) {
+    addInOutNode("Operator", {"value" : node.token.slowToString()});
+  }
+
+  visitParenthesizedExpression(ParenthesizedExpression node) {
+    visitNodeWithChildren(node, "ParenthesizedExpression");
+  }
+
+  visitReturn(Return node) {
+    visitNodeWithChildren(node, "Return");
+  }
+
+  visitScriptTag(ScriptTag node) {
+    visitNodeWithChildren(node, "ScriptTag");
+  }
+
+  visitSend(Send node) {
+    visitNodeWithChildren(node, "Send");
+  }
+
+  visitSendSet(SendSet node) {
+    visitNodeWithChildren(node, "SendSet");
+  }
+
+  visitStringInterpolation(StringInterpolation node) {
+    visitNodeWithChildren(node, "StringInterpolation");
+  }
+
+  visitStringInterpolationPart(StringInterpolationPart node) {
+    visitNodeWithChildren(node, "StringInterpolationPart");
+  }
+
+  visitStringJuxtaposition(StringJuxtaposition node) {
+    visitNodeWithChildren(node, "StringJuxtaposition");
+  }
+
+  visitSwitchCase(SwitchCase node) {
+    visitNodeWithChildren(node, "SwitchCase");
+  }
+
+  visitSwitchStatement(SwitchStatement node) {
+    visitNodeWithChildren(node, "SwitchStatement");
+  }
+
+  visitThrow(Throw node) {
+    visitNodeWithChildren(node, "Throw");
+  }
+
+  visitTryStatement(TryStatement node) {
+    visitNodeWithChildren(node, "TryStatement");
+  }
+
+  visitTypeAnnotation(TypeAnnotation node) {
+    visitNodeWithChildren(node, "TypeAnnotation");
+  }
+
+  visitTypedef(Typedef node) {
+    visitNodeWithChildren(node, "Typedef");
+  }
+
+  visitTypeVariable(TypeVariable node) {
+    visitNodeWithChildren(node, "TypeVariable");
+  }
+
+  visitVariableDefinitions(VariableDefinitions node) {
+    visitNodeWithChildren(node, "VariableDefinitions");
+  }
+
+  visitWhile(While node) {
+    visitNodeWithChildren(node, "While");
+  }
+}