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="preprocessor">#include "dynamic.h"</span>
  59 00052 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  60 00053 <span class="preprocessor">#include "<a class="code" href="ctables_8h.html">ctables.h</a>"</span>
  61 00054 <span class="preprocessor">#include &lt;string&gt;</span>
  62 00055 <span class="preprocessor">#include &lt;deque&gt;</span>
  63 00056 <span class="preprocessor">#include &lt;sstream&gt;</span>
  64 00057
  65 <a name="l00060"></a><a class="code" href="modules_8h.html#a26">00060</a> <span class="keyword">typedef</span> std::deque&lt;std::string&gt; <a class="code" href="modules_8h.html#a26">file_cache</a>;
  66 <a name="l00061"></a><a class="code" href="modules_8h.html#a27">00061</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a26">file_cache</a> <a class="code" href="modules_8h.html#a27">string_list</a>;
  67 00062
  68 <a name="l00065"></a><a class="code" href="modules_8h.html#a28">00065</a> <span class="keyword">typedef</span> std::deque&lt;userrec*&gt; <a class="code" href="modules_8h.html#a28">chanuserlist</a>;
  69 00066
  70 00067
  71 00068 <span class="comment">// This #define allows us to call a method in all</span>
  72 00069 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
  73 00070 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
  74 00071
  75 <a name="l00072"></a><a class="code" href="modules_8h.html#a20">00072</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
  76 00073 <span class="preprocessor"></span>
  77 00074 <span class="comment">// This define is similar to the one above but returns a result in MOD_RESULT.</span>
  78 00075 <span class="comment">// The first module to return a nonzero result is the value to be accepted,</span>
  79 00076 <span class="comment">// and any modules after are ignored.</span>
  80 00077
  81 00078 <span class="comment">// *********************************************************************************************</span>
  82 00079
  83 <a name="l00080"></a><a class="code" href="modules_8h.html#a21">00080</a> <span class="preprocessor">#define FOREACH_RESULT(x) { MOD_RESULT = 0; \</span>
  84 00081 <span class="preprocessor">                        for (int i = 0; i &lt;= MODCOUNT; i++) { \</span>
  85 00082 <span class="preprocessor">                        int res = modules[i]-&gt;x ; \</span>
  86 00083 <span class="preprocessor">                        if (res != 0) { \</span>
  87 00084 <span class="preprocessor">                                MOD_RESULT = res; \</span>
  88 00085 <span class="preprocessor">                                break; \</span>
  89 00086 <span class="preprocessor">                        } \</span>
  90 00087 <span class="preprocessor">                } \</span>
  91 00088 <span class="preprocessor">        } </span>
  92 00089 <span class="preprocessor"></span>
  93 00090 <span class="comment">// *********************************************************************************************</span>
  94 00091
  95 00092 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a30">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
  96 00093 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a31">server_mode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
  97 00094
  98 00095 <span class="comment">// class Version holds the version information of a Module, returned</span>
  99 00096 <span class="comment">// by Module::GetVersion (thanks RD)</span>
 100 00097
 101 <a name="l00102"></a><a class="code" href="classVersion.html">00102</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>
 102 00103 {
 103 00104  <span class="keyword">public</span>:
 104 <a name="l00105"></a><a class="code" href="classVersion.html#o2">00105</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>;
 105 00106          <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);
 106 00107 };
 107 00108
 108 <a name="l00114"></a><a class="code" href="classAdmin.html">00114</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>
 109 00115 {
 110 00116  <span class="keyword">public</span>:
 111 <a name="l00117"></a><a class="code" href="classAdmin.html#o2">00117</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>;
 112 00118          <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
 113 00119 };
 114 00120
 115 <a name="l00126"></a><a class="code" href="classModule.html">00126</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>
 116 00127 {
 117 00128  <span class="keyword">public</span>:
 118 00129
 119 00133         <a class="code" href="classModule.html#a0">Module</a>();
 120 00134
 121 00138         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
 122 00139
 123 00144         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
 124 00145
 125 00149         <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);
 126 00150
 127 00154         <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);
 128 00155
 129 00160         <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);
 130 00161
 131 00166         <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);
 132 00167
 133 00174         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a7">OnPacketTransmit</a>(<span class="keywordtype">char</span> *p);
 134 00175
 135 00183         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a8">OnPacketReceive</a>(<span class="keywordtype">char</span> *p);
 136 00184
 137 00190         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
 138 00191
 139 00200         <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);
 140 00201
 141 00211         <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#a27">string_list</a> &amp;params);
 142 00212
 143 00226         <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);
 144 00227
 145 00228
 146 00233         <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);
 147 00234
 148 00243         <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);
 149 00244
 150 00249         <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);
 151 00250
 152 00256         <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);
 153 00257
 154 00266         <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);
 155 00267
 156 00279         <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);
 157 00280
 158 00291         <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);
 159 00292
 160 00314         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a20">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);
 161 00315
 162 00321         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a27">string_list</a> <a class="code" href="classModule.html#a21">OnUserSync</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 163 00322
 164 00328         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a27">string_list</a> <a class="code" href="classModule.html#a22">OnChannelSync</a>(<a class="code" href="classchanrec.html">chanrec</a>* chan);
 165 00329
 166 00333         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a23">On005Numeric</a>(std::string &amp;output);
 167 00334
 168 00344         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a24">OnKill</a>(<a class="code" href="classuserrec.html">userrec</a>* source, <a class="code" href="classuserrec.html">userrec</a>* dest, std::string reason);
 169 00345
 170 00356         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a25">OnLoadModule</a>(<a class="code" href="classModule.html">Module</a>* mod,std::string name);
 171 00357 };
 172 00358
 173 00359
 174 <a name="l00365"></a><a class="code" href="classServer.html">00365</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>
 175 00366 {
 176 00367  <span class="keyword">public</span>:
 177 00371         <a class="code" href="classServer.html#a0">Server</a>();
 178 00375         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
 179 00376
 180 00380         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
 181 00385         <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);
 182 00390         <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);
 183 00395         <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);
 184 00400         <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);
 185 00415         <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);
 186 00422         <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);
 187 00427         <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);
 188 00435         <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);
 189 00440         <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);
 190 00441
 191 00445         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
 192 00449         <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);
 193 00453         <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);
 194 00457         <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);
 195 00462         <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);
 196 00466         <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);
 197 00469         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a18">GetServerName</a>();
 198 00472         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a19">GetNetworkName</a>();
 199 00478         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a20">GetAdmin</a>();
 200 00497         <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);
 201 00498
 202 00520         <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);
 203 00521
 204 00536         <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);
 205 00537
 206 00559         <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);
 207 00560
 208 00573         <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);
 209 00574
 210 00580         <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);
 211 00581
 212 00587         <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);
 213 00588
 214 00594         <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);
 215 00595
 216 00606         <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);
 217 00607
 218 00612         <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);
 219 00613
 220 00625         <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);
 221 00626
 222 00632         <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);
 223 00633
 224 00639         <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);
 225 00640
 226 00649         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a34">IsUlined</a>(std::string server);
 227 00650
 228 00654         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a28">chanuserlist</a> <a class="code" href="classServer.html#a35">GetUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* chan);
 229 00655
 230 00656 };
 231 00657
 232 <a name="l00658"></a><a class="code" href="modules_8h.html#a22">00658</a> <span class="preprocessor">#define CONF_NOT_A_NUMBER       0x000010</span>
 233 <a name="l00659"></a><a class="code" href="modules_8h.html#a23">00659</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_NOT_UNSIGNED       0x000080</span>
 234 <a name="l00660"></a><a class="code" href="modules_8h.html#a24">00660</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_VALUE_NOT_FOUND    0x000100</span>
 235 <a name="l00661"></a><a class="code" href="modules_8h.html#a25">00661</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_FILE_NOT_FOUND     0x000200</span>
 236 00662 <span class="preprocessor"></span>
 237 <a name="l00669"></a><a class="code" href="classConfigReader.html">00669</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>
 238 00670 {
 239 00671   <span class="keyword">protected</span>:
 240 <a name="l00677"></a><a class="code" href="classConfigReader.html#p0">00677</a>         std::stringstream *<a class="code" href="classConfigReader.html#p0">cache</a>;
 241 <a name="l00678"></a><a class="code" href="classConfigReader.html#p1">00678</a>         std::stringstream *<a class="code" href="classConfigReader.html#p1">errorlog</a>;
 242 <a name="l00681"></a><a class="code" href="classConfigReader.html#p2">00681</a>         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#p2">readerror</a>;
 243 <a name="l00682"></a><a class="code" href="classConfigReader.html#p3">00682</a>         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#p3">error</a>;
 244 00683
 245 00684   <span class="keyword">public</span>:
 246 00689         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 247 00693 <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>
 248 00697 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 249 00702         std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
 250 00708         <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);
 251 00717         <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);
 252 00722         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#a6">GetError</a>();
 253 00729         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a7">Enumerate</a>(std::string tag);
 254 00734         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a8">Verify</a>();
 255 00741         <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);
 256 00742
 257 00748         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a10">EnumerateValues</a>(std::string tag, <span class="keywordtype">int</span> index);
 258 00749 };
 259 00750
 260 00751
 261 00752
 262 <a name="l00758"></a><a class="code" href="classFileReader.html">00758</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>
 263 00759 {
 264 <a name="l00760"></a><a class="code" href="classFileReader.html#r0">00760</a>  <a class="code" href="modules_8h.html#a26">file_cache</a> <a class="code" href="classFileReader.html#r0">fc</a>;
 265 00761  <span class="keyword">public</span>:
 266 00766          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 267 00767
 268 00773          <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
 269 00774
 270 00778          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 271 00779
 272 00785          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
 273 00786
 274 00790          <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
 275 00791
 276 00796          std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
 277 00797
 278 00803          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
 279 00804 };
 280 00805
 281 00806
 282 <a name="l00813"></a><a class="code" href="classModuleFactory.html">00813</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>
 283 00814 {
 284 00815  <span class="keyword">public</span>:
 285 <a name="l00816"></a><a class="code" href="classModuleFactory.html#a0">00816</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 286 <a name="l00817"></a><a class="code" href="classModuleFactory.html#a1">00817</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 287 00822         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 288 00823 };
 289 00824
 290 00825
 291 <a name="l00826"></a><a class="code" href="modules_8h.html#a29">00826</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a29">ircd_module</a>;
 292 00827
 293 00828 <span class="preprocessor">#endif</span>
 294 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Mar 28 21:09:25 2005 for InspIRCd by
 295 <a href="http://www.doxygen.org/index.html">
 296 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 297 </a>1.3.3 </small></address>
 298 </body>
 299 </html>