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 00017 <span class="preprocessor">#include "dynamic.h"</span>
  26 00018 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  27 00019 <span class="preprocessor">#include &lt;string&gt;</span>
  28 00020 <span class="preprocessor">#include &lt;deque&gt;</span>
  29 00021
  30 <a name="l00024"></a><a class="code" href="modules_8h.html#a6">00024</a> <span class="keyword">typedef</span> deque&lt;string&gt; <a class="code" href="modules_8h.html#a6">file_cache</a>;
  31 00025
  32 00026
  33 00027 <span class="comment">// This #define allows us to call a method in all</span>
  34 00028 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
  35 00029 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
  36 00030
  37 <a name="l00031"></a><a class="code" href="modules_8h.html#a5">00031</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
  38 00032 <span class="preprocessor"></span>
  39 00033 <span class="comment">// class Version holds the version information of a Module, returned</span>
  40 00034 <span class="comment">// by Module::GetVersion (thanks RD)</span>
  41 00035
  42 <a name="l00040"></a><a class="code" href="classVersion.html">00040</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>
  43 00041 {
  44 00042  <span class="keyword">public</span>:
  45 <a name="l00043"></a><a class="code" href="classVersion.html#m2">00043</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>;
  46 00044          <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);
  47 00045 };
  48 00046
  49 00047
  50 <a name="l00053"></a><a class="code" href="classAdmin.html">00053</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>
  51 00054 {
  52 00055  <span class="keyword">public</span>:
  53 <a name="l00056"></a><a class="code" href="classAdmin.html#m2">00056</a>          <span class="keyword">const</span> 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>;
  54 00057          <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick);
  55 00058 };
  56 00059
  57 <a name="l00065"></a><a class="code" href="classModule.html">00065</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>
  58 00066 {
  59 00067  <span class="keyword">public</span>:
  60 00068
  61 00072         <a class="code" href="classModule.html#a0">Module</a>();
  62 00073
  63 00077         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
  64 00078
  65 00083         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
  66 00084
  67 00088         <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);
  68 00089
  69 00093         <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);
  70 00094
  71 00099         <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);
  72 00100
  73 00105         <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);
  74 00106
  75 00113         <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);
  76 00114
  77 00122         <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);
  78 00123
  79 00129         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
  80 00130
  81 00137         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">Module::OnServerRaw</a>(string &amp;raw, <span class="keywordtype">bool</span> inbound);
  82 00138
  83 00139 };
  84 00140
  85 00141
  86 <a name="l00147"></a><a class="code" href="classServer.html">00147</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>
  87 00148 {
  88 00149  <span class="keyword">public</span>:
  89 00153         <a class="code" href="classServer.html#a0">Server</a>();
  90 00157         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
  91 00158
  92 00162         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
  93 00167         <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, string s);
  94 00172         <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, string s);
  95 00177         <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, string s);
  96 00182         <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, string s);
  97 00187         <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, string s);
  98 00194         <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, string s,<span class="keywordtype">bool</span> IncludeSender);
  99 00199         <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);
 100 00207         <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, string text,<span class="keywordtype">bool</span> IncludeSender);
 101 00212         <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, string text);
 102 00213
 103 00217         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
 104 00221         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick);
 105 00225         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel);
 106 00230         <span class="keyword">virtual</span> 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);
 107 00233         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
 108 00236         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
 109 00242         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
 110 00243
 111 00244 };
 112 00245
 113 <a name="l00252"></a><a class="code" href="classConfigReader.html">00252</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>
 114 00253 {
 115 00254   <span class="keyword">protected</span>:
 116 <a name="l00257"></a><a class="code" href="classConfigReader.html#n0">00257</a>         string <a class="code" href="classConfigReader.html#n0">fname</a>;
 117 00258   <span class="keyword">public</span>:
 118 00263         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 119 00267 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename);  <span class="comment">// read a module-specific config</span>
 120 00271 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 121 00276         string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
 122 00283         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
 123 00287         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
 124 00288 };
 125 00289
 126 00290
 127 00291
 128 <a name="l00297"></a><a class="code" href="classFileReader.html">00297</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>
 129 00298 {
 130 <a name="l00299"></a><a class="code" href="classFileReader.html#o0">00299</a>  <a class="code" href="modules_8h.html#a6">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
 131 00300  <span class="keyword">public</span>:
 132 00305          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 133 00311          <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
 134 00315          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 135 00321          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
 136 00326          string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
 137 00332          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
 138 00333 };
 139 00334
 140 00335
 141 <a name="l00342"></a><a class="code" href="classModuleFactory.html">00342</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>
 142 00343 {
 143 00344  <span class="keyword">public</span>:
 144 <a name="l00345"></a><a class="code" href="classModuleFactory.html#a0">00345</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 145 <a name="l00346"></a><a class="code" href="classModuleFactory.html#a1">00346</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 146 00351         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 147 00352 };
 148 00353
 149 00354
 150 <a name="l00355"></a><a class="code" href="modules_8h.html#a7">00355</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a7">ircd_module</a>;
 151 00356
 152 00357 <span class="preprocessor">#endif</span>
 153 </pre></div><hr><address style="align: right;"><small>Generated on Sun Mar 30 19:34:54 2003 for InspIRCd by
 154 <a href="http://www.doxygen.org/index.html">
 155 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 156 width=110 height=53></a>1.3-rc3 </small></address>
 157 </body>
 158 </html>