<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>FileReader class Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.3-rc2 -->
+<!-- Generated by Doxygen 1.3-rc3 -->
<center>
-<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
+<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="
namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>FileReader Class Reference</h1>Caches a text file into memory and can be used to retrieve lines from it.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code>
<p>
-<p>Inheritance diagram for FileReader:
-<p><center><img src="classFileReader.png" usemap="#FileReader_map" border="0" alt=""></center>
-<map name="FileReader_map">
-<area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,74,24">
+Inheritance diagram for FileReader:<p><center><img src="classFileReader__inherit__graph.gif" border="0" usemap="#FileReader__inherit__map" alt="Inheritance graph"></center>
+<map name="FileReader__inherit__map">
+<area href="classclassbase.html" shape="rect" coords="11,16,77,37" alt="">
</map>
-<a href="classFileReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for FileReader:<p><center><img src="classFileReader__coll__graph.gif" border="0" usemap="#FileReader__coll__map" alt="Collaboration graph"></center>
+<map name="FileReader__coll__map">
+<area href="classclassbase.html" shape="rect" coords="7,107,73,128" alt="">
+</map>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classFileReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
-<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classFileReader.html#a0">FileReader</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classFileReader.html#a1">FileReader</a> (string filename)</td></tr>
+<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classFileReader.html#a1">FileReader</a> (std::string filename)</td></tr>
<tr><td> </td><td><font size=-1><em>Secondary constructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classFileReader.html#a2">~FileReader</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default destructor.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classFileReader.html#a3">LoadFile</a> (string filename)</td></tr>
+<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classFileReader.html#a3">LoadFile</a> (std::string filename)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to load a file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>string </td><td valign=bottom><a class="el" href="classFileReader.html#a4">GetLine</a> (int x)</td></tr>
+<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classFileReader.html#a4">Exists</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieve one line from the file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classFileReader.html#a5">FileSize</a> ()</td></tr>
-<tr><td> </td><td><font size=-1><em>Returns the size of the file in lines.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classFileReader.html#a5">GetLine</a> (int x)</td></tr>
+<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classFileReader.html#a6">FileSize</a> ()</td></tr>
+<tr><td> </td><td><font size=-1><em>Returns the size of the file in lines.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a class="el" href="modules_8h.html#a1">file_cache</a> </td><td valign=bottom><a class="el" href="classFileReader.html#o0">fc</a></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="modules_8h.html#a1
0">file_cache</a> </td><td valign=bottom><a class="el" href="classFileReader.html#o0">fc</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Caches a text file into memory and can be used to retrieve lines from it.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00
282">282</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
+Definition at line <a class="el" href="modules_8h-source.html#l00
493">493</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="FileReader::FileReader"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<p>
This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
205">205</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00
336">336</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00206 {
-00207 }
+<div class="fragment"><pre>00337 {
+00338 }
</pre></div> </td>
</tr>
</table>
<tr>
<td class="md" nowrap valign="top"> FileReader::FileReader </td>
<td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">string </td>
+ <td class="md" nowrap valign="top">std::string </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
<p>
Secondary constructor.
<p>
-This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a5">FileReader::FileSize</a> returns 0.
+This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
198">198</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00
329">329</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00284">fc</a>, and <a class="el" href="modules_8h-source.html#l00049">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
<p>
-<div class="fragment"><pre>00199 {
-00200 <a class="code" href="modules_8h.html#a1">file_cache</a> c;
-00201 readfile(c,filename.c_str());
-00
202 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
-00203 }
+<div class="fragment"><pre>00330 {
+00331 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00332 readfile(c,filename.c_str());
+00
333 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
+00334 }
</pre></div> </td>
</tr>
</table>
<p>
This deletes the memory allocated to the file.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
216">216</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00
348">348</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00217 {
-00218 }
+<div class="fragment"><pre>00349 {
+00350 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
-<a name="a5" doxytag="FileReader::FileSize"></a><p>
+<a name="a4" doxytag="FileReader::Exists"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool FileReader::Exists </td>
+ <td class="md" valign="top">( </td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">) </td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Retrieve one line from the file.
+<p>
+This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
+<p>
+Definition at line <a class="el" href="modules_8cpp-source.html#l00352">352</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>.
+<p>
+<div class="fragment"><pre>00353 {
+00354 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
+00355 {
+00356 <span class="keywordflow">return</span>(false);
+00357 }
+00358 <span class="keywordflow">else</span>
+00359 {
+00360 <span class="keywordflow">return</span>(true);
+00361 }
+00362 }
+</pre></div> </td>
+ </tr>
+</table>
+<a name="a6" doxytag="FileReader::FileSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<p>
This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
227">227</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00
371">371</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00284">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>.
<p>
-<div class="fragment"><pre>00228 {
-00
229 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
-00230 }
+<div class="fragment"><pre>00372 {
+00
373 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
+00374 }
</pre></div> </td>
</tr>
</table>
-<a name="a
4" doxytag="FileReader::GetLine"></a><p>
+<a name="a
5" doxytag="FileReader::GetLine"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
- <td class="md" nowrap valign="top"> string FileReader::GetLine </td>
+ <td class="md" nowrap valign="top"> std::string FileReader::GetLine </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>x</em> </td>
<td>
<p>
-Retrieve one line from the file.
-<p>
-This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
+
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
220">220</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00
364">364</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00284">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>.
<p>
-<div class="fragment"><pre>00221 {
-00
222 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size()))
-00223 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-00
224 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
-00225 }
+<div class="fragment"><pre>00365 {
+00
366 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size()))
+00367 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+00
368 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
+00369 }
</pre></div> </td>
</tr>
</table>
<tr>
<td class="md" nowrap valign="top"> void FileReader::LoadFile </td>
<td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">string </td>
+ <td class="md" nowrap valign="top">std::string </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
<p>
Used to load a file.
<p>
-This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a5">FileReader::FileSize</a> returns 0.
+This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
209">209</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00
340">340</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00284">fc</a>, and <a class="el" href="modules_8h-source.html#l00049">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
<p>
-<div class="fragment"><pre>00210 {
-00211 <a class="code" href="modules_8h.html#a1">file_cache</a> c;
-00212 readfile(c,filename.c_str());
-00
213 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
-00214 }
+<div class="fragment"><pre>00341 {
+00342 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00343 readfile(c,filename.c_str());
+00
344 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
+00345 }
</pre></div> </td>
</tr>
</table>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
- <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a1">file_cache</a> FileReader::fc<code> [private]</code>
+ <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a10">file_cache</a> FileReader::fc<code> [private]</code>
</table>
</td>
</tr>
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00
284">284</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l00
495">495</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00198">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00227">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00220">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00209">LoadFile()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00352">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00329">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00371">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00364">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00340">LoadFile()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
-<hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:42 2003 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Tue Apr 6 21:13:59 2004 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
-width=110 height=53></a>1.3-rc2 </small></address>
+width=110 height=53></a>1.3-rc3 </small></address>
</body>
</html>
projects / user / henk / code / inspircd.git / blobdiff