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-rc2 -->
   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">$Log$
  12 00003 <span class="comment">Revision 1.5  2003/01/27 00:28:57  brain
  13 00003 <span class="comment">...
  14 00003 <span class="comment"></span>
  15 00004 <span class="comment">Revision 1.2  2003/01/26 23:52:59  brain</span>
  16 00005 <span class="comment">Modified documentation for base classes</span>
  17 00006 <span class="comment">Added base classes</span>
  18 00007 <span class="comment"></span>
  19 00008 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
  20 00009 <span class="comment">InspIRCd second source tree</span>
  21 00010 <span class="comment"></span>
  22 00011 <span class="comment">Revision 1.12  2003/01/22 20:59:10  brain</span>
  23 00012 <span class="comment">Added FileReader class documentation</span>
  24 00013 <span class="comment"></span>
  25 00014 <span class="comment">Revision 1.11  2003/01/22 20:49:16  brain</span>
  26 00015 <span class="comment">Added FileReader file-caching class</span>
  27 00016 <span class="comment">Changed m_randquote to use FileReader class</span>
  28 00017 <span class="comment"></span>
  29 00018 <span class="comment">Revision 1.10  2003/01/22 00:57:27  brain</span>
  30 00019 <span class="comment">Changes to documentation</span>
  31 00020 <span class="comment"></span>
  32 00021 <span class="comment">Revision 1.9  2003/01/22 00:44:26  brain</span>
  33 00022 <span class="comment">Added documentation comments</span>
  34 00023 <span class="comment"></span>
  35 00024 <span class="comment">Revision 1.8  2003/01/21 20:31:24  brain</span>
  36 00025 <span class="comment">Modified to add documentation</span>
  37 00026 <span class="comment">Added ConfigReader class for modules</span>
  38 00027 <span class="comment"></span>
  39 00028 <span class="comment">Revision 1.7  2003/01/15 22:47:44  brain</span>
  40 00029 <span class="comment">Changed user and channel structs to classes (finally)</span>
  41 00030 <span class="comment"></span>
  42 00031 <span class="comment">Revision 1.6  2003/01/13 22:30:50  brain</span>
  43 00032 <span class="comment">Added Admin class (holds /admin info for modules)</span>
  44 00033 <span class="comment">Added methods to Server class</span>
  45 00034 <span class="comment"></span>
  46 00035 <span class="comment"></span>
  47 00036 <span class="comment">*/</span>
  48 00037
  49 00038
  50 00039 <span class="preprocessor">#ifndef __PLUGIN_H</span>
  51 00040 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
  52 00041 <span class="preprocessor"></span>
  53 00042 <span class="preprocessor">#include "dynamic.h"</span>
  54 00043 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
  55 00044 <span class="preprocessor">#include &lt;string&gt;</span>
  56 00045 <span class="preprocessor">#include &lt;deque&gt;</span>
  57 00046
  58 <a name="l00049"></a><a class="code" href="modules_8h.html#a1">00049</a> <span class="keyword">typedef</span> deque&lt;string&gt; <a class="code" href="modules_8h.html#a1">file_cache</a>;
  59 00050
  60 00051
  61 00052 <span class="comment">// This #define allows us to call a method in all</span>
  62 00053 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
  63 00054 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
  64 00055
  65 <a name="l00056"></a><a class="code" href="modules_8h.html#a0">00056</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
  66 00057 <span class="preprocessor"></span>
  67 00058 <span class="comment">// class Version holds the version information of a Module, returned</span>
  68 00059 <span class="comment">// by Module::GetVersion (thanks RD)</span>
  69 00060
  70 <a name="l00065"></a><a class="code" href="classVersion.html">00065</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>
  71 00066 {
  72 00067  <span class="keyword">public</span>:
  73 <a name="l00068"></a><a class="code" href="classVersion.html#m2">00068</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>;
  74 00069          <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);
  75 00070 };
  76 00071
  77 00072
  78 <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>
  79 00079 {
  80 00080  <span class="keyword">public</span>:
  81 <a name="l00081"></a><a class="code" href="classAdmin.html#m2">00081</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>;
  82 00082          <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick);
  83 00083 };
  84 00084
  85 <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>
  86 00091 {
  87 00092  <span class="keyword">public</span>:
  88 00096         <a class="code" href="classModule.html#a0">Module</a>();
  89 00100         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
  90 00105         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
  91 00109         <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);
  92 00113         <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);
  93 00118         <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);
  94 00123         <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);
  95 00124 };
  96 00125
  97 00126
  98 <a name="l00132"></a><a class="code" href="classServer.html">00132</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>
  99 00133 {
 100 00134  <span class="keyword">public</span>:
 101 00138         <a class="code" href="classServer.html#a0">Server</a>();
 102 00142         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
 103 00143
 104 00147         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
 105 00152         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Debug</a>(string s);
 106 00157         <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);
 107 00162         <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);
 108 00167         <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);
 109 00172         <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);
 110 00179         <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);
 111 00184         <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);
 112 00192         <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);
 113 00197         <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);
 114 00198
 115 00202         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
 116 00206         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick);
 117 00210         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel);
 118 00215         <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);
 119 00218         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
 120 00221         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
 121 00227         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
 122 00228
 123 00229 };
 124 00230
 125 <a name="l00237"></a><a class="code" href="classConfigReader.html">00237</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>
 126 00238 {
 127 00239   <span class="keyword">protected</span>:
 128 <a name="l00242"></a><a class="code" href="classConfigReader.html#n0">00242</a>         string <a class="code" href="classConfigReader.html#n0">fname</a>;
 129 00243   <span class="keyword">public</span>:
 130 00248         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
 131 00252 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename);  <span class="comment">// read a module-specific config</span>
 132 00256 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
 133 00261         string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
 134 00268         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
 135 00272         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
 136 00273 };
 137 00274
 138 00275
 139 00276
 140 <a name="l00282"></a><a class="code" href="classFileReader.html">00282</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>
 141 00283 {
 142 <a name="l00284"></a><a class="code" href="classFileReader.html#o0">00284</a>  <a class="code" href="modules_8h.html#a1">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
 143 00285  <span class="keyword">public</span>:
 144 00290          <a class="code" href="classFileReader.html#a0">FileReader</a>();
 145 00296          <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
 146 00300          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
 147 00306          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
 148 00311          string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
 149 00317          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
 150 00318 };
 151 00319
 152 00320
 153 <a name="l00327"></a><a class="code" href="classModuleFactory.html">00327</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 00328 {
 155 00329  <span class="keyword">public</span>:
 156 <a name="l00330"></a><a class="code" href="classModuleFactory.html#a0">00330</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
 157 <a name="l00331"></a><a class="code" href="classModuleFactory.html#a1">00331</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
 158 00336         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
 159 00337 };
 160 00338
 161 00339 <span class="preprocessor">#endif</span>
 162 </pre></div><hr><address style="align: right;"><small>Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by
 163 <a href="http://www.doxygen.org/index.html">
 164 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 165 width=110 height=53></a>1.3-rc2 </small></address>
 166 </body>
 167 </html>