diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-14 14:52:12 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-14 14:52:12 +0000 |
| commit | 03be04a9a2d86a4568d09d5e1689dd7ef37c863a (patch) | |
| tree | d7040d4ceeaf75e849d59dd1ed077962b75fb4bf /docs/module-doc/classConfigReader.html | |
| parent | 8b6b85c19528de8f0d35ab766d7559ad519869b3 (diff) | |
Added extra docs for new config system
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classConfigReader.html')
| -rw-r--r-- | docs/module-doc/classConfigReader.html | 293 |
1 files changed, 147 insertions, 146 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 5d160fbd8..f5da7b3a4 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#l01510">1510</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#l01525">1525</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#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#l00734">734</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#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="l00808"></a>00808 { -<a name="l00809"></a>00809 <a class="code" href="modules_8cpp.html#include_5Fstack">include_stack</a>.clear(); -<a name="l00810"></a>00810 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="l00811"></a>00811 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="l00812"></a>00812 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -<a name="l00813"></a>00813 <span class="keywordflow">if</span> (!this->readerror) -<a name="l00814"></a>00814 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="l00815"></a>00815 } +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, <a class="el" href="classServerConfig.html#ClearStack_28_29">ServerConfig::ClearStack()</a>, <a class="el" href="modules_8h-source.html#l01516">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01538">error</a>, <a class="el" href="modules_8h-source.html#l01534">errorlog</a>, <a class="el" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">ServerConfig::LoadConf()</a>, and <a class="el" href="modules_8h-source.html#l01537">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00735"></a>00735 { +<a name="l00736"></a>00736 <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ClearStack_28_29">ClearStack</a>(); +<a name="l00737"></a>00737 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="l00738"></a>00738 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="l00739"></a>00739 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">LoadConf</a>(CONFIG_FILE,this->cache,this->errorlog); +<a name="l00740"></a>00740 <span class="keywordflow">if</span> (!this->readerror) +<a name="l00741"></a>00741 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="l00742"></a>00742 } </pre></div> <p> </td> @@ -146,15 +146,16 @@ 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#l00827">827</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#l00754">754</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#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="l00828"></a>00828 { -<a name="l00829"></a>00829 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="l00830"></a>00830 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="l00831"></a>00831 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="l00832"></a>00832 <span class="keywordflow">if</span> (!this->readerror) -<a name="l00833"></a>00833 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="l00834"></a>00834 }; +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, <a class="el" href="classServerConfig.html#ClearStack_28_29">ServerConfig::ClearStack()</a>, <a class="el" href="modules_8h-source.html#l01516">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01538">error</a>, <a class="el" href="modules_8h-source.html#l01534">errorlog</a>, <a class="el" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">ServerConfig::LoadConf()</a>, and <a class="el" href="modules_8h-source.html#l01537">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00755"></a>00755 { +<a name="l00756"></a>00756 <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ClearStack_28_29">ClearStack</a>(); +<a name="l00757"></a>00757 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="l00758"></a>00758 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="l00759"></a>00759 this-><a class="code" href="classConfigReader.html#readerror">readerror</a> = <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">LoadConf</a>(filename.c_str(),this-><a class="code" href="classConfigReader.html#cache">cache</a>,this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>); +<a name="l00760"></a>00760 <span class="keywordflow">if</span> (!this->readerror) +<a name="l00761"></a>00761 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="l00762"></a>00762 }; </pre></div> <p> </td> @@ -188,14 +189,14 @@ Default destructor. <p> This method destroys the ConfigReader class. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00818">818</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#l00745">745</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>, and <a class="el" href="modules_8h-source.html#l01519">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00819"></a>00819 { -<a name="l00820"></a>00820 <span class="keywordflow">if</span> (this->cache) -<a name="l00821"></a>00821 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#cache">cache</a>; -<a name="l00822"></a>00822 <span class="keywordflow">if</span> (this->errorlog) -<a name="l00823"></a>00823 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>; -<a name="l00824"></a>00824 } +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, and <a class="el" href="modules_8h-source.html#l01534">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00746"></a>00746 { +<a name="l00747"></a>00747 <span class="keywordflow">if</span> (this->cache) +<a name="l00748"></a>00748 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#cache">cache</a>; +<a name="l00749"></a>00749 <span class="keywordflow">if</span> (this->errorlog) +<a name="l00750"></a>00750 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#errorlog">errorlog</a>; +<a name="l00751"></a>00751 } </pre></div> <p> </td> @@ -240,38 +241,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#l00905">905</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="l00906"></a>00906 { -<a name="l00907"></a>00907 <span class="keywordflow">if</span> (bail) -<a name="l00908"></a>00908 { -<a name="l00909"></a>00909 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="l00910"></a>00910 exit(0); -<a name="l00911"></a>00911 } -<a name="l00912"></a>00912 <span class="keywordflow">else</span> -<a name="l00913"></a>00913 { -<a name="l00914"></a>00914 <span class="keywordtype">char</span> dataline[1024]; -<a name="l00915"></a>00915 <span class="keywordflow">if</span> (user) -<a name="l00916"></a>00916 { -<a name="l00917"></a>00917 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="l00918"></a>00918 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) -<a name="l00919"></a>00919 { -<a name="l00920"></a>00920 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); -<a name="l00921"></a>00921 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="l00922"></a>00922 } -<a name="l00923"></a>00923 } -<a name="l00924"></a>00924 <span class="keywordflow">else</span> -<a name="l00925"></a>00925 { -<a name="l00926"></a>00926 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="l00927"></a>00927 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) -<a name="l00928"></a>00928 { -<a name="l00929"></a>00929 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); -<a name="l00930"></a>00930 WriteOpers(dataline); -<a name="l00931"></a>00931 } -<a name="l00932"></a>00932 } -<a name="l00933"></a>00933 <span class="keywordflow">return</span>; -<a name="l00934"></a>00934 } -<a name="l00935"></a>00935 } +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#l01534">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="l00834"></a>00834 { +<a name="l00835"></a>00835 <span class="keywordflow">if</span> (bail) +<a name="l00836"></a>00836 { +<a name="l00837"></a>00837 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="l00838"></a>00838 exit(0); +<a name="l00839"></a>00839 } +<a name="l00840"></a>00840 <span class="keywordflow">else</span> +<a name="l00841"></a>00841 { +<a name="l00842"></a>00842 <span class="keywordtype">char</span> dataline[1024]; +<a name="l00843"></a>00843 <span class="keywordflow">if</span> (user) +<a name="l00844"></a>00844 { +<a name="l00845"></a>00845 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="l00846"></a>00846 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) +<a name="l00847"></a>00847 { +<a name="l00848"></a>00848 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); +<a name="l00849"></a>00849 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="l00850"></a>00850 } +<a name="l00851"></a>00851 } +<a name="l00852"></a>00852 <span class="keywordflow">else</span> +<a name="l00853"></a>00853 { +<a name="l00854"></a>00854 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="l00855"></a>00855 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>->eof()) +<a name="l00856"></a>00856 { +<a name="l00857"></a>00857 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>->getline(dataline,1024); +<a name="l00858"></a>00858 WriteOpers(dataline); +<a name="l00859"></a>00859 } +<a name="l00860"></a>00860 } +<a name="l00861"></a>00861 <span class="keywordflow">return</span>; +<a name="l00862"></a>00862 } +<a name="l00863"></a>00863 } </pre></div> <p> </td> @@ -306,11 +307,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#l00938">938</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#l00866">866</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>.<div class="fragment"><pre class="fragment"><a name="l00939"></a>00939 { -<a name="l00940"></a>00940 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str()); -<a name="l00941"></a>00941 } +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, and <a class="el" href="classServerConfig.html#EnumConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_29">ServerConfig::EnumConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00867"></a>00867 { +<a name="l00868"></a>00868 <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#EnumConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_29">EnumConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str()); +<a name="l00869"></a>00869 } </pre></div> <p> </td> @@ -354,11 +355,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#l00943">943</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#l00871">871</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>.<div class="fragment"><pre class="fragment"><a name="l00944"></a>00944 { -<a name="l00945"></a>00945 <span class="keywordflow">return</span> EnumValues(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index); -<a name="l00946"></a>00946 } +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, and <a class="el" href="classServerConfig.html#EnumValues_28std_3A_3Astringstream_20_2Aconfig_2C_20const_20char_20_2Atag_2C_20int_20index_29">ServerConfig::EnumValues()</a>.<div class="fragment"><pre class="fragment"><a name="l00872"></a>00872 { +<a name="l00873"></a>00873 <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#EnumValues_28std_3A_3Astringstream_20_2Aconfig_2C_20const_20char_20_2Atag_2C_20int_20index_29">EnumValues</a>(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index); +<a name="l00874"></a>00874 } </pre></div> <p> </td> @@ -392,13 +393,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#l00898">898</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#l00826">826</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00899"></a>00899 { -<a name="l00900"></a>00900 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#error">error</a>; -<a name="l00901"></a>00901 this-><a class="code" href="classConfigReader.html#error">error</a> = 0; -<a name="l00902"></a>00902 <span class="keywordflow">return</span> olderr; -<a name="l00903"></a>00903 } +References <a class="el" href="modules_8h-source.html#l01538">error</a>.<div class="fragment"><pre class="fragment"><a name="l00827"></a>00827 { +<a name="l00828"></a>00828 <span class="keywordtype">long</span> olderr = this-><a class="code" href="classConfigReader.html#error">error</a>; +<a name="l00829"></a>00829 this-><a class="code" href="classConfigReader.html#error">error</a> = 0; +<a name="l00830"></a>00830 <span class="keywordflow">return</span> olderr; +<a name="l00831"></a>00831 } </pre></div> <p> </td> @@ -448,23 +449,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#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#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="l00853"></a>00853 { -<a name="l00854"></a>00854 <span class="keywordtype">char</span> val[MAXBUF]; -<a name="l00855"></a>00855 <span class="keywordtype">char</span> t[MAXBUF]; -<a name="l00856"></a>00856 <span class="keywordtype">char</span> n[MAXBUF]; -<a name="l00857"></a>00857 strlcpy(t,tag.c_str(),MAXBUF); -<a name="l00858"></a>00858 strlcpy(n,name.c_str(),MAXBUF); -<a name="l00859"></a>00859 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); -<a name="l00860"></a>00860 <span class="keywordflow">if</span> (!res) -<a name="l00861"></a>00861 { -<a name="l00862"></a>00862 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="l00863"></a>00863 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00864"></a>00864 } -<a name="l00865"></a>00865 <a class="code" href="namespaceirc.html#string">std::string</a> s = val; -<a name="l00866"></a>00866 <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="l00867"></a>00867 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00780">780</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, <a class="el" href="modules_8h-source.html#l01515">CONF_VALUE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01538">error</a>, and <a class="el" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ServerConfig::ReadConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00781"></a>00781 { +<a name="l00782"></a>00782 <span class="keywordtype">char</span> val[MAXBUF]; +<a name="l00783"></a>00783 <span class="keywordtype">char</span> t[MAXBUF]; +<a name="l00784"></a>00784 <span class="keywordtype">char</span> n[MAXBUF]; +<a name="l00785"></a>00785 strlcpy(t,tag.c_str(),MAXBUF); +<a name="l00786"></a>00786 strlcpy(n,name.c_str(),MAXBUF); +<a name="l00787"></a>00787 <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); +<a name="l00788"></a>00788 <span class="keywordflow">if</span> (!res) +<a name="l00789"></a>00789 { +<a name="l00790"></a>00790 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="l00791"></a>00791 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00792"></a>00792 } +<a name="l00793"></a>00793 <a class="code" href="namespaceirc.html#string">std::string</a> s = val; +<a name="l00794"></a>00794 <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="l00795"></a>00795 } </pre></div> <p> </td> @@ -520,35 +521,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#l00869">869</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="l00870"></a>00870 { -<a name="l00871"></a>00871 <span class="keywordtype">char</span> val[MAXBUF]; -<a name="l00872"></a>00872 <span class="keywordtype">char</span> t[MAXBUF]; -<a name="l00873"></a>00873 <span class="keywordtype">char</span> n[MAXBUF]; -<a name="l00874"></a>00874 strlcpy(t,tag.c_str(),MAXBUF); -<a name="l00875"></a>00875 strlcpy(n,name.c_str(),MAXBUF); -<a name="l00876"></a>00876 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); -<a name="l00877"></a>00877 <span class="keywordflow">if</span> (!res) -<a name="l00878"></a>00878 { -<a name="l00879"></a>00879 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="l00880"></a>00880 <span class="keywordflow">return</span> 0; -<a name="l00881"></a>00881 } -<a name="l00882"></a>00882 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(val); i++) -<a name="l00883"></a>00883 { -<a name="l00884"></a>00884 <span class="keywordflow">if</span> (!isdigit(val[i])) -<a name="l00885"></a>00885 { -<a name="l00886"></a>00886 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="l00887"></a>00887 <span class="keywordflow">return</span> 0; -<a name="l00888"></a>00888 } -<a name="l00889"></a>00889 } -<a name="l00890"></a>00890 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) -<a name="l00891"></a>00891 { -<a name="l00892"></a>00892 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="l00893"></a>00893 <span class="keywordflow">return</span> 0; -<a name="l00894"></a>00894 } -<a name="l00895"></a>00895 <span class="keywordflow">return</span> atoi(val); -<a name="l00896"></a>00896 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00797">797</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, <a class="el" href="modules_8h-source.html#l01513">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01514">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01515">CONF_VALUE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01538">error</a>, and <a class="el" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ServerConfig::ReadConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00798"></a>00798 { +<a name="l00799"></a>00799 <span class="keywordtype">char</span> val[MAXBUF]; +<a name="l00800"></a>00800 <span class="keywordtype">char</span> t[MAXBUF]; +<a name="l00801"></a>00801 <span class="keywordtype">char</span> n[MAXBUF]; +<a name="l00802"></a>00802 strlcpy(t,tag.c_str(),MAXBUF); +<a name="l00803"></a>00803 strlcpy(n,name.c_str(),MAXBUF); +<a name="l00804"></a>00804 <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); +<a name="l00805"></a>00805 <span class="keywordflow">if</span> (!res) +<a name="l00806"></a>00806 { +<a name="l00807"></a>00807 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="l00808"></a>00808 <span class="keywordflow">return</span> 0; +<a name="l00809"></a>00809 } +<a name="l00810"></a>00810 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(val); i++) +<a name="l00811"></a>00811 { +<a name="l00812"></a>00812 <span class="keywordflow">if</span> (!isdigit(val[i])) +<a name="l00813"></a>00813 { +<a name="l00814"></a>00814 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="l00815"></a>00815 <span class="keywordflow">return</span> 0; +<a name="l00816"></a>00816 } +<a name="l00817"></a>00817 } +<a name="l00818"></a>00818 <span class="keywordflow">if</span> ((needs_unsigned) && (atoi(val)<0)) +<a name="l00819"></a>00819 { +<a name="l00820"></a>00820 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="l00821"></a>00821 <span class="keywordflow">return</span> 0; +<a name="l00822"></a>00822 } +<a name="l00823"></a>00823 <span class="keywordflow">return</span> atoi(val); +<a name="l00824"></a>00824 } </pre></div> <p> </td> @@ -598,22 +599,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#l00836">836</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="l00837"></a>00837 { -<a name="l00838"></a>00838 <span class="keywordtype">char</span> val[MAXBUF]; -<a name="l00839"></a>00839 <span class="keywordtype">char</span> t[MAXBUF]; -<a name="l00840"></a>00840 <span class="keywordtype">char</span> n[MAXBUF]; -<a name="l00841"></a>00841 strlcpy(t,tag.c_str(),MAXBUF); -<a name="l00842"></a>00842 strlcpy(n,name.c_str(),MAXBUF); -<a name="l00843"></a>00843 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); -<a name="l00844"></a>00844 <span class="keywordflow">if</span> (!res) -<a name="l00845"></a>00845 { -<a name="l00846"></a>00846 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="l00847"></a>00847 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -<a name="l00848"></a>00848 } -<a name="l00849"></a>00849 <span class="keywordflow">return</span> val; -<a name="l00850"></a>00850 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00764">764</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l01533">cache</a>, <a class="el" href="modules_8h-source.html#l01515">CONF_VALUE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01538">error</a>, and <a class="el" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ServerConfig::ReadConf()</a>.<div class="fragment"><pre class="fragment"><a name="l00765"></a>00765 { +<a name="l00766"></a>00766 <span class="keywordtype">char</span> val[MAXBUF]; +<a name="l00767"></a>00767 <span class="keywordtype">char</span> t[MAXBUF]; +<a name="l00768"></a>00768 <span class="keywordtype">char</span> n[MAXBUF]; +<a name="l00769"></a>00769 strlcpy(t,tag.c_str(),MAXBUF); +<a name="l00770"></a>00770 strlcpy(n,name.c_str(),MAXBUF); +<a name="l00771"></a>00771 <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val); +<a name="l00772"></a>00772 <span class="keywordflow">if</span> (!res) +<a name="l00773"></a>00773 { +<a name="l00774"></a>00774 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="l00775"></a>00775 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; +<a name="l00776"></a>00776 } +<a name="l00777"></a>00777 <span class="keywordflow">return</span> val; +<a name="l00778"></a>00778 } </pre></div> <p> </td> @@ -647,11 +648,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#l00948">948</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#l00876">876</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00949"></a>00949 { -<a name="l00950"></a>00950 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#readerror">readerror</a>; -<a name="l00951"></a>00951 } +References <a class="el" href="modules_8h-source.html#l01537">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00877"></a>00877 { +<a name="l00878"></a>00878 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#readerror">readerror</a>; +<a name="l00879"></a>00879 } </pre></div> <p> </td> @@ -682,9 +683,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#l01518">1518</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#l01533">1533</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#l00807">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00938">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00943">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00852">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00869">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00836">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00818">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00734">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00866">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00871">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00780">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00797">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00764">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00745">~ConfigReader()</a>. </td> </tr> </table> <a class="anchor" name="error"></a><!-- doxytag: member="ConfigReader::error" ref="error" args="" --><p> @@ -709,9 +710,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00807">ConfigReader( <p> <p> -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>. +Definition at line <a class="el" href="modules_8h-source.html#l01538">1538</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#l00807">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00898">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00852">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00869">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00836">ReadValue()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00734">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00826">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00780">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00797">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00764">ReadValue()</a>. </td> </tr> </table> <a class="anchor" name="errorlog"></a><!-- doxytag: member="ConfigReader::errorlog" ref="errorlog" args="" --><p> @@ -736,9 +737,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00807">ConfigReader( <p> <p> -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>. +Definition at line <a class="el" href="modules_8h-source.html#l01534">1534</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#l00807">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00905">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00818">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00734">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00833">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00745">~ConfigReader()</a>. </td> </tr> </table> <a class="anchor" name="readerror"></a><!-- doxytag: member="ConfigReader::readerror" ref="readerror" args="" --><p> @@ -765,14 +766,14 @@ Used to store errors. <p> <p> -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>. +Definition at line <a class="el" href="modules_8h-source.html#l01537">1537</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#l00807">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00948">Verify()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00734">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00876">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 Mon Dec 12 18:31:02 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 14 14:49:30 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> |