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">
6 <!-- Generated by Doxygen 1.3-rc3 -->
8 <a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </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>
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 <string></span>
33 00025 <span class="preprocessor">#include <deque></span>
34 00026 <span class="preprocessor">#include <sstream></span>
36 <a name="l00030"></a><a class="code" href="modules_8h.html#a10">00030</a> <span class="keyword">typedef</span> std::deque<std::string> <a class="code" href="modules_8h.html#a10">file_cache</a>;
37 <a name="l00031"></a><a class="code" href="modules_8h.html#a11">00031</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>;
39 00033 <span class="comment">// This #define allows us to call a method in all</span>
40 00034 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
41 00035 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
43 <a name="l00037"></a><a class="code" href="modules_8h.html#a8">00037</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-></span>
44 00038 <span class="preprocessor"></span>
45 00039 <span class="comment">// This define is similar to the one above but returns a result in MOD_RESULT.</span>
46 00040 <span class="comment">// The first module to return a nonzero result is the value to be accepted,</span>
47 00041 <span class="comment">// and any modules after are ignored.</span>
49 00043 <span class="comment">// *********************************************************************************************</span>
51 <a name="l00045"></a><a class="code" href="modules_8h.html#a9">00045</a> <span class="preprocessor">#define FOREACH_RESULT(x) { MOD_RESULT = 0; \</span>
52 00046 <span class="preprocessor"> for (int i = 0; i <= MODCOUNT; i++) { \</span>
53 00047 <span class="preprocessor"> int res = modules[i]->x ; \</span>
54 00048 <span class="preprocessor"> if (res) { \</span>
55 00049 <span class="preprocessor"> MOD_RESULT = res; \</span>
56 00050 <span class="preprocessor"> break; \</span>
57 00051 <span class="preprocessor"> } \</span>
58 00052 <span class="preprocessor"> } \</span>
59 00053 <span class="preprocessor"> } </span>
60 00054 <span class="preprocessor"></span>
61 00055 <span class="comment">// *********************************************************************************************</span>
63 00057 <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);
64 00058 <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);
66 00060 <span class="comment">// class Version holds the version information of a Module, returned</span>
67 00061 <span class="comment">// by Module::GetVersion (thanks RD)</span>
69 <a name="l00067"></a><a class="code" href="classVersion.html">00067</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 00069 <span class="keyword">public</span>:
72 <a name="l00070"></a><a class="code" href="classVersion.html#m2">00070</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>;
73 00071 <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);
76 <a name="l00079"></a><a class="code" href="classAdmin.html">00079</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>
78 00081 <span class="keyword">public</span>:
79 <a name="l00082"></a><a class="code" href="classAdmin.html#m2">00082</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>;
80 00083 <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
83 <a name="l00091"></a><a class="code" href="classModule.html">00091</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>
85 00093 <span class="keyword">public</span>:
87 00098 <a class="code" href="classModule.html#a0">Module</a>();
89 00103 <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
91 00109 <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
93 00114 <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);
95 00119 <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);
97 00125 <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);
99 00131 <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);
101 00139 <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);
103 00148 <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);
105 00155 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
107 00163 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">OnServerRaw</a>(std::string &raw, <span class="keywordtype">bool</span> inbound);
109 00174 <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, <span class="keywordtype">void</span>* target, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, string_list &params);
111 00188 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a12">OnUserPreJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keyword">const</span> <span class="keywordtype">char</span>* cname);
114 00195 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a13">OnOper</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
116 00205 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a14">OnInfo</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
118 00211 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a15">OnWhois</a>(<a class="code" href="classuserrec.html">userrec</a>* source, <a class="code" href="classuserrec.html">userrec</a>* dest);
120 00221 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a16">OnUserPreMessage</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string text);
122 00231 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a17">OnUserPreNotice</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string text);
126 <a name="l00240"></a><a class="code" href="classServer.html">00240</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>
128 00242 <span class="keyword">public</span>:
129 00246 <a class="code" href="classServer.html#a0">Server</a>();
130 00250 <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
132 00255 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
133 00260 <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);
134 00265 <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);
135 00270 <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);
136 00275 <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);
137 00290 <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);
138 00297 <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);
139 00302 <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);
140 00310 <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);
141 00315 <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);
143 00320 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
144 00324 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classServer.html#a13">CountUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* c);
145 00328 <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a14">FindNick</a>(std::string nick);
146 00332 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a15">FindChannel</a>(std::string channel);
147 00337 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
148 00340 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a17">GetServerName</a>();
149 00343 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a18">GetNetworkName</a>();
150 00349 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a19">GetAdmin</a>();
151 00368 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a20">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);
153 00384 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a21">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
155 00407 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a22">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
157 00421 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a23">SendToModeMask</a>(std::string modes, <span class="keywordtype">int</span> flags, std::string text);
159 00428 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a24">JoinUserToChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string key);
161 00435 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a25">PartUserFromChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string reason);
163 00442 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a26">ChangeUserNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string nickname);
165 00454 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a27">QuitUser</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string reason);
167 00460 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a28">MatchText</a>(std::string sliteral, std::string spattern);
170 <a name="l00469"></a><a class="code" href="classConfigReader.html">00469</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>
172 00471 <span class="keyword">protected</span>:
173 <a name="l00477"></a><a class="code" href="classConfigReader.html#n0">00477</a> std::stringstream *<a class="code" href="classConfigReader.html#n0">cache</a>;
174 <a name="l00480"></a><a class="code" href="classConfigReader.html#n1">00480</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#n1">error</a>;
176 00482 <span class="keyword">public</span>:
177 00487 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span>
178 00491 <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>
179 00495 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
180 00500 std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
181 00507 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag);
182 00512 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
184 00519 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a6">EnumerateValues</a>(std::string tag, <span class="keywordtype">int</span> index);
189 <a name="l00529"></a><a class="code" href="classFileReader.html">00529</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>
191 <a name="l00531"></a><a class="code" href="classFileReader.html#o0">00531</a> <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
192 00532 <span class="keyword">public</span>:
193 00537 <a class="code" href="classFileReader.html#a0">FileReader</a>();
195 00544 <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
197 00549 <a class="code" href="classFileReader.html#a2">~FileReader</a>();
199 00556 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
201 00561 <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
203 00567 std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
205 00574 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
209 <a name="l00584"></a><a class="code" href="classModuleFactory.html">00584</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>
211 00586 <span class="keyword">public</span>:
212 <a name="l00587"></a><a class="code" href="classModuleFactory.html#a0">00587</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
213 <a name="l00588"></a><a class="code" href="classModuleFactory.html#a1">00588</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
214 00593 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
218 <a name="l00597"></a><a class="code" href="modules_8h.html#a12">00597</a> <span class="keyword">typedef</span> DLLFactory<ModuleFactory> <a class="code" href="modules_8h.html#a12">ircd_module</a>;
220 00599 <span class="preprocessor">#endif</span>
221 </pre></div><hr><address style="align: right;"><small>Generated on Thu Apr 8 19:12:27 2004 for InspIRCd by
222 <a href="http://www.doxygen.org/index.html">
223 <img src="doxygen.png" alt="doxygen" align="middle" border=0
224 width=110 height=53></a>1.3-rc3 </small></address>