org.antlr.runtime.tree
Class RewriteRuleSubtreeStream

java.lang.Object
  org.antlr.runtime.tree.RewriteRuleElementStream
      org.antlr.runtime.tree.RewriteRuleSubtreeStream

public class RewriteRuleSubtreeStream
extends RewriteRuleElementStream

Field Summary

Fields inherited from class org.antlr.runtime.tree.RewriteRuleElementStream

adaptor, cursor, elementDescription, elements, singleElement

Constructor Summary

RewriteRuleSubtreeStream(TreeAdaptor adaptor, java.lang.String elementDescription)

RewriteRuleSubtreeStream(TreeAdaptor adaptor, java.lang.String elementDescription, java.util.List elements)
Create a stream, but feed off an existing list

RewriteRuleSubtreeStream(TreeAdaptor adaptor, java.lang.String elementDescription, java.lang.Object oneElement)
Create a stream with one element

Method Summary

protected java.lang.Object	dup(java.lang.Object el) When constructing trees, sometimes we need to dup a token or AST subtree.
java.lang.Object	nextNode() Treat next element as a single node even if it's a subtree.

Methods inherited from class org.antlr.runtime.tree.RewriteRuleElementStream

_next, add, getDescription, hasNext, next, reset, size, toTree

Methods inherited from class java.lang.Object

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

Constructor Detail

RewriteRuleSubtreeStream

public RewriteRuleSubtreeStream(TreeAdaptor adaptor,
                                java.lang.String elementDescription)

RewriteRuleSubtreeStream

public RewriteRuleSubtreeStream(TreeAdaptor adaptor,
                                java.lang.String elementDescription,
                                java.lang.Object oneElement)

Create a stream with one element

RewriteRuleSubtreeStream

public RewriteRuleSubtreeStream(TreeAdaptor adaptor,
                                java.lang.String elementDescription,
                                java.util.List elements)

Create a stream, but feed off an existing list

Method Detail

nextNode

public java.lang.Object nextNode()

Treat next element as a single node even if it's a subtree. This is used instead of next() when the result has to be a tree root node. Also prevents us from duplicating recently-added children; e.g., ^(type ID)+ adds ID to type and then 2nd iteration must dup the type node, but ID has been added. Referencing a rule result twice is ok; dup entire tree as we can't be adding trees; e.g., expr expr.

dup

protected java.lang.Object dup(java.lang.Object el)

Description copied from class: RewriteRuleElementStream

When constructing trees, sometimes we need to dup a token or AST subtree. Dup'ing a token means just creating another AST node around it. For trees, you must call the adaptor.dupTree().

Specified by:

dup in class RewriteRuleElementStream