ParserSupport (JRuby Core 9.1.10.0 API)

java.lang.Object
- org.jruby.parser.ParserSupport

public class ParserSupport
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected ParserConfiguration`	`configuration`
`protected StaticScope`	`currentScope`
`protected RubyLexer`	`lexer`
`protected IRubyWarnings`	`warnings`

Constructor Summary

Constructors
Constructor and Description

ParserSupport()

Constructors
Constructor and Description
`ParserSupport()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`addRootNode(Node topOfAST)`
`Node`	`appendToBlock(Node head, Node tail)`
`Node`	`arg_add(ISourcePosition position, Node node1, Node node2)`
`Node`	`arg_append(Node node1, Node node2)`
`Node`	`arg_blk_pass(Node firstNode, BlockPassNode secondNode)`
`Node`	`arg_concat(ISourcePosition position, Node node1, Node node2)`
`ArgumentNode`	`arg_var(String name)`
`Node`	`aryset(Node receiver, Node index)` Define an array set condition so we can return lhs
`AssignableNode`	`assignableInCurr(String name, Node value)`
`AssignableNode`	`assignableKeyword(String name, Node value)`
`AssignableNode`	`assignableLabel(String name, Node value)`
`AssignableNode`	`assignableLabelOrIdentifier(String name, Node value)`
`static int`	`associateEncoding(org.jruby.util.ByteList buffer, org.jcodings.Encoding newEncoding, int codeRange)`
`Node`	`asSymbol(ISourcePosition position, Node value)`
`Node`	`asSymbol(ISourcePosition position, String value)`
`Node`	`attrset(Node receiver, String name)` Define an attribute set condition so we can return lhs
`Node`	`attrset(Node receiver, String callType, String name)`
`void`	`backrefAssignError(Node node)`
`boolean`	`checkExpression(Node node)`
`protected void`	`checkRegexpSyntax(org.jruby.util.ByteList value, RegexpOptions options)`
`void`	`checkUselessStatement(Node node)` Check to see if current node is an useless statement.
`void`	`checkUselessStatements(BlockNode blockNode)` Check all nodes but the last one in a BlockNode for useless (void context) statements.
`void`	`compile_error(String message)`
`protected void`	`compileError(org.jcodings.Encoding optionEncoding, org.jcodings.Encoding encoding)`
`DStrNode`	`createDStrNode(ISourcePosition position)`
`KeyValuePair<Node,Node>`	`createKeyValue(Node key, Node value)`
`Node`	`declareIdentifier(String name)`
`void`	`fixpos(Node node, Node orig)`
`String`	`formal_argument(String identifier)`
`void`	`frobnicate_fcall_args(FCallNode fcall, Node args, Node iter)`
`Node`	`getConditionNode(Node node)`
`ParserConfiguration`	`getConfiguration()`
`StaticScope`	`getCurrentScope()`
`int`	`getInSingle()` Getter for property inSingle.
`Node`	`getMatchNode(Node firstNode, Node secondNode)`
`Node`	`getOperatorCallNode(Node firstNode, String operator)`
`Node`	`getOperatorCallNode(Node firstNode, String operator, Node secondNode)`
`Node`	`getOperatorCallNode(Node firstNode, String operator, Node secondNode, ISourcePosition defaultPosition)`
`ISourcePosition`	`getPosition(ISourcePositionHolder start)`
`RubyParserResult`	`getResult()` Gets the result.
`Node`	`gettable2(Node node)` We know for callers of this that it cannot be any of the specials checked in gettable.
`protected void`	`getterIdentifierError(ISourcePosition position, String identifier)`
`void`	`initTopLocalVariables()` Description of the RubyMethod
`String`	`internalId()`
`boolean`	`is_local_id(String name)`
`boolean`	`isBreakStatement(Node node)` Is the supplied node a break/control statement?
`boolean`	`isInDef()`
`boolean`	`isInSingle()` Getter for property inSingle.
`boolean`	`isLazy(String callType)`
`boolean`	`isLiteral(Node node)` Is this a literal in the sense that MRI has a NODE_LIT for.
`KeywordArgNode`	`keyword_arg(ISourcePosition position, AssignableNode assignable)`
`ListNode`	`list_append(Node list, Node item)`
`ListNode`	`list_concat(Node first, Node second)`
`Node`	`literal_concat(ISourcePosition position, Node head, Node tail)`
`protected Node`	`makeNullNil(Node node)`
`ComplexNode`	`negateComplexNode(ComplexNode complexNode)`
`FloatNode`	`negateFloat(FloatNode floatNode)`
`NumericNode`	`negateInteger(NumericNode integerNode)`
`NumericNode`	`negateNumeric(NumericNode node)`
`RationalNode`	`negateRational(RationalNode rationalNode)`
`ArgsTailHolder`	`new_args_tail(ISourcePosition position, ListNode keywordArg, String keywordRestArgName, BlockArgNode blockArg)`
`Node`	`new_args(ISourcePosition position, ListNode pre, ListNode optional, RestArgNode rest, ListNode post, ArgsTailHolder tail)`
`Node`	`new_attrassign(ISourcePosition position, Node receiver, String name, Node args, boolean isLazy)`
`Node`	`new_bv(String identifier)`
`Node`	`new_call(Node receiver, String name, Node argsNode, Node iter)`
`Node`	`new_call(Node receiver, String callType, String name, Node argsNode, Node iter)`
`Colon2Node`	`new_colon2(ISourcePosition position, Node leftNode, String name)`
`Colon3Node`	`new_colon3(ISourcePosition position, String name)`
`Node`	`new_defined(ISourcePosition position, Node something)`
`Node`	`new_fcall(String operation)`
`Node`	`new_opElementAsgnNode(Node receiverNode, String operatorName, Node argsNode, Node valueNode)`
`Node`	`new_super(ISourcePosition position, Node args)`
`Node`	`new_yield(ISourcePosition position, Node node)`
`Node`	`newAlias(ISourcePosition position, Node newNode, Node oldNode)`
`AndNode`	`newAndNode(ISourcePosition position, Node left, Node right)`
`ArrayNode`	`newArrayNode(ISourcePosition position, Node firstNode)`
`CaseNode`	`newCaseNode(ISourcePosition position, Node expression, Node firstWhenNode)` Ok I admit that this is somewhat ugly.
`Node`	`newEvStrNode(ISourcePosition position, Node node)`
`Node`	`newline_node(Node node, ISourcePosition position)` Wraps node with NEWLINE node.
`Node`	`newOpAsgn(ISourcePosition position, Node receiverNode, String callType, Node valueNode, String variableName, String operatorName)`
`Node`	`newOpConstAsgn(ISourcePosition position, Node lhs, String operatorName, Node rhs)`
`OrNode`	`newOrNode(ISourcePosition position, Node left, Node right)`
`Node`	`newRegexpNode(ISourcePosition position, Node contents, RegexpNode end)`
`Node`	`newRescueModNode(Node body, Node rescueBody)`
`SplatNode`	`newSplatNode(ISourcePosition position, Node node)`
`SValueNode`	`newSValueNode(ISourcePosition position, Node node)`
`Node`	`newUndef(ISourcePosition position, Node nameNode)`
`WhenNode`	`newWhenNode(ISourcePosition position, Node expressionNodes, Node bodyNode, Node nextCase)`
`Node`	`node_assign(Node lhs, Node rhs)`
`void`	`popCurrentScope()`
`ISourcePosition`	`position(ISourcePositionHolder one, ISourcePositionHolder two)`
`void`	`pushBlockScope()`
`void`	`pushLocalScope()`
`void`	`regexpFragmentCheck(RegexpNode end, org.jruby.util.ByteList value)`
`Node`	`remove_duplicate_keys(HashNode hash)`
`void`	`reset()`
`Node`	`ret_args(Node node, ISourcePosition position)`
`void`	`setConfiguration(ParserConfiguration configuration)` Sets the configuration.
`void`	`setInDef(boolean inDef)`
`void`	`setInSingle(int inSingle)` Setter for property inSingle.
`void`	`setLexer(RubyLexer lexer)`
`void`	`setRegexpEncoding(RegexpNode end, org.jruby.util.ByteList value)`
`void`	`setResult(RubyParserResult result)` Sets the result.
`void`	`setWarnings(IRubyWarnings warnings)`
`String`	`shadowing_lvar(String name)`
`Node`	`splat_array(Node node)` If node is a splat and it is splatting a literal array then return the literal array.
`void`	`warn(IRubyWarnings.ID id, ISourcePosition position, String message, Object... data)`
`void`	`warning(IRubyWarnings.ID id, ISourcePosition position, String message, Object... data)`
`void`	`warningUnlessEOption(IRubyWarnings.ID id, Node node, String message)`
`void`	`warnUnlessEOption(IRubyWarnings.ID id, Node node, String message)`
`void`	`yyerror(String message)` generate parsing error
`void`	`yyerror(String message, String[] expected, String found)` generate parsing error

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentScope
```
protected StaticScope currentScope
```

lexer
```
protected RubyLexer lexer
```

warnings
```
protected IRubyWarnings warnings
```

configuration

protected ParserConfiguration configuration

Constructor Detail
- ParserSupport
```
public ParserSupport()
```

Method Detail

reset
```
public void reset()
```

getCurrentScope
```
public StaticScope getCurrentScope()
```

getConfiguration

public ParserConfiguration getConfiguration()

popCurrentScope
```
public void popCurrentScope()
```

pushBlockScope
```
public void pushBlockScope()
```

pushLocalScope
```
public void pushLocalScope()
```

arg_concat

public Node arg_concat(ISourcePosition position,
                       Node node1,
                       Node node2)

arg_blk_pass

public Node arg_blk_pass(Node firstNode,
                         BlockPassNode secondNode)

gettable2
```
public Node gettable2(Node node)
```
We know for callers of this that it cannot be any of the specials checked in gettable.

Parameters:

node - to check its variable type

Returns:

an AST node representing this new variable

declareIdentifier

public Node declareIdentifier(String name)

assignableLabelOrIdentifier

public AssignableNode assignableLabelOrIdentifier(String name,
                                                  Node value)

assignableKeyword

public AssignableNode assignableKeyword(String name,
                                        Node value)

assignableLabel

public AssignableNode assignableLabel(String name,
                                      Node value)

getterIdentifierError

protected void getterIdentifierError(ISourcePosition position,
                                     String identifier)

newline_node

public Node newline_node(Node node,
                         ISourcePosition position)

Wraps node with NEWLINE node.

Parameters:: node -

addRootNode

public Node addRootNode(Node topOfAST)

appendToBlock

public Node appendToBlock(Node head,
                          Node tail)

assignableInCurr

public AssignableNode assignableInCurr(String name,
                                       Node value)

getOperatorCallNode

public Node getOperatorCallNode(Node firstNode,
                                String operator)

getOperatorCallNode

public Node getOperatorCallNode(Node firstNode,
                                String operator,
                                Node secondNode)

getOperatorCallNode

public Node getOperatorCallNode(Node firstNode,
                                String operator,
                                Node secondNode,
                                ISourcePosition defaultPosition)

getMatchNode

public Node getMatchNode(Node firstNode,
                         Node secondNode)

aryset
```
public Node aryset(Node receiver,
                   Node index)
```
Define an array set condition so we can return lhs

Parameters:

receiver - array being set

index - node which should evalute to index of array set

Returns:

an AttrAssignNode

attrset
```
public Node attrset(Node receiver,
                    String name)
```
Define an attribute set condition so we can return lhs

Parameters:

receiver - object which contains attribute

name - of the attribute being set

Returns:

an AttrAssignNode

attrset

public Node attrset(Node receiver,
                    String callType,
                    String name)

backrefAssignError

public void backrefAssignError(Node node)

arg_add

public Node arg_add(ISourcePosition position,
                    Node node1,
                    Node node2)

node_assign

public Node node_assign(Node lhs,
                        Node rhs)

ret_args

public Node ret_args(Node node,
                     ISourcePosition position)

isBreakStatement
```
public boolean isBreakStatement(Node node)
```
Is the supplied node a break/control statement?

Parameters:

node - to be checked

Returns:

true if a control node, false otherwise

warnUnlessEOption

public void warnUnlessEOption(IRubyWarnings.ID id,
                              Node node,
                              String message)

warningUnlessEOption

public void warningUnlessEOption(IRubyWarnings.ID id,
                                 Node node,
                                 String message)

checkExpression

public boolean checkExpression(Node node)

isLiteral
```
public boolean isLiteral(Node node)
```
Is this a literal in the sense that MRI has a NODE_LIT for. This is different than ILiteralNode. We should pick a different name since ILiteralNode is something we created which is similar but used for a slightly different condition (can I do singleton things).

Parameters:

node - to be tested

Returns:

true if it is a literal

checkUselessStatement
```
public void checkUselessStatement(Node node)
```
Check to see if current node is an useless statement. If useless a warning if printed.

Parameters:

node - to be checked.

checkUselessStatements
```
public void checkUselessStatements(BlockNode blockNode)
```
Check all nodes but the last one in a BlockNode for useless (void context) statements.

Parameters:

blockNode - to be checked.

makeNullNil

protected Node makeNullNil(Node node)

getConditionNode

public Node getConditionNode(Node node)

newSValueNode

public SValueNode newSValueNode(ISourcePosition position,
                                Node node)

newSplatNode

public SplatNode newSplatNode(ISourcePosition position,
                              Node node)

newArrayNode

public ArrayNode newArrayNode(ISourcePosition position,
                              Node firstNode)

position

public ISourcePosition position(ISourcePositionHolder one,
                                ISourcePositionHolder two)

newAndNode

public AndNode newAndNode(ISourcePosition position,
                          Node left,
                          Node right)

newOrNode

public OrNode newOrNode(ISourcePosition position,
                        Node left,
                        Node right)

newCaseNode
```
public CaseNode newCaseNode(ISourcePosition position,
                            Node expression,
                            Node firstWhenNode)
```
Ok I admit that this is somewhat ugly. We post-process a chain of when nodes and analyze them to re-insert them back into our new CaseNode the way we want. The grammar is being difficult and until I go back into the depths of that this is where things are.

Parameters:

expression - of the case node (e.g. case foo)

firstWhenNode - first when (which could also be the else)

Returns:

a new case node

newWhenNode

public WhenNode newWhenNode(ISourcePosition position,
                            Node expressionNodes,
                            Node bodyNode,
                            Node nextCase)

new_opElementAsgnNode

public Node new_opElementAsgnNode(Node receiverNode,
                                  String operatorName,
                                  Node argsNode,
                                  Node valueNode)

newOpAsgn

public Node newOpAsgn(ISourcePosition position,
                      Node receiverNode,
                      String callType,
                      Node valueNode,
                      String variableName,
                      String operatorName)

newOpConstAsgn

public Node newOpConstAsgn(ISourcePosition position,
                           Node lhs,
                           String operatorName,
                           Node rhs)

isLazy

public boolean isLazy(String callType)

new_attrassign

public Node new_attrassign(ISourcePosition position,
                           Node receiver,
                           String name,
                           Node args,
                           boolean isLazy)

new_call

public Node new_call(Node receiver,
                     String callType,
                     String name,
                     Node argsNode,
                     Node iter)

new_call

public Node new_call(Node receiver,
                     String name,
                     Node argsNode,
                     Node iter)

new_colon2

public Colon2Node new_colon2(ISourcePosition position,
                             Node leftNode,
                             String name)

new_colon3

public Colon3Node new_colon3(ISourcePosition position,
                             String name)

frobnicate_fcall_args

public void frobnicate_fcall_args(FCallNode fcall,
                                  Node args,
                                  Node iter)

fixpos

public void fixpos(Node node,
                   Node orig)

new_fcall

public Node new_fcall(String operation)

new_super

public Node new_super(ISourcePosition position,
                      Node args)

initTopLocalVariables
```
public void initTopLocalVariables()
```
Description of the RubyMethod

isInSingle
```
public boolean isInSingle()
```
Getter for property inSingle.

Returns:

Value of property inSingle.

setInSingle
```
public void setInSingle(int inSingle)
```
Setter for property inSingle.

Parameters:

inSingle - New value of property inSingle.

isInDef
```
public boolean isInDef()
```

setInDef
```
public void setInDef(boolean inDef)
```

getInSingle
```
public int getInSingle()
```
Getter for property inSingle.

Returns:

Value of property inSingle.

getResult
```
public RubyParserResult getResult()
```
Gets the result.

Returns:

Returns a RubyParserResult

setResult
```
public void setResult(RubyParserResult result)
```
Sets the result.

Parameters:

result - The result to set

setConfiguration
```
public void setConfiguration(ParserConfiguration configuration)
```
Sets the configuration.

Parameters:

configuration - The configuration to set

setWarnings

public void setWarnings(IRubyWarnings warnings)

setLexer

public void setLexer(RubyLexer lexer)

createDStrNode

public DStrNode createDStrNode(ISourcePosition position)

createKeyValue

public KeyValuePair<Node,Node> createKeyValue(Node key,
                                              Node value)

asSymbol

public Node asSymbol(ISourcePosition position,
                     String value)

asSymbol

public Node asSymbol(ISourcePosition position,
                     Node value)

literal_concat

public Node literal_concat(ISourcePosition position,
                           Node head,
                           Node tail)

newRescueModNode

public Node newRescueModNode(Node body,
                             Node rescueBody)

newEvStrNode

public Node newEvStrNode(ISourcePosition position,
                         Node node)

new_yield

public Node new_yield(ISourcePosition position,
                      Node node)

negateInteger

public NumericNode negateInteger(NumericNode integerNode)

negateFloat

public FloatNode negateFloat(FloatNode floatNode)

negateComplexNode

public ComplexNode negateComplexNode(ComplexNode complexNode)

negateRational

public RationalNode negateRational(RationalNode rationalNode)

new_args

public Node new_args(ISourcePosition position,
                     ListNode pre,
                     ListNode optional,
                     RestArgNode rest,
                     ListNode post,
                     ArgsTailHolder tail)

new_args_tail

public ArgsTailHolder new_args_tail(ISourcePosition position,
                                    ListNode keywordArg,
                                    String keywordRestArgName,
                                    BlockArgNode blockArg)

remove_duplicate_keys

public Node remove_duplicate_keys(HashNode hash)

newAlias

public Node newAlias(ISourcePosition position,
                     Node newNode,
                     Node oldNode)

newUndef

public Node newUndef(ISourcePosition position,
                     Node nameNode)

yyerror
```
public void yyerror(String message)
```
generate parsing error

yyerror

public void yyerror(String message,
                    String[] expected,
                    String found)

generate parsing error

Parameters:: message - text to be displayed.; expected - list of acceptable tokens, if available.

getPosition

public ISourcePosition getPosition(ISourcePositionHolder start)

warn

public void warn(IRubyWarnings.ID id,
                 ISourcePosition position,
                 String message,
                 Object... data)

warning

public void warning(IRubyWarnings.ID id,
                    ISourcePosition position,
                    String message,
                    Object... data)

is_local_id

public boolean is_local_id(String name)

list_append

public ListNode list_append(Node list,
                            Node item)

new_bv

public Node new_bv(String identifier)

arg_var

public ArgumentNode arg_var(String name)

formal_argument

public String formal_argument(String identifier)

shadowing_lvar

public String shadowing_lvar(String name)

list_concat

public ListNode list_concat(Node first,
                            Node second)

splat_array
```
public Node splat_array(Node node)
```
If node is a splat and it is splatting a literal array then return the literal array. Otherwise return null. This allows grammar to not splat into a Ruby Array if splatting a literal array.

arg_append

public Node arg_append(Node node1,
                       Node node2)

regexpFragmentCheck

public void regexpFragmentCheck(RegexpNode end,
                                org.jruby.util.ByteList value)

compile_error

public void compile_error(String message)

compileError

protected void compileError(org.jcodings.Encoding optionEncoding,
                            org.jcodings.Encoding encoding)

setRegexpEncoding

public void setRegexpEncoding(RegexpNode end,
                              org.jruby.util.ByteList value)

checkRegexpSyntax

protected void checkRegexpSyntax(org.jruby.util.ByteList value,
                                 RegexpOptions options)

newRegexpNode

public Node newRegexpNode(ISourcePosition position,
                          Node contents,
                          RegexpNode end)

associateEncoding

public static int associateEncoding(org.jruby.util.ByteList buffer,
                                    org.jcodings.Encoding newEncoding,
                                    int codeRange)

keyword_arg

public KeywordArgNode keyword_arg(ISourcePosition position,
                                  AssignableNode assignable)

negateNumeric

public NumericNode negateNumeric(NumericNode node)

new_defined

public Node new_defined(ISourcePosition position,
                        Node something)

internalId
```
public String internalId()
```

Class ParserSupport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currentScope

lexer

warnings

configuration

Constructor Detail

ParserSupport

Method Detail

reset

getCurrentScope

getConfiguration

popCurrentScope

pushBlockScope

pushLocalScope

arg_concat

arg_blk_pass

gettable2

declareIdentifier

assignableLabelOrIdentifier

assignableKeyword

assignableLabel

getterIdentifierError

newline_node

addRootNode

appendToBlock

assignableInCurr

getOperatorCallNode

getOperatorCallNode

getOperatorCallNode

getMatchNode

aryset

attrset

attrset

backrefAssignError

arg_add

node_assign

ret_args

isBreakStatement

warnUnlessEOption

warningUnlessEOption

checkExpression

isLiteral

checkUselessStatement

checkUselessStatements

makeNullNil

getConditionNode

newSValueNode

newSplatNode

newArrayNode

position

newAndNode

newOrNode

newCaseNode

newWhenNode

new_opElementAsgnNode

newOpAsgn

newOpConstAsgn

isLazy

new_attrassign

new_call

new_call

new_colon2

new_colon3

frobnicate_fcall_args

fixpos

new_fcall

new_super

initTopLocalVariables

isInSingle

setInSingle

isInDef

setInDef

getInSingle

getResult

setResult