com.oracle.truffle.api

Class Scope

java.lang.Object

com.oracle.truffle.api.Scope

public final class Scope
extends Object

Representation of a scope in a guest language program. The scope contains a set of declared and valid variables. The scopes can be both lexical and dynamic.

Since:

0.30

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Scope.Builder Builder to create a new Scope object.

Method Summary

Modifier and Type	Method and Description
Object	getArguments() Get arguments of this scope.
String	getName() Human readable name of this scope.
Node	getNode() Get a node representing this scope.
Object	getReceiver() Get a receiver object of this scope.
String	getReceiverName() Get code name of the receiver object, if there is any.
Object	getRootInstance() Get the root instance object of this scope.
Object	getVariables() Get variables declared in this scope.
static Scope.Builder	newBuilder(String name, Object variables) Create a new Scope builder.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static Scope.Builder newBuilder(String name,
                                       Object variables)

Create a new Scope builder.

The properties representing the variables needs to have deterministic iteration order, variable declaration order is recommended.

Parameters:

name - name of the scope, a name description like block, name of a function, closure, script, module, etc.

variables - a TruffleObject containing the variables as its properties, never null. Must respond true to HAS_KEYS.

Since:

0.30

getName

public String getName()

Human readable name of this scope. A name description like block, name of a function, closure, script, module, etc.

Since:

0.30

getNode

public Node getNode()

Get a node representing this scope. Functional scopes return the appropriate RootNode , top scopes do not have a node associated.

Returns:

the node, or null when no node is associated.

Since:

0.30

getVariables

public Object getVariables()

Get variables declared in this scope. When a Node (and a Frame) was provided when this scope was obtained, variables are valid at that specified Node (and Frame).

The properties representing the variables have deterministic iteration order, variable declaration order is preferred.

Returns:

A TruffleObject containing the variables as its properties, never null.

Since:

0.30

getArguments

public Object getArguments()

Get arguments of this scope. There might be different arguments returned in local scopes when different Frame instances were provided.

The properties representing the arguments have deterministic iteration order, argument declaration order is preferred.

Returns:

A TruffleObject containing the arguments as its properties for named arguments, or as its array for unnamed arguments. A null is returned when this scope does not have a concept of arguments. An empty TruffleObject is provided when it has a sense to have arguments (e.g. function scope), but there are none.

Since:

0.30

getReceiver

public Object getReceiver()

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

The scope that represents the function provide receiver object, if there is one, other scopes do not provide it, unless they override it.

Returns:

the receiver object, or null when there is no receiver

Since:

19.0

See Also:

Scope.getReceiverName()

getRootInstance

public Object getRootInstance()

Get the root instance object of this scope. The object is an instance of guest language representation of the root node of this scope, e.g. a guest language function.

Returns:

the root instance object, or null when no such instance exists.

Since:

19.3.0

getReceiverName

public String getReceiverName()

Get code name of the receiver object, if there is any.

Returns:

the code name of receiver object, or null.

Since:

19.0

See Also:

Scope.getReceiver()