comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/package-info.java @ 22259:1348cc2e084e

Truffle/Instrumentation: javadoc
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Mon, 28 Sep 2015 12:34:51 -0700
parents 75e5db92973a
children bbe2598ae2bc
comparison
equal deleted inserted replaced
22258:ff9d1426d744 22259:1348cc2e084e
22 * or visit www.oracle.com if you need additional information or have any 22 * or visit www.oracle.com if you need additional information or have any
23 * questions. 23 * questions.
24 */ 24 */
25 25
26 /** 26 /**
27 * <h4>The Truffle Instrumentation Framework</h4> 27 * <h4>Truffle {@linkplain com.oracle.truffle.api.instrument.Instrumenter Instrumentation}: access to execution events for Debuggers and other tools.</h4>
28 * <p> 28 * <p>
29 * This framework permits client 29 * This framework permits client
30 * {@linkplain com.oracle.truffle.api.instrument.Instrumenter.Tool tools}, 30 * {@linkplain com.oracle.truffle.api.instrument.Instrumenter.Tool tools},
31 * either builtin or third-party, to observe with <em>very low overhead</em> the execution of a 31 * either builtin or third-party, to observe with <em>very low overhead</em> the execution of a
32 * {@linkplain com.oracle.truffle.api.TruffleLanguage Truffle Language} program at the level of 32 * {@linkplain com.oracle.truffle.api.TruffleLanguage Truffle Language} program at the level of
155 * <li>One (but no more than one) 155 * <li>One (but no more than one)
156 * {@linkplain com.oracle.truffle.api.instrument.StandardBeforeInstrumentListener StandardBeforeInstrumentListener} 156 * {@linkplain com.oracle.truffle.api.instrument.StandardBeforeInstrumentListener StandardBeforeInstrumentListener}
157 * may optionally be attached for notification <em>before</em> every <em>AST execution event</em> where the specified 157 * may optionally be attached for notification <em>before</em> every <em>AST execution event</em> where the specified
158 * {@linkplain com.oracle.truffle.api.instrument.SyntaxTag tag} is present.</li> 158 * {@linkplain com.oracle.truffle.api.instrument.SyntaxTag tag} is present.</li>
159 * <li>One (but no more than one) 159 * <li>One (but no more than one)
160 * {@linkplain com.oracle.truffle.api.instrument.StandardBeforeInstrumentListener StandardBeforeInstrumentListener} 160 * {@linkplain com.oracle.truffle.api.instrument.StandardAfterInstrumentListener StandardAfterInstrumentListener}
161 * may optionally be attached for notification <em>after</em> every <em>AST execution event</em> where the specified 161 * may optionally be attached for notification <em>after</em> every <em>AST execution event</em> where the specified
162 * {@linkplain com.oracle.truffle.api.instrument.SyntaxTag tag} is present.</li> 162 * {@linkplain com.oracle.truffle.api.instrument.SyntaxTag tag} is present.</li>
163 * <li>The 163 * <li>The
164 * {@linkplain com.oracle.truffle.api.instrument.TagInstrument TagInstrument} mechanism is independent 164 * {@linkplain com.oracle.truffle.api.instrument.TagInstrument TagInstrument} mechanism is independent
165 * of listeners that may be attached to 165 * of listeners that may be attached to