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="doxygen.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="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#a9">00029</a> <span class="keyword">typedef</span> std::deque&lt;std::string&gt; <a class="code" href="modules_8h.html#a9">file_cache</a>;
  36 <a name="l00030"></a><a class="code" href="modules_8h.html#a10">00030</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a9">file_cache</a> <a class="code" href="modules_8h.html#a10">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="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a12">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
  45 00039
  46 00040 <span class="comment">// class Version holds the version information of a Module, returned</span>
  47 00041 <span class="comment">// by Module::GetVersion (thanks RD)</span>
  48 00042
  49 <a name="l00047"></a><a class="code" href="classVersion.html">00047</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>
  50 00048 {
  51 00049  <span class="keyword">public</span>:
  52 <a name="l00050"></a><a class="code" href="classVersion.html#m2">00050</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>;
  53 00051          <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);
  54 00052 };
  55 00053
  56 <a name="l00059"></a><a class="code" href="classAdmin.html">00059</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>
  57 00060 {
  58 00061  <span class="keyword">public</span>:
  59 <a name="l00062"></a><a class="code" href="classAdmin.html#m2">00062</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>;
  60 00063          <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
  61 00064 };
  62 00065
  63 <a name="l00071"></a><a class="code" href="classModule.html">00071</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>
  64 00072 {
  65 00073  <span class="keyword">public</span>:
  66 00074
  67 00078         <a class="code" href="classModule.html#a0">Module</a>();
  68 00079
  69 00083         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
  70 00084
  71 00089         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
  72 00090
  73 00094         <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);
  74 00095
  75 00099         <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);
  76 00100
  77 00105         <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);
  78 00106
  79 00111         <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);
  80 00112
  81 00119         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a7">Module::OnPacketTransmit</a>(<span class="keywordtype">char</span> *p);
  82 00120
  83 00128         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a8">Module::OnPacketReceive</a>(<span class="keywordtype">char</span> *p);
  84 00129
  85 00135         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
  86 00136
  87 00143         <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);
  88 00144
  89 00153         <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);
  90 00154
  91 00155 };
  92 00156
  93 00157
  94 <a name="l00163"></a><a class="code" href="classServer.html">00163</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>
  95 00164 {
  96 00165  <span class="keyword">public</span>:
  97 00169         <a class="code" href="classServer.html#a0">Server</a>();
  98 00173         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
  99 00174
 100 00178         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
 101 00183         <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);
 102 00188         <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);
 103 00193         <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);
 104 00198         <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);
 105 00203         <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);
 106 00210         <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);
 107 00215         <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);
 108 00223         <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);
 109 00228         <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);
 110 00229
 111 00233         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
 112 00237         <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);
 113 00241         <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);
 114 00246         <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);
 115 00249         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">GetServerName</a>();
 116 00252         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
 117 00258         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
 118 00276         <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> default_on, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off);
 119 00277
 120 00292         <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);
 121 00293
 122 00294 };
 123 00295
 124 <a name="l00302"></a><a class="code" href="classConfigReader.html">00302</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>
 125 00303 {
 126 00304   <span class="keyword">protected</span>:
 127 <a name="l00307"></a><a class="code" href="classConfigReader.html#n0">00307</a>         std::string <a class="code" href="classConfigReader.html#n0">fname</a>;
 128 00308   <span class="keyword">public</span>:
 129 00313         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 130 00317 <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>
 131 00321 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 132 00326         std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
 133 00333         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag);
 134 00337         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
 135 00338 };
 136 00339
 137 00340
 138 00341
 139 <a name="l00347"></a><a class="code" href="classFileReader.html">00347</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>
 140 00348 {
 141 <a name="l00349"></a><a class="code" href="classFileReader.html#o0">00349</a>  <a class="code" href="modules_8h.html#a9">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
 142 00350  <span class="keyword">public</span>:
 143 00355          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 144 00361          <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
 145 00365          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 146 00371          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
 147 00376          <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
 148 00377          std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
 149 00383          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
 150 00384 };
 151 00385
 152 00386
 153 <a name="l00393"></a><a class="code" href="classModuleFactory.html">00393</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>
 154 00394 {
 155 00395  <span class="keyword">public</span>:
 156 <a name="l00396"></a><a class="code" href="classModuleFactory.html#a0">00396</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 157 <a name="l00397"></a><a class="code" href="classModuleFactory.html#a1">00397</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 158 00402         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 159 00403 };
 160 00404
 161 00405
 162 <a name="l00406"></a><a class="code" href="modules_8h.html#a11">00406</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a11">ircd_module</a>;
 163 00407
 164 00408 <span class="preprocessor">#endif</span>
 165 </pre></div><hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:27 2004 for InspIRCd by
 166 <a href="http://www.doxygen.org/index.html">
 167 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 168 width=110 height=53></a>1.3-rc3 </small></address>
 169 </body>
 170 </html>