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">
6 <!-- Generated by Doxygen 1.3-rc2 -->
8 <a class="qindex" href="main.html">Main Page</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">$Log$
12 00003 <span class="comment">Revision 1.2 2003/01/23 20:38:00 brain
13 00003 <span class="comment">Updated documentation scripts
14 00003 <span class="comment"></span>
15 00004 <span class="comment">Revision 1.1.1.1 2003/01/23 19:45:58 brain</span>
16 00005 <span class="comment">InspIRCd second source tree</span>
17 00006 <span class="comment"></span>
18 00007 <span class="comment">Revision 1.12 2003/01/22 20:59:10 brain</span>
19 00008 <span class="comment">Added FileReader class documentation</span>
20 00009 <span class="comment"></span>
21 00010 <span class="comment">Revision 1.11 2003/01/22 20:49:16 brain</span>
22 00011 <span class="comment">Added FileReader file-caching class</span>
23 00012 <span class="comment">Changed m_randquote to use FileReader class</span>
24 00013 <span class="comment"></span>
25 00014 <span class="comment">Revision 1.10 2003/01/22 00:57:27 brain</span>
26 00015 <span class="comment">Changes to documentation</span>
27 00016 <span class="comment"></span>
28 00017 <span class="comment">Revision 1.9 2003/01/22 00:44:26 brain</span>
29 00018 <span class="comment">Added documentation comments</span>
30 00019 <span class="comment"></span>
31 00020 <span class="comment">Revision 1.8 2003/01/21 20:31:24 brain</span>
32 00021 <span class="comment">Modified to add documentation</span>
33 00022 <span class="comment">Added ConfigReader class for modules</span>
34 00023 <span class="comment"></span>
35 00024 <span class="comment">Revision 1.7 2003/01/15 22:47:44 brain</span>
36 00025 <span class="comment">Changed user and channel structs to classes (finally)</span>
37 00026 <span class="comment"></span>
38 00027 <span class="comment">Revision 1.6 2003/01/13 22:30:50 brain</span>
39 00028 <span class="comment">Added Admin class (holds /admin info for modules)</span>
40 00029 <span class="comment">Added methods to Server class</span>
41 00030 <span class="comment"></span>
42 00031 <span class="comment"></span>
43 00032 <span class="comment">*/</span>
46 00035 <span class="preprocessor">#ifndef __PLUGIN_H</span>
47 00036 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
48 00037 <span class="preprocessor"></span>
49 00038 <span class="preprocessor">#include "dynamic.h"</span>
50 00039 <span class="preprocessor">#include <string></span>
51 00040 <span class="preprocessor">#include <deque></span>
53 <a name="l00044"></a><a class="code" href="modules_8h.html#a1">00044</a> <span class="keyword">typedef</span> deque<string> <a class="code" href="modules_8h.html#a1">file_cache</a>;
56 00047 <span class="comment">// This #define allows us to call a method in all</span>
57 00048 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
58 00049 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
60 <a name="l00051"></a><a class="code" href="modules_8h.html#a0">00051</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-></span>
61 00052 <span class="preprocessor"></span>
62 00053 <span class="comment">// class Version holds the version information of a Module, returned</span>
63 00054 <span class="comment">// by Module::GetVersion (thanks RD)</span>
65 <a name="l00060"></a><a class="code" href="classVersion.html">00060</a> <span class="keyword">class </span><a class="code" href="classVersion.html">Version</a>
67 00062 <span class="keyword">public</span>:
68 <a name="l00063"></a><a class="code" href="classVersion.html#m2">00063</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>;
69 00064 <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);
73 <a name="l00073"></a><a class="code" href="classAdmin.html">00073</a> <span class="keyword">class </span><a class="code" href="classAdmin.html">Admin</a>
75 00075 <span class="keyword">public</span>:
76 <a name="l00076"></a><a class="code" href="classAdmin.html#m2">00076</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>;
77 00077 <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick);
80 <a name="l00085"></a><a class="code" href="classModule.html">00085</a> <span class="keyword">class </span><a class="code" href="classModule.html">Module</a>
82 00087 <span class="keyword">public</span>:
83 00091 <a class="code" href="classModule.html#a0">Module</a>();
84 00095 <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
85 00100 <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
86 00104 <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);
87 00108 <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);
88 00113 <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);
89 00118 <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);
93 <a name="l00127"></a><a class="code" href="classServer.html">00127</a> <span class="keyword">class </span><a class="code" href="classServer.html">Server</a>
95 00129 <span class="keyword">public</span>:
96 00133 <a class="code" href="classServer.html#a0">Server</a>();
97 00137 <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
99 00142 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
100 00147 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Debug</a>(string s);
101 00152 <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);
102 00157 <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);
103 00162 <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);
104 00167 <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);
105 00174 <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);
106 00179 <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);
107 00187 <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);
108 00192 <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);
110 00197 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
111 00201 <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick);
112 00205 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel);
113 00210 <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);
114 00213 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
115 00216 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
116 00222 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
120 <a name="l00232"></a><a class="code" href="classConfigReader.html">00232</a> <span class="keyword">class </span><a class="code" href="classConfigReader.html">ConfigReader</a>
122 00234 <span class="keyword">protected</span>:
123 <a name="l00237"></a><a class="code" href="classConfigReader.html#n0">00237</a> string <a class="code" href="classConfigReader.html#n0">fname</a>;
124 00238 <span class="keyword">public</span>:
125 00243 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span>
126 00247 <span class="comment"></span> <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename); <span class="comment">// read a module-specific config</span>
127 00251 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
128 00256 string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
129 00263 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
130 00267 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
135 <a name="l00277"></a><a class="code" href="classFileReader.html">00277</a> <span class="keyword">class </span><a class="code" href="classFileReader.html">FileReader</a>
137 <a name="l00279"></a><a class="code" href="classFileReader.html#o0">00279</a> <a class="code" href="modules_8h.html#a1">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
138 00280 <span class="keyword">public</span>:
139 00285 <a class="code" href="classFileReader.html#a0">FileReader</a>();
140 00291 <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
141 00295 <a class="code" href="classFileReader.html#a2">~FileReader</a>();
142 00301 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
143 00306 string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
144 00312 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
148 <a name="l00322"></a><a class="code" href="classModuleFactory.html">00322</a> <span class="keyword">class </span><a class="code" href="classModuleFactory.html">ModuleFactory</a>
150 00324 <span class="keyword">public</span>:
151 <a name="l00325"></a><a class="code" href="classModuleFactory.html#a0">00325</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
152 <a name="l00326"></a><a class="code" href="classModuleFactory.html#a1">00326</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
153 00331 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
156 00334 <span class="preprocessor">#endif</span>
157 </pre></div><hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by
158 <a href="http://www.doxygen.org/index.html">
159 <img src="doxygen.png" alt="doxygen" align="middle" border=0
160 width=110 height=53></a>1.3-rc2 </small></address>