]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/modules_8cpp-source.html
c1b6188992e03a8dcc0aa4a91ba1ea36cf9f8bc1
[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-rc3 -->
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 00036 <span class="keywordtype">void</span> Module::OnServerRaw(string &amp;raw, <span class="keywordtype">bool</span> inbound) { }
45 <a name="l00037"></a><a class="code" href="classModule.html#a2">00037</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); }
46 00038 
47 00039 <span class="comment">// server is a wrapper class that provides methods to all of the C-style</span>
48 00040 <span class="comment">// exports in the core</span>
49 00041 <span class="comment">//</span>
50 00042 
51 <a name="l00043"></a><a class="code" href="classServer.html#a0">00043</a> <a class="code" href="classServer.html#a0">Server::Server</a>()
52 00044 {
53 00045 }
54 00046 
55 <a name="l00047"></a><a class="code" href="classServer.html#a1">00047</a> <a class="code" href="classServer.html#a1">Server::~Server</a>()
56 00048 {
57 00049 }
58 00050 
59 <a name="l00051"></a><a class="code" href="classServer.html#a2">00051</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">Server::SendOpers</a>(string s)
60 00052 {
61 00053         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
62 00054 }
63 00055 
64 <a name="l00056"></a><a class="code" href="classServer.html#a3">00056</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Server::Log</a>(<span class="keywordtype">int</span> level, string s)
65 00057 {
66 00058         log(level,<span class="stringliteral">"%s"</span>,s.c_str());
67 00059 }
68 00060 
69 <a name="l00061"></a><a class="code" href="classServer.html#a4">00061</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Server::Send</a>(<span class="keywordtype">int</span> Socket, string s)
70 00062 {
71 00063         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
72 00064 }
73 00065 
74 <a name="l00066"></a><a class="code" href="classServer.html#a5">00066</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">Server::SendServ</a>(<span class="keywordtype">int</span> Socket, string s)
75 00067 {
76 00068         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
77 00069 }
78 00070 
79 <a name="l00071"></a><a class="code" href="classServer.html#a6">00071</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)
80 00072 {
81 00073         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
82 00074 }
83 00075 
84 <a name="l00076"></a><a class="code" href="classServer.html#a7">00076</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)
85 00077 {
86 00078         WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
87 00079 }
88 00080 
89 <a name="l00081"></a><a class="code" href="classServer.html#a8">00081</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)
90 00082 {
91 00083         <span class="keywordflow">if</span> (IncludeSender)
92 00084         {
93 00085                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
94 00086         }
95 00087         <span class="keywordflow">else</span>
96 00088         {
97 00089                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
98 00090         }
99 00091 }
100 00092 
101 <a name="l00093"></a><a class="code" href="classServer.html#a9">00093</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)
102 00094 {
103 00095         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
104 00096 }
105 00097 
106 <a name="l00098"></a><a class="code" href="classServer.html#a10">00098</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)
107 00099 {
108 00100         <span class="keywordflow">if</span> (IncludeSender)
109 00101         {
110 00102                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
111 00103         }
112 00104         <span class="keywordflow">else</span>
113 00105         {
114 00106                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
115 00107         }
116 00108 }
117 00109 
118 <a name="l00110"></a><a class="code" href="classServer.html#a11">00110</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)
119 00111 {
120 00112         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
121 00113 }
122 00114 
123 <a name="l00115"></a><a class="code" href="classServer.html#a12">00115</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">Server::IsNick</a>(string nick)
124 00116 {
125 00117         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
126 00118 }
127 00119 
128 <a name="l00120"></a><a class="code" href="classServer.html#a13">00120</a> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">Server::FindNick</a>(string nick)
129 00121 {
130 00122         <span class="keywordflow">return</span> Find(nick);
131 00123 }
132 00124 
133 <a name="l00125"></a><a class="code" href="classServer.html#a14">00125</a> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">Server::FindChannel</a>(string channel)
134 00126 {
135 00127         <span class="keywordflow">return</span> FindChan(channel.c_str());
136 00128 }
137 00129 
138 <a name="l00130"></a><a class="code" href="classServer.html#a15">00130</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)
139 00131 {
140 00132         string mode = cmode(User,Chan);
141 00133         <span class="keywordflow">return</span> mode;
142 00134 }
143 00135 
144 <a name="l00136"></a><a class="code" href="classServer.html#a16">00136</a> string <a class="code" href="classServer.html#a16">Server::GetServerName</a>()
145 00137 {
146 00138         <span class="keywordflow">return</span> getservername();
147 00139 }
148 00140 
149 <a name="l00141"></a><a class="code" href="classServer.html#a17">00141</a> string <a class="code" href="classServer.html#a17">Server::GetNetworkName</a>()
150 00142 {
151 00143         <span class="keywordflow">return</span> getnetworkname();
152 00144 }
153 00145 
154 <a name="l00146"></a><a class="code" href="classServer.html#a18">00146</a> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">Server::GetAdmin</a>()
155 00147 {
156 00148         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
157 00149 }
158 00150 
159 00151 
160 <a name="l00152"></a><a class="code" href="classConfigReader.html#a0">00152</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>()
161 00153 {
162 00154         <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
163 00155 }
164 00156 
165 00157 
166 <a name="l00158"></a><a class="code" href="classConfigReader.html#a2">00158</a> <a class="code" href="classConfigReader.html#a2">ConfigReader::~ConfigReader</a>()
167 00159 {
168 00160 }
169 00161 
170 00162 
171 <a name="l00163"></a><a class="code" href="classConfigReader.html#a1">00163</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>(string filename) : fname(filename) { };
172 00164 
173 <a name="l00165"></a><a class="code" href="classConfigReader.html#a3">00165</a> string <a class="code" href="classConfigReader.html#a3">ConfigReader::ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index)
174 00166 {
175 00167         <span class="keywordtype">char</span> val[MAXBUF];
176 00168         ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
177 00169         string s = val;
178 00170         <span class="keywordflow">return</span> s;
179 00171 }
180 00172 
181 00173 
182 <a name="l00174"></a><a class="code" href="classConfigReader.html#a4">00174</a> <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">ConfigReader::Enumerate</a>(string tag)
183 00175 {
184 00176         <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
185 00177 }
186 00178 
187 00179 
188 <a name="l00180"></a><a class="code" href="classConfigReader.html#a5">00180</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">ConfigReader::Verify</a>()
189 00181 {
190 00182         <span class="keywordflow">return</span> <span class="keyword">true</span>;
191 00183 }
192 00184 
193 00185 
194 <a name="l00186"></a><a class="code" href="classFileReader.html#a1">00186</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>(string filename)
195 00187 {
196 00188         <a class="code" href="modules_8h.html#a6">file_cache</a> c;
197 00189         readfile(c,filename.c_str());
198 00190         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
199 00191 }
200 00192 
201 <a name="l00193"></a><a class="code" href="classFileReader.html#a0">00193</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>()
202 00194 {
203 00195 }
204 00196 
205 <a name="l00197"></a><a class="code" href="classFileReader.html#a3">00197</a> <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">FileReader::LoadFile</a>(string filename)
206 00198 {
207 00199         <a class="code" href="modules_8h.html#a6">file_cache</a> c;
208 00200         readfile(c,filename.c_str());
209 00201         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
210 00202 }
211 00203 
212 <a name="l00204"></a><a class="code" href="classFileReader.html#a2">00204</a> <a class="code" href="classFileReader.html#a2">FileReader::~FileReader</a>()
213 00205 {
214 00206 }
215 00207 
216 <a name="l00208"></a><a class="code" href="classFileReader.html#a4">00208</a> string <a class="code" href="classFileReader.html#a4">FileReader::GetLine</a>(<span class="keywordtype">int</span> x)
217 00209 {
218 00210         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
219 00211                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
220 00212         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
221 00213 }
222 00214 
223 <a name="l00215"></a><a class="code" href="classFileReader.html#a5">00215</a> <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileReader::FileSize</a>()
224 00216 {
225 00217         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
226 00218 }
227 00219 
228 00220 
229 00221 vector&lt;Module*&gt; <a class="code" href="modules_8cpp.html#a1">modules</a>(255);
230 00222 vector&lt;ircd_module*&gt; <a class="code" href="modules_8cpp.html#a2">factory</a>(255);
231 00223 
232 <a name="l00224"></a><a class="code" href="modules_8cpp.html#a0">00224</a> <span class="keywordtype">int</span> <a class="code" href="modules_8cpp.html#a0">MODCOUNT</a>  = -1;
233 00225 
234 00226 
235 </pre></div><hr><address style="align: right;"><small>Generated on Sun Mar 30 13:27:58 2003 for InspIRCd by
236 <a href="http://www.doxygen.org/index.html">
237 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
238 width=110 height=53></a>1.3-rc3 </small></address>
239 </body>
240 </html>