org.jruby.parser

Class StaticScope

java.lang.Object

org.jruby.parser.StaticScope

All Implemented Interfaces:

java.io.Serializable

public class StaticScope
extends java.lang.Object
implements java.io.Serializable

StaticScope represents lexical scoping of variables and module/class constants. At a very high level every scopes enclosing scope contains variables in the next outer lexical layer. The enclosing scopes variables may or may not be reachable depending on the scoping rules for variables (governed by BlockStaticScope and LocalStaticScope). StaticScope also keeps track of current module/class that is in scope. previousCRefScope will point to the previous scope of the enclosing module/class (cref).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticScope.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected StaticScope	enclosingScope
static int	MAX_SPECIALIZED_SIZE
protected IRScopeType	scopeType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope) Construct a new static scope.
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope, java.lang.String file)
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope, java.lang.String[] names)
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope, java.lang.String[] names, int firstKeywordIndex) Construct a new static scope.

Method Summary

Modifier and Type	Method and Description
AssignableNode	addAssign(ISourcePosition position, RubySymbol symbolID, Node value)
int	addNamedCaptureVariable(java.lang.String name) Add a new named capture variable to this (current) scope.
int	addVariable(java.lang.String name) Add a new variable to this (current) scope unless it is already defined in any reachable scope.
int	addVariableThisScope(java.lang.String name) Add a new variable to this (current) scope unless it is already defined in the current scope.
AssignableNode	assign(ISourcePosition position, RubySymbol name, Node value) Make a DASgn or LocalAsgn node based on scope logic
AssignableNode	assign(ISourcePosition position, RubySymbol symbolID, Node value, StaticScope topScope, int depth)
AssignableNode	assignKeyword(ISourcePosition position, RubySymbol symbolID, Node value) Register a keyword argument with this staticScope.
<T> T	collectVariables(java.util.function.IntFunction<T> collectionFactory, java.util.function.BiConsumer<T,java.lang.String> collectionPopulator) Populate a deduplicated collection of variable names in scope using the given functions.
DynamicScope	construct(DynamicScope parent)
Node	declare(ISourcePosition position, RubySymbol symbolID) Make a DVar or LocalVar node based on scoping logic
Node	declare(ISourcePosition position, RubySymbol symbolID, int depth)
RubyModule	determineModule() Update current scoping structure to populate with proper cref scoping values.
StaticScope	duplicate()
int	exists(java.lang.String name) Does the variable exist?
java.lang.String[]	getAllNamesInScope() Get all visible variables that we can see from this scope that have been assigned (e.g.
long	getCommandArgumentStack()
IRubyObject	getConstant(java.lang.String internedName)
IRubyObject	getConstantDefined(java.lang.String internedName) Gets a constant back from lexical search from the cref in this scope.
IRubyObject	getConstantDefinedNoObject(java.lang.String internedName)
IRubyObject	getConstantInner(java.lang.String internedName)
DynamicScope	getDummyScope()
StaticScope	getEnclosingScope() Next outer most scope in list of scopes.
java.lang.String	getFile()
int	getFirstKeywordIndex()
IRScope	getIRScope()
StaticScope	getLocalScope() Gets the Local Scope relative to the current Scope.
RubyArray	getLocalVariables(Ruby runtime) Convenience wrapper around collectVariables(IntFunction, BiConsumer).
RubyModule	getModule() Get the live CRef module associated with this scope.
int	getNumberOfVariables()
RubyModule	getOverlayModuleForRead()
RubyModule	getOverlayModuleForWrite(ThreadContext context)
StaticScope	getPreviousCRefScope()
IRScopeType	getScopeType()
Signature	getSignature() For all block or method associated with static scopes this will return the signature for that signature-providing scope.
StaticScope.Type	getType()
java.lang.String[]	getVariables()
boolean	isArgumentScope() Argument scopes represent scopes which contain arguments for zsuper.
boolean	isBlockScope()
int	isDefined(java.lang.String name) Is this name in the visible to the current scope
int	isDefined(java.lang.String name, int depth)
boolean	isNamedCapture(int index)
boolean	keywordExists(java.lang.String name)
void	makeArgumentScope()
void	setCommandArgumentStack(long commandArgumentStack)
void	setIRScope(IRScope irScope)
void	setModule(RubyModule module)
void	setPreviousCRefScope(StaticScope crefScope)
void	setScopeType(IRScopeType scopeType)
void	setSignature(Signature signature) This happens in when first defining ArgsNodes or when reifying a method from AOT.
void	setVariables(java.lang.String[] names)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SPECIALIZED_SIZE

public static final int MAX_SPECIALIZED_SIZE

See Also:

Constant Field Values

enclosingScope

protected final StaticScope enclosingScope

scopeType

protected IRScopeType scopeType

Constructor Detail

StaticScope

protected StaticScope(StaticScope.Type type,
                      StaticScope enclosingScope,
                      java.lang.String file)

StaticScope

protected StaticScope(StaticScope.Type type,
                      StaticScope enclosingScope)

Construct a new static scope.

Parameters:

type - the type of scope

enclosingScope - the lexically containing scope.

StaticScope

protected StaticScope(StaticScope.Type type,
                      StaticScope enclosingScope,
                      java.lang.String[] names,
                      int firstKeywordIndex)

Construct a new static scope. The array of strings should all be the interned versions, since several other optimizations depend on being able to do object equality checks.

Parameters:

type - the type of scope

enclosingScope - the lexically containing scope.

names - The list of interned String variable names.

StaticScope

protected StaticScope(StaticScope.Type type,
                      StaticScope enclosingScope,
                      java.lang.String[] names)

Method Detail

getFirstKeywordIndex

public int getFirstKeywordIndex()

construct

public DynamicScope construct(DynamicScope parent)

getIRScope

public IRScope getIRScope()

getScopeType

public IRScopeType getScopeType()

setScopeType

public void setScopeType(IRScopeType scopeType)

setIRScope

public void setIRScope(IRScope irScope)

addVariableThisScope

public int addVariableThisScope(java.lang.String name)

Add a new variable to this (current) scope unless it is already defined in the current scope.

Parameters:

name - of new variable

Returns:

index of variable

addNamedCaptureVariable

public int addNamedCaptureVariable(java.lang.String name)

Add a new named capture variable to this (current) scope.

Parameters:

name - name of variable.

Returns:

index of variable

addVariable

public int addVariable(java.lang.String name)

Add a new variable to this (current) scope unless it is already defined in any reachable scope.

Parameters:

name - of new variable

Returns:

index+depth merged location of scope

getVariables

public java.lang.String[] getVariables()

getNumberOfVariables

public int getNumberOfVariables()

setVariables

public void setVariables(java.lang.String[] names)

getConstantDefined

public IRubyObject getConstantDefined(java.lang.String internedName)

Gets a constant back from lexical search from the cref in this scope. As it is for defined? we will not forced resolution of autoloads nor call const_defined

getConstantDefinedNoObject

public IRubyObject getConstantDefinedNoObject(java.lang.String internedName)

getConstant

public IRubyObject getConstant(java.lang.String internedName)

getConstantInner

public IRubyObject getConstantInner(java.lang.String internedName)

getEnclosingScope

public StaticScope getEnclosingScope()

Next outer most scope in list of scopes. An enclosing scope may have no direct scoping relationship to its child. If I am in a localScope and then I enter something which creates another localScope the enclosing scope will be the first scope, but there are no valid scoping relationships between the two. Methods which walk the enclosing scopes are responsible for enforcing appropriate scoping relationships.

Returns:

the parent scope

exists

public int exists(java.lang.String name)

Does the variable exist?

Parameters:

name - of the variable to find

Returns:

index of variable or -1 if it does not exist

isDefined

public int isDefined(java.lang.String name)

Is this name in the visible to the current scope

Parameters:

name - to be looked for

Returns:

a location where the left-most 16 bits of number of scopes down it is and the right-most 16 bits represents its index in that scope

assign

public AssignableNode assign(ISourcePosition position,
                             RubySymbol name,
                             Node value)

Make a DASgn or LocalAsgn node based on scope logic

Parameters:

position -

name -

value -

Returns:

Note: This is private code made public only for parser.

assignKeyword

public AssignableNode assignKeyword(ISourcePosition position,
                                    RubySymbol symbolID,
                                    Node value)

Register a keyword argument with this staticScope. It additionally will track where the first keyword argument started so we can test and tell whether we have a kwarg or an ordinary variable during live execution (See keywordExists).

Parameters:

position -

symbolID -

value -

Returns:

keywordExists

public boolean keywordExists(java.lang.String name)

getAllNamesInScope

public java.lang.String[] getAllNamesInScope()

Get all visible variables that we can see from this scope that have been assigned (e.g. seen so far)

Returns:

a list of all names (sans $~ and $_ which are special names)

collectVariables

public <T> T collectVariables(java.util.function.IntFunction<T> collectionFactory,
                              java.util.function.BiConsumer<T,java.lang.String> collectionPopulator)

Populate a deduplicated collection of variable names in scope using the given functions. This may include variables that are not strictly Ruby local variable names, so the consumer should validate names as appropriate.

Type Parameters:

T - resulting collection type

Parameters:

collectionFactory - used to construct the collection

collectionPopulator - used to pass values into the collection

Returns:

populated collection

getLocalVariables

public RubyArray getLocalVariables(Ruby runtime)

Convenience wrapper around collectVariables(IntFunction, BiConsumer).

Parameters:

runtime - current runtime

Returns:

populated RubyArray

isDefined

public int isDefined(java.lang.String name,
                     int depth)

addAssign

public AssignableNode addAssign(ISourcePosition position,
                                RubySymbol symbolID,
                                Node value)

assign

public AssignableNode assign(ISourcePosition position,
                             RubySymbol symbolID,
                             Node value,
                             StaticScope topScope,
                             int depth)

declare

public Node declare(ISourcePosition position,
                    RubySymbol symbolID,
                    int depth)

declare

public Node declare(ISourcePosition position,
                    RubySymbol symbolID)

Make a DVar or LocalVar node based on scoping logic

Parameters:

position - the location that in the source that the new node will come from

symbolID - of the variable to be created is named

Returns:

a DVarNode or LocalVarNode Note: This is private code made public only for parser.

getLocalScope

public StaticScope getLocalScope()

Gets the Local Scope relative to the current Scope. For LocalScopes this will be itself. Blocks will contain the LocalScope it contains.

Returns:

localScope

getModule

public RubyModule getModule()

Get the live CRef module associated with this scope.

Returns:

the live module

getPreviousCRefScope

public StaticScope getPreviousCRefScope()

setPreviousCRefScope

public void setPreviousCRefScope(StaticScope crefScope)

setModule

public void setModule(RubyModule module)

determineModule

public RubyModule determineModule()

Update current scoping structure to populate with proper cref scoping values. This should be called at any point when you reference a scope for the first time. For the interpreter this is done in a small number of places (defnNode, defsNode, and getBlock). The compiler does this in the same places.

Returns:

the current cref, though this is largely an implementation detail

isBlockScope

public boolean isBlockScope()

isArgumentScope

public boolean isArgumentScope()

Argument scopes represent scopes which contain arguments for zsuper. All LocalStaticScopes are argument scopes and BlockStaticScopes can be when they are used by define_method.

makeArgumentScope

public void makeArgumentScope()

getSignature

public Signature getSignature()

For all block or method associated with static scopes this will return the signature for that signature-providing scope. module bodies and other non-arity specific code will return null.

setSignature

public void setSignature(Signature signature)

This happens in when first defining ArgsNodes or when reifying a method from AOT.

getDummyScope

public DynamicScope getDummyScope()

setCommandArgumentStack

public void setCommandArgumentStack(long commandArgumentStack)

getCommandArgumentStack

public long getCommandArgumentStack()

isNamedCapture

public boolean isNamedCapture(int index)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getType

public StaticScope.Type getType()

getFile

public java.lang.String getFile()

duplicate

public StaticScope duplicate()

getOverlayModuleForRead

public RubyModule getOverlayModuleForRead()

getOverlayModuleForWrite

public RubyModule getOverlayModuleForWrite(ThreadContext context)