JRuby Base 10.0.0.0 · org.jruby.runtime.DynamicScope

Modifier and Type	Field and Description
private EvalType	evalType
private boolean	lambda
protected final DynamicScope	parent
protected final StaticScope	staticScope

Access	Constructor and Description
protected	DynamicScope(StaticScope staticScope, DynamicScope parent)

Method Summary

Modifier and Type	Method and Description
public void	clearEvalType()
public DynamicScope	cloneScope() Deprecated
public DynamicScope	Returns: a duplicate of this scope with all the current values dupEvalScope() Binding needs to clone its scope with all the current values.
public final String[]	Returns: a list of variable names getAllNamesInScope() Get all variable names captured (visible) by this scope (sans $~ and $_).
public EvalType	getEvalType()
public DynamicScope	getNextCapturedScope() Deprecated
public DynamicScope	Returns: The n-th parent scope or `null`. getNthParentScope(int - number of levels above to look. n) Returns the n-th parent scope of this scope.
public final DynamicScope	getParentScope() Get parent (capturing) scope.
public final StaticScope	Returns: static complement to this scope getStaticScope() Get the static scope associated with this DynamicScope.
public abstract IRubyObject	Returns: the value here getValue(int zero-indexed value that represents where variable lives offset, int how many captured scopes down this variable should be set depth) Get value from current scope or one of its captured scopes.
public IRubyObject	getValueDepthZero(int offset) Variation of getValue for depth 0
public IRubyObject	getValueDepthZeroOrNil(int offset, IRubyObject nil) getValueOrNil for depth 0
public IRubyObject	getValueEightDepthZero() getValue for index 8, depth 0
public IRubyObject	getValueEightDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 8, depth 0
public IRubyObject	getValueFiveDepthZero() getValue for index 5, depth 0
public IRubyObject	getValueFiveDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 5, depth 0
public IRubyObject	getValueFourDepthZero() getValue for index 4, depth 0
public IRubyObject	getValueFourDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 4, depth 0
public IRubyObject	getValueNineDepthZero() getValue for index 9, depth 0
public IRubyObject	getValueNineDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 9, depth 0
public IRubyObject	getValueOneDepthZero() getValue for index 1, depth 0
public IRubyObject	getValueOneDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 1, depth 0
public IRubyObject	getValueOrNil(int offset, int depth, IRubyObject nil) Variation of getValue that checks for nulls, returning and setting the given value (presumably nil)
public IRubyObject[]	getValues()
public IRubyObject	getValueSevenDepthZero() getValue for index 7, depth 0
public IRubyObject	getValueSevenDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 7, depth 0
public IRubyObject	getValueSixDepthZero() getValue for index 6, depth 0
public IRubyObject	getValueSixDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 6, depth 0
public IRubyObject	getValueThreeDepthZero() getValue for index 3, depth 0
public IRubyObject	getValueThreeDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 3, depth 0
public IRubyObject	getValueTwoDepthZero() getValue for index 2, depth 0
public IRubyObject	getValueTwoDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 2, depth 0
public IRubyObject	getValueZeroDepthZero() getValue for index 0, depth 0
public IRubyObject	getValueZeroDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 0, depth 0
public void	growIfNeeded()
public boolean	inBindingEval()
public boolean	inInstanceEval()
public boolean	inModuleEval()
public boolean	isLambda()
public boolean	Returns: true if this scope is the nearest return scope, false otherwise isReturnTarget() A DynamicScope is the target of a non-local return if it is one of the following: * A method scope * A top-level script scope * A block scope that is either marked as the argument scope (define_method) or a lambda
public static DynamicScope	newDummyScope(StaticScope staticScope, DynamicScope parent)
public static DynamicScope	newDynamicScope(StaticScope staticScope, DynamicScope parent)
public static DynamicScope	newDynamicScope(StaticScope staticScope, DynamicScope parent, EvalType evalType)
public static DynamicScope	newDynamicScope(StaticScope staticScope)
public void	setEvalType(EvalType evalType)
public void	setLambda(boolean lambda)
public IRubyObject	setValue(int zero-indexed value that represents where variable lives offset, IRubyObject to set value, int how many captured scopes down this variable should be set depth) Set value in current dynamic scope or one of its captured scopes.
public IRubyObject	setValue(IRubyObject to set value, int zero-indexed value that represents where variable lives offset, int how many captured scopes down this variable should be set depth) Set value in current dynamic scope or one of its captured scopes.
public IRubyObject	setValueDepthZero(IRubyObject to set value, int zero-indexed value that represents where variable lives offset) setValue for depth zero
public void	setValueDepthZeroVoid(IRubyObject to set value, int zero-indexed value that represents where variable lives offset) setValue for depth zero
public void	setValueEightDepthZeroVoid(IRubyObject value) Set value eight in this scope.
public void	setValueFiveDepthZeroVoid(IRubyObject value) Set value five in this scope.
public void	setValueFourDepthZeroVoid(IRubyObject value) Set value four in this scope.
public void	setValueNineDepthZeroVoid(IRubyObject value) Set value nine in this scope.
public IRubyObject	setValueOneDepthZero(IRubyObject value) Set value one in this scope.
public void	setValueOneDepthZeroVoid(IRubyObject value) Set value one in this scope.
public void	setValueSevenDepthZeroVoid(IRubyObject value) Set value seven in this scope.
public void	setValueSixDepthZeroVoid(IRubyObject value) Set value six in this scope.
public IRubyObject	setValueThreeDepthZero(IRubyObject value) Set value three in this scope.
public void	setValueThreeDepthZeroVoid(IRubyObject value) Set value three in this scope.
public IRubyObject	setValueTwoDepthZero(IRubyObject value) Set value two in this scope.
public void	setValueTwoDepthZeroVoid(IRubyObject value) Set value two in this scope.
public abstract void	setValueVoid(IRubyObject to set value, int zero-indexed value that represents where variable lives offset, int how many captured scopes down this variable should be set depth) Set value in current dynamic scope or one of its captured scopes.
public IRubyObject	setValueZeroDepthZero(IRubyObject value) Set value zero in this scope;
public void	setValueZeroDepthZeroVoid(IRubyObject value) Set value zero in this scope;
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toString(StringBuffer buf, String indent)

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

evalType	back to summary
private EvalType evalType

lambda	back to summary
private boolean lambda

parent	back to summary
protected final DynamicScope parent

staticScope	back to summary
protected final StaticScope staticScope

DynamicScope	back to summary
protected DynamicScope(StaticScope staticScope, DynamicScope parent)

Method Detail

clearEvalType	back to summary
public void clearEvalType()

cloneScope	back to summary
public DynamicScope cloneScope() Deprecated Annotations @Deprecated

dupEvalScope	back to summary
public DynamicScope dupEvalScope() Binding needs to clone its scope with all the current values. Returns:DynamicScope a duplicate of this scope with all the current values

dupEvalScope

back to summary

public DynamicScope dupEvalScope()

Binding needs to clone its scope with all the current values.

Returns:DynamicScope: a duplicate of this scope with all the current values

getAllNamesInScope	back to summary
public final String[] getAllNamesInScope() Get all variable names captured (visible) by this scope (sans $~ and $_). Returns:String[] a list of variable names

getAllNamesInScope

back to summary

public final String[] getAllNamesInScope()

Get all variable names captured (visible) by this scope (sans $~ and $_).

Returns:String[]: a list of variable names

getEvalType	back to summary
public EvalType getEvalType()

getNextCapturedScope	back to summary
public DynamicScope getNextCapturedScope() Deprecated Annotations @Deprecated

getNthParentScope back to summary

getNthParentScope	back to summary
public DynamicScope getNthParentScope(int n) Returns the n-th parent scope of this scope. May return `null`. Parameters n:int - number of levels above to look. Returns:DynamicScope The n-th parent scope or `null`.

public DynamicScope getNthParentScope(int n)

Returns the n-th parent scope of this scope. May return null.

Parameters

n:int: - number of levels above to look.

Returns:DynamicScope

The n-th parent scope or null.

getParentScope	back to summary
public final DynamicScope getParentScope() Get parent (capturing) scope. This is used by eval and closures to walk up to hard lexical boundary.

getStaticScope	back to summary
public final StaticScope getStaticScope() Get the static scope associated with this DynamicScope. Returns:StaticScope static complement to this scope

getStaticScope

back to summary

public final StaticScope getStaticScope()

Get the static scope associated with this DynamicScope.

Returns:StaticScope: static complement to this scope

getValue	back to summary
public abstract IRubyObject getValue(int offset, int depth) Get value from current scope or one of its captured scopes. Parameters offset:int zero-indexed value that represents where variable lives depth:int how many captured scopes down this variable should be set Returns:IRubyObject the value here Annotations @JIT

getValue

back to summary

public abstract IRubyObject getValue(int offset, int depth)

Get value from current scope or one of its captured scopes.

Parameters

offset:int: zero-indexed value that represents where variable lives
depth:int: how many captured scopes down this variable should be set

Returns:IRubyObject

the value here

Annotations

@JIT

getValueDepthZero	back to summary
public IRubyObject getValueDepthZero(int offset) Variation of getValue for depth 0 Annotations @JIT

getValueDepthZero

back to summary

public IRubyObject getValueDepthZero(int offset)

Variation of getValue for depth 0

Annotations

@JIT

getValueDepthZeroOrNil	back to summary
public IRubyObject getValueDepthZeroOrNil(int offset, IRubyObject nil) getValueOrNil for depth 0

getValueEightDepthZero	back to summary
public IRubyObject getValueEightDepthZero() getValue for index 8, depth 0 Annotations @JIT

getValueEightDepthZero

back to summary

public IRubyObject getValueEightDepthZero()

getValue for index 8, depth 0

Annotations

@JIT

getValueEightDepthZeroOrNil	back to summary
public IRubyObject getValueEightDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 8, depth 0

getValueFiveDepthZero	back to summary
public IRubyObject getValueFiveDepthZero() getValue for index 5, depth 0 Annotations @JIT

getValueFiveDepthZero

back to summary

public IRubyObject getValueFiveDepthZero()

getValue for index 5, depth 0

Annotations

@JIT

getValueFiveDepthZeroOrNil	back to summary
public IRubyObject getValueFiveDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 5, depth 0

getValueFourDepthZero	back to summary
public IRubyObject getValueFourDepthZero() getValue for index 4, depth 0 Annotations @JIT

getValueFourDepthZero

back to summary

public IRubyObject getValueFourDepthZero()

getValue for index 4, depth 0

Annotations

@JIT

getValueFourDepthZeroOrNil	back to summary
public IRubyObject getValueFourDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 4, depth 0

getValueNineDepthZero	back to summary
public IRubyObject getValueNineDepthZero() getValue for index 9, depth 0 Annotations @JIT

getValueNineDepthZero

back to summary

public IRubyObject getValueNineDepthZero()

getValue for index 9, depth 0

Annotations

@JIT

getValueNineDepthZeroOrNil	back to summary
public IRubyObject getValueNineDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 9, depth 0

getValueOneDepthZero	back to summary
public IRubyObject getValueOneDepthZero() getValue for index 1, depth 0 Annotations @JIT

getValueOneDepthZero

back to summary

public IRubyObject getValueOneDepthZero()

getValue for index 1, depth 0

Annotations

@JIT

getValueOneDepthZeroOrNil	back to summary
public IRubyObject getValueOneDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 1, depth 0

getValueOrNil	back to summary
public IRubyObject getValueOrNil(int offset, int depth, IRubyObject nil) Variation of getValue that checks for nulls, returning and setting the given value (presumably nil)

getValues	back to summary
public IRubyObject[] getValues()

getValueSevenDepthZero	back to summary
public IRubyObject getValueSevenDepthZero() getValue for index 7, depth 0 Annotations @JIT

getValueSevenDepthZero

back to summary

public IRubyObject getValueSevenDepthZero()

getValue for index 7, depth 0

Annotations

@JIT

getValueSevenDepthZeroOrNil	back to summary
public IRubyObject getValueSevenDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 7, depth 0

getValueSixDepthZero	back to summary
public IRubyObject getValueSixDepthZero() getValue for index 6, depth 0 Annotations @JIT

getValueSixDepthZero

back to summary

public IRubyObject getValueSixDepthZero()

getValue for index 6, depth 0

Annotations

@JIT

getValueSixDepthZeroOrNil	back to summary
public IRubyObject getValueSixDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 6, depth 0

getValueThreeDepthZero	back to summary
public IRubyObject getValueThreeDepthZero() getValue for index 3, depth 0 Annotations @JIT

getValueThreeDepthZero

back to summary

public IRubyObject getValueThreeDepthZero()

getValue for index 3, depth 0

Annotations

@JIT

getValueThreeDepthZeroOrNil	back to summary
public IRubyObject getValueThreeDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 3, depth 0

getValueTwoDepthZero	back to summary
public IRubyObject getValueTwoDepthZero() getValue for index 2, depth 0 Annotations @JIT

getValueTwoDepthZero

back to summary

public IRubyObject getValueTwoDepthZero()

getValue for index 2, depth 0

Annotations

@JIT

getValueTwoDepthZeroOrNil	back to summary
public IRubyObject getValueTwoDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 2, depth 0

getValueZeroDepthZero	back to summary
public IRubyObject getValueZeroDepthZero() getValue for index 0, depth 0 Annotations @JIT

getValueZeroDepthZero

back to summary

public IRubyObject getValueZeroDepthZero()

getValue for index 0, depth 0

Annotations

@JIT

getValueZeroDepthZeroOrNil	back to summary
public IRubyObject getValueZeroDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 0, depth 0

growIfNeeded	back to summary
public void growIfNeeded()

inBindingEval	back to summary
public boolean inBindingEval()

inInstanceEval	back to summary
public boolean inInstanceEval()

inModuleEval	back to summary
public boolean inModuleEval()

isLambda	back to summary
public boolean isLambda()

isReturnTarget	back to summary
public boolean isReturnTarget() A DynamicScope is the target of a non-local return if it is one of the following: * A method scope * A top-level script scope * A block scope that is either marked as the argument scope (define_method) or a lambda Returns:boolean true if this scope is the nearest return scope, false otherwise

isReturnTarget

back to summary

public boolean isReturnTarget()

A DynamicScope is the target of a non-local return if it is one of the following: * A method scope * A top-level script scope * A block scope that is either marked as the argument scope (define_method) or a lambda