|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/antlr-2.7.4/antlr/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>TokenBuffer (antlr Javadoc)</title><script src="../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="antlr.TokenBuffer class"/><meta name="keywords" content="input"/><meta name="keywords" content="nMarkers"/><meta name="keywords" content="markerOffset"/><meta name="keywords" content="numToConsume"/><meta name="keywords" content="queue"/><meta name="keywords" content="reset()"/><meta name="keywords" content="consume()"/><meta name="keywords" content="getInput()"/><meta name="keywords" content="LA()"/><meta name="keywords" content="LT()"/><meta name="keywords" content="mark()"/><meta name="keywords" content="rewind()"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="TokenBuffer-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex-1.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../antlr/Token.html">Prev Class</a> | <a href="../antlr/TokenManager.html">Next Class</a></td><td class="navi"><a href="../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="TokenBuffer.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">antlr</h3><h1 class="class title-class">Class TokenBuffer</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code><a href="file:/usr/share/javadoc/java/java/lang/Object.html">java.lang.Object</a></code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>antlr.TokenBuffer</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">TokenBuffer</b></code></div><div class="class synopsis superclass"><code>extends <a href="file:/usr/share/javadoc/java/java/lang/Object.html" title="Class in ">Object</a></code></div></div><hr/><div class="class description">A Stream of Token objects fed to the parser from a Tokenizer that can
be rewound via mark()/rewind() methods.
<p/>
A dynamic array is used to buffer up all the input tokens. Normally,
"k" tokens are stored in the buffer. More tokens may be stored during
guess mode (testing syntactic predicate), or when LT(i>k) is referenced.
Consumption of tokens is deferred. In other words, reading the next
token is not done by conume(), but deferred until needed by LA or LT.
<p/>
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../antlr/Token.html"><code>Token</code></a>, <code>antlr.Tokenizer</code>, <a href="../antlr/TokenQueue.html"><code>TokenQueue</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/TokenStream.html" title="Interface in antlr">TokenStream</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#input">input</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#markerOffset">markerOffset</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#nMarkers">nMarkers</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#numToConsume">numToConsume</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) <a href="../antlr/TokenQueue.html" title="Class in antlr">TokenQueue</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#queue">queue</a></code></dt></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#TokenBuffer(antlr.TokenStream)">TokenBuffer</a>(<a href="../antlr/TokenStream.html" title="Interface in antlr">TokenStream</a> input_)</code></dt><dd class="description">Create a token buffer </dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#LA(int)">LA</a>(int i)</code></dt><dd class="description">Get a lookahead token value </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/Token.html" title="Class in antlr">Token</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#LT(int)">LT</a>(int i)</code></dt><dd class="description">Get a lookahead token </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#consume()">consume</a>()</code></dt><dd class="description">Mark another token for deferred consumption </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/TokenStream.html" title="Interface in antlr">TokenStream</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getInput()">getInput</a>()</code></dt><dd class="description">return the Tokenizer (needed by ParseView) </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#mark()">mark</a>()</code></dt><dd class="description">Return an integer marker that can be used to rewind the buffer to
its current state.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#reset()">reset</a>()</code></dt><dd class="description">Reset the input buffer to empty state </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#rewind(int)">rewind</a>(int mark)</code></dt><dd class="description">Rewind the token buffer to a marker.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="input" id="input"/><div class="member detail outer"><h3 class="member detail name">input</h3><pre class="member detail synopsis">protected <a href="../antlr/TokenStream.html" title="Interface in antlr">TokenStream</a> input</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="markerOffset" id="markerOffset"/><div class="member detail outer"><h3 class="member detail name">markerOffset</h3><pre class="member detail synopsis">(package private) int markerOffset</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="nMarkers" id="nMarkers"/><div class="member detail outer"><h3 class="member detail name">nMarkers</h3><pre class="member detail synopsis">(package private) int nMarkers</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="numToConsume" id="numToConsume"/><div class="member detail outer"><h3 class="member detail name">numToConsume</h3><pre class="member detail synopsis">(package private) int numToConsume</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="queue" id="queue"/><div class="member detail outer"><h3 class="member detail name">queue</h3><pre class="member detail synopsis">(package private) <a href="../antlr/TokenQueue.html" title="Class in antlr">TokenQueue</a> queue</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="TokenBuffer(antlr.TokenStream)" id="TokenBuffer(antlr.TokenStream)"/><div class="member detail outer"><h3 class="member detail name">TokenBuffer</h3><pre class="member detail synopsis">public TokenBuffer(<a href="../antlr/TokenStream.html" title="Interface in antlr">TokenStream</a> input_)</pre><blockquote class="member detail name"><div class="member detail description">Create a token buffer </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="LA(int)" id="LA(int)"/><div class="member detail outer"><h3 class="member detail name">LA</h3><pre class="member detail synopsis">public final int LA(int i)
throws <a href="../antlr/TokenStreamException.html" title="Class in antlr">TokenStreamException</a></pre><blockquote class="member detail name"><div class="member detail description">Get a lookahead token value </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="LT(int)" id="LT(int)"/><div class="member detail outer"><h3 class="member detail name">LT</h3><pre class="member detail synopsis">public final <a href="../antlr/Token.html" title="Class in antlr">Token</a> LT(int i)
throws <a href="../antlr/TokenStreamException.html" title="Class in antlr">TokenStreamException</a></pre><blockquote class="member detail name"><div class="member detail description">Get a lookahead token </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="consume()" id="consume()"/><div class="member detail outer"><h3 class="member detail name">consume</h3><pre class="member detail synopsis">public final void consume()</pre><blockquote class="member detail name"><div class="member detail description">Mark another token for deferred consumption </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getInput()" id="getInput()"/><div class="member detail outer"><h3 class="member detail name">getInput</h3><pre class="member detail synopsis">public <a href="../antlr/TokenStream.html" title="Interface in antlr">TokenStream</a> getInput()</pre><blockquote class="member detail name"><div class="member detail description">return the Tokenizer (needed by ParseView) </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="mark()" id="mark()"/><div class="member detail outer"><h3 class="member detail name">mark</h3><pre class="member detail synopsis">public final int mark()</pre><blockquote class="member detail name"><div class="member detail description">Return an integer marker that can be used to rewind the buffer to
its current state.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="reset()" id="reset()"/><div class="member detail outer"><h3 class="member detail name">reset</h3><pre class="member detail synopsis">public final void reset()</pre><blockquote class="member detail name"><div class="member detail description">Reset the input buffer to empty state </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="rewind(int)" id="rewind(int)"/><div class="member detail outer"><h3 class="member detail name">rewind</h3><pre class="member detail synopsis">public final void rewind(int mark)</pre><blockquote class="member detail name"><div class="member detail description">Rewind the token buffer to a marker.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">mark</code><span class="separator"> - </span><span class="description">Marker returned previously from mark()</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="TokenBuffer-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex-1.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr></table></body></html>