<!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/antlr3filestream.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('antlr3filestream_8c.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>antlr3filestream.c File Reference</h1> </div>
</div>
<div class="contents">
<p>The ANTLR3 C filestream is used when the source character stream is a filesystem based input set and all the characters in the filestream can be loaded at once into memory and away the lexer goes.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <antlr3.h></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3filestream.c:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c__incl.png" border="0" usemap="#src_2antlr3filestream_8c" alt=""/></div>
<map name="src_2antlr3filestream_8c" id="src_2antlr3filestream_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">ANTLR3_API <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="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8c.html#a449abcf6642288f35bacc3aae39c0ff6">antlr3AsciiFileStreamNew</a> (<a class="el" href="antlr3defs_8h.html#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> fileName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use the contents of an operating system file as the input for an input stream. <a href="#a449abcf6642288f35bacc3aae39c0ff6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ANTLR3_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8c.html#a1e94b56e2eb94d1868f171fac82506e3">antlr3Fclose</a> (<a class="el" href="antlr3defs_8h.html#a9beaa398598a3af4b812ace606130875">ANTLR3_FDSC</a> fd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an operating system file and free any handles etc. <a href="#a1e94b56e2eb94d1868f171fac82506e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ANTLR3_API <a class="el" href="antlr3defs_8h.html#a9beaa398598a3af4b812ace606130875">ANTLR3_FDSC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8c.html#a2bd0116a11ccc7a0d5badc301d34cb70">antlr3Fopen</a> (<a class="el" href="antlr3defs_8h.html#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> filename, const char *mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open an operating system file and return the descriptor We just use the common open() and related functions here. <a href="#a2bd0116a11ccc7a0d5badc301d34cb70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ANTLR3_API <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8c.html#a2d7d39a2ac3aa6cd29e1864ef650296d">antlr3Fread</a> (<a class="el" href="antlr3defs_8h.html#a9beaa398598a3af4b812ace606130875">ANTLR3_FDSC</a> fdsc, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> count, void *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ANTLR3_API <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8c.html#a2b59652a7427bad64918a79a01ca8245">antlr3Fsize</a> (<a class="el" href="antlr3defs_8h.html#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> fileName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ANTLR3_API <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8c.html#a855396d7279b462915e7e3830c8d17d7">antlr3readAscii</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#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> fileName)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The ANTLR3 C filestream is used when the source character stream is a filesystem based input set and all the characters in the filestream can be loaded at once into memory and away the lexer goes. </p>
<p>A number of initializers are provided in order that various character sets can be supported from input files. The ANTLR3 C runtime expects to deal with UTF32 characters only (the reasons for this are to do with the simplification of C code when using this form of Unicode encoding, though this is not a panacea. More information can be found on this by consulting:</p>
<ul>
<li><a href="http://www.unicode.org/versions/Unicode4.0.0/ch02.pdf#G11178">http://www.unicode.org/versions/Unicode4.0.0/ch02.pdf#G11178</a> Where a well grounded discussion of the encoding formats available may be found. </li>
</ul>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a449abcf6642288f35bacc3aae39c0ff6"></a><!-- doxytag: member="antlr3filestream.c::antlr3AsciiFileStreamNew" ref="a449abcf6642288f35bacc3aae39c0ff6" args="(pANTLR3_UINT8 fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_API <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> antlr3AsciiFileStreamNew </td>
<td>(</td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> </td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use the contents of an operating system file as the input for an input stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fileName</td><td>Name of operating system file to read. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>Pointer to new input stream context upon success</li>
<li>One of the ANTLR3_ERR_ defines on error. </li>
</ul>
</dd></dl>
<p>References <a class="el" href="antlr3defs_8h.html#ab14376fa4b3a6ffe41ba76e897824767">ANTLR3_CALLOC</a>, <a class="el" href="antlr3intstream_8h.html#abcbe3506dc98d1789d8113a9c3eff082">ANTLR3_CHARSTREAM</a>, <a class="el" href="antlr3errors_8h.html#a7820810a680eaeb12344ec6f3dbecdde">ANTLR3_SUCCESS</a>, <a class="el" href="antlr3inputstream_8c.html#a7c16415f2169b8602521bf04503b1baa">antlr3AsciiSetupStream()</a>, <a class="el" href="antlr3filestream_8c.html#a855396d7279b462915e7e3830c8d17d7">antlr3readAscii()</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_p_u_t___s_t_r_e_a_m__struct.html#abc54ce78713d5c52e306752257932454">ANTLR3_INPUT_STREAM_struct::fileName</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___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html#a7aa8c7669f01a6da359ca0729d635dd7">ANTLR3_STRING_FACTORY_struct::newStr</a>, <a class="el" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html#a8071957bbe514572d50d61500ee054e5">ANTLR3_INT_STREAM_struct::streamName</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><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a449abcf6642288f35bacc3aae39c0ff6_cgraph.png" border="0" usemap="#antlr3filestream_8c_a449abcf6642288f35bacc3aae39c0ff6_cgraph" alt=""/></div>
<map name="antlr3filestream_8c_a449abcf6642288f35bacc3aae39c0ff6_cgraph" id="antlr3filestream_8c_a449abcf6642288f35bacc3aae39c0ff6_cgraph">
<area shape="rect" id="node3" href="antlr3inputstream_8c.html#a7c16415f2169b8602521bf04503b1baa" title="Common function to setup function interface for an 8 bit ASCII input stream." alt="" coords="317,1272,560,1299"/><area shape="rect" id="node94" href="antlr3filestream_8c.html#a855396d7279b462915e7e3830c8d17d7" title="antlr3readAscii" alt="" coords="353,1373,524,1400"/><area shape="rect" id="node5" href="antlr3inputstream_8c.html#a21447ea48a486c62b30dbec7bac4520d" title="antlr3GenericSetupStream" alt="" coords="609,563,871,589"/><area shape="rect" id="node71" href="antlr3string_8c.html#a093d8f8ffc08b56bb751974a0b27d9b6" title="antlr3StringFactoryNew" alt="" coords="619,1272,861,1299"/><area shape="rect" id="node7" href="antlr3inputstream_8c.html#a04b17af4657eba6575a81e11553a9ac2" title="Consume the next character in an 8 bit ASCII input stream." alt="" coords="960,411,1163,437"/><area shape="rect" id="node9" href="antlr3inputstream_8c.html#a88f441835477f47ece67fd43d91902d0" title="Return the current offset in to the current line in the input stream." alt="" coords="920,461,1203,488"/><area shape="rect" id="node11" href="antlr3inputstream_8c.html#a020b2a4c7892d5aeff8cc46fa477db0e" title="Return the line number as understood by the 8 bit/ASCII input stream." alt="" coords="960,512,1163,539"/><area shape="rect" id="node13" 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="945,563,1177,589"/><area shape="rect" id="node15" href="antlr3inputstream_8c.html#ad90161c1a0f0c00ab2a41a2ccdd47126" title="antlr3AsciiGetSourceName" alt="" coords="931,613,1192,640"/><area shape="rect" id="node17" href="antlr3inputstream_8c.html#ad9cc281bdf5a5db4d2d637665735fd4b" title="Calculate the current index in the output stream." alt="" coords="971,664,1152,691"/><area shape="rect" id="node19" href="antlr3inputstream_8c.html#a6f265b941d90fc60f1fc7b0ffac52133" title="Return the input element assuming an 8 bit ascii input." alt="" coords="1281,233,1433,260"/><area shape="rect" id="node21" href="antlr3inputstream_8c.html#a414ce5c054eb9a018502fe58c8aa0938" title="Return the input element assuming an 8 bit ascii input." alt="" coords="985,715,1137,741"/><area shape="rect" id="node23" 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="976,765,1147,792"/><area shape="rect" id="node25" href="antlr3inputstream_8c.html#a9d8c8cecacc8aab95a6e4916417ea4f2" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="960,816,1163,843"/><area shape="rect" id="node27" href="antlr3inputstream_8c.html#a66ed7e1476c1a41d910643ccd36590dd" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="965,917,1157,944"/><area shape="rect" id="node29" href="antlr3inputstream_8c.html#a1adb69a6e789ecb1e3525a30f2b93192" title="Rewind the lexer input to the state specified by the supplied mark." alt="" coords="1272,892,1443,919"/><area shape="rect" id="node31" href="antlr3inputstream_8c.html#a864af44a978e75ffa7b80685e370b987" title="Rewind the lexer input to the state specified by the last produced mark." alt="" coords="945,968,1177,995"/><area shape="rect" id="node34" href="antlr3inputstream_8c.html#aa8a037b8d5ccd944010885e5425bbd8d" title="Set the current offset in the current line to be a particular setting." alt="" coords="920,1019,1203,1045"/><area shape="rect" id="node36" href="antlr3inputstream_8c.html#a37ea26f99429587e51e9d19e09a67339" title="Set the current line number as understood by the input stream." alt="" coords="960,5,1163,32"/><area shape="rect" id="node38" href="antlr3inputstream_8c.html#ab186c3ea6ae5f33342d39accea8f0fd5" title="Set the newline trigger character in the input stream to the supplied parameter." alt="" coords="925,56,1197,83"/><area shape="rect" id="node40" href="antlr3inputstream_8c.html#a27a86b0651fff2fb5cd5278a7d1bf16d" title="antlr3AsciiSetUcaseLA" alt="" coords="945,107,1177,133"/><area shape="rect" id="node45" 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="976,157,1147,184"/><area shape="rect" id="node47" href="antlr3inputstream_8c.html#a2db610f2179ac9ec9bd88f46ea708d4b" title="Return a substring of the ASCII (8 bit) input stream in newly allocated memory." alt="" coords="965,208,1157,235"/><area shape="rect" id="node49" href="antlr3inputstream_8c.html#a2071f06b671bc50c37c323b9e9f66a8f" title="Close down an input stream and free any memory allocated by it." alt="" coords="971,259,1152,285"/><area shape="rect" id="node51" href="antlr3inputstream_8c.html#a6db084bb0d49cec0847c2e31396bb550" title="Reset a re-startable input stream to the start." alt="" coords="971,1069,1152,1096"/><area shape="rect" id="node67" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#ga58e4ce6e808a830c69cc73f3db040ae4" title="antlr3IntStreamNew" alt="" coords="960,360,1163,387"/><area shape="rect" id="node43" 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="1252,107,1463,133"/><area shape="rect" id="node53" href="antlr3collections_8c.html#a0f20590f5ba34812e48d6cec3e126fd6" title="antlr3VectorNew" alt="" coords="1272,1095,1443,1121"/><area shape="rect" id="node55" href="antlr3collections_8c.html#a257bb3a732b0aee54f196ea448944d0b" title="antlr3SetVectorApi" alt="" coords="1512,1095,1715,1121"/><area shape="rect" id="node57" href="antlr3collections_8c.html#ab7bfa6d6ae69bd46b3c155d55a7162a1" title="Add the supplied pointer and freeing function pointer to the list, expanding the vector if needed..." alt="" coords="1773,993,1944,1020"/><area shape="rect" id="node59" href="antlr3collections_8c.html#aa6d77074d26182876f7cc5269f39dcaf" title="antlr3VectorClear" alt="" coords="1763,1044,1955,1071"/><area shape="rect" id="node61" href="antlr3collections_8c.html#a2f2a279a441ad513caf852f3f5387f1e" title="antlr3VectorDel" alt="" coords="1773,1095,1944,1121"/><area shape="rect" id="node63" href="antlr3collections_8c.html#acebfdc6cc1b28c406946fa6e72c1f581" title="antlr3VectorFree" alt="" coords="1768,1145,1949,1172"/><area shape="rect" id="node65" href="antlr3collections_8c.html#a62297bdab210e5a852d9c778a48556b8" title="antlr3VectorGet" alt="" coords="1773,1196,1944,1223"/><area shape="rect" id="node69" href="group__p_a_n_t_l_r3___i_n_t___s_t_r_e_a_m.html#gab9e98efaa7265d8af43f81feefeb6579" title="freeStream" alt="" coords="1296,360,1419,387"/><area shape="rect" id="node74" href="antlr3string_8c.html#a1b413d5a90212a05ac374d0ecff495ef" title="Fascist Capitalist Pig function created to oppress the workers comrade." alt="" coords="991,1475,1132,1501"/><area shape="rect" id="node76" href="antlr3string_8c.html#a0a3d4c0f9076e26dbe14693a5946b38e" title="destroy" alt="" coords="1016,1171,1107,1197"/><area shape="rect" id="node78" 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="1016,1221,1107,1248"/><area shape="rect" id="node82" href="antlr3string_8c.html#aa4bb69b65c9021096ab73b5b0f4d8228" title="newRaw8" alt="" coords="1016,1424,1107,1451"/><area shape="rect" id="node88" href="antlr3string_8c.html#a3ec2260d58995feecd5f0a19db44287f" title="Creates a new string with enough capacity for size 8 bit characters plus a terminator." alt="" coords="1011,1272,1112,1299"/><area shape="rect" id="node90" href="antlr3string_8c.html#ac42f6b7f61aaaaeef9364a3b6a2f2846" title="Create a new 8 bit string from the supplied, null terminated, 8 bit string pointer." alt="" coords="1016,1323,1107,1349"/><area shape="rect" id="node92" href="antlr3string_8c.html#ad2791348557c03f3db05d005ffd12743" title="printable8" alt="" coords="1000,1373,1123,1400"/><area shape="rect" id="node80" href="antlr3commontreenodestream_8c.html#a7d68f5af32504d0af4c13a4c9d33726d" title="Expensive to compute the size of the whole tree while parsing." alt="" coords="1327,1221,1388,1248"/><area shape="rect" id="node84" href="antlr3string_8c.html#ad3b8ca592798fba5c5c8f49412b41cd0" title="stringFree" alt="" coords="1296,1399,1419,1425"/><area shape="rect" id="node86" href="antlr3string_8c.html#aa01170a5ff98de91c515b39525546bf8" title="stringInit8" alt="" coords="1292,1449,1423,1476"/><area shape="rect" id="node96" href="antlr3filestream_8c.html#a1e94b56e2eb94d1868f171fac82506e3" title="Close an operating system file and free any handles etc." alt="" coords="669,1424,811,1451"/><area shape="rect" id="node98" href="antlr3filestream_8c.html#a2bd0116a11ccc7a0d5badc301d34cb70" title="Open an operating system file and return the descriptor We just use the common open() and related fun..." alt="" coords="675,1475,805,1501"/><area shape="rect" id="node100" href="antlr3filestream_8c.html#a2d7d39a2ac3aa6cd29e1864ef650296d" title="antlr3Fread" alt="" coords="675,1323,805,1349"/><area shape="rect" id="node102" href="antlr3filestream_8c.html#a2b59652a7427bad64918a79a01ca8245" title="antlr3Fsize" alt="" coords="675,1373,805,1400"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a1e94b56e2eb94d1868f171fac82506e3"></a><!-- doxytag: member="antlr3filestream.c::antlr3Fclose" ref="a1e94b56e2eb94d1868f171fac82506e3" args="(ANTLR3_FDSC fd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_API void antlr3Fclose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a9beaa398598a3af4b812ace606130875">ANTLR3_FDSC</a> </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close an operating system file and free any handles etc. </p>
<p>Referenced by <a class="el" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7">antlr3readAscii()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a1e94b56e2eb94d1868f171fac82506e3_icgraph.png" border="0" usemap="#antlr3filestream_8c_a1e94b56e2eb94d1868f171fac82506e3_icgraph" alt=""/></div>
<map name="antlr3filestream_8c_a1e94b56e2eb94d1868f171fac82506e3_icgraph" id="antlr3filestream_8c_a1e94b56e2eb94d1868f171fac82506e3_icgraph">
<area shape="rect" id="node3" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7" title="antlr3readAscii" alt="" coords="199,5,369,32"/><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="420,5,681,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a2bd0116a11ccc7a0d5badc301d34cb70"></a><!-- doxytag: member="antlr3filestream.c::antlr3Fopen" ref="a2bd0116a11ccc7a0d5badc301d34cb70" args="(pANTLR3_UINT8 filename, const char *mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_API <a class="el" href="antlr3defs_8h.html#a9beaa398598a3af4b812ace606130875">ANTLR3_FDSC</a> antlr3Fopen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open an operating system file and return the descriptor We just use the common open() and related functions here. </p>
<p>Later we might find better ways on systems such as Windows and OpenVMS for instance. But the idea is to read the while file at once anyway, so it may be irrelevant. </p>
<p>Referenced by <a class="el" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7">antlr3readAscii()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph.png" border="0" usemap="#antlr3filestream_8c_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph" alt=""/></div>
<map name="antlr3filestream_8c_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph" id="antlr3filestream_8c_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph">
<area shape="rect" id="node3" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7" title="antlr3readAscii" alt="" coords="188,5,359,32"/><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="409,5,671,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a2d7d39a2ac3aa6cd29e1864ef650296d"></a><!-- doxytag: member="antlr3filestream.c::antlr3Fread" ref="a2d7d39a2ac3aa6cd29e1864ef650296d" args="(ANTLR3_FDSC fdsc, ANTLR3_UINT32 count, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_API <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> antlr3Fread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a9beaa398598a3af4b812ace606130875">ANTLR3_FDSC</a> </td>
<td class="paramname"><em>fdsc</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>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7">antlr3readAscii()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph.png" border="0" usemap="#antlr3filestream_8c_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph" alt=""/></div>
<map name="antlr3filestream_8c_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph" id="antlr3filestream_8c_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph">
<area shape="rect" id="node3" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7" title="antlr3readAscii" alt="" coords="188,5,359,32"/><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="409,5,671,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a2b59652a7427bad64918a79a01ca8245"></a><!-- doxytag: member="antlr3filestream.c::antlr3Fsize" ref="a2b59652a7427bad64918a79a01ca8245" args="(pANTLR3_UINT8 fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_API <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> antlr3Fsize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="antlr3defs_8h.html#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> </td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="antlr3defs_8h.html#a2ac0f0c422c4f69864f72ed959d099d8">_stat</a>.</p>
<p>Referenced by <a class="el" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7">antlr3readAscii()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a2b59652a7427bad64918a79a01ca8245_icgraph.png" border="0" usemap="#antlr3filestream_8c_a2b59652a7427bad64918a79a01ca8245_icgraph" alt=""/></div>
<map name="antlr3filestream_8c_a2b59652a7427bad64918a79a01ca8245_icgraph" id="antlr3filestream_8c_a2b59652a7427bad64918a79a01ca8245_icgraph">
<area shape="rect" id="node3" href="antlr3filestream_8h.html#a855396d7279b462915e7e3830c8d17d7" title="antlr3readAscii" alt="" coords="188,5,359,32"/><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="409,5,671,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a855396d7279b462915e7e3830c8d17d7"></a><!-- doxytag: member="antlr3filestream.c::antlr3readAscii" ref="a855396d7279b462915e7e3830c8d17d7" args="(pANTLR3_INPUT_STREAM input, pANTLR3_UINT8 fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_API <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> antlr3readAscii </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#a95c800abcac5d607fd9e3e775ace78c5">pANTLR3_UINT8</a> </td>
<td class="paramname"><em>fileName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="antlr3errors_8h.html#a0f6bf04a7df727ea3d266ce0764d6573">ANTLR3_ERR_NOFILE</a>, <a class="el" href="antlr3errors_8h.html#abbdcaff3e5d4da9691443e7ecdb671bf">ANTLR3_ERR_NOMEM</a>, <a class="el" href="antlr3defs_8h.html#a3ba818e88ae972c4f77e55e80ed8abd5">ANTLR3_MALLOC</a>, <a class="el" href="antlr3errors_8h.html#a7820810a680eaeb12344ec6f3dbecdde">ANTLR3_SUCCESS</a>, <a class="el" href="antlr3errors_8h.html#a8cfcfbce03f3039eb35d87f97105dc1b">ANTLR3_TRUE</a>, <a class="el" href="antlr3filestream_8c.html#a1e94b56e2eb94d1868f171fac82506e3">antlr3Fclose()</a>, <a class="el" href="antlr3filestream_8c.html#a2bd0116a11ccc7a0d5badc301d34cb70">antlr3Fopen()</a>, <a class="el" href="antlr3filestream_8c.html#a2d7d39a2ac3aa6cd29e1864ef650296d">antlr3Fread()</a>, <a class="el" href="antlr3filestream_8c.html#a2b59652a7427bad64918a79a01ca8245">antlr3Fsize()</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#a6fb47df51fb05073a1d38877d6f0f16d">ANTLR3_INPUT_STREAM_struct::isAllocated</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#ae3b592e8fc40f7576b8ffd2125e26bb3">ANTLR3_INPUT_STREAM_struct::sizeBuf</a>.</p>
<p>Referenced by <a class="el" href="antlr3defs_8h.html#a449abcf6642288f35bacc3aae39c0ff6">antlr3AsciiFileStreamNew()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_cgraph.png" border="0" usemap="#antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_cgraph" alt=""/></div>
<map name="antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_cgraph" id="antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_cgraph">
<area shape="rect" id="node3" href="antlr3filestream_8c.html#a1e94b56e2eb94d1868f171fac82506e3" title="Close an operating system file and free any handles etc." alt="" coords="228,5,369,32"/><area shape="rect" id="node5" href="antlr3filestream_8c.html#a2bd0116a11ccc7a0d5badc301d34cb70" title="Open an operating system file and return the descriptor We just use the common open() and related fun..." alt="" coords="233,56,364,83"/><area shape="rect" id="node7" href="antlr3filestream_8c.html#a2d7d39a2ac3aa6cd29e1864ef650296d" title="antlr3Fread" alt="" coords="233,107,364,133"/><area shape="rect" id="node9" href="antlr3filestream_8c.html#a2b59652a7427bad64918a79a01ca8245" title="antlr3Fsize" alt="" coords="233,157,364,184"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_icgraph.png" border="0" usemap="#antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_icgraph" alt=""/></div>
<map name="antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_icgraph" id="antlr3filestream_8c_a855396d7279b462915e7e3830c8d17d7_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="228,5,489,32"/></map>
</div>
</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="antlr3filestream_8c.html">antlr3filestream.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>
