]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - 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
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>channels.h Source File</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3-rc3 -->
7 <center>
8 <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>
9 <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>
10 00002 <span class="comment"></span>
11 00003 <span class="comment">   </span>
12 00004 <span class="comment">*/</span>
13 00005 
14 00006 <span class="preprocessor">#include "inspircd_config.h"</span>
15 00007 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
16 00008 <span class="preprocessor">#include &lt;time.h&gt;</span>
17 00009 <span class="preprocessor">#include &lt;vector&gt;</span>
18 00010 
19 00011 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
20 00012 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
21 00013 <span class="preprocessor"></span>
22 <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>
23 00018 {
24 00019  <span class="keyword">public</span>:
25 <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>;
26 <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];
27 <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];
28 00023 
29 <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> }
30 <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> }
31 00026 };
32 00027 
33 00028 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
34 00029 <span class="comment">// reasons only</span>
35 00030 
36 <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>
37 00034 {
38 00035 };
39 00036 
40 00037 <span class="comment">// same with this...</span>
41 00038 
42 <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>
43 00042 {
44 00043 };
45 00044 
46 00045 <span class="comment">// and this...</span>
47 00046 
48 <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>
49 00050 {
50 00051 };
51 00052 
52 00053 
53 <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>;
54 00057 
55 <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>;
56 00061 
57 <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>;
58 00065 
59 <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>
60 00071 {
61 00072  <span class="keyword">public</span>:
62 <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>
63 <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>
64 <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];
65 <a name="l00086"></a><a class="code" href="classchanrec.html#m3">00086</a>         time_t <a class="code" href="classchanrec.html#m3">created</a>;
66 <a name="l00090"></a><a class="code" href="classchanrec.html#m4">00090</a>         time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
67 <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];
68 00095 
69 <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>;
70 00100         
71 <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];
72 00105         
73 <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>;
74 00109         
75 <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>;
76 00113         
77 <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>;
78 00117         
79 <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>;
80 00121         
81 <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>;
82 00126         
83 <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>;
84 00131         
85 <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>;
86 00135         
87 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);
88 00139 
89 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);
90 00143  
91 00146         <a class="code" href="classchanrec.html#a2">chanrec</a>();
92 00147 
93 <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> }
94 00149 };
95 00150 
96 00151 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
97 00152 <span class="comment"> * needs to come AFTER struct chanrec */</span>
98 00153 
99 <a name="l00154"></a><a class="code" href="channels_8h.html#a0">00154</a> <span class="preprocessor">#define UCMODE_OP      1</span>
100 <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>
101 <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>
102 <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>
103 <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>
104 00159 <span class="preprocessor"></span> 
105 <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>
106 00166 {
107 00167  <span class="keyword">public</span>:
108 <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>;
109 00172         
110 <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>;
111 00177 
112 <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> }
113 <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> }
114 00180 };
115 00181 
116 00182 <span class="preprocessor">#endif</span>
117 00183 <span class="preprocessor"></span>
118 </pre></div><hr><address style="align: right;"><small>Generated on Sat Apr 3 16:36:02 2004 for InspIRCd by
119 <a href="http://www.doxygen.org/index.html">
120 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
121 width=110 height=53></a>1.3-rc3 </small></address>
122 </body>
123 </html>