inspircd/docs/module-doc/channels_8h-source.html
2003-01-26 23:52:48 +00:00

148 lines
12 KiB
HTML

<!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.3 2003/01/26 23:52:47 brain
00003 <span class="comment">Modified documentation for base classes
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 "<a class="code" href="base_8h.html">base.h</a>"</span>
00024 <span class="preprocessor">#include &lt;time.h&gt;</span>
00025 <span class="preprocessor">#include &lt;vector&gt;</span>
00026
00027 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
00029 <span class="preprocessor"></span>
<a name="l00033"></a><a class="code" href="classHostItem.html">00033</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>
00034 {
00035 <span class="keyword">public</span>:
<a name="l00036"></a><a class="code" href="classHostItem.html#m0">00036</a> time_t <a class="code" href="classHostItem.html#m0">set_time</a>;
<a name="l00037"></a><a class="code" href="classHostItem.html#m1">00037</a> <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m1">set_by</a>[NICKMAX];
<a name="l00038"></a><a class="code" href="classHostItem.html#m2">00038</a> <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#m2">data</a>[MAXBUF];
00039
<a name="l00040"></a><a class="code" href="classHostItem.html#a0">00040</a> <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> }
<a name="l00041"></a><a class="code" href="classHostItem.html#a1">00041</a> <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> }
00042 };
00043
00044 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
00045 <span class="comment">// reasons only</span>
00046
<a name="l00049"></a><a class="code" href="classBanItem.html">00049</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>
00050 {
00051 };
00052
00053 <span class="comment">// same with this...</span>
00054
<a name="l00057"></a><a class="code" href="classExemptItem.html">00057</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>
00058 {
00059 };
00060
00061 <span class="comment">// and this...</span>
00062
<a name="l00065"></a><a class="code" href="classInviteItem.html">00065</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>
00066 {
00067 };
00068
00069
<a name="l00072"></a><a class="code" href="channels_8h.html#a5">00072</a> <span class="keyword">typedef</span> vector&lt;BanItem&gt; <a class="code" href="channels_8h.html#a5">BanList</a>;
00073
<a name="l00076"></a><a class="code" href="channels_8h.html#a6">00076</a> <span class="keyword">typedef</span> vector&lt;ExemptItem&gt; <a class="code" href="channels_8h.html#a6">ExemptList</a>;
00077
<a name="l00080"></a><a class="code" href="channels_8h.html#a7">00080</a> <span class="keyword">typedef</span> vector&lt;InviteItem&gt; <a class="code" href="channels_8h.html#a7">InviteList</a>;
00081
<a name="l00086"></a><a class="code" href="classchanrec.html">00086</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>
00087 {
00088 <span class="keyword">public</span>:
<a name="l00091"></a><a class="code" href="classchanrec.html#m0">00091</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
<a name="l00095"></a><a class="code" href="classchanrec.html#m1">00095</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="l00099"></a><a class="code" href="classchanrec.html#m2">00099</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m2">topic</a>[MAXBUF];
<a name="l00102"></a><a class="code" href="classchanrec.html#m3">00102</a> time_t <a class="code" href="classchanrec.html#m3">created</a>;
<a name="l00106"></a><a class="code" href="classchanrec.html#m4">00106</a> time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
<a name="l00110"></a><a class="code" href="classchanrec.html#m5">00110</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m5">setby</a>[NICKMAX];
00111
<a name="l00115"></a><a class="code" href="classchanrec.html#m6">00115</a> <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#m6">limit</a>;
00116
<a name="l00120"></a><a class="code" href="classchanrec.html#m7">00120</a> <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#m7">key</a>[32];
00121
<a name="l00124"></a><a class="code" href="classchanrec.html#m8">00124</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m8">topiclock</a>;
00125
<a name="l00128"></a><a class="code" href="classchanrec.html#m9">00128</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m9">noexternal</a>;
00129
<a name="l00132"></a><a class="code" href="classchanrec.html#m10">00132</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m10">inviteonly</a>;
00133
<a name="l00136"></a><a class="code" href="classchanrec.html#m11">00136</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m11">moderated</a>;
00137
<a name="l00141"></a><a class="code" href="classchanrec.html#m12">00141</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m12">secret</a>;
00142
<a name="l00146"></a><a class="code" href="classchanrec.html#m13">00146</a> <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#m13">c_private</a>;
00147
<a name="l00150"></a><a class="code" href="classchanrec.html#m14">00150</a> <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#m14">bans</a>;
00151
<a name="l00154"></a><a class="code" href="classchanrec.html#a0">00154</a> <a class="code" href="classchanrec.html#a0">chanrec</a>()
00155 {
00156 strcpy(name,<span class="stringliteral">""</span>);
00157 strcpy(custom_modes,<span class="stringliteral">""</span>);
00158 strcpy(topic,<span class="stringliteral">""</span>);
00159 strcpy(setby,<span class="stringliteral">""</span>);
00160 strcpy(key,<span class="stringliteral">""</span>);
00161 created = topicset = limit = 0;
00162 topiclock = noexternal = inviteonly = moderated = secret = c_private = <span class="keyword">false</span>;
00163 }
00164
<a name="l00165"></a><a class="code" href="classchanrec.html#a1">00165</a> <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a1">~chanrec</a>() { <span class="comment">/* stub */</span> }
00166 };
00167
00168 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
00169 <span class="comment"> * needs to come AFTER struct chanrec */</span>
00170
<a name="l00171"></a><a class="code" href="channels_8h.html#a0">00171</a> <span class="preprocessor">#define UCMODE_OP 1</span>
<a name="l00172"></a><a class="code" href="channels_8h.html#a1">00172</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE 2</span>
<a name="l00173"></a><a class="code" href="channels_8h.html#a2">00173</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP 4</span>
<a name="l00174"></a><a class="code" href="channels_8h.html#a3">00174</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
<a name="l00175"></a><a class="code" href="channels_8h.html#a4">00175</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
00176 <span class="preprocessor"></span>
<a name="l00182"></a><a class="code" href="classucrec.html">00182</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>
00183 {
00184 <span class="keyword">public</span>:
<a name="l00188"></a><a class="code" href="classucrec.html#m0">00188</a> <span class="keywordtype">long</span> <a class="code" href="classucrec.html#m0">uc_modes</a>;
00189
<a name="l00193"></a><a class="code" href="classucrec.html#m1">00193</a> <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#m1">channel</a>;
00194
<a name="l00195"></a><a class="code" href="classucrec.html#a0">00195</a> <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
<a name="l00196"></a><a class="code" href="classucrec.html#a1">00196</a> <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
00197 };
00198
00199 <span class="preprocessor">#endif</span>
00200 <span class="preprocessor"></span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:47 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>