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.cpp 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.cpp</h1><a href="modules_8cpp.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.1 2003/01/23 19:45:58 brain
13 00003 <span class="comment">Initial revision
14 00003 <span class="comment">
15 00003 <span class="comment">Revision 1.9 2003/01/22 20:59:12 brain
16 00003 <span class="comment">Added FileReader class documentation
17 00003 <span class="comment"></span>
18 00004 <span class="comment">Revision 1.7 2003/01/22 20:49:16 brain</span>
19 00005 <span class="comment">Added FileReader file-caching class</span>
20 00006 <span class="comment">Changed m_randquote to use FileReader class</span>
21 00007 <span class="comment"></span>
22 00008 <span class="comment">Revision 1.6 2003/01/21 20:31:24 brain</span>
23 00009 <span class="comment">Modified to add documentation</span>
24 00010 <span class="comment">Added ConfigReader class for modules</span>
25 00011 <span class="comment"></span>
26 00012 <span class="comment">Revision 1.5 2003/01/13 22:30:50 brain</span>
27 00013 <span class="comment">Added Admin class (holds /admin info for modules)</span>
28 00014 <span class="comment">Added methods to Server class</span>
29 00015 <span class="comment"></span>
30 00016 <span class="comment"></span>
31 00017 <span class="comment">*/</span>
35 00021 <span class="preprocessor">#include <typeinfo></span>
36 00022 <span class="preprocessor">#include <iostream.h></span>
37 00023 <span class="preprocessor">#include "globals.h"</span>
38 00024 <span class="preprocessor">#include "<a class="code" href="modules_8h.html">modules.h</a>"</span>
39 00025 <span class="preprocessor">#include "inspircd_io.h"</span>
41 00027 <span class="comment">// version is a simple class for holding a modules version number</span>
43 <a name="l00029"></a><a class="code" href="classVersion.html#a0">00029</a> <a class="code" href="classVersion.html#a0">Version::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) : Major(major), Minor(minor), Revision(revision), Build(build) { };
45 00031 <span class="comment">// admin is a simple class for holding a server's administrative info</span>
47 <a name="l00033"></a><a class="code" href="classAdmin.html#a0">00033</a> <a class="code" href="classAdmin.html#a0">Admin::Admin</a>(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { };
49 00035 <span class="comment">//</span>
50 00036 <span class="comment">// Announce to the world that the Module base</span>
51 00037 <span class="comment">// class has been created or destroyed</span>
52 00038 <span class="comment">//</span>
54 <a name="l00040"></a><a class="code" href="classModule.html#a0">00040</a> <a class="code" href="classModule.html#a0">Module::Module</a>() { }
55 <a name="l00041"></a><a class="code" href="classModule.html#a1">00041</a> <a class="code" href="classModule.html#a1">Module::~Module</a>() { }
56 <a name="l00042"></a><a class="code" href="classModule.html#a3">00042</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a3">Module::OnUserConnect</a>(<a class="code" href="classuserrec.html">userrec</a>* user) { }
57 <a name="l00043"></a><a class="code" href="classModule.html#a4">00043</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a4">Module::OnUserQuit</a>(<a class="code" href="classuserrec.html">userrec</a>* user) { }
58 <a name="l00044"></a><a class="code" href="classModule.html#a5">00044</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a5">Module::OnUserJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel) { }
59 <a name="l00045"></a><a class="code" href="classModule.html#a6">00045</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a6">Module::OnUserPart</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel) { }
60 <a name="l00046"></a><a class="code" href="classModule.html#a2">00046</a> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">Module::GetVersion</a>() { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
62 00048 <span class="comment">// server is a wrapper class that provides methods to all of the C-style</span>
63 00049 <span class="comment">// exports in the core</span>
64 00050 <span class="comment">//</span>
66 <a name="l00052"></a><a class="code" href="classServer.html#a0">00052</a> <a class="code" href="classServer.html#a0">Server::Server</a>()
70 <a name="l00056"></a><a class="code" href="classServer.html#a1">00056</a> <a class="code" href="classServer.html#a1">Server::~Server</a>()
74 <a name="l00060"></a><a class="code" href="classServer.html#a2">00060</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">Server::SendOpers</a>(string s)
76 00062 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
79 <a name="l00065"></a><a class="code" href="classServer.html#a3">00065</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Server::Debug</a>(string s)
81 00067 debug(<span class="stringliteral">"%s"</span>,s.c_str());
84 <a name="l00070"></a><a class="code" href="classServer.html#a4">00070</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Server::Send</a>(<span class="keywordtype">int</span> Socket, string s)
86 00072 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
89 <a name="l00075"></a><a class="code" href="classServer.html#a5">00075</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">Server::SendServ</a>(<span class="keywordtype">int</span> Socket, string s)
91 00077 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
94 <a name="l00080"></a><a class="code" href="classServer.html#a6">00080</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a6">Server::SendFrom</a>(<span class="keywordtype">int</span> Socket, <a class="code" href="classuserrec.html">userrec</a>* User, string s)
96 00082 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
99 <a name="l00085"></a><a class="code" href="classServer.html#a7">00085</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a7">Server::SendTo</a>(<a class="code" href="classuserrec.html">userrec</a>* Source, <a class="code" href="classuserrec.html">userrec</a>* Dest, string s)
101 00087 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
104 <a name="l00090"></a><a class="code" href="classServer.html#a8">00090</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a8">Server::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 00092 <span class="keywordflow">if</span> (IncludeSender)
108 00094 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
110 00096 <span class="keywordflow">else</span>
112 00098 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
116 <a name="l00102"></a><a class="code" href="classServer.html#a9">00102</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a9">Server::CommonChannels</a>(<a class="code" href="classuserrec.html">userrec</a>* u1, <a class="code" href="classuserrec.html">userrec</a>* u2)
118 00104 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
121 <a name="l00107"></a><a class="code" href="classServer.html#a10">00107</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a10">Server::SendCommon</a>(<a class="code" href="classuserrec.html">userrec</a>* User, string text,<span class="keywordtype">bool</span> IncludeSender)
123 00109 <span class="keywordflow">if</span> (IncludeSender)
125 00111 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
127 00113 <span class="keywordflow">else</span>
129 00115 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
133 <a name="l00119"></a><a class="code" href="classServer.html#a11">00119</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a11">Server::SendWallops</a>(<a class="code" href="classuserrec.html">userrec</a>* User, string text)
135 00121 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
138 <a name="l00124"></a><a class="code" href="classServer.html#a12">00124</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">Server::IsNick</a>(string nick)
140 00126 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
143 <a name="l00129"></a><a class="code" href="classServer.html#a13">00129</a> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">Server::FindNick</a>(string nick)
145 00131 <span class="keywordflow">return</span> Find(nick);
148 <a name="l00134"></a><a class="code" href="classServer.html#a14">00134</a> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">Server::FindChannel</a>(string channel)
150 00136 <span class="keywordflow">return</span> FindChan(channel.c_str());
153 <a name="l00139"></a><a class="code" href="classServer.html#a15">00139</a> string <a class="code" href="classServer.html#a15">Server::ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan)
155 00141 string mode = cmode(User,Chan);
156 00142 <span class="keywordflow">return</span> mode;
159 <a name="l00145"></a><a class="code" href="classServer.html#a16">00145</a> string <a class="code" href="classServer.html#a16">Server::GetServerName</a>()
161 00147 <span class="keywordflow">return</span> getservername();
164 <a name="l00150"></a><a class="code" href="classServer.html#a17">00150</a> string <a class="code" href="classServer.html#a17">Server::GetNetworkName</a>()
166 00152 <span class="keywordflow">return</span> getnetworkname();
169 <a name="l00155"></a><a class="code" href="classServer.html#a18">00155</a> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">Server::GetAdmin</a>()
171 00157 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
175 <a name="l00161"></a><a class="code" href="classConfigReader.html#a0">00161</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>()
177 00163 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
181 <a name="l00167"></a><a class="code" href="classConfigReader.html#a2">00167</a> <a class="code" href="classConfigReader.html#a2">ConfigReader::~ConfigReader</a>()
186 <a name="l00172"></a><a class="code" href="classConfigReader.html#a1">00172</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>(string filename) : fname(filename) { };
188 <a name="l00174"></a><a class="code" href="classConfigReader.html#a3">00174</a> string <a class="code" href="classConfigReader.html#a3">ConfigReader::ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index)
190 00176 <span class="keywordtype">char</span> val[MAXBUF];
191 00177 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
192 00178 string s = val;
193 00179 <span class="keywordflow">return</span> s;
197 <a name="l00183"></a><a class="code" href="classConfigReader.html#a4">00183</a> <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">ConfigReader::Enumerate</a>(string tag)
199 00185 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
203 <a name="l00189"></a><a class="code" href="classConfigReader.html#a5">00189</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">ConfigReader::Verify</a>()
205 00191 <span class="keywordflow">return</span> <span class="keyword">true</span>;
209 <a name="l00195"></a><a class="code" href="classFileReader.html#a1">00195</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>(string filename)
211 00197 <a class="code" href="modules_8h.html#a1">file_cache</a> c;
212 00198 readfile(c,filename.c_str());
213 00199 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
216 <a name="l00202"></a><a class="code" href="classFileReader.html#a0">00202</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>()
220 <a name="l00206"></a><a class="code" href="classFileReader.html#a3">00206</a> <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">FileReader::LoadFile</a>(string filename)
222 00208 <a class="code" href="modules_8h.html#a1">file_cache</a> c;
223 00209 readfile(c,filename.c_str());
224 00210 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
227 <a name="l00213"></a><a class="code" href="classFileReader.html#a2">00213</a> <a class="code" href="classFileReader.html#a2">FileReader::~FileReader</a>()
231 <a name="l00217"></a><a class="code" href="classFileReader.html#a4">00217</a> string <a class="code" href="classFileReader.html#a4">FileReader::GetLine</a>(<span class="keywordtype">int</span> x)
233 00219 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size()))
234 00220 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
235 00221 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
238 <a name="l00224"></a><a class="code" href="classFileReader.html#a5">00224</a> <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileReader::FileSize</a>()
240 00226 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
244 </pre></div><hr><address style="align: right;"><small>Generated on Wed Jan 22 20:56:47 2003 for InspIRCd by
245 <a href="http://www.doxygen.org/index.html">
246 <img src="doxygen.png" alt="doxygen" align="middle" border=0
247 width=110 height=53></a>1.3-rc2 </small></address>