<!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>InspIRCd: ConfigReader class Reference</title> <link href="inspircd.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.3.3 --> <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="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> 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 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 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. <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#l01072">1072</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 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"> ConfigReader::ConfigReader </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> 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#l00833">833</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>, <a class="el" href="modules_8h-source.html#l01063">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01085">error</a>, <a class="el" href="modules_8h-source.html#l01081">errorlog</a>, and <a class="el" href="modules_8h-source.html#l01084">readerror</a>. <p> <div class="fragment"><pre>00834 { 00835 this-><a class="code" href="classConfigReader.html#p0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); 00836 this-><a class="code" href="classConfigReader.html#p1">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); 00837 this-><a class="code" href="classConfigReader.html#p2">readerror</a> = LoadConf(CONFIG_FILE,this->cache,this->errorlog); 00838 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#p2">readerror</a>) 00839 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a30">CONF_FILE_NOT_FOUND</a>; 00840 } </pre></div> </td> </tr> </table> <a name="a1" doxytag="ConfigReader::ConfigReader"></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"> 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="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> 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#l00852">852</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>, <a class="el" href="modules_8h-source.html#l01063">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01085">error</a>, <a class="el" href="modules_8h-source.html#l01081">errorlog</a>, and <a class="el" href="modules_8h-source.html#l01084">readerror</a>. <p> <div class="fragment"><pre>00853 { 00854 this-><a class="code" href="classConfigReader.html#p0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); 00855 this-><a class="code" href="classConfigReader.html#p1">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); 00856 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>); 00857 <span class="keywordflow">if</span> (!this-><a class="code" href="classConfigReader.html#p2">readerror</a>) 00858 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a30">CONF_FILE_NOT_FOUND</a>; 00859 }; </pre></div> </td> </tr> </table> <a name="a2" doxytag="ConfigReader::~ConfigReader"></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"> 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="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Default destructor. <p> This method destroys the ConfigReader class. <p> Definition at line <a class="el" href="modules_8cpp-source.html#l00843">843</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>, and <a class="el" href="modules_8h-source.html#l01081">errorlog</a>. <p> <div class="fragment"><pre>00844 { 00845 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#p0">cache</a>) 00846 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#p0">cache</a>; 00847 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#p1">errorlog</a>) 00848 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#p1">errorlog</a>; 00849 } </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#l00930">930</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01081">errorlog</a>, <a class="el" href="connection_8h-source.html#l00171">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00106">userrec::nick</a>. <p> <div class="fragment"><pre>00931 { 00932 <span class="keywordflow">if</span> (bail) 00933 { 00934 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()); 00935 exit(0); 00936 } 00937 <span class="keywordflow">else</span> 00938 { 00939 <span class="keywordtype">char</span> dataline[1024]; 00940 <span class="keywordflow">if</span> (user) 00941 { 00942 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>); 00943 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#p1">errorlog</a>->eof()) 00944 { 00945 <a class="code" href="classConfigReader.html#p1">errorlog</a>->getline(dataline,1024); 00946 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); 00947 } 00948 } 00949 <span class="keywordflow">else</span> 00950 { 00951 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#o0">nick</a>); 00952 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#p1">errorlog</a>->eof()) 00953 { 00954 <a class="code" href="classConfigReader.html#p1">errorlog</a>->getline(dataline,1024); 00955 WriteOpers(dataline); 00956 } 00957 } 00958 <span class="keywordflow">return</span>; 00959 } 00960 } </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="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> 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#l00963">963</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>. <p> <div class="fragment"><pre>00964 { 00965 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); 00966 } </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> Definition at line <a class="el" href="modules_8cpp-source.html#l00968">968</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>. <p> <div class="fragment"><pre>00969 { 00970 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); 00971 } </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#l00923">923</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01085">error</a>. <p> <div class="fragment"><pre>00924 { 00925 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#p3">error</a>; 00926 this->error = 0; 00927 <span class="keywordflow">return</span> olderr; 00928 } </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#l00877">877</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>, <a class="el" href="modules_8h-source.html#l01062">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01085">error</a>. <p> <div class="fragment"><pre>00878 { 00879 <span class="keywordtype">char</span> val[MAXBUF]; 00880 <span class="keywordtype">char</span> t[MAXBUF]; 00881 <span class="keywordtype">char</span> n[MAXBUF]; 00882 strlcpy(t,tag.c_str(),MAXBUF); 00883 strlcpy(n,name.c_str(),MAXBUF); 00884 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); 00885 <span class="keywordflow">if</span> (!res) 00886 { 00887 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a>; 00888 <span class="keywordflow">return</span> <span class="keyword">false</span>; 00889 } 00890 std::string s = val; 00891 <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>)); 00892 } </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#l00894">894</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>, <a class="el" href="modules_8h-source.html#l01060">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01061">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01062">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01085">error</a>. <p> <div class="fragment"><pre>00895 { 00896 <span class="keywordtype">char</span> val[MAXBUF]; 00897 <span class="keywordtype">char</span> t[MAXBUF]; 00898 <span class="keywordtype">char</span> n[MAXBUF]; 00899 strlcpy(t,tag.c_str(),MAXBUF); 00900 strlcpy(n,name.c_str(),MAXBUF); 00901 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); 00902 <span class="keywordflow">if</span> (!res) 00903 { 00904 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a>; 00905 <span class="keywordflow">return</span> 0; 00906 } 00907 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < strlen(val); i++) 00908 { 00909 <span class="keywordflow">if</span> (!isdigit(val[i])) 00910 { 00911 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a27">CONF_NOT_A_NUMBER</a>; 00912 <span class="keywordflow">return</span> 0; 00913 } 00914 } 00915 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) 00916 { 00917 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a28">CONF_NOT_UNSIGNED</a>; 00918 <span class="keywordflow">return</span> 0; 00919 } 00920 <span class="keywordflow">return</span> atoi(val); 00921 } </pre></div> </td> </tr> </table> <a name="a3" doxytag="ConfigReader::ReadValue"></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::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> </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 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#l00861">861</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01080">cache</a>, <a class="el" href="modules_8h-source.html#l01062">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01085">error</a>. <p> <div class="fragment"><pre>00862 { 00863 <span class="keywordtype">char</span> val[MAXBUF]; 00864 <span class="keywordtype">char</span> t[MAXBUF]; 00865 <span class="keywordtype">char</span> n[MAXBUF]; 00866 strlcpy(t,tag.c_str(),MAXBUF); 00867 strlcpy(n,name.c_str(),MAXBUF); 00868 <span class="keywordtype">int</span> res = ReadConf(cache,t,n,index,val); 00869 <span class="keywordflow">if</span> (!res) 00870 { 00871 this-><a class="code" href="classConfigReader.html#p3">error</a> = <a class="code" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a>; 00872 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; 00873 } 00874 <span class="keywordflow">return</span> std::string(val); 00875 } </pre></div> </td> </tr> </table> <a name="a8" doxytag="ConfigReader::Verify"></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::Verify </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 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#l00973">973</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l01084">readerror</a>. <p> <div class="fragment"><pre>00974 { 00975 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#p2">readerror</a>; 00976 } </pre></div> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <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#l01080">1080</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#l00833">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00963">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00968">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00877">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00894">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00861">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00843">~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#l01085">1085</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#l00833">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00923">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00877">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00894">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00861">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#l01081">1081</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#l00833">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00930">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00843">~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="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool <a class="el" href="classConfigReader.html#p2">ConfigReader::readerror</a><code> [protected]</code> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Used to store errors. <p> <p> Definition at line <a class="el" href="modules_8h-source.html#l01084">1084</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#l00833">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00973">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 size="1"><address style="align: right;"><small>Generated on Wed Apr 20 15:47:01 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.3 </small></address> </body> </html>