<!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: src/antlr3ucs2inputstream.c 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('antlr3ucs2inputstream_8c.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>antlr3ucs2inputstream.c File Reference</h1> </div>
</div>
<div class="contents">
<p>Base functions to initialize and manipulate a UCS2 input stream.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <antlr3input.h></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3ucs2inputstream.c:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3ucs2inputstream_8c__incl.png" border="0" usemap="#src_2antlr3ucs2inputstream_8c" alt=""/></div>
<map name="src_2antlr3ucs2inputstream_8c" id="src_2antlr3ucs2inputstream_8c">
</map>
</div>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3ucs2inputstream_8c.html#ae75b7cccb33ba984032ebf57d36ae712">antlr3UCS2Consume</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> is)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Consume the next character in an 8 bit ASCII input stream. <a href="#ae75b7cccb33ba984032ebf57d36ae712"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3ucs2inputstream_8c.html#ac99e851def1fcdba29265ab6c0f873b4">antlr3UCS2Index</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> is)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the current index in the output stream. <a href="#ac99e851def1fcdba29265ab6c0f873b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="antlr3defs_8h.html#a078eec1343cdbb862af80f352ea701da">ANTLR3_UCHAR</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3ucs2inputstream_8c.html#aa2d9456a1af1b2e3fbc7e324d0d1f7d5">antlr3UCS2LA</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> is, <a class="el" href="antlr3defs_8h.html#a6faef5c4687f8eb633d2aefea93973ca">ANTLR3_INT32</a> la)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the input element assuming an 8 bit ascii input. <a href="#aa2d9456a1af1b2e3fbc7e324d0d1f7d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3ucs2inputstream_8c.html#a3ce4ad08a0c7244fa89242718c09d0ca">antlr3UCS2Seek</a> (<a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> is, <a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> seekPoint)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rewind the lexer input to the state specified by the supplied mark. <a href="#a3ce4ad08a0c7244fa89242718c09d0ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3ucs2inputstream_8c.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>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">pANTLR3_STRING</a> </td><td class="memItemRight" valign="bottom"><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">pANTLR3_INPUT_STREAM</a> input, <a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> start, <a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> stop)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a substring of the ucs2 (16 bit) input stream in newly allocated memory. <a href="#a4ae28207ab892249bda682bccc2c04e8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base functions to initialize and manipulate a UCS2 input stream. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae75b7cccb33ba984032ebf57d36ae712"></a><!-- doxytag: member="antlr3ucs2inputstream.c::antlr3UCS2Consume" ref="ae75b7cccb33ba984032ebf57d36ae712" args="(pANTLR3_INT_STREAM is)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void antlr3UCS2Consume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> </td>
<td class="paramname"><em>is</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Consume the next character in 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>
<p>References <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#abe574b44337acb6550f27de7d80b8a08">ANTLR3_INPUT_STREAM_struct::charPositionInLine</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a4c75e460ade15e43bd4628fac2430ac1">ANTLR3_INPUT_STREAM_struct::currentLine</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#adc08e8fb7a312429e31b667cf9c67386">ANTLR3_INPUT_STREAM_struct::data</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a6339fbb583899850cc6647706c60f197">ANTLR3_INPUT_STREAM_struct::line</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a2a7261f49bf42f8101b598f85ad86486">ANTLR3_INPUT_STREAM_struct::newlineChar</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a782664088fb3999f4b152bf3e309bf7c">ANTLR3_INPUT_STREAM_struct::nextChar</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ae3b592e8fc40f7576b8ffd2125e26bb3">ANTLR3_INPUT_STREAM_struct::sizeBuf</a>, and <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>.</p>
<p>Referenced by <a class="el" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3ucs2inputstream_8c_ae75b7cccb33ba984032ebf57d36ae712_icgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_ae75b7cccb33ba984032ebf57d36ae712_icgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_ae75b7cccb33ba984032ebf57d36ae712_icgraph" id="antlr3ucs2inputstream_8c_ae75b7cccb33ba984032ebf57d36ae712_icgraph">
<area shape="rect" id="node3" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee" title="Common function to setup function interface for a 16 bit "UCS2" input stream." alt="" coords="245,5,477,32"/><area shape="rect" id="node5" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="527,5,868,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ac99e851def1fcdba29265ab6c0f873b4"></a><!-- doxytag: member="antlr3ucs2inputstream.c::antlr3UCS2Index" ref="ac99e851def1fcdba29265ab6c0f873b4" args="(pANTLR3_INT_STREAM is)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> antlr3UCS2Index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> </td>
<td class="paramname"><em>is</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculate the current index in the output stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input stream context pointer </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a782664088fb3999f4b152bf3e309bf7c">ANTLR3_INPUT_STREAM_struct::nextChar</a>, and <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>.</p>
<p>Referenced by <a class="el" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3ucs2inputstream_8c_ac99e851def1fcdba29265ab6c0f873b4_icgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_ac99e851def1fcdba29265ab6c0f873b4_icgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_ac99e851def1fcdba29265ab6c0f873b4_icgraph" id="antlr3ucs2inputstream_8c_ac99e851def1fcdba29265ab6c0f873b4_icgraph">
<area shape="rect" id="node3" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee" title="Common function to setup function interface for a 16 bit "UCS2" input stream." alt="" coords="227,5,459,32"/><area shape="rect" id="node5" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="508,5,849,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aa2d9456a1af1b2e3fbc7e324d0d1f7d5"></a><!-- doxytag: member="antlr3ucs2inputstream.c::antlr3UCS2LA" ref="aa2d9456a1af1b2e3fbc7e324d0d1f7d5" args="(pANTLR3_INT_STREAM is, ANTLR3_INT32 la)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="antlr3defs_8h.html#a078eec1343cdbb862af80f352ea701da">ANTLR3_UCHAR</a> antlr3UCS2LA </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> </td>
<td class="paramname"><em>is</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a6faef5c4687f8eb633d2aefea93973ca">ANTLR3_INT32</a> </td>
<td class="paramname"><em>la</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the input element assuming an 8 bit ascii input. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input stream context pointer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">la</td><td>1 based offset of next input stream element</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Next input character in internal ANTLR3 encoding (UTF32) </dd></dl>
<p>References <a class="el" href="antlr3errors_8h.html#acfaa7f0b23bf1c4e2210366ed0c5e0ad">ANTLR3_CHARSTREAM_EOF</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#adc08e8fb7a312429e31b667cf9c67386">ANTLR3_INPUT_STREAM_struct::data</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#a782664088fb3999f4b152bf3e309bf7c">ANTLR3_INPUT_STREAM_struct::nextChar</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#ae3b592e8fc40f7576b8ffd2125e26bb3">ANTLR3_INPUT_STREAM_struct::sizeBuf</a>, and <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>.</p>
<p>Referenced by <a class="el" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3ucs2inputstream_8c_aa2d9456a1af1b2e3fbc7e324d0d1f7d5_icgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_aa2d9456a1af1b2e3fbc7e324d0d1f7d5_icgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_aa2d9456a1af1b2e3fbc7e324d0d1f7d5_icgraph" id="antlr3ucs2inputstream_8c_aa2d9456a1af1b2e3fbc7e324d0d1f7d5_icgraph">
<area shape="rect" id="node3" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee" title="Common function to setup function interface for a 16 bit "UCS2" input stream." alt="" coords="197,5,429,32"/><area shape="rect" id="node5" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="479,5,820,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a3ce4ad08a0c7244fa89242718c09d0ca"></a><!-- doxytag: member="antlr3ucs2inputstream.c::antlr3UCS2Seek" ref="a3ce4ad08a0c7244fa89242718c09d0ca" args="(pANTLR3_INT_STREAM is, ANTLR3_MARKER seekPoint)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void antlr3UCS2Seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html">pANTLR3_INT_STREAM</a> </td>
<td class="paramname"><em>is</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> </td>
<td class="paramname"><em>seekPoint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rewind the lexer input to the state specified by the supplied mark. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input stream context pointer</td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Assumes ASCII (or at least, 8 Bit) input stream. </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#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#a782664088fb3999f4b152bf3e309bf7c">ANTLR3_INPUT_STREAM_struct::nextChar</a>, and <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>.</p>
<p>Referenced by <a class="el" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3ucs2inputstream_8c_a3ce4ad08a0c7244fa89242718c09d0ca_icgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_a3ce4ad08a0c7244fa89242718c09d0ca_icgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_a3ce4ad08a0c7244fa89242718c09d0ca_icgraph" id="antlr3ucs2inputstream_8c_a3ce4ad08a0c7244fa89242718c09d0ca_icgraph">
<area shape="rect" id="node3" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee" title="Common function to setup function interface for a 16 bit "UCS2" input stream." alt="" coords="216,5,448,32"/><area shape="rect" id="node5" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="497,5,839,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a020ca344ffee44774c9d4c4a5308ebee"></a><!-- doxytag: member="antlr3ucs2inputstream.c::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="antlr3ucs2inputstream_8c_a020ca344ffee44774c9d4c4a5308ebee_cgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_a020ca344ffee44774c9d4c4a5308ebee_cgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_a020ca344ffee44774c9d4c4a5308ebee_cgraph" id="antlr3ucs2inputstream_8c_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="antlr3ucs2inputstream_8c_a020ca344ffee44774c9d4c4a5308ebee_icgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_a020ca344ffee44774c9d4c4a5308ebee_icgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_a020ca344ffee44774c9d4c4a5308ebee_icgraph" id="antlr3ucs2inputstream_8c_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>
<a class="anchor" id="a4ae28207ab892249bda682bccc2c04e8"></a><!-- doxytag: member="antlr3ucs2inputstream.c::antlr3UCS2Substr" ref="a4ae28207ab892249bda682bccc2c04e8" args="(pANTLR3_INPUT_STREAM input, ANTLR3_MARKER start, ANTLR3_MARKER stop)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">pANTLR3_STRING</a> antlr3UCS2Substr </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#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a0361e6bf442e07afe923e4d05e9ebc4f">ANTLR3_MARKER</a> </td>
<td class="paramname"><em>stop</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a substring of the ucs2 (16 bit) input stream in newly allocated memory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>Input stream context pointer </td></tr>
<tr><td class="paramname">start</td><td>Offset in input stream where the string starts </td></tr>
<tr><td class="paramname">stop</td><td>Offset in the input stream where the string ends. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="antlr3defs_8h.html#ac0a5917ff4670729a65b204e57ce9cb2">ANTLR3_UINT32_CAST</a>, <a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html#a6cb6566b577eb18979692b1f999f6a0c">ANTLR3_STRING_FACTORY_struct::newPtr</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="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee">antlr3UCS2SetupStream()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3ucs2inputstream_8c_a4ae28207ab892249bda682bccc2c04e8_icgraph.png" border="0" usemap="#antlr3ucs2inputstream_8c_a4ae28207ab892249bda682bccc2c04e8_icgraph" alt=""/></div>
<map name="antlr3ucs2inputstream_8c_a4ae28207ab892249bda682bccc2c04e8_icgraph" id="antlr3ucs2inputstream_8c_a4ae28207ab892249bda682bccc2c04e8_icgraph">
<area shape="rect" id="node3" href="antlr3input_8h.html#a020ca344ffee44774c9d4c4a5308ebee" title="Common function to setup function interface for a 16 bit "UCS2" input stream." alt="" coords="237,5,469,32"/><area shape="rect" id="node5" href="antlr3defs_8h.html#ae056370f36a0cdb74897b6283523a74d" title="Create an in-place UCS2 string stream as input to ANTLR 3." alt="" coords="519,5,860,32"/></map>
</div>
</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="antlr3ucs2inputstream_8c.html">antlr3ucs2inputstream.c</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>
