diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-11-27 01:44:46 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-11-27 01:44:46 +0000 |
| commit | cd9f9a8add02597a2998ba74b803ed3fbf81314c (patch) | |
| tree | b53e3ea035c25a0580e9b31dc31f27ee33c36c96 /docs/module-doc/classFileReader.html | |
| parent | 91755849c3bdf089f4583c119fcbb90ff99bed5b (diff) | |
Added new documentation
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classFileReader.html')
| -rw-r--r-- | docs/module-doc/classFileReader.html | 249 |
1 files changed, 121 insertions, 128 deletions
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 3e69fe2d0..6141b3c73 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -1,77 +1,76 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>InspIRCd: FileReader class Reference</title> +<title>InspIRCd: FileReader Class Reference</title> <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.3.3 --> -<div class="qindex"><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="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> -<h1>FileReader Class Reference</h1>Caches a text file into memory and can be used to retrieve lines from it. +<!-- Generated by Doxygen 1.4.4-20050815 --> +<div class="qindex"><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">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>FileReader Class Reference</h1><!-- doxytag: class="FileReader" --><!-- doxytag: inherits="classbase" -->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> 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="12,7,92,34" alt=""> +<area href="classclassbase.html" shape="rect" coords="11,7,91,34" alt=""> </map> <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="8,98,88,125" alt=""> +<area href="classclassbase.html" shape="rect" coords="7,97,87,124" 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> +<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 Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a0">FileReader</a> ()</td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#FileReader_28_29">FileReader</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. </em> <a href="#a0"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a1">FileReader</a> (std::string filename)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#FileReader_28_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#FileReader_28std_3A_3Astring_20filename_29">FileReader</a> (<a class="el" href="namespaceirc.html#string">std::string</a> filename)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Secondary constructor. </em> <a href="#a1"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a2">~FileReader</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Secondary constructor. <a href="#FileReader_28std_3A_3Astring_20filename_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#_7EFileReader_28_29">~FileReader</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. </em> <a href="#a2"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a3">LoadFile</a> (std::string filename)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#_7EFileReader_28_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#LoadFile_28std_3A_3Astring_20filename_29">LoadFile</a> (<a class="el" href="namespaceirc.html#string">std::string</a> filename)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to load a file. </em> <a href="#a3"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a4">Exists</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to load a file. <a href="#LoadFile_28std_3A_3Astring_20filename_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#Exists_28_29">Exists</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the file exists This function will return false if the file could not be opened. </em> <a href="#a4"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a5">GetLine</a> (int x)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the file exists This function will return false if the file could not be opened. <a href="#Exists_28_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#GetLine_28int_20x_29">GetLine</a> (int x)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve one line from the file. </em> <a href="#a5"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#a6">FileSize</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve one line from the file. <a href="#GetLine_28int_20x_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#FileSize_28_29">FileSize</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the file in lines. </em> <a href="#a6"></a><em><br><br></td></tr> -<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="modules_8h.html#a31">file_cache</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html#r0">fc</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the file in lines. <a href="#FileSize_28_29"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="modules_8h.html#file_5Fcache">file_cache</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileReader.html#fc">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> -This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. +This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l01239">1239</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 class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +Definition at line <a class="el" href="modules_8h-source.html#l01210">1210</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="FileReader_28_29"></a><!-- doxytag: member="FileReader::FileReader" ref="FileReader_28_29" args="()" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> FileReader::FileReader </td> + <td class="md" nowrap valign="top">FileReader::FileReader </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> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -83,32 +82,31 @@ Default constructor. <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#l00975">975</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#l00950">950</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00951"></a>00951 { +<a name="l00952"></a>00952 } +</pre></div> <p> -<div class="fragment"><pre>00976 { -00977 } -</pre></div> </td> + </td> </tr> </table> -<a name="a1" doxytag="FileReader::FileReader"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="FileReader_28std_3A_3Astring_20filename_29"></a><!-- doxytag: member="FileReader::FileReader" ref="FileReader_28std_3A_3Astring_20filename_29" args="(std::string filename)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> FileReader::FileReader </td> + <td class="md" nowrap valign="top">FileReader::FileReader </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td> <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> - </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -118,38 +116,37 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00975">975</a> <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#a6">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#FileSize_28_29">FileReader::FileSize</a> returns 0. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00968">968</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#l00943">943</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01241">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>. +References <a class="el" href="modules_8h-source.html#l01212">fc</a>.<div class="fragment"><pre class="fragment"><a name="l00944"></a>00944 { +<a name="l00945"></a>00945 <a class="code" href="modules_8h.html#file_5Fcache">file_cache</a> c; +<a name="l00946"></a>00946 readfile(c,filename.c_str()); +<a name="l00947"></a>00947 this-><a class="code" href="classFileReader.html#fc">fc</a> = c; +<a name="l00948"></a>00948 } +</pre></div> <p> -<div class="fragment"><pre>00969 { -00970 <a class="code" href="modules_8h.html#a31">file_cache</a> c; -00971 readfile(c,filename.c_str()); -00972 this-><a class="code" href="classFileReader.html#r0">fc</a> = c; -00973 } -</pre></div> </td> + </td> </tr> </table> -<a name="a2" doxytag="FileReader::~FileReader"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="_7EFileReader_28_29"></a><!-- doxytag: member="FileReader::~FileReader" ref="_7EFileReader_28_29" args="()" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> FileReader::~<a class="el" href="classFileReader.html">FileReader</a> </td> + <td class="md" nowrap valign="top">FileReader::~FileReader </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> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -161,32 +158,31 @@ Default destructor. <p> This deletes the memory allocated to the file. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00987">987</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#l00962">962</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00963"></a>00963 { +<a name="l00964"></a>00964 } +</pre></div> <p> -<div class="fragment"><pre>00988 { -00989 } -</pre></div> </td> + </td> </tr> </table> <hr><h2>Member Function Documentation</h2> -<a name="a4" doxytag="FileReader::Exists"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="Exists_28_29"></a><!-- doxytag: member="FileReader::Exists" ref="Exists_28_29" args="()" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> bool FileReader::Exists </td> + <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> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -198,41 +194,40 @@ Returns true if the file exists This function will return false if the file coul <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00991">991</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l01241">fc</a>. -<p> -<div class="fragment"><pre>00992 { -00993 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0) -00994 { -00995 <span class="keywordflow">return</span>(<span class="keyword">false</span>); -00996 } -00997 <span class="keywordflow">else</span> -00998 { -00999 <span class="keywordflow">return</span>(<span class="keyword">true</span>); -01000 } -01001 } -</pre></div> </td> +Definition at line <a class="el" href="modules_8cpp-source.html#l00966">966</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01212">fc</a>.<div class="fragment"><pre class="fragment"><a name="l00967"></a>00967 { +<a name="l00968"></a>00968 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#fc">fc</a>.size() == 0) +<a name="l00969"></a>00969 { +<a name="l00970"></a>00970 <span class="keywordflow">return</span>(<span class="keyword">false</span>); +<a name="l00971"></a>00971 } +<a name="l00972"></a>00972 <span class="keywordflow">else</span> +<a name="l00973"></a>00973 { +<a name="l00974"></a>00974 <span class="keywordflow">return</span>(<span class="keyword">true</span>); +<a name="l00975"></a>00975 } +<a name="l00976"></a>00976 } +</pre></div> +<p> + </td> </tr> </table> -<a name="a6" doxytag="FileReader::FileSize"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="FileSize_28_29"></a><!-- doxytag: member="FileReader::FileSize" ref="FileSize_28_29" args="()" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> int FileReader::FileSize </td> + <td class="md" nowrap valign="top">int FileReader::FileSize </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> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -244,35 +239,34 @@ Returns the size of the file in lines. <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#l01010">1010</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#l00985">985</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01241">fc</a>. +References <a class="el" href="modules_8h-source.html#l01212">fc</a>.<div class="fragment"><pre class="fragment"><a name="l00986"></a>00986 { +<a name="l00987"></a>00987 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#fc">fc</a>.size(); +<a name="l00988"></a>00988 } +</pre></div> <p> -<div class="fragment"><pre>01011 { -01012 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size(); -01013 } -</pre></div> </td> + </td> </tr> </table> -<a name="a5" doxytag="FileReader::GetLine"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="GetLine_28int_20x_29"></a><!-- doxytag: member="FileReader::GetLine" ref="GetLine_28int_20x_29" args="(int x)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::string FileReader::GetLine </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> 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 class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> - </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -284,37 +278,36 @@ 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#l01003">1003</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#l00978">978</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01241">fc</a>. +References <a class="el" href="modules_8h-source.html#l01212">fc</a>.<div class="fragment"><pre class="fragment"><a name="l00979"></a>00979 { +<a name="l00980"></a>00980 <span class="keywordflow">if</span> ((x<0) || ((<span class="keywordtype">unsigned</span>)x><a class="code" href="classFileReader.html#fc">fc</a>.size())) +<a name="l00981"></a>00981 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; +<a name="l00982"></a>00982 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#fc">fc</a>[x]; +<a name="l00983"></a>00983 } +</pre></div> <p> -<div class="fragment"><pre>01004 { -01005 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#r0">fc</a>.size())) -01006 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -01007 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x]; -01008 } -</pre></div> </td> + </td> </tr> </table> -<a name="a3" doxytag="FileReader::LoadFile"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="LoadFile_28std_3A_3Astring_20filename_29"></a><!-- doxytag: member="FileReader::LoadFile" ref="LoadFile_28std_3A_3Astring_20filename_29" args="(std::string filename)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> void FileReader::LoadFile </td> + <td class="md" nowrap valign="top">void FileReader::LoadFile </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td> <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> - </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -324,33 +317,34 @@ References <a class="el" href="modules_8h-source.html#l01241">fc</a>. <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#a6">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#FileSize_28_29">FileReader::FileSize</a> returns 0. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00979">979</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#l00954">954</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01241">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>. +References <a class="el" href="modules_8h-source.html#l01212">fc</a>.<div class="fragment"><pre class="fragment"><a name="l00955"></a>00955 { +<a name="l00956"></a>00956 <a class="code" href="modules_8h.html#file_5Fcache">file_cache</a> c; +<a name="l00957"></a>00957 readfile(c,filename.c_str()); +<a name="l00958"></a>00958 this-><a class="code" href="classFileReader.html#fc">fc</a> = c; +<a name="l00959"></a>00959 } +</pre></div> <p> -<div class="fragment"><pre>00980 { -00981 <a class="code" href="modules_8h.html#a31">file_cache</a> c; -00982 readfile(c,filename.c_str()); -00983 this-><a class="code" href="classFileReader.html#r0">fc</a> = c; -00984 } -</pre></div> </td> + </td> </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="r0" doxytag="FileReader::fc"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="fc"></a><!-- doxytag: member="FileReader::fc" ref="fc" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a31">file_cache</a> <a class="el" href="classFileReader.html#r0">FileReader::fc</a><code> [private]</code> + <td class="md" nowrap valign="top"><a class="el" href="modules_8h.html#file_5Fcache">file_cache</a> <a class="el" href="classFileReader.html#fc">FileReader::fc</a><code> [private]</code> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -360,16 +354,15 @@ References <a class="el" href="modules_8h-source.html#l01241">fc</a>, and <a cla <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l01241">1241</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#l01212">1212</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#l00991">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00968">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l01010">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l01003">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00979">LoadFile()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00966">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00943">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00985">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00978">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00954">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 size="1"><address style="align: right;"><small>Generated on Mon May 30 05:17:01 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border=0 > -</a>1.3.3 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> </html> |