java.lang.Object
- org.antlr.runtime.debug.DebugTreeNodeStream

所有已实现的接口:

IntStream, TreeNodeStream
```
public class DebugTreeNodeStream
extends java.lang.Object
implements TreeNodeStream
```
Debug any tree node stream. The constructor accepts the stream and a debug listener. As node stream calls come in, debug events are triggered.

字段概要

字段
修饰符和类型	字段	说明
`protected TreeAdaptor`	`adaptor`
`protected DebugEventListener`	`dbg`
`protected boolean`	`initialStreamState`
`protected TreeNodeStream`	`input`
`protected int`	`lastMarker`	Track the last mark() call result value for use in rewind().

构造器概要

构造器
构造器说明

DebugTreeNodeStream(TreeNodeStream input, DebugEventListener dbg)

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`void`	`consume()`
`java.lang.Object`	`get(int i)`	Get a tree node at an absolute index `i`; 0..n-1.
`java.lang.String`	`getSourceName()`	Where are you getting symbols from? Normally, implementations will pass the buck all the way to the lexer who can ask its input stream for the file name or whatever.
`TokenStream`	`getTokenStream()`	If the tree associated with this stream was created from a `TokenStream`, you can specify it here.
`TreeAdaptor`	`getTreeAdaptor()`	What adaptor can tell me how to interpret/navigate nodes and trees.
`java.lang.Object`	`getTreeSource()`	Where is this stream pulling nodes from? This is not the name, but the object that provides node objects.
`int`	`index()`	Return the current input symbol index 0..n where n indicates the last symbol has been read.
`int`	`LA(int i)`	Get int at current input pointer + i ahead where i=1 is next int.
`java.lang.Object`	`LT(int i)`	Get tree node at current input pointer + `k` ahead where `k==1` is next node.
`int`	`mark()`	Tell the stream to start buffering if it hasn't already.
`void`	`release(int marker)`	You may want to commit to a backtrack but don't want to force the stream to keep bookkeeping objects around for a marker that is no longer necessary.
`void`	`replaceChildren(java.lang.Object parent, int startChildIndex, int stopChildIndex, java.lang.Object t)`	Replace children of `parent` from index `startChildIndex` to `stopChildIndex` with `t`, which might be a list.
`void`	`reset()`	Reset the tree node stream in such a way that it acts like a freshly constructed stream.
`void`	`rewind()`	Rewind to the input position of the last marker.
`void`	`rewind(int marker)`	Reset the stream so that next call to index would return marker.
`void`	`seek(int index)`	Set the input cursor to the position indicated by index.
`void`	`setDebugListener(DebugEventListener dbg)`
`void`	`setUniqueNavigationNodes(boolean uniqueNavigationNodes)`	It is normally this object that instructs the node stream to create unique nav nodes, but to satisfy interface, we have to define it.
`int`	`size()`	Only makes sense for streams that buffer everything up probably, but might be useful to display the entire stream or for testing.
`java.lang.String`	`toString(java.lang.Object start, java.lang.Object stop)`	Return the text of all nodes from `start` to `stop`, inclusive.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - dbg
```
protected DebugEventListener dbg
```
  - adaptor
```
protected TreeAdaptor adaptor
```
  - input
```
protected TreeNodeStream input
```
  - initialStreamState
```
protected boolean initialStreamState
```
  - lastMarker
```
protected int lastMarker
```
    Track the last mark() call result value for use in rewind().
- 构造器详细资料
  - DebugTreeNodeStream
```
public DebugTreeNodeStream(TreeNodeStream input,
                           DebugEventListener dbg)
```
- 方法详细资料
  - setDebugListener
```
public void setDebugListener(DebugEventListener dbg)
```
  - getTreeAdaptor
```
public TreeAdaptor getTreeAdaptor()
```
    从接口复制的说明: TreeNodeStream
    
    What adaptor can tell me how to interpret/navigate nodes and trees. E.g., get text of a node.
    
    指定者:
    
    getTreeAdaptor 在接口中 TreeNodeStream
  - consume
```
public void consume()
```
    指定者:
    
    consume 在接口中 IntStream
  - get
```
public java.lang.Object get(int i)
```
    从接口复制的说明: TreeNodeStream
    
    Get a tree node at an absolute index i; 0..n-1. If you don't want to buffer up nodes, then this method makes no sense for you.
    
    指定者:
    
    get 在接口中 TreeNodeStream
  - LT
```
public java.lang.Object LT(int i)
```
    从接口复制的说明: TreeNodeStream
    
    Get tree node at current input pointer + k ahead where k==1 is next node. k<0 indicates nodes in the past. So LT(-1) is previous node, but implementations are not required to provide results for k < -1. LT(0) is undefined. For k<=n, return null. Return null for LT(0) and any index that results in an absolute address that is negative.
    This is analogous to TokenStream.LT(int), but this returns a tree node instead of a Token. Makes code generation identical for both parser and tree grammars.
    
    指定者:
    
    LT 在接口中 TreeNodeStream
  - LA
```
public int LA(int i)
```
    从接口复制的说明: IntStream
    
    Get int at current input pointer + i ahead where i=1 is next int. Negative indexes are allowed. LA(-1) is previous token (token just matched). LA(-i) where i is before first token should yield -1, invalid char / EOF.
    
    指定者:
    
    LA 在接口中 IntStream
  - mark
```
public int mark()
```
    从接口复制的说明: IntStream
    
    Tell the stream to start buffering if it hasn't already. Return current input position, index(), or some other marker so that when passed to rewind() you get back to the same spot. rewind(mark()) should not affect the input cursor. The Lexer track line/col info as well as input index so its markers are not pure input indexes. Same for tree node streams.
    
    指定者:
    
    mark 在接口中 IntStream
  - index
```
public int index()
```
    从接口复制的说明: IntStream
    
    Return the current input symbol index 0..n where n indicates the last symbol has been read. The index is the symbol about to be read not the most recently read symbol.
    
    指定者:
    
    index 在接口中 IntStream
  - rewind
```
public void rewind(int marker)
```
    从接口复制的说明: IntStream
    
    Reset the stream so that next call to index would return marker. The marker will usually be index() but it doesn't have to be. It's just a marker to indicate what state the stream was in. This is essentially calling release() and seek(). If there are markers created after this marker argument, this routine must unroll them like a stack. Assume the state the stream was in when this marker was created.
    
    指定者:
    
    rewind 在接口中 IntStream
  - rewind
```
public void rewind()
```
    从接口复制的说明: IntStream
    
    Rewind to the input position of the last marker. Used currently only after a cyclic DFA and just before starting a sem/syn predicate to get the input position back to the start of the decision. Do not "pop" the marker off the state. mark(i) and rewind(i) should balance still. It is like invoking rewind(last marker) but it should not "pop" the marker off. It's like seek(last marker's input position).
    
    指定者:
    
    rewind 在接口中 IntStream
  - release
```
public void release(int marker)
```
    从接口复制的说明: IntStream
    
    You may want to commit to a backtrack but don't want to force the stream to keep bookkeeping objects around for a marker that is no longer necessary. This will have the same behavior as rewind() except it releases resources without the backward seek. This must throw away resources for all markers back to the marker argument. So if you're nested 5 levels of mark(), and then release(2) you have to release resources for depths 2..5.
    
    指定者:
    
    release 在接口中 IntStream
  - seek
```
public void seek(int index)
```
    从接口复制的说明: IntStream
    
    Set the input cursor to the position indicated by index. This is normally used to seek ahead in the input stream. No buffering is required to do this unless you know your stream will use seek to move backwards such as when backtracking. This is different from rewind in its multi-directional requirement and in that its argument is strictly an input cursor (index). For char streams, seeking forward must update the stream state such as line number. For seeking backwards, you will be presumably backtracking using the mark/rewind mechanism that restores state and so this method does not need to update state when seeking backwards. Currently, this method is only used for efficient backtracking using memoization, but in the future it may be used for incremental parsing. The index is 0..n-1. A seek to position i means that LA(1) will return the ith symbol. So, seeking to 0 means LA(1) will return the first element in the stream.
    
    指定者:
    
    seek 在接口中 IntStream
  - size
```
public int size()
```
    从接口复制的说明: IntStream
    
    Only makes sense for streams that buffer everything up probably, but might be useful to display the entire stream or for testing. This value includes a single EOF.
    
    指定者:
    
    size 在接口中 IntStream
  - reset
```
public void reset()
```
    从接口复制的说明: TreeNodeStream
    
    Reset the tree node stream in such a way that it acts like a freshly constructed stream.
    
    指定者:
    
    reset 在接口中 TreeNodeStream
  - getTreeSource
```
public java.lang.Object getTreeSource()
```
    从接口复制的说明: TreeNodeStream
    
    Where is this stream pulling nodes from? This is not the name, but the object that provides node objects.
    
    指定者:
    
    getTreeSource 在接口中 TreeNodeStream
  - getSourceName
```
public java.lang.String getSourceName()
```
    从接口复制的说明: IntStream
    
    Where are you getting symbols from? Normally, implementations will pass the buck all the way to the lexer who can ask its input stream for the file name or whatever.
    
    指定者:
    
    getSourceName 在接口中 IntStream
  - getTokenStream
```
public TokenStream getTokenStream()
```
    从接口复制的说明: TreeNodeStream
    
    If the tree associated with this stream was created from a TokenStream, you can specify it here. Used to do rule $text attribute in tree parser. Optional unless you use tree parser rule $text attribute or output=template and rewrite=true options.
    
    指定者:
    
    getTokenStream 在接口中 TreeNodeStream
  - setUniqueNavigationNodes
```
public void setUniqueNavigationNodes(boolean uniqueNavigationNodes)
```
    It is normally this object that instructs the node stream to create unique nav nodes, but to satisfy interface, we have to define it. It might be better to ignore the parameter but there might be a use for it later, so I'll leave.
    
    指定者:
    
    setUniqueNavigationNodes 在接口中 TreeNodeStream
  - replaceChildren
```
public void replaceChildren(java.lang.Object parent,
                            int startChildIndex,
                            int stopChildIndex,
                            java.lang.Object t)
```
    从接口复制的说明: TreeNodeStream
    
    Replace children of parent from index startChildIndex to stopChildIndex with t, which might be a list. Number of children may be different after this call. The stream is notified because it is walking the tree and might need to know you are monkeying with the underlying tree. Also, it might be able to modify the node stream to avoid restreaming for future phases.
    If parent is null, don't do anything; must be at root of overall tree. Can't replace whatever points to the parent externally. Do nothing.
    
    指定者:
    
    replaceChildren 在接口中 TreeNodeStream
  - toString
```
public java.lang.String toString(java.lang.Object start,
                                 java.lang.Object stop)
```
    从接口复制的说明: TreeNodeStream
    
    Return the text of all nodes from start to stop, inclusive. If the stream does not buffer all the nodes then it can still walk recursively from start until stop. You can always return null or "" too, but users should not access $ruleLabel.text in an action of course in that case.
    
    指定者:
    
    toString 在接口中 TreeNodeStream

类 DebugTreeNodeStream

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

dbg

adaptor

input

initialStreamState

lastMarker

构造器详细资料

DebugTreeNodeStream

方法详细资料

setDebugListener

getTreeAdaptor

consume

get

LT

LA

mark

index

rewind

rewind

release

seek

size

reset

getTreeSource

getSourceName

getTokenStream

setUniqueNavigationNodes

replaceChildren

toString