Mercurial > hg > truffle

comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ASTPrinter.java @ 21951:9c8c0937da41

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moving all sources into truffle subdirectory
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 17 Jun 2015 10:58:08 +0200
parents graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ASTPrinter.java@36285949c1d5
children dc83cc1f94f2
comparison
equal deleted inserted replaced
21950:2a5011c7e641 21951:9c8c0937da41
1 /*
2 * Copyright (c) 2013, 2015, 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 * Access to AST-based debugging support, which is could be language implementation specific in the
33 * details chosen to be presented.
34 * <p>
35 * <strong>WARNING:</strong> this interface is under development and will change substantially.
36 */
37 public interface ASTPrinter {
38
39 /**
40 * Prints a textual AST display, one line per node, with nesting.
41 *
42 * @param p
43 * @param node the root node of the display.
44 * @param maxDepth the maximum number of levels to print below the root
45 * @param markNode a node to mark with a textual arrow prefix, if present.
46 */
47 void printTree(PrintWriter p, Node node, int maxDepth, Node markNode);
48
49 /**
50 * Creates a textual AST display, one line per node, with nesting.
51 *
52 * @param node the root node of the display.
53 * @param maxDepth the maximum number of levels to print below the root
54 * @param markNode a node to mark with a textual arrow prefix, if present.
55 */
56 String printTreeToString(Node node, int maxDepth, Node markNode);
57
58 /**
59 * Creates a textual AST display, one line per node, with nesting.
60 *
61 * @param node the root node of the display.
62 * @param maxDepth the maximum number of levels to print below the root
63 */
64 String printTreeToString(Node node, int maxDepth);
65
66 /**
67 * Creates a textual display describing a single (non-wrapper) node, including instrumentation
68 * status: if Probed, and any tags.
69 */
70 String printNodeWithInstrumentation(Node node);
71 }