]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/channels_8h-source.html
Added support for module-defined chanmodes with no parameters
[user/henk/code/inspircd.git] / docs / module-doc / channels_8h-source.html
index e7ec3e226a0b3cd88883f9382afb1f48160b7d04..a91e1ac982c3da7252525c93c79c357cead52c3e 100644 (file)
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 <title>channels.h Source File</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="inspircd.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.3-rc2 -->
+<!-- Generated by Doxygen 1.3-rc3 -->
 <center>
 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </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">$Log$
-00003 <span class="comment">Revision 1.2  2003/01/23 20:38:00  brain
-00003 <span class="comment">Updated documentation scripts
-00003 <span class="comment"></span>
-00004 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
-00005 <span class="comment">InspIRCd second source tree</span>
-00006 <span class="comment"></span>
-00007 <span class="comment">Revision 1.7  2003/01/22 00:44:26  brain</span>
-00008 <span class="comment">Added documentation comments</span>
-00009 <span class="comment"></span>
-00010 <span class="comment">Revision 1.6  2003/01/21 21:11:17  brain</span>
-00011 <span class="comment">Added documentation</span>
-00012 <span class="comment"></span>
-00013 <span class="comment">Revision 1.5  2003/01/16 20:11:55  brain</span>
-00014 <span class="comment">fixed some ugly pointer bugs (thanks dblack and a|KK|y!)</span>
-00015 <span class="comment"></span>
-00016 <span class="comment">Revision 1.4  2003/01/15 22:47:44  brain</span>
-00017 <span class="comment">Changed user and channel structs to classes (finally)</span>
-00018 <span class="comment"></span>
-00019 <span class="comment">   </span>
-00020 <span class="comment">*/</span>
-00021 
-00022 <span class="preprocessor">#include "inspircd_config.h"</span>
-00023 <span class="preprocessor">#include &lt;time.h&gt;</span>
-00024 <span class="preprocessor">#include &lt;vector&gt;</span>
-00025 
-00026 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
-00027 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
-00028 <span class="preprocessor"></span>
-<a name="l00032"></a><a class="code" href="classHostItem.html">00032</a> <span class="keyword">class </span><a class="code" href="classHostItem.html">HostItem</a>
-00033 {
-00034  <span class="keyword">public</span>:
-<a name="l00035"></a><a class="code" href="classHostItem.html#m0">00035</a>         time_t <a class="code" href="classHostItem.html#m0">set_time</a>;
-<a name="l00036"></a><a class="code" href="classHostItem.html#m1">00036</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m1">set_by</a>[NICKMAX];
-<a name="l00037"></a><a class="code" href="classHostItem.html#m2">00037</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m2">data</a>[MAXBUF];
+00003 <span class="comment">   </span>
+00004 <span class="comment">*/</span>
+00005 
+00006 <span class="preprocessor">#include "inspircd_config.h"</span>
+00007 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
+00008 <span class="preprocessor">#include &lt;time.h&gt;</span>
+00009 <span class="preprocessor">#include &lt;vector&gt;</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="l00039"></a><a class="code" href="classHostItem.html#a0">00039</a>         <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> }
-<a name="l00040"></a><a class="code" href="classHostItem.html#a1">00040</a>         <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> }
-00041 };
-00042 
-00043 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
-00044 <span class="comment">// reasons only</span>
-00045 
-<a name="l00048"></a><a class="code" href="classBanItem.html">00048</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>
-00049 {
-00050 };
-00051 
-00052 <span class="comment">// same with this...</span>
+<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 
 00053 
-<a name="l00056"></a><a class="code" href="classExemptItem.html">00056</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>
-00057 {
-00058 };
-00059 
-00060 <span class="comment">// and this...</span>
+<a name="l00056"></a><a class="code" href="channels_8h.html#a5">00056</a> <span class="keyword">typedef</span> std::vector&lt;BanItem&gt;    <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&lt;ExemptItem&gt; <a class="code" href="channels_8h.html#a6">ExemptList</a>;
 00061 
-<a name="l00064"></a><a class="code" href="classInviteItem.html">00064</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>
-00065 {
-00066 };
-00067 
-00068 
-<a name="l00071"></a><a class="code" href="channels_8h.html#a5">00071</a> <span class="keyword">typedef</span> vector&lt;BanItem&gt;         <a class="code" href="channels_8h.html#a5">BanList</a>;
-00072 
-<a name="l00075"></a><a class="code" href="channels_8h.html#a6">00075</a> <span class="keyword">typedef</span> vector&lt;ExemptItem&gt;      <a class="code" href="channels_8h.html#a6">ExemptList</a>;
-00076 
-<a name="l00079"></a><a class="code" href="channels_8h.html#a7">00079</a> <span class="keyword">typedef</span> vector&lt;InviteItem&gt;      <a class="code" href="channels_8h.html#a7">InviteList</a>;
-00080 
-<a name="l00085"></a><a class="code" href="classchanrec.html">00085</a> <span class="keyword">class </span><a class="code" href="classchanrec.html">chanrec</a>
-00086 {
-00087  <span class="keyword">public</span>:
-<a name="l00090"></a><a class="code" href="classchanrec.html#m0">00090</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
-<a name="l00094"></a><a class="code" href="classchanrec.html#m1">00094</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="l00098"></a><a class="code" href="classchanrec.html#m2">00098</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m2">topic</a>[MAXBUF];
-<a name="l00101"></a><a class="code" href="classchanrec.html#m3">00101</a>         time_t <a class="code" href="classchanrec.html#m3">created</a>;
-<a name="l00105"></a><a class="code" href="classchanrec.html#m4">00105</a>         time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
-<a name="l00109"></a><a class="code" href="classchanrec.html#m5">00109</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m5">setby</a>[NICKMAX];
-00110 
-<a name="l00114"></a><a class="code" href="classchanrec.html#m6">00114</a>         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#m6">limit</a>;
-00115         
-<a name="l00119"></a><a class="code" href="classchanrec.html#m7">00119</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m7">key</a>[32];
-00120         
-<a name="l00123"></a><a class="code" href="classchanrec.html#m8">00123</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m8">topiclock</a>;
-00124         
-<a name="l00127"></a><a class="code" href="classchanrec.html#m9">00127</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m9">noexternal</a>;
-00128         
-<a name="l00131"></a><a class="code" href="classchanrec.html#m10">00131</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m10">inviteonly</a>;
-00132         
-<a name="l00135"></a><a class="code" href="classchanrec.html#m11">00135</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m11">moderated</a>;
-00136         
-<a name="l00140"></a><a class="code" href="classchanrec.html#m12">00140</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m12">secret</a>;
-00141         
-<a name="l00145"></a><a class="code" href="classchanrec.html#m13">00145</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m13">c_private</a>;
-00146         
-<a name="l00149"></a><a class="code" href="classchanrec.html#m14">00149</a>         <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#m14">bans</a>;
+<a name="l00064"></a><a class="code" href="channels_8h.html#a7">00064</a> <span class="keyword">typedef</span> std::vector&lt;InviteItem&gt; <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>;
+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>;
+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 
-<a name="l00153"></a><a class="code" href="classchanrec.html#a0">00153</a>         <a class="code" href="classchanrec.html#a0">chanrec</a>()
-00154         {
-00155                 strcpy(name,<span class="stringliteral">""</span>);
-00156                 strcpy(custom_modes,<span class="stringliteral">""</span>);
-00157                 strcpy(topic,<span class="stringliteral">""</span>);
-00158                 strcpy(setby,<span class="stringliteral">""</span>);
-00159                 strcpy(key,<span class="stringliteral">""</span>);
-00160                 created = topicset = limit = 0;
-00161                 topiclock = noexternal = inviteonly = moderated = secret = c_private = <span class="keyword">false</span>;
-00162         }
-00163 
-<a name="l00164"></a><a class="code" href="classchanrec.html#a1">00164</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a1">~chanrec</a>() { <span class="comment">/* stub */</span> }
-00165 };
-00166 
-00167 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
-00168 <span class="comment"> * needs to come AFTER struct chanrec */</span>
-00169 
-<a name="l00170"></a><a class="code" href="channels_8h.html#a0">00170</a> <span class="preprocessor">#define UCMODE_OP      1</span>
-<a name="l00171"></a><a class="code" href="channels_8h.html#a1">00171</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
-<a name="l00172"></a><a class="code" href="channels_8h.html#a2">00172</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
-<a name="l00173"></a><a class="code" href="channels_8h.html#a3">00173</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
-<a name="l00174"></a><a class="code" href="channels_8h.html#a4">00174</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
-00175 <span class="preprocessor"></span> 
-<a name="l00181"></a><a class="code" href="classucrec.html">00181</a> <span class="keyword">class </span><a class="code" href="classucrec.html">ucrec</a>
-00182 {
-00183  <span class="keyword">public</span>:
-<a name="l00187"></a><a class="code" href="classucrec.html#m0">00187</a>         <span class="keywordtype">long</span> <a class="code" href="classucrec.html#m0">uc_modes</a>;
-00188         
-<a name="l00192"></a><a class="code" href="classucrec.html#m1">00192</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#m1">channel</a>;
-00193 
-<a name="l00194"></a><a class="code" href="classucrec.html#a0">00194</a>         <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
-<a name="l00195"></a><a class="code" href="classucrec.html#a1">00195</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
-00196 };
-00197 
-00198 <span class="preprocessor">#endif</span>
-00199 <span class="preprocessor"></span>
-</pre></div><hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by
+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>
+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
 <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>
+width=110 height=53></a>1.3-rc3 </small></address>
 </body>
 </html>