summaryrefslogtreecommitdiff
path: root/docs/module-doc/channels_8h-source.html
blob: 3a203ce1f1b2029e9d69df233b2538abe1a74f81 (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
147
148
149
150
151
<!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.5  2003/01/27 00:28:57  brain
00003 <span class="comment">...
00003 <span class="comment"></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="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">// same with this...</span>
00058 
<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 <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#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="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>;
00081 
<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#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#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="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:23:10 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>