]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/modules_8cpp-source.html
Documentation update, 09/02/03
[user/henk/code/inspircd.git] / docs / module-doc / modules_8cpp-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.cpp 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.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"></span>
12 00004 <span class="comment">*/</span>
13 00005 
14 00006 
15 00007 
16 00008 <span class="preprocessor">#include &lt;typeinfo&gt;</span>
17 00009 <span class="preprocessor">#include &lt;iostream.h&gt;</span>
18 00010 <span class="preprocessor">#include "globals.h"</span>
19 00011 <span class="preprocessor">#include "<a class="code" href="modules_8h.html">modules.h</a>"</span>
20 00012 <span class="preprocessor">#include "inspircd_io.h"</span>
21 00013 
22 00014 <span class="comment">// version is a simple class for holding a modules version number</span>
23 00015 
24 <a name="l00016"></a><a class="code" href="classVersion.html#a0">00016</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) { };
25 00017 
26 00018 <span class="comment">// admin is a simple class for holding a server's administrative info</span>
27 00019 
28 <a name="l00020"></a><a class="code" href="classAdmin.html#a0">00020</a> <a class="code" href="classAdmin.html#a0">Admin::Admin</a>(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { };
29 00021 
30 00022 <span class="comment">//</span>
31 00023 <span class="comment">// Announce to the world that the Module base</span>
32 00024 <span class="comment">// class has been created or destroyed</span>
33 00025 <span class="comment">//</span>
34 00026 
35 <a name="l00027"></a><a class="code" href="classModule.html#a0">00027</a> <a class="code" href="classModule.html#a0">Module::Module</a>() { }
36 <a name="l00028"></a><a class="code" href="classModule.html#a1">00028</a> <a class="code" href="classModule.html#a1">Module::~Module</a>() { }
37 <a name="l00029"></a><a class="code" href="classModule.html#a3">00029</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) { }
38 <a name="l00030"></a><a class="code" href="classModule.html#a4">00030</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) { }
39 <a name="l00031"></a><a class="code" href="classModule.html#a5">00031</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) { }
40 <a name="l00032"></a><a class="code" href="classModule.html#a6">00032</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) { }
41 00033 <span class="keywordtype">void</span> Module::OnPacketTransmit(<span class="keywordtype">char</span> *p) { }
42 00034 <span class="keywordtype">void</span> Module::OnPacketReceive(<span class="keywordtype">char</span> *p) { }
43 <a name="l00035"></a><a class="code" href="classModule.html#a9">00035</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">Module::OnRehash</a>() { }
44 <a name="l00036"></a><a class="code" href="classModule.html#a2">00036</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); }
45 00037 
46 00038 <span class="comment">// server is a wrapper class that provides methods to all of the C-style</span>
47 00039 <span class="comment">// exports in the core</span>
48 00040 <span class="comment">//</span>
49 00041 
50 <a name="l00042"></a><a class="code" href="classServer.html#a0">00042</a> <a class="code" href="classServer.html#a0">Server::Server</a>()
51 00043 {
52 00044 }
53 00045 
54 <a name="l00046"></a><a class="code" href="classServer.html#a1">00046</a> <a class="code" href="classServer.html#a1">Server::~Server</a>()
55 00047 {
56 00048 }
57 00049 
58 <a name="l00050"></a><a class="code" href="classServer.html#a2">00050</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">Server::SendOpers</a>(string s)
59 00051 {
60 00052         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
61 00053 }
62 00054 
63 <a name="l00055"></a><a class="code" href="classServer.html#a3">00055</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Server::Log</a>(<span class="keywordtype">int</span> level, string s)
64 00056 {
65 00057         log(level,<span class="stringliteral">"%s"</span>,s.c_str());
66 00058 }
67 00059 
68 <a name="l00060"></a><a class="code" href="classServer.html#a4">00060</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Server::Send</a>(<span class="keywordtype">int</span> Socket, string s)
69 00061 {
70 00062         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
71 00063 }
72 00064 
73 <a name="l00065"></a><a class="code" href="classServer.html#a5">00065</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">Server::SendServ</a>(<span class="keywordtype">int</span> Socket, string s)
74 00066 {
75 00067         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
76 00068 }
77 00069 
78 <a name="l00070"></a><a class="code" href="classServer.html#a6">00070</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)
79 00071 {
80 00072         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
81 00073 }
82 00074 
83 <a name="l00075"></a><a class="code" href="classServer.html#a7">00075</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)
84 00076 {
85 00077         WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
86 00078 }
87 00079 
88 <a name="l00080"></a><a class="code" href="classServer.html#a8">00080</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)
89 00081 {
90 00082         <span class="keywordflow">if</span> (IncludeSender)
91 00083         {
92 00084                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
93 00085         }
94 00086         <span class="keywordflow">else</span>
95 00087         {
96 00088                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
97 00089         }
98 00090 }
99 00091 
100 <a name="l00092"></a><a class="code" href="classServer.html#a9">00092</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)
101 00093 {
102 00094         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
103 00095 }
104 00096 
105 <a name="l00097"></a><a class="code" href="classServer.html#a10">00097</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)
106 00098 {
107 00099         <span class="keywordflow">if</span> (IncludeSender)
108 00100         {
109 00101                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
110 00102         }
111 00103         <span class="keywordflow">else</span>
112 00104         {
113 00105                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
114 00106         }
115 00107 }
116 00108 
117 <a name="l00109"></a><a class="code" href="classServer.html#a11">00109</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)
118 00110 {
119 00111         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
120 00112 }
121 00113 
122 <a name="l00114"></a><a class="code" href="classServer.html#a12">00114</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">Server::IsNick</a>(string nick)
123 00115 {
124 00116         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
125 00117 }
126 00118 
127 <a name="l00119"></a><a class="code" href="classServer.html#a13">00119</a> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">Server::FindNick</a>(string nick)
128 00120 {
129 00121         <span class="keywordflow">return</span> Find(nick);
130 00122 }
131 00123 
132 <a name="l00124"></a><a class="code" href="classServer.html#a14">00124</a> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">Server::FindChannel</a>(string channel)
133 00125 {
134 00126         <span class="keywordflow">return</span> FindChan(channel.c_str());
135 00127 }
136 00128 
137 <a name="l00129"></a><a class="code" href="classServer.html#a15">00129</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)
138 00130 {
139 00131         string mode = cmode(User,Chan);
140 00132         <span class="keywordflow">return</span> mode;
141 00133 }
142 00134 
143 <a name="l00135"></a><a class="code" href="classServer.html#a16">00135</a> string <a class="code" href="classServer.html#a16">Server::GetServerName</a>()
144 00136 {
145 00137         <span class="keywordflow">return</span> getservername();
146 00138 }
147 00139 
148 <a name="l00140"></a><a class="code" href="classServer.html#a17">00140</a> string <a class="code" href="classServer.html#a17">Server::GetNetworkName</a>()
149 00141 {
150 00142         <span class="keywordflow">return</span> getnetworkname();
151 00143 }
152 00144 
153 <a name="l00145"></a><a class="code" href="classServer.html#a18">00145</a> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">Server::GetAdmin</a>()
154 00146 {
155 00147         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
156 00148 }
157 00149 
158 00150 
159 <a name="l00151"></a><a class="code" href="classConfigReader.html#a0">00151</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>()
160 00152 {
161 00153         <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
162 00154 }
163 00155 
164 00156 
165 <a name="l00157"></a><a class="code" href="classConfigReader.html#a2">00157</a> <a class="code" href="classConfigReader.html#a2">ConfigReader::~ConfigReader</a>()
166 00158 {
167 00159 }
168 00160 
169 00161 
170 <a name="l00162"></a><a class="code" href="classConfigReader.html#a1">00162</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>(string filename) : fname(filename) { };
171 00163 
172 <a name="l00164"></a><a class="code" href="classConfigReader.html#a3">00164</a> string <a class="code" href="classConfigReader.html#a3">ConfigReader::ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index)
173 00165 {
174 00166         <span class="keywordtype">char</span> val[MAXBUF];
175 00167         ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
176 00168         string s = val;
177 00169         <span class="keywordflow">return</span> s;
178 00170 }
179 00171 
180 00172 
181 <a name="l00173"></a><a class="code" href="classConfigReader.html#a4">00173</a> <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">ConfigReader::Enumerate</a>(string tag)
182 00174 {
183 00175         <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
184 00176 }
185 00177 
186 00178 
187 <a name="l00179"></a><a class="code" href="classConfigReader.html#a5">00179</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">ConfigReader::Verify</a>()
188 00180 {
189 00181         <span class="keywordflow">return</span> <span class="keyword">true</span>;
190 00182 }
191 00183 
192 00184 
193 <a name="l00185"></a><a class="code" href="classFileReader.html#a1">00185</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>(string filename)
194 00186 {
195 00187         <a class="code" href="modules_8h.html#a6">file_cache</a> c;
196 00188         readfile(c,filename.c_str());
197 00189         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
198 00190 }
199 00191 
200 <a name="l00192"></a><a class="code" href="classFileReader.html#a0">00192</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>()
201 00193 {
202 00194 }
203 00195 
204 <a name="l00196"></a><a class="code" href="classFileReader.html#a3">00196</a> <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">FileReader::LoadFile</a>(string filename)
205 00197 {
206 00198         <a class="code" href="modules_8h.html#a6">file_cache</a> c;
207 00199         readfile(c,filename.c_str());
208 00200         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
209 00201 }
210 00202 
211 <a name="l00203"></a><a class="code" href="classFileReader.html#a2">00203</a> <a class="code" href="classFileReader.html#a2">FileReader::~FileReader</a>()
212 00204 {
213 00205 }
214 00206 
215 <a name="l00207"></a><a class="code" href="classFileReader.html#a4">00207</a> string <a class="code" href="classFileReader.html#a4">FileReader::GetLine</a>(<span class="keywordtype">int</span> x)
216 00208 {
217 00209         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
218 00210                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
219 00211         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
220 00212 }
221 00213 
222 <a name="l00214"></a><a class="code" href="classFileReader.html#a5">00214</a> <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileReader::FileSize</a>()
223 00215 {
224 00216         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
225 00217 }
226 00218 
227 00219 
228 00220 vector&lt;Module*&gt; <a class="code" href="modules_8cpp.html#a1">modules</a>(255);
229 00221 vector&lt;ircd_module*&gt; <a class="code" href="modules_8cpp.html#a2">factory</a>(255);
230 00222 
231 <a name="l00223"></a><a class="code" href="modules_8cpp.html#a0">00223</a> <span class="keywordtype">int</span> <a class="code" href="modules_8cpp.html#a0">MODCOUNT</a>  = -1;
232 00224 
233 00225 
234 </pre></div><hr><address style="align: right;"><small>Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by
235 <a href="http://www.doxygen.org/index.html">
236 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
237 width=110 height=53></a>1.3-rc2 </small></address>
238 </body>
239 </html>