comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ToolEvalNode.java @ 21181:78a4b44420cf

Truffle/Instrumentation: rename the "SplicedNode" Instrument kind to the "ToolEval" instrument kind, along with some redesign based on earlier feedback.
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 03 May 2015 21:59:55 -0700
parents
children
comparison
equal deleted inserted replaced
21180:c2f5dc4418d0 21181:78a4b44420cf
1 /*
2 * Copyright (c) 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 com.oracle.truffle.api.frame.*;
28 import com.oracle.truffle.api.nodes.*;
29
30 /**
31 * Root of a client-provided AST fragment that can be executed efficiently, subject to full Truffle
32 * optimization, by a {@linkplain Instrument#create(ToolEvalNodeFactory, String) Tool Eval
33 * Instrument}.
34 *
35 * @see Instrument
36 * @see ToolEvalNodeFactory
37 * @see ToolEvalResultListener
38 */
39 public abstract class ToolEvalNode extends Node implements InstrumentationNode {
40
41 /**
42 * Executes this AST fragment on behalf of a client {@link Instrument}, just before the
43 * guest-language AST node to which the {@link Probe} holding the Instrument is executed.
44 *
45 * @param node the guest-language AST node to which the host Instrument's Probe is attached
46 * @param vFrame execution frame at the guest-language AST node
47 * @return the result of this AST fragment's execution
48 */
49 public abstract Object executeToolEvalNode(Node node, VirtualFrame vFrame);
50
51 }