comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/NodeInstrumenter.java @ 14094:3f27e57439ed

Truffle/Instrumentation: significant rearrangement (including moved class) and extension of the Truffle Instrumentation Framework. New interfaces include DebugContext (which can be attached to the ExecutionContext), through which access is provided to possibly language-specific (a) node instrumentation, (b) debug services manager, (c) notification when programs halt, (d) display of language values, and (e) display of variable identifiers.
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Mon, 03 Feb 2014 20:58:23 -0800
parents
children
comparison
equal deleted inserted replaced
13736:64fa70319890 14094:3f27e57439ed
1 /*
2 * Copyright (c) 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.nodes.instrument;
26
27 import com.oracle.truffle.api.nodes.*;
28
29 /**
30 * Implements the instrumentation of a Truffle AST node and returning either:
31 * <ul>
32 * <li>the node itself, or</li>
33 * <li>a newly created {@linkplain InstrumentationProxyNode proxy node} that holds the instrumented
34 * node as its {@linkplain com.oracle.truffle.api.nodes.Node.Child child}.</li>
35 * </ul>
36 */
37 public interface NodeInstrumenter {
38
39 /**
40 * Wraps a {@linkplain InstrumentationProxyNode proxy node} around a node (if not already
41 * wrapped), marks the location with a {@linkplain NodePhylum phylum (category)} for user
42 * interaction, and passes along any characteristics of the particular node that are important
43 * for instrumentation (e.g. the function/method name at a call).
44 */
45 Node instrumentAs(Node node, NodePhylum phylum, Object... args);
46 }