diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
| commit | 52899de0ff2d62ca0542b243c41626010bf62083 (patch) | |
| tree | b9c92bbdb7d65a7467cbd6ebcbc31dc2f96e09e3 /docs/module-doc/classConfigReader.html | |
| parent | 0340f1a432d684347d8dbc3aa85c8436c56d4039 (diff) | |
Documentation update
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classConfigReader.html')
| -rw-r--r-- | docs/module-doc/classConfigReader.html | 581 |
1 files changed, 351 insertions, 230 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index f8c1f7bda..3519d1aa8 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -1,72 +1,83 @@ <!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> +<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="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> -<hr><h1>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>bool </td><td valign=bottom><a class="el" href="classConfigReader.html#a4">ReadFlag</a> (std::string tag, std::string name, int index)</td></tr> -<tr><td> </td><td><font size=-1><em>Retrieves a boolean value from the config file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td 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> </td><td><font size=-1><em>Retrieves an integer value from the config file.</em> <a href="#a5"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classConfigReader.html#a6">GetError</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Returns the last error to occur.</em> <a href="#a6"></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#a7">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="#a7"></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#a8">Verify</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Returns true if a config file is valid.</em> <a href="#a8"></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#a9">EnumerateValues</a> (std::string tag, int index)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns the number of items within a tag.</em> <a href="#a9"></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::stringstream * </td><td valign=bottom><a class="el" href="classConfigReader.html#n0">cache</a></td></tr> -<tr><td> </td><td><font size=-1><em>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="#n0"></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#n1">readerror</a></td></tr> -<tr><td> </td><td><font size=-1><em>Used to store errors.</em> <a href="#n1"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classConfigReader.html#n2">error</a></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#l00618">618</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#l00641">641</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> @@ -82,34 +93,35 @@ Definition at line <a class="el" href="modules_8h-source.html#l00618">618</a> of <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#l00553">553</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#l00566">566</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00626">cache</a>, <a class="el" href="modules_8h-source.html#l00610">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l00630">error</a>, and <a class="el" href="modules_8h-source.html#l00629">readerror</a>. +References <a class="el" href="modules_8h-source.html#l00649">cache</a>, <a class="el" href="modules_8h-source.html#l00633">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l00654">error</a>, <a class="el" href="modules_8h-source.html#l00650">errorlog</a>, and <a class="el" href="modules_8h-source.html#l00653">readerror</a>. <p> -<div class="fragment"><pre>00554 { -00555 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -00556 this-><a class="code" href="classConfigReader.html#n1">readerror</a> = LoadConf(CONFIG_FILE,this->cache); -00557 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#n1">readerror</a>) -00558 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a25">CONF_FILE_NOT_FOUND</a>; -00559 } +<div class="fragment"><pre>00567 { +00568 this-><a class="code" href="classConfigReader.html#p0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00569 this-><a class="code" href="classConfigReader.html#p1">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00570 this-><a class="code" href="classConfigReader.html#p2">readerror</a> = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +00571 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#p2">readerror</a>) +00572 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a25">CONF_FILE_NOT_FOUND</a>; +00573 } </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> @@ -125,33 +137,34 @@ References <a class="el" href="modules_8h-source.html#l00626">cache</a>, <a clas <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#l00569">569</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#l00585">585</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00626">cache</a>, <a class="el" href="modules_8h-source.html#l00610">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l00630">error</a>, and <a class="el" href="modules_8h-source.html#l00629">readerror</a>. +References <a class="el" href="modules_8h-source.html#l00649">cache</a>, <a class="el" href="modules_8h-source.html#l00633">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l00654">error</a>, <a class="el" href="modules_8h-source.html#l00650">errorlog</a>, and <a class="el" href="modules_8h-source.html#l00653">readerror</a>. <p> -<div class="fragment"><pre>00570 { -00571 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -00572 this-><a class="code" href="classConfigReader.html#n1">readerror</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#n0">cache</a>); -00573 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#n1">readerror</a>) -00574 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a25">CONF_FILE_NOT_FOUND</a>; -00575 }; +<div class="fragment"><pre>00586 { +00587 this-><a class="code" href="classConfigReader.html#p0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00588 this-><a class="code" href="classConfigReader.html#p1">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00589 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>); +00590 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#p2">readerror</a>) +00591 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a25">CONF_FILE_NOT_FOUND</a>; +00592 }; </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> @@ -167,33 +180,111 @@ References <a class="el" href="modules_8h-source.html#l00626">cache</a>, <a clas <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#l00562">562</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#l00576">576</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00626">cache</a>. +References <a class="el" href="modules_8h-source.html#l00649">cache</a>, and <a class="el" href="modules_8h-source.html#l00650">errorlog</a>. <p> -<div class="fragment"><pre>00563 { -00564 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#n0">cache</a>) -00565 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#n0">cache</a>; -00566 } +<div class="fragment"><pre>00577 { +00578 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#p0">cache</a>) +00579 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#p0">cache</a>; +00580 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#p1">errorlog</a>) +00581 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#p1">errorlog</a>; +00582 } </pre></div> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> +<a name="a9" doxytag="ConfigReader::DumpErrors"></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"> 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#l00663">663</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00650">errorlog</a>, <a class="el" href="connection_8h-source.html#l00178">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00102">userrec::nick</a>. +<p> +<div class="fragment"><pre>00664 { +00665 <span class="keywordflow">if</span> (bail) +00666 { +00667 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()); +00668 exit(0); +00669 } +00670 <span class="keywordflow">else</span> +00671 { +00672 <span class="keywordtype">char</span> dataline[1024]; +00673 <span class="keywordflow">if</span> (user) +00674 { +00675 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>); +00676 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#p1">errorlog</a>->eof()) +00677 { +00678 <a class="code" href="classConfigReader.html#p1">errorlog</a>->getline(dataline,1024); +00679 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); +00680 } +00681 } +00682 <span class="keywordflow">else</span> +00683 { +00684 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#o0">nick</a>); +00685 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#p1">errorlog</a>->eof()) +00686 { +00687 <a class="code" href="classConfigReader.html#p1">errorlog</a>->getline(dataline,1024); +00688 WriteOpers(dataline); +00689 } +00690 } +00691 <span class="keywordflow">return</span>; +00692 } +00693 } +</pre></div> </td> + </tr> +</table> <a name="a7" doxytag="ConfigReader::Enumerate"></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"> 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> @@ -209,34 +300,36 @@ References <a class="el" href="modules_8h-source.html#l00626">cache</a>. <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#l00647">647</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#l00696">696</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00648 { -00649 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); -00650 } +References <a class="el" href="modules_8h-source.html#l00649">cache</a>. +<p> +<div class="fragment"><pre>00697 { +00698 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); +00699 } </pre></div> </td> </tr> </table> -<a name="a9" doxytag="ConfigReader::EnumerateValues"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="a10" doxytag="ConfigReader::EnumerateValues"></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"> 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> + <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> + <td class="mdname" nowrap> <em>index</em></td> </tr> <tr> <td></td> @@ -256,28 +349,30 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00647">647</a> <td> <p> -Returns the number of items within a tag. +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> -Definition at line <a class="el" href="modules_8cpp-source.html#l00652">652</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#l00701">701</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00649">cache</a>. <p> -<div class="fragment"><pre>00653 { -00654 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); -00655 } +<div class="fragment"><pre>00702 { +00703 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); +00704 } </pre></div> </td> </tr> </table> <a name="a6" doxytag="ConfigReader::GetError"></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"> 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="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -293,44 +388,44 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00652">652</a> <td> <p> -Returns the last error to occur. +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#l00639">639</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#l00656">656</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00630">error</a>. +References <a class="el" href="modules_8h-source.html#l00654">error</a>. <p> -<div class="fragment"><pre>00640 { -00641 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#n2">error</a>; -00642 this->error = 0; -00643 <span class="keywordflow">return</span> olderr; -00644 } +<div class="fragment"><pre>00657 { +00658 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#p3">error</a>; +00659 this->error = 0; +00660 <span class="keywordflow">return</span> olderr; +00661 } </pre></div> </td> </tr> </table> <a name="a4" doxytag="ConfigReader::ReadFlag"></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"> 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> + <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> @@ -350,60 +445,60 @@ References <a class="el" href="modules_8h-source.html#l00630">error</a>. <td> <p> -Retrieves a boolean value from the config file. +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#l00593">593</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l00609">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00630">error</a>. -<p> -<div class="fragment"><pre>00594 { -00595 <span class="keywordtype">char</span> val[MAXBUF]; -00596 <span class="keywordtype">char</span> t[MAXBUF]; -00597 <span class="keywordtype">char</span> n[MAXBUF]; -00598 strncpy(t,tag.c_str(),MAXBUF); -00599 strncpy(n,name.c_str(),MAXBUF); -00600 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); -00601 <span class="keywordflow">if</span> (!res) -00602 { -00603 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>; -00604 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00605 } -00606 std::string s = val; -00607 <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>)); -00608 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00610">610</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00649">cache</a>, <a class="el" href="modules_8h-source.html#l00632">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00654">error</a>. +<p> +<div class="fragment"><pre>00611 { +00612 <span class="keywordtype">char</span> val[MAXBUF]; +00613 <span class="keywordtype">char</span> t[MAXBUF]; +00614 <span class="keywordtype">char</span> n[MAXBUF]; +00615 strlcpy(t,tag.c_str(),MAXBUF); +00616 strlcpy(n,name.c_str(),MAXBUF); +00617 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); +00618 <span class="keywordflow">if</span> (!res) +00619 { +00620 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>; +00621 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00622 } +00623 std::string s = val; +00624 <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>)); +00625 } </pre></div> </td> </tr> </table> <a name="a5" doxytag="ConfigReader::ReadInteger"></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"> 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> + <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></td> <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>needs_unsigned</em></td> + <td class="mdname" nowrap> <em>needs_unsigned</em></td> </tr> <tr> <td></td> @@ -423,66 +518,66 @@ References <a class="el" href="modules_8h-source.html#l00609">CONF_VALUE_NOT_FOU <td> <p> -Retrieves an integer value from the config file. +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#l00610">610</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l00607">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l00608">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l00609">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00630">error</a>. -<p> -<div class="fragment"><pre>00611 { -00612 <span class="keywordtype">char</span> val[MAXBUF]; -00613 <span class="keywordtype">char</span> t[MAXBUF]; -00614 <span class="keywordtype">char</span> n[MAXBUF]; -00615 strncpy(t,tag.c_str(),MAXBUF); -00616 strncpy(n,name.c_str(),MAXBUF); -00617 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); -00618 <span class="keywordflow">if</span> (!res) -00619 { -00620 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>; -00621 <span class="keywordflow">return</span> 0; -00622 } -00623 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < strlen(val); i++) -00624 { -00625 <span class="keywordflow">if</span> (!isdigit(val[i])) -00626 { -00627 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a22">CONF_NOT_A_NUMBER</a>; -00628 <span class="keywordflow">return</span> 0; -00629 } -00630 } -00631 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) -00632 { -00633 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a23">CONF_NOT_UNSIGNED</a>; -00634 <span class="keywordflow">return</span> 0; -00635 } -00636 <span class="keywordflow">return</span> atoi(val); -00637 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00627">627</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00649">cache</a>, <a class="el" href="modules_8h-source.html#l00630">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l00631">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l00632">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00654">error</a>. +<p> +<div class="fragment"><pre>00628 { +00629 <span class="keywordtype">char</span> val[MAXBUF]; +00630 <span class="keywordtype">char</span> t[MAXBUF]; +00631 <span class="keywordtype">char</span> n[MAXBUF]; +00632 strlcpy(t,tag.c_str(),MAXBUF); +00633 strlcpy(n,name.c_str(),MAXBUF); +00634 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); +00635 <span class="keywordflow">if</span> (!res) +00636 { +00637 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>; +00638 <span class="keywordflow">return</span> 0; +00639 } +00640 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < strlen(val); i++) +00641 { +00642 <span class="keywordflow">if</span> (!isdigit(val[i])) +00643 { +00644 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a22">CONF_NOT_A_NUMBER</a>; +00645 <span class="keywordflow">return</span> 0; +00646 } +00647 } +00648 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) +00649 { +00650 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a23">CONF_NOT_UNSIGNED</a>; +00651 <span class="keywordflow">return</span> 0; +00652 } +00653 <span class="keywordflow">return</span> atoi(val); +00654 } </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> @@ -502,41 +597,41 @@ References <a class="el" href="modules_8h-source.html#l00607">CONF_NOT_A_NUMBER< <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#l00577">577</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l00609">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00630">error</a>. -<p> -<div class="fragment"><pre>00578 { -00579 <span class="keywordtype">char</span> val[MAXBUF]; -00580 <span class="keywordtype">char</span> t[MAXBUF]; -00581 <span class="keywordtype">char</span> n[MAXBUF]; -00582 strncpy(t,tag.c_str(),MAXBUF); -00583 strncpy(n,name.c_str(),MAXBUF); -00584 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); -00585 <span class="keywordflow">if</span> (!res) -00586 { -00587 this-><a class="code" href="classConfigReader.html#n2">error</a> = <a class="code" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>; -00588 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -00589 } -00590 <span class="keywordflow">return</span> std::string(val); -00591 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00594">594</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00649">cache</a>, <a class="el" href="modules_8h-source.html#l00632">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l00654">error</a>. +<p> +<div class="fragment"><pre>00595 { +00596 <span class="keywordtype">char</span> val[MAXBUF]; +00597 <span class="keywordtype">char</span> t[MAXBUF]; +00598 <span class="keywordtype">char</span> n[MAXBUF]; +00599 strlcpy(t,tag.c_str(),MAXBUF); +00600 strlcpy(n,name.c_str(),MAXBUF); +00601 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); +00602 <span class="keywordflow">if</span> (!res) +00603 { +00604 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>; +00605 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; +00606 } +00607 <span class="keywordflow">return</span> std::string(val); +00608 } </pre></div> </td> </tr> </table> <a name="a8" doxytag="ConfigReader::Verify"></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"> 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> @@ -552,28 +647,28 @@ References <a class="el" href="modules_8h-source.html#l00609">CONF_VALUE_NOT_FOU <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> -Definition at line <a class="el" href="modules_8cpp-source.html#l00657">657</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#l00706">706</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00629">readerror</a>. +References <a class="el" href="modules_8h-source.html#l00653">readerror</a>. <p> -<div class="fragment"><pre>00658 { -00659 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#n1">readerror</a>; -00660 } +<div class="fragment"><pre>00707 { +00708 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#p2">readerror</a>; +00709 } </pre></div> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="n0" doxytag="ConfigReader::cache"></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="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::stringstream* ConfigReader::cache<code> [protected]</code> + <td class="md" nowrap valign="top"> std::stringstream* <a class="el" href="classConfigReader.html#p0">ConfigReader::cache</a><code> [protected]</code> </table> </td> </tr> @@ -586,22 +681,48 @@ References <a class="el" href="modules_8h-source.html#l00629">readerror</a>. <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). +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#l00626">626</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#l00649">649</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#l00566">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00696">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00701">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00610">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00627">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00594">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00576">~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#l00654">654</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#l00553">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00562">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00566">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00656">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00610">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00627">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00594">ReadValue()</a>. </td> </tr> </table> -<a name="n2" doxytag="ConfigReader::error"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="p1" doxytag="ConfigReader::errorlog"></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"> long ConfigReader::error<code> [protected]</code> + <td class="md" nowrap valign="top"> std::stringstream* <a class="el" href="classConfigReader.html#p1">ConfigReader::errorlog</a><code> [protected]</code> </table> </td> </tr> @@ -616,18 +737,18 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00553">ConfigReader( <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00630">630</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#l00650">650</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#l00553">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00639">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00593">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00610">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00577">ReadValue()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00566">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00663">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00576">~ConfigReader()</a>. </td> </tr> </table> -<a name="n1" doxytag="ConfigReader::readerror"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<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"> bool ConfigReader::readerror<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> @@ -640,20 +761,20 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00553">ConfigReader( <td> <p> -Used to store errors. +Used to store errors. <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00629">629</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#l00653">653</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#l00553">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00657">Verify()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00566">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00706">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 Sun May 2 00:09:32 2004 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Mar 25 03:49:31 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> |