docs/module-doc/channels_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 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.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   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">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <div class="nav">
   9 <a class="el" href="dir_000000.html">home</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">brain</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000002.html">inspircd-cvs</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000003.html">inspircd</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000004.html">include</a></div>
  10 <h1>channels.h</h1><a href="channels_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*       +------------------------------------+</span>
  11 <a name="l00002"></a>00002 <span class="comment"> *       | Inspire Internet Relay Chat Daemon |</span>
  12 <a name="l00003"></a>00003 <span class="comment"> *       +------------------------------------+</span>
  13 <a name="l00004"></a>00004 <span class="comment"> *</span>
  14 <a name="l00005"></a>00005 <span class="comment"> *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.</span>
  15 <a name="l00006"></a>00006 <span class="comment"> *                       E-mail:</span>
  16 <a name="l00007"></a>00007 <span class="comment"> *                &lt;brain@chatspike.net&gt;</span>
  17 <a name="l00008"></a>00008 <span class="comment"> *                &lt;Craig@chatspike.net&gt;</span>
  18 <a name="l00009"></a>00009 <span class="comment"> *     </span>
  19 <a name="l00010"></a>00010 <span class="comment"> * Written by Craig Edwards, Craig McLure, and others.</span>
  20 <a name="l00011"></a>00011 <span class="comment"> * This program is free but copyrighted software; see</span>
  21 <a name="l00012"></a>00012 <span class="comment"> *            the file COPYING for details.</span>
  22 <a name="l00013"></a>00013 <span class="comment"> *</span>
  23 <a name="l00014"></a>00014 <span class="comment"> * ---------------------------------------------------</span>
  24 <a name="l00015"></a>00015 <span class="comment"> */</span>
  25 <a name="l00016"></a>00016
  26 <a name="l00017"></a>00017 <span class="preprocessor">#include "inspircd_config.h"</span>
  27 <a name="l00018"></a>00018 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  28 <a name="l00019"></a>00019 <span class="preprocessor">#include &lt;time.h&gt;</span>
  29 <a name="l00020"></a>00020 <span class="preprocessor">#include &lt;vector&gt;</span>
  30 <a name="l00021"></a>00021 <span class="preprocessor">#include &lt;string&gt;</span>
  31 <a name="l00022"></a>00022
  32 <a name="l00023"></a>00023 <span class="preprocessor">#ifndef __CHANNELS_H__</span>
  33 <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __CHANNELS_H__</span>
  34 <a name="l00025"></a>00025 <span class="preprocessor"></span>
  35 <a name="l00026"></a><a class="code" href="channels_8h.html#CM_5FTOPICLOCK">00026</a> <span class="preprocessor">#define CM_TOPICLOCK 1</span>
  36 <a name="l00027"></a><a class="code" href="channels_8h.html#CM_5FNOEXTERNAL">00027</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_NOEXTERNAL 2</span>
  37 <a name="l00028"></a><a class="code" href="channels_8h.html#CM_5FINVITEONLY">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_INVITEONLY 4</span>
  38 <a name="l00029"></a><a class="code" href="channels_8h.html#CM_5FMODERATED">00029</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_MODERATED 8</span>
  39 <a name="l00030"></a><a class="code" href="channels_8h.html#CM_5FSECRET">00030</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_SECRET 16</span>
  40 <a name="l00031"></a><a class="code" href="channels_8h.html#CM_5FPRIVATE">00031</a> <span class="preprocessor"></span><span class="preprocessor">#define CM_PRIVATE 32</span>
  41 <a name="l00032"></a>00032 <span class="preprocessor"></span>
  42 <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>
  43 <a name="l00037"></a>00037 {
  44 <a name="l00038"></a>00038  <span class="keyword">public</span>:
  45 <a name="l00039"></a><a class="code" href="classHostItem.html#set_5Ftime">00039</a>         time_t <a class="code" href="classHostItem.html#set_5Ftime">set_time</a>;
  46 <a name="l00040"></a><a class="code" href="classHostItem.html#set_5Fby_5BNICKMAX_5D">00040</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#set_5Fby_5BNICKMAX_5D">set_by</a>[NICKMAX];
  47 <a name="l00041"></a><a class="code" href="classHostItem.html#data_5BMAXBUF_5D">00041</a>         <span class="keywordtype">char</span> <a class="code" href="classHostItem.html#data_5BMAXBUF_5D">data</a>[MAXBUF];
  48 <a name="l00042"></a>00042
  49 <a name="l00043"></a><a class="code" href="classHostItem.html#HostItem_28_29">00043</a>         <a class="code" href="classHostItem.html#HostItem_28_29">HostItem</a>() { <span class="comment">/* stub */</span> }
  50 <a name="l00044"></a><a class="code" href="classHostItem.html#_7EHostItem_28_29">00044</a>         <span class="keyword">virtual</span> <a class="code" href="classHostItem.html#_7EHostItem_28_29">~HostItem</a>() { <span class="comment">/* stub */</span> }
  51 <a name="l00045"></a>00045 };
  52 <a name="l00046"></a>00046
  53 <a name="l00047"></a>00047 <span class="comment">// banlist is inherited from HostList mainly for readability</span>
  54 <a name="l00048"></a>00048 <span class="comment">// reasons only</span>
  55 <a name="l00049"></a>00049
  56 <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>
  57 <a name="l00053"></a>00053 {
  58 <a name="l00054"></a>00054 };
  59 <a name="l00055"></a>00055
  60 <a name="l00056"></a>00056 <span class="comment">// same with this...</span>
  61 <a name="l00057"></a>00057
  62 <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>
  63 <a name="l00061"></a>00061 {
  64 <a name="l00062"></a>00062 };
  65 <a name="l00063"></a>00063
  66 <a name="l00064"></a>00064 <span class="comment">// and this...</span>
  67 <a name="l00065"></a>00065
  68 <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>
  69 <a name="l00069"></a>00069 {
  70 <a name="l00070"></a>00070 };
  71 <a name="l00071"></a>00071
  72 <a name="l00072"></a>00072
  73 <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>
  74 <a name="l00078"></a>00078 {
  75 <a name="l00079"></a>00079  <span class="keyword">public</span>:
  76 <a name="l00080"></a><a class="code" href="classModeParameter.html#mode">00080</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#mode">mode</a>;
  77 <a name="l00081"></a><a class="code" href="classModeParameter.html#parameter_5BMAXBUF_5D">00081</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#parameter_5BMAXBUF_5D">parameter</a>[MAXBUF];
  78 <a name="l00082"></a><a class="code" href="classModeParameter.html#channel_5BCHANMAX_5D">00082</a>         <span class="keywordtype">char</span> <a class="code" href="classModeParameter.html#channel_5BCHANMAX_5D">channel</a>[CHANMAX];
  79 <a name="l00083"></a>00083 };
  80 <a name="l00084"></a>00084
  81 <a name="l00087"></a><a class="code" href="channels_8h.html#BanList">00087</a> <span class="keyword">typedef</span> std::vector&lt;BanItem&gt;    <a class="code" href="channels_8h.html#BanList">BanList</a>;
  82 <a name="l00088"></a>00088
  83 <a name="l00091"></a><a class="code" href="channels_8h.html#ExemptList">00091</a> <span class="keyword">typedef</span> std::vector&lt;ExemptItem&gt; <a class="code" href="channels_8h.html#ExemptList">ExemptList</a>;
  84 <a name="l00092"></a>00092
  85 <a name="l00095"></a><a class="code" href="channels_8h.html#InviteList">00095</a> <span class="keyword">typedef</span> std::vector&lt;InviteItem&gt; <a class="code" href="channels_8h.html#InviteList">InviteList</a>;
  86 <a name="l00096"></a>00096
  87 <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>
  88 <a name="l00102"></a>00102 {
  89 <a name="l00103"></a>00103  <span class="keyword">public</span>:
  90 <a name="l00106"></a><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>[CHANMAX]; <span class="comment">/* channel name */</span>
  91 <a name="l00110"></a><a class="code" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">00110</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">custom_modes</a>[MAXMODES];     <span class="comment">/* modes handled by modules */</span>
  92 <a name="l00111"></a>00111
  93 <a name="l00115"></a><a class="code" href="classchanrec.html#internal_5Fuserlist">00115</a>         std::vector&lt;char*&gt; <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>;
  94 <a name="l00116"></a>00116
  95 <a name="l00120"></a><a class="code" href="classchanrec.html#topic_5BMAXBUF_5D">00120</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#topic_5BMAXBUF_5D">topic</a>[MAXBUF];
  96 <a name="l00123"></a><a class="code" href="classchanrec.html#created">00123</a>         time_t <a class="code" href="classchanrec.html#created">created</a>;
  97 <a name="l00127"></a><a class="code" href="classchanrec.html#topicset">00127</a>         time_t <a class="code" href="classchanrec.html#topicset">topicset</a>;
  98 <a name="l00131"></a><a class="code" href="classchanrec.html#setby_5BNICKMAX_5D">00131</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#setby_5BNICKMAX_5D">setby</a>[NICKMAX];
  99 <a name="l00132"></a>00132
 100 <a name="l00136"></a><a class="code" href="classchanrec.html#limit">00136</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classchanrec.html#limit">limit</a>;
 101 <a name="l00137"></a>00137
 102 <a name="l00141"></a><a class="code" href="classchanrec.html#key_5B_33_32_5D">00141</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#key_5B_33_32_5D">key</a>[32];
 103 <a name="l00142"></a>00142
 104 <a name="l00145"></a><a class="code" href="classchanrec.html#binarymodes">00145</a>         <span class="keywordtype">char</span> <a class="code" href="classchanrec.html#binarymodes">binarymodes</a>;
 105 <a name="l00146"></a>00146
 106 <a name="l00149"></a><a class="code" href="classchanrec.html#bans">00149</a>         <a class="code" href="channels_8h.html#BanList">BanList</a> <a class="code" href="classchanrec.html#bans">bans</a>;
 107 <a name="l00150"></a>00150
 108 <a name="l00155"></a>00155         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#SetCustomMode_28char_20mode_2C_20bool_20mode_5Fon_29">SetCustomMode</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">bool</span> mode_on);
 109 <a name="l00156"></a>00156
 110 <a name="l00162"></a>00162         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#SetCustomModeParam_28char_20mode_2C_20char_20_2Aparameter_2C_20bool_20mode_5Fon_29">SetCustomModeParam</a>(<span class="keywordtype">char</span> mode,<span class="keywordtype">char</span>* parameter,<span class="keywordtype">bool</span> mode_on);
 111 <a name="l00163"></a>00163
 112 <a name="l00168"></a>00168         <span class="keywordtype">bool</span> <a class="code" href="classchanrec.html#IsCustomModeSet_28char_20mode_29">IsCustomModeSet</a>(<span class="keywordtype">char</span> mode);
 113 <a name="l00169"></a>00169
 114 <a name="l00180"></a>00180         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classchanrec.html#GetModeParameter_28char_20mode_29">GetModeParameter</a>(<span class="keywordtype">char</span> mode);
 115 <a name="l00181"></a>00181
 116 <a name="l00189"></a>00189         <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#GetUserCounter_28_29">GetUserCounter</a>();
 117 <a name="l00190"></a>00190
 118 <a name="l00198"></a>00198         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#AddUser_28char_20_2Acastuser_29">AddUser</a>(<span class="keywordtype">char</span>* castuser);
 119 <a name="l00199"></a>00199
 120 <a name="l00207"></a>00207         <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#DelUser_28char_20_2Acastuser_29">DelUser</a>(<span class="keywordtype">char</span>* castuser);
 121 <a name="l00208"></a>00208
 122 <a name="l00218"></a>00218         std::vector&lt;char*&gt; *<a class="code" href="classchanrec.html#GetUsers_28_29">GetUsers</a>();
 123 <a name="l00219"></a>00219
 124 <a name="l00222"></a>00222         <a class="code" href="classchanrec.html#chanrec_28_29">chanrec</a>();
 125 <a name="l00223"></a>00223
 126 <a name="l00224"></a><a class="code" href="classchanrec.html#_7Echanrec_28_29">00224</a>         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html#_7Echanrec_28_29">~chanrec</a>() { <span class="comment">/* stub */</span> }
 127 <a name="l00225"></a>00225 };
 128 <a name="l00226"></a>00226
 129 <a name="l00227"></a>00227 <span class="comment">/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o</span>
 130 <a name="l00228"></a>00228 <span class="comment"> * needs to come AFTER struct chanrec */</span>
 131 <a name="l00229"></a>00229
 132 <a name="l00230"></a><a class="code" href="channels_8h.html#UCMODE_5FOP">00230</a> <span class="preprocessor">#define UCMODE_OP      1</span>
 133 <a name="l00231"></a><a class="code" href="channels_8h.html#UCMODE_5FVOICE">00231</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_VOICE   2</span>
 134 <a name="l00232"></a><a class="code" href="channels_8h.html#UCMODE_5FHOP">00232</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_HOP     4</span>
 135 <a name="l00233"></a><a class="code" href="channels_8h.html#UCMODE_5FPROTECT">00233</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_PROTECT 8</span>
 136 <a name="l00234"></a><a class="code" href="channels_8h.html#UCMODE_5FFOUNDER">00234</a> <span class="preprocessor"></span><span class="preprocessor">#define UCMODE_FOUNDER 16</span>
 137 <a name="l00235"></a>00235 <span class="preprocessor"></span>
 138 <a name="l00241"></a><a class="code" href="classucrec.html">00241</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>
 139 <a name="l00242"></a>00242 {
 140 <a name="l00243"></a>00243  <span class="keyword">public</span>:
 141 <a name="l00247"></a><a class="code" href="classucrec.html#uc_5Fmodes">00247</a>         <span class="keywordtype">char</span> <a class="code" href="classucrec.html#uc_5Fmodes">uc_modes</a>;
 142 <a name="l00248"></a>00248
 143 <a name="l00252"></a><a class="code" href="classucrec.html#channel">00252</a>         <a class="code" href="classchanrec.html">chanrec</a> *<a class="code" href="classucrec.html#channel">channel</a>;
 144 <a name="l00253"></a>00253
 145 <a name="l00254"></a><a class="code" href="classucrec.html#ucrec_28_29">00254</a>         <a class="code" href="classucrec.html#ucrec_28_29">ucrec</a>() { <span class="comment">/* stub */</span> }
 146 <a name="l00255"></a><a class="code" href="classucrec.html#_7Eucrec_28_29">00255</a>         <span class="keyword">virtual</span> <a class="code" href="classucrec.html#_7Eucrec_28_29">~ucrec</a>() { <span class="comment">/* stub */</span> }
 147 <a name="l00256"></a>00256 };
 148 <a name="l00257"></a>00257
 149 <a name="l00258"></a>00258 <span class="preprocessor">#endif</span>
 150 <a name="l00259"></a>00259 <span class="preprocessor"></span>
 151 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
 152 <a href="http://www.doxygen.org/index.html">
 153 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 154 </body>
 155 </html>