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>InspIRCd: channels.h Source File</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <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>
   9 00002 <span class="comment"> *       | Inspire Internet Relay Chat Daemon |</span>
  10 00003 <span class="comment"> *       +------------------------------------+</span>
  11 00004 <span class="comment"> *</span>
  12 00005 <span class="comment"> *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.</span>
  13 00006 <span class="comment"> *                       E-mail:</span>
  14 00007 <span class="comment"> *                &lt;brain@chatspike.net&gt;</span>
  15 00008 <span class="comment"> *                &lt;Craig@chatspike.net&gt;</span>
  16 00009 <span class="comment"> *     </span>
  17 00010 <span class="comment"> * Written by Craig Edwards, Craig McLure, and others.</span>
  18 00011 <span class="comment"> * This program is free but copyrighted software; see</span>
  19 00012 <span class="comment"> *            the file COPYING for details.</span>
  20 00013 <span class="comment"> *</span>
  21 00014 <span class="comment"> * ---------------------------------------------------</span>
  22 00015 <span class="comment"> */</span>
  23 00016
  24 00017 <span class="preprocessor">#include "inspircd_config.h"</span>
  25 00018 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  26 00019 <span class="preprocessor">#include &lt;time.h&gt;</span>
  27 00020 <span class="preprocessor">#include &lt;vector&gt;</span>
  28 00021 <span class="preprocessor">#include &lt;string&gt;</span>
  29 00022
  30 00023 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
  31 00024 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
  32 00025 <span class="preprocessor"></span>
  33 <a name="l00026"></a><a class="code" href="channels_8h.html#a0">00026</a> <span class="preprocessor">#define CM_TOPICLOCK 1</span>
  34 <a name="l00027"></a><a class="code" href="channels_8h.html#a1">00027</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_NOEXTERNAL 2</span>
  35 <a name="l00028"></a><a class="code" href="channels_8h.html#a2">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_INVITEONLY 4</span>
  36 <a name="l00029"></a><a class="code" href="channels_8h.html#a3">00029</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_MODERATED 8</span>
  37 <a name="l00030"></a><a class="code" href="channels_8h.html#a4">00030</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_SECRET 16</span>
  38 <a name="l00031"></a><a class="code" href="channels_8h.html#a5">00031</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_PRIVATE 32</span>
  39 00032 <span class="preprocessor"></span>
  40 <a name="l00036"></a><a class="code" href="classHostItem.html">00036</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>
  41 00037 {
  42 00038  <span class="keyword">public</span>:
  43 <a name="l00039"></a><a class="code" href="classHostItem.html#o0">00039</a>         time_t <a class="code" href="classHostItem.html#o0">set_time</a>;
  44 <a name="l00040"></a><a class="code" href="classHostItem.html#o1">00040</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#o1">set_by</a>[NICKMAX];
  45 <a name="l00041"></a><a class="code" href="classHostItem.html#o2">00041</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#o2">data</a>[MAXBUF];
  46 00042
  47 <a name="l00043"></a><a class="code" href="classHostItem.html#a0">00043</a>         <a class="code" href="classHostItem.html#a0">HostItem</a>() { <span class="comment">/* stub */</span> }
  48 <a name="l00044"></a><a class="code" href="classHostItem.html#a1">00044</a>         <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#a1">~HostItem</a>() { <span class="comment">/* stub */</span> }
  49 00045 };
  50 00046
  51 00047 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
  52 00048 <span class="comment">// reasons only</span>
  53 00049
  54 <a name="l00052"></a><a class="code" href="classBanItem.html">00052</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 00053 {
  56 00054 };
  57 00055
  58 00056 <span class="comment">// same with this...</span>
  59 00057
  60 <a name="l00060"></a><a class="code" href="classExemptItem.html">00060</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 00061 {
  62 00062 };
  63 00063
  64 00064 <span class="comment">// and this...</span>
  65 00065
  66 <a name="l00068"></a><a class="code" href="classInviteItem.html">00068</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 00069 {
  68 00070 };
  69 00071
  70 00072
  71 <a name="l00077"></a><a class="code" href="classModeParameter.html">00077</a> <span class="keyword">class </span><a class="code" href="classModeParameter.html">ModeParameter</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
  72 00078 {
  73 00079  <span class="keyword">public</span>:
  74 <a name="l00080"></a><a class="code" href="classModeParameter.html#o0">00080</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#o0">mode</a>;
  75 <a name="l00081"></a><a class="code" href="classModeParameter.html#o1">00081</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#o1">parameter</a>[MAXBUF];
  76 <a name="l00082"></a><a class="code" href="classModeParameter.html#o2">00082</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#o2">channel</a>[CHANMAX];
  77 00083 };
  78 00084
  79 <a name="l00087"></a><a class="code" href="channels_8h.html#a11">00087</a> <span class="keyword">typedef</span> std::vector&lt;BanItem&gt;    <a class="code" href="channels_8h.html#a11">BanList</a>;
  80 00088
  81 <a name="l00091"></a><a class="code" href="channels_8h.html#a12">00091</a> <span class="keyword">typedef</span> std::vector&lt;ExemptItem&gt; <a class="code" href="channels_8h.html#a12">ExemptList</a>;
  82 00092
  83 <a name="l00095"></a><a class="code" href="channels_8h.html#a13">00095</a> <span class="keyword">typedef</span> std::vector&lt;InviteItem&gt; <a class="code" href="channels_8h.html#a13">InviteList</a>;
  84 00096
  85 <a name="l00101"></a><a class="code" href="classchanrec.html">00101</a> <span class="keyword">class </span><a class="code" href="classchanrec.html">chanrec</a> : <span class="keyword">public</span> <a class="code" href="classExtensible.html">Extensible</a>
  86 00102 {
  87 00103  <span class="keyword">public</span>:
  88 <a name="l00106"></a><a class="code" href="classchanrec.html#o0">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
  89 <a name="l00110"></a><a class="code" href="classchanrec.html#o1">00110</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o1">custom_modes</a>[MAXMODES];     <span class="comment">/* modes handled by modules */</span>
  90 00111
  91 <a name="l00115"></a><a class="code" href="classchanrec.html#o2">00115</a>         std::vector&lt;char*&gt; <a class="code" href="classchanrec.html#o2">internal_userlist</a>;
  92 00116
  93 <a name="l00120"></a><a class="code" href="classchanrec.html#o3">00120</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o3">topic</a>[MAXBUF];
  94 <a name="l00123"></a><a class="code" href="classchanrec.html#o4">00123</a>         time_t <a class="code" href="classchanrec.html#o4">created</a>;
  95 <a name="l00127"></a><a class="code" href="classchanrec.html#o5">00127</a>         time_t <a class="code" href="classchanrec.html#o5">topicset</a>;
  96 <a name="l00131"></a><a class="code" href="classchanrec.html#o6">00131</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o6">setby</a>[NICKMAX];
  97 00132
  98 <a name="l00136"></a><a class="code" href="classchanrec.html#o7">00136</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o7">limit</a>;
  99 00137
 100 <a name="l00141"></a><a class="code" href="classchanrec.html#o8">00141</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o8">key</a>[32];
 101 00142
 102 <a name="l00145"></a><a class="code" href="classchanrec.html#o9">00145</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o9">binarymodes</a>;
 103 00146
 104 <a name="l00149"></a><a class="code" href="classchanrec.html#o10">00149</a>         <a class="code" href="channels_8h.html#a11">BanList</a> <a class="code" href="classchanrec.html#o10">bans</a>;
 105 00150
 106 00153         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a0">SetCustomMode</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">bool</span> mode_on);
 107 00154
 108 00157         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a1">SetCustomModeParam</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">char</span>* parameter,<span class="keywordtype">bool</span> mode_on);
 109 00158
 110 00161         <span class="keywordtype">bool</span> <a class="code" href="classchanrec.html#a2">IsCustomModeSet</a>(<span class="keywordtype">char</span> mode);
 111 00162
 112 00169         std::string <a class="code" href="classchanrec.html#a3">GetModeParameter</a>(<span class="keywordtype">char</span> mode);
 113 00170
 114 00176         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#a4">GetUserCounter</a>();
 115 00177
 116 00183         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a5">AddUser</a>(<span class="keywordtype">char</span>* castuser);
 117 00184
 118 00190         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a6">DelUser</a>(<span class="keywordtype">char</span>* castuser);
 119 00191
 120 00199         std::vector&lt;char*&gt; *<a class="code" href="classchanrec.html#a7">GetUsers</a>();
 121 00200
 122 00203         <a class="code" href="classchanrec.html#a8">chanrec</a>();
 123 00204
 124 <a name="l00205"></a><a class="code" href="classchanrec.html#a9">00205</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a9">~chanrec</a>() { <span class="comment">/* stub */</span> }
 125 00206 };
 126 00207
 127 00208 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
 128 00209 <span class="comment"> * needs to come AFTER struct chanrec */</span>
 129 00210
 130 <a name="l00211"></a><a class="code" href="channels_8h.html#a6">00211</a> <span class="preprocessor">#define UCMODE_OP      1</span>
 131 <a name="l00212"></a><a class="code" href="channels_8h.html#a7">00212</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
 132 <a name="l00213"></a><a class="code" href="channels_8h.html#a8">00213</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
 133 <a name="l00214"></a><a class="code" href="channels_8h.html#a9">00214</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
 134 <a name="l00215"></a><a class="code" href="channels_8h.html#a10">00215</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
 135 00216 <span class="preprocessor"></span>
 136 <a name="l00222"></a><a class="code" href="classucrec.html">00222</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>
 137 00223 {
 138 00224  <span class="keyword">public</span>:
 139 <a name="l00228"></a><a class="code" href="classucrec.html#o0">00228</a>         <span class="keywordtype">char</span> <a class="code" href="classucrec.html#o0">uc_modes</a>;
 140 00229
 141 <a name="l00233"></a><a class="code" href="classucrec.html#o1">00233</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#o1">channel</a>;
 142 00234
 143 <a name="l00235"></a><a class="code" href="classucrec.html#a0">00235</a>         <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
 144 <a name="l00236"></a><a class="code" href="classucrec.html#a1">00236</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
 145 00237 };
 146 00238
 147 00239 <span class="preprocessor">#endif</span>
 148 00240 <span class="preprocessor"></span>
 149 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:58:42 2005 for InspIRCd by
 150 <a href="http://www.doxygen.org/index.html">
 151 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 152 </a>1.3.3 </small></address>
 153 </body>
 154 </html>