<!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>ANTLR3C: include/antlr3input.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<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">ANTLR3C <span id="projectnumber">3.1.2</span></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="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('antlr3input_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>antlr3input.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Defines the basic structures used to manipulate character streams from any input source.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3string_8h.html">antlr3string.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3commontoken_8h.html">antlr3commontoken.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3intstream_8h.html">antlr3intstream.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3input.h:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h__incl.png" border="0" usemap="#include_2antlr3input_8h" alt=""/></div>
<map name="include_2antlr3input_8h" id="include_2antlr3input_8h">
<area shape="rect" id="node3" href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime." alt="" coords="439,304,580,331"/><area shape="rect" id="node16" href="antlr3string_8h.html" title="Simple string interface allows indiscriminate allocation of strings such that they can be allocated a..." alt="" coords="452,80,615,107"/><area shape="rect" id="node26" href="antlr3commontoken_8h.html" title="Defines the interface for a common token." alt="" coords="672,155,883,181"/><area shape="rect" id="node29" href="antlr3intstream_8h.html" title="Defines the the class interface for an antlr3 INTSTREAM." alt="" coords="689,80,881,107"/><area shape="rect" id="node5" href="antlr3errors_8h.html" title="antlr3errors.h" alt="" coords="5,379,168,405"/><area shape="rect" id="node11" href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes." alt="" coords="493,379,696,405"/><area shape="rect" id="node13" href="antlr3convertutf_8h.html" title="antlr3convertutf.h" alt="" coords="720,379,923,405"/><area shape="rect" id="node19" href="antlr3collections_8h.html" title="antlr3collections.h" alt="" coords="437,155,648,181"/><area shape="rect" id="node22" href="antlr3bitset_8h.html" title="Defines the basic structures of an ANTLR3 bitset." alt="" coords="488,229,651,256"/></map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h__dep__incl.png" border="0" usemap="#include_2antlr3input_8hdep" alt=""/></div>
<map name="include_2antlr3input_8hdep" id="include_2antlr3input_8hdep">
<area shape="rect" id="node3" href="antlr3_8h.html" title="include/antlr3.h" alt="" coords="1021,304,1203,331"/><area shape="rect" id="node5" href="antlr3baserecognizer_8h.html" title="Defines the basic structure to support recognizing by either a lexer, parser, or tree parser..." alt="" coords="777,155,1100,181"/><area shape="rect" id="node11" href="antlr3lexer_8h.html" title="Base interface for any ANTLR3 lexer." alt="" coords="1272,229,1504,256"/><area shape="rect" id="node26" href="antlr3tokenstream_8h.html" title="Defines the interface for an ANTLR3 common token stream." alt="" coords="1243,80,1533,107"/><area shape="rect" id="node8" href="antlr3cyclicdfa_8h.html" title="include/antlr3cyclicdfa.h" alt="" coords="976,229,1248,256"/><area shape="rect" id="node15" href="antlr3parser_8h.html" title="Base implementation of an ANTLR3 parser." alt="" coords="312,229,555,256"/><area shape="rect" id="node19" href="antlr3rewritestreams_8h.html" title="include/antlr3rewritestreams.h" alt="" coords="579,229,901,256"/><area shape="rect" id="node22" href="antlr3treeparser_8h.html" title="include/antlr3treeparser.h" alt="" coords="5,229,288,256"/></map>
</div>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">ANTLR3_INPUT_STREAM_struct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Master context structure for an ANTLR3 C runtime based input stream. <a href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___l_e_x___s_t_a_t_e__struct.html">ANTLR3_LEX_STATE_struct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure for track lex input states as part of <a class="el" href="antlr3commontreenodestream_8c.html#a0ddd24ffd4326d1375a3314e6a5040a1" title="Mark the state of the input stream so that we can come back to it after a syntactic predicate and so ...">mark()</a> and rewind() of lexer. <a href="struct_a_n_t_l_r3___l_e_x___s_t_a_t_e__struct.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">ANTLR3_INPUT_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apistructures.html#ga4dfd330c592f520117952ec2a101e022">ANTLR3_INPUT_STREAM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Master context structure for an ANTLR3 C runtime based input stream. <a href="group__apistructures.html#ga4dfd330c592f520117952ec2a101e022"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_a_n_t_l_r3___l_e_x___s_t_a_t_e__struct.html">ANTLR3_LEX_STATE_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3input_8h.html#a42cdabc9f37ef790073c5e6ff5650a8e">ANTLR3_LEX_STATE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure for track lex input states as part of <a class="el" href="antlr3commontreenodestream_8c.html#a0ddd24ffd4326d1375a3314e6a5040a1" title="Mark the state of the input stream so that we can come back to it after a syntactic predicate and so ...">mark()</a> and rewind() of lexer. <a href="#a42cdabc9f37ef790073c5e6ff5650a8e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3input_8h.html#a7c16415f2169b8602521bf04503b1baa">antlr3AsciiSetupStream</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">pANTLR3_INPUT_STREAM</a> input, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Common function to setup function interface for an 8 bit ASCII input stream. <a href="#a7c16415f2169b8602521bf04503b1baa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3input_8h.html#a21447ea48a486c62b30dbec7bac4520d">antlr3GenericSetupStream</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">pANTLR3_INPUT_STREAM</a> input, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">pANTLR3_INPUT_STREAM</a> input, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Common function to setup function interface for a 16 bit "UCS2" input stream. <a href="#a020ca344ffee44774c9d4c4a5308ebee"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines the basic structures used to manipulate character streams from any input source. </p>
<p>The first implementation of this stream was ASCII 8 bit, but any character size and encoding can in theory be used, so long as they can return a 32 bit Integer representation of their characters amd efficiently mark and revert to specific offsets into their input streams. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a42cdabc9f37ef790073c5e6ff5650a8e"></a><!-- doxytag: member="antlr3input.h::ANTLR3_LEX_STATE" ref="a42cdabc9f37ef790073c5e6ff5650a8e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_a_n_t_l_r3___l_e_x___s_t_a_t_e__struct.html">ANTLR3_LEX_STATE_struct</a>
<a class="el" href="struct_a_n_t_l_r3___l_e_x___s_t_a_t_e__struct.html">ANTLR3_LEX_STATE</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Structure for track lex input states as part of <a class="el" href="antlr3commontreenodestream_8c.html#a0ddd24ffd4326d1375a3314e6a5040a1" title="Mark the state of the input stream so that we can come back to it after a syntactic predicate and so ...">mark()</a> and rewind() of lexer. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7c16415f2169b8602521bf04503b1baa"></a><!-- doxytag: member="antlr3input.h::antlr3AsciiSetupStream" ref="a7c16415f2169b8602521bf04503b1baa" args="(pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void antlr3AsciiSetupStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">pANTLR3_INPUT_STREAM</a> </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Common function to setup function interface for an 8 bit ASCII input stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>Input stream context pointer</td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>Many of the 8 bit ASCII oriented file stream handling functions will be usable by any or at least some other input streams. Therefore it is perfectly acceptable to call this function to install the ASCII handler then override just those functions that would not work for the particular input encoding, such as consume for instance. </li>
</ul>
</dd></dl>
<p>References <a class="el" href="antlr3inputstream_8c.html#a21447ea48a486c62b30dbec7bac4520d">antlr3GenericSetupStream()</a>, <a class="el" href="antlr3string_8c.html#a093d8f8ffc08b56bb751974a0b27d9b6">antlr3StringFactoryNew()</a>, and <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ad3de400db5b8a382e5f1973ac5db70c0">ANTLR3_INPUT_STREAM_struct::strFactory</a>.</p>
<p>Referenced by <a class="el" href="antlr3defs_8h.html#a449abcf6642288f35bacc3aae39c0ff6">antlr3AsciiFileStreamNew()</a>, <a class="el" href="antlr3defs_8h.html#a6d21ea1bbd612d00207e772fb7f050dc">antlr3NewAsciiStringCopyStream()</a>, and <a class="el" href="antlr3defs_8h.html#ade853f2bfd99e96ee0cd9f1cca97427a">antlr3NewAsciiStringInPlaceStream()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_cgraph.png" border="0" usemap="#antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_cgraph" alt=""/></div>
<map name="antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_cgraph" id="antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_cgraph">
<area shape="rect" id="node3" href="antlr3inputstream_8c.html#a21447ea48a486c62b30dbec7bac4520d" title="antlr3GenericSetupStream" alt="" coords="297,563,559,589"/><area shape="rect" id="node77" href="antlr3string_8c.html#a093d8f8ffc08b56bb751974a0b27d9b6" title="antlr3StringFactoryNew" alt="" coords="307,1272,549,1299"/><area shape="rect" id="node5" href="antlr3inputstream_8c.html#a04b17af4657eba6575a81e11553a9ac2" title="Consume the next character in an 8 bit ASCII input stream." alt="" coords="648,411,851,437"/><area shape="rect" id="node7" href="antlr3inputstream_8c.html#a88f441835477f47ece67fd43d91902d0" title="Return the current offset in to the current line in the input stream." alt="" coords="608,461,891,488"/><area shape="rect" id="node9" href="antlr3inputstream_8c.html#a020b2a4c7892d5aeff8cc46fa477db0e" title="Return the line number as understood by the 8 bit/ASCII input stream." alt="" coords="648,512,851,539"/><area shape="rect" id="node11" href="antlr3inputstream_8c.html#a80dc7dff66516aba7c5cba1cc41a7621" title="Return a pointer into the input stream that points at the start of the current input line as triggere..." alt="" coords="633,563,865,589"/><area shape="rect" id="node13" href="antlr3inputstream_8c.html#ad90161c1a0f0c00ab2a41a2ccdd47126" title="antlr3AsciiGetSourceName" alt="" coords="619,613,880,640"/><area shape="rect" id="node15" href="antlr3inputstream_8c.html#ad9cc281bdf5a5db4d2d637665735fd4b" title="Calculate the current index in the output stream." alt="" coords="659,664,840,691"/><area shape="rect" id="node17" href="antlr3inputstream_8c.html#a6f265b941d90fc60f1fc7b0ffac52133" title="Return the input element assuming an 8 bit ascii input." alt="" coords="969,233,1121,260"/><area shape="rect" id="node19" href="antlr3inputstream_8c.html#a414ce5c054eb9a018502fe58c8aa0938" title="Return the input element assuming an 8 bit ascii input." alt="" coords="673,715,825,741"/><area shape="rect" id="node21" href="antlr3inputstream_8c.html#aaa06c4ab344d09c0dc34bb7a72a71c90" title="Mark the current input point in an Ascii 8 bit stream such as a file stream, where all the input is a..." alt="" coords="664,765,835,792"/><area shape="rect" id="node23" href="antlr3inputstream_8c.html#a9d8c8cecacc8aab95a6e4916417ea4f2" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="648,816,851,843"/><area shape="rect" id="node25" href="antlr3inputstream_8c.html#a66ed7e1476c1a41d910643ccd36590dd" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="653,917,845,944"/><area shape="rect" id="node27" href="antlr3inputstream_8c.html#a1adb69a6e789ecb1e3525a30f2b93192" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="960,892,1131,919"/><area shape="rect" id="node29" href="antlr3inputstream_8c.html#a864af44a978e75ffa7b80685e370b987" title="Rewind the lexer input to the state specified by the last produced mark." alt="" coords="633,968,865,995"/><area shape="rect" id="node32" href="antlr3inputstream_8c.html#aa8a037b8d5ccd944010885e5425bbd8d" title="Set the current offset in the current line to be a particular setting." alt="" coords="608,1019,891,1045"/><area shape="rect" id="node34" href="antlr3inputstream_8c.html#a37ea26f99429587e51e9d19e09a67339" title="Set the current line number as understood by the input stream." alt="" coords="648,5,851,32"/><area shape="rect" id="node36" href="antlr3inputstream_8c.html#ab186c3ea6ae5f33342d39accea8f0fd5" title="Set the newline trigger character in the input stream to the supplied parameter." alt="" coords="613,56,885,83"/><area shape="rect" id="node38" href="antlr3inputstream_8c.html#a27a86b0651fff2fb5cd5278a7d1bf16d" title="antlr3AsciiSetUcaseLA" alt="" coords="633,107,865,133"/><area shape="rect" id="node43" href="antlr3inputstream_8c.html#a1eeecf25fb6b84324009a2d2017dc4e6" title="Return the size of the current input stream, as an Ascii file which in this case is the total input..." alt="" coords="664,157,835,184"/><area shape="rect" id="node45" href="antlr3inputstream_8c.html#a2db610f2179ac9ec9bd88f46ea708d4b" title="Return a substring of the ASCII (8 bit) input stream in newly allocated memory." alt="" coords="653,208,845,235"/><area shape="rect" id="node47" href="antlr3inputstream_8c.html#a2071f06b671bc50c37c323b9e9f66a8f" title="Close down an input stream and free any memory allocated by it." alt="" coords="659,259,840,285"/><area shape="rect" id="node49" href="antlr3inputstream_8c.html#a6db084bb0d49cec0847c2e31396bb550" title="Reset a re-startable input stream to the start." alt="" coords="659,1069,840,1096"/><area shape="rect" id="node73" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#ga58e4ce6e808a830c69cc73f3db040ae4" title="antlr3IntStreamNew" alt="" coords="648,360,851,387"/><area shape="rect" id="node41" href="antlr3inputstream_8c.html#a24a1b524458e398b1ac96c76b79fd2d1" title="Return the input element assuming an 8 bit ASCII input and always return the UPPER CASE character..." alt="" coords="940,107,1151,133"/><area shape="rect" id="node51" href="antlr3collections_8c.html#a0f20590f5ba34812e48d6cec3e126fd6" title="antlr3VectorNew" alt="" coords="960,1095,1131,1121"/><area shape="rect" id="node53" href="antlr3collections_8c.html#a257bb3a732b0aee54f196ea448944d0b" title="antlr3SetVectorApi" alt="" coords="1200,1095,1403,1121"/><area shape="rect" id="node55" href="antlr3collections_8c.html#ab7bfa6d6ae69bd46b3c155d55a7162a1" title="Add the supplied pointer and freeing function pointer to the list, expanding the vector if needed..." alt="" coords="1467,892,1637,919"/><area shape="rect" id="node57" href="antlr3collections_8c.html#aa6d77074d26182876f7cc5269f39dcaf" title="antlr3VectorClear" alt="" coords="1456,943,1648,969"/><area shape="rect" id="node59" href="antlr3collections_8c.html#a2f2a279a441ad513caf852f3f5387f1e" title="antlr3VectorDel" alt="" coords="1467,993,1637,1020"/><area shape="rect" id="node61" href="antlr3collections_8c.html#acebfdc6cc1b28c406946fa6e72c1f581" title="antlr3VectorFree" alt="" coords="1461,1044,1643,1071"/><area shape="rect" id="node63" href="antlr3collections_8c.html#a62297bdab210e5a852d9c778a48556b8" title="antlr3VectorGet" alt="" coords="1467,1095,1637,1121"/><area shape="rect" id="node65" href="antlr3collections_8c.html#aea45dc661f9abf012538728ab751962b" title="Replace the element at the specified entry point with the supplied entry." alt="" coords="1467,1145,1637,1172"/><area shape="rect" id="node67" href="antlr3collections_8c.html#a080b1c287eb015e890bfb6d5c20be49c" title="antlr3VectorSize" alt="" coords="1461,1196,1643,1223"/><area shape="rect" id="node69" href="antlr3collections_8c.html#ad8d9537615595fcbf0d5c1fecde4b4d9" title="Replace the element at the specified entry point with the supplied entry." alt="" coords="1461,1247,1643,1273"/><area shape="rect" id="node71" href="antlr3collections_8c.html#a2ac98c6e0465a288734e77595a1b9d13" title="Remove the entry from the vector, but do not free any entry, even if it has a free pointer..." alt="" coords="1451,1297,1653,1324"/><area shape="rect" id="node75" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#gab9e98efaa7265d8af43f81feefeb6579" title="freeStream" alt="" coords="984,360,1107,387"/><area shape="rect" id="node80" href="antlr3string_8c.html#a1b413d5a90212a05ac374d0ecff495ef" title="Fascist Capitalist Pig function created to oppress the workers comrade." alt="" coords="679,1475,820,1501"/><area shape="rect" id="node82" href="antlr3string_8c.html#a0a3d4c0f9076e26dbe14693a5946b38e" title="destroy" alt="" coords="704,1171,795,1197"/><area shape="rect" id="node84" href="antlr3string_8c.html#a872d78a174c23de5f24960b95f922aa2" title="Creates a new 8 bit string initialized with the 8 bit characters at the supplied ptr, of pre-determined size." alt="" coords="704,1221,795,1248"/><area shape="rect" id="node90" href="antlr3string_8c.html#aa4bb69b65c9021096ab73b5b0f4d8228" title="newRaw8" alt="" coords="704,1424,795,1451"/><area shape="rect" id="node98" href="antlr3string_8c.html#a3ec2260d58995feecd5f0a19db44287f" title="Creates a new string with enough capacity for size 8 bit characters plus a terminator." alt="" coords="699,1272,800,1299"/><area shape="rect" id="node100" href="antlr3string_8c.html#ac42f6b7f61aaaaeef9364a3b6a2f2846" title="Create a new 8 bit string from the supplied, null terminated, 8 bit string pointer." alt="" coords="704,1323,795,1349"/><area shape="rect" id="node102" href="antlr3string_8c.html#ad2791348557c03f3db05d005ffd12743" title="printable8" alt="" coords="688,1373,811,1400"/><area shape="rect" id="node86" href="antlr3commontreenodestream_8c.html#a7d68f5af32504d0af4c13a4c9d33726d" title="Expensive to compute the size of the whole tree while parsing." alt="" coords="1015,1221,1076,1248"/><area shape="rect" id="node88" href="antlr3commontreenodestream_8c.html#aebb793e586aa9eddebde64b400ba24ba" title="Walk and fill the tree node buffer from the root tree." alt="" coords="1220,1221,1383,1248"/><area shape="rect" id="node92" href="antlr3string_8c.html#ad3b8ca592798fba5c5c8f49412b41cd0" title="stringFree" alt="" coords="984,1399,1107,1425"/><area shape="rect" id="node94" href="antlr3string_8c.html#aa01170a5ff98de91c515b39525546bf8" title="stringInit8" alt="" coords="980,1449,1111,1476"/><area shape="rect" id="node96" href="antlr3string_8c.html#a6efdb3988c91c1625fc1e513dbd2381f" title="addc8" alt="" coords="1265,1449,1337,1476"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_icgraph.png" border="0" usemap="#antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_icgraph" alt=""/></div>
<map name="antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_icgraph" id="antlr3input_8h_a7c16415f2169b8602521bf04503b1baa_icgraph">
<area shape="rect" id="node3" href="antlr3defs_8h.html#a449abcf6642288f35bacc3aae39c0ff6" title="Use the contents of an operating system file as the input for an input stream." alt="" coords="341,5,603,32"/><area shape="rect" id="node5" href="antlr3defs_8h.html#a6d21ea1bbd612d00207e772fb7f050dc" title="Create an ASCII string stream as input to ANTLR 3, copying the input string." alt="" coords="311,56,633,83"/><area shape="rect" id="node7" href="antlr3defs_8h.html#ade853f2bfd99e96ee0cd9f1cca97427a" title="Create an in-place ASCII string stream as input to ANTLR 3." alt="" coords="296,107,648,133"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a21447ea48a486c62b30dbec7bac4520d"></a><!-- doxytag: member="antlr3input.h::antlr3GenericSetupStream" ref="a21447ea48a486c62b30dbec7bac4520d" args="(pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void antlr3GenericSetupStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">pANTLR3_INPUT_STREAM</a> </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#abc96e456bf8fdbb01b869b1ab9e27e5a">ANTLR3_INT_STREAM_struct::_LA</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a20b41f8c004bb0183ed4c7f9bb6502aa">ANTLR3_INPUT_STREAM_struct::_LT</a>, <a class="el" href="antlr3intstream_8h.html#abcbe3506dc98d1789d8113a9c3eff082">ANTLR3_CHARSTREAM</a>, <a class="el" href="antlr3inputstream_8c.html#a04b17af4657eba6575a81e11553a9ac2">antlr3AsciiConsume()</a>, <a class="el" href="antlr3inputstream_8c.html#a88f441835477f47ece67fd43d91902d0">antlr3AsciiGetCharPosition()</a>, <a class="el" href="antlr3inputstream_8c.html#a020b2a4c7892d5aeff8cc46fa477db0e">antlr3AsciiGetLine()</a>, <a class="el" href="antlr3inputstream_8c.html#a80dc7dff66516aba7c5cba1cc41a7621">antlr3AsciiGetLineBuf()</a>, <a class="el" href="antlr3inputstream_8c.html#ad90161c1a0f0c00ab2a41a2ccdd47126">antlr3AsciiGetSourceName()</a>, <a class="el" href="antlr3inputstream_8c.html#ad9cc281bdf5a5db4d2d637665735fd4b">antlr3AsciiIndex()</a>, <a class="el" href="antlr3inputstream_8c.html#a6f265b941d90fc60f1fc7b0ffac52133">antlr3AsciiLA()</a>, <a class="el" href="antlr3inputstream_8c.html#a414ce5c054eb9a018502fe58c8aa0938">antlr3AsciiLT()</a>, <a class="el" href="antlr3inputstream_8c.html#aaa06c4ab344d09c0dc34bb7a72a71c90">antlr3AsciiMark()</a>, <a class="el" href="antlr3inputstream_8c.html#a9d8c8cecacc8aab95a6e4916417ea4f2">antlr3AsciiRelease()</a>, <a class="el" href="antlr3inputstream_8c.html#a66ed7e1476c1a41d910643ccd36590dd">antlr3AsciiRewind()</a>, <a class="el" href="antlr3inputstream_8c.html#a864af44a978e75ffa7b80685e370b987">antlr3AsciiRewindLast()</a>, <a class="el" href="antlr3inputstream_8c.html#a1adb69a6e789ecb1e3525a30f2b93192">antlr3AsciiSeek()</a>, <a class="el" href="antlr3inputstream_8c.html#aa8a037b8d5ccd944010885e5425bbd8d">antlr3AsciiSetCharPosition()</a>, <a class="el" href="antlr3inputstream_8c.html#a37ea26f99429587e51e9d19e09a67339">antlr3AsciiSetLine()</a>, <a class="el" href="antlr3inputstream_8c.html#ab186c3ea6ae5f33342d39accea8f0fd5">antlr3AsciiSetNewLineChar()</a>, <a class="el" href="antlr3inputstream_8c.html#a27a86b0651fff2fb5cd5278a7d1bf16d">antlr3AsciiSetUcaseLA()</a>, <a class="el" href="antlr3inputstream_8c.html#a1eeecf25fb6b84324009a2d2017dc4e6">antlr3AsciiSize()</a>, <a class="el" href="antlr3inputstream_8c.html#a2db610f2179ac9ec9bd88f46ea708d4b">antlr3AsciiSubstr()</a>, <a class="el" href="antlr3inputstream_8c.html#a2071f06b671bc50c37c323b9e9f66a8f">antlr3InputClose()</a>, <a class="el" href="antlr3inputstream_8c.html#a6db084bb0d49cec0847c2e31396bb550">antlr3InputReset()</a>, <a class="el" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#ga58e4ce6e808a830c69cc73f3db040ae4">antlr3IntStreamNew()</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#aaac6c588f4b1817939ff796074ff494b">ANTLR3_INPUT_STREAM_struct::charByteSize</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a1174c85bc9399c19072476c3187eec25">ANTLR3_INPUT_STREAM_struct::close</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a94cc34ff782903d0d2b91595f308062a">ANTLR3_INT_STREAM_struct::consume</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a942654996b465ef576470e0beb0519ab">ANTLR3_INPUT_STREAM_struct::free</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a1a12fe9fd03a2057c1956c5063c8d7b3">ANTLR3_INPUT_STREAM_struct::getCharPositionInLine</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a9bf0bff9acd4e32f08c8f57938d062aa">ANTLR3_INPUT_STREAM_struct::getLine</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ac54c9d30cefd8256ea68d2d044ec4395">ANTLR3_INPUT_STREAM_struct::getLineBuf</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#ad71ca21244172b4a0dc36efa8fbeec53">ANTLR3_INT_STREAM_struct::getSourceName</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a5141407fe8b50ff4e87f617811fd54fc">ANTLR3_INT_STREAM_struct::index</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ac90101686f579652c058d24f5a7bad35">ANTLR3_INPUT_STREAM_struct::istream</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#ad59b7290943c5152aa28377343335983">ANTLR3_INT_STREAM_struct::mark</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a2994637c93652f92a9b8b1d3090f5eb9">ANTLR3_INPUT_STREAM_struct::markers</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#aaf72411c29dcfa48673babf667797ba6">ANTLR3_INT_STREAM_struct::release</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ac4698064b0b32eddb47f954d1c664071">ANTLR3_INPUT_STREAM_struct::reset</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a8fa6f22f95f34f15d7d085fa4bddfcf8">ANTLR3_INT_STREAM_struct::rewind</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a5bd359e0dbc0dd65c226d573776f33b6">ANTLR3_INT_STREAM_struct::rewindLast</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a052f31580e00cb4200a6234dfcca600b">ANTLR3_INT_STREAM_struct::seek</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a8f2a47c8b7ffaea9466ba01a39b35bba">ANTLR3_INPUT_STREAM_struct::setCharPositionInLine</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a29cecb04980a396b5b7a928f53117bd2">ANTLR3_INPUT_STREAM_struct::setLine</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a08d57c74e1b52ad004ea0f7fc93ae76b">ANTLR3_INPUT_STREAM_struct::SetNewLineChar</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a7dfb77fa3d12dd66d9ea9bfe38c890a4">ANTLR3_INPUT_STREAM_struct::setUcaseLA</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a52014f7dacdfa801db4c20a24a08f5b7">ANTLR3_INPUT_STREAM_struct::size</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#aa5328318fdaba5a203bd15a7136b8594">ANTLR3_INPUT_STREAM_struct::substr</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a6f5f3b5448e33c1e083849ca67465d05">ANTLR3_INT_STREAM_struct::super</a>, and <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a43cdca646646b19cb679ca87f45b03f8">ANTLR3_INT_STREAM_struct::type</a>.</p>
<p>Referenced by <a class="el" href="antlr3input_8h.html#a7c16415f2169b8602521bf04503b1baa">antlr3AsciiSetupStream()</a>, and <a class="el" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_cgraph.png" border="0" usemap="#antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_cgraph" alt=""/></div>
<map name="antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_cgraph" id="antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_cgraph">
<area shape="rect" id="node3" href="antlr3inputstream_8c.html#a04b17af4657eba6575a81e11553a9ac2" title="Consume the next character in an 8 bit ASCII input stream." alt="" coords="357,5,560,32"/><area shape="rect" id="node5" href="antlr3inputstream_8c.html#a88f441835477f47ece67fd43d91902d0" title="Return the current offset in to the current line in the input stream." alt="" coords="317,56,600,83"/><area shape="rect" id="node7" href="antlr3inputstream_8c.html#a020b2a4c7892d5aeff8cc46fa477db0e" title="Return the line number as understood by the 8 bit/ASCII input stream." alt="" coords="357,107,560,133"/><area shape="rect" id="node9" href="antlr3inputstream_8c.html#a80dc7dff66516aba7c5cba1cc41a7621" title="Return a pointer into the input stream that points at the start of the current input line as triggere..." alt="" coords="343,157,575,184"/><area shape="rect" id="node11" href="antlr3inputstream_8c.html#ad90161c1a0f0c00ab2a41a2ccdd47126" title="antlr3AsciiGetSourceName" alt="" coords="328,208,589,235"/><area shape="rect" id="node13" href="antlr3inputstream_8c.html#ad9cc281bdf5a5db4d2d637665735fd4b" title="Calculate the current index in the output stream." alt="" coords="368,259,549,285"/><area shape="rect" id="node15" href="antlr3inputstream_8c.html#a6f265b941d90fc60f1fc7b0ffac52133" title="Return the input element assuming an 8 bit ascii input." alt="" coords="679,613,831,640"/><area shape="rect" id="node17" href="antlr3inputstream_8c.html#a414ce5c054eb9a018502fe58c8aa0938" title="Return the input element assuming an 8 bit ascii input." alt="" coords="383,360,535,387"/><area shape="rect" id="node19" href="antlr3inputstream_8c.html#aaa06c4ab344d09c0dc34bb7a72a71c90" title="Mark the current input point in an Ascii 8 bit stream such as a file stream, where all the input is a..." alt="" coords="373,411,544,437"/><area shape="rect" id="node21" href="antlr3inputstream_8c.html#a9d8c8cecacc8aab95a6e4916417ea4f2" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="357,461,560,488"/><area shape="rect" id="node23" href="antlr3inputstream_8c.html#a66ed7e1476c1a41d910643ccd36590dd" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="363,309,555,336"/><area shape="rect" id="node25" href="antlr3inputstream_8c.html#a1adb69a6e789ecb1e3525a30f2b93192" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="669,461,840,488"/><area shape="rect" id="node27" href="antlr3inputstream_8c.html#a864af44a978e75ffa7b80685e370b987" title="Rewind the lexer input to the state specified by the last produced mark." alt="" coords="343,613,575,640"/><area shape="rect" id="node30" href="antlr3inputstream_8c.html#aa8a037b8d5ccd944010885e5425bbd8d" title="Set the current offset in the current line to be a particular setting." alt="" coords="317,664,600,691"/><area shape="rect" id="node32" href="antlr3inputstream_8c.html#a37ea26f99429587e51e9d19e09a67339" title="Set the current line number as understood by the input stream." alt="" coords="357,715,560,741"/><area shape="rect" id="node34" href="antlr3inputstream_8c.html#ab186c3ea6ae5f33342d39accea8f0fd5" title="Set the newline trigger character in the input stream to the supplied parameter." alt="" coords="323,765,595,792"/><area shape="rect" id="node36" href="antlr3inputstream_8c.html#a27a86b0651fff2fb5cd5278a7d1bf16d" title="antlr3AsciiSetUcaseLA" alt="" coords="343,816,575,843"/><area shape="rect" id="node41" href="antlr3inputstream_8c.html#a1eeecf25fb6b84324009a2d2017dc4e6" title="Return the size of the current input stream, as an Ascii file which in this case is the total input..." alt="" coords="373,867,544,893"/><area shape="rect" id="node43" href="antlr3inputstream_8c.html#a2db610f2179ac9ec9bd88f46ea708d4b" title="Return a substring of the ASCII (8 bit) input stream in newly allocated memory." alt="" coords="363,917,555,944"/><area shape="rect" id="node45" href="antlr3inputstream_8c.html#a2071f06b671bc50c37c323b9e9f66a8f" title="Close down an input stream and free any memory allocated by it." alt="" coords="368,968,549,995"/><area shape="rect" id="node47" href="antlr3inputstream_8c.html#a6db084bb0d49cec0847c2e31396bb550" title="Reset a re-startable input stream to the start." alt="" coords="368,1019,549,1045"/><area shape="rect" id="node74" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#ga58e4ce6e808a830c69cc73f3db040ae4" title="antlr3IntStreamNew" alt="" coords="357,1069,560,1096"/><area shape="rect" id="node39" href="antlr3inputstream_8c.html#a24a1b524458e398b1ac96c76b79fd2d1" title="Return the input element assuming an 8 bit ASCII input and always return the UPPER CASE character..." alt="" coords="649,816,860,843"/><area shape="rect" id="node49" href="antlr3collections_8c.html#a0f20590f5ba34812e48d6cec3e126fd6" title="antlr3VectorNew" alt="" coords="669,1019,840,1045"/><area shape="rect" id="node51" href="antlr3collections_8c.html#a257bb3a732b0aee54f196ea448944d0b" title="antlr3SetVectorApi" alt="" coords="909,1019,1112,1045"/><area shape="rect" id="node53" href="antlr3collections_8c.html#ab7bfa6d6ae69bd46b3c155d55a7162a1" title="Add the supplied pointer and freeing function pointer to the list, expanding the vector if needed..." alt="" coords="1176,1069,1347,1096"/><area shape="rect" id="node57" href="antlr3collections_8c.html#aa6d77074d26182876f7cc5269f39dcaf" title="antlr3VectorClear" alt="" coords="1165,867,1357,893"/><area shape="rect" id="node59" href="antlr3collections_8c.html#a2f2a279a441ad513caf852f3f5387f1e" title="antlr3VectorDel" alt="" coords="1176,917,1347,944"/><area shape="rect" id="node61" href="antlr3collections_8c.html#acebfdc6cc1b28c406946fa6e72c1f581" title="antlr3VectorFree" alt="" coords="1171,968,1352,995"/><area shape="rect" id="node63" href="antlr3collections_8c.html#a62297bdab210e5a852d9c778a48556b8" title="antlr3VectorGet" alt="" coords="1176,1019,1347,1045"/><area shape="rect" id="node65" href="antlr3collections_8c.html#aea45dc661f9abf012538728ab751962b" title="Replace the element at the specified entry point with the supplied entry." alt="" coords="1176,816,1347,843"/><area shape="rect" id="node68" href="antlr3collections_8c.html#a080b1c287eb015e890bfb6d5c20be49c" title="antlr3VectorSize" alt="" coords="1171,1120,1352,1147"/><area shape="rect" id="node70" href="antlr3collections_8c.html#ad8d9537615595fcbf0d5c1fecde4b4d9" title="Replace the element at the specified entry point with the supplied entry." alt="" coords="1171,1171,1352,1197"/><area shape="rect" id="node72" href="antlr3collections_8c.html#a2ac98c6e0465a288734e77595a1b9d13" title="Remove the entry from the vector, but do not free any entry, even if it has a free pointer..." alt="" coords="1160,1221,1363,1248"/><area shape="rect" id="node55" href="antlr3collections_8c.html#ac0149859fb053a93f46163e0ee568b7f" title="antlr3VectorResize" alt="" coords="1411,943,1613,969"/><area shape="rect" id="node76" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#gab9e98efaa7265d8af43f81feefeb6579" title="freeStream" alt="" coords="693,1069,816,1096"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_icgraph.png" border="0" usemap="#antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_icgraph" alt=""/></div>
<map name="antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_icgraph" id="antlr3input_8h_a21447ea48a486c62b30dbec7bac4520d_icgraph">
<area shape="rect" id="node3" href="antlr3input_8h.html#a7c16415f2169b8602521bf04503b1baa" title="Common function to setup function interface for an 8 bit ASCII input stream." alt="" coords="317,69,560,96"/><area shape="rect" id="node11" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee" title="Common function to setup function interface for a 16 bit "UCS2" input stream." alt="" coords="323,132,555,159"/><area shape="rect" id="node5" href="antlr3defs_8h.html#a449abcf6642288f35bacc3aae39c0ff6" title="Use the contents of an operating system file as the input for an input stream." alt="" coords="653,5,915,32"/><area shape="rect" id="node7" href="antlr3defs_8h.html#a6d21ea1bbd612d00207e772fb7f050dc" title="Create an ASCII string stream as input to ANTLR 3, copying the input string." alt="" coords="623,56,945,83"/><area shape="rect" id="node9" href="antlr3defs_8h.html#ade853f2bfd99e96ee0cd9f1cca97427a" title="Create an in-place ASCII string stream as input to ANTLR 3." alt="" coords="608,107,960,133"/><area shape="rect" id="node13" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="613,157,955,184"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a020ca344ffee44774c9d4c4a5308ebee"></a><!-- doxytag: member="antlr3input.h::antlr3UCS2SetupStream" ref="a020ca344ffee44774c9d4c4a5308ebee" args="(pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void antlr3UCS2SetupStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">pANTLR3_INPUT_STREAM</a> </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Common function to setup function interface for a 16 bit "UCS2" input stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>Input stream context pointer</td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>Strictly speaking, there is no such thing as a UCS2 input stream as the term tends to confuse the notions of character encoding, unicode and so on. However because there will possibly be a need for a UTF-16 stream, I needed to identify 16 bit streams that do not support surrogate encodings and UCS2 is how it is mostly referred to. For instance Java, Oracle and others use a 16 bit encoding of characters and so this type of stream is very common. Take it to mean, therefore, a straight 16 bit uncomplicated encoding of Unicode code points. </li>
</ul>
</dd></dl>
<p>References <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#abc96e456bf8fdbb01b869b1ab9e27e5a">ANTLR3_INT_STREAM_struct::_LA</a>, <a class="el" href="antlr3inputstream_8c.html#a21447ea48a486c62b30dbec7bac4520d">antlr3GenericSetupStream()</a>, <a class="el" href="antlr3ucs2inputstream_8c.html#ae75b7cccb33ba984032ebf57d36ae712">antlr3UCS2Consume()</a>, <a class="el" href="antlr3ucs2inputstream_8c.html#ac99e851def1fcdba29265ab6c0f873b4">antlr3UCS2Index()</a>, <a class="el" href="antlr3ucs2inputstream_8c.html#aa2d9456a1af1b2e3fbc7e324d0d1f7d5">antlr3UCS2LA()</a>, <a class="el" href="antlr3ucs2inputstream_8c.html#a3ce4ad08a0c7244fa89242718c09d0ca">antlr3UCS2Seek()</a>, <a class="el" href="antlr3string_8c.html#ac13bd5eb395a17e3e8e890f9d1215e94">antlr3UCS2StringFactoryNew()</a>, <a class="el" href="antlr3ucs2inputstream_8c.html#a4ae28207ab892249bda682bccc2c04e8">antlr3UCS2Substr()</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#aaac6c588f4b1817939ff796074ff494b">ANTLR3_INPUT_STREAM_struct::charByteSize</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a94cc34ff782903d0d2b91595f308062a">ANTLR3_INT_STREAM_struct::consume</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a5141407fe8b50ff4e87f617811fd54fc">ANTLR3_INT_STREAM_struct::index</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ac90101686f579652c058d24f5a7bad35">ANTLR3_INPUT_STREAM_struct::istream</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a052f31580e00cb4200a6234dfcca600b">ANTLR3_INT_STREAM_struct::seek</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ad3de400db5b8a382e5f1973ac5db70c0">ANTLR3_INPUT_STREAM_struct::strFactory</a>, and <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#aa5328318fdaba5a203bd15a7136b8594">ANTLR3_INPUT_STREAM_struct::substr</a>.</p>
<p>Referenced by <a class="el" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d">antlr3NewUCS2StringInPlaceStream()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_cgraph.png" border="0" usemap="#antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_cgraph" alt=""/></div>
<map name="antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_cgraph" id="antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_cgraph">
<area shape="rect" id="node3" href="antlr3inputstream_8c.html#a21447ea48a486c62b30dbec7bac4520d" title="antlr3GenericSetupStream" alt="" coords="296,563,557,589"/><area shape="rect" id="node57" href="antlr3ucs2inputstream_8c.html#ae75b7cccb33ba984032ebf57d36ae712" title="Consume the next character in an 8 bit ASCII input stream." alt="" coords="331,1120,523,1147"/><area shape="rect" id="node59" href="antlr3ucs2inputstream_8c.html#ac99e851def1fcdba29265ab6c0f873b4" title="Calculate the current index in the output stream." alt="" coords="341,1171,512,1197"/><area shape="rect" id="node61" href="antlr3ucs2inputstream_8c.html#aa2d9456a1af1b2e3fbc7e324d0d1f7d5" title="Return the input element assuming an 8 bit ascii input." alt="" coords="356,1221,497,1248"/><area shape="rect" id="node63" href="antlr3ucs2inputstream_8c.html#a3ce4ad08a0c7244fa89242718c09d0ca" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="345,1272,508,1299"/><area shape="rect" id="node65" href="antlr3string_8c.html#ac13bd5eb395a17e3e8e890f9d1215e94" title="Create a string factory that is UCS2 (16 bit) encoding based." alt="" coords="285,1323,568,1349"/><area shape="rect" id="node107" href="antlr3ucs2inputstream_8c.html#a4ae28207ab892249bda682bccc2c04e8" title="Return a substring of the ucs2 (16 bit) input stream in newly allocated memory." alt="" coords="336,1373,517,1400"/><area shape="rect" id="node5" href="antlr3inputstream_8c.html#a04b17af4657eba6575a81e11553a9ac2" title="Consume the next character in an 8 bit ASCII input stream." alt="" coords="656,968,859,995"/><area shape="rect" id="node7" href="antlr3inputstream_8c.html#a88f441835477f47ece67fd43d91902d0" title="Return the current offset in to the current line in the input stream." alt="" coords="616,1019,899,1045"/><area shape="rect" id="node9" href="antlr3inputstream_8c.html#a020b2a4c7892d5aeff8cc46fa477db0e" title="Return the line number as understood by the 8 bit/ASCII input stream." alt="" coords="656,5,859,32"/><area shape="rect" id="node11" href="antlr3inputstream_8c.html#a80dc7dff66516aba7c5cba1cc41a7621" title="Return a pointer into the input stream that points at the start of the current input line as triggere..." alt="" coords="641,56,873,83"/><area shape="rect" id="node13" href="antlr3inputstream_8c.html#ad90161c1a0f0c00ab2a41a2ccdd47126" title="antlr3AsciiGetSourceName" alt="" coords="627,107,888,133"/><area shape="rect" id="node15" href="antlr3inputstream_8c.html#ad9cc281bdf5a5db4d2d637665735fd4b" title="Calculate the current index in the output stream." alt="" coords="667,157,848,184"/><area shape="rect" id="node17" href="antlr3inputstream_8c.html#a6f265b941d90fc60f1fc7b0ffac52133" title="Return the input element assuming an 8 bit ascii input." alt="" coords="977,613,1129,640"/><area shape="rect" id="node19" href="antlr3inputstream_8c.html#a414ce5c054eb9a018502fe58c8aa0938" title="Return the input element assuming an 8 bit ascii input." alt="" coords="681,259,833,285"/><area shape="rect" id="node21" href="antlr3inputstream_8c.html#aaa06c4ab344d09c0dc34bb7a72a71c90" title="Mark the current input point in an Ascii 8 bit stream such as a file stream, where all the input is a..." alt="" coords="672,309,843,336"/><area shape="rect" id="node23" href="antlr3inputstream_8c.html#a9d8c8cecacc8aab95a6e4916417ea4f2" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="656,360,859,387"/><area shape="rect" id="node25" href="antlr3inputstream_8c.html#a66ed7e1476c1a41d910643ccd36590dd" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="661,208,853,235"/><area shape="rect" id="node27" href="antlr3inputstream_8c.html#a1adb69a6e789ecb1e3525a30f2b93192" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="968,309,1139,336"/><area shape="rect" id="node29" href="antlr3inputstream_8c.html#a864af44a978e75ffa7b80685e370b987" title="Rewind the lexer input to the state specified by the last produced mark." alt="" coords="641,512,873,539"/><area shape="rect" id="node32" href="antlr3inputstream_8c.html#aa8a037b8d5ccd944010885e5425bbd8d" title="Set the current offset in the current line to be a particular setting." alt="" coords="616,563,899,589"/><area shape="rect" id="node34" href="antlr3inputstream_8c.html#a37ea26f99429587e51e9d19e09a67339" title="Set the current line number as understood by the input stream." alt="" coords="656,613,859,640"/><area shape="rect" id="node36" href="antlr3inputstream_8c.html#ab186c3ea6ae5f33342d39accea8f0fd5" title="Set the newline trigger character in the input stream to the supplied parameter." alt="" coords="621,664,893,691"/><area shape="rect" id="node38" href="antlr3inputstream_8c.html#a27a86b0651fff2fb5cd5278a7d1bf16d" title="antlr3AsciiSetUcaseLA" alt="" coords="641,461,873,488"/><area shape="rect" id="node43" href="antlr3inputstream_8c.html#a1eeecf25fb6b84324009a2d2017dc4e6" title="Return the size of the current input stream, as an Ascii file which in this case is the total input..." alt="" coords="672,765,843,792"/><area shape="rect" id="node45" href="antlr3inputstream_8c.html#a2db610f2179ac9ec9bd88f46ea708d4b" title="Return a substring of the ASCII (8 bit) input stream in newly allocated memory." alt="" coords="661,816,853,843"/><area shape="rect" id="node47" href="antlr3inputstream_8c.html#a2071f06b671bc50c37c323b9e9f66a8f" title="Close down an input stream and free any memory allocated by it." alt="" coords="667,867,848,893"/><area shape="rect" id="node49" href="antlr3inputstream_8c.html#a6db084bb0d49cec0847c2e31396bb550" title="Reset a re-startable input stream to the start." alt="" coords="667,1069,848,1096"/><area shape="rect" id="node53" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#ga58e4ce6e808a830c69cc73f3db040ae4" title="antlr3IntStreamNew" alt="" coords="656,917,859,944"/><area shape="rect" id="node41" href="antlr3inputstream_8c.html#a24a1b524458e398b1ac96c76b79fd2d1" title="Return the input element assuming an 8 bit ASCII input and always return the UPPER CASE character..." alt="" coords="948,461,1159,488"/><area shape="rect" id="node51" href="antlr3collections_8c.html#a0f20590f5ba34812e48d6cec3e126fd6" title="antlr3VectorNew" alt="" coords="968,1095,1139,1121"/><area shape="rect" id="node55" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#gab9e98efaa7265d8af43f81feefeb6579" title="freeStream" alt="" coords="992,917,1115,944"/><area shape="rect" id="node67" href="antlr3string_8c.html#a093d8f8ffc08b56bb751974a0b27d9b6" title="antlr3StringFactoryNew" alt="" coords="636,1475,879,1501"/><area shape="rect" id="node70" href="antlr3string_8c.html#a1b413d5a90212a05ac374d0ecff495ef" title="Fascist Capitalist Pig function created to oppress the workers comrade." alt="" coords="983,1297,1124,1324"/><area shape="rect" id="node72" href="antlr3string_8c.html#a0a3d4c0f9076e26dbe14693a5946b38e" title="destroy" alt="" coords="1008,1348,1099,1375"/><area shape="rect" id="node90" href="antlr3string_8c.html#ae3feb218c7f7cf8056c3e1af033d3afb" title="Creates a new 16 bit string initialized with the 16 bit characters at the supplied ptr..." alt="" coords="988,1652,1119,1679"/><area shape="rect" id="node93" href="antlr3string_8c.html#ab997b00485f2b58e9c11ac3d9ed36162" title="Creates a new 16 bit string initialized with the 8 bit characters at the supplied 8 bit character ptr..." alt="" coords="992,1703,1115,1729"/><area shape="rect" id="node96" href="antlr3string_8c.html#a7ab10fcd00d661190e63269ad3e1cf99" title="newRaw16" alt="" coords="1003,1196,1104,1223"/><area shape="rect" id="node99" href="antlr3string_8c.html#a5a18860cec3cdb1d4d003fb91d821879" title="Creates a new string with enough capacity for size 16 bit characters plus a terminator." alt="" coords="701,1171,813,1197"/><area shape="rect" id="node101" href="antlr3string_8c.html#af862e61c80b8d95973cb320816b94455" title="Create a new 16 bit string from the supplied, null terminated, 16 bit string pointer." alt="" coords="692,1221,823,1248"/><area shape="rect" id="node103" href="antlr3string_8c.html#a8f8263029e04935f9bdfdf7ae6fc5a50" title="Create a new 16 bit string from the supplied, null terminated, 8 bit string pointer." alt="" coords="696,1272,819,1299"/><area shape="rect" id="node105" href="antlr3string_8c.html#afae7df691f731fcf2b576672b3fabce6" title="printable16" alt="" coords="692,1323,823,1349"/><area shape="rect" id="node74" href="antlr3string_8c.html#a872d78a174c23de5f24960b95f922aa2" title="Creates a new 8 bit string initialized with the 8 bit characters at the supplied ptr, of pre-determined size." alt="" coords="1008,1601,1099,1628"/><area shape="rect" id="node78" href="antlr3string_8c.html#aa4bb69b65c9021096ab73b5b0f4d8228" title="newRaw8" alt="" coords="1008,1399,1099,1425"/><area shape="rect" id="node82" href="antlr3string_8c.html#a3ec2260d58995feecd5f0a19db44287f" title="Creates a new string with enough capacity for size 8 bit characters plus a terminator." alt="" coords="1003,1449,1104,1476"/><area shape="rect" id="node84" href="antlr3string_8c.html#ac42f6b7f61aaaaeef9364a3b6a2f2846" title="Create a new 8 bit string from the supplied, null terminated, 8 bit string pointer." alt="" coords="1008,1500,1099,1527"/><area shape="rect" id="node86" href="antlr3string_8c.html#ad2791348557c03f3db05d005ffd12743" title="printable8" alt="" coords="992,1551,1115,1577"/><area shape="rect" id="node76" href="antlr3commontreenodestream_8c.html#a7d68f5af32504d0af4c13a4c9d33726d" title="Expensive to compute the size of the whole tree while parsing." alt="" coords="1239,1652,1300,1679"/><area shape="rect" id="node80" href="antlr3string_8c.html#ad3b8ca592798fba5c5c8f49412b41cd0" title="stringFree" alt="" coords="1208,1297,1331,1324"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_icgraph.png" border="0" usemap="#antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_icgraph" alt=""/></div>
<map name="antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_icgraph" id="antlr3input_8h_a020ca344ffee44774c9d4c4a5308ebee_icgraph">
<area shape="rect" id="node3" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="287,5,628,32"/></map>
</div>
</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="antlr3input_8h.html">antlr3input.h</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for ANTLR3C by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
