Package org.jruby.runtime

Class Block

java.lang.Object

org.jruby.runtime.Block

All Implemented Interfaces:

BiFunction<ThreadContext,IRubyObject,IRubyObject>, Function<ThreadContext,IRubyObject>, FunctionOneOrTwoOrThree<ThreadContext,IRubyObject,IRubyObject,IRubyObject>, TriFunction<ThreadContext,IRubyObject,IRubyObject,IRubyObject>

public class Block
extends Object
implements FunctionOneOrTwoOrThree<ThreadContext,IRubyObject,IRubyObject,IRubyObject>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Block.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final Binding	binding
private final BlockBody	body
private final 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"
private final EvalType	evalType
static final 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.
final Block.Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
	Block(BlockBody body)
	Block(BlockBody body, Binding binding)
	Block(BlockBody body, Binding binding, Block.Type type)
private	Block(BlockBody body, Binding binding, Block.Type type, Block escapeBlock, EvalType evalType)

Method Summary

Modifier and Type	Method	Description
DynamicScope	allocScope(DynamicScope parentScope)
IRubyObject	apply(ThreadContext context)
IRubyObject	apply(ThreadContext context, IRubyObject arg0)
IRubyObject	apply(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
Arity	arity()	Deprecated.
IRubyObject	call(ThreadContext context)
IRubyObject	call(ThreadContext context, Block blockArg)
IRubyObject	call(ThreadContext context, IRubyObject arg0)
IRubyObject	call(ThreadContext context, IRubyObject[] args)
IRubyObject	call(ThreadContext context, IRubyObject[] args, Block blockArg)
IRubyObject	call(ThreadContext context, IRubyObject arg0, Block blockArg)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block blockArg)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block blockArg)
Block	cloneBlock()
Block	cloneBlockAndBinding()
Block	cloneBlockAndBinding(EvalType evalType)
Block	cloneBlockAndFrame()
Block	cloneBlockAndFrame(EvalType evalType)
Block	cloneBlockAsType(Block.Type newType)
Block	cloneBlockForEval(IRubyObject self, EvalType evalType)
Block	deepCloneBlockForEval(IRubyObject self, EvalType evalType)
boolean	equals(Object other)
void	escape()
Binding	getBinding()
BlockBody	getBody()
EvalType	getEvalType()
Frame	getFrame()	Gets the frame.
RubyProc	getProcObject()	Retrieve the proc object associated with this block
Signature	getSignature()
Visibility	getVisibility()
int	hashCode()
boolean	isEscaped()
final boolean	isGiven()	Is the current block a real yield'able block instead a null one
private static IRubyObject[]	maybeSpreadArgs(ThreadContext context, IRubyObject[] args, Block block)
void	setProcObject(RubyProc procObject)	Set the proc object associated with this block
void	setVisibility(Visibility vis)
IRubyObject	yield(ThreadContext context, IRubyObject value)
IRubyObject	yieldArray(ThreadContext context, IRubyObject value, IRubyObject self)
IRubyObject	yieldNonArray(ThreadContext context, IRubyObject value, IRubyObject self)
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)
IRubyObject	yieldValues(ThreadContext context, IRubyObject[] args)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

compose

Methods inherited from interface org.jruby.util.func.FunctionOneOrTwoOrThree

andThen

Field Details

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 final 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 final Block escapeBlock

What block to use for determining escape; defaults to this

evalType

private final EvalType evalType

NULL_BLOCK

public static final Block NULL_BLOCK

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

Constructor Details

Block

private Block(BlockBody body,
 Binding binding,
 Block.Type type,
 Block escapeBlock,
 EvalType evalType)

Block

public Block(BlockBody body,
 Binding binding,
 Block.Type type)

Block

public Block(BlockBody body,
 Binding binding)

Block

public Block(BlockBody body)

Method Details

allocScope

public DynamicScope allocScope(DynamicScope parentScope)

getEvalType

public EvalType getEvalType()

call

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

call

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

call

public IRubyObject call(ThreadContext context)

call

public IRubyObject call(ThreadContext context,
 Block blockArg)

yieldSpecific

public IRubyObject yieldSpecific(ThreadContext context)

call

public IRubyObject call(ThreadContext context,
 IRubyObject arg0)

call

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

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 blockArg)

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 blockArg)

yieldSpecific

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

yield

public IRubyObject yield(ThreadContext context,
 IRubyObject value)

apply

public IRubyObject apply(ThreadContext context)

Specified by:

apply in interface Function<ThreadContext,IRubyObject>

See Also:

• Function.apply(Object)

apply

public IRubyObject apply(ThreadContext context,
 IRubyObject arg0)

Specified by:

apply in interface BiFunction<ThreadContext,IRubyObject,IRubyObject>

See Also:

• BiFunction.apply(Object, Object)

apply

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

Specified by:

apply in interface TriFunction<ThreadContext,IRubyObject,IRubyObject,IRubyObject>

See Also:

• TriFunction.apply(Object, Object, Object)

maybeSpreadArgs

private static IRubyObject[] maybeSpreadArgs(ThreadContext context,
 IRubyObject[] args,
 Block block)

yieldNonArray

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

yieldArray

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

yieldValues

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

cloneBlock

public Block cloneBlock()

cloneBlockAsType

public Block cloneBlockAsType(Block.Type newType)

cloneBlockAndBinding

public Block cloneBlockAndBinding()

cloneBlockAndBinding

public Block cloneBlockAndBinding(EvalType evalType)

cloneBlockAndFrame

public Block cloneBlockAndFrame()

cloneBlockAndFrame

public Block cloneBlockAndFrame(EvalType evalType)

cloneBlockForEval

public Block cloneBlockForEval(IRubyObject self,
 EvalType evalType)

deepCloneBlockForEval

public Block deepCloneBlockForEval(IRubyObject self,
 EvalType evalType)

arity

@Deprecated
public Arity arity()

Deprecated.

What is the arity of this block?

Returns:

the arity

getSignature

public Signature getSignature()

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()

getVisibility

public Visibility getVisibility()

setVisibility

public void setVisibility(Visibility vis)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object