Mercurial > hg > truffle

comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/SimpleInstrumentListener.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/SimpleInstrumentListener.java@263ab98b3bf0
children dc83cc1f94f2
comparison
equal deleted inserted replaced
21950:2a5011c7e641 21951:9c8c0937da41
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.source.*;
28
29 /**
30 * A receiver of Truffle execution events that can act on behalf of an external client.
31 * <p>
32 * The {@link Probe} instance provides access to the {@link SourceSection} associated with the
33 * event, as well as any {@link SyntaxTag}s that have been applied at that program's location.
34 * <p>
35 * This is the simplest kind of listener, suitable for clients that need no other information about
36 * the program's execution state at the time of the event. Clients that require access to the AST
37 * execution state should use {@link StandardInstrumentListener}.
38 * <p>
39 * Clients are free, of course, to record additional information in the listener implementation that
40 * carries additional information about the context and reason for the particular {@link Instrument}
41 * that is to be created from the listener.
42 */
43 public interface SimpleInstrumentListener {
44
45 /**
46 * Receive notification that a program location is about to be executed.
47 * <p>
48 * <strong>Synchronous</strong>: Truffle execution waits until the call returns.
49 */
50 void enter(Probe probe);
51
52 /**
53 * Receive notification that a program location's {@code void}-valued execution has just
54 * completed.
55 * <p>
56 * <strong>Synchronous</strong>: Truffle execution waits until the call returns.
57 */
58 void returnVoid(Probe probe);
59
60 /**
61 * Receive notification that a program location's execution has just completed and returned a
62 * value (boxed if primitive).
63 * <p>
64 * <strong>Synchronous</strong>: Truffle execution waits until the call returns.
65 */
66 void returnValue(Probe probe, Object result);
67
68 /**
69 * Receive notification that a program location's execution has just thrown an exception.
70 * <p>
71 * <strong>Synchronous</strong>: Truffle execution waits until the call returns.
72 */
73 void returnExceptional(Probe probe, Exception exception);
74 }