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/channels_8h-source.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/channels_8h-source.html')
| -rw-r--r-- | docs/module-doc/channels_8h-source.html | 210 |
1 files changed, 112 insertions, 98 deletions
diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html index a91e1ac98..9f660ef79 100644 --- a/docs/module-doc/channels_8h-source.html +++ b/docs/module-doc/channels_8h-source.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>channels.h</h1><a href="channels_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span> 00002 <span class="comment"></span> 00003 <span class="comment"> </span> @@ -15,107 +15,121 @@ 00007 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span> 00008 <span class="preprocessor">#include <time.h></span> 00009 <span class="preprocessor">#include <vector></span> -00010 -00011 <span class="preprocessor">#ifndef __CHANNELS_H__</span> -00012 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span> -00013 <span class="preprocessor"></span> -<a name="l00017"></a><a class="code" href="classHostItem.html">00017</a> <span class="keyword">class </span><a class="code" href="classHostItem.html">HostItem</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> -00018 { -00019 <span class="keyword">public</span>: -<a name="l00020"></a><a class="code" href="classHostItem.html#m0">00020</a> time_t <a class="code" href="classHostItem.html#m0">set_time</a>; -<a name="l00021"></a><a class="code" href="classHostItem.html#m1">00021</a> <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m1">set_by</a>[NICKMAX]; -<a name="l00022"></a><a class="code" href="classHostItem.html#m2">00022</a> <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m2">data</a>[MAXBUF]; -00023 -<a name="l00024"></a><a class="code" href="classHostItem.html#a0">00024</a> <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> } -<a name="l00025"></a><a class="code" href="classHostItem.html#a1">00025</a> <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> } -00026 }; -00027 -00028 <span class="comment">// banlist is inherited from HostList mainly for readability</span> -00029 <span class="comment">// reasons only</span> -00030 -<a name="l00033"></a><a class="code" href="classBanItem.html">00033</a> <span class="keyword">class </span><a class="code" href="classBanItem.html">BanItem</a> : <span class="keyword">public</span> <a class="code" href="classHostItem.html">HostItem</a> -00034 { -00035 }; -00036 -00037 <span class="comment">// same with this...</span> -00038 -<a name="l00041"></a><a class="code" href="classExemptItem.html">00041</a> <span class="keyword">class </span><a class="code" href="classExemptItem.html">ExemptItem</a> : <span class="keyword">public</span> <a class="code" href="classHostItem.html">HostItem</a> -00042 { -00043 }; -00044 -00045 <span class="comment">// and this...</span> -00046 -<a name="l00049"></a><a class="code" href="classInviteItem.html">00049</a> <span class="keyword">class </span><a class="code" href="classInviteItem.html">InviteItem</a> : <span class="keyword">public</span> <a class="code" href="classHostItem.html">HostItem</a> -00050 { -00051 }; -00052 +00010 <span class="preprocessor">#include <string></span> +00011 +00012 <span class="preprocessor">#ifndef __CHANNELS_H__</span> +00013 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span> +00014 <span class="preprocessor"></span> +<a name="l00018"></a><a class="code" href="classHostItem.html">00018</a> <span class="keyword">class </span><a class="code" href="classHostItem.html">HostItem</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00019 { +00020 <span class="keyword">public</span>: +<a name="l00021"></a><a class="code" href="classHostItem.html#m0">00021</a> time_t <a class="code" href="classHostItem.html#m0">set_time</a>; +<a name="l00022"></a><a class="code" href="classHostItem.html#m1">00022</a> <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m1">set_by</a>[NICKMAX]; +<a name="l00023"></a><a class="code" href="classHostItem.html#m2">00023</a> <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m2">data</a>[MAXBUF]; +00024 +<a name="l00025"></a><a class="code" href="classHostItem.html#a0">00025</a> <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> } +<a name="l00026"></a><a class="code" href="classHostItem.html#a1">00026</a> <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> } +00027 }; +00028 +00029 <span class="comment">// banlist is inherited from HostList mainly for readability</span> +00030 <span class="comment">// reasons only</span> +00031 +<a name="l00034"></a><a class="code" href="classBanItem.html">00034</a> <span class="keyword">class </span><a class="code" href="classBanItem.html">BanItem</a> : <span class="keyword">public</span> <a class="code" href="classHostItem.html">HostItem</a> +00035 { +00036 }; +00037 +00038 <span class="comment">// same with this...</span> +00039 +<a name="l00042"></a><a class="code" href="classExemptItem.html">00042</a> <span class="keyword">class </span><a class="code" href="classExemptItem.html">ExemptItem</a> : <span class="keyword">public</span> <a class="code" href="classHostItem.html">HostItem</a> +00043 { +00044 }; +00045 +00046 <span class="comment">// and this...</span> +00047 +<a name="l00050"></a><a class="code" href="classInviteItem.html">00050</a> <span class="keyword">class </span><a class="code" href="classInviteItem.html">InviteItem</a> : <span class="keyword">public</span> <a class="code" href="classHostItem.html">HostItem</a> +00051 { +00052 }; 00053 -<a name="l00056"></a><a class="code" href="channels_8h.html#a5">00056</a> <span class="keyword">typedef</span> std::vector<BanItem> <a class="code" href="channels_8h.html#a5">BanList</a>; -00057 -<a name="l00060"></a><a class="code" href="channels_8h.html#a6">00060</a> <span class="keyword">typedef</span> std::vector<ExemptItem> <a class="code" href="channels_8h.html#a6">ExemptList</a>; -00061 -<a name="l00064"></a><a class="code" href="channels_8h.html#a7">00064</a> <span class="keyword">typedef</span> std::vector<InviteItem> <a class="code" href="channels_8h.html#a7">InviteList</a>; -00065 -<a name="l00070"></a><a class="code" href="classchanrec.html">00070</a> <span class="keyword">class </span><a class="code" href="classchanrec.html">chanrec</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> -00071 { -00072 <span class="keyword">public</span>: -<a name="l00075"></a><a class="code" href="classchanrec.html#m0">00075</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span> -<a name="l00079"></a><a class="code" href="classchanrec.html#m1">00079</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m1">custom_modes</a>[MAXMODES]; <span class="comment">/* modes handled by modules */</span> -<a name="l00083"></a><a class="code" href="classchanrec.html#m2">00083</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m2">topic</a>[MAXBUF]; -<a name="l00086"></a><a class="code" href="classchanrec.html#m3">00086</a> time_t <a class="code" href="classchanrec.html#m3">created</a>; -<a name="l00090"></a><a class="code" href="classchanrec.html#m4">00090</a> time_t <a class="code" href="classchanrec.html#m4">topicset</a>; -<a name="l00094"></a><a class="code" href="classchanrec.html#m5">00094</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m5">setby</a>[NICKMAX]; -00095 -<a name="l00099"></a><a class="code" href="classchanrec.html#m6">00099</a> <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#m6">limit</a>; -00100 -<a name="l00104"></a><a class="code" href="classchanrec.html#m7">00104</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m7">key</a>[32]; -00105 -<a name="l00108"></a><a class="code" href="classchanrec.html#m8">00108</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m8">topiclock</a>; -00109 -<a name="l00112"></a><a class="code" href="classchanrec.html#m9">00112</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m9">noexternal</a>; -00113 -<a name="l00116"></a><a class="code" href="classchanrec.html#m10">00116</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m10">inviteonly</a>; -00117 -<a name="l00120"></a><a class="code" href="classchanrec.html#m11">00120</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m11">moderated</a>; -00121 -<a name="l00125"></a><a class="code" href="classchanrec.html#m12">00125</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m12">secret</a>; -00126 -<a name="l00130"></a><a class="code" href="classchanrec.html#m13">00130</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m13">c_private</a>; +00054 +<a name="l00059"></a><a class="code" href="classModeParameter.html">00059</a> <span class="keyword">class </span><a class="code" href="classModeParameter.html">ModeParameter</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00060 { +00061 <span class="keyword">public</span>: +<a name="l00062"></a><a class="code" href="classModeParameter.html#m0">00062</a> <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#m0">mode</a>; +<a name="l00063"></a><a class="code" href="classModeParameter.html#m1">00063</a> <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#m1">parameter</a>[MAXBUF]; +<a name="l00064"></a><a class="code" href="classModeParameter.html#m2">00064</a> <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#m2">channel</a>[CHANMAX]; +00065 }; +00066 +<a name="l00069"></a><a class="code" href="channels_8h.html#a5">00069</a> <span class="keyword">typedef</span> std::vector<BanItem> <a class="code" href="channels_8h.html#a5">BanList</a>; +00070 +<a name="l00073"></a><a class="code" href="channels_8h.html#a6">00073</a> <span class="keyword">typedef</span> std::vector<ExemptItem> <a class="code" href="channels_8h.html#a6">ExemptList</a>; +00074 +<a name="l00077"></a><a class="code" href="channels_8h.html#a7">00077</a> <span class="keyword">typedef</span> std::vector<InviteItem> <a class="code" href="channels_8h.html#a7">InviteList</a>; +00078 +<a name="l00083"></a><a class="code" href="classchanrec.html">00083</a> <span class="keyword">class </span><a class="code" href="classchanrec.html">chanrec</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00084 { +00085 <span class="keyword">public</span>: +<a name="l00088"></a><a class="code" href="classchanrec.html#m0">00088</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span> +<a name="l00092"></a><a class="code" href="classchanrec.html#m1">00092</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m1">custom_modes</a>[MAXMODES]; <span class="comment">/* modes handled by modules */</span> +00093 +<a name="l00097"></a><a class="code" href="classchanrec.html#m2">00097</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m2">topic</a>[MAXBUF]; +<a name="l00100"></a><a class="code" href="classchanrec.html#m3">00100</a> time_t <a class="code" href="classchanrec.html#m3">created</a>; +<a name="l00104"></a><a class="code" href="classchanrec.html#m4">00104</a> time_t <a class="code" href="classchanrec.html#m4">topicset</a>; +<a name="l00108"></a><a class="code" href="classchanrec.html#m5">00108</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m5">setby</a>[NICKMAX]; +00109 +<a name="l00113"></a><a class="code" href="classchanrec.html#m6">00113</a> <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#m6">limit</a>; +00114 +<a name="l00118"></a><a class="code" href="classchanrec.html#m7">00118</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m7">key</a>[32]; +00119 +<a name="l00122"></a><a class="code" href="classchanrec.html#m8">00122</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m8">topiclock</a>; +00123 +<a name="l00126"></a><a class="code" href="classchanrec.html#m9">00126</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m9">noexternal</a>; +00127 +<a name="l00130"></a><a class="code" href="classchanrec.html#m10">00130</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m10">inviteonly</a>; 00131 -<a name="l00134"></a><a class="code" href="classchanrec.html#m14">00134</a> <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#m14">bans</a>; +<a name="l00134"></a><a class="code" href="classchanrec.html#m11">00134</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m11">moderated</a>; 00135 -00138 <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a0">SetCustomMode</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">bool</span> mode_on); -00139 -00142 <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a1">SetCustomModeParam</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">char</span>* parameter,<span class="keywordtype">bool</span> mode_on); -00143 -00146 <a class="code" href="classchanrec.html#a2">chanrec</a>(); -00147 -<a name="l00148"></a><a class="code" href="classchanrec.html#a3">00148</a> <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a3">~chanrec</a>() { <span class="comment">/* stub */</span> } -00149 }; -00150 -00151 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span> -00152 <span class="comment"> * needs to come AFTER struct chanrec */</span> +<a name="l00139"></a><a class="code" href="classchanrec.html#m12">00139</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m12">secret</a>; +00140 +<a name="l00144"></a><a class="code" href="classchanrec.html#m13">00144</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m13">c_private</a>; +00145 +<a name="l00148"></a><a class="code" href="classchanrec.html#m14">00148</a> <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#m14">bans</a>; +00149 +00152 <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a0">SetCustomMode</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">bool</span> mode_on); 00153 -<a name="l00154"></a><a class="code" href="channels_8h.html#a0">00154</a> <span class="preprocessor">#define UCMODE_OP 1</span> -<a name="l00155"></a><a class="code" href="channels_8h.html#a1">00155</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE 2</span> -<a name="l00156"></a><a class="code" href="channels_8h.html#a2">00156</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP 4</span> -<a name="l00157"></a><a class="code" href="channels_8h.html#a3">00157</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span> -<a name="l00158"></a><a class="code" href="channels_8h.html#a4">00158</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span> -00159 <span class="preprocessor"></span> -<a name="l00165"></a><a class="code" href="classucrec.html">00165</a> <span class="keyword">class </span><a class="code" href="classucrec.html">ucrec</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> -00166 { -00167 <span class="keyword">public</span>: -<a name="l00171"></a><a class="code" href="classucrec.html#m0">00171</a> <span class="keywordtype">long</span> <a class="code" href="classucrec.html#m0">uc_modes</a>; -00172 -<a name="l00176"></a><a class="code" href="classucrec.html#m1">00176</a> <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#m1">channel</a>; -00177 -<a name="l00178"></a><a class="code" href="classucrec.html#a0">00178</a> <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> } -<a name="l00179"></a><a class="code" href="classucrec.html#a1">00179</a> <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> } -00180 }; -00181 -00182 <span class="preprocessor">#endif</span> -00183 <span class="preprocessor"></span> -</pre></div><hr><address style="align: right;"><small>Generated on Sat Apr 3 16:36:02 2004 for InspIRCd by +00156 <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a1">SetCustomModeParam</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">char</span>* parameter,<span class="keywordtype">bool</span> mode_on); +00157 +00160 <span class="keywordtype">bool</span> <a class="code" href="classchanrec.html#a2">IsCustomModeSet</a>(<span class="keywordtype">char</span> mode); +00161 +00168 std::string <a class="code" href="classchanrec.html#a3">GetModeParameter</a>(<span class="keywordtype">char</span> mode); +00169 +00172 <a class="code" href="classchanrec.html#a4">chanrec</a>(); +00173 +<a name="l00174"></a><a class="code" href="classchanrec.html#a5">00174</a> <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a5">~chanrec</a>() { <span class="comment">/* stub */</span> } +00175 }; +00176 +00177 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span> +00178 <span class="comment"> * needs to come AFTER struct chanrec */</span> +00179 +<a name="l00180"></a><a class="code" href="channels_8h.html#a0">00180</a> <span class="preprocessor">#define UCMODE_OP 1</span> +<a name="l00181"></a><a class="code" href="channels_8h.html#a1">00181</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE 2</span> +<a name="l00182"></a><a class="code" href="channels_8h.html#a2">00182</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP 4</span> +<a name="l00183"></a><a class="code" href="channels_8h.html#a3">00183</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span> +<a name="l00184"></a><a class="code" href="channels_8h.html#a4">00184</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span> +00185 <span class="preprocessor"></span> +<a name="l00191"></a><a class="code" href="classucrec.html">00191</a> <span class="keyword">class </span><a class="code" href="classucrec.html">ucrec</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00192 { +00193 <span class="keyword">public</span>: +<a name="l00197"></a><a class="code" href="classucrec.html#m0">00197</a> <span class="keywordtype">long</span> <a class="code" href="classucrec.html#m0">uc_modes</a>; +00198 +<a name="l00202"></a><a class="code" href="classucrec.html#m1">00202</a> <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#m1">channel</a>; +00203 +<a name="l00204"></a><a class="code" href="classucrec.html#a0">00204</a> <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> } +<a name="l00205"></a><a class="code" href="classucrec.html#a1">00205</a> <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> } +00206 }; +00207 +00208 <span class="preprocessor">#endif</span> +00209 <span class="preprocessor"></span> +</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:14 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> |