com.oracle.truffle.api.debug

Class Debugger

java.lang.Object

com.oracle.truffle.api.debug.Debugger

public final class Debugger
extends Object

Represents debugging related state of a PolyglotEngine.

Access to the (singleton) instance in an engine, is available via:

• Debugger.find(PolyglotEngine)
• Debugger.find(TruffleLanguage.Env)
• DebuggerSession.getDebugger()

To start new debugger session use Debugger.startSession(SuspendedCallback). Please see DebuggerSession for a usage example.

The debugger supports diagnostic tracing that can be enabled using the -Dtruffle.debug.trace=true Java property. The output of this tracing is not guaranteed and will change without notice.

Since:

0.9

See Also:

Debugger.startSession(SuspendedCallback), DebuggerSession, Breakpoint

Method Summary

Modifier and Type	Method and Description
static Debugger	find(PolyglotEngine engine) Finds debugger associated with given engine.
static Debugger	find(TruffleLanguage.Env env) Finds the debugger associated with a given language environment.
List<Source>	getLoadedSources() Returns a list of all loaded sources.
DebuggerSession	startSession(SuspendedCallback callback) Starts a new session provided with a callback that gets notified whenever the execution is suspended.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startSession

public DebuggerSession startSession(SuspendedCallback callback)

Starts a new session provided with a callback that gets notified whenever the execution is suspended.

Parameters:

callback - the callback to notify

Since:

0.17

See Also:

DebuggerSession, SuspendedEvent

getLoadedSources

public List<Source> getLoadedSources()

Returns a list of all loaded sources. The sources are returned in the order as they have been loaded by the languages.

Returns:

an unmodifiable list of sources

Since:

0.17

find

public static Debugger find(PolyglotEngine engine)

Finds debugger associated with given engine. There is at most one debugger associated with any PolyglotEngine.

Parameters:

engine - the engine to find debugger for

Returns:

an instance of associated debugger, never null

Since:

0.9

find

public static Debugger find(TruffleLanguage.Env env)

Finds the debugger associated with a given language environment. There is at most one debugger associated with any PolyglotEngine. Please note that a debugger instance looked up with a language also has access to all other languages and sources that were loaded by them.

Parameters:

env - the language environment to find debugger for

Returns:

an instance of associated debugger, never null

Since:

0.17