]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/channels_8h-source.html
Modified documentation
[user/henk/code/inspircd.git] / docs / module-doc / channels_8h-source.html
index ba7592c81c77c1a4c1fb1b606c02ccf38abdeaee..2d618ec6a040bd3d7a4deb990617f2467fd988d3 100644 (file)
 <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">$Log$
-00003 <span class="comment">Revision 1.1  2003/01/23 19:45:57  brain
-00003 <span class="comment">Initial revision
-00003 <span class="comment">
-00003 <span class="comment">Revision 1.6  2003/01/22 20:59:12  brain
-00003 <span class="comment">Added FileReader class documentation
+00003 <span class="comment">Revision 1.4  2003/01/27 00:22:39  brain
+00003 <span class="comment">Modified documentation
 00003 <span class="comment"></span>
-00004 <span class="comment">Revision 1.7  2003/01/22 00:44:26  brain</span>
-00005 <span class="comment">Added documentation comments</span>
-00006 <span class="comment"></span>
-00007 <span class="comment">Revision 1.6  2003/01/21 21:11:17  brain</span>
-00008 <span class="comment">Added documentation</span>
-00009 <span class="comment"></span>
-00010 <span class="comment">Revision 1.5  2003/01/16 20:11:55  brain</span>
-00011 <span class="comment">fixed some ugly pointer bugs (thanks dblack and a|KK|y!)</span>
-00012 <span class="comment"></span>
-00013 <span class="comment">Revision 1.4  2003/01/15 22:47:44  brain</span>
-00014 <span class="comment">Changed user and channel structs to classes (finally)</span>
-00015 <span class="comment"></span>
-00016 <span class="comment">   </span>
-00017 <span class="comment">*/</span>
-00018 
-00019 <span class="preprocessor">#include "inspircd_config.h"</span>
-00020 <span class="preprocessor">#include &lt;time.h&gt;</span>
-00021 <span class="preprocessor">#include &lt;vector&gt;</span>
-00022 
-00023 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
-00024 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
-00025 <span class="preprocessor"></span>
-<a name="l00029"></a><a class="code" href="classHostItem.html">00029</a> <span class="keyword">class </span><a class="code" href="classHostItem.html">HostItem</a>
-00030 {
-00031  <span class="keyword">public</span>:
-<a name="l00032"></a><a class="code" href="classHostItem.html#m0">00032</a>         time_t <a class="code" href="classHostItem.html#m0">set_time</a>;
-<a name="l00033"></a><a class="code" href="classHostItem.html#m1">00033</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m1">set_by</a>[NICKMAX];
-<a name="l00034"></a><a class="code" href="classHostItem.html#m2">00034</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m2">data</a>[MAXBUF];
-00035 
-<a name="l00036"></a><a class="code" href="classHostItem.html#a0">00036</a>         <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> }
-<a name="l00037"></a><a class="code" href="classHostItem.html#a1">00037</a>         <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> }
-00038 };
-00039 
-00040 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
-00041 <span class="comment">// reasons only</span>
-00042 
-<a name="l00045"></a><a class="code" href="classBanItem.html">00045</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>
-00046 {
-00047 };
-00048 
-00049 <span class="comment">// same with this...</span>
+00004 <span class="comment">Revision 1.2  2003/01/26 23:52:59  brain</span>
+00005 <span class="comment">Modified documentation for base classes</span>
+00006 <span class="comment">Added base classes</span>
+00007 <span class="comment"></span>
+00008 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
+00009 <span class="comment">InspIRCd second source tree</span>
+00010 <span class="comment"></span>
+00011 <span class="comment">Revision 1.7  2003/01/22 00:44:26  brain</span>
+00012 <span class="comment">Added documentation comments</span>
+00013 <span class="comment"></span>
+00014 <span class="comment">Revision 1.6  2003/01/21 21:11:17  brain</span>
+00015 <span class="comment">Added documentation</span>
+00016 <span class="comment"></span>
+00017 <span class="comment">Revision 1.5  2003/01/16 20:11:55  brain</span>
+00018 <span class="comment">fixed some ugly pointer bugs (thanks dblack and a|KK|y!)</span>
+00019 <span class="comment"></span>
+00020 <span class="comment">Revision 1.4  2003/01/15 22:47:44  brain</span>
+00021 <span class="comment">Changed user and channel structs to classes (finally)</span>
+00022 <span class="comment"></span>
+00023 <span class="comment">   </span>
+00024 <span class="comment">*/</span>
+00025 
+00026 <span class="preprocessor">#include "inspircd_config.h"</span>
+00027 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
+00028 <span class="preprocessor">#include &lt;time.h&gt;</span>
+00029 <span class="preprocessor">#include &lt;vector&gt;</span>
+00030 
+00031 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
+00032 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
+00033 <span class="preprocessor"></span>
+<a name="l00037"></a><a class="code" href="classHostItem.html">00037</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>
+00038 {
+00039  <span class="keyword">public</span>:
+<a name="l00040"></a><a class="code" href="classHostItem.html#m0">00040</a>         time_t <a class="code" href="classHostItem.html#m0">set_time</a>;
+<a name="l00041"></a><a class="code" href="classHostItem.html#m1">00041</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m1">set_by</a>[NICKMAX];
+<a name="l00042"></a><a class="code" href="classHostItem.html#m2">00042</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m2">data</a>[MAXBUF];
+00043 
+<a name="l00044"></a><a class="code" href="classHostItem.html#a0">00044</a>         <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> }
+<a name="l00045"></a><a class="code" href="classHostItem.html#a1">00045</a>         <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> }
+00046 };
+00047 
+00048 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
+00049 <span class="comment">// reasons only</span>
 00050 
-<a name="l00053"></a><a class="code" href="classExemptItem.html">00053</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>
+<a name="l00053"></a><a class="code" href="classBanItem.html">00053</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>
 00054 {
 00055 };
 00056 
-00057 <span class="comment">// and this...</span>
+00057 <span class="comment">// same with this...</span>
 00058 
-<a name="l00061"></a><a class="code" href="classInviteItem.html">00061</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>
+<a name="l00061"></a><a class="code" href="classExemptItem.html">00061</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>
 00062 {
 00063 };
 00064 
-00065 
-<a name="l00068"></a><a class="code" href="channels_8h.html#a5">00068</a> <span class="keyword">typedef</span> vector&lt;BanItem&gt;         <a class="code" href="channels_8h.html#a5">BanList</a>;
-00069 
-<a name="l00072"></a><a class="code" href="channels_8h.html#a6">00072</a> <span class="keyword">typedef</span> vector&lt;ExemptItem&gt;      <a class="code" href="channels_8h.html#a6">ExemptList</a>;
+00065 <span class="comment">// and this...</span>
+00066 
+<a name="l00069"></a><a class="code" href="classInviteItem.html">00069</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>
+00070 {
+00071 };
+00072 
 00073 
-<a name="l00076"></a><a class="code" href="channels_8h.html#a7">00076</a> <span class="keyword">typedef</span> vector&lt;InviteItem&gt;      <a class="code" href="channels_8h.html#a7">InviteList</a>;
+<a name="l00076"></a><a class="code" href="channels_8h.html#a5">00076</a> <span class="keyword">typedef</span> vector&lt;BanItem&gt;         <a class="code" href="channels_8h.html#a5">BanList</a>;
 00077 
-<a name="l00082"></a><a class="code" href="classchanrec.html">00082</a> <span class="keyword">class </span><a class="code" href="classchanrec.html">chanrec</a>
-00083 {
-00084  <span class="keyword">public</span>:
-<a name="l00087"></a><a class="code" href="classchanrec.html#m0">00087</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
-<a name="l00091"></a><a class="code" href="classchanrec.html#m1">00091</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="l00095"></a><a class="code" href="classchanrec.html#m2">00095</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m2">topic</a>[MAXBUF];
-<a name="l00098"></a><a class="code" href="classchanrec.html#m3">00098</a>         time_t <a class="code" href="classchanrec.html#m3">created</a>;
-<a name="l00102"></a><a class="code" href="classchanrec.html#m4">00102</a>         time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
-<a name="l00106"></a><a class="code" href="classchanrec.html#m5">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m5">setby</a>[NICKMAX];
-00107 
-<a name="l00111"></a><a class="code" href="classchanrec.html#m6">00111</a>         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#m6">limit</a>;
-00112         
-<a name="l00116"></a><a class="code" href="classchanrec.html#m7">00116</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m7">key</a>[32];
-00117         
-<a name="l00120"></a><a class="code" href="classchanrec.html#m8">00120</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m8">topiclock</a>;
-00121         
-<a name="l00124"></a><a class="code" href="classchanrec.html#m9">00124</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m9">noexternal</a>;
+<a name="l00080"></a><a class="code" href="channels_8h.html#a6">00080</a> <span class="keyword">typedef</span> vector&lt;ExemptItem&gt;      <a class="code" href="channels_8h.html#a6">ExemptList</a>;
+0008
+<a name="l00084"></a><a class="code" href="channels_8h.html#a7">00084</a> <span class="keyword">typedef</span> vector&lt;InviteItem&gt;      <a class="code" href="channels_8h.html#a7">InviteList</a>;
+00085 
+<a name="l00090"></a><a class="code" href="classchanrec.html">00090</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>
+00091 {
+00092  <span class="keyword">public</span>:
+<a name="l00095"></a><a class="code" href="classchanrec.html#m0">00095</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
+<a name="l00099"></a><a class="code" href="classchanrec.html#m1">00099</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="l00103"></a><a class="code" href="classchanrec.html#m2">00103</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m2">topic</a>[MAXBUF];
+<a name="l00106"></a><a class="code" href="classchanrec.html#m3">00106</a>         time_t <a class="code" href="classchanrec.html#m3">created</a>;
+<a name="l00110"></a><a class="code" href="classchanrec.html#m4">00110</a>         time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
+<a name="l00114"></a><a class="code" href="classchanrec.html#m5">00114</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m5">setby</a>[NICKMAX];
+00115 
+<a name="l00119"></a><a class="code" href="classchanrec.html#m6">00119</a>         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#m6">limit</a>;
+00120         
+<a name="l00124"></a><a class="code" href="classchanrec.html#m7">00124</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m7">key</a>[32];
 00125         
-<a name="l00128"></a><a class="code" href="classchanrec.html#m10">00128</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m10">inviteonly</a>;
+<a name="l00128"></a><a class="code" href="classchanrec.html#m8">00128</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m8">topiclock</a>;
 00129         
-<a name="l00132"></a><a class="code" href="classchanrec.html#m11">00132</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m11">moderated</a>;
+<a name="l00132"></a><a class="code" href="classchanrec.html#m9">00132</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m9">noexternal</a>;
 00133         
-<a name="l00137"></a><a class="code" href="classchanrec.html#m12">00137</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m12">secret</a>;
-00138         
-<a name="l00142"></a><a class="code" href="classchanrec.html#m13">00142</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m13">c_private</a>;
-00143         
-<a name="l00146"></a><a class="code" href="classchanrec.html#m14">00146</a>         <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#m14">bans</a>;
-00147 
-<a name="l00150"></a><a class="code" href="classchanrec.html#a0">00150</a>         <a class="code" href="classchanrec.html#a0">chanrec</a>()
-00151         {
-00152                 strcpy(name,<span class="stringliteral">""</span>);
-00153                 strcpy(custom_modes,<span class="stringliteral">""</span>);
-00154                 strcpy(topic,<span class="stringliteral">""</span>);
-00155                 strcpy(setby,<span class="stringliteral">""</span>);
-00156                 strcpy(key,<span class="stringliteral">""</span>);
-00157                 created = topicset = limit = 0;
-00158                 topiclock = noexternal = inviteonly = moderated = secret = c_private = <span class="keyword">false</span>;
-00159         }
-00160 
-<a name="l00161"></a><a class="code" href="classchanrec.html#a1">00161</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a1">~chanrec</a>() { <span class="comment">/* stub */</span> }
-00162 };
-00163 
-00164 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
-00165 <span class="comment"> * needs to come AFTER struct chanrec */</span>
-00166 
-<a name="l00167"></a><a class="code" href="channels_8h.html#a0">00167</a> <span class="preprocessor">#define UCMODE_OP      1</span>
-<a name="l00168"></a><a class="code" href="channels_8h.html#a1">00168</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
-<a name="l00169"></a><a class="code" href="channels_8h.html#a2">00169</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
-<a name="l00170"></a><a class="code" href="channels_8h.html#a3">00170</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
-<a name="l00171"></a><a class="code" href="channels_8h.html#a4">00171</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
-00172 <span class="preprocessor"></span> 
-<a name="l00178"></a><a class="code" href="classucrec.html">00178</a> <span class="keyword">class </span><a class="code" href="classucrec.html">ucrec</a>
-00179 {
-00180  <span class="keyword">public</span>:
-<a name="l00184"></a><a class="code" href="classucrec.html#m0">00184</a>         <span class="keywordtype">long</span> <a class="code" href="classucrec.html#m0">uc_modes</a>;
-00185         
-<a name="l00189"></a><a class="code" href="classucrec.html#m1">00189</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#m1">channel</a>;
-00190 
-<a name="l00191"></a><a class="code" href="classucrec.html#a0">00191</a>         <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
-<a name="l00192"></a><a class="code" href="classucrec.html#a1">00192</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
-00193 };
-00194 
-00195 <span class="preprocessor">#endif</span>
-00196 <span class="preprocessor"></span>
-</pre></div><hr><address style="align: right;"><small>Generated on Wed Jan 22 20:56:46 2003 for InspIRCd by
+<a name="l00136"></a><a class="code" href="classchanrec.html#m10">00136</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m10">inviteonly</a>;
+00137         
+<a name="l00140"></a><a class="code" href="classchanrec.html#m11">00140</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m11">moderated</a>;
+00141         
+<a name="l00145"></a><a class="code" href="classchanrec.html#m12">00145</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m12">secret</a>;
+00146         
+<a name="l00150"></a><a class="code" href="classchanrec.html#m13">00150</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m13">c_private</a>;
+00151         
+<a name="l00154"></a><a class="code" href="classchanrec.html#m14">00154</a>         <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#m14">bans</a>;
+00155 
+<a name="l00158"></a><a class="code" href="classchanrec.html#a0">00158</a>         <a class="code" href="classchanrec.html#a0">chanrec</a>()
+00159         {
+00160                 strcpy(name,<span class="stringliteral">""</span>);
+00161                 strcpy(custom_modes,<span class="stringliteral">""</span>);
+00162                 strcpy(topic,<span class="stringliteral">""</span>);
+00163                 strcpy(setby,<span class="stringliteral">""</span>);
+00164                 strcpy(key,<span class="stringliteral">""</span>);
+00165                 created = topicset = limit = 0;
+00166                 topiclock = noexternal = inviteonly = moderated = secret = c_private = <span class="keyword">false</span>;
+00167         }
+00168 
+<a name="l00169"></a><a class="code" href="classchanrec.html#a1">00169</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a1">~chanrec</a>() { <span class="comment">/* stub */</span> }
+00170 };
+00171 
+00172 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
+00173 <span class="comment"> * needs to come AFTER struct chanrec */</span>
+00174 
+<a name="l00175"></a><a class="code" href="channels_8h.html#a0">00175</a> <span class="preprocessor">#define UCMODE_OP      1</span>
+<a name="l00176"></a><a class="code" href="channels_8h.html#a1">00176</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
+<a name="l00177"></a><a class="code" href="channels_8h.html#a2">00177</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
+<a name="l00178"></a><a class="code" href="channels_8h.html#a3">00178</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
+<a name="l00179"></a><a class="code" href="channels_8h.html#a4">00179</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
+00180 <span class="preprocessor"></span> 
+<a name="l00186"></a><a class="code" href="classucrec.html">00186</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>
+00187 {
+00188  <span class="keyword">public</span>:
+<a name="l00192"></a><a class="code" href="classucrec.html#m0">00192</a>         <span class="keywordtype">long</span> <a class="code" href="classucrec.html#m0">uc_modes</a>;
+00193         
+<a name="l00197"></a><a class="code" href="classucrec.html#m1">00197</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#m1">channel</a>;
+00198 
+<a name="l00199"></a><a class="code" href="classucrec.html#a0">00199</a>         <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
+<a name="l00200"></a><a class="code" href="classucrec.html#a1">00200</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
+00201 };
+00202 
+00203 <span class="preprocessor">#endif</span>
+00204 <span class="preprocessor"></span>
+</pre></div><hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:40 2003 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-rc2 </small></address>