com.oracle.truffle.api.metadata

Class ScopeProvider.AbstractScope

java.lang.Object

com.oracle.truffle.api.metadata.ScopeProvider.AbstractScope

Enclosing interface:

ScopeProvider<C>

public abstract static class ScopeProvider.AbstractScope
extends Object

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

Since:

0.26

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScope()

Method Summary

Modifier and Type	Method and Description
protected abstract ScopeProvider.AbstractScope	findParent() Find a parent scope.
protected abstract Object	getArguments(Frame frame) Provide arguments of this scope.
protected abstract String	getName() Human readable name of this scope.
protected abstract Node	getNode() Get a node representing this scope.
protected abstract Object	getVariables(Frame frame) Provide variables declared in this scope and valid at the Node passed to ScopeProvider.findScope(java.lang.Object, com.oracle.truffle.api.nodes.Node, com.oracle.truffle.api.frame.Frame) .

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScope

protected AbstractScope()

Since:

0.26

Method Detail

getName

protected abstract String getName()

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

Since:

0.26

getNode

protected abstract Node getNode()

Get a node representing this scope. Functional scopes should return the appropriate RootNode.

Returns:

the node, or null when no node is associated.

Since:

0.26

getVariables

protected abstract Object getVariables(Frame frame)

Provide variables declared in this scope and valid at the Node passed to ScopeProvider.findScope(java.lang.Object, com.oracle.truffle.api.nodes.Node, com.oracle.truffle.api.frame.Frame) . In general, there can be different variables returned when different Frame instances are provided.

Parameters:

frame - The current frame, or null for lexical access when the program is not running, or is not suspended at the scope's location. The variables might not be readable/writable with the null frame.

Returns:

A TruffleObject containing the variables as its properties. Should not be null, provide an empty TruffleObject when no variables are available.

Since:

0.26

getArguments

protected abstract Object getArguments(Frame frame)

Provide arguments of this scope. In general, there can be different arguments returned when different Frame instances are provided.

Parameters:

frame - The current frame, or null for lexical access when the program is not running, or is not suspended at the scope's location. The arguments might not be readable/writable with the null frame.

Returns:

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

Since:

0.26

findParent

protected abstract ScopeProvider.AbstractScope findParent()

Find a parent scope.

Returns:

the parent scope, or null when there is none.

Since:

0.26