comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/AdvancedInstrumentResultListener.java @ 21353:876e710523c5

Truffle/Instrumentation: rename "Tool Eval" Instrument kind to "Advanced" Instrument kind
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Tue, 12 May 2015 12:57:47 -0700
parents graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ToolEvalResultListener.java@78a4b44420cf
children 575032310b2c
comparison
equal deleted inserted replaced
21345:a818a6a57ef4 21353:876e710523c5
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 * Listener for receiving the result a client-provided {@linkplain AdvancedInstrumentRoot AST
32 * fragment}, when executed by a
33 * {@linkplain Instrument#create(AdvancedInstrumentRootFactory, String) Advanced Instrument}.
34 *
35 * @see Instrument
36 * @see AdvancedInstrumentRoot
37 * @see AdvancedInstrumentRootFactory
38 */
39 public interface AdvancedInstrumentResultListener {
40
41 /**
42 * Notifies listener that a client-provided {@linkplain AdvancedInstrumentRoot AST fragment} has
43 * been executed by an {@linkplain Instrument#create(AdvancedInstrumentRootFactory, String)
44 * Advanced Instrument} with the specified result, possibly {@code null}.
45 *
46 * @param node the guest-language AST node to which the host Instrument's {@link Probe} is
47 * attached
48 * @param vFrame execution frame at the guest-language AST node
49 * @param result the result of this AST fragment's execution
50 */
51 void notifyResult(Node node, VirtualFrame vFrame, Object result);
52
53 /**
54 * Notifies listener that execution of client-provided {@linkplain AdvancedInstrumentRoot AST
55 * fragment} filed during execution by a @linkplain
56 * Instrument#create(AdvancedInstrumentRootFactory, String) Advanced Instrument}.
57 *
58 * @param node the guest-language AST node to which the host Instrument's {@link Probe} is
59 * attached
60 * @param vFrame execution frame at the guest-language AST node
61 * @param ex the exception
62 */
63 void notifyFailure(Node node, VirtualFrame vFrame, RuntimeException ex);
64
65 }