org.jruby.runtime

Class Binding

java.lang.Object

org.jruby.runtime.Binding

public class Binding
extends java.lang.Object

Internal live representation of a block ({...} or do ... end).

Field Summary

Fields

Modifier and Type	Field and Description
private BacktraceElement	backtrace
private DynamicScope	dummyScope
private DynamicScope	dynamicScope A reference to all variable values (and names) that are in-scope for this block.
private DynamicScope	evalScope Binding-local scope for 1.9 mode.
private Binding	evalScopeBinding Location of eval scope.
private Frame	frame frame of method which defined this block
private RubyModule	klass
private IRubyObject	self 'self' at point when the block is defined
private Visibility	visibility

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Binding(Binding other)
	Binding(Frame frame, RubyModule bindingClass, DynamicScope dynamicScope, BacktraceElement backtrace)
	Binding(IRubyObject self, Frame frame, Visibility visibility, RubyModule klass, DynamicScope dynamicScope, BacktraceElement backtrace)
private	Binding(IRubyObject self, Frame frame, Visibility visibility, RubyModule klass, DynamicScope dynamicScope, BacktraceElement backtrace, DynamicScope dummyScope)

Method Summary

Modifier and Type	Method and Description
Binding	clone() Clone the binding.
Binding	cloneForEval() Clone the binding, but maintain a reference to the original "eval binding" to continue sharing eval context.
boolean	equals(java.lang.Object other)
BacktraceElement	getBacktrace()
DynamicScope	getDummyScope(StaticScope staticScope)
DynamicScope	getDynamicScope() Gets the dynamicVariables that are local to this block.
DynamicScope	getEvalScope(Ruby runtime)
java.lang.String	getFile()
Frame	getFrame() Gets the frame.
RubyModule	getKlass() Gets the klass.
int	getLine()
java.lang.String	getMethod()
IRubyObject	getSelf()
Visibility	getVisibility()
void	setFile(java.lang.String file)
void	setLine(int line)
void	setMethod(java.lang.String method)
void	setSelf(IRubyObject self)
void	setVisibility(Visibility visibility)

Methods inherited from class java.lang.Object

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

Field Detail

frame

private final Frame frame

frame of method which defined this block

backtrace

private final BacktraceElement backtrace

klass

private final RubyModule klass

visibility

private Visibility visibility

self

private IRubyObject self

'self' at point when the block is defined

dynamicScope

private final DynamicScope dynamicScope

A reference to all variable values (and names) that are in-scope for this block.

evalScope

private DynamicScope evalScope

Binding-local scope for 1.9 mode.

evalScopeBinding

private Binding evalScopeBinding

Location of eval scope. Because bindings are usually cloned before used for eval, we indirect the reference of the eval scope through another Binding reference, allowing us to share the same eval scope across multiple Binding instances without the cost of allocating a DynamicScope[1] for each new Binding object.

dummyScope

private DynamicScope dummyScope

Constructor Detail

Binding

public Binding(IRubyObject self,
               Frame frame,
               Visibility visibility,
               RubyModule klass,
               DynamicScope dynamicScope,
               BacktraceElement backtrace)

Binding

private Binding(IRubyObject self,
                Frame frame,
                Visibility visibility,
                RubyModule klass,
                DynamicScope dynamicScope,
                BacktraceElement backtrace,
                DynamicScope dummyScope)

Binding

public Binding(Frame frame,
               RubyModule bindingClass,
               DynamicScope dynamicScope,
               BacktraceElement backtrace)

Binding

private Binding(Binding other)

Method Detail

cloneForEval

public Binding cloneForEval()

Clone the binding, but maintain a reference to the original "eval binding" to continue sharing eval context.

Returns:

a new Binding with shared eval context

clone

public Binding clone()

Clone the binding. The frame will be duplicated, and eval context will point to the new binding, but other fields will be copied as-is.

Overrides:

clone in class java.lang.Object

Returns:

a new cloned Binding

getVisibility

public Visibility getVisibility()

setVisibility

public void setVisibility(Visibility visibility)

getSelf

public IRubyObject getSelf()

setSelf

public void setSelf(IRubyObject self)

getDynamicScope

public DynamicScope getDynamicScope()

Gets the dynamicVariables that are local to this block. Parent dynamic scopes are also accessible via the current dynamic scope.

Returns:

Returns all relevent variable scoping information

getDummyScope

public DynamicScope getDummyScope(StaticScope staticScope)

getFrame

public Frame getFrame()

Gets the frame.

Returns:

Returns a RubyFrame

getKlass

public RubyModule getKlass()

Gets the klass.

Returns:

Returns a RubyModule

getBacktrace

public BacktraceElement getBacktrace()

getFile

public java.lang.String getFile()

setFile

public void setFile(java.lang.String file)

getLine

public int getLine()

setLine

public void setLine(int line)

getMethod

public java.lang.String getMethod()

setMethod

public void setMethod(java.lang.String method)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getEvalScope

public final DynamicScope getEvalScope(Ruby runtime)