<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ANTLR Support Libraries 2.7.1+: CharBuffer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ANTLR Support Libraries 2.7.1+</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-methods">Private Member Functions</a> </div>
<div class="headertitle">
<h1>CharBuffer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CharBuffer" --><!-- doxytag: inherits="InputBuffer" -->
<p><code>#include <<a class="el" href="CharBuffer_8hpp_source.html">CharBuffer.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for CharBuffer:</div>
<div class="dyncontent">
<div class="center"><img src="classCharBuffer__inherit__graph.png" border="0" usemap="#CharBuffer_inherit__map" alt="Inheritance graph"/></div>
<map name="CharBuffer_inherit__map" id="CharBuffer_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CharBuffer:</div>
<div class="dyncontent">
<div class="center"><img src="classCharBuffer__coll__graph.png" border="0" usemap="#CharBuffer_coll__map" alt="Collaboration graph"/></div>
<map name="CharBuffer_coll__map" id="CharBuffer_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCharBuffer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharBuffer.html#ab23de20b765dd95d23ed666edb5d99ee">CharBuffer</a> (std::istream &<a class="el" href="classCharBuffer.html#a291e1383986e8dc153e761c2a6314e37">input</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a character buffer. <a href="#ab23de20b765dd95d23ed666edb5d99ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharBuffer.html#a3038857d07b5646052a20c5e3895ffb2">getChar</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next character from the stream. <a href="#a3038857d07b5646052a20c5e3895ffb2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharBuffer.html#a291e1383986e8dc153e761c2a6314e37">input</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharBuffer.html#a6400b5792878bf1680eaa8ef642065e5">CharBuffer</a> (const <a class="el" href="classCharBuffer.html">CharBuffer</a> &other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCharBuffer.html">CharBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharBuffer.html#ad75c35b0f447b5ffd0f0c4fd8532264c">operator=</a> (const <a class="el" href="classCharBuffer.html">CharBuffer</a> &other)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A Stream of characters fed to the lexer from a InputStream that can be rewound via <a class="el" href="classInputBuffer.html#ad09c1b83e1e54db4d650215d576e8305">mark()</a>/rewind() methods. </p>
<p>A dynamic array is used to buffer up all the input characters. Normally, "k" characters are stored in the buffer. More characters may be stored during guess mode (testing syntactic predicate), or when LT(i>k) is referenced. Consumption of characters is deferred. In other words, reading the next character is not done by <a class="el" href="classInputBuffer.html#a7fc02531cd092b4be5db785129357c90">consume()</a>, but deferred until needed by LA or LT. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>antlr.CharQueue </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab23de20b765dd95d23ed666edb5d99ee"></a><!-- doxytag: member="CharBuffer::CharBuffer" ref="ab23de20b765dd95d23ed666edb5d99ee" args="(std::istream &input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CharBuffer::CharBuffer </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>input_</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a character buffer. </p>
<p>Create a character buffer. Enable fail and bad exceptions, if supported by platform. </p>
</div>
</div>
<a class="anchor" id="a6400b5792878bf1680eaa8ef642065e5"></a><!-- doxytag: member="CharBuffer::CharBuffer" ref="a6400b5792878bf1680eaa8ef642065e5" args="(const CharBuffer &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CharBuffer::CharBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCharBuffer.html">CharBuffer</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3038857d07b5646052a20c5e3895ffb2"></a><!-- doxytag: member="CharBuffer::getChar" ref="a3038857d07b5646052a20c5e3895ffb2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CharBuffer::getChar </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next character from the stream. </p>
<p>Get the next character from the stream. May throw <a class="el" href="classCharStreamIOException.html">CharStreamIOException</a> when something bad happens (not EOF) (if supported by platform). </p>
<p>Implements <a class="el" href="classInputBuffer.html#a330a5238a409a12116cfe83911bf4750">InputBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="ad75c35b0f447b5ffd0f0c4fd8532264c"></a><!-- doxytag: member="CharBuffer::operator=" ref="ad75c35b0f447b5ffd0f0c4fd8532264c" args="(const CharBuffer &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCharBuffer.html">CharBuffer</a>& CharBuffer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCharBuffer.html">CharBuffer</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a291e1383986e8dc153e761c2a6314e37"></a><!-- doxytag: member="CharBuffer::input" ref="a291e1383986e8dc153e761c2a6314e37" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std ::istream& <a class="el" href="classCharBuffer.html#a291e1383986e8dc153e761c2a6314e37">CharBuffer::input</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>antlr/<a class="el" href="CharBuffer_8hpp_source.html">CharBuffer.hpp</a></li>
<li>src/<a class="el" href="CharBuffer_8cpp.html">CharBuffer.cpp</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Mar 25 2011 for ANTLR Support Libraries 2.7.1+ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
