mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-10 19:19:02 -04:00
d9b89849e0
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@155 e03df62e-2008-0410-955e-edbf42e46eb7
168 lines
15 KiB
HTML
168 lines
15 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>modules.h Source File</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3-rc2 -->
|
|
<center>
|
|
<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>
|
|
<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>
|
|
00002 <span class="comment"></span>
|
|
00003 <span class="comment">$Log$
|
|
00003 <span class="comment">Revision 1.4 2003/01/27 00:22:39 brain
|
|
00003 <span class="comment">Modified documentation
|
|
00003 <span class="comment"></span>
|
|
00004 <span class="comment">Revision 1.2 2003/01/26 23:52:59 brain</span>
|
|
00005 <span class="comment">Modified documentation for base classes</span>
|
|
00006 <span class="comment">Added base classes</span>
|
|
00007 <span class="comment"></span>
|
|
00008 <span class="comment">Revision 1.1.1.1 2003/01/23 19:45:58 brain</span>
|
|
00009 <span class="comment">InspIRCd second source tree</span>
|
|
00010 <span class="comment"></span>
|
|
00011 <span class="comment">Revision 1.12 2003/01/22 20:59:10 brain</span>
|
|
00012 <span class="comment">Added FileReader class documentation</span>
|
|
00013 <span class="comment"></span>
|
|
00014 <span class="comment">Revision 1.11 2003/01/22 20:49:16 brain</span>
|
|
00015 <span class="comment">Added FileReader file-caching class</span>
|
|
00016 <span class="comment">Changed m_randquote to use FileReader class</span>
|
|
00017 <span class="comment"></span>
|
|
00018 <span class="comment">Revision 1.10 2003/01/22 00:57:27 brain</span>
|
|
00019 <span class="comment">Changes to documentation</span>
|
|
00020 <span class="comment"></span>
|
|
00021 <span class="comment">Revision 1.9 2003/01/22 00:44:26 brain</span>
|
|
00022 <span class="comment">Added documentation comments</span>
|
|
00023 <span class="comment"></span>
|
|
00024 <span class="comment">Revision 1.8 2003/01/21 20:31:24 brain</span>
|
|
00025 <span class="comment">Modified to add documentation</span>
|
|
00026 <span class="comment">Added ConfigReader class for modules</span>
|
|
00027 <span class="comment"></span>
|
|
00028 <span class="comment">Revision 1.7 2003/01/15 22:47:44 brain</span>
|
|
00029 <span class="comment">Changed user and channel structs to classes (finally)</span>
|
|
00030 <span class="comment"></span>
|
|
00031 <span class="comment">Revision 1.6 2003/01/13 22:30:50 brain</span>
|
|
00032 <span class="comment">Added Admin class (holds /admin info for modules)</span>
|
|
00033 <span class="comment">Added methods to Server class</span>
|
|
00034 <span class="comment"></span>
|
|
00035 <span class="comment"></span>
|
|
00036 <span class="comment">*/</span>
|
|
00037
|
|
00038
|
|
00039 <span class="preprocessor">#ifndef __PLUGIN_H</span>
|
|
00040 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
|
|
00041 <span class="preprocessor"></span>
|
|
00042 <span class="preprocessor">#include "dynamic.h"</span>
|
|
00043 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
|
|
00044 <span class="preprocessor">#include <string></span>
|
|
00045 <span class="preprocessor">#include <deque></span>
|
|
00046
|
|
<a name="l00049"></a><a class="code" href="modules_8h.html#a1">00049</a> <span class="keyword">typedef</span> deque<string> <a class="code" href="modules_8h.html#a1">file_cache</a>;
|
|
00050
|
|
00051
|
|
00052 <span class="comment">// This #define allows us to call a method in all</span>
|
|
00053 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
|
|
00054 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
|
|
00055
|
|
<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 <= MODCOUNT; i++) modules[i]-></span>
|
|
00057 <span class="preprocessor"></span>
|
|
00058 <span class="comment">// class Version holds the version information of a Module, returned</span>
|
|
00059 <span class="comment">// by Module::GetVersion (thanks RD)</span>
|
|
00060
|
|
<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>
|
|
00066 {
|
|
00067 <span class="keyword">public</span>:
|
|
<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>;
|
|
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);
|
|
00070 };
|
|
00071
|
|
00072
|
|
<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>
|
|
00079 {
|
|
00080 <span class="keyword">public</span>:
|
|
<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>;
|
|
00082 <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick);
|
|
00083 };
|
|
00084
|
|
<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>
|
|
00091 {
|
|
00092 <span class="keyword">public</span>:
|
|
00096 <a class="code" href="classModule.html#a0">Module</a>();
|
|
00100 <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
|
|
00105 <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
00124 };
|
|
00125
|
|
00126
|
|
<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>
|
|
00133 {
|
|
00134 <span class="keyword">public</span>:
|
|
00138 <a class="code" href="classServer.html#a0">Server</a>();
|
|
00142 <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
|
|
00143
|
|
00147 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
|
|
00152 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Debug</a>(string s);
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
00198
|
|
00202 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
|
|
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);
|
|
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);
|
|
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);
|
|
00218 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
|
|
00221 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
|
|
00227 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
|
|
00228
|
|
00229 };
|
|
00230
|
|
<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>
|
|
00238 {
|
|
00239 <span class="keyword">protected</span>:
|
|
<a name="l00242"></a><a class="code" href="classConfigReader.html#n0">00242</a> string <a class="code" href="classConfigReader.html#n0">fname</a>;
|
|
00243 <span class="keyword">public</span>:
|
|
00248 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span>
|
|
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>
|
|
00256 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
|
|
00261 string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
|
|
00268 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
|
|
00272 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
|
|
00273 };
|
|
00274
|
|
00275
|
|
00276
|
|
<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>
|
|
00283 {
|
|
<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>;
|
|
00285 <span class="keyword">public</span>:
|
|
00290 <a class="code" href="classFileReader.html#a0">FileReader</a>();
|
|
00296 <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
|
|
00300 <a class="code" href="classFileReader.html#a2">~FileReader</a>();
|
|
00306 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
|
|
00311 string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
|
|
00317 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
|
|
00318 };
|
|
00319
|
|
00320
|
|
<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>
|
|
00328 {
|
|
00329 <span class="keyword">public</span>:
|
|
<a name="l00330"></a><a class="code" href="classModuleFactory.html#a0">00330</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
|
|
<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>() { }
|
|
00336 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
|
|
00337 };
|
|
00338
|
|
00339 <span class="preprocessor">#endif</span>
|
|
</pre></div><hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:41 2003 for InspIRCd by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0
|
|
width=110 height=53></a>1.3-rc2 </small></address>
|
|
</body>
|
|
</html>
|