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 00071         <a class="code" href="classModule.html#a0">Module</a>();
  61 00075         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
  62 00080         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
  63 00084         <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);
  64 00088         <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);
  65 00093         <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);
  66 00098         <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);
  67 00099
  68 00100
  69 00101         <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);
  70 00102         <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);
  71 00103         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
  72 00104         <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);
  73 00105
  74 00106 };
  75 00107
  76 00108
  77 <a name="l00114"></a><a class="code" href="classServer.html">00114</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>
  78 00115 {
  79 00116  <span class="keyword">public</span>:
  80 00120         <a class="code" href="classServer.html#a0">Server</a>();
  81 00124         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
  82 00125
  83 00129         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
  84 00134         <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);
  85 00139         <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);
  86 00144         <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);
  87 00149         <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);
  88 00154         <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);
  89 00161         <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);
  90 00166         <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);
  91 00174         <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);
  92 00179         <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);
  93 00180
  94 00184         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
  95 00188         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick);
  96 00192         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel);
  97 00197         <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);
  98 00200         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
  99 00203         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
 100 00209         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
 101 00210
 102 00211 };
 103 00212
 104 <a name="l00219"></a><a class="code" href="classConfigReader.html">00219</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>
 105 00220 {
 106 00221   <span class="keyword">protected</span>:
 107 <a name="l00224"></a><a class="code" href="classConfigReader.html#n0">00224</a>         string <a class="code" href="classConfigReader.html#n0">fname</a>;
 108 00225   <span class="keyword">public</span>:
 109 00230         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 110 00234 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename);  <span class="comment">// read a module-specific config</span>
 111 00238 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 112 00243         string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
 113 00250         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
 114 00254         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
 115 00255 };
 116 00256
 117 00257
 118 00258
 119 <a name="l00264"></a><a class="code" href="classFileReader.html">00264</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>
 120 00265 {
 121 <a name="l00266"></a><a class="code" href="classFileReader.html#o0">00266</a>  <a class="code" href="modules_8h.html#a6">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
 122 00267  <span class="keyword">public</span>:
 123 00272          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 124 00278          <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
 125 00282          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 126 00288          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
 127 00293          string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
 128 00299          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
 129 00300 };
 130 00301
 131 00302
 132 <a name="l00309"></a><a class="code" href="classModuleFactory.html">00309</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>
 133 00310 {
 134 00311  <span class="keyword">public</span>:
 135 <a name="l00312"></a><a class="code" href="classModuleFactory.html#a0">00312</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 136 <a name="l00313"></a><a class="code" href="classModuleFactory.html#a1">00313</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 137 00318         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 138 00319 };
 139 00320
 140 00321
 141 <a name="l00322"></a><a class="code" href="modules_8h.html#a7">00322</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a7">ircd_module</a>;
 142 00323
 143 00324 <span class="preprocessor">#endif</span>
 144 </pre></div><hr><address style="align: right;"><small>Generated on Sun Mar 30 13:27:58 2003 for InspIRCd by
 145 <a href="http://www.doxygen.org/index.html">
 146 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 147 width=110 height=53></a>1.3-rc3 </small></address>
 148 </body>
 149 </html>