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.1  2003/01/23 19:45:57  brain
  13 00003 <span class="comment">Initial revision
  14 00003 <span class="comment">
  15 00003 <span class="comment">Revision 1.6  2003/01/22 20:59:12  brain
  16 00003 <span class="comment">Added FileReader class documentation
  17 00003 <span class="comment"></span>
  18 00004 <span class="comment">Revision 1.7  2003/01/22 00:44:26  brain</span>
  19 00005 <span class="comment">Added documentation comments</span>
  20 00006 <span class="comment"></span>
  21 00007 <span class="comment">Revision 1.6  2003/01/21 21:11:17  brain</span>
  22 00008 <span class="comment">Added documentation</span>
  23 00009 <span class="comment"></span>
  24 00010 <span class="comment">Revision 1.5  2003/01/16 20:11:55  brain</span>
  25 00011 <span class="comment">fixed some ugly pointer bugs (thanks dblack and a|KK|y!)</span>
  26 00012 <span class="comment"></span>
  27 00013 <span class="comment">Revision 1.4  2003/01/15 22:47:44  brain</span>
  28 00014 <span class="comment">Changed user and channel structs to classes (finally)</span>
  29 00015 <span class="comment"></span>
  30 00016 <span class="comment">   </span>
  31 00017 <span class="comment">*/</span>
  32 00018
  33 00019 <span class="preprocessor">#include "inspircd_config.h"</span>
  34 00020 <span class="preprocessor">#include &lt;time.h&gt;</span>
  35 00021 <span class="preprocessor">#include &lt;vector&gt;</span>
  36 00022
  37 00023 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
  38 00024 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
  39 00025 <span class="preprocessor"></span>
  40 <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>
  41 00030 {
  42 00031  <span class="keyword">public</span>:
  43 <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>;
  44 <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];
  45 <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];
  46 00035
  47 <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> }
  48 <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> }
  49 00038 };
  50 00039
  51 00040 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
  52 00041 <span class="comment">// reasons only</span>
  53 00042
  54 <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>
  55 00046 {
  56 00047 };
  57 00048
  58 00049 <span class="comment">// same with this...</span>
  59 00050
  60 <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>
  61 00054 {
  62 00055 };
  63 00056
  64 00057 <span class="comment">// and this...</span>
  65 00058
  66 <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>
  67 00062 {
  68 00063 };
  69 00064
  70 00065
  71 <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>;
  72 00069
  73 <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>;
  74 00073
  75 <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>;
  76 00077
  77 <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>
  78 00083 {
  79 00084  <span class="keyword">public</span>:
  80 <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>
  81 <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>
  82 <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];
  83 <a name="l00098"></a><a class="code" href="classchanrec.html#m3">00098</a>         time_t <a class="code" href="classchanrec.html#m3">created</a>;
  84 <a name="l00102"></a><a class="code" href="classchanrec.html#m4">00102</a>         time_t <a class="code" href="classchanrec.html#m4">topicset</a>;
  85 <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];
  86 00107
  87 <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>;
  88 00112
  89 <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];
  90 00117
  91 <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>;
  92 00121
  93 <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>;
  94 00125
  95 <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>;
  96 00129
  97 <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>;
  98 00133
  99 <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>;
 100 00138
 101 <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>;
 102 00143
 103 <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>;
 104 00147
 105 <a name="l00150"></a><a class="code" href="classchanrec.html#a0">00150</a>         <a class="code" href="classchanrec.html#a0">chanrec</a>()
 106 00151         {
 107 00152                 strcpy(name,<span class="stringliteral">""</span>);
 108 00153                 strcpy(custom_modes,<span class="stringliteral">""</span>);
 109 00154                 strcpy(topic,<span class="stringliteral">""</span>);
 110 00155                 strcpy(setby,<span class="stringliteral">""</span>);
 111 00156                 strcpy(key,<span class="stringliteral">""</span>);
 112 00157                 created = topicset = limit = 0;
 113 00158                 topiclock = noexternal = inviteonly = moderated = secret = c_private = <span class="keyword">false</span>;
 114 00159         }
 115 00160
 116 <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> }
 117 00162 };
 118 00163
 119 00164 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
 120 00165 <span class="comment"> * needs to come AFTER struct chanrec */</span>
 121 00166
 122 <a name="l00167"></a><a class="code" href="channels_8h.html#a0">00167</a> <span class="preprocessor">#define UCMODE_OP      1</span>
 123 <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>
 124 <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>
 125 <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>
 126 <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>
 127 00172 <span class="preprocessor"></span>
 128 <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>
 129 00179 {
 130 00180  <span class="keyword">public</span>:
 131 <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>;
 132 00185
 133 <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>;
 134 00190
 135 <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> }
 136 <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> }
 137 00193 };
 138 00194
 139 00195 <span class="preprocessor">#endif</span>
 140 00196 <span class="preprocessor"></span>
 141 </pre></div><hr><address style="align: right;"><small>Generated on Wed Jan 22 20:56:46 2003 for InspIRCd by
 142 <a href="http://www.doxygen.org/index.html">
 143 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 144 width=110 height=53></a>1.3-rc2 </small></address>
 145 </body>
 146 </html>