diff options
Diffstat (limited to 'docs/module-doc/classConfigReader.html')
| -rw-r--r-- | docs/module-doc/classConfigReader.html | 292 |
1 files changed, 146 insertions, 146 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 331390141..6a8a95db9 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -73,7 +73,7 @@ It may either be instantiated with one parameter or none. Constructing the class <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l01121">1121</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#l01510">1510</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="ConfigReader_28_29"></a><!-- doxytag: member="ConfigReader::ConfigReader" ref="ConfigReader_28_29" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> @@ -102,16 +102,16 @@ 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#l00796">796</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#l00834">834</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01112">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01134">error</a>, <a class="el" href="modules_8h-source.html#l01130">errorlog</a>, <a class="el" href="modules_8cpp.html#include_5Fstack">include_stack</a>, and <a class="el" href="modules_8h-source.html#l01133">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00797"></a>00797 { -<a name="l00798"></a>00798 <a class="code" href="modules_8cpp.html#include_5Fstack">include_stack</a>.clear(); -<a name="l00799"></a>00799 this-><a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -<a name="l00800"></a>00800 this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -<a name="l00801"></a>00801 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -<a name="l00802"></a>00802 <span class="keywordflow">if</span> (!this->readerror) -<a name="l00803"></a>00803 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>; -<a name="l00804"></a>00804 } +References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01501">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01523">error</a>, <a class="el" href="modules_8h-source.html#l01519">errorlog</a>, <a class="el" href="modules_8cpp.html#include_5Fstack">include_stack</a>, and <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00835"></a>00835 { +<a name="l00836"></a>00836 <a class="code" href="modules_8cpp.html#include_5Fstack">include_stack</a>.clear(); +<a name="l00837"></a>00837 this-><a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +<a name="l00838"></a>00838 this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +<a name="l00839"></a>00839 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +<a name="l00840"></a>00840 <span class="keywordflow">if</span> (!this->readerror) +<a name="l00841"></a>00841 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>; +<a name="l00842"></a>00842 } </pre></div> <p> </td> @@ -146,15 +146,15 @@ 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#l00816">816</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#l00854">854</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01112">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01134">error</a>, <a class="el" href="modules_8h-source.html#l01130">errorlog</a>, and <a class="el" href="modules_8h-source.html#l01133">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00817"></a>00817 { -<a name="l00818"></a>00818 this-><a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -<a name="l00819"></a>00819 this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -<a name="l00820"></a>00820 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#cache">cache</a>,this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>); -<a name="l00821"></a>00821 <span class="keywordflow">if</span> (!this->readerror) -<a name="l00822"></a>00822 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>; -<a name="l00823"></a>00823 }; +References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01501">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01523">error</a>, <a class="el" href="modules_8h-source.html#l01519">errorlog</a>, and <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00855"></a>00855 { +<a name="l00856"></a>00856 this-><a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +<a name="l00857"></a>00857 this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +<a name="l00858"></a>00858 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#cache">cache</a>,this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>); +<a name="l00859"></a>00859 <span class="keywordflow">if</span> (!this->readerror) +<a name="l00860"></a>00860 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>; +<a name="l00861"></a>00861 }; </pre></div> <p> </td> @@ -188,14 +188,14 @@ Default destructor. <p> This method destroys the ConfigReader class. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00807">807</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#l00845">845</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>, and <a class="el" href="modules_8h-source.html#l01130">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00808"></a>00808 { -<a name="l00809"></a>00809 <span class="keywordflow">if</span> (this->cache) -<a name="l00810"></a>00810 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#cache">cache</a>; -<a name="l00811"></a>00811 <span class="keywordflow">if</span> (this->errorlog) -<a name="l00812"></a>00812 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>; -<a name="l00813"></a>00813 } +References <a class="el" href="modules_8h-source.html#l01518">cache</a>, and <a class="el" href="modules_8h-source.html#l01519">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00846"></a>00846 { +<a name="l00847"></a>00847 <span class="keywordflow">if</span> (this->cache) +<a name="l00848"></a>00848 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#cache">cache</a>; +<a name="l00849"></a>00849 <span class="keywordflow">if</span> (this->errorlog) +<a name="l00850"></a>00850 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>; +<a name="l00851"></a>00851 } </pre></div> <p> </td> @@ -240,38 +240,38 @@ 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#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#l01130">errorlog</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00121">userrec::nick</a>.<div class="fragment"><pre class="fragment"><a name="l00895"></a>00895 { -<a name="l00896"></a>00896 <span class="keywordflow">if</span> (bail) -<a name="l00897"></a>00897 { -<a name="l00898"></a>00898 printf(<span class="stringliteral">"There were errors in your configuration:\n%s"</span>,<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->str().c_str()); -<a name="l00899"></a>00899 exit(0); -<a name="l00900"></a>00900 } -<a name="l00901"></a>00901 <span class="keywordflow">else</span> -<a name="l00902"></a>00902 { -<a name="l00903"></a>00903 <span class="keywordtype">char</span> dataline[1024]; -<a name="l00904"></a>00904 <span class="keywordflow">if</span> (user) -<a name="l00905"></a>00905 { -<a name="l00906"></a>00906 WriteServ(user-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>); -<a name="l00907"></a>00907 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) -<a name="l00908"></a>00908 { -<a name="l00909"></a>00909 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); -<a name="l00910"></a>00910 WriteServ(user-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :%s"</span>,user-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,dataline); -<a name="l00911"></a>00911 } -<a name="l00912"></a>00912 } -<a name="l00913"></a>00913 <span class="keywordflow">else</span> -<a name="l00914"></a>00914 { -<a name="l00915"></a>00915 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>); -<a name="l00916"></a>00916 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) -<a name="l00917"></a>00917 { -<a name="l00918"></a>00918 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); -<a name="l00919"></a>00919 WriteOpers(dataline); -<a name="l00920"></a>00920 } -<a name="l00921"></a>00921 } -<a name="l00922"></a>00922 <span class="keywordflow">return</span>; -<a name="l00923"></a>00923 } -<a name="l00924"></a>00924 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00932">932</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01519">errorlog</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00124">userrec::nick</a>.<div class="fragment"><pre class="fragment"><a name="l00933"></a>00933 { +<a name="l00934"></a>00934 <span class="keywordflow">if</span> (bail) +<a name="l00935"></a>00935 { +<a name="l00936"></a>00936 printf(<span class="stringliteral">"There were errors in your configuration:\n%s"</span>,<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->str().c_str()); +<a name="l00937"></a>00937 exit(0); +<a name="l00938"></a>00938 } +<a name="l00939"></a>00939 <span class="keywordflow">else</span> +<a name="l00940"></a>00940 { +<a name="l00941"></a>00941 <span class="keywordtype">char</span> dataline[1024]; +<a name="l00942"></a>00942 <span class="keywordflow">if</span> (user) +<a name="l00943"></a>00943 { +<a name="l00944"></a>00944 WriteServ(user-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>); +<a name="l00945"></a>00945 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) +<a name="l00946"></a>00946 { +<a name="l00947"></a>00947 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); +<a name="l00948"></a>00948 WriteServ(user-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :%s"</span>,user-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,dataline); +<a name="l00949"></a>00949 } +<a name="l00950"></a>00950 } +<a name="l00951"></a>00951 <span class="keywordflow">else</span> +<a name="l00952"></a>00952 { +<a name="l00953"></a>00953 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>); +<a name="l00954"></a>00954 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) +<a name="l00955"></a>00955 { +<a name="l00956"></a>00956 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); +<a name="l00957"></a>00957 WriteOpers(dataline); +<a name="l00958"></a>00958 } +<a name="l00959"></a>00959 } +<a name="l00960"></a>00960 <span class="keywordflow">return</span>; +<a name="l00961"></a>00961 } +<a name="l00962"></a>00962 } </pre></div> <p> </td> @@ -306,11 +306,11 @@ 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#ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29">ConfigReader::ReadValue</a> to loop through all copies of a multiple instance tag. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00927">927</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#l00965">965</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00928"></a>00928 { -<a name="l00929"></a>00929 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str()); -<a name="l00930"></a>00930 } +References <a class="el" href="modules_8h-source.html#l01518">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00966"></a>00966 { +<a name="l00967"></a>00967 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str()); +<a name="l00968"></a>00968 } </pre></div> <p> </td> @@ -354,11 +354,11 @@ 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#l00932">932</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#l00970">970</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00933"></a>00933 { -<a name="l00934"></a>00934 <span class="keywordflow">return</span> EnumValues(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index); -<a name="l00935"></a>00935 } +References <a class="el" href="modules_8h-source.html#l01518">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00971"></a>00971 { +<a name="l00972"></a>00972 <span class="keywordflow">return</span> EnumValues(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index); +<a name="l00973"></a>00973 } </pre></div> <p> </td> @@ -392,13 +392,13 @@ 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#GetError_28_29">GetError()</a> resets the error flag back to 0. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00887">887</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#l00925">925</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00888"></a>00888 { -<a name="l00889"></a>00889 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#error">error</a>; -<a name="l00890"></a>00890 this-><a class="code" href="classConfigReader.html#error">error</a> = 0; -<a name="l00891"></a>00891 <span class="keywordflow">return</span> olderr; -<a name="l00892"></a>00892 } +References <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00926"></a>00926 { +<a name="l00927"></a>00927 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#error">error</a>; +<a name="l00928"></a>00928 this-><a class="code" href="classConfigReader.html#error">error</a> = 0; +<a name="l00929"></a>00929 <span class="keywordflow">return</span> olderr; +<a name="l00930"></a>00930 } </pre></div> <p> </td> @@ -448,23 +448,23 @@ 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#l00841">841</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01111">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00842"></a>00842 { -<a name="l00843"></a>00843 <span class="keywordtype">char</span> val[MAXBUF]; -<a name="l00844"></a>00844 <span class="keywordtype">char</span> t[MAXBUF]; -<a name="l00845"></a>00845 <span class="keywordtype">char</span> n[MAXBUF]; -<a name="l00846"></a>00846 strlcpy(t,tag.c_str(),MAXBUF); -<a name="l00847"></a>00847 strlcpy(n,name.c_str(),MAXBUF); -<a name="l00848"></a>00848 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); -<a name="l00849"></a>00849 <span class="keywordflow">if</span> (!res) -<a name="l00850"></a>00850 { -<a name="l00851"></a>00851 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>; -<a name="l00852"></a>00852 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00853"></a>00853 } -<a name="l00854"></a>00854 <a class="code" href="namespaceirc.html#string">std::string</a> s = val; -<a name="l00855"></a>00855 <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>)); -<a name="l00856"></a>00856 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00879">879</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01500">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00880"></a>00880 { +<a name="l00881"></a>00881 <span class="keywordtype">char</span> val[MAXBUF]; +<a name="l00882"></a>00882 <span class="keywordtype">char</span> t[MAXBUF]; +<a name="l00883"></a>00883 <span class="keywordtype">char</span> n[MAXBUF]; +<a name="l00884"></a>00884 strlcpy(t,tag.c_str(),MAXBUF); +<a name="l00885"></a>00885 strlcpy(n,name.c_str(),MAXBUF); +<a name="l00886"></a>00886 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); +<a name="l00887"></a>00887 <span class="keywordflow">if</span> (!res) +<a name="l00888"></a>00888 { +<a name="l00889"></a>00889 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>; +<a name="l00890"></a>00890 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00891"></a>00891 } +<a name="l00892"></a>00892 <a class="code" href="namespaceirc.html#string">std::string</a> s = val; +<a name="l00893"></a>00893 <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>)); +<a name="l00894"></a>00894 } </pre></div> <p> </td> @@ -520,35 +520,35 @@ 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#GetError_28_29">GetError()</a> will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> will return CONF_NOT_UNSIGNED <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00858">858</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01109">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01110">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01111">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00859"></a>00859 { -<a name="l00860"></a>00860 <span class="keywordtype">char</span> val[MAXBUF]; -<a name="l00861"></a>00861 <span class="keywordtype">char</span> t[MAXBUF]; -<a name="l00862"></a>00862 <span class="keywordtype">char</span> n[MAXBUF]; -<a name="l00863"></a>00863 strlcpy(t,tag.c_str(),MAXBUF); -<a name="l00864"></a>00864 strlcpy(n,name.c_str(),MAXBUF); -<a name="l00865"></a>00865 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); -<a name="l00866"></a>00866 <span class="keywordflow">if</span> (!res) -<a name="l00867"></a>00867 { -<a name="l00868"></a>00868 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>; -<a name="l00869"></a>00869 <span class="keywordflow">return</span> 0; -<a name="l00870"></a>00870 } -<a name="l00871"></a>00871 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(val); i++) -<a name="l00872"></a>00872 { -<a name="l00873"></a>00873 <span class="keywordflow">if</span> (!isdigit(val[i])) -<a name="l00874"></a>00874 { -<a name="l00875"></a>00875 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FA_5FNUMBER">CONF_NOT_A_NUMBER</a>; -<a name="l00876"></a>00876 <span class="keywordflow">return</span> 0; -<a name="l00877"></a>00877 } -<a name="l00878"></a>00878 } -<a name="l00879"></a>00879 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) -<a name="l00880"></a>00880 { -<a name="l00881"></a>00881 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FUNSIGNED">CONF_NOT_UNSIGNED</a>; -<a name="l00882"></a>00882 <span class="keywordflow">return</span> 0; -<a name="l00883"></a>00883 } -<a name="l00884"></a>00884 <span class="keywordflow">return</span> atoi(val); -<a name="l00885"></a>00885 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00896">896</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01498">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01499">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01500">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00897"></a>00897 { +<a name="l00898"></a>00898 <span class="keywordtype">char</span> val[MAXBUF]; +<a name="l00899"></a>00899 <span class="keywordtype">char</span> t[MAXBUF]; +<a name="l00900"></a>00900 <span class="keywordtype">char</span> n[MAXBUF]; +<a name="l00901"></a>00901 strlcpy(t,tag.c_str(),MAXBUF); +<a name="l00902"></a>00902 strlcpy(n,name.c_str(),MAXBUF); +<a name="l00903"></a>00903 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); +<a name="l00904"></a>00904 <span class="keywordflow">if</span> (!res) +<a name="l00905"></a>00905 { +<a name="l00906"></a>00906 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>; +<a name="l00907"></a>00907 <span class="keywordflow">return</span> 0; +<a name="l00908"></a>00908 } +<a name="l00909"></a>00909 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(val); i++) +<a name="l00910"></a>00910 { +<a name="l00911"></a>00911 <span class="keywordflow">if</span> (!isdigit(val[i])) +<a name="l00912"></a>00912 { +<a name="l00913"></a>00913 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FA_5FNUMBER">CONF_NOT_A_NUMBER</a>; +<a name="l00914"></a>00914 <span class="keywordflow">return</span> 0; +<a name="l00915"></a>00915 } +<a name="l00916"></a>00916 } +<a name="l00917"></a>00917 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) +<a name="l00918"></a>00918 { +<a name="l00919"></a>00919 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FUNSIGNED">CONF_NOT_UNSIGNED</a>; +<a name="l00920"></a>00920 <span class="keywordflow">return</span> 0; +<a name="l00921"></a>00921 } +<a name="l00922"></a>00922 <span class="keywordflow">return</span> atoi(val); +<a name="l00923"></a>00923 } </pre></div> <p> </td> @@ -598,22 +598,22 @@ 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#l00825">825</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01111">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00826"></a>00826 { -<a name="l00827"></a>00827 <span class="keywordtype">char</span> val[MAXBUF]; -<a name="l00828"></a>00828 <span class="keywordtype">char</span> t[MAXBUF]; -<a name="l00829"></a>00829 <span class="keywordtype">char</span> n[MAXBUF]; -<a name="l00830"></a>00830 strlcpy(t,tag.c_str(),MAXBUF); -<a name="l00831"></a>00831 strlcpy(n,name.c_str(),MAXBUF); -<a name="l00832"></a>00832 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); -<a name="l00833"></a>00833 <span class="keywordflow">if</span> (!res) -<a name="l00834"></a>00834 { -<a name="l00835"></a>00835 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>; -<a name="l00836"></a>00836 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -<a name="l00837"></a>00837 } -<a name="l00838"></a>00838 <span class="keywordflow">return</span> val; -<a name="l00839"></a>00839 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00863">863</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01500">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00864"></a>00864 { +<a name="l00865"></a>00865 <span class="keywordtype">char</span> val[MAXBUF]; +<a name="l00866"></a>00866 <span class="keywordtype">char</span> t[MAXBUF]; +<a name="l00867"></a>00867 <span class="keywordtype">char</span> n[MAXBUF]; +<a name="l00868"></a>00868 strlcpy(t,tag.c_str(),MAXBUF); +<a name="l00869"></a>00869 strlcpy(n,name.c_str(),MAXBUF); +<a name="l00870"></a>00870 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); +<a name="l00871"></a>00871 <span class="keywordflow">if</span> (!res) +<a name="l00872"></a>00872 { +<a name="l00873"></a>00873 this-><a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>; +<a name="l00874"></a>00874 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; +<a name="l00875"></a>00875 } +<a name="l00876"></a>00876 <span class="keywordflow">return</span> val; +<a name="l00877"></a>00877 } </pre></div> <p> </td> @@ -647,11 +647,11 @@ 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#l00937">937</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#l00975">975</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01133">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00938"></a>00938 { -<a name="l00939"></a>00939 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#readerror">readerror</a>; -<a name="l00940"></a>00940 } +References <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00976"></a>00976 { +<a name="l00977"></a>00977 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#readerror">readerror</a>; +<a name="l00978"></a>00978 } </pre></div> <p> </td> @@ -682,9 +682,9 @@ The contents of the configuration file This protected member should never be acc <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#l01129">1129</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#l01518">1518</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#l00796">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00927">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00932">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00841">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00858">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00825">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00807">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00965">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00970">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00879">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00896">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00863">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00845">~ConfigReader()</a>. </td> </tr> </table> <a class="anchor" name="error"></a><!-- doxytag: member="ConfigReader::error" ref="error" args="" --><p> @@ -709,9 +709,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader( <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l01134">1134</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#l01523">1523</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#l00796">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00887">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00841">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00858">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00825">ReadValue()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00925">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00879">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00896">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00863">ReadValue()</a>. </td> </tr> </table> <a class="anchor" name="errorlog"></a><!-- doxytag: member="ConfigReader::errorlog" ref="errorlog" args="" --><p> @@ -736,9 +736,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader( <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l01130">1130</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#l01519">1519</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#l00796">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00894">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00807">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00932">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00845">~ConfigReader()</a>. </td> </tr> </table> <a class="anchor" name="readerror"></a><!-- doxytag: member="ConfigReader::readerror" ref="readerror" args="" --><p> @@ -765,14 +765,14 @@ Used to store errors. <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l01133">1133</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#l01522">1522</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#l00796">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00937">Verify()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00975">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 Sun Nov 27 01:43:25 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> |