com.oracle.truffle.api.debug

Class DebugScope

java.lang.Object

com.oracle.truffle.api.debug.DebugScope

public final class DebugScope
extends Object

Representation of guest language scope at the current suspension point. It contains a set of declared and valid variables as well as arguments, if any. The scope is only valid as long as the associated frame is valid.

Since:

0.26

See Also:

DebugStackFrame.getScope()

Method Summary

Modifier and Type	Method and Description
Iterable<DebugValue>	getArguments() Get arguments of this scope.
DebugValue	getDeclaredValue(String name) Get a local variable declared in this scope by name.
Iterable<DebugValue>	getDeclaredValues() Get local variables declared in this scope, valid at the current suspension point.
String	getName() Get a human readable name of this scope.
DebugScope	getParent() Get a parent scope.
DebugValue	getReceiver() Get value that represents the receiver object of this scope.
SourceSection	getSourceSection() Get a source section representing this scope.
boolean	isFunctionScope() Test if this scope represents the function scope at the frame it was obtained from.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Get a human readable name of this scope.

Since:

0.26

getParent

public DebugScope getParent()
                     throws DebugException

Get a parent scope.

Returns:

the parent scope, or null.

Throws:

DebugException - when guest language code throws an exception

Since:

0.26

isFunctionScope

public boolean isFunctionScope()

Test if this scope represents the function scope at the frame it was obtained from. arguments of function scope represent arguments of the appropriate function.

Since:

0.26

getSourceSection

public SourceSection getSourceSection()
                               throws DebugException

Get a source section representing this scope. Please note that while this scope does not provide variables that are valid only after the suspension point, the source section can actually span after the suspension point.

Returns:

the source section, or null when not available.

Throws:

DebugException - when guest language code throws an exception

Since:

0.29

getArguments

public Iterable<DebugValue> getArguments()
                                  throws DebugException

Get arguments of this scope. If this scope is a function scope, function arguments are returned.

This method is not thread-safe and will throw an IllegalStateException if called on another thread than it was created with.

Returns:

an iterable of arguments, or null when this scope does not have a concept of arguments.

Throws:

DebugException - when guest language code throws an exception

Since:

0.26

getReceiver

public DebugValue getReceiver()

Get value that represents the receiver object of this scope. The receiver object is represented as this in Java or JavaScript and self in Ruby, for instance.

The returned value has a name that represents the receiver in the guest language. The scope that represents the function provide receiver object, if there is one, other scopes do not provide it, unless they override it.

Returns:

value that represents the receiver, or null when there is no receiver object

Since:

19.0

getDeclaredValues

public Iterable<DebugValue> getDeclaredValues()
                                       throws DebugException

Get local variables declared in this scope, valid at the current suspension point. Call this method on parent, to get values of variables declared in parent scope, if any.

This method is not thread-safe and will throw an IllegalStateException if called on another thread than it was created with.

Throws:

DebugException - when guest language code throws an exception

Since:

0.26

getDeclaredValue

public DebugValue getDeclaredValue(String name)
                            throws DebugException

Get a local variable declared in this scope by name. Call this method on parent, to get value of a variable declared in parent scope, if any.

This method is not thread-safe and will throw an IllegalStateException if called on another thread than it was created with.

Returns:

a value of requested name, or null when no such value was found.

Throws:

DebugException - when guest language code throws an exception

Since:

0.26