docs/module-doc/classConfigReader.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: ConfigReader Class Reference</title>
   4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ConfigReader Class Reference</h1><!-- doxytag: class="ConfigReader" --><!-- doxytag: inherits="classbase" -->Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  12 <p>
  13 Inheritance diagram for ConfigReader:<p><center><img src="classConfigReader__inherit__graph.gif" border="0" usemap="#ConfigReader__inherit__map" alt="Inheritance graph"></center>
  14 <map name="ConfigReader__inherit__map">
  15 <area href="classclassbase.html" shape="rect" coords="19,7,99,34" alt="">
  16 </map>
  17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ConfigReader:<p><center><img src="classConfigReader__coll__graph.gif" border="0" usemap="#ConfigReader__coll__map" alt="Collaboration graph"></center>
  18 <map name="ConfigReader__coll__map">
  19 <area href="classclassbase.html" shape="rect" coords="7,97,87,124" alt="">
  20 </map>
  21 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classConfigReader-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  22 <tr><td></td></tr>
  23 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  24 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#ConfigReader_28_29">ConfigReader</a> ()</td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#ConfigReader_28_29"></a><br></td></tr>
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#ConfigReader_28std_3A_3Astring_20filename_29">ConfigReader</a> (<a class="el" href="namespaceirc.html#string">std::string</a> filename)</td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor.  <a href="#ConfigReader_28std_3A_3Astring_20filename_29"></a><br></td></tr>
  30 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#_7EConfigReader_28_29">~ConfigReader</a> ()</td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#_7EConfigReader_28_29"></a><br></td></tr>
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29">ReadValue</a> (<a class="el" href="namespaceirc.html#string">std::string</a> tag, <a class="el" href="namespaceirc.html#string">std::string</a> name, int index)</td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a value from the config file.  <a href="#ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29"></a><br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#ReadFlag_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29">ReadFlag</a> (<a class="el" href="namespaceirc.html#string">std::string</a> tag, <a class="el" href="namespaceirc.html#string">std::string</a> name, int index)</td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a boolean value from the config file.  <a href="#ReadFlag_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29"></a><br></td></tr>
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#ReadInteger_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_2C_20bool_20needs_5Funsigned_29">ReadInteger</a> (<a class="el" href="namespaceirc.html#string">std::string</a> tag, <a class="el" href="namespaceirc.html#string">std::string</a> name, int index, bool needs_unsigned)</td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an integer value from the config file.  <a href="#ReadInteger_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_2C_20bool_20needs_5Funsigned_29"></a><br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#GetError_28_29">GetError</a> ()</td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the last error to occur.  <a href="#GetError_28_29"></a><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#Enumerate_28std_3A_3Astring_20tag_29">Enumerate</a> (<a class="el" href="namespaceirc.html#string">std::string</a> tag)</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Counts the number of times a given tag appears in the config file.  <a href="#Enumerate_28std_3A_3Astring_20tag_29"></a><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#Verify_28_29">Verify</a> ()</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if a config file is valid.  <a href="#Verify_28_29"></a><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#DumpErrors_28bool_20bail_2C_20userrec_20_2Auser_29">DumpErrors</a> (bool bail, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dumps the list of errors in a config file to an output location.  <a href="#DumpErrors_28bool_20bail_2C_20userrec_20_2Auser_29"></a><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#EnumerateValues_28std_3A_3Astring_20tag_2C_20int_20index_29">EnumerateValues</a> (<a class="el" href="namespaceirc.html#string">std::string</a> tag, int index)</td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of items within a tag.  <a href="#EnumerateValues_28std_3A_3Astring_20tag_2C_20int_20index_29"></a><br></td></tr>
  57 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
  58 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::stringstream *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#cache">cache</a></td></tr>
  59
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).  <a href="#cache"></a><br></td></tr>
  61 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::stringstream *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#errorlog">errorlog</a></td></tr>
  62
  63 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#readerror">readerror</a></td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to store errors.  <a href="#readerror"></a><br></td></tr>
  66 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConfigReader.html#error">error</a></td></tr>
  67
  68 </table>
  69 <hr><a name="_details"></a><h2>Detailed Description</h2>
  70 Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
  71 <p>
  72 It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.
  73 <p>
  74
  75 <p>
  76 Definition at line <a class="el" href="modules_8h-source.html#l01550">1550</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  77 <a class="anchor" name="ConfigReader_28_29"></a><!-- doxytag: member="ConfigReader::ConfigReader" ref="ConfigReader_28_29" args="()" --><p>
  78 <table class="mdTable" cellpadding="2" cellspacing="0">
  79   <tr>
  80     <td class="mdRow">
  81       <table cellpadding="0" cellspacing="0" border="0">
  82         <tr>
  83           <td class="md" nowrap valign="top">ConfigReader::ConfigReader           </td>
  84           <td class="md" valign="top">(&nbsp;</td>
  85           <td class="mdname1" valign="top" nowrap>          </td>
  86           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  87           <td class="md" nowrap></td>
  88         </tr>
  89       </table>
  90     </td>
  91   </tr>
  92 </table>
  93 <table cellspacing="5" cellpadding="0" border="0">
  94   <tr>
  95     <td>
  96       &nbsp;
  97     </td>
  98     <td>
  99
 100 <p>
 101 Default constructor.
 102 <p>
 103 This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
 104 <p>
 105 Definition at line <a class="el" href="modules_8cpp-source.html#l00735">735</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 106 <p>
 107 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, <a class="el" href="classServerConfig.html#ClearStack_28_29">ServerConfig::ClearStack()</a>, <a class="el" href="modules_8h-source.html#l01541">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01563">error</a>, <a class="el" href="modules_8h-source.html#l01559">errorlog</a>, <a class="el" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">ServerConfig::LoadConf()</a>, and <a class="el" href="modules_8h-source.html#l01562">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00736"></a>00736 {
 108 <a name="l00737"></a>00737         <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ClearStack_28_29">ClearStack</a>();
 109 <a name="l00738"></a>00738         this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
 110 <a name="l00739"></a>00739         this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
 111 <a name="l00740"></a>00740         this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a> = <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">LoadConf</a>(CONFIG_FILE,this-&gt;cache,this-&gt;errorlog);
 112 <a name="l00741"></a>00741         <span class="keywordflow">if</span> (!this-&gt;readerror)
 113 <a name="l00742"></a>00742                 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>;
 114 <a name="l00743"></a>00743 }
 115 </pre></div>
 116 <p>
 117     </td>
 118   </tr>
 119 </table>
 120 <a class="anchor" name="ConfigReader_28std_3A_3Astring_20filename_29"></a><!-- doxytag: member="ConfigReader::ConfigReader" ref="ConfigReader_28std_3A_3Astring_20filename_29" args="(std::string filename)" --><p>
 121 <table class="mdTable" cellpadding="2" cellspacing="0">
 122   <tr>
 123     <td class="mdRow">
 124       <table cellpadding="0" cellspacing="0" border="0">
 125         <tr>
 126           <td class="md" nowrap valign="top">ConfigReader::ConfigReader           </td>
 127           <td class="md" valign="top">(&nbsp;</td>
 128           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 129           <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
 130           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 131           <td class="md" nowrap></td>
 132         </tr>
 133       </table>
 134     </td>
 135   </tr>
 136 </table>
 137 <table cellspacing="5" cellpadding="0" border="0">
 138   <tr>
 139     <td>
 140       &nbsp;
 141     </td>
 142     <td>
 143
 144 <p>
 145 Overloaded constructor.
 146 <p>
 147 This constructor initialises the ConfigReader class to read a user-specified config file
 148 <p>
 149 Definition at line <a class="el" href="modules_8cpp-source.html#l00755">755</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 150 <p>
 151 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, <a class="el" href="classServerConfig.html#ClearStack_28_29">ServerConfig::ClearStack()</a>, <a class="el" href="modules_8h-source.html#l01541">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01563">error</a>, <a class="el" href="modules_8h-source.html#l01559">errorlog</a>, <a class="el" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">ServerConfig::LoadConf()</a>, and <a class="el" href="modules_8h-source.html#l01562">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00756"></a>00756 {
 152 <a name="l00757"></a>00757         <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ClearStack_28_29">ClearStack</a>();
 153 <a name="l00758"></a>00758         this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
 154 <a name="l00759"></a>00759         this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
 155 <a name="l00760"></a>00760         this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a> = <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">LoadConf</a>(filename.c_str(),this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a>,this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a>);
 156 <a name="l00761"></a>00761         <span class="keywordflow">if</span> (!this-&gt;readerror)
 157 <a name="l00762"></a>00762                 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>;
 158 <a name="l00763"></a>00763 };
 159 </pre></div>
 160 <p>
 161     </td>
 162   </tr>
 163 </table>
 164 <a class="anchor" name="_7EConfigReader_28_29"></a><!-- doxytag: member="ConfigReader::~ConfigReader" ref="_7EConfigReader_28_29" args="()" --><p>
 165 <table class="mdTable" cellpadding="2" cellspacing="0">
 166   <tr>
 167     <td class="mdRow">
 168       <table cellpadding="0" cellspacing="0" border="0">
 169         <tr>
 170           <td class="md" nowrap valign="top">ConfigReader::~ConfigReader           </td>
 171           <td class="md" valign="top">(&nbsp;</td>
 172           <td class="mdname1" valign="top" nowrap>          </td>
 173           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 174           <td class="md" nowrap></td>
 175         </tr>
 176       </table>
 177     </td>
 178   </tr>
 179 </table>
 180 <table cellspacing="5" cellpadding="0" border="0">
 181   <tr>
 182     <td>
 183       &nbsp;
 184     </td>
 185     <td>
 186
 187 <p>
 188 Default destructor.
 189 <p>
 190 This method destroys the ConfigReader class.
 191 <p>
 192 Definition at line <a class="el" href="modules_8cpp-source.html#l00746">746</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 193 <p>
 194 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, and <a class="el" href="modules_8h-source.html#l01559">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00747"></a>00747 {
 195 <a name="l00748"></a>00748         <span class="keywordflow">if</span> (this-&gt;cache)
 196 <a name="l00749"></a>00749                 <span class="keyword">delete</span> this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a>;
 197 <a name="l00750"></a>00750         <span class="keywordflow">if</span> (this-&gt;errorlog)
 198 <a name="l00751"></a>00751                 <span class="keyword">delete</span> this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a>;
 199 <a name="l00752"></a>00752 }
 200 </pre></div>
 201 <p>
 202     </td>
 203   </tr>
 204 </table>
 205 <hr><h2>Member Function Documentation</h2>
 206 <a class="anchor" name="DumpErrors_28bool_20bail_2C_20userrec_20_2Auser_29"></a><!-- doxytag: member="ConfigReader::DumpErrors" ref="DumpErrors_28bool_20bail_2C_20userrec_20_2Auser_29" args="(bool bail, userrec *user)" --><p>
 207 <table class="mdTable" cellpadding="2" cellspacing="0">
 208   <tr>
 209     <td class="mdRow">
 210       <table cellpadding="0" cellspacing="0" border="0">
 211         <tr>
 212           <td class="md" nowrap valign="top">void ConfigReader::DumpErrors           </td>
 213           <td class="md" valign="top">(&nbsp;</td>
 214           <td class="md" nowrap valign="top">bool&nbsp;</td>
 215           <td class="mdname" nowrap> <em>bail</em>, </td>
 216         </tr>
 217         <tr>
 218           <td class="md" nowrap align="right"></td>
 219           <td class="md"></td>
 220           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 221           <td class="mdname" nowrap> <em>user</em></td>
 222         </tr>
 223         <tr>
 224           <td class="md"></td>
 225           <td class="md">)&nbsp;</td>
 226           <td class="md" colspan="2"></td>
 227         </tr>
 228       </table>
 229     </td>
 230   </tr>
 231 </table>
 232 <table cellspacing="5" cellpadding="0" border="0">
 233   <tr>
 234     <td>
 235       &nbsp;
 236     </td>
 237     <td>
 238
 239 <p>
 240 Dumps the list of errors in a config file to an output location.
 241 <p>
 242 If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.
 243 <p>
 244 Definition at line <a class="el" href="modules_8cpp-source.html#l00834">834</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 245 <p>
 246 References <a class="el" href="modules_8h-source.html#l01559">errorlog</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="users_8h-source.html#l00128">userrec::nick</a>, <a class="el" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers()</a>, and <a class="el" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ()</a>.<div class="fragment"><pre class="fragment"><a name="l00835"></a>00835 {
 247 <a name="l00836"></a>00836         <span class="keywordflow">if</span> (bail)
 248 <a name="l00837"></a>00837         {
 249 <a name="l00838"></a>00838                 printf(<span class="stringliteral">"There were errors in your configuration:\n%s"</span>,<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;str().c_str());
 250 <a name="l00839"></a>00839                 exit(0);
 251 <a name="l00840"></a>00840         }
 252 <a name="l00841"></a>00841         <span class="keywordflow">else</span>
 253 <a name="l00842"></a>00842         {
 254 <a name="l00843"></a>00843                 <span class="keywordtype">char</span> dataline[1024];
 255 <a name="l00844"></a>00844                 <span class="keywordflow">if</span> (user)
 256 <a name="l00845"></a>00845                 {
 257 <a name="l00846"></a>00846                         <a class="code" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ</a>(user-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :There were errors in the configuration file:"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
 258 <a name="l00847"></a>00847                         <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;eof())
 259 <a name="l00848"></a>00848                         {
 260 <a name="l00849"></a>00849                                 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;getline(dataline,1024);
 261 <a name="l00850"></a>00850                                 <a class="code" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ</a>(user-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :%s"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,dataline);
 262 <a name="l00851"></a>00851                         }
 263 <a name="l00852"></a>00852                 }
 264 <a name="l00853"></a>00853                 <span class="keywordflow">else</span>
 265 <a name="l00854"></a>00854                 {
 266 <a name="l00855"></a>00855                         <a class="code" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers</a>(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
 267 <a name="l00856"></a>00856                         <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;eof())
 268 <a name="l00857"></a>00857                         {
 269 <a name="l00858"></a>00858                                 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;getline(dataline,1024);
 270 <a name="l00859"></a>00859                                 <a class="code" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers</a>(dataline);
 271 <a name="l00860"></a>00860                         }
 272 <a name="l00861"></a>00861                 }
 273 <a name="l00862"></a>00862                 <span class="keywordflow">return</span>;
 274 <a name="l00863"></a>00863         }
 275 <a name="l00864"></a>00864 }
 276 </pre></div>
 277 <p>
 278     </td>
 279   </tr>
 280 </table>
 281 <a class="anchor" name="Enumerate_28std_3A_3Astring_20tag_29"></a><!-- doxytag: member="ConfigReader::Enumerate" ref="Enumerate_28std_3A_3Astring_20tag_29" args="(std::string tag)" --><p>
 282 <table class="mdTable" cellpadding="2" cellspacing="0">
 283   <tr>
 284     <td class="mdRow">
 285       <table cellpadding="0" cellspacing="0" border="0">
 286         <tr>
 287           <td class="md" nowrap valign="top">int ConfigReader::Enumerate           </td>
 288           <td class="md" valign="top">(&nbsp;</td>
 289           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 290           <td class="mdname1" valign="top" nowrap> <em>tag</em>          </td>
 291           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 292           <td class="md" nowrap></td>
 293         </tr>
 294       </table>
 295     </td>
 296   </tr>
 297 </table>
 298 <table cellspacing="5" cellpadding="0" border="0">
 299   <tr>
 300     <td>
 301       &nbsp;
 302     </td>
 303     <td>
 304
 305 <p>
 306 Counts the number of times a given tag appears in the config file.
 307 <p>
 308 This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of <a class="el" href="classConfigReader.html#ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29">ConfigReader::ReadValue</a> to loop through all copies of a multiple instance tag.
 309 <p>
 310 Definition at line <a class="el" href="modules_8cpp-source.html#l00867">867</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 311 <p>
 312 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, and <a class="el" href="classServerConfig.html#EnumConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_29">ServerConfig::EnumConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00868"></a>00868 {
 313 <a name="l00869"></a>00869         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#EnumConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_29">EnumConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str());
 314 <a name="l00870"></a>00870 }
 315 </pre></div>
 316 <p>
 317     </td>
 318   </tr>
 319 </table>
 320 <a class="anchor" name="EnumerateValues_28std_3A_3Astring_20tag_2C_20int_20index_29"></a><!-- doxytag: member="ConfigReader::EnumerateValues" ref="EnumerateValues_28std_3A_3Astring_20tag_2C_20int_20index_29" args="(std::string tag, int index)" --><p>
 321 <table class="mdTable" cellpadding="2" cellspacing="0">
 322   <tr>
 323     <td class="mdRow">
 324       <table cellpadding="0" cellspacing="0" border="0">
 325         <tr>
 326           <td class="md" nowrap valign="top">int ConfigReader::EnumerateValues           </td>
 327           <td class="md" valign="top">(&nbsp;</td>
 328           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 329           <td class="mdname" nowrap> <em>tag</em>, </td>
 330         </tr>
 331         <tr>
 332           <td class="md" nowrap align="right"></td>
 333           <td class="md"></td>
 334           <td class="md" nowrap>int&nbsp;</td>
 335           <td class="mdname" nowrap> <em>index</em></td>
 336         </tr>
 337         <tr>
 338           <td class="md"></td>
 339           <td class="md">)&nbsp;</td>
 340           <td class="md" colspan="2"></td>
 341         </tr>
 342       </table>
 343     </td>
 344   </tr>
 345 </table>
 346 <table cellspacing="5" cellpadding="0" border="0">
 347   <tr>
 348     <td>
 349       &nbsp;
 350     </td>
 351     <td>
 352
 353 <p>
 354 Returns the number of items within a tag.
 355 <p>
 356 For example if the tag was &lt;test tag="blah" data="foo"&gt; then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
 357 <p>
 358 Definition at line <a class="el" href="modules_8cpp-source.html#l00872">872</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 359 <p>
 360 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, and <a class="el" href="classServerConfig.html#EnumValues_28std_3A_3Astringstream_20_2Aconfig_2C_20const_20char_20_2Atag_2C_20int_20index_29">ServerConfig::EnumValues()</a>.<div class="fragment"><pre class="fragment"><a name="l00873"></a>00873 {
 361 <a name="l00874"></a>00874         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#EnumValues_28std_3A_3Astringstream_20_2Aconfig_2C_20const_20char_20_2Atag_2C_20int_20index_29">EnumValues</a>(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index);
 362 <a name="l00875"></a>00875 }
 363 </pre></div>
 364 <p>
 365     </td>
 366   </tr>
 367 </table>
 368 <a class="anchor" name="GetError_28_29"></a><!-- doxytag: member="ConfigReader::GetError" ref="GetError_28_29" args="()" --><p>
 369 <table class="mdTable" cellpadding="2" cellspacing="0">
 370   <tr>
 371     <td class="mdRow">
 372       <table cellpadding="0" cellspacing="0" border="0">
 373         <tr>
 374           <td class="md" nowrap valign="top">long ConfigReader::GetError           </td>
 375           <td class="md" valign="top">(&nbsp;</td>
 376           <td class="mdname1" valign="top" nowrap>          </td>
 377           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 378           <td class="md" nowrap></td>
 379         </tr>
 380       </table>
 381     </td>
 382   </tr>
 383 </table>
 384 <table cellspacing="5" cellpadding="0" border="0">
 385   <tr>
 386     <td>
 387       &nbsp;
 388     </td>
 389     <td>
 390
 391 <p>
 392 Returns the last error to occur.
 393 <p>
 394 Valid errors can be found by looking in <a class="el" href="modules_8h.html">modules.h</a>. Any nonzero value indicates an error condition. A call to <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> resets the error flag back to 0.
 395 <p>
 396 Definition at line <a class="el" href="modules_8cpp-source.html#l00827">827</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 397 <p>
 398 References <a class="el" href="modules_8h-source.html#l01563">error</a>.<div class="fragment"><pre class="fragment"><a name="l00828"></a>00828 {
 399 <a name="l00829"></a>00829         <span class="keywordtype">long</span> olderr = this-&gt;<a class="code" href="classConfigReader.html#error">error</a>;
 400 <a name="l00830"></a>00830         this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = 0;
 401 <a name="l00831"></a>00831         <span class="keywordflow">return</span> olderr;
 402 <a name="l00832"></a>00832 }
 403 </pre></div>
 404 <p>
 405     </td>
 406   </tr>
 407 </table>
 408 <a class="anchor" name="ReadFlag_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29"></a><!-- doxytag: member="ConfigReader::ReadFlag" ref="ReadFlag_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29" args="(std::string tag, std::string name, int index)" --><p>
 409 <table class="mdTable" cellpadding="2" cellspacing="0">
 410   <tr>
 411     <td class="mdRow">
 412       <table cellpadding="0" cellspacing="0" border="0">
 413         <tr>
 414           <td class="md" nowrap valign="top">bool ConfigReader::ReadFlag           </td>
 415           <td class="md" valign="top">(&nbsp;</td>
 416           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 417           <td class="mdname" nowrap> <em>tag</em>, </td>
 418         </tr>
 419         <tr>
 420           <td class="md" nowrap align="right"></td>
 421           <td class="md"></td>
 422           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 423           <td class="mdname" nowrap> <em>name</em>, </td>
 424         </tr>
 425         <tr>
 426           <td class="md" nowrap align="right"></td>
 427           <td class="md"></td>
 428           <td class="md" nowrap>int&nbsp;</td>
 429           <td class="mdname" nowrap> <em>index</em></td>
 430         </tr>
 431         <tr>
 432           <td class="md"></td>
 433           <td class="md">)&nbsp;</td>
 434           <td class="md" colspan="2"></td>
 435         </tr>
 436       </table>
 437     </td>
 438   </tr>
 439 </table>
 440 <table cellspacing="5" cellpadding="0" border="0">
 441   <tr>
 442     <td>
 443       &nbsp;
 444     </td>
 445     <td>
 446
 447 <p>
 448 Retrieves a boolean value from the config file.
 449 <p>
 450 This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" and "true" in the config file count as true to ReadFlag, and any other value counts as false.
 451 <p>
 452 Definition at line <a class="el" href="modules_8cpp-source.html#l00781">781</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 453 <p>
 454 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, <a class="el" href="modules_8h-source.html#l01540">CONF_VALUE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01563">error</a>, and <a class="el" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ServerConfig::ReadConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00782"></a>00782 {
 455 <a name="l00783"></a>00783         <span class="keywordtype">char</span> val[MAXBUF];
 456 <a name="l00784"></a>00784         <span class="keywordtype">char</span> t[MAXBUF];
 457 <a name="l00785"></a>00785         <span class="keywordtype">char</span> n[MAXBUF];
 458 <a name="l00786"></a>00786         strlcpy(t,tag.c_str(),MAXBUF);
 459 <a name="l00787"></a>00787         strlcpy(n,name.c_str(),MAXBUF);
 460 <a name="l00788"></a>00788         <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
 461 <a name="l00789"></a>00789         <span class="keywordflow">if</span> (!res)
 462 <a name="l00790"></a>00790         {
 463 <a name="l00791"></a>00791                 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
 464 <a name="l00792"></a>00792                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
 465 <a name="l00793"></a>00793         }
 466 <a name="l00794"></a>00794         <a class="code" href="namespaceirc.html#string">std::string</a> s = val;
 467 <a name="l00795"></a>00795         <span class="keywordflow">return</span> ((s == <span class="stringliteral">"yes"</span>) || (s == <span class="stringliteral">"YES"</span>) || (s == <span class="stringliteral">"true"</span>) || (s == <span class="stringliteral">"TRUE"</span>) || (s == <span class="stringliteral">"1"</span>));
 468 <a name="l00796"></a>00796 }
 469 </pre></div>
 470 <p>
 471     </td>
 472   </tr>
 473 </table>
 474 <a class="anchor" name="ReadInteger_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_2C_20bool_20needs_5Funsigned_29"></a><!-- doxytag: member="ConfigReader::ReadInteger" ref="ReadInteger_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_2C_20bool_20needs_5Funsigned_29" args="(std::string tag, std::string name, int index, bool needs_unsigned)" --><p>
 475 <table class="mdTable" cellpadding="2" cellspacing="0">
 476   <tr>
 477     <td class="mdRow">
 478       <table cellpadding="0" cellspacing="0" border="0">
 479         <tr>
 480           <td class="md" nowrap valign="top">long ConfigReader::ReadInteger           </td>
 481           <td class="md" valign="top">(&nbsp;</td>
 482           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 483           <td class="mdname" nowrap> <em>tag</em>, </td>
 484         </tr>
 485         <tr>
 486           <td class="md" nowrap align="right"></td>
 487           <td class="md"></td>
 488           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 489           <td class="mdname" nowrap> <em>name</em>, </td>
 490         </tr>
 491         <tr>
 492           <td class="md" nowrap align="right"></td>
 493           <td class="md"></td>
 494           <td class="md" nowrap>int&nbsp;</td>
 495           <td class="mdname" nowrap> <em>index</em>, </td>
 496         </tr>
 497         <tr>
 498           <td class="md" nowrap align="right"></td>
 499           <td class="md"></td>
 500           <td class="md" nowrap>bool&nbsp;</td>
 501           <td class="mdname" nowrap> <em>needs_unsigned</em></td>
 502         </tr>
 503         <tr>
 504           <td class="md"></td>
 505           <td class="md">)&nbsp;</td>
 506           <td class="md" colspan="2"></td>
 507         </tr>
 508       </table>
 509     </td>
 510   </tr>
 511 </table>
 512 <table cellspacing="5" cellpadding="0" border="0">
 513   <tr>
 514     <td>
 515       &nbsp;
 516     </td>
 517     <td>
 518
 519 <p>
 520 Retrieves an integer value from the config file.
 521 <p>
 522 This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> will return CONF_NOT_UNSIGNED
 523 <p>
 524 Definition at line <a class="el" href="modules_8cpp-source.html#l00798">798</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 525 <p>
 526 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, <a class="el" href="modules_8h-source.html#l01538">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01539">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01540">CONF_VALUE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01563">error</a>, and <a class="el" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ServerConfig::ReadConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00799"></a>00799 {
 527 <a name="l00800"></a>00800         <span class="keywordtype">char</span> val[MAXBUF];
 528 <a name="l00801"></a>00801         <span class="keywordtype">char</span> t[MAXBUF];
 529 <a name="l00802"></a>00802         <span class="keywordtype">char</span> n[MAXBUF];
 530 <a name="l00803"></a>00803         strlcpy(t,tag.c_str(),MAXBUF);
 531 <a name="l00804"></a>00804         strlcpy(n,name.c_str(),MAXBUF);
 532 <a name="l00805"></a>00805         <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
 533 <a name="l00806"></a>00806         <span class="keywordflow">if</span> (!res)
 534 <a name="l00807"></a>00807         {
 535 <a name="l00808"></a>00808                 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
 536 <a name="l00809"></a>00809                 <span class="keywordflow">return</span> 0;
 537 <a name="l00810"></a>00810         }
 538 <a name="l00811"></a>00811         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(val); i++)
 539 <a name="l00812"></a>00812         {
 540 <a name="l00813"></a>00813                 <span class="keywordflow">if</span> (!isdigit(val[i]))
 541 <a name="l00814"></a>00814                 {
 542 <a name="l00815"></a>00815                         this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FA_5FNUMBER">CONF_NOT_A_NUMBER</a>;
 543 <a name="l00816"></a>00816                         <span class="keywordflow">return</span> 0;
 544 <a name="l00817"></a>00817                 }
 545 <a name="l00818"></a>00818         }
 546 <a name="l00819"></a>00819         <span class="keywordflow">if</span> ((needs_unsigned) &amp;&amp; (atoi(val)&lt;0))
 547 <a name="l00820"></a>00820         {
 548 <a name="l00821"></a>00821                 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FUNSIGNED">CONF_NOT_UNSIGNED</a>;
 549 <a name="l00822"></a>00822                 <span class="keywordflow">return</span> 0;
 550 <a name="l00823"></a>00823         }
 551 <a name="l00824"></a>00824         <span class="keywordflow">return</span> atoi(val);
 552 <a name="l00825"></a>00825 }
 553 </pre></div>
 554 <p>
 555     </td>
 556   </tr>
 557 </table>
 558 <a class="anchor" name="ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29"></a><!-- doxytag: member="ConfigReader::ReadValue" ref="ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29" args="(std::string tag, std::string name, int index)" --><p>
 559 <table class="mdTable" cellpadding="2" cellspacing="0">
 560   <tr>
 561     <td class="mdRow">
 562       <table cellpadding="0" cellspacing="0" border="0">
 563         <tr>
 564           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> ConfigReader::ReadValue           </td>
 565           <td class="md" valign="top">(&nbsp;</td>
 566           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 567           <td class="mdname" nowrap> <em>tag</em>, </td>
 568         </tr>
 569         <tr>
 570           <td class="md" nowrap align="right"></td>
 571           <td class="md"></td>
 572           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 573           <td class="mdname" nowrap> <em>name</em>, </td>
 574         </tr>
 575         <tr>
 576           <td class="md" nowrap align="right"></td>
 577           <td class="md"></td>
 578           <td class="md" nowrap>int&nbsp;</td>
 579           <td class="mdname" nowrap> <em>index</em></td>
 580         </tr>
 581         <tr>
 582           <td class="md"></td>
 583           <td class="md">)&nbsp;</td>
 584           <td class="md" colspan="2"></td>
 585         </tr>
 586       </table>
 587     </td>
 588   </tr>
 589 </table>
 590 <table cellspacing="5" cellpadding="0" border="0">
 591   <tr>
 592     <td>
 593       &nbsp;
 594     </td>
 595     <td>
 596
 597 <p>
 598 Retrieves a value from the config file.
 599 <p>
 600 This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
 601 <p>
 602 Definition at line <a class="el" href="modules_8cpp-source.html#l00765">765</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 603 <p>
 604 References <a class="el" href="modules_8h-source.html#l01558">cache</a>, <a class="el" href="modules_8h-source.html#l01540">CONF_VALUE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01563">error</a>, and <a class="el" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ServerConfig::ReadConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00766"></a>00766 {
 605 <a name="l00767"></a>00767         <span class="keywordtype">char</span> val[MAXBUF];
 606 <a name="l00768"></a>00768         <span class="keywordtype">char</span> t[MAXBUF];
 607 <a name="l00769"></a>00769         <span class="keywordtype">char</span> n[MAXBUF];
 608 <a name="l00770"></a>00770         strlcpy(t,tag.c_str(),MAXBUF);
 609 <a name="l00771"></a>00771         strlcpy(n,name.c_str(),MAXBUF);
 610 <a name="l00772"></a>00772         <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
 611 <a name="l00773"></a>00773         <span class="keywordflow">if</span> (!res)
 612 <a name="l00774"></a>00774         {
 613 <a name="l00775"></a>00775                 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
 614 <a name="l00776"></a>00776                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
 615 <a name="l00777"></a>00777         }
 616 <a name="l00778"></a>00778         <span class="keywordflow">return</span> val;
 617 <a name="l00779"></a>00779 }
 618 </pre></div>
 619 <p>
 620     </td>
 621   </tr>
 622 </table>
 623 <a class="anchor" name="Verify_28_29"></a><!-- doxytag: member="ConfigReader::Verify" ref="Verify_28_29" args="()" --><p>
 624 <table class="mdTable" cellpadding="2" cellspacing="0">
 625   <tr>
 626     <td class="mdRow">
 627       <table cellpadding="0" cellspacing="0" border="0">
 628         <tr>
 629           <td class="md" nowrap valign="top">bool ConfigReader::Verify           </td>
 630           <td class="md" valign="top">(&nbsp;</td>
 631           <td class="mdname1" valign="top" nowrap>          </td>
 632           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 633           <td class="md" nowrap></td>
 634         </tr>
 635       </table>
 636     </td>
 637   </tr>
 638 </table>
 639 <table cellspacing="5" cellpadding="0" border="0">
 640   <tr>
 641     <td>
 642       &nbsp;
 643     </td>
 644     <td>
 645
 646 <p>
 647 Returns true if a config file is valid.
 648 <p>
 649 This method is partially implemented and will only return false if the config file does not exist or could not be opened.
 650 <p>
 651 Definition at line <a class="el" href="modules_8cpp-source.html#l00877">877</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 652 <p>
 653 References <a class="el" href="modules_8h-source.html#l01562">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00878"></a>00878 {
 654 <a name="l00879"></a>00879         <span class="keywordflow">return</span> this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a>;
 655 <a name="l00880"></a>00880 }
 656 </pre></div>
 657 <p>
 658     </td>
 659   </tr>
 660 </table>
 661 <hr><h2>Member Data Documentation</h2>
 662 <a class="anchor" name="cache"></a><!-- doxytag: member="ConfigReader::cache" ref="cache" args="" --><p>
 663 <table class="mdTable" cellpadding="2" cellspacing="0">
 664   <tr>
 665     <td class="mdRow">
 666       <table cellpadding="0" cellspacing="0" border="0">
 667         <tr>
 668           <td class="md" nowrap valign="top">std::stringstream* <a class="el" href="classConfigReader.html#cache">ConfigReader::cache</a><code> [protected]</code>          </td>
 669         </tr>
 670       </table>
 671     </td>
 672   </tr>
 673 </table>
 674 <table cellspacing="5" cellpadding="0" border="0">
 675   <tr>
 676     <td>
 677       &nbsp;
 678     </td>
 679     <td>
 680
 681 <p>
 682 The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).
 683 <p>
 684 It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
 685 <p>
 686 Definition at line <a class="el" href="modules_8h-source.html#l01558">1558</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 687 <p>
 688 Referenced by <a class="el" href="modules_8cpp-source.html#l00735">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00867">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00872">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00781">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00798">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00765">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00746">~ConfigReader()</a>.    </td>
 689   </tr>
 690 </table>
 691 <a class="anchor" name="error"></a><!-- doxytag: member="ConfigReader::error" ref="error" args="" --><p>
 692 <table class="mdTable" cellpadding="2" cellspacing="0">
 693   <tr>
 694     <td class="mdRow">
 695       <table cellpadding="0" cellspacing="0" border="0">
 696         <tr>
 697           <td class="md" nowrap valign="top">long <a class="el" href="classConfigReader.html#error">ConfigReader::error</a><code> [protected]</code>          </td>
 698         </tr>
 699       </table>
 700     </td>
 701   </tr>
 702 </table>
 703 <table cellspacing="5" cellpadding="0" border="0">
 704   <tr>
 705     <td>
 706       &nbsp;
 707     </td>
 708     <td>
 709
 710 <p>
 711
 712 <p>
 713 Definition at line <a class="el" href="modules_8h-source.html#l01563">1563</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 714 <p>
 715 Referenced by <a class="el" href="modules_8cpp-source.html#l00735">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00827">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00781">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00798">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00765">ReadValue()</a>.    </td>
 716   </tr>
 717 </table>
 718 <a class="anchor" name="errorlog"></a><!-- doxytag: member="ConfigReader::errorlog" ref="errorlog" args="" --><p>
 719 <table class="mdTable" cellpadding="2" cellspacing="0">
 720   <tr>
 721     <td class="mdRow">
 722       <table cellpadding="0" cellspacing="0" border="0">
 723         <tr>
 724           <td class="md" nowrap valign="top">std::stringstream* <a class="el" href="classConfigReader.html#errorlog">ConfigReader::errorlog</a><code> [protected]</code>          </td>
 725         </tr>
 726       </table>
 727     </td>
 728   </tr>
 729 </table>
 730 <table cellspacing="5" cellpadding="0" border="0">
 731   <tr>
 732     <td>
 733       &nbsp;
 734     </td>
 735     <td>
 736
 737 <p>
 738
 739 <p>
 740 Definition at line <a class="el" href="modules_8h-source.html#l01559">1559</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 741 <p>
 742 Referenced by <a class="el" href="modules_8cpp-source.html#l00735">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00834">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00746">~ConfigReader()</a>.    </td>
 743   </tr>
 744 </table>
 745 <a class="anchor" name="readerror"></a><!-- doxytag: member="ConfigReader::readerror" ref="readerror" args="" --><p>
 746 <table class="mdTable" cellpadding="2" cellspacing="0">
 747   <tr>
 748     <td class="mdRow">
 749       <table cellpadding="0" cellspacing="0" border="0">
 750         <tr>
 751           <td class="md" nowrap valign="top">bool <a class="el" href="classConfigReader.html#readerror">ConfigReader::readerror</a><code> [protected]</code>          </td>
 752         </tr>
 753       </table>
 754     </td>
 755   </tr>
 756 </table>
 757 <table cellspacing="5" cellpadding="0" border="0">
 758   <tr>
 759     <td>
 760       &nbsp;
 761     </td>
 762     <td>
 763
 764 <p>
 765 Used to store errors.
 766 <p>
 767
 768 <p>
 769 Definition at line <a class="el" href="modules_8h-source.html#l01562">1562</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 770 <p>
 771 Referenced by <a class="el" href="modules_8cpp-source.html#l00735">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00877">Verify()</a>.    </td>
 772   </tr>
 773 </table>
 774 <hr>The documentation for this class was generated from the following files:<ul>
 775 <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>
 776 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:15 2005 for InspIRCd by&nbsp;
 777 <a href="http://www.doxygen.org/index.html">
 778 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 779 </body>
 780 </html>