<!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>ConfigReader class Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<title>InspIRCd: ConfigReader class Reference</title>
+<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- 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>
-<hr><h1>ConfigReader Class Reference</h1>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.
+<!-- 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="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
+<h1>ConfigReader Class Reference</h1>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.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code>
<p>
-Inheritance diagram for ConfigReader:<p><center><img src="classConfigReader__inherit__graph.gif" border="0" usemap="#ConfigReader__inherit__map" alt="Inheritance graph"></center>
-<map name="ConfigReader__inherit__map">
-<area href="classclassbase.html" shape="rect" coords="19,16,85,37" alt="">
-</map>
-<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>
-<map name="ConfigReader__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="classConfigReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+Inherits <a class="el" href="classclassbase.html">classbase</a>.
+<p>
+<a href="classConfigReader-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 nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classConfigReader.html#a0">ConfigReader</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="classConfigReader.html#a1">ConfigReader</a> (std::string filename)</td></tr>
-<tr><td> </td><td><font size=-1><em>Overloaded 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="classConfigReader.html#a2">~ConfigReader</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>std::string </td><td valign=bottom><a class="el" href="classConfigReader.html#a3">ReadValue</a> (std::string tag, std::string name, int index)</td></tr>
-<tr><td> </td><td><font size=-1><em>Retrieves a value from the config file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classConfigReader.html#a4">Enumerate</a> (std::string tag)</td></tr>
-<tr><td> </td><td><font size=-1><em>Counts the number of times a given tag appears in the config file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classConfigReader.html#a5">Verify</a> ()</td></tr>
-<tr><td> </td><td><font size=-1><em>Returns true if a config file is valid.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#a0">ConfigReader</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="classConfigReader.html#a1">ConfigReader</a> (std::string filename)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Overloaded 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="classConfigReader.html#a2">~ConfigReader</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>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#a3">ReadValue</a> (std::string tag, std::string name, int index)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a value from the config 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="classConfigReader.html#a4">ReadFlag</a> (std::string tag, std::string name, int index)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a boolean value from the config file. </em> <a href="#a4"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#a5">ReadInteger</a> (std::string tag, std::string name, int index, bool needs_unsigned)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves an integer value from the config file. </em> <a href="#a5"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#a6">GetError</a> ()</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the last error to occur. </em> <a href="#a6"></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="classConfigReader.html#a7">Enumerate</a> (std::string tag)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Counts the number of times a given tag appears in the config file. </em> <a href="#a7"></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="classConfigReader.html#a8">Verify</a> ()</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a config file is valid. </em> <a href="#a8"></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="classConfigReader.html#a9">DumpErrors</a> (bool bail, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Dumps the list of errors in a config file to an output location. </em> <a href="#a9"></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="classConfigReader.html#a10">EnumerateValues</a> (std::string tag, int index)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of items within a tag. </em> <a href="#a10"></a><em><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classConfigReader.html#n0">fname</a></td></tr>
-<tr><td> </td><td><font size=-1><em>The filename of the configuration file, as set by the constructor.</em> <a href="#n0"></a><em></em></font><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>std::stringstream * </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#p0">cache</a></td></tr>
+
+<tr><td class="mdescLeft"> </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). </em> <a href="#p0"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>std::stringstream * </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#p1">errorlog</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#p2">readerror</a></td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to store errors. </em> <a href="#p2"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html#p3">error</a></td></tr>
+
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
-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.
+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.
<p>
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.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00
322">322</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
790">790</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="ConfigReader::ConfigReader"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ConfigReader::ConfigReader </td>
<td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </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>
<td>
<p>
-Default constructor.
+Default constructor.
<p>
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
229">229</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
675">675</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00327">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>, <a class="el" href="modules_8h-source.html#l00782">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l00803">error</a>, <a class="el" href="modules_8h-source.html#l00799">errorlog</a>, and <a class="el" href="modules_8h-source.html#l00802">readerror</a>.
<p>
-<div class="fragment"><pre>00230 {
-00231 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
-00232 }
+<div class="fragment"><pre>00676 {
+00677 this-><a class="code" href="classConfigReader.html#p0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
+00678 this-><a class="code" href="classConfigReader.html#p1">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
+00679 this-><a class="code" href="classConfigReader.html#p2">readerror</a> = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00680 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#p2">readerror</a>)
+00681 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a30">CONF_FILE_NOT_FOUND</a>;
+00682 }
</pre></div> </td>
</tr>
</table>
<a name="a1" doxytag="ConfigReader::ConfigReader"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ConfigReader::ConfigReader </td>
<td class="md" valign="top">( </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="mdname1" valign="top" nowrap> <em>filename</em> </td>
+ <td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
<td>
<p>
-Overloaded constructor.
+Overloaded constructor.
<p>
This constructor initialises the ConfigReader class to read a user-specified config file
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00
240">240</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
694">694</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00240 : <a class="code" href="classConfigReader.html#n0">fname</a>(filename) { };
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>, <a class="el" href="modules_8h-source.html#l00782">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l00803">error</a>, <a class="el" href="modules_8h-source.html#l00799">errorlog</a>, and <a class="el" href="modules_8h-source.html#l00802">readerror</a>.
+<p>
+<div class="fragment"><pre>00695 {
+00696 this-><a class="code" href="classConfigReader.html#p0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
+00697 this-><a class="code" href="classConfigReader.html#p1">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
+00698 this-><a class="code" href="classConfigReader.html#p2">readerror</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#p0">cache</a>,this-><a class="code" href="classConfigReader.html#p1">errorlog</a>);
+00699 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#p2">readerror</a>)
+00700 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a30">CONF_FILE_NOT_FOUND</a>;
+00701 };
</pre></div> </td>
</tr>
</table>
<a name="a2" doxytag="ConfigReader::~ConfigReader"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
- <td class="md" nowrap valign="top"> ConfigReader::~ConfigReader </td>
+ <td class="md" nowrap valign="top"> ConfigReader::~<a class="el" href="classConfigReader.html">ConfigReader</a> </td>
<td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </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>
<td>
<p>
-Default destructor.
+Default destructor.
<p>
This method destroys the ConfigReader class.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00235">235</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#l00685">685</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>, and <a class="el" href="modules_8h-source.html#l00799">errorlog</a>.
<p>
-<div class="fragment"><pre>00236 {
-00237 }
+<div class="fragment"><pre>00686 {
+00687 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#p0">cache</a>)
+00688 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#p0">cache</a>;
+00689 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#p1">errorlog</a>)
+00690 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#p1">errorlog</a>;
+00691 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
-<a name="a
4" doxytag="ConfigReader::Enumerate"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<a name="a
9" doxytag="ConfigReader::DumpErrors"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void ConfigReader::DumpErrors </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">bool </td>
+ <td class="mdname" nowrap> <em>bail</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
+ <td class="mdname" nowrap> <em>user</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Dumps the list of errors in a config file to an output location.
+<p>
+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.
+<p>
+Definition at line <a class="el" href="modules_8cpp-source.html#l00772">772</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00799">errorlog</a>, <a class="el" href="connection_8h-source.html#l00178">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00106">userrec::nick</a>.
+<p>
+<div class="fragment"><pre>00773 {
+00774 <span class="keywordflow">if</span> (bail)
+00775 {
+00776 printf(<span class="stringliteral">"There were errors in your configuration:\n%s"</span>,<a class="code" href="classConfigReader.html#p1">errorlog</a>->str().c_str());
+00777 exit(0);
+00778 }
+00779 <span class="keywordflow">else</span>
+00780 {
+00781 <span class="keywordtype">char</span> dataline[1024];
+00782 <span class="keywordflow">if</span> (user)
+00783 {
+00784 WriteServ(user-><a class="code" href="classconnection.html#o0">fd</a>,<span class="stringliteral">"NOTICE %s :There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#o0">nick</a>);
+00785 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#p1">errorlog</a>->eof())
+00786 {
+00787 <a class="code" href="classConfigReader.html#p1">errorlog</a>->getline(dataline,1024);
+00788 WriteServ(user-><a class="code" href="classconnection.html#o0">fd</a>,<span class="stringliteral">"NOTICE %s :%s"</span>,user-><a class="code" href="classuserrec.html#o0">nick</a>,dataline);
+00789 }
+00790 }
+00791 <span class="keywordflow">else</span>
+00792 {
+00793 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#o0">nick</a>);
+00794 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#p1">errorlog</a>->eof())
+00795 {
+00796 <a class="code" href="classConfigReader.html#p1">errorlog</a>->getline(dataline,1024);
+00797 WriteOpers(dataline);
+00798 }
+00799 }
+00800 <span class="keywordflow">return</span>;
+00801 }
+00802 }
+</pre></div> </td>
+ </tr>
+</table>
+<a name="a7" doxytag="ConfigReader::Enumerate"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ConfigReader::Enumerate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::string </td>
- <td class="mdname1" valign="top" nowrap> <em>tag</em> </td>
- <td class="md" valign="top">) </td>
+ <td class="mdname1" valign="top" nowrap> <em>tag</em> </td>
+ <td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
<td>
<p>
-Counts the number of times a given tag appears in the config file.
+Counts the number of times a given tag appears in the config file.
<p>
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#a3">ConfigReader::ReadValue</a> to loop through all copies of a multiple instance tag.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00250">250</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#l00805">805</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>.
+<p>
+<div class="fragment"><pre>00806 {
+00807 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str());
+00808 }
+</pre></div> </td>
+ </tr>
+</table>
+<a name="a10" doxytag="ConfigReader::EnumerateValues"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> int ConfigReader::EnumerateValues </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">std::string </td>
+ <td class="mdname" nowrap> <em>tag</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>int </td>
+ <td class="mdname" nowrap> <em>index</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Returns the number of items within a tag.
+<p>
+For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
<p>
-References <a class="el" href="modules_8h-source.html#l00327">fname</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00810">810</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00251 {
-00252 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
-00253 }
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>.
+<p>
+<div class="fragment"><pre>00811 {
+00812 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index);
+00813 }
+</pre></div> </td>
+ </tr>
+</table>
+<a name="a6" doxytag="ConfigReader::GetError"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> long ConfigReader::GetError </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>
+Returns the last error to occur.
+<p>
+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#a6">GetError()</a> resets the error flag back to 0.
+<p>
+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>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00803">error</a>.
+<p>
+<div class="fragment"><pre>00766 {
+00767 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#p3">error</a>;
+00768 this->error = 0;
+00769 <span class="keywordflow">return</span> olderr;
+00770 }
+</pre></div> </td>
+ </tr>
+</table>
+<a name="a4" doxytag="ConfigReader::ReadFlag"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool ConfigReader::ReadFlag </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">std::string </td>
+ <td class="mdname" nowrap> <em>tag</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>std::string </td>
+ <td class="mdname" nowrap> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>int </td>
+ <td class="mdname" nowrap> <em>index</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Retrieves a boolean value from the config file.
+<p>
+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.
+<p>
+Definition at line <a class="el" href="modules_8cpp-source.html#l00719">719</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>, <a class="el" href="modules_8h-source.html#l00781">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00803">error</a>.
+<p>
+<div class="fragment"><pre>00720 {
+00721 <span class="keywordtype">char</span> val[MAXBUF];
+00722 <span class="keywordtype">char</span> t[MAXBUF];
+00723 <span class="keywordtype">char</span> n[MAXBUF];
+00724 strlcpy(t,tag.c_str(),MAXBUF);
+00725 strlcpy(n,name.c_str(),MAXBUF);
+00726 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val);
+00727 <span class="keywordflow">if</span> (!res)
+00728 {
+00729 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a>;
+00730 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+00731 }
+00732 std::string s = val;
+00733 <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>));
+00734 }
+</pre></div> </td>
+ </tr>
+</table>
+<a name="a5" doxytag="ConfigReader::ReadInteger"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> long ConfigReader::ReadInteger </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">std::string </td>
+ <td class="mdname" nowrap> <em>tag</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>std::string </td>
+ <td class="mdname" nowrap> <em>name</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>int </td>
+ <td class="mdname" nowrap> <em>index</em>, </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ <td class="md" nowrap>bool </td>
+ <td class="mdname" nowrap> <em>needs_unsigned</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Retrieves an integer value from the config file.
+<p>
+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#a6">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#a6">GetError()</a> will return CONF_NOT_UNSIGNED
+<p>
+Definition at line <a class="el" href="modules_8cpp-source.html#l00736">736</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>, <a class="el" href="modules_8h-source.html#l00779">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l00780">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l00781">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00803">error</a>.
+<p>
+<div class="fragment"><pre>00737 {
+00738 <span class="keywordtype">char</span> val[MAXBUF];
+00739 <span class="keywordtype">char</span> t[MAXBUF];
+00740 <span class="keywordtype">char</span> n[MAXBUF];
+00741 strlcpy(t,tag.c_str(),MAXBUF);
+00742 strlcpy(n,name.c_str(),MAXBUF);
+00743 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val);
+00744 <span class="keywordflow">if</span> (!res)
+00745 {
+00746 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a>;
+00747 <span class="keywordflow">return</span> 0;
+00748 }
+00749 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < strlen(val); i++)
+00750 {
+00751 <span class="keywordflow">if</span> (!isdigit(val[i]))
+00752 {
+00753 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a27">CONF_NOT_A_NUMBER</a>;
+00754 <span class="keywordflow">return</span> 0;
+00755 }
+00756 }
+00757 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0))
+00758 {
+00759 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a28">CONF_NOT_UNSIGNED</a>;
+00760 <span class="keywordflow">return</span> 0;
+00761 }
+00762 <span class="keywordflow">return</span> atoi(val);
+00763 }
</pre></div> </td>
</tr>
</table>
<a name="a3" doxytag="ConfigReader::ReadValue"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::string ConfigReader::ReadValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::string </td>
- <td class="mdname" nowrap> <em>tag</em>, </td>
+ <td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>std::string </td>
- <td class="mdname" nowrap> <em>name</em>, </td>
+ <td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
- <td class="mdname" nowrap> <em>index</em></td>
+ <td class="mdname" nowrap> <em>index</em></td>
</tr>
<tr>
<td></td>
<td>
<p>
-Retrieves a value from the config file.
+Retrieves a value from the config file.
<p>
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.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00242">242</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
-<p>
-References <a class="el" href="modules_8h-source.html#l00327">fname</a>.
-<p>
-<div class="fragment"><pre>00243 {
-00244 <span class="keywordtype">char</span> val[MAXBUF];
-00245 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
-00246 <span class="keywordflow">return</span> val;
-00247 }
+Definition at line <a class="el" href="modules_8cpp-source.html#l00703">703</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00798">cache</a>, <a class="el" href="modules_8h-source.html#l00781">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00803">error</a>.
+<p>
+<div class="fragment"><pre>00704 {
+00705 <span class="keywordtype">char</span> val[MAXBUF];
+00706 <span class="keywordtype">char</span> t[MAXBUF];
+00707 <span class="keywordtype">char</span> n[MAXBUF];
+00708 strlcpy(t,tag.c_str(),MAXBUF);
+00709 strlcpy(n,name.c_str(),MAXBUF);
+00710 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val);
+00711 <span class="keywordflow">if</span> (!res)
+00712 {
+00713 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a>;
+00714 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+00715 }
+00716 <span class="keywordflow">return</span> std::string(val);
+00717 }
</pre></div> </td>
</tr>
</table>
-<a name="a
5" doxytag="ConfigReader::Verify"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<a name="a
8" doxytag="ConfigReader::Verify"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool ConfigReader::Verify </td>
<td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </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>
<td>
<p>
-Returns true if a config file is valid.
+Returns true if a config file is valid.
+<p>
+This method is partially implemented and will only return false if the config file does not exist or could not be opened.
<p>
-This method is unimplemented and will always return true.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00815">815</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00256">256</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+References <a class="el" href="modules_8h-source.html#l00802">readerror</a>.
<p>
-<div class="fragment"><pre>00257 {
-00258 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-00259 }
+<div class="fragment"><pre>00816 {
+00817 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#p2">readerror</a>;
+00818 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
-<a name="n0" doxytag="ConfigReader::fname"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<a name="p0" doxytag="ConfigReader::cache"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> std::stringstream* <a class="el" href="classConfigReader.html#p0">ConfigReader::cache</a><code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+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).
+<p>
+It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00798">798</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#l00675">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00805">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00810">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00719">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00736">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00703">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00685">~ConfigReader()</a>. </td>
+ </tr>
+</table>
+<a name="p3" doxytag="ConfigReader::error"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> long <a class="el" href="classConfigReader.html#p3">ConfigReader::error</a><code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00803">803</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#l00675">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00765">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00719">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00736">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00703">ReadValue()</a>. </td>
+ </tr>
+</table>
+<a name="p1" doxytag="ConfigReader::errorlog"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> std::stringstream* <a class="el" href="classConfigReader.html#p1">ConfigReader::errorlog</a><code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00799">799</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#l00675">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00772">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00685">~ConfigReader()</a>. </td>
+ </tr>
+</table>
+<a name="p2" doxytag="ConfigReader::readerror"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
- <td class="md">
+ <td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
- <td class="md" nowrap valign="top"> std::string ConfigReader::fname<code> [protected]</code>
+ <td class="md" nowrap valign="top"> bool <a class="el" href="classConfigReader.html#p2">ConfigReader::readerror</a><code> [protected]</code>
</table>
</td>
</tr>
<td>
<p>
-The filename of the configuration file, as set by the constructor.
+Used to store errors.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00
327">327</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
802">802</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#l00229">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00250">Enumerate()</a>, and <a class="el" href="modules_8cpp-source.html#l00242">ReadValue()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00675">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00815">Verify()</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 Fri Apr 2 14:46:13 2004 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Wed Apr 13 13:07:02 2005 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-rc3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.3 </small></address>
</body>
</html>
projects / user / henk / code / inspircd.git / blobdiff