org.jruby.ast

Class ArgsNode

java.lang.Object

org.jruby.ast.Node

org.jruby.ast.ArgsNode

All Implemented Interfaces:

ISourcePositionHolder

Direct Known Subclasses:

ArgsNoArgNode, ArgsPreOneArgNode, ArgsPreTwoArgNode

public class ArgsNode
extends Node

Represents the argument declarations of a method. The fields: foo(p1, ..., pn, o1 = v1, ..., on = v2, *r, q1, ..., qn) p1...pn = pre arguments o1...on = optional arguments r = rest argument q1...qn = post arguments (only in 1.9)

Field Summary

Fields

Modifier and Type	Field and Description
protected Arity	arity
private BlockArgNode	blockArgNode
protected boolean	hasKwargs
protected boolean	hasMasgnArgs
protected boolean	hasOptArgs
protected boolean	isSimple
private KeywordRestArgNode	keyRest
private ListNode	keywords
protected int	maxArgsCount
private ListNode	optArgs
private ListNode	post
private int	postCount
private int	postIndex
private ListNode	pre
private int	preCount
private int	requiredArgsCount
protected int	restArg
protected ArgumentNode	restArgNode

Fields inherited from class org.jruby.ast.Node

EMPTY_LIST

Constructor Summary

Constructors

Constructor and Description
ArgsNode(ISourcePosition position, ListNode pre, ListNode optionalArguments, RestArgNode rest, ListNode post, BlockArgNode blockArgNode) Construct a new ArgsNode with no keyword arguments.
ArgsNode(ISourcePosition position, ListNode pre, ListNode optionalArguments, RestArgNode rest, ListNode post, ListNode keywords, KeywordRestArgNode keyRest, BlockArgNode blockArgNode) Construct a new ArgsNode with keyword arguments.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	accept(NodeVisitor iVisitor) Accept for the visitor pattern.
protected void	assignKwargs(RubyHash keyValues, Ruby runtime, ThreadContext context, DynamicScope scope, IRubyObject self)
protected int	assignOptArgs(IRubyObject[] args, Ruby runtime, ThreadContext context, IRubyObject self, int givenArgsCount, int arglen)
protected Arity	calculateArity()
void	checkArgCount(Ruby runtime, int argsLength)
void	checkArgCount(Ruby runtime, java.lang.String name, int argsLength)
java.util.List<Node>	childNodes()
ListNode	getArgs() Deprecated.
Arity	getArity()
BlockArgNode	getBlock() Gets the explicit block argument of the parameter list (&block).
BlockArgNode	getBlockArgNode() Deprecated.
KeywordRestArgNode	getKeyRest()
ListNode	getKeywords()
private RubyHash	getKeywordValues(IRubyObject[] args)
int	getMaxArgumentsCount()
NodeType	getNodeType()
ListNode	getOptArgs() Gets the optArgs.
int	getOptionalArgsCount()
ListNode	getPost()
int	getPostCount()
private int	getPostCount(int preCount, int optArgCount, RestArgNode rest)
int	getPostIndex()
ListNode	getPre() Gets the required arguments at the beginning of the argument definition
int	getPreCount()
int	getRequiredArgsCount()
int	getRestArg() Gets the restArg.
ArgumentNode	getRestArgNode() Gets the restArgNode.
protected boolean	hasMasgnArgs()
private void	masgnAwareArgAssign(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject[] args, Block block, DynamicScope scope)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject[] args, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, IRubyObject arg4, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, IRubyObject arg4, IRubyObject arg5, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, IRubyObject arg4, IRubyObject arg5, IRubyObject arg6, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, IRubyObject arg4, IRubyObject arg5, IRubyObject arg6, IRubyObject arg7, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, IRubyObject arg4, IRubyObject arg5, IRubyObject arg6, IRubyObject arg7, IRubyObject arg8, Block block)
void	prepare(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, IRubyObject arg4, IRubyObject arg5, IRubyObject arg6, IRubyObject arg7, IRubyObject arg8, IRubyObject arg9, Block block)
protected int	prepareOptionalArguments(ThreadContext context, Ruby runtime, IRubyObject self, IRubyObject[] args, int arglen)
protected void	prepareOptOrRestArgs(ThreadContext context, Ruby runtime, DynamicScope scope, IRubyObject self, IRubyObject[] args, RubyHash kwvals)
protected void	prepareRestArg(ThreadContext context, Ruby runtime, DynamicScope scope, IRubyObject[] args, int arglen, int givenArgsCount)
protected void	processBlockArg(DynamicScope scope, Ruby runtime, Block block)

Methods inherited from class org.jruby.ast.Node

assign, createList, createList, createList, createList, definition, getNodeName, getPosition, interpret, isNil, setPosition, toString

Methods inherited from class java.lang.Object

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

Field Detail

pre

private final ListNode pre

preCount

private final int preCount

optArgs

private final ListNode optArgs

restArgNode

protected final ArgumentNode restArgNode

restArg

protected final int restArg

blockArgNode

private final BlockArgNode blockArgNode

arity

protected Arity arity

requiredArgsCount

private final int requiredArgsCount

hasOptArgs

protected final boolean hasOptArgs

hasMasgnArgs

protected final boolean hasMasgnArgs

hasKwargs

protected final boolean hasKwargs

maxArgsCount

protected int maxArgsCount

isSimple

protected final boolean isSimple

post

private final ListNode post

postCount

private final int postCount

postIndex

private final int postIndex

keywords

private final ListNode keywords

keyRest

private final KeywordRestArgNode keyRest

Constructor Detail

ArgsNode

public ArgsNode(ISourcePosition position,
                ListNode pre,
                ListNode optionalArguments,
                RestArgNode rest,
                ListNode post,
                BlockArgNode blockArgNode)

Construct a new ArgsNode with no keyword arguments.

Parameters:

position -

pre -

optionalArguments -

rest -

post -

blockArgNode -

ArgsNode

public ArgsNode(ISourcePosition position,
                ListNode pre,
                ListNode optionalArguments,
                RestArgNode rest,
                ListNode post,
                ListNode keywords,
                KeywordRestArgNode keyRest,
                BlockArgNode blockArgNode)

Construct a new ArgsNode with keyword arguments.

Parameters:

position -

pre -

optionalArguments -

rest -

post -

keywords -

keyRest -

blockArgNode -

Method Detail

getPostCount

private int getPostCount(int preCount,
                         int optArgCount,
                         RestArgNode rest)

getNodeType

public NodeType getNodeType()

Specified by:

getNodeType in class Node

Returns:

the nodeId

calculateArity

protected Arity calculateArity()

hasMasgnArgs

protected boolean hasMasgnArgs()

accept

public java.lang.Object accept(NodeVisitor iVisitor)

Accept for the visitor pattern.

Specified by:

accept in class Node

Parameters:

iVisitor - the visitor

getPre

public ListNode getPre()

Gets the required arguments at the beginning of the argument definition

getArgs

@Deprecated
public ListNode getArgs()

Deprecated.

getArity

public Arity getArity()

getRequiredArgsCount

public int getRequiredArgsCount()

getOptionalArgsCount

public int getOptionalArgsCount()

getPost

public ListNode getPost()

getMaxArgumentsCount

public int getMaxArgumentsCount()

getOptArgs

public ListNode getOptArgs()

Gets the optArgs.

Returns:

Returns a ListNode

getRestArg

public int getRestArg()

Gets the restArg.

Returns:

Returns a int

getRestArgNode

public ArgumentNode getRestArgNode()

Gets the restArgNode.

Returns:

Returns an ArgumentNode

getBlockArgNode

@Deprecated
public BlockArgNode getBlockArgNode()

Deprecated.

getBlock

public BlockArgNode getBlock()

Gets the explicit block argument of the parameter list (&block).

Returns:

Returns a BlockArgNode

getPostCount

public int getPostCount()

getPostIndex

public int getPostIndex()

getPreCount

public int getPreCount()

getKeywords

public ListNode getKeywords()

getKeyRest

public KeywordRestArgNode getKeyRest()

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject[] args,
                    Block block)

getKeywordValues

private RubyHash getKeywordValues(IRubyObject[] args)

masgnAwareArgAssign

private void masgnAwareArgAssign(ThreadContext context,
                                 Ruby runtime,
                                 IRubyObject self,
                                 IRubyObject[] args,
                                 Block block,
                                 DynamicScope scope)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    IRubyObject arg4,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    IRubyObject arg4,
                    IRubyObject arg5,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    IRubyObject arg4,
                    IRubyObject arg5,
                    IRubyObject arg6,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    IRubyObject arg4,
                    IRubyObject arg5,
                    IRubyObject arg6,
                    IRubyObject arg7,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    IRubyObject arg4,
                    IRubyObject arg5,
                    IRubyObject arg6,
                    IRubyObject arg7,
                    IRubyObject arg8,
                    Block block)

prepare

public void prepare(ThreadContext context,
                    Ruby runtime,
                    IRubyObject self,
                    IRubyObject arg0,
                    IRubyObject arg1,
                    IRubyObject arg2,
                    IRubyObject arg3,
                    IRubyObject arg4,
                    IRubyObject arg5,
                    IRubyObject arg6,
                    IRubyObject arg7,
                    IRubyObject arg8,
                    IRubyObject arg9,
                    Block block)

checkArgCount

public void checkArgCount(Ruby runtime,
                          int argsLength)

checkArgCount

public void checkArgCount(Ruby runtime,
                          java.lang.String name,
                          int argsLength)

prepareOptOrRestArgs

protected void prepareOptOrRestArgs(ThreadContext context,
                                    Ruby runtime,
                                    DynamicScope scope,
                                    IRubyObject self,
                                    IRubyObject[] args,
                                    RubyHash kwvals)

prepareOptionalArguments

protected int prepareOptionalArguments(ThreadContext context,
                                       Ruby runtime,
                                       IRubyObject self,
                                       IRubyObject[] args,
                                       int arglen)

prepareRestArg

protected void prepareRestArg(ThreadContext context,
                              Ruby runtime,
                              DynamicScope scope,
                              IRubyObject[] args,
                              int arglen,
                              int givenArgsCount)

assignOptArgs

protected int assignOptArgs(IRubyObject[] args,
                            Ruby runtime,
                            ThreadContext context,
                            IRubyObject self,
                            int givenArgsCount,
                            int arglen)

assignKwargs

protected void assignKwargs(RubyHash keyValues,
                            Ruby runtime,
                            ThreadContext context,
                            DynamicScope scope,
                            IRubyObject self)

processBlockArg

protected void processBlockArg(DynamicScope scope,
                               Ruby runtime,
                               Block block)

childNodes

public java.util.List<Node> childNodes()

Specified by:

childNodes in class Node