summaryrefslogtreecommitdiff
path: root/docs/module-doc/channels_8h-source.html
blob: ba7592c81c77c1a4c1fb1b606c02ccf38abdeaee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<!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">
</head><body>
<!-- Generated by Doxygen 1.3-rc2 -->
<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.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"></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>
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>
00054 {
00055 };
00056 
00057 <span class="comment">// and 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>
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>;
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>;
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>;
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>;
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>;
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 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>
</body>
</html>