diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
| commit | 78a96055c428d1970ece93dfb01902ac0d1699bd (patch) | |
| tree | b0df96bae212f97c67ebf2339d40454f2283e5d3 /docs/module-doc/modules_8cpp.html | |
| parent | db6ed68db7e38e21a9ce66cecaf42006f034dc62 (diff) | |
New documentation to document user/channel mode handling
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@380 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/modules_8cpp.html')
| -rw-r--r-- | docs/module-doc/modules_8cpp.html | 149 |
1 files changed, 103 insertions, 46 deletions
diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html index 4bd2c143c..1aba98c40 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -5,7 +5,7 @@ </head><body> <!-- Generated by Doxygen 1.3-rc3 --> <center> -<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>modules.cpp File Reference</h1><code>#include <typeinfo></code><br> <code>#include <iostream></code><br> <code>#include "globals.h"</code><br> @@ -31,11 +31,12 @@ Include dependency graph for modules.cpp:<p><center><img src="modules_8cpp__incl <tr><td nowrap align=right valign=top>typedef ExtModeList::iterator </td><td valign=bottom><a class="el" href="modules_8cpp.html#a1">ExtModeListIter</a></td></tr> <tr><td colspan=2><br><h2>Functions</h2></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="modules_8cpp.html#a4">ModeDefined</a> (char modechar, int type)</td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="modules_8cpp.html#a5">ModeDefinedOn</a> (char modechar, int type)</td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="modules_8cpp.html#a6">ModeDefinedOff</a> (char modechar, int type)</td></tr> -<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="modules_8cpp.html#a7">DoAddExtendedMode</a> (char modechar, int type, bool default_on, int params_on, int params_off)</td></tr> -<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="classModule.html">Module</a> * > </td><td valign=bottom><a class="el" href="modules_8cpp.html#a8">modules</a> (255)</td></tr> -<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="modules_8h.html#a12">ircd_module</a> * > </td><td valign=bottom><a class="el" href="modules_8cpp.html#a9">factory</a> (255)</td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="modules_8cpp.html#a5">ModeDefinedOper</a> (char modechar, int type)</td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="modules_8cpp.html#a6">ModeDefinedOn</a> (char modechar, int type)</td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="modules_8cpp.html#a7">ModeDefinedOff</a> (char modechar, int type)</td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="modules_8cpp.html#a8">DoAddExtendedMode</a> (char modechar, int type, bool requires_oper, int params_on, int params_off)</td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="classModule.html">Module</a> * > </td><td valign=bottom><a class="el" href="modules_8cpp.html#a9">modules</a> (255)</td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="modules_8h.html#a12">ircd_module</a> * > </td><td valign=bottom><a class="el" href="modules_8cpp.html#a10">factory</a> (255)</td></tr> <tr><td colspan=2><br><h2>Variables</h2></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="modules_8cpp.html#a0">ExtModeList</a> </td><td valign=bottom><a class="el" href="modules_8cpp.html#a2">EMode</a></td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="modules_8cpp.html#a3">MODCOUNT</a> = -1</td></tr> @@ -88,11 +89,11 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00028">28</a> o <p> Definition at line <a class="el" href="modules_8cpp-source.html#l00029">29</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined()</a>, <a class="el" href="modules_8cpp-source.html#l00062">ModeDefinedOff()</a>, and <a class="el" href="modules_8cpp-source.html#l00049">ModeDefinedOn()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined()</a>, <a class="el" href="modules_8cpp-source.html#l00076">ModeDefinedOff()</a>, <a class="el" href="modules_8cpp-source.html#l00063">ModeDefinedOn()</a>, and <a class="el" href="modules_8cpp-source.html#l00048">ModeDefinedOper()</a>. </td> </tr> </table> <hr><h2>Function Documentation</h2> -<a name="a7" doxytag="modules.cpp::DoAddExtendedMode"></a><p> +<a name="a8" doxytag="modules.cpp::DoAddExtendedMode"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -113,7 +114,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined() <td></td> <td></td> <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>default_on</em>, </td> + <td class="mdname" nowrap> <em>requires_oper</em>, </td> </tr> <tr> <td></td> @@ -147,23 +148,23 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined() <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00075">75</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#l00089">89</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined()</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00230">Server::AddExtendedMode()</a>. +Referenced by <a class="el" href="modules_8cpp-source.html#l00244">Server::AddExtendedMode()</a>. <p> -<div class="fragment"><pre>00076 { -00077 <span class="keywordflow">if</span> (<a class="code" href="modules_8cpp.html#a4">ModeDefined</a>(modechar,type)) { -00078 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00079 } -00080 <a class="code" href="modules_8cpp.html#a2">EMode</a>.push_back(<a class="code" href="classExtMode.html">ExtMode</a>(modechar,type,default_on,params_on,params_off)); -00081 <span class="keywordflow">return</span> <span class="keyword">true</span>; -00082 } +<div class="fragment"><pre>00090 { +00091 <span class="keywordflow">if</span> (<a class="code" href="modules_8cpp.html#a4">ModeDefined</a>(modechar,type)) { +00092 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00093 } +00094 <a class="code" href="modules_8cpp.html#a2">EMode</a>.push_back(<a class="code" href="classExtMode.html">ExtMode</a>(modechar,type,requires_oper,params_on,params_off)); +00095 <span class="keywordflow">return</span> <span class="keyword">true</span>; +00096 } </pre></div> </td> </tr> </table> -<a name="a9" doxytag="modules.cpp::factory"></a><p> +<a name="a10" doxytag="modules.cpp::factory"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -233,7 +234,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00034">34</a> o <p> References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and <a class="el" href="modules_8cpp-source.html#l00029">ExtModeListIter</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00075">DoAddExtendedMode()</a>. +Referenced by <a class="el" href="modules_8cpp-source.html#l00089">DoAddExtendedMode()</a>. <p> <div class="fragment"><pre>00035 { 00036 log(DEBUG,<span class="stringliteral">"Size of extmodes vector is %d"</span>,<a class="code" href="modules_8cpp.html#a2">EMode</a>.size()); @@ -250,7 +251,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00075">DoAddExtended </pre></div> </td> </tr> </table> -<a name="a6" doxytag="modules.cpp::ModeDefinedOff"></a><p> +<a name="a7" doxytag="modules.cpp::ModeDefinedOff"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -287,24 +288,24 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00075">DoAddExtended <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00062">62</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#l00076">76</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and <a class="el" href="modules_8cpp-source.html#l00029">ExtModeListIter</a>. <p> -<div class="fragment"><pre>00063 { -00064 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++) -00065 { -00066 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type)) -00067 { -00068 <span class="keywordflow">return</span> i->params_when_off; -00069 } -00070 } -00071 <span class="keywordflow">return</span> 0; -00072 } +<div class="fragment"><pre>00077 { +00078 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++) +00079 { +00080 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type)) +00081 { +00082 <span class="keywordflow">return</span> i->params_when_off; +00083 } +00084 } +00085 <span class="keywordflow">return</span> 0; +00086 } </pre></div> </td> </tr> </table> -<a name="a5" doxytag="modules.cpp::ModeDefinedOn"></a><p> +<a name="a6" doxytag="modules.cpp::ModeDefinedOn"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -341,24 +342,80 @@ References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and < <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00049">49</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#l00063">63</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and <a class="el" href="modules_8cpp-source.html#l00029">ExtModeListIter</a>. <p> -<div class="fragment"><pre>00050 { +<div class="fragment"><pre>00064 { +00065 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++) +00066 { +00067 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type)) +00068 { +00069 <span class="keywordflow">return</span> i->params_when_on; +00070 } +00071 } +00072 <span class="keywordflow">return</span> 0; +00073 } +</pre></div> </td> + </tr> +</table> +<a name="a5" doxytag="modules.cpp::ModeDefinedOper"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool ModeDefinedOper </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char </td> + <td class="mdname" nowrap> <em>modechar</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>type</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> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00048">48</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and <a class="el" href="modules_8cpp-source.html#l00029">ExtModeListIter</a>. +<p> +<div class="fragment"><pre>00049 { +00050 log(DEBUG,<span class="stringliteral">"Size of extmodes vector is %d"</span>,<a class="code" href="modules_8cpp.html#a2">EMode</a>.size()); 00051 <span class="keywordflow">for</span> (<a class="code" href="modules_8cpp.html#a1">ExtModeListIter</a> i = <a class="code" href="modules_8cpp.html#a2">EMode</a>.begin(); i < <a class="code" href="modules_8cpp.html#a2">EMode</a>.end(); i++) 00052 { -00053 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type)) -00054 { -00055 <span class="keywordflow">return</span> i->params_when_on; -00056 } -00057 } -00058 <span class="keywordflow">return</span> 0; -00059 } +00053 log(DEBUG,<span class="stringliteral">"i->modechar==%c, modechar=%c, i->type=%d, type=%d"</span>,i->modechar,modechar,i->type,type); +00054 <span class="keywordflow">if</span> ((i->modechar == modechar) && (i->type == type) && (i->needsoper == <span class="keyword">true</span>)) +00055 { +00056 <span class="keywordflow">return</span> <span class="keyword">true</span>; +00057 } +00058 } +00059 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00060 } </pre></div> </td> </tr> </table> -<a name="a8" doxytag="modules.cpp::modules"></a><p> +<a name="a9" doxytag="modules.cpp::modules"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -411,7 +468,7 @@ References <a class="el" href="modules_8cpp-source.html#l00031">EMode</a>, and < <p> Definition at line <a class="el" href="modules_8cpp-source.html#l00031">31</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00075">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined()</a>, <a class="el" href="modules_8cpp-source.html#l00062">ModeDefinedOff()</a>, and <a class="el" href="modules_8cpp-source.html#l00049">ModeDefinedOn()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00089">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00034">ModeDefined()</a>, <a class="el" href="modules_8cpp-source.html#l00076">ModeDefinedOff()</a>, <a class="el" href="modules_8cpp-source.html#l00063">ModeDefinedOn()</a>, and <a class="el" href="modules_8cpp-source.html#l00048">ModeDefinedOper()</a>. </td> </tr> </table> <a name="a3" doxytag="modules.cpp::MODCOUNT"></a><p> @@ -435,10 +492,10 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00075">DoAddExtended <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00320">320</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. </td> +Definition at line <a class="el" href="modules_8cpp-source.html#l00349">349</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. </td> </tr> </table> -<hr><address style="align: right;"><small>Generated on Sat Apr 3 16:36:06 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:18 2004 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc3 </small></address> |