1 .TH "modules.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*-
9 \fC#include 'dynamic.h'\fP
11 \fC#include 'base.h'\fP
13 \fC#include 'ctables.h'\fP
15 \fC#include <string>\fP
17 \fC#include <deque>\fP
19 \fC#include <sstream>\fP
26 .RI "class \fBAdmin\fP"
28 .RI "\fIHolds /ADMIN data This class contains the admin details of the local server. \fP"
30 .RI "class \fBConfigReader\fP"
32 .RI "\fIAllows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. \fP"
34 .RI "class \fBFileReader\fP"
36 .RI "\fICaches a text file into memory and can be used to retrieve lines from it. \fP"
38 .RI "class \fBModule\fP"
40 .RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules. \fP"
42 .RI "class \fBModuleFactory\fP"
44 .RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. \fP"
46 .RI "class \fBServer\fP"
48 .RI "\fIAllows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. \fP"
50 .RI "class \fBVersion\fP"
52 .RI "\fIHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. \fP"
58 .RI "#define \fBDEBUG\fP 10"
61 .RI "#define \fBVERBOSE\fP 20"
64 .RI "#define \fBDEFAULT\fP 30"
67 .RI "#define \fBSPARSE\fP 40"
70 .RI "#define \fBNONE\fP 50"
73 .RI "#define \fBMT_CHANNEL\fP 1"
76 .RI "#define \fBMT_CLIENT\fP 2"
79 .RI "#define \fBMT_SERVER\fP 3"
82 .RI "#define \fBACR_DEFAULT\fP 0"
85 .RI "#define \fBACR_DENY\fP 1"
88 .RI "#define \fBACR_ALLOW\fP 2"
91 .RI "#define \fBAC_KICK\fP 0"
94 .RI "#define \fBAC_DEOP\fP 1"
97 .RI "#define \fBAC_OP\fP 2"
100 .RI "#define \fBAC_VOICE\fP 3"
103 .RI "#define \fBAC_DEVOICE\fP 4"
106 .RI "#define \fBAC_HALFOP\fP 5"
109 .RI "#define \fBAC_DEHALFOP\fP 6"
112 .RI "#define \fBAC_INVITE\fP 7"
115 .RI "#define \fBAC_GENERAL_MODE\fP 8"
118 .RI "#define \fBVF_STATIC\fP 1"
121 .RI "#define \fBVF_VENDOR\fP 2"
124 .RI "#define \fBVF_SERVICEPROVIDER\fP 4"
127 .RI "#define \fBVF_COMMON\fP 8"
130 .RI "#define \fBFOREACH_MOD\fP for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->"
133 .RI "#define \fBFOREACH_RESULT\fP(x)"
136 .RI "#define \fBFD_MAGIC_NUMBER\fP -42"
139 .RI "#define \fBCONF_NOT_A_NUMBER\fP 0x000010"
142 .RI "#define \fBCONF_NOT_UNSIGNED\fP 0x000080"
145 .RI "#define \fBCONF_VALUE_NOT_FOUND\fP 0x000100"
148 .RI "#define \fBCONF_FILE_NOT_FOUND\fP 0x000200"
155 .RI "typedef std::deque< std::string > \fBfile_cache\fP"
157 .RI "\fILow level definition of a \fBFileReader\fP classes file cache area. \fP"
159 .RI "typedef \fBfile_cache\fP \fBstring_list\fP"
162 .RI "typedef std::deque< \fBuserrec\fP * > \fBchanuserlist\fP"
164 .RI "\fIHolds a list of users in a channel. \fP"
166 .RI "typedef DLLFactory< \fBModuleFactory\fP > \fBircd_module\fP"
173 .RI "void \fBcreatecommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)"
176 .RI "void \fBserver_mode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
179 .SH "Define Documentation"
181 .SS "#define AC_DEHALFOP 6"
183 Definition at line 47 of file modules.h.
184 .SS "#define AC_DEOP 1"
186 Definition at line 42 of file modules.h.
187 .SS "#define AC_DEVOICE 4"
189 Definition at line 45 of file modules.h.
190 .SS "#define AC_GENERAL_MODE 8"
192 Definition at line 49 of file modules.h.
193 .SS "#define AC_HALFOP 5"
195 Definition at line 46 of file modules.h.
196 .SS "#define AC_INVITE 7"
198 Definition at line 48 of file modules.h.
199 .SS "#define AC_KICK 0"
201 Definition at line 41 of file modules.h.
202 .SS "#define AC_OP 2"
204 Definition at line 43 of file modules.h.
205 .SS "#define AC_VOICE 3"
207 Definition at line 44 of file modules.h.
208 .SS "#define ACR_ALLOW 2"
210 Definition at line 39 of file modules.h.
211 .SS "#define ACR_DEFAULT 0"
213 Definition at line 37 of file modules.h.
215 Referenced by Module::OnAccessCheck().
216 .SS "#define ACR_DENY 1"
218 Definition at line 38 of file modules.h.
219 .SS "#define CONF_FILE_NOT_FOUND 0x000200"
221 Definition at line 782 of file modules.h.
223 Referenced by ConfigReader::ConfigReader().
224 .SS "#define CONF_NOT_A_NUMBER 0x000010"
226 Definition at line 779 of file modules.h.
228 Referenced by ConfigReader::ReadInteger().
229 .SS "#define CONF_NOT_UNSIGNED 0x000080"
231 Definition at line 780 of file modules.h.
233 Referenced by ConfigReader::ReadInteger().
234 .SS "#define CONF_VALUE_NOT_FOUND 0x000100"
236 Definition at line 781 of file modules.h.
238 Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
239 .SS "#define DEBUG 10"
241 Definition at line 23 of file modules.h.
243 Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam().
244 .SS "#define DEFAULT 30"
246 Definition at line 25 of file modules.h.
247 .SS "#define FD_MAGIC_NUMBER -42"
249 Definition at line 99 of file modules.h.
251 Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
252 .SS "#define FOREACH_MOD for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->"
254 Definition at line 79 of file modules.h.
255 .SS "#define FOREACH_RESULT(x)"
259 for (int i = 0; i <= MODCOUNT; i++) { \
260 int res = modules[i]->x ; \
269 Definition at line 87 of file modules.h.
270 .SS "#define MT_CHANNEL 1"
272 Definition at line 31 of file modules.h.
274 Referenced by Server::AddExtendedListMode(), and ModeMakeList().
275 .SS "#define MT_CLIENT 2"
277 Definition at line 32 of file modules.h.
279 Referenced by Server::AddExtendedMode().
280 .SS "#define MT_SERVER 3"
282 Definition at line 33 of file modules.h.
284 Referenced by Server::AddExtendedMode().
285 .SS "#define NONE 50"
287 Definition at line 27 of file modules.h.
288 .SS "#define SPARSE 40"
290 Definition at line 26 of file modules.h.
291 .SS "#define VERBOSE 20"
293 Definition at line 24 of file modules.h.
294 .SS "#define VF_COMMON 8"
296 Definition at line 56 of file modules.h.
297 .SS "#define VF_SERVICEPROVIDER 4"
299 Definition at line 55 of file modules.h.
300 .SS "#define VF_STATIC 1"
302 Definition at line 53 of file modules.h.
303 .SS "#define VF_VENDOR 2"
305 Definition at line 54 of file modules.h.
307 Referenced by Module::GetVersion().
308 .SH "Typedef Documentation"
310 .SS "typedef std::deque<\fBuserrec\fP*> \fBchanuserlist\fP"
312 Holds a list of users in a channel. Definition at line 72 of file modules.h.
314 Referenced by Server::GetUsers().
315 .SS "typedef std::deque<std::string> \fBfile_cache\fP"
317 Low level definition of a \fBFileReader\fP classes file cache area. Definition at line 67 of file modules.h.
319 Referenced by FileReader::FileReader(), and FileReader::LoadFile().
320 .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP"
322 Definition at line 947 of file modules.h.
323 .SS "typedef \fBfile_cache\fP \fBstring_list\fP"
325 Definition at line 68 of file modules.h.
327 Referenced by Module::OnChannelSync(), and Module::OnUserSync().
328 .SH "Function Documentation"
330 .SS "void createcommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)"
332 Referenced by Server::AddCommand().
333 .SS "void server_mode (char ** parameters, int pcnt, \fBuserrec\fP * user)"
335 Referenced by Server::SendMode().
338 Generated automatically by Doxygen for InspIRCd from the source code.