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>modules.h Source File</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
   9 <hr><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>
  10 00002 <span class="comment"></span>
  11 00003 <span class="comment"></span>
  12 00004 <span class="comment"></span>
  13 00005 <span class="comment">*/</span>
  14 00006
  15 00007
  16 00008 <span class="preprocessor">#ifndef __PLUGIN_H</span>
  17 00009 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
  18 00010 <span class="preprocessor"></span>
  19 <a name="l00011"></a><a class="code" href="modules_8h.html#a0">00011</a> <span class="preprocessor">#define DEBUG 10</span>
  20 <a name="l00012"></a><a class="code" href="modules_8h.html#a1">00012</a> <span class="preprocessor"></span><span class="preprocessor">#define VERBOSE 20</span>
  21 <a name="l00013"></a><a class="code" href="modules_8h.html#a2">00013</a> <span class="preprocessor"></span><span class="preprocessor">#define DEFAULT 30</span>
  22 <a name="l00014"></a><a class="code" href="modules_8h.html#a3">00014</a> <span class="preprocessor"></span><span class="preprocessor">#define SPARSE 40</span>
  23 <a name="l00015"></a><a class="code" href="modules_8h.html#a4">00015</a> <span class="preprocessor"></span><span class="preprocessor">#define NONE 50</span>
  24 00016 <span class="preprocessor"></span>
  25 <a name="l00017"></a><a class="code" href="modules_8h.html#a5">00017</a> <span class="preprocessor">#define MT_CHANNEL 1</span>
  26 <a name="l00018"></a><a class="code" href="modules_8h.html#a6">00018</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_CLIENT 2</span>
  27 <a name="l00019"></a><a class="code" href="modules_8h.html#a7">00019</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_SERVER 3</span>
  28 00020 <span class="preprocessor"></span>
  29 00021 <span class="preprocessor">#include "dynamic.h"</span>
  30 00022 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  31 00023 <span class="preprocessor">#include "<a class="code" href="ctables_8h.html">ctables.h</a>"</span>
  32 00024 <span class="preprocessor">#include &lt;string&gt;</span>
  33 00025 <span class="preprocessor">#include &lt;deque&gt;</span>
  34 00026
  35 <a name="l00029"></a><a class="code" href="modules_8h.html#a10">00029</a> <span class="keyword">typedef</span> std::deque&lt;std::string&gt; <a class="code" href="modules_8h.html#a10">file_cache</a>;
  36 <a name="l00030"></a><a class="code" href="modules_8h.html#a11">00030</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="modules_8h.html#a11">string_list</a>;
  37 00031
  38 00032 <span class="comment">// This #define allows us to call a method in all</span>
  39 00033 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
  40 00034 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
  41 00035
  42 <a name="l00036"></a><a class="code" href="modules_8h.html#a8">00036</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
  43 00037 <span class="preprocessor"></span>
  44 00038 <span class="comment">// This define is similar to the one above but returns a result in MOD_RESULT.</span>
  45 00039 <span class="comment">// The first module to return a nonzero result is the value to be accepted,</span>
  46 00040 <span class="comment">// and any modules after are ignored.</span>
  47 00041
  48 00042 <span class="comment">// *********************************************************************************************</span>
  49 00043
  50 <a name="l00044"></a><a class="code" href="modules_8h.html#a9">00044</a> <span class="preprocessor">#define FOREACH_RESULT(x) { MOD_RESULT = 0; \</span>
  51 00045 <span class="preprocessor">                        for (int i = 0; i &lt;= MODCOUNT; i++) { \</span>
  52 00046 <span class="preprocessor">                        int res = modules[i]-&gt;x ; \</span>
  53 00047 <span class="preprocessor">                        if (res) { \</span>
  54 00048 <span class="preprocessor">                                MOD_RESULT = res; \</span>
  55 00049 <span class="preprocessor">                                break; \</span>
  56 00050 <span class="preprocessor">                        } \</span>
  57 00051 <span class="preprocessor">                } \</span>
  58 00052 <span class="preprocessor">   } </span>
  59 00053 <span class="preprocessor"></span>
  60 00054 <span class="comment">// *********************************************************************************************</span>
  61 00055
  62 00056 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a13">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
  63 00057 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a14">server_mode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
  64 00058
  65 00059 <span class="comment">// class Version holds the version information of a Module, returned</span>
  66 00060 <span class="comment">// by Module::GetVersion (thanks RD)</span>
  67 00061
  68 <a name="l00066"></a><a class="code" href="classVersion.html">00066</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>
  69 00067 {
  70 00068  <span class="keyword">public</span>:
  71 <a name="l00069"></a><a class="code" href="classVersion.html#m2">00069</a>          <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classVersion.html#m0">Major</a>, <a class="code" href="classVersion.html#m1">Minor</a>, <a class="code" href="classVersion.html#m2">Revision</a>, <a class="code" href="classVersion.html#m3">Build</a>;
  72 00070          <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);
  73 00071 };
  74 00072
  75 <a name="l00078"></a><a class="code" href="classAdmin.html">00078</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>
  76 00079 {
  77 00080  <span class="keyword">public</span>:
  78 <a name="l00081"></a><a class="code" href="classAdmin.html#m2">00081</a>          <span class="keyword">const</span> std::string <a class="code" href="classAdmin.html#m0">Name</a>, <a class="code" href="classAdmin.html#m1">Email</a>, <a class="code" href="classAdmin.html#m2">Nick</a>;
  79 00082          <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
  80 00083 };
  81 00084
  82 <a name="l00090"></a><a class="code" href="classModule.html">00090</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>
  83 00091 {
  84 00092  <span class="keyword">public</span>:
  85 00093
  86 00097         <a class="code" href="classModule.html#a0">Module</a>();
  87 00098
  88 00102         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
  89 00103
  90 00108         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
  91 00109
  92 00113         <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);
  93 00114
  94 00118         <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);
  95 00119
  96 00124         <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);
  97 00125
  98 00130         <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);
  99 00131
 100 00138         <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);
 101 00139
 102 00147         <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);
 103 00148
 104 00154         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
 105 00155
 106 00162         <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);
 107 00163
 108 00172         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classModule.html#a11">OnExtendedMode</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, string_list &amp;params);
 109 00173
 110 00186         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a12">Module::OnUserPreJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keywordtype">char</span>* cname);
 111 00187
 112 00188 };
 113 00189
 114 00190
 115 <a name="l00196"></a><a class="code" href="classServer.html">00196</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>
 116 00197 {
 117 00198  <span class="keyword">public</span>:
 118 00202         <a class="code" href="classServer.html#a0">Server</a>();
 119 00206         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
 120 00207
 121 00211         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
 122 00216         <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);
 123 00221         <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);
 124 00226         <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);
 125 00231         <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);
 126 00236         <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);
 127 00243         <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);
 128 00248         <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);
 129 00256         <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);
 130 00261         <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);
 131 00262
 132 00266         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
 133 00270         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(std::string nick);
 134 00274         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(std::string channel);
 135 00279         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a15">ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
 136 00282         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">GetServerName</a>();
 137 00285         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
 138 00291         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
 139 00310         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a19">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);
 140 00311
 141 00326         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a20">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
 142 00327
 143 00349         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a21">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
 144 00350 };
 145 00351
 146 <a name="l00358"></a><a class="code" href="classConfigReader.html">00358</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>
 147 00359 {
 148 00360   <span class="keyword">protected</span>:
 149 <a name="l00363"></a><a class="code" href="classConfigReader.html#n0">00363</a>         std::string <a class="code" href="classConfigReader.html#n0">fname</a>;
 150 00364   <span class="keyword">public</span>:
 151 00369         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 152 00373 <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>
 153 00377 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 154 00382         std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
 155 00389         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag);
 156 00393         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
 157 00394 };
 158 00395
 159 00396
 160 00397
 161 <a name="l00403"></a><a class="code" href="classFileReader.html">00403</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>
 162 00404 {
 163 <a name="l00405"></a><a class="code" href="classFileReader.html#o0">00405</a>  <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
 164 00406  <span class="keyword">public</span>:
 165 00411          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 166 00417          <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
 167 00421          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 168 00427          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
 169 00432          <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
 170 00433          std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
 171 00439          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
 172 00440 };
 173 00441
 174 00442
 175 <a name="l00449"></a><a class="code" href="classModuleFactory.html">00449</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>
 176 00450 {
 177 00451  <span class="keyword">public</span>:
 178 <a name="l00452"></a><a class="code" href="classModuleFactory.html#a0">00452</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 179 <a name="l00453"></a><a class="code" href="classModuleFactory.html#a1">00453</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 180 00458         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 181 00459 };
 182 00460
 183 00461
 184 <a name="l00462"></a><a class="code" href="modules_8h.html#a12">00462</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a12">ircd_module</a>;
 185 00463
 186 00464 <span class="preprocessor">#endif</span>
 187 </pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:14 2004 for InspIRCd by
 188 <a href="http://www.doxygen.org/index.html">
 189 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 190 width=110 height=53></a>1.3-rc3 </small></address>
 191 </body>
 192 </html>