org.jruby.runtime

Class Block

java.lang.Object

org.jruby.runtime.Block

public final class Block
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Block.Type

Field Summary

Fields

Modifier and Type	Field and Description
private Binding	binding
private BlockBody	body
private Block	escapeBlock What block to use for determining escape; defaults to this
private boolean	escaped Whether this block and any clones of it should be considered "escaped"
static Block	NULL_BLOCK All Block variables should either refer to a real block or this NULL_BLOCK.
private RubyProc	proc The Proc that this block is associated with.
Block.Type	type

Constructor Summary

Constructors

Constructor and Description
Block(BlockBody body)
Block(BlockBody body, Binding binding)

Method Summary

Modifier and Type	Method and Description
Arity	arity() What is the arity of this block?
IRubyObject	call(ThreadContext context)
IRubyObject	call(ThreadContext context, Block block)
IRubyObject	call(ThreadContext context, IRubyObject arg0)
IRubyObject	call(ThreadContext context, IRubyObject[] args)
IRubyObject	call(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	call(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
Block	cloneBlock()
Block	cloneBlockAndFrame()
Block	cloneBlockForEval(IRubyObject self)
boolean	equals(java.lang.Object other)
void	escape()
Binding	getBinding()
BlockBody	getBody()
Frame	getFrame() Gets the frame.
RubyProc	getProcObject() Retrieve the proc object associated with this block
boolean	isEscaped()
boolean	isGiven() Is the current block a real yield'able block instead a null one
void	setProcObject(RubyProc procObject) Set the proc object associated with this block
IRubyObject	yield(ThreadContext context, boolean aValue) Deprecated.
IRubyObject	yield(ThreadContext context, IRubyObject value)
IRubyObject	yield(ThreadContext context, IRubyObject value, boolean aValue) Deprecated.
IRubyObject	yield(ThreadContext context, IRubyObject value, IRubyObject self, RubyModule klass, boolean aValue) Deprecated.
IRubyObject	yieldArray(ThreadContext context, IRubyObject value, IRubyObject self, RubyModule klass)
IRubyObject	yieldNonArray(ThreadContext context, IRubyObject value, IRubyObject self, RubyModule klass)
IRubyObject	yieldSpecific(ThreadContext context)
IRubyObject	yieldSpecific(ThreadContext context, IRubyObject arg0)
IRubyObject	yieldSpecific(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	yieldSpecific(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)

Methods inherited from class java.lang.Object

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

Field Detail

proc

private RubyProc proc

The Proc that this block is associated with. When we reference blocks via variable reference they are converted to Proc objects. We store a reference of the associated Proc object for easy conversion.

type

public Block.Type type

binding

private final Binding binding

body

private final BlockBody body

escaped

private boolean escaped

Whether this block and any clones of it should be considered "escaped"

escapeBlock

private Block escapeBlock

What block to use for determining escape; defaults to this

NULL_BLOCK

public static final Block NULL_BLOCK

All Block variables should either refer to a real block or this NULL_BLOCK.

Constructor Detail

Block

public Block(BlockBody body,
             Binding binding)

Block

public Block(BlockBody body)

Method Detail

call

public IRubyObject call(ThreadContext context,
                        IRubyObject[] args)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject[] args,
                        Block block)

call

public IRubyObject call(ThreadContext context)

call

public IRubyObject call(ThreadContext context,
                        Block block)

yieldSpecific

public IRubyObject yieldSpecific(ThreadContext context)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject arg0)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject arg0,
                        Block block)

yieldSpecific

public IRubyObject yieldSpecific(ThreadContext context,
                                 IRubyObject arg0)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        Block block)

yieldSpecific

public IRubyObject yieldSpecific(ThreadContext context,
                                 IRubyObject arg0,
                                 IRubyObject arg1)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        IRubyObject arg2)

call

public IRubyObject call(ThreadContext context,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        IRubyObject arg2,
                        Block block)

yieldSpecific

public IRubyObject yieldSpecific(ThreadContext context,
                                 IRubyObject arg0,
                                 IRubyObject arg1,
                                 IRubyObject arg2)

yield

public IRubyObject yield(ThreadContext context,
                         IRubyObject value)

yield

@Deprecated
public IRubyObject yield(ThreadContext context,
                                     IRubyObject value,
                                     IRubyObject self,
                                     RubyModule klass,
                                     boolean aValue)

Deprecated.

yieldNonArray

public IRubyObject yieldNonArray(ThreadContext context,
                                 IRubyObject value,
                                 IRubyObject self,
                                 RubyModule klass)

yieldArray

public IRubyObject yieldArray(ThreadContext context,
                              IRubyObject value,
                              IRubyObject self,
                              RubyModule klass)

yield

@Deprecated
public IRubyObject yield(ThreadContext context,
                                     IRubyObject value,
                                     boolean aValue)

Deprecated.

yield

@Deprecated
public IRubyObject yield(ThreadContext context,
                                     boolean aValue)

Deprecated.

cloneBlock

public Block cloneBlock()

cloneBlockAndFrame

public Block cloneBlockAndFrame()

cloneBlockForEval

public Block cloneBlockForEval(IRubyObject self)

arity

public Arity arity()

What is the arity of this block?

Returns:

the arity

getProcObject

public RubyProc getProcObject()

Retrieve the proc object associated with this block

Returns:

the proc or null if this has no proc associated with it

setProcObject

public void setProcObject(RubyProc procObject)

Set the proc object associated with this block

Parameters:

procObject -

isGiven

public final boolean isGiven()

Is the current block a real yield'able block instead a null one

Returns:

true if this is a valid block or false otherwise

getBinding

public Binding getBinding()

getBody

public BlockBody getBody()

getFrame

public Frame getFrame()

Gets the frame.

Returns:

Returns a RubyFrame

isEscaped

public boolean isEscaped()

escape

public void escape()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object