comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/impl/SimpleASTInstrumentListener.java @ 19819:a5b09092003a

Truffle/Instrumentation (part 2): For clients of Instrumentation, replace the TruffleEventListener interface with two: InstrumentListener, and ASTInstrumentListener. The former is simple, completely Truffle-safe (can't affect Truffle execution), and designed for simple tools. The latter is similar to the previous interface.
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Thu, 12 Mar 2015 18:04:30 -0700
parents
children
comparison
equal deleted inserted replaced
19818:907128d02b31 19819:a5b09092003a
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.impl;
26
27 import com.oracle.truffle.api.frame.*;
28 import com.oracle.truffle.api.instrument.*;
29 import com.oracle.truffle.api.nodes.*;
30
31 /**
32 * An abstract listener for AST {@linkplain ASTInstrumentListener execution events} that ignores
33 * return values and supports handling all events by overriding only two methods:
34 * <ul>
35 * <li>{@link #enter(Probe, Node, VirtualFrame)}, and</li>
36 * <li>{@link #returnAny(Probe, Node, VirtualFrame)}.</li>
37 * </ul>
38 */
39 public abstract class SimpleASTInstrumentListener implements ASTInstrumentListener {
40
41 public void enter(Probe probe, Node node, VirtualFrame vFrame) {
42 }
43
44 /**
45 * Receive notification that one of an AST Node's execute methods has just returned by any
46 * means: with or without a return value (ignored) or via exception (ignored).
47 *
48 * @param probe where the event originated
49 * @param node specific node of the event
50 * @param vFrame
51 */
52 protected void returnAny(Probe probe, Node node, VirtualFrame vFrame) {
53 }
54
55 public final void returnVoid(Probe probe, Node node, VirtualFrame vFrame) {
56 returnAny(probe, node, vFrame);
57 }
58
59 public final void returnValue(Probe probe, Node node, VirtualFrame vFrame, Object result) {
60 returnAny(probe, node, vFrame);
61 }
62
63 public final void returnExceptional(Probe probe, Node node, VirtualFrame vFrame, Exception e) {
64 returnAny(probe, node, vFrame);
65 }
66
67 }