docs/module-doc/modules_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: modules.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>modules.h</h1><a href="modules_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
  25 00018 <span class="preprocessor">#ifndef __PLUGIN_H</span>
  26 00019 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
  27 00020 <span class="preprocessor"></span>
  28 00021 <span class="comment">// log levels</span>
  29 00022
  30 <a name="l00023"></a><a class="code" href="modules_8h.html#a0">00023</a> <span class="preprocessor">#define DEBUG 10</span>
  31 <a name="l00024"></a><a class="code" href="modules_8h.html#a1">00024</a> <span class="preprocessor"></span><span class="preprocessor">#define VERBOSE 20</span>
  32 <a name="l00025"></a><a class="code" href="modules_8h.html#a2">00025</a> <span class="preprocessor"></span><span class="preprocessor">#define DEFAULT 30</span>
  33 <a name="l00026"></a><a class="code" href="modules_8h.html#a3">00026</a> <span class="preprocessor"></span><span class="preprocessor">#define SPARSE 40</span>
  34 <a name="l00027"></a><a class="code" href="modules_8h.html#a4">00027</a> <span class="preprocessor"></span><span class="preprocessor">#define NONE 50</span>
  35 00028 <span class="preprocessor"></span>
  36 00029 <span class="comment">// used with OnExtendedMode() method of modules</span>
  37 00030
  38 <a name="l00031"></a><a class="code" href="modules_8h.html#a5">00031</a> <span class="preprocessor">#define MT_CHANNEL 1</span>
  39 <a name="l00032"></a><a class="code" href="modules_8h.html#a6">00032</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_CLIENT 2</span>
  40 <a name="l00033"></a><a class="code" href="modules_8h.html#a7">00033</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_SERVER 3</span>
  41 00034 <span class="preprocessor"></span>
  42 00035 <span class="comment">// used with OnAccessCheck() method of modules</span>
  43 00036
  44 <a name="l00037"></a><a class="code" href="modules_8h.html#a8">00037</a> <span class="preprocessor">#define ACR_DEFAULT 0           // Do default action (act as if the module isnt even loaded)</span>
  45 <a name="l00038"></a><a class="code" href="modules_8h.html#a9">00038</a> <span class="preprocessor"></span><span class="preprocessor">#define ACR_DENY 1              // deny the action</span>
  46 <a name="l00039"></a><a class="code" href="modules_8h.html#a10">00039</a> <span class="preprocessor"></span><span class="preprocessor">#define ACR_ALLOW 2             // allow the action</span>
  47 00040 <span class="preprocessor"></span>
  48 <a name="l00041"></a><a class="code" href="modules_8h.html#a11">00041</a> <span class="preprocessor">#define AC_KICK 0               // a user is being kicked</span>
  49 <a name="l00042"></a><a class="code" href="modules_8h.html#a12">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_DEOP 1               // a user is being deopped</span>
  50 <a name="l00043"></a><a class="code" href="modules_8h.html#a13">00043</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_OP 2                 // a user is being opped</span>
  51 <a name="l00044"></a><a class="code" href="modules_8h.html#a14">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_VOICE 3              // a user is being voiced</span>
  52 <a name="l00045"></a><a class="code" href="modules_8h.html#a15">00045</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_DEVOICE 4            // a user is being devoiced</span>
  53 <a name="l00046"></a><a class="code" href="modules_8h.html#a16">00046</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_HALFOP 5             // a user is being halfopped</span>
  54 <a name="l00047"></a><a class="code" href="modules_8h.html#a17">00047</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_DEHALFOP 6           // a user is being dehalfopped</span>
  55 <a name="l00048"></a><a class="code" href="modules_8h.html#a18">00048</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_INVITE 7             // a user is being invited</span>
  56 <a name="l00049"></a><a class="code" href="modules_8h.html#a19">00049</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_GENERAL_MODE 8       // a user channel mode is being changed</span>
  57 00050 <span class="preprocessor"></span>
  58 00051 <span class="comment">// used to define a set of behavior bits for a module</span>
  59 00052
  60 <a name="l00053"></a><a class="code" href="modules_8h.html#a20">00053</a> <span class="preprocessor">#define VF_STATIC               1       // module is static, cannot be /unloadmodule'd</span>
  61 <a name="l00054"></a><a class="code" href="modules_8h.html#a21">00054</a> <span class="preprocessor"></span><span class="preprocessor">#define VF_VENDOR               2       // module is a vendor module (came in the original tarball, not 3rd party)</span>
  62 <a name="l00055"></a><a class="code" href="modules_8h.html#a22">00055</a> <span class="preprocessor"></span><span class="preprocessor">#define VF_SERVICEPROVIDER      4       // module provides a service to other modules (can be a dependency)</span>
  63 <a name="l00056"></a><a class="code" href="modules_8h.html#a23">00056</a> <span class="preprocessor"></span><span class="preprocessor">#define VF_COMMON               8       // module needs to be common on all servers in a mesh to link</span>
  64 00057 <span class="preprocessor"></span>
  65 00058 <span class="preprocessor">#include "dynamic.h"</span>
  66 00059 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  67 00060 <span class="preprocessor">#include "<a class="code" href="ctables_8h.html">ctables.h</a>"</span>
  68 00061 <span class="preprocessor">#include &lt;string&gt;</span>
  69 00062 <span class="preprocessor">#include &lt;deque&gt;</span>
  70 00063 <span class="preprocessor">#include &lt;sstream&gt;</span>
  71 00064
  72 <a name="l00067"></a><a class="code" href="modules_8h.html#a31">00067</a> <span class="keyword">typedef</span> std::deque&lt;std::string&gt; <a class="code" href="modules_8h.html#a31">file_cache</a>;
  73 <a name="l00068"></a><a class="code" href="modules_8h.html#a32">00068</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a31">file_cache</a> <a class="code" href="modules_8h.html#a32">string_list</a>;
  74 00069
  75 <a name="l00072"></a><a class="code" href="modules_8h.html#a33">00072</a> <span class="keyword">typedef</span> std::deque&lt;userrec*&gt; <a class="code" href="modules_8h.html#a33">chanuserlist</a>;
  76 00073
  77 00074
  78 00075 <span class="comment">// This #define allows us to call a method in all</span>
  79 00076 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
  80 00077 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
  81 00078
  82 <a name="l00079"></a><a class="code" href="modules_8h.html#a24">00079</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
  83 00080 <span class="preprocessor"></span>
  84 00081 <span class="comment">// This define is similar to the one above but returns a result in MOD_RESULT.</span>
  85 00082 <span class="comment">// The first module to return a nonzero result is the value to be accepted,</span>
  86 00083 <span class="comment">// and any modules after are ignored.</span>
  87 00084
  88 00085 <span class="comment">// *********************************************************************************************</span>
  89 00086
  90 <a name="l00087"></a><a class="code" href="modules_8h.html#a25">00087</a> <span class="preprocessor">#define FOREACH_RESULT(x) { MOD_RESULT = 0; \</span>
  91 00088 <span class="preprocessor">                        for (int i = 0; i &lt;= MODCOUNT; i++) { \</span>
  92 00089 <span class="preprocessor">                        int res = modules[i]-&gt;x ; \</span>
  93 00090 <span class="preprocessor">                        if (res != 0) { \</span>
  94 00091 <span class="preprocessor">                                MOD_RESULT = res; \</span>
  95 00092 <span class="preprocessor">                                break; \</span>
  96 00093 <span class="preprocessor">                        } \</span>
  97 00094 <span class="preprocessor">                } \</span>
  98 00095 <span class="preprocessor">        } </span>
  99 00096 <span class="preprocessor"></span>
 100 00097 <span class="comment">// *********************************************************************************************</span>
 101 00098
 102 <a name="l00099"></a><a class="code" href="modules_8h.html#a26">00099</a> <span class="preprocessor">#define FD_MAGIC_NUMBER -42</span>
 103 00100 <span class="preprocessor"></span>
 104 00101 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a35">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams, <span class="keywordtype">char</span>* source);
 105 00102 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a36">server_mode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
 106 00103
 107 00104 <span class="comment">// class Version holds the version information of a Module, returned</span>
 108 00105 <span class="comment">// by Module::GetVersion (thanks RD)</span>
 109 00106
 110 <a name="l00111"></a><a class="code" href="classVersion.html">00111</a> <span class="keyword">class </span><a class="code" href="classVersion.html">Version</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 111 00112 {
 112 00113  <span class="keyword">public</span>:
 113 <a name="l00114"></a><a class="code" href="classVersion.html#o2">00114</a>          <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classVersion.html#o0">Major</a>, <a class="code" href="classVersion.html#o1">Minor</a>, <a class="code" href="classVersion.html#o2">Revision</a>, <a class="code" href="classVersion.html#o3">Build</a>, <a class="code" href="classVersion.html#o4">Flags</a>;
 114 00115          <a class="code" href="classVersion.html#a0">Version</a>(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> revision, <span class="keywordtype">int</span> build, <span class="keywordtype">int</span> flags);
 115 00116 };
 116 00117
 117 <a name="l00123"></a><a class="code" href="classAdmin.html">00123</a> <span class="keyword">class </span><a class="code" href="classAdmin.html">Admin</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 118 00124 {
 119 00125  <span class="keyword">public</span>:
 120 <a name="l00126"></a><a class="code" href="classAdmin.html#o2">00126</a>          <span class="keyword">const</span> std::string <a class="code" href="classAdmin.html#o0">Name</a>, <a class="code" href="classAdmin.html#o1">Email</a>, <a class="code" href="classAdmin.html#o2">Nick</a>;
 121 00127          <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
 122 00128 };
 123 00129
 124 <a name="l00135"></a><a class="code" href="classModule.html">00135</a> <span class="keyword">class </span><a class="code" href="classModule.html">Module</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 125 00136 {
 126 00137  <span class="keyword">public</span>:
 127 00138
 128 00142         <a class="code" href="classModule.html#a0">Module</a>();
 129 00143
 130 00147         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
 131 00148
 132 00153         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
 133 00154
 134 00158         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a3">OnUserConnect</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 135 00159
 136 00163         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a4">OnUserQuit</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 137 00164
 138 00169         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a5">OnUserJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel);
 139 00170
 140 00175         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a6">OnUserPart</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel);
 141 00176
 142 00182         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a7">OnPacketTransmit</a>(std::string &amp;data, std::string serv);
 143 00183
 144 00190         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a8">OnPacketReceive</a>(std::string &amp;data, std::string serv);
 145 00191
 146 00197         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
 147 00198
 148 00207         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">OnServerRaw</a>(std::string &amp;raw, <span class="keywordtype">bool</span> inbound, <a class="code" href="classuserrec.html">userrec</a>* user);
 149 00208
 150 00218         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a11">OnExtendedMode</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <span class="keywordtype">void</span>* target, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, <a class="code" href="modules_8h.html#a32">string_list</a> &amp;params);
 151 00219
 152 00233         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a12">OnUserPreJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keyword">const</span> <span class="keywordtype">char</span>* cname);
 153 00234
 154 00235
 155 00240         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a13">OnOper</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 156 00241
 157 00250         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a14">OnInfo</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 158 00251
 159 00256         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a15">OnWhois</a>(<a class="code" href="classuserrec.html">userrec</a>* source, <a class="code" href="classuserrec.html">userrec</a>* dest);
 160 00257
 161 00263         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a16">OnUserPreInvite</a>(<a class="code" href="classuserrec.html">userrec</a>* source,<a class="code" href="classuserrec.html">userrec</a>* dest,<a class="code" href="classchanrec.html">chanrec</a>* channel);
 162 00264
 163 00273         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a17">OnUserPreMessage</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string &amp;text);
 164 00274
 165 00286         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a18">OnUserPreNotice</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string &amp;text);
 166 00287
 167 00295         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a19">OnUserPreNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string newnick);
 168 00296
 169 00304         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a20">OnUserPostNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string oldnick);
 170 00305
 171 00327         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a21">OnAccessCheck</a>(<a class="code" href="classuserrec.html">userrec</a>* source,<a class="code" href="classuserrec.html">userrec</a>* dest,<a class="code" href="classchanrec.html">chanrec</a>* channel,<span class="keywordtype">int</span> access_type);
 172 00328
 173 00334         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a32">string_list</a> <a class="code" href="classModule.html#a22">OnUserSync</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 174 00335
 175 00341         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a32">string_list</a> <a class="code" href="classModule.html#a23">OnChannelSync</a>(<a class="code" href="classchanrec.html">chanrec</a>* chan);
 176 00342
 177 00346         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a24">On005Numeric</a>(std::string &amp;output);
 178 00347
 179 00357         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a25">OnKill</a>(<a class="code" href="classuserrec.html">userrec</a>* source, <a class="code" href="classuserrec.html">userrec</a>* dest, std::string reason);
 180 00358
 181 00369         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a26">OnLoadModule</a>(<a class="code" href="classModule.html">Module</a>* mod,std::string name);
 182 00370
 183 00376         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a27">OnBackgroundTimer</a>(time_t curtime);
 184 00377
 185 00385         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a28">OnSendList</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel, <span class="keywordtype">char</span> mode);
 186 00386
 187 00387 };
 188 00388
 189 00389
 190 <a name="l00395"></a><a class="code" href="classServer.html">00395</a> <span class="keyword">class </span><a class="code" href="classServer.html">Server</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 191 00396 {
 192 00397  <span class="keyword">public</span>:
 193 00401         <a class="code" href="classServer.html#a0">Server</a>();
 194 00405         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
 195 00406
 196 00410         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
 197 00415         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Log</a>(<span class="keywordtype">int</span> level, std::string s);
 198 00420         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Send</a>(<span class="keywordtype">int</span> Socket, std::string s);
 199 00425         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">SendServ</a>(<span class="keywordtype">int</span> Socket, std::string s);
 200 00430         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a6">SendFrom</a>(<span class="keywordtype">int</span> Socket, <a class="code" href="classuserrec.html">userrec</a>* User, std::string s);
 201 00445         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a7">SendTo</a>(<a class="code" href="classuserrec.html">userrec</a>* Source, <a class="code" href="classuserrec.html">userrec</a>* Dest, std::string s);
 202 00452         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a8">SendChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Channel, std::string s,<span class="keywordtype">bool</span> IncludeSender);
 203 00457         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a9">CommonChannels</a>(<a class="code" href="classuserrec.html">userrec</a>* u1, <a class="code" href="classuserrec.html">userrec</a>* u2);
 204 00465         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a10">SendCommon</a>(<a class="code" href="classuserrec.html">userrec</a>* User, std::string text,<span class="keywordtype">bool</span> IncludeSender);
 205 00470         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a11">SendWallops</a>(<a class="code" href="classuserrec.html">userrec</a>* User, std::string text);
 206 00471
 207 00475         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
 208 00479         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classServer.html#a13">CountUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* c);
 209 00483         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a14">FindNick</a>(std::string nick);
 210 00487         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a15">FindChannel</a>(std::string channel);
 211 00492         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
 212 00496         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a17">IsOnChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
 213 00499         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a18">GetServerName</a>();
 214 00502         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a19">GetNetworkName</a>();
 215 00508         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a20">GetAdmin</a>();
 216 00527         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a21">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> requires_oper, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off);
 217 00528
 218 00550         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a22">AddExtendedListMode</a>(<span class="keywordtype">char</span> modechar);
 219 00551
 220 00569         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a23">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams, <span class="keywordtype">char</span>* source);
 221 00570
 222 00592         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a24">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
 223 00593
 224 00606         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a25">SendToModeMask</a>(std::string modes, <span class="keywordtype">int</span> flags, std::string text);
 225 00607
 226 00613         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a26">JoinUserToChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string key);
 227 00614
 228 00620         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a27">PartUserFromChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string reason);
 229 00621
 230 00627         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a28">ChangeUserNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string nickname);
 231 00628
 232 00639         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a29">QuitUser</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string reason);
 233 00640
 234 00645         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a30">MatchText</a>(std::string sliteral, std::string spattern);
 235 00646
 236 00658         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a31">CallCommandHandler</a>(std::string commandname, <span class="keywordtype">char</span>** parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a>* user);
 237 00659
 238 00665         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a32">ChangeHost</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string host);
 239 00666
 240 00672         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a33">ChangeGECOS</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string gecos);
 241 00673
 242 00682         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a34">IsUlined</a>(std::string server);
 243 00683
 244 00687         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a33">chanuserlist</a> <a class="code" href="classServer.html#a35">GetUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* chan);
 245 00688
 246 00695         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a36">UserToPseudo</a>(<a class="code" href="classuserrec.html">userrec</a>* user,std::string message);
 247 00696
 248 00703         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a37">PseudoToUser</a>(<a class="code" href="classuserrec.html">userrec</a>* alive,<a class="code" href="classuserrec.html">userrec</a>* zombie,std::string message);
 249 00704
 250 00712         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a38">AddGLine</a>(<span class="keywordtype">long</span> <a class="code" href="commands_8h.html#a75">duration</a>, std::string source, std::string reason, std::string hostmask);
 251 00713
 252 00721         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a39">AddQLine</a>(<span class="keywordtype">long</span> <a class="code" href="commands_8h.html#a75">duration</a>, std::string source, std::string reason, std::string nickname);
 253 00722
 254 00730         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a40">AddZLine</a>(<span class="keywordtype">long</span> <a class="code" href="commands_8h.html#a75">duration</a>, std::string source, std::string reason, std::string ipaddr);
 255 00731
 256 00739         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a41">AddKLine</a>(<span class="keywordtype">long</span> <a class="code" href="commands_8h.html#a75">duration</a>, std::string source, std::string reason, std::string hostmask);
 257 00740
 258 00748         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a42">AddELine</a>(<span class="keywordtype">long</span> <a class="code" href="commands_8h.html#a75">duration</a>, std::string source, std::string reason, std::string hostmask);
 259 00749
 260 00752         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a43">DelGLine</a>(std::string hostmask);
 261 00753
 262 00756         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a44">DelQLine</a>(std::string nickname);
 263 00757
 264 00760         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a45">DelZLine</a>(std::string ipaddr);
 265 00761
 266 00764         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a46">DelKLine</a>(std::string hostmask);
 267 00765
 268 00768         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a47">DelELine</a>(std::string hostmask);
 269 00769
 270 00775         <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classServer.html#a48">CalcDuration</a>(std::string <a class="code" href="commands_8h.html#a75">duration</a>);
 271 00776
 272 00777 };
 273 00778
 274 <a name="l00779"></a><a class="code" href="modules_8h.html#a27">00779</a> <span class="preprocessor">#define CONF_NOT_A_NUMBER       0x000010</span>
 275 <a name="l00780"></a><a class="code" href="modules_8h.html#a28">00780</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_NOT_UNSIGNED       0x000080</span>
 276 <a name="l00781"></a><a class="code" href="modules_8h.html#a29">00781</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_VALUE_NOT_FOUND    0x000100</span>
 277 <a name="l00782"></a><a class="code" href="modules_8h.html#a30">00782</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_FILE_NOT_FOUND     0x000200</span>
 278 00783 <span class="preprocessor"></span>
 279 <a name="l00790"></a><a class="code" href="classConfigReader.html">00790</a> <span class="keyword">class </span><a class="code" href="classConfigReader.html">ConfigReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 280 00791 {
 281 00792   <span class="keyword">protected</span>:
 282 <a name="l00798"></a><a class="code" href="classConfigReader.html#p0">00798</a>         std::stringstream *<a class="code" href="classConfigReader.html#p0">cache</a>;
 283 <a name="l00799"></a><a class="code" href="classConfigReader.html#p1">00799</a>         std::stringstream *<a class="code" href="classConfigReader.html#p1">errorlog</a>;
 284 <a name="l00802"></a><a class="code" href="classConfigReader.html#p2">00802</a>         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#p2">readerror</a>;
 285 <a name="l00803"></a><a class="code" href="classConfigReader.html#p3">00803</a>         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#p3">error</a>;
 286 00804
 287 00805   <span class="keyword">public</span>:
 288 00810         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 289 00814 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(std::string filename);     <span class="comment">// read a module-specific config</span>
 290 00818 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 291 00823         std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
 292 00829         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a4">ReadFlag</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
 293 00838         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#a5">ReadInteger</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> needs_unsigned);
 294 00843         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#a6">GetError</a>();
 295 00850         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a7">Enumerate</a>(std::string tag);
 296 00855         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a8">Verify</a>();
 297 00862         <span class="keywordtype">void</span> <a class="code" href="classConfigReader.html#a9">DumpErrors</a>(<span class="keywordtype">bool</span> bail,<a class="code" href="classuserrec.html">userrec</a>* user);
 298 00863
 299 00869         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a10">EnumerateValues</a>(std::string tag, <span class="keywordtype">int</span> index);
 300 00870 };
 301 00871
 302 00872
 303 00873
 304 <a name="l00879"></a><a class="code" href="classFileReader.html">00879</a> <span class="keyword">class </span><a class="code" href="classFileReader.html">FileReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 305 00880 {
 306 <a name="l00881"></a><a class="code" href="classFileReader.html#r0">00881</a>  <a class="code" href="modules_8h.html#a31">file_cache</a> <a class="code" href="classFileReader.html#r0">fc</a>;
 307 00882  <span class="keyword">public</span>:
 308 00887          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 309 00888
 310 00894          <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
 311 00895
 312 00899          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 313 00900
 314 00906          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
 315 00907
 316 00911          <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
 317 00912
 318 00917          std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
 319 00918
 320 00924          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
 321 00925 };
 322 00926
 323 00927
 324 <a name="l00934"></a><a class="code" href="classModuleFactory.html">00934</a> <span class="keyword">class </span><a class="code" href="classModuleFactory.html">ModuleFactory</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
 325 00935 {
 326 00936  <span class="keyword">public</span>:
 327 <a name="l00937"></a><a class="code" href="classModuleFactory.html#a0">00937</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 328 <a name="l00938"></a><a class="code" href="classModuleFactory.html#a1">00938</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 329 00943         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 330 00944 };
 331 00945
 332 00946
 333 <a name="l00947"></a><a class="code" href="modules_8h.html#a34">00947</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a34">ircd_module</a>;
 334 00948
 335 00949 <span class="preprocessor">#endif</span>
 336 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 13 13:06:54 2005 for InspIRCd by
 337 <a href="http://www.doxygen.org/index.html">
 338 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 339 </a>1.3.3 </small></address>
 340 </body>
 341 </html>