Mercurial > hg > truffle

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ASTPrinter.java @ 16859:1051d6e4b61b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
truffle api: update comments
author Bernhard Urban <bernhard.urban@jku.at>
date Tue, 19 Aug 2014 13:51:14 +0200
parents 0c6d8a08e31b
children 36285949c1d5
comparison
equal deleted inserted replaced
16858:a8af2abc2039 16859:1051d6e4b61b
27 import java.io.*; 27 import java.io.*;
28 28
29 import com.oracle.truffle.api.nodes.*; 29 import com.oracle.truffle.api.nodes.*;
30 30
31 /** 31 /**
32 * Language-agnostic access to AST-based debugging support. 32 * Access to AST-based debugging support, which is could be language implementation specific in the
33 * details chosen to be presented.
33 * <p> 34 * <p>
34 * <strong>WARNING:</strong> this interface is under development and will change substantially. 35 * <strong>WARNING:</strong> this interface is under development and will change substantially.
35 */ 36 */
36 public interface ASTPrinter { 37 public interface ASTPrinter {
37 38
38 /** 39 /**
39 * Prints a textual AST display, one line per node, with nesting. 40 * Prints a textual AST display, one line per node, with nesting.
40 * 41 *
41 * @param p 42 * @param p
42 * @param node the root node of the display. 43 * @param node the root node of the display.
43 * @param maxDepth the maximum number of levels to print below the root 44 * @param maxDepth the maximum number of levels to print below the root
44 * @param markNode a node to mark with a textual arrow prefix, if present. 45 * @param markNode a node to mark with a textual arrow prefix, if present.
45 */ 46 */
46 void printTree(PrintWriter p, Node node, int maxDepth, Node markNode); 47 void printTree(PrintWriter p, Node node, int maxDepth, Node markNode);
47 48
48 /** 49 /**
49 * Creates a textual AST display, one line per node, with nesting. 50 * Creates a textual AST display, one line per node, with nesting.
50 * 51 *
51 * @param node the root node of the display. 52 * @param node the root node of the display.
52 * @param maxDepth the maximum number of levels to print below the root 53 * @param maxDepth the maximum number of levels to print below the root
53 * @param markNode a node to mark with a textual arrow prefix, if present. 54 * @param markNode a node to mark with a textual arrow prefix, if present.
54 */ 55 */
55 String printTreeToString(Node node, int maxDepth, Node markNode); 56 String printTreeToString(Node node, int maxDepth, Node markNode);
56 57
57 /** 58 /**
58 * Creates a textual AST display, one line per node, with nesting. 59 * Creates a textual AST display, one line per node, with nesting.
59 * 60 *
60 * @param node the root node of the display. 61 * @param node the root node of the display.
61 * @param maxDepth the maximum number of levels to print below the root 62 * @param maxDepth the maximum number of levels to print below the root
62 */ 63 */
63 String printTreeToString(Node node, int maxDepth); 64 String printTreeToString(Node node, int maxDepth);
64 65