org.jruby.runtime

Class DynamicScope

java.lang.Object

org.jruby.runtime.DynamicScope

Direct Known Subclasses:

ManyVarsDynamicScope, NoVarsDynamicScope, SharedBindingDynamicScope

public abstract class DynamicScope
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected DynamicScope	parent
protected StaticScope	staticScope

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearEvalType()
abstract DynamicScope	cloneScope()
String[]	getAllNamesInScope() Get all variable names captured (visible) by this scope (sans $~ and $_).
EvalType	getEvalType()
DynamicScope	getFlipScope() Find the scope to use for flip-flops.
DynamicScope	getNextCapturedScope() Deprecated.
DynamicScope	getNthParentScope(int n) Returns the n-th parent scope of this scope.
DynamicScope	getParentScope() Get parent (capturing) scope.
StaticScope	getStaticScope() Get the static scope associated with this DynamicScope.
abstract IRubyObject	getValue(int offset, int depth) Get value from current scope or one of its captured scopes.
abstract IRubyObject	getValueDepthZeroOrNil(int offset, IRubyObject nil) getValueOrNil for depth 0
abstract IRubyObject	getValueOneDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 1, depth 0
abstract IRubyObject	getValueOrNil(int offset, int depth, IRubyObject nil) Variation of getValue that checks for nulls, returning and setting the given value (presumably nil)
abstract IRubyObject[]	getValues()
abstract IRubyObject	getValueThreeDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 3, depth 0
abstract IRubyObject	getValueTwoDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 2, depth 0
abstract IRubyObject	getValueZeroDepthZeroOrNil(IRubyObject nil) getValueOrNil for index 0, depth 0
abstract void	growIfNeeded()
boolean	inBindingEval()
boolean	inInstanceEval()
boolean	inModuleEval()
boolean	isLambda()
static DynamicScope	newDummyScope(StaticScope staticScope, DynamicScope parent)
static DynamicScope	newDynamicScope(StaticScope staticScope)
static DynamicScope	newDynamicScope(StaticScope staticScope, DynamicScope parent)
static DynamicScope	newDynamicScope(StaticScope staticScope, DynamicScope parent, EvalType evalType)
void	setEvalType(EvalType evalType)
void	setLambda(boolean lambda)
abstract IRubyObject	setValue(int offset, IRubyObject value, int depth) Set value in current dynamic scope or one of its captured scopes.
IRubyObject	setValue(IRubyObject value, int offset, int depth) Set value in current dynamic scope or one of its captured scopes.
abstract IRubyObject	setValueDepthZero(IRubyObject value, int offset) setValue for depth zero
void	setValueDepthZeroVoid(IRubyObject value, int offset) setValue for depth zero
abstract IRubyObject	setValueOneDepthZero(IRubyObject value) Set value one in this scope.
void	setValueOneDepthZeroVoid(IRubyObject value) Set value one in this scope.
abstract IRubyObject	setValueThreeDepthZero(IRubyObject value) Set value three in this scope.
void	setValueThreeDepthZeroVoid(IRubyObject value) Set value three in this scope.
abstract IRubyObject	setValueTwoDepthZero(IRubyObject value) Set value two in this scope.
void	setValueTwoDepthZeroVoid(IRubyObject value) Set value two in this scope.
void	setValueVoid(IRubyObject value, int offset, int depth) Set value in current dynamic scope or one of its captured scopes.
abstract IRubyObject	setValueZeroDepthZero(IRubyObject value) Set value zero in this scope;
void	setValueZeroDepthZeroVoid(IRubyObject value) Set value zero in this scope;
String	toString()
String	toString(StringBuffer buf, String indent)

Methods inherited from class java.lang.Object

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

Field Detail

staticScope

protected final StaticScope staticScope

parent

protected final DynamicScope parent

Constructor Detail

DynamicScope

protected DynamicScope(StaticScope staticScope,
                       DynamicScope parent)

DynamicScope

protected DynamicScope(StaticScope staticScope)

Method Detail

newDynamicScope

public static DynamicScope newDynamicScope(StaticScope staticScope,
                                           DynamicScope parent)

newDynamicScope

public static DynamicScope newDynamicScope(StaticScope staticScope,
                                           DynamicScope parent,
                                           EvalType evalType)

newDummyScope

public static DynamicScope newDummyScope(StaticScope staticScope,
                                         DynamicScope parent)

getParentScope

public final DynamicScope getParentScope()

Get parent (capturing) scope. This is used by eval and closures to walk up to hard lexical boundary.

getNextCapturedScope

@Deprecated
public DynamicScope getNextCapturedScope()

Deprecated.

getNthParentScope

public DynamicScope getNthParentScope(int n)

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

Parameters:

n - - number of levels above to look.

Returns:

The n-th parent scope or null.

newDynamicScope

public static DynamicScope newDynamicScope(StaticScope staticScope)

getFlipScope

public DynamicScope getFlipScope()

Find the scope to use for flip-flops. Flip-flops live either in the topmost "method scope" or in their nearest containing "eval scope".

Returns:

The scope to use for flip-flops

getStaticScope

public final StaticScope getStaticScope()

Get the static scope associated with this DynamicScope.

Returns:

static complement to this scope

getAllNamesInScope

public final String[] getAllNamesInScope()

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

Returns:

a list of variable names

growIfNeeded

public abstract void growIfNeeded()

cloneScope

public abstract DynamicScope cloneScope()

getValues

public abstract IRubyObject[] getValues()

getValue

public abstract IRubyObject getValue(int offset,
                                     int depth)

Get value from current scope or one of its captured scopes. FIXME: block variables are not getting primed to nil so we need to null check those until we prime them properly. Also add assert back in.

Parameters:

offset - zero-indexed value that represents where variable lives

depth - how many captured scopes down this variable should be set

Returns:

the value here

getValueOrNil

public abstract IRubyObject getValueOrNil(int offset,
                                          int depth,
                                          IRubyObject nil)

Variation of getValue that checks for nulls, returning and setting the given value (presumably nil)

getValueDepthZeroOrNil

public abstract IRubyObject getValueDepthZeroOrNil(int offset,
                                                   IRubyObject nil)

getValueOrNil for depth 0

getValueZeroDepthZeroOrNil

public abstract IRubyObject getValueZeroDepthZeroOrNil(IRubyObject nil)

getValueOrNil for index 0, depth 0

getValueOneDepthZeroOrNil

public abstract IRubyObject getValueOneDepthZeroOrNil(IRubyObject nil)

getValueOrNil for index 1, depth 0

getValueTwoDepthZeroOrNil

public abstract IRubyObject getValueTwoDepthZeroOrNil(IRubyObject nil)

getValueOrNil for index 2, depth 0

getValueThreeDepthZeroOrNil

public abstract IRubyObject getValueThreeDepthZeroOrNil(IRubyObject nil)

getValueOrNil for index 3, depth 0

setValue

public abstract IRubyObject setValue(int offset,
                                     IRubyObject value,
                                     int depth)

Set value in current dynamic scope or one of its captured scopes.

Parameters:

offset - zero-indexed value that represents where variable lives

value - to set

depth - how many captured scopes down this variable should be set

setValue

public IRubyObject setValue(IRubyObject value,
                            int offset,
                            int depth)

Set value in current dynamic scope or one of its captured scopes.

Parameters:

offset - zero-indexed value that represents where variable lives

value - to set

depth - how many captured scopes down this variable should be set

setValueVoid

public void setValueVoid(IRubyObject value,
                         int offset,
                         int depth)

Set value in current dynamic scope or one of its captured scopes.

Parameters:

offset - zero-indexed value that represents where variable lives

value - to set

depth - how many captured scopes down this variable should be set

setValueDepthZero

public abstract IRubyObject setValueDepthZero(IRubyObject value,
                                              int offset)

setValue for depth zero

Parameters:

value - to set

offset - zero-indexed value that represents where variable lives

setValueDepthZeroVoid

public void setValueDepthZeroVoid(IRubyObject value,
                                  int offset)

setValue for depth zero

Parameters:

value - to set

offset - zero-indexed value that represents where variable lives

setValueZeroDepthZero

public abstract IRubyObject setValueZeroDepthZero(IRubyObject value)

Set value zero in this scope;

setValueZeroDepthZeroVoid

public void setValueZeroDepthZeroVoid(IRubyObject value)

Set value zero in this scope;

setValueOneDepthZero

public abstract IRubyObject setValueOneDepthZero(IRubyObject value)

Set value one in this scope.

setValueOneDepthZeroVoid

public void setValueOneDepthZeroVoid(IRubyObject value)

Set value one in this scope.

setValueTwoDepthZero

public abstract IRubyObject setValueTwoDepthZero(IRubyObject value)

Set value two in this scope.

setValueTwoDepthZeroVoid

public void setValueTwoDepthZeroVoid(IRubyObject value)

Set value two in this scope.

setValueThreeDepthZero

public abstract IRubyObject setValueThreeDepthZero(IRubyObject value)

Set value three in this scope.

setValueThreeDepthZeroVoid

public void setValueThreeDepthZeroVoid(IRubyObject value)

Set value three in this scope.

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(StringBuffer buf,
                       String indent)

inInstanceEval

public boolean inInstanceEval()

inModuleEval

public boolean inModuleEval()

inBindingEval

public boolean inBindingEval()

setEvalType

public void setEvalType(EvalType evalType)

getEvalType

public EvalType getEvalType()

clearEvalType

public void clearEvalType()

setLambda

public void setLambda(boolean lambda)

isLambda

public boolean isLambda()