JRuby Base 10.0.0.0 · org.jruby.parser.StaticScope · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static enum	StaticScope.Type

Modifier and Type	Field and Description
private volatile MethodHandle	constructor
private transient RubyModule	cref
private DynamicScope	dummyScope
protected StaticScope	enclosingScope
private String	file
private IRScope	irScope
private boolean	isArgumentScope
private boolean	isBlockOrEval
private volatile Collection<String>	ivarNames
private BitSet	keywordIndices
public static final int	MAX_SPECIALIZED_SIZE
private static final String[]	NO_NAMES
private RubyModule	overlayModule
private StaticScope	previousCRefScope
protected IRScopeType	scopeType
private static final long	serialVersionUID
private Signature	signature
private StaticScope.Type	type
private String[]	variableNames
private int	variableNamesLength

Access	Constructor and Description
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope, String file)
protected	StaticScope(StaticScope.Type the type of scope type, StaticScope the lexically containing scope. enclosingScope) Construct a new static scope.
protected	StaticScope(StaticScope.Type the type of scope type, StaticScope the lexically containing scope. enclosingScope, String[] The list of interned String variable names. names, int firstKeywordIndex) Construct a new static scope.
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope, String file, String[] names, int firstKeywordIndex)
protected	StaticScope(StaticScope.Type type, StaticScope enclosingScope, String[] names)

Method Summary

Modifier and Type	Method and Description
private synchronized MethodHandle	acquireConstructor()
public AssignableNode	addAssign(int line, RubySymbol symbolID, Node value)
public int	Returns: index+depth merged location of scope addVariable(String of new variable name) Add a new variable to this (current) scope unless it is already defined in any reachable scope.
public int	Returns: index of variable addVariableThisScope(String of new variable name) Add a new variable to this (current) scope unless it is already defined in the current scope.
public AssignableNode	assign(int line, RubySymbol name, Node value) Make a DASgn or LocalAsgn node based on scope logic Note: This is private code made public only for parser.
public AssignableNode	assign(int line, RubySymbol symbolID, Node value, StaticScope topScope, int depth)
public AssignableNode	assignKeyword(int line, RubySymbol symbolID, Node value) Register a keyword argument with this staticScope.
public void	captureParentRefinements(ThreadContext context) Duplicate the parent scope's refinements overlay to get a moment-in-time snapshot.
public <T> T	collectVariables(IntFunction<T> collectionFactory, BiConsumer<T, String> collectionPopulator)
public < resulting collection type T> T	Returns: populated collection collectVariables(ThreadContext context, BiFunction<ThreadContext, Integer, T> used to construct the collection collectionFactory, BiConsumer<T, String> used to pass values into the collection collectionPopulator) Populate a deduplicated collection of variable names in scope using the given functions.
public DynamicScope	construct(DynamicScope parent)
public Node	declare(int line, RubySymbol symbolID, int depth)
public Node	Returns: a DVarNode or LocalVarNode Note: This is private code made public only for parser. declare(int the location that in the source that the new node will come from line, RubySymbol of the variable to be created is named symbolID) Make a DVar or LocalVar node based on scoping logic
public RubyModule	Returns: the current cref, though this is largely an implementation detail determineModule() Update current scoping structure to populate with proper cref scoping values.
public StaticScope	duplicate()
public int	Returns: index of variable or -1 if it does not exist exists(String of the variable to find name) Does the variable exist?
private int	findVariableName(String name)
public String[]	Returns: a list of all names (sans $~ and $_ which are special names) getAllNamesInScope() Get all visible variables that we can see from this scope that have been assigned (e.g. seen so far)
public IRubyObject	getConstant(String internedName) Deprecated since 10.0.
public IRubyObject	getConstant(ThreadContext context, String internedName)
public IRubyObject	getConstantDefined(String internedName) Deprecated since 10.0.
public IRubyObject	getConstantDefined(ThreadContext context, String internedName) Gets a constant back from lexical search from the cref in this scope.
public IRubyObject	getConstantDefinedNoObject(String internedName) Deprecated since 10.0.
private IRubyObject	getConstantDefinedNoObject(ThreadContext context, String internedName)
public IRubyObject	getConstantInner(String internedName) Deprecated since 10.0.
private IRubyObject	getConstantInnerNoObject(ThreadContext context, String internedName)
public DynamicScope	getDummyScope()
public StaticScope	Returns: the parent scope getEnclosingScope() Next outer most scope in list of scopes.
public String	getFile()
public int	getFirstKeywordIndex()
public Collection<String>	getInstanceVariableNames()
public IRScope	getIRScope()
public BitSet	getKeywordIndices()
public StaticScope	Returns: localScope getLocalScope() Gets the Local Scope relative to the current Scope.
public RubyArray<T extends IRubyObject>	getLocalVariables(Ruby runtime) Deprecated since 10.0.
public RubyArray<T extends IRubyObject>	Returns: populated RubyArray getLocalVariables(ThreadContext the current context context) Get a Ruby Array of all local variables.
public RubyModule	Returns: the live module getModule() Get the live CRef module associated with this scope.
public int	getNumberOfVariables()
public RubyModule	getOverlayModuleForRead()
public RubyModule	getOverlayModuleForWrite(ThreadContext context)
public StaticScope	getPreviousCRefScope()
public IRubyObject	getScopedConstant(ThreadContext context, String internedName)
public IRScopeType	getScopeType()
public Signature	getSignature() For all block or method associated with static scopes this will return the signature for that signature-providing scope.
public StaticScope.Type	getType()
public String[]	getVariables()
private void	growVariableNames(String name)
public boolean	isArgumentScope() Argument scopes represent scopes which contain arguments for zsuper.
public boolean	isBlockScope()
public int	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 isDefined(String to be looked for name) Is this name in the visible to the current scope
public int	isDefined(String name, int depth)
public boolean	isRuby2Keywords()
public boolean	Returns: true if so isWithinMethod() Determine if we happen to be within a method definition.
public boolean	keywordExists(String name)
public void	makeArgumentScope()
public void	setEnclosingScope(StaticScope parent)
public void	setFile(String file)
public void	setInstanceVariableNames(Collection<String> ivarWrites)
public void	setIRScope(IRScope irScope)
public void	setKeywordIndices(BitSet keywordIndices)
public void	setModule(RubyModule module)
public void	setPreviousCRefScope(StaticScope crefScope)
public void	setScopeType(IRScopeType scopeType)
public void	setSignature(Signature signature) This happens in when first defining ArgsNodes or when reifying a method from AOT.
public void	setVariables(String[] names)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

constructor	back to summary
private volatile MethodHandle constructor

cref	back to summary
private transient RubyModule cref

dummyScope	back to summary
private DynamicScope dummyScope

enclosingScope	back to summary
protected StaticScope enclosingScope

file	back to summary
private String file

irScope	back to summary
private IRScope irScope

isArgumentScope	back to summary
private boolean isArgumentScope

isBlockOrEval	back to summary
private boolean isBlockOrEval

ivarNames	back to summary
private volatile Collection<String> ivarNames

keywordIndices	back to summary
private BitSet keywordIndices

MAX_SPECIALIZED_SIZE	back to summary
public static final int MAX_SPECIALIZED_SIZE

NO_NAMES	back to summary
private static final String[] NO_NAMES

overlayModule	back to summary
private RubyModule overlayModule

previousCRefScope	back to summary
private StaticScope previousCRefScope

scopeType	back to summary
protected IRScopeType scopeType

serialVersionUID	back to summary
private static final long serialVersionUID

signature	back to summary
private Signature signature

type	back to summary
private StaticScope.Type type

variableNames	back to summary
private String[] variableNames

variableNamesLength	back to summary
private int variableNamesLength

StaticScope	back to summary
protected StaticScope(StaticScope.Type type, StaticScope enclosingScope, String file)

StaticScope	back to summary
protected StaticScope(StaticScope.Type type, StaticScope enclosingScope) Construct a new static scope. Parameters type:StaticScope.Type the type of scope enclosingScope:StaticScope the lexically containing scope.

StaticScope	back to summary
protected StaticScope(StaticScope.Type type, StaticScope enclosingScope, 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:StaticScope.Type the type of scope enclosingScope:StaticScope the lexically containing scope. names:String[] The list of interned String variable names.

StaticScope	back to summary
protected StaticScope(StaticScope.Type type, StaticScope enclosingScope, String file, String[] names, int firstKeywordIndex)

StaticScope	back to summary
protected StaticScope(StaticScope.Type type, StaticScope enclosingScope, String[] names)

Method Detail

acquireConstructor	back to summary
private synchronized MethodHandle acquireConstructor()

addAssign	back to summary
public AssignableNode addAssign(int line, RubySymbol symbolID, Node value)

addVariable	back to summary
public int addVariable(String name) Add a new variable to this (current) scope unless it is already defined in any reachable scope. Parameters name:String of new variable Returns:int index+depth merged location of scope

addVariable

back to summary

public int addVariable(String name)

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

Parameters

name:String: of new variable

Returns:int

index+depth merged location of scope

addVariableThisScope	back to summary
public int addVariableThisScope(String name) Add a new variable to this (current) scope unless it is already defined in the current scope. Parameters name:String of new variable Returns:int index of variable

addVariableThisScope

back to summary

public int addVariableThisScope(String name)

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

Parameters

name:String: of new variable

Returns:int

index of variable

assign	back to summary
public AssignableNode assign(int line, RubySymbol name, Node value) Make a DASgn or LocalAsgn node based on scope logic Note: This is private code made public only for parser.

assign	back to summary
public AssignableNode assign(int line, RubySymbol symbolID, Node value, StaticScope topScope, int depth)

assignKeyword	back to summary
public AssignableNode assignKeyword(int line, 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).

captureParentRefinements	back to summary
public void captureParentRefinements(ThreadContext context) Duplicate the parent scope's refinements overlay to get a moment-in-time snapshot. Caller must decide whether this scope is using (or maybe) using refinements.

collectVariables	back to summary
public <T> T collectVariables(IntFunction<T> collectionFactory, BiConsumer<T, String> collectionPopulator)

collectVariables	back to summary
public <T> T collectVariables(ThreadContext context, BiFunction<ThreadContext, Integer, T> collectionFactory, BiConsumer<T, 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. Parameters <T> resulting collection type collectionFactory:BiFunction<ThreadContext, Integer, T> used to construct the collection collectionPopulator:BiConsumer<T, String> used to pass values into the collection Returns:T populated collection

collectVariables

back to summary

public <T> T collectVariables(ThreadContext context, BiFunction<ThreadContext, Integer, T> collectionFactory, BiConsumer<T, 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.

Parameters

<T>: resulting collection type
collectionFactory:BiFunction<ThreadContext, Integer, T>: used to construct the collection
collectionPopulator:BiConsumer<T, String>: used to pass values into the collection

Returns:T

populated collection

construct	back to summary
public DynamicScope construct(DynamicScope parent)

declare	back to summary
public Node declare(int line, RubySymbol symbolID, int depth)

declare	back to summary
public Node declare(int line, RubySymbol symbolID) Make a DVar or LocalVar node based on scoping logic Parameters line:int the location that in the source that the new node will come from symbolID:RubySymbol of the variable to be created is named Returns:Node a DVarNode or LocalVarNode Note: This is private code made public only for parser.

declare

back to summary

public Node declare(int line, RubySymbol symbolID)

Make a DVar or LocalVar node based on scoping logic

Parameters

line:int: the location that in the source that the new node will come from
symbolID:RubySymbol: of the variable to be created is named

Returns:Node

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

determineModule	back to summary
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:RubyModule the current cref, though this is largely an implementation detail

determineModule

back to summary

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:RubyModule: the current cref, though this is largely an implementation detail

duplicate	back to summary
public StaticScope duplicate()

exists	back to summary
public int exists(String name) Does the variable exist? Parameters name:String of the variable to find Returns:int index of variable or -1 if it does not exist

exists

back to summary

public int exists(String name)

Does the variable exist?

Parameters

name:String: of the variable to find

Returns:int

index of variable or -1 if it does not exist

findVariableName	back to summary
private int findVariableName(String name)

getAllNamesInScope	back to summary
public String[] getAllNamesInScope() Get all visible variables that we can see from this scope that have been assigned (e.g. seen so far) Returns:String[] a list of all names (sans $~ and $_ which are special names)

getAllNamesInScope

back to summary

public String[] getAllNamesInScope()

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

Returns:String[]: a list of all names (sans $~ and $_ which are special names)

getConstant	back to summary
public IRubyObject getConstant(String internedName) Deprecated since 10.0. Annotations @Deprecated since:10.0

getConstant	back to summary
public IRubyObject getConstant(ThreadContext context, String internedName)

getConstantDefined	back to summary
public IRubyObject getConstantDefined(String internedName) Deprecated since 10.0. Annotations @Deprecated since:10.0

getConstantDefined	back to summary
public IRubyObject getConstantDefined(ThreadContext context, 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	back to summary
public IRubyObject getConstantDefinedNoObject(String internedName) Deprecated since 10.0. Annotations @Deprecated since:10.0

getConstantDefinedNoObject	back to summary
private IRubyObject getConstantDefinedNoObject(ThreadContext context, String internedName)

getConstantInner	back to summary
public IRubyObject getConstantInner(String internedName) Deprecated since 10.0. Annotations @Deprecated since:10.0

getConstantInnerNoObject	back to summary
private IRubyObject getConstantInnerNoObject(ThreadContext context, String internedName)

getDummyScope	back to summary
public DynamicScope getDummyScope()

getEnclosingScope

back to summary

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:StaticScope: the parent scope

getFile	back to summary
public String getFile()

getFirstKeywordIndex	back to summary
public int getFirstKeywordIndex()

getInstanceVariableNames	back to summary
public Collection<String> getInstanceVariableNames()

getIRScope	back to summary
public IRScope getIRScope()

getKeywordIndices	back to summary
public BitSet getKeywordIndices()

getLocalScope

back to summary

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:StaticScope: localScope

getLocalVariables	back to summary
public RubyArray<T extends IRubyObject> getLocalVariables(Ruby runtime) Deprecated since 10.0. Annotations @Deprecated since:10.0

getLocalVariables

back to summary

public RubyArray<T extends IRubyObject> getLocalVariables(ThreadContext context)

Get a Ruby Array of all local variables.

Parameters

context:ThreadContext: the current context

Returns:RubyArray<T extends IRubyObject>

populated RubyArray

getModule

back to summary

public RubyModule getModule()

Get the live CRef module associated with this scope.

Returns:RubyModule: the live module

getNumberOfVariables	back to summary
public int getNumberOfVariables()

getOverlayModuleForRead	back to summary
public RubyModule getOverlayModuleForRead()

getOverlayModuleForWrite	back to summary
public RubyModule getOverlayModuleForWrite(ThreadContext context)

getPreviousCRefScope	back to summary
public StaticScope getPreviousCRefScope()

getScopedConstant	back to summary
public IRubyObject getScopedConstant(ThreadContext context, String internedName)

getScopeType	back to summary
public IRScopeType getScopeType()

getSignature	back to summary
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.

getType	back to summary
public StaticScope.Type getType()

getVariables	back to summary
public String[] getVariables()

growVariableNames	back to summary
private void growVariableNames(String name)

isArgumentScope	back to summary
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.

isBlockScope	back to summary
public boolean isBlockScope()

isDefined

back to summary

public int isDefined(String name)

Is this name in the visible to the current scope

Parameters

name:String: to be looked for

Returns:int

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

isDefined	back to summary
public int isDefined(String name, int depth)

isRuby2Keywords	back to summary
public boolean isRuby2Keywords()

isWithinMethod

back to summary

public boolean isWithinMethod()

Determine if we happen to be within a method definition.

Returns:boolean: true if so

keywordExists	back to summary
public boolean keywordExists(String name)

makeArgumentScope	back to summary
public void makeArgumentScope()

setEnclosingScope	back to summary
public void setEnclosingScope(StaticScope parent)

setFile	back to summary
public void setFile(String file)

setInstanceVariableNames	back to summary
public void setInstanceVariableNames(Collection<String> ivarWrites)

setIRScope	back to summary
public void setIRScope(IRScope irScope)

setKeywordIndices	back to summary
public void setKeywordIndices(BitSet keywordIndices)

setModule	back to summary
public void setModule(RubyModule module)

setPreviousCRefScope	back to summary
public void setPreviousCRefScope(StaticScope crefScope)

setScopeType	back to summary
public void setScopeType(IRScopeType scopeType)

setSignature	back to summary
public void setSignature(Signature signature) This happens in when first defining ArgsNodes or when reifying a method from AOT.

setVariables	back to summary
public void setVariables(String[] names)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Modifier and Type	Field and Description
public static final StaticScope.Type	BLOCK
public static final StaticScope.Type	EVAL
public static final StaticScope.Type	LOCAL

Modifier and Type	Method and Description
public static StaticScope.Type	fromOrdinal(int value)
public static StaticScope.Type	valueOf(String name)
public static StaticScope.Type[]	values()

public Class StaticScope

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum StaticScope.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail