]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/modules_8h-source.html
documentation update for updated return values of OnUserPreJoin
[user/henk/code/inspircd.git] / docs / module-doc / modules_8h-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.h Source File</title>
4 <link href="inspircd.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="namespaces.html">Namespace List</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.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"></span>
12 00004 <span class="comment"></span>
13 00005 <span class="comment">*/</span>
14 00006 
15 00007 
16 00008 <span class="preprocessor">#ifndef __PLUGIN_H</span>
17 00009 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
18 00010 <span class="preprocessor"></span>
19 00011 <span class="comment">// log levels</span>
20 00012 
21 <a name="l00013"></a><a class="code" href="modules_8h.html#a0">00013</a> <span class="preprocessor">#define DEBUG 10</span>
22 <a name="l00014"></a><a class="code" href="modules_8h.html#a1">00014</a> <span class="preprocessor"></span><span class="preprocessor">#define VERBOSE 20</span>
23 <a name="l00015"></a><a class="code" href="modules_8h.html#a2">00015</a> <span class="preprocessor"></span><span class="preprocessor">#define DEFAULT 30</span>
24 <a name="l00016"></a><a class="code" href="modules_8h.html#a3">00016</a> <span class="preprocessor"></span><span class="preprocessor">#define SPARSE 40</span>
25 <a name="l00017"></a><a class="code" href="modules_8h.html#a4">00017</a> <span class="preprocessor"></span><span class="preprocessor">#define NONE 50</span>
26 00018 <span class="preprocessor"></span>
27 00019 <span class="comment">// used with OnExtendedMode() method of modules</span>
28 00020 
29 <a name="l00021"></a><a class="code" href="modules_8h.html#a5">00021</a> <span class="preprocessor">#define MT_CHANNEL 1</span>
30 <a name="l00022"></a><a class="code" href="modules_8h.html#a6">00022</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_CLIENT 2</span>
31 <a name="l00023"></a><a class="code" href="modules_8h.html#a7">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_SERVER 3</span>
32 00024 <span class="preprocessor"></span>
33 00025 <span class="comment">// used with OnAccessCheck() method of modules</span>
34 00026 
35 <a name="l00027"></a><a class="code" href="modules_8h.html#a8">00027</a> <span class="preprocessor">#define ACR_DEFAULT 0           // Do default action (act as if the module isnt even loaded)</span>
36 <a name="l00028"></a><a class="code" href="modules_8h.html#a9">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define ACR_DENY 1              // deny the action</span>
37 <a name="l00029"></a><a class="code" href="modules_8h.html#a10">00029</a> <span class="preprocessor"></span><span class="preprocessor">#define ACR_ALLOW 2             // allow the action</span>
38 00030 <span class="preprocessor"></span>
39 <a name="l00031"></a><a class="code" href="modules_8h.html#a11">00031</a> <span class="preprocessor">#define AC_KICK 0               // a user is being kicked</span>
40 <a name="l00032"></a><a class="code" href="modules_8h.html#a12">00032</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_DEOP 1               // a user is being deopped</span>
41 <a name="l00033"></a><a class="code" href="modules_8h.html#a13">00033</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_OP 2                 // a user is being opped</span>
42 <a name="l00034"></a><a class="code" href="modules_8h.html#a14">00034</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_VOICE 3              // a user is being voiced</span>
43 <a name="l00035"></a><a class="code" href="modules_8h.html#a15">00035</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_DEVOICE 4            // a user is being devoiced</span>
44 <a name="l00036"></a><a class="code" href="modules_8h.html#a16">00036</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_HALFOP 5             // a user is being halfopped</span>
45 <a name="l00037"></a><a class="code" href="modules_8h.html#a17">00037</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_DEHALFOP 6           // a user is being dehalfopped</span>
46 <a name="l00038"></a><a class="code" href="modules_8h.html#a18">00038</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_INVITE 7             // a user is being invited</span>
47 <a name="l00039"></a><a class="code" href="modules_8h.html#a19">00039</a> <span class="preprocessor"></span><span class="preprocessor">#define AC_GENERAL_MODE 8       // a user channel mode is being changed</span>
48 00040 <span class="preprocessor"></span>
49 00041 <span class="preprocessor">#include "dynamic.h"</span>
50 00042 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
51 00043 <span class="preprocessor">#include "<a class="code" href="ctables_8h.html">ctables.h</a>"</span>
52 00044 <span class="preprocessor">#include &lt;string&gt;</span>
53 00045 <span class="preprocessor">#include &lt;deque&gt;</span>
54 00046 <span class="preprocessor">#include &lt;sstream&gt;</span>
55 00047 
56 <a name="l00050"></a><a class="code" href="modules_8h.html#a26">00050</a> <span class="keyword">typedef</span> std::deque&lt;std::string&gt; <a class="code" href="modules_8h.html#a26">file_cache</a>;
57 <a name="l00051"></a><a class="code" href="modules_8h.html#a27">00051</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a26">file_cache</a> <a class="code" href="modules_8h.html#a27">string_list</a>;
58 00052 
59 <a name="l00055"></a><a class="code" href="modules_8h.html#a28">00055</a> <span class="keyword">typedef</span> std::deque&lt;userrec*&gt; <a class="code" href="modules_8h.html#a28">chanuserlist</a>;
60 00056 
61 00057 
62 00058 <span class="comment">// This #define allows us to call a method in all</span>
63 00059 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
64 00060 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
65 00061 
66 <a name="l00062"></a><a class="code" href="modules_8h.html#a20">00062</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
67 00063 <span class="preprocessor"></span>
68 00064 <span class="comment">// This define is similar to the one above but returns a result in MOD_RESULT.</span>
69 00065 <span class="comment">// The first module to return a nonzero result is the value to be accepted,</span>
70 00066 <span class="comment">// and any modules after are ignored.</span>
71 00067 
72 00068 <span class="comment">// *********************************************************************************************</span>
73 00069 
74 <a name="l00070"></a><a class="code" href="modules_8h.html#a21">00070</a> <span class="preprocessor">#define FOREACH_RESULT(x) { MOD_RESULT = 0; \</span>
75 00071 <span class="preprocessor">                        for (int i = 0; i &lt;= MODCOUNT; i++) { \</span>
76 00072 <span class="preprocessor">                        int res = modules[i]-&gt;x ; \</span>
77 00073 <span class="preprocessor">                        if (res != 0) { \</span>
78 00074 <span class="preprocessor">                                MOD_RESULT = res; \</span>
79 00075 <span class="preprocessor">                                break; \</span>
80 00076 <span class="preprocessor">                        } \</span>
81 00077 <span class="preprocessor">                } \</span>
82 00078 <span class="preprocessor">        } </span>
83 00079 <span class="preprocessor"></span>   
84 00080 <span class="comment">// *********************************************************************************************</span>
85 00081 
86 00082 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a30">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
87 00083 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a31">server_mode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
88 00084 
89 00085 <span class="comment">// class Version holds the version information of a Module, returned</span>
90 00086 <span class="comment">// by Module::GetVersion (thanks RD)</span>
91 00087 
92 <a name="l00092"></a><a class="code" href="classVersion.html">00092</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>
93 00093 {
94 00094  <span class="keyword">public</span>:
95 <a name="l00095"></a><a class="code" href="classVersion.html#m2">00095</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>;
96 00096          <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);
97 00097 };
98 00098 
99 <a name="l00104"></a><a class="code" href="classAdmin.html">00104</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>
100 00105 {
101 00106  <span class="keyword">public</span>:
102 <a name="l00107"></a><a class="code" href="classAdmin.html#m2">00107</a>          <span class="keyword">const</span> std::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>;
103 00108          <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
104 00109 };
105 00110 
106 <a name="l00116"></a><a class="code" href="classModule.html">00116</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>
107 00117 {
108 00118  <span class="keyword">public</span>:
109 00119 
110 00123         <a class="code" href="classModule.html#a0">Module</a>();
111 00124 
112 00128         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
113 00129 
114 00134         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
115 00135 
116 00139         <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);
117 00140 
118 00144         <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);
119 00145 
120 00150         <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);
121 00151 
122 00156         <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);
123 00157 
124 00164         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a7">OnPacketTransmit</a>(<span class="keywordtype">char</span> *p);
125 00165 
126 00173         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a8">OnPacketReceive</a>(<span class="keywordtype">char</span> *p);
127 00174 
128 00180         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
129 00181 
130 00190         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">OnServerRaw</a>(std::string &amp;raw, <span class="keywordtype">bool</span> inbound, <a class="code" href="classuserrec.html">userrec</a>* user);
131 00191 
132 00201         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a11">OnExtendedMode</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <span class="keywordtype">void</span>* target, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, string_list &amp;params);
133 00202         
134 00216         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a12">OnUserPreJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keyword">const</span> <span class="keywordtype">char</span>* cname);
135 00217         
136 00218         
137 00223         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a13">OnOper</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
138 00224         
139 00233         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a14">OnInfo</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
140 00234         
141 00239         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a15">OnWhois</a>(<a class="code" href="classuserrec.html">userrec</a>* source, <a class="code" href="classuserrec.html">userrec</a>* dest);
142 00240         
143 00249         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a16">OnUserPreMessage</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string text);
144 00250 
145 00259         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a17">OnUserPreNotice</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string text);
146 00260         
147 00268         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a18">OnUserPreNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string newnick);
148 00269         
149 00292         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a19">OnAccessCheck</a>(<a class="code" href="classuserrec.html">userrec</a>* source,<a class="code" href="classuserrec.html">userrec</a>* dest,<a class="code" href="classchanrec.html">chanrec</a>* channel,<span class="keywordtype">int</span> access_type);
150 00298         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a27">string_list</a> <a class="code" href="classModule.html#a20">OnUserSync</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
151 00299 
152 00305         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a27">string_list</a> <a class="code" href="classModule.html#a21">OnChannelSync</a>(<a class="code" href="classchanrec.html">chanrec</a>* chan);
153 00306 };
154 00307 
155 00308 
156 <a name="l00314"></a><a class="code" href="classServer.html">00314</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>
157 00315 {
158 00316  <span class="keyword">public</span>:
159 00320         <a class="code" href="classServer.html#a0">Server</a>();
160 00324         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
161 00325 
162 00329         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
163 00334         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Log</a>(<span class="keywordtype">int</span> level, std::string s);
164 00339         <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, std::string s);
165 00344         <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, std::string s);
166 00349         <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, std::string s);
167 00364         <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, std::string s);
168 00371         <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, std::string s,<span class="keywordtype">bool</span> IncludeSender);
169 00376         <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);
170 00384         <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, std::string text,<span class="keywordtype">bool</span> IncludeSender);
171 00389         <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, std::string text);
172 00390 
173 00394         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
174 00398         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classServer.html#a13">CountUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* c);
175 00402         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a14">FindNick</a>(std::string nick);
176 00406         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a15">FindChannel</a>(std::string channel);
177 00411         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
178 00415         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a17">IsOnChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
179 00418         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a18">GetServerName</a>();
180 00421         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a19">GetNetworkName</a>();
181 00427         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a20">GetAdmin</a>();
182 00446         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a21">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> requires_oper, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off);
183 00447 
184 00469         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a22">AddExtendedListMode</a>(<span class="keywordtype">char</span> modechar);
185 00470         
186 00485         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a23">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
187 00486          
188 00508         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a24">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
189 00509         
190 00522         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a25">SendToModeMask</a>(std::string modes, <span class="keywordtype">int</span> flags, std::string text);
191 00523 
192 00529         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a26">JoinUserToChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string key);
193 00530         
194 00536         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a27">PartUserFromChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string reason);
195 00537         
196 00543         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a28">ChangeUserNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string nickname);
197 00544         
198 00555         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a29">QuitUser</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string reason);
199 00556         
200 00561         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a30">MatchText</a>(std::string sliteral, std::string spattern);
201 00562         
202 00574         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a31">CallCommandHandler</a>(std::string commandname, <span class="keywordtype">char</span>** parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a>* user);
203 00575         
204 00581         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a32">ChangeHost</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string host);
205 00582         
206 00588         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a33">ChangeGECOS</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string gecos);
207 00589         
208 00598         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a34">IsUlined</a>(std::string server);
209 00599         
210 00603         <span class="keyword">virtual</span> <a class="code" href="modules_8h.html#a28">chanuserlist</a> <a class="code" href="classServer.html#a35">GetUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* chan);
211 00604 
212 00605 };
213 00606 
214 <a name="l00607"></a><a class="code" href="modules_8h.html#a22">00607</a> <span class="preprocessor">#define CONF_NOT_A_NUMBER       0x000010</span>
215 <a name="l00608"></a><a class="code" href="modules_8h.html#a23">00608</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_NOT_UNSIGNED       0x000080</span>
216 <a name="l00609"></a><a class="code" href="modules_8h.html#a24">00609</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_VALUE_NOT_FOUND    0x000100</span>
217 <a name="l00610"></a><a class="code" href="modules_8h.html#a25">00610</a> <span class="preprocessor"></span><span class="preprocessor">#define CONF_FILE_NOT_FOUND     0x000200</span>
218 00611 <span class="preprocessor"></span>
219 <a name="l00618"></a><a class="code" href="classConfigReader.html">00618</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>
220 00619 {
221 00620   <span class="keyword">protected</span>:
222 <a name="l00626"></a><a class="code" href="classConfigReader.html#n0">00626</a>         std::stringstream *<a class="code" href="classConfigReader.html#n0">cache</a>;
223 <a name="l00629"></a><a class="code" href="classConfigReader.html#n1">00629</a>         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#n1">readerror</a>;
224 <a name="l00630"></a><a class="code" href="classConfigReader.html#n2">00630</a>         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#n2">error</a>;
225 00631         
226 00632   <span class="keyword">public</span>:
227 00637         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
228 00641 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(std::string filename);     <span class="comment">// read a module-specific config</span>
229 00645 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
230 00650         std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
231 00656         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a4">ReadFlag</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
232 00665         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#a5">ReadInteger</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> needs_unsigned);
233 00670         <span class="keywordtype">long</span> <a class="code" href="classConfigReader.html#a6">GetError</a>();
234 00677         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a7">Enumerate</a>(std::string tag);
235 00682         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a8">Verify</a>();
236 00683 
237 00689         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a9">EnumerateValues</a>(std::string tag, <span class="keywordtype">int</span> index);
238 00690 };
239 00691 
240 00692 
241 00693 
242 <a name="l00699"></a><a class="code" href="classFileReader.html">00699</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>
243 00700 {
244 <a name="l00701"></a><a class="code" href="classFileReader.html#o0">00701</a>  <a class="code" href="modules_8h.html#a26">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
245 00702  <span class="keyword">public</span>:
246 00707          <a class="code" href="classFileReader.html#a0">FileReader</a>();
247 00708 
248 00714          <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
249 00715 
250 00719          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
251 00720 
252 00726          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
253 00727 
254 00731          <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
255 00732          
256 00737          std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
257 00738 
258 00744          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
259 00745 };
260 00746 
261 00747 
262 <a name="l00754"></a><a class="code" href="classModuleFactory.html">00754</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>
263 00755 {
264 00756  <span class="keyword">public</span>:
265 <a name="l00757"></a><a class="code" href="classModuleFactory.html#a0">00757</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
266 <a name="l00758"></a><a class="code" href="classModuleFactory.html#a1">00758</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
267 00763         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
268 00764 };
269 00765 
270 00766 
271 <a name="l00767"></a><a class="code" href="modules_8h.html#a29">00767</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a29">ircd_module</a>;
272 00768 
273 00769 <span class="preprocessor">#endif</span>
274 </pre></div><hr><address style="align: right;"><small>Generated on Sun May 2 00:09:18 2004 for InspIRCd by
275 <a href="http://www.doxygen.org/index.html">
276 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
277 width=110 height=53></a>1.3-rc3 </small></address>
278 </body>
279 </html>