<!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+: CharInputBuffer 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> </div>
<div class="headertitle">
<h1>CharInputBuffer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CharInputBuffer" --><!-- doxytag: inherits="InputBuffer" -->
<p><code>#include <<a class="el" href="CharInputBuffer_8hpp_source.html">CharInputBuffer.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for CharInputBuffer:</div>
<div class="dyncontent">
<div class="center"><img src="classCharInputBuffer__inherit__graph.png" border="0" usemap="#CharInputBuffer_inherit__map" alt="Inheritance graph"/></div>
<map name="CharInputBuffer_inherit__map" id="CharInputBuffer_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CharInputBuffer:</div>
<div class="dyncontent">
<div class="center"><img src="classCharInputBuffer__coll__graph.png" border="0" usemap="#CharInputBuffer_coll__map" alt="Collaboration graph"/></div>
<map name="CharInputBuffer_coll__map" id="CharInputBuffer_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCharInputBuffer-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="classCharInputBuffer.html#aa6070db9b3add23315cb3fc4f48ef1b6">CharInputBuffer</a> (unsigned char *buf, size_t size, bool owner=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#a4ea4ff8761842eb3aee007eca5a6222e">~CharInputBuffer</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#a3d17b07c6261c2fb882c0cc980866424">reset</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#a206ad055f6cf530b5df9a479d8ebbad7">getChar</a> (void)</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">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#a75cdf053465baa7b377bc7f2beaf3c37">buffer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the buffer with data <a href="#a75cdf053465baa7b377bc7f2beaf3c37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#accdb57d0df6b74f4c170b147b26930d9">ptr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">position ptr into the buffer <a href="#accdb57d0df6b74f4c170b147b26930d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#a177023f4b6d9a1fff9bf0a6c82701a64">end</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">end sentry for buffer <a href="#a177023f4b6d9a1fff9bf0a6c82701a64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCharInputBuffer.html#aa3d0f000f526e6738927e9a3a3084406">delete_buffer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">flag signifying if we have to delete the buffer <a href="#aa3d0f000f526e6738927e9a3a3084406"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="CharInputBuffer_8hpp.html">CharInputBuffer.hpp</a> provides an <a class="el" href="classInputBuffer.html">InputBuffer</a> for plain character arrays (buffers). </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa6070db9b3add23315cb3fc4f48ef1b6"></a><!-- doxytag: member="CharInputBuffer::CharInputBuffer" ref="aa6070db9b3add23315cb3fc4f48ef1b6" args="(unsigned char *buf, size_t size, bool owner=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CharInputBuffer::CharInputBuffer </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>owner</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="CharInputBuffer_8hpp.html">CharInputBuffer.hpp</a> object with a char* buffer of 'size' if 'owner' is true, then the buffer will be delete[]-ed on destruction. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>it is assumed the buffer was allocated with new[]! </dd></dl>
</div>
</div>
<a class="anchor" id="a4ea4ff8761842eb3aee007eca5a6222e"></a><!-- doxytag: member="CharInputBuffer::~CharInputBuffer" ref="a4ea4ff8761842eb3aee007eca5a6222e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CharInputBuffer::~CharInputBuffer </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<dl class="note"><dt><b>Note:</b></dt><dd>If you're using malloced data, then you probably need to change this destructor. Or better use this class as template for your own. </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a206ad055f6cf530b5df9a479d8ebbad7"></a><!-- doxytag: member="CharInputBuffer::getChar" ref="a206ad055f6cf530b5df9a479d8ebbad7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CharInputBuffer::getChar </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override this in subclasses to get the next character </p>
<p>Implements <a class="el" href="classInputBuffer.html#a330a5238a409a12116cfe83911bf4750">InputBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="a3d17b07c6261c2fb882c0cc980866424"></a><!-- doxytag: member="CharInputBuffer::reset" ref="a3d17b07c6261c2fb882c0cc980866424" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CharInputBuffer::reset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the <a class="el" href="classCharInputBuffer.html">CharInputBuffer</a> to initial state Called from <a class="el" href="classLexerInputState.html#a90031004476b4038df477a296a58e1d9">LexerInputState::reset</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classLexerInputState.html">LexerInputState</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classInputBuffer.html#a8775d70258996e18e59b5224ee5b3193">InputBuffer</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a75cdf053465baa7b377bc7f2beaf3c37"></a><!-- doxytag: member="CharInputBuffer::buffer" ref="a75cdf053465baa7b377bc7f2beaf3c37" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* <a class="el" href="classCharInputBuffer.html#a75cdf053465baa7b377bc7f2beaf3c37">CharInputBuffer::buffer</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the buffer with data </p>
</div>
</div>
<a class="anchor" id="aa3d0f000f526e6738927e9a3a3084406"></a><!-- doxytag: member="CharInputBuffer::delete_buffer" ref="aa3d0f000f526e6738927e9a3a3084406" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classCharInputBuffer.html#aa3d0f000f526e6738927e9a3a3084406">CharInputBuffer::delete_buffer</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>flag signifying if we have to delete the buffer </p>
</div>
</div>
<a class="anchor" id="a177023f4b6d9a1fff9bf0a6c82701a64"></a><!-- doxytag: member="CharInputBuffer::end" ref="a177023f4b6d9a1fff9bf0a6c82701a64" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* <a class="el" href="classCharInputBuffer.html#a177023f4b6d9a1fff9bf0a6c82701a64">CharInputBuffer::end</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>end sentry for buffer </p>
</div>
</div>
<a class="anchor" id="accdb57d0df6b74f4c170b147b26930d9"></a><!-- doxytag: member="CharInputBuffer::ptr" ref="accdb57d0df6b74f4c170b147b26930d9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* <a class="el" href="classCharInputBuffer.html#accdb57d0df6b74f4c170b147b26930d9">CharInputBuffer::ptr</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>position ptr into the buffer </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>antlr/<a class="el" href="CharInputBuffer_8hpp_source.html">CharInputBuffer.hpp</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>
