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="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc2 -->
   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">$Log$
  12 00003 <span class="comment">Revision 1.4  2003/01/27 00:22:39  brain
  13 00003 <span class="comment">Modified documentation
  14 00003 <span class="comment"></span>
  15 00004 <span class="comment">Revision 1.2  2003/01/26 23:52:59  brain</span>
  16 00005 <span class="comment">Modified documentation for base classes</span>
  17 00006 <span class="comment">Added base classes</span>
  18 00007 <span class="comment"></span>
  19 00008 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
  20 00009 <span class="comment">InspIRCd second source tree</span>
  21 00010 <span class="comment"></span>
  22 00011 <span class="comment">Revision 1.7  2003/01/22 00:44:26  brain</span>
  23 00012 <span class="comment">Added documentation comments</span>
  24 00013 <span class="comment"></span>
  25 00014 <span class="comment">Revision 1.6  2003/01/21 21:11:17  brain</span>
  26 00015 <span class="comment">Added documentation</span>
  27 00016 <span class="comment"></span>
  28 00017 <span class="comment">Revision 1.5  2003/01/16 20:11:55  brain</span>
  29 00018 <span class="comment">fixed some ugly pointer bugs (thanks dblack and a|KK|y!)</span>
  30 00019 <span class="comment"></span>
  31 00020 <span class="comment">Revision 1.4  2003/01/15 22:47:44  brain</span>
  32 00021 <span class="comment">Changed user and channel structs to classes (finally)</span>
  33 00022 <span class="comment"></span>
  34 00023 <span class="comment">   </span>
  35 00024 <span class="comment">*/</span>
  36 00025
  37 00026 <span class="preprocessor">#include "inspircd_config.h"</span>
  38 00027 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  39 00028 <span class="preprocessor">#include &lt;time.h&gt;</span>
  40 00029 <span class="preprocessor">#include &lt;vector&gt;</span>
  41 00030
  42 00031 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
  43 00032 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
  44 00033 <span class="preprocessor"></span>
  45 <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>
  46 00038 {
  47 00039  <span class="keyword">public</span>:
  48 <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>;
  49 <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];
  50 <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];
  51 00043
  52 <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> }
  53 <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> }
  54 00046 };
  55 00047
  56 00048 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
  57 00049 <span class="comment">// reasons only</span>
  58 00050
  59 <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>
  60 00054 {
  61 00055 };
  62 00056
  63 00057 <span class="comment">// same with this...</span>
  64 00058
  65 <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>
  66 00062 {
  67 00063 };
  68 00064
  69 00065 <span class="comment">// and this...</span>
  70 00066
  71 <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>
  72 00070 {
  73 00071 };
  74 00072
  75 00073
  76 <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>;
  77 00077
  78 <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>;
  79 00081
  80 <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>;
  81 00085
  82 <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>
  83 00091 {
  84 00092  <span class="keyword">public</span>:
  85 <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>
  86 <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>
  87 <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];
  88 <a name="l00106"></a><a class="code" href="classchanrec.html#m3">00106</a>         time_t <a class="code" href="classchanrec.html#m3">created</a>;
  89 <a name="l00110"></a><a class="code" href="classchanrec.html#m4">00110</a>         time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
  90 <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];
  91 00115
  92 <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>;
  93 00120
  94 <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];
  95 00125
  96 <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>;
  97 00129
  98 <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>;
  99 00133
 100 <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>;
 101 00137
 102 <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>;
 103 00141
 104 <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>;
 105 00146
 106 <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>;
 107 00151
 108 <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>;
 109 00155
 110 <a name="l00158"></a><a class="code" href="classchanrec.html#a0">00158</a>         <a class="code" href="classchanrec.html#a0">chanrec</a>()
 111 00159         {
 112 00160                 strcpy(name,<span class="stringliteral">""</span>);
 113 00161                 strcpy(custom_modes,<span class="stringliteral">""</span>);
 114 00162                 strcpy(topic,<span class="stringliteral">""</span>);
 115 00163                 strcpy(setby,<span class="stringliteral">""</span>);
 116 00164                 strcpy(key,<span class="stringliteral">""</span>);
 117 00165                 created = topicset = limit = 0;
 118 00166                 topiclock = noexternal = inviteonly = moderated = secret = c_private = <span class="keyword">false</span>;
 119 00167         }
 120 00168
 121 <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> }
 122 00170 };
 123 00171
 124 00172 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
 125 00173 <span class="comment"> * needs to come AFTER struct chanrec */</span>
 126 00174
 127 <a name="l00175"></a><a class="code" href="channels_8h.html#a0">00175</a> <span class="preprocessor">#define UCMODE_OP      1</span>
 128 <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>
 129 <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>
 130 <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>
 131 <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>
 132 00180 <span class="preprocessor"></span>
 133 <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>
 134 00187 {
 135 00188  <span class="keyword">public</span>:
 136 <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>;
 137 00193
 138 <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>;
 139 00198
 140 <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> }
 141 <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> }
 142 00201 };
 143 00202
 144 00203 <span class="preprocessor">#endif</span>
 145 00204 <span class="preprocessor"></span>
 146 </pre></div><hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:40 2003 for InspIRCd by
 147 <a href="http://www.doxygen.org/index.html">
 148 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 149 width=110 height=53></a>1.3-rc2 </small></address>
 150 </body>
 151 </html>