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="l00029"></a><a class="code" href="classHostItem.html">00029</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>
  34 00030 {
  35 00031  <span class="keyword">public</span>:
  36 <a name="l00032"></a><a class="code" href="classHostItem.html#o0">00032</a>         time_t <a class="code" href="classHostItem.html#o0">set_time</a>;
  37 <a name="l00033"></a><a class="code" href="classHostItem.html#o1">00033</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#o1">set_by</a>[NICKMAX];
  38 <a name="l00034"></a><a class="code" href="classHostItem.html#o2">00034</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#o2">data</a>[MAXBUF];
  39 00035
  40 <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> }
  41 <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> }
  42 00038 };
  43 00039
  44 00040 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
  45 00041 <span class="comment">// reasons only</span>
  46 00042
  47 <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>
  48 00046 {
  49 00047 };
  50 00048
  51 00049 <span class="comment">// same with this...</span>
  52 00050
  53 <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>
  54 00054 {
  55 00055 };
  56 00056
  57 00057 <span class="comment">// and this...</span>
  58 00058
  59 <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>
  60 00062 {
  61 00063 };
  62 00064
  63 00065
  64 <a name="l00070"></a><a class="code" href="classModeParameter.html">00070</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>
  65 00071 {
  66 00072  <span class="keyword">public</span>:
  67 <a name="l00073"></a><a class="code" href="classModeParameter.html#o0">00073</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#o0">mode</a>;
  68 <a name="l00074"></a><a class="code" href="classModeParameter.html#o1">00074</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#o1">parameter</a>[MAXBUF];
  69 <a name="l00075"></a><a class="code" href="classModeParameter.html#o2">00075</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#o2">channel</a>[CHANMAX];
  70 00076 };
  71 00077
  72 <a name="l00080"></a><a class="code" href="channels_8h.html#a5">00080</a> <span class="keyword">typedef</span> std::vector&lt;BanItem&gt;    <a class="code" href="channels_8h.html#a5">BanList</a>;
  73 00081
  74 <a name="l00084"></a><a class="code" href="channels_8h.html#a6">00084</a> <span class="keyword">typedef</span> std::vector&lt;ExemptItem&gt; <a class="code" href="channels_8h.html#a6">ExemptList</a>;
  75 00085
  76 <a name="l00088"></a><a class="code" href="channels_8h.html#a7">00088</a> <span class="keyword">typedef</span> std::vector&lt;InviteItem&gt; <a class="code" href="channels_8h.html#a7">InviteList</a>;
  77 00089
  78 <a name="l00094"></a><a class="code" href="classchanrec.html">00094</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>
  79 00095 {
  80 00096  <span class="keyword">public</span>:
  81 <a name="l00099"></a><a class="code" href="classchanrec.html#o0">00099</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o0">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
  82 <a name="l00103"></a><a class="code" href="classchanrec.html#o1">00103</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>
  83 00104
  84 <a name="l00107"></a><a class="code" href="classchanrec.html#o2">00107</a>         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#o2">users</a>;
  85 00108
  86 <a name="l00112"></a><a class="code" href="classchanrec.html#o3">00112</a>         std::vector&lt;char*&gt; <a class="code" href="classchanrec.html#o3">internal_userlist</a>;
  87 00113
  88 <a name="l00117"></a><a class="code" href="classchanrec.html#o4">00117</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o4">topic</a>[MAXBUF];
  89 <a name="l00120"></a><a class="code" href="classchanrec.html#o5">00120</a>         time_t <a class="code" href="classchanrec.html#o5">created</a>;
  90 <a name="l00124"></a><a class="code" href="classchanrec.html#o6">00124</a>         time_t <a class="code" href="classchanrec.html#o6">topicset</a>;
  91 <a name="l00128"></a><a class="code" href="classchanrec.html#o7">00128</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o7">setby</a>[NICKMAX];
  92 00129
  93 <a name="l00133"></a><a class="code" href="classchanrec.html#o8">00133</a>         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#o8">limit</a>;
  94 00134
  95 <a name="l00138"></a><a class="code" href="classchanrec.html#o9">00138</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o9">key</a>[32];
  96 00139
  97 <a name="l00142"></a><a class="code" href="classchanrec.html#o10">00142</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o10">topiclock</a>;
  98 00143
  99 <a name="l00146"></a><a class="code" href="classchanrec.html#o11">00146</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o11">noexternal</a>;
 100 00147
 101 <a name="l00150"></a><a class="code" href="classchanrec.html#o12">00150</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o12">inviteonly</a>;
 102 00151
 103 <a name="l00154"></a><a class="code" href="classchanrec.html#o13">00154</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o13">moderated</a>;
 104 00155
 105 <a name="l00159"></a><a class="code" href="classchanrec.html#o14">00159</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o14">secret</a>;
 106 00160
 107 <a name="l00164"></a><a class="code" href="classchanrec.html#o15">00164</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o15">c_private</a>;
 108 00165
 109 <a name="l00168"></a><a class="code" href="classchanrec.html#o16">00168</a>         <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#o16">bans</a>;
 110 00169
 111 00172         <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);
 112 00173
 113 00176         <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);
 114 00177
 115 00180         <span class="keywordtype">bool</span> <a class="code" href="classchanrec.html#a2">IsCustomModeSet</a>(<span class="keywordtype">char</span> mode);
 116 00181
 117 00188         std::string <a class="code" href="classchanrec.html#a3">GetModeParameter</a>(<span class="keywordtype">char</span> mode);
 118 00189
 119 00195         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a4">IncUserCounter</a>();
 120 00196
 121 00204         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a5">DecUserCounter</a>();
 122 00205
 123 00211         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#a6">GetUserCounter</a>();
 124 00212
 125 00218         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a7">AddUser</a>(<span class="keywordtype">char</span>* castuser);
 126 00219
 127 00225         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#a8">DelUser</a>(<span class="keywordtype">char</span>* castuser);
 128 00226
 129 00234         std::vector&lt;char*&gt; *<a class="code" href="classchanrec.html#a9">GetUsers</a>();
 130 00235
 131 00238         <a class="code" href="classchanrec.html#a10">chanrec</a>();
 132 00239
 133 <a name="l00240"></a><a class="code" href="classchanrec.html#a11">00240</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a11">~chanrec</a>() { <span class="comment">/* stub */</span> }
 134 00241 };
 135 00242
 136 00243 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
 137 00244 <span class="comment"> * needs to come AFTER struct chanrec */</span>
 138 00245
 139 <a name="l00246"></a><a class="code" href="channels_8h.html#a0">00246</a> <span class="preprocessor">#define UCMODE_OP      1</span>
 140 <a name="l00247"></a><a class="code" href="channels_8h.html#a1">00247</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
 141 <a name="l00248"></a><a class="code" href="channels_8h.html#a2">00248</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
 142 <a name="l00249"></a><a class="code" href="channels_8h.html#a3">00249</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
 143 <a name="l00250"></a><a class="code" href="channels_8h.html#a4">00250</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
 144 00251 <span class="preprocessor"></span>
 145 <a name="l00257"></a><a class="code" href="classucrec.html">00257</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>
 146 00258 {
 147 00259  <span class="keyword">public</span>:
 148 <a name="l00263"></a><a class="code" href="classucrec.html#o0">00263</a>         <span class="keywordtype">long</span> <a class="code" href="classucrec.html#o0">uc_modes</a>;
 149 00264
 150 <a name="l00268"></a><a class="code" href="classucrec.html#o1">00268</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#o1">channel</a>;
 151 00269
 152 <a name="l00270"></a><a class="code" href="classucrec.html#a0">00270</a>         <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
 153 <a name="l00271"></a><a class="code" href="classucrec.html#a1">00271</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
 154 00272 };
 155 00273
 156 00274 <span class="preprocessor">#endif</span>
 157 00275 <span class="preprocessor"></span>
 158 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:43 2005 for InspIRCd by
 159 <a href="http://www.doxygen.org/index.html">
 160 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 161 </a>1.3.3 </small></address>
 162 </body>
 163 </html>