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="l00108"></a><a class="code" href="classchanrec.html#o2">00108</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o2">topic</a>[MAXBUF];
  85 <a name="l00111"></a><a class="code" href="classchanrec.html#o3">00111</a>         time_t <a class="code" href="classchanrec.html#o3">created</a>;
  86 <a name="l00115"></a><a class="code" href="classchanrec.html#o4">00115</a>         time_t <a class="code" href="classchanrec.html#o4">topicset</a>;
  87 <a name="l00119"></a><a class="code" href="classchanrec.html#o5">00119</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o5">setby</a>[NICKMAX];
  88 00120
  89 <a name="l00124"></a><a class="code" href="classchanrec.html#o6">00124</a>         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#o6">limit</a>;
  90 00125
  91 <a name="l00129"></a><a class="code" href="classchanrec.html#o7">00129</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#o7">key</a>[32];
  92 00130
  93 <a name="l00133"></a><a class="code" href="classchanrec.html#o8">00133</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o8">topiclock</a>;
  94 00134
  95 <a name="l00137"></a><a class="code" href="classchanrec.html#o9">00137</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o9">noexternal</a>;
  96 00138
  97 <a name="l00141"></a><a class="code" href="classchanrec.html#o10">00141</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o10">inviteonly</a>;
  98 00142
  99 <a name="l00145"></a><a class="code" href="classchanrec.html#o11">00145</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o11">moderated</a>;
 100 00146
 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">secret</a>;
 102 00151
 103 <a name="l00155"></a><a class="code" href="classchanrec.html#o13">00155</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#o13">c_private</a>;
 104 00156
 105 <a name="l00159"></a><a class="code" href="classchanrec.html#o14">00159</a>         <a class="code" href="channels_8h.html#a5">BanList</a> <a class="code" href="classchanrec.html#o14">bans</a>;
 106 00160
 107 00163         <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);
 108 00164
 109 00167         <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);
 110 00168
 111 00171         <span class="keywordtype">bool</span> <a class="code" href="classchanrec.html#a2">IsCustomModeSet</a>(<span class="keywordtype">char</span> mode);
 112 00172
 113 00179         std::string <a class="code" href="classchanrec.html#a3">GetModeParameter</a>(<span class="keywordtype">char</span> mode);
 114 00180
 115 00183         <a class="code" href="classchanrec.html#a4">chanrec</a>();
 116 00184
 117 <a name="l00185"></a><a class="code" href="classchanrec.html#a5">00185</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#a5">~chanrec</a>() { <span class="comment">/* stub */</span> }
 118 00186 };
 119 00187
 120 00188 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
 121 00189 <span class="comment"> * needs to come AFTER struct chanrec */</span>
 122 00190
 123 <a name="l00191"></a><a class="code" href="channels_8h.html#a0">00191</a> <span class="preprocessor">#define UCMODE_OP      1</span>
 124 <a name="l00192"></a><a class="code" href="channels_8h.html#a1">00192</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
 125 <a name="l00193"></a><a class="code" href="channels_8h.html#a2">00193</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
 126 <a name="l00194"></a><a class="code" href="channels_8h.html#a3">00194</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
 127 <a name="l00195"></a><a class="code" href="channels_8h.html#a4">00195</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
 128 00196 <span class="preprocessor"></span>
 129 <a name="l00202"></a><a class="code" href="classucrec.html">00202</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>
 130 00203 {
 131 00204  <span class="keyword">public</span>:
 132 <a name="l00208"></a><a class="code" href="classucrec.html#o0">00208</a>         <span class="keywordtype">long</span> <a class="code" href="classucrec.html#o0">uc_modes</a>;
 133 00209
 134 <a name="l00213"></a><a class="code" href="classucrec.html#o1">00213</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#o1">channel</a>;
 135 00214
 136 <a name="l00215"></a><a class="code" href="classucrec.html#a0">00215</a>         <a class="code" href="classucrec.html#a0">ucrec</a>() { <span class="comment">/* stub */</span> }
 137 <a name="l00216"></a><a class="code" href="classucrec.html#a1">00216</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#a1">~ucrec</a>() { <span class="comment">/* stub */</span> }
 138 00217 };
 139 00218
 140 00219 <span class="preprocessor">#endif</span>
 141 00220 <span class="preprocessor"></span>
 142 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Apr 9 14:38:24 2005 for InspIRCd by
 143 <a href="http://www.doxygen.org/index.html">
 144 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 145 </a>1.3.3 </small></address>
 146 </body>
 147 </html>