comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ASTPrinter.java @ 15279:0c6d8a08e31b

Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 20 Apr 2014 20:37:27 -0700
parents
children 1051d6e4b61b
comparison
equal deleted inserted replaced
14862:0e713dba33bb 15279:0c6d8a08e31b
1 /*
2 * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package com.oracle.truffle.api.instrument;
26
27 import java.io.*;
28
29 import com.oracle.truffle.api.nodes.*;
30
31 /**
32 * Language-agnostic access to AST-based debugging support.
33 * <p>
34 * <strong>WARNING:</strong> this interface is under development and will change substantially.
35 */
36 public interface ASTPrinter {
37
38 /**
39 * Prints a textual AST display, one line per node, with nesting.
40 *
41 * @param p
42 * @param node the root node of the display.
43 * @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 */
46 void printTree(PrintWriter p, Node node, int maxDepth, Node markNode);
47
48 /**
49 * Creates a textual AST display, one line per node, with nesting.
50 *
51 * @param node the root node of the display.
52 * @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 */
55 String printTreeToString(Node node, int maxDepth, Node markNode);
56
57 /**
58 * Creates a textual AST display, one line per node, with nesting.
59 *
60 * @param node the root node of the display.
61 * @param maxDepth the maximum number of levels to print below the root
62 */
63 String printTreeToString(Node node, int maxDepth);
64
65 }