<!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/antlr3filestream.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('antlr3filestream_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>antlr3filestream.h File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3filestream.h:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3filestream_8h__incl.png" border="0" usemap="#include_2antlr3filestream_8h" alt=""/></div>
<map name="include_2antlr3filestream_8h" id="include_2antlr3filestream_8h">
<area shape="rect" id="node3" href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime." alt="" coords="439,80,580,107"/><area shape="rect" id="node5" href="antlr3errors_8h.html" title="antlr3errors.h" alt="" coords="5,155,168,181"/><area shape="rect" id="node11" href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes." alt="" coords="493,155,696,181"/><area shape="rect" id="node13" href="antlr3convertutf_8h.html" title="antlr3convertutf.h" alt="" coords="720,155,923,181"/></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="antlr3filestream_8h__dep__incl.png" border="0" usemap="#include_2antlr3filestream_8hdep" alt=""/></div>
<map name="include_2antlr3filestream_8hdep" id="include_2antlr3filestream_8hdep">
<area shape="rect" id="node3" href="antlr3_8h.html" title="include/antlr3.h" alt="" coords="56,80,237,107"/></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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3filestream_8h.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_8h.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_8h.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_8h.html#a54e345f44d2737076667400fe2649486">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_8h.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/><h2>Function Documentation</h2>
<a class="anchor" id="a1e94b56e2eb94d1868f171fac82506e3"></a><!-- doxytag: member="antlr3filestream.h::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_8h_a1e94b56e2eb94d1868f171fac82506e3_icgraph.png" border="0" usemap="#antlr3filestream_8h_a1e94b56e2eb94d1868f171fac82506e3_icgraph" alt=""/></div>
<map name="antlr3filestream_8h_a1e94b56e2eb94d1868f171fac82506e3_icgraph" id="antlr3filestream_8h_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.h::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_8h_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph.png" border="0" usemap="#antlr3filestream_8h_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph" alt=""/></div>
<map name="antlr3filestream_8h_a2bd0116a11ccc7a0d5badc301d34cb70_icgraph" id="antlr3filestream_8h_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.h::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_8h_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph.png" border="0" usemap="#antlr3filestream_8h_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph" alt=""/></div>
<map name="antlr3filestream_8h_a2d7d39a2ac3aa6cd29e1864ef650296d_icgraph" id="antlr3filestream_8h_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="a54e345f44d2737076667400fe2649486"></a><!-- doxytag: member="antlr3filestream.h::antlr3Fsize" ref="a54e345f44d2737076667400fe2649486" 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_8h_a54e345f44d2737076667400fe2649486_icgraph.png" border="0" usemap="#antlr3filestream_8h_a54e345f44d2737076667400fe2649486_icgraph" alt=""/></div>
<map name="antlr3filestream_8h_a54e345f44d2737076667400fe2649486_icgraph" id="antlr3filestream_8h_a54e345f44d2737076667400fe2649486_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.h::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_8h_a855396d7279b462915e7e3830c8d17d7_cgraph.png" border="0" usemap="#antlr3filestream_8h_a855396d7279b462915e7e3830c8d17d7_cgraph" alt=""/></div>
<map name="antlr3filestream_8h_a855396d7279b462915e7e3830c8d17d7_cgraph" id="antlr3filestream_8h_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_8h_a855396d7279b462915e7e3830c8d17d7_icgraph.png" border="0" usemap="#antlr3filestream_8h_a855396d7279b462915e7e3830c8d17d7_icgraph" alt=""/></div>
<map name="antlr3filestream_8h_a855396d7279b462915e7e3830c8d17d7_icgraph" id="antlr3filestream_8h_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_8h.html">antlr3filestream.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>
