From 59a2c6c2d96a4557cd885fefcbce97f490962692 Mon Sep 17 00:00:00 2001
From: brain
Date: Tue, 6 Apr 2004 20:16:43 +0000
Subject: Updated docs
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@411 e03df62e-2008-0410-955e-edbf42e46eb7
---
docs/module-doc/modules_8cpp-source.html | 516 ++++++++++++++++---------------
1 file changed, 259 insertions(+), 257 deletions(-)
(limited to 'docs/module-doc/modules_8cpp-source.html')
diff --git a/docs/module-doc/modules_8cpp-source.html b/docs/module-doc/modules_8cpp-source.html
index 81e149e10..a6398c94a 100644
--- a/docs/module-doc/modules_8cpp-source.html
+++ b/docs/module-doc/modules_8cpp-source.html
@@ -127,266 +127,268 @@
00119 Version Module::GetVersion() { return Version(1,0,0,0); }
00120 void Module::OnOper(userrec* user) { };
00121 void Module::OnInfo(userrec* user) { };
-00122 void Module::OnWhois(userrec* source, userrec* dest) { };
-00123
-00124
-00125
-00126
-00127
-00128 Server::Server()
-00129 {
-00130 }
-00131
-00132 Server::~Server()
-00133 {
-00134 }
-00135
-00136 void Server::SendOpers(std::string s)
-00137 {
-00138 WriteOpers("%s",s.c_str());
-00139 }
-00140
-00141 void Server::SendToModeMask(std::string modes, int flags, std::string text)
-00142 {
-00143 WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00144 }
-00145
-00146 chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key)
-00147 {
-00148 return add_channel(user,cname.c_str(),key.c_str());
-00149 }
-00150
-00151 chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason)
-00152 {
-00153 return del_channel(user,cname.c_str(),reason.c_str());
-00154 }
-00155
-00156 void Server::ChangeUserNick(userrec* user, std::string nickname)
-00157 {
-00158 force_nickchange(user,nickname.c_str());
-00159 }
-00160
-00161 void Server::QuitUser(userrec* user, std::string reason)
-00162 {
-00163 kill_link(user,reason.c_str());
-00164 }
-00165
-00166
-00167 void Server::Log(int level, std::string s)
-00168 {
-00169 log(level,"%s",s.c_str());
-00170 }
-00171
-00172 void Server::AddCommand(char* cmd, handlerfunc f, char flags, int minparams)
-00173 {
-00174 createcommand(cmd,f,flags,minparams);
-00175 }
-00176
-00177 void Server::SendMode(char **parameters, int pcnt, userrec *user)
-00178 {
-00179 server_mode(parameters,pcnt,user);
-00180 }
-00181
-00182 void Server::Send(int Socket, std::string s)
-00183 {
-00184 Write(Socket,"%s",s.c_str());
-00185 }
-00186
-00187 void Server::SendServ(int Socket, std::string s)
-00188 {
-00189 WriteServ(Socket,"%s",s.c_str());
-00190 }
-00191
-00192 void Server::SendFrom(int Socket, userrec* User, std::string s)
-00193 {
-00194 WriteFrom(Socket,User,"%s",s.c_str());
-00195 }
-00196
-00197 void Server::SendTo(userrec* Source, userrec* Dest, std::string s)
-00198 {
-00199 WriteTo(Source,Dest,"%s",s.c_str());
-00200 }
-00201
-00202 void Server::SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender)
-00203 {
-00204 if (IncludeSender)
-00205 {
-00206 WriteChannel(Channel,User,"%s",s.c_str());
-00207 }
-00208 else
-00209 {
-00210 ChanExceptSender(Channel,User,"%s",s.c_str());
-00211 }
-00212 }
-00213
-00214 bool Server::CommonChannels(userrec* u1, userrec* u2)
-00215 {
-00216 return (common_channels(u1,u2) != 0);
-00217 }
-00218
-00219 void Server::SendCommon(userrec* User, std::string text,bool IncludeSender)
-00220 {
-00221 if (IncludeSender)
-00222 {
-00223 WriteCommon(User,"%s",text.c_str());
-00224 }
-00225 else
-00226 {
-00227 WriteCommonExcept(User,"%s",text.c_str());
-00228 }
-00229 }
-00230
-00231 void Server::SendWallops(userrec* User, std::string text)
-00232 {
-00233 WriteWallOps(User,"%s",text.c_str());
-00234 }
-00235
-00236 bool Server::IsNick(std::string nick)
-00237 {
-00238 return (isnick(nick.c_str()) != 0);
-00239 }
-00240
-00241 userrec* Server::FindNick(std::string nick)
-00242 {
-00243 return Find(nick);
-00244 }
-00245
-00246 chanrec* Server::FindChannel(std::string channel)
-00247 {
-00248 return FindChan(channel.c_str());
-00249 }
-00250
-00251 std::string Server::ChanMode(userrec* User, chanrec* Chan)
-00252 {
-00253 return cmode(User,Chan);
-00254 }
-00255
-00256 std::string Server::GetServerName()
-00257 {
-00258 return getservername();
-00259 }
-00260
-00261 std::string Server::GetNetworkName()
-00262 {
-00263 return getnetworkname();
-00264 }
-00265
-00266 Admin Server::GetAdmin()
-00267 {
-00268 return Admin(getadminname(),getadminemail(),getadminnick());
-00269 }
-00270
-00271
+00122 void Module::OnWhois(userrec* source, userrec* dest) { };
+00123 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text) { return 0; };
+00124 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text) { return 0; };
+00125
+00126
+00127
+00128
+00129
+00130 Server::Server()
+00131 {
+00132 }
+00133
+00134 Server::~Server()
+00135 {
+00136 }
+00137
+00138 void Server::SendOpers(std::string s)
+00139 {
+00140 WriteOpers("%s",s.c_str());
+00141 }
+00142
+00143 void Server::SendToModeMask(std::string modes, int flags, std::string text)
+00144 {
+00145 WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00146 }
+00147
+00148 chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key)
+00149 {
+00150 return add_channel(user,cname.c_str(),key.c_str());
+00151 }
+00152
+00153 chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason)
+00154 {
+00155 return del_channel(user,cname.c_str(),reason.c_str());
+00156 }
+00157
+00158 void Server::ChangeUserNick(userrec* user, std::string nickname)
+00159 {
+00160 force_nickchange(user,nickname.c_str());
+00161 }
+00162
+00163 void Server::QuitUser(userrec* user, std::string reason)
+00164 {
+00165 kill_link(user,reason.c_str());
+00166 }
+00167
+00168
+00169 void Server::Log(int level, std::string s)
+00170 {
+00171 log(level,"%s",s.c_str());
+00172 }
+00173
+00174 void Server::AddCommand(char* cmd, handlerfunc f, char flags, int minparams)
+00175 {
+00176 createcommand(cmd,f,flags,minparams);
+00177 }
+00178
+00179 void Server::SendMode(char **parameters, int pcnt, userrec *user)
+00180 {
+00181 server_mode(parameters,pcnt,user);
+00182 }
+00183
+00184 void Server::Send(int Socket, std::string s)
+00185 {
+00186 Write(Socket,"%s",s.c_str());
+00187 }
+00188
+00189 void Server::SendServ(int Socket, std::string s)
+00190 {
+00191 WriteServ(Socket,"%s",s.c_str());
+00192 }
+00193
+00194 void Server::SendFrom(int Socket, userrec* User, std::string s)
+00195 {
+00196 WriteFrom(Socket,User,"%s",s.c_str());
+00197 }
+00198
+00199 void Server::SendTo(userrec* Source, userrec* Dest, std::string s)
+00200 {
+00201 WriteTo(Source,Dest,"%s",s.c_str());
+00202 }
+00203
+00204 void Server::SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender)
+00205 {
+00206 if (IncludeSender)
+00207 {
+00208 WriteChannel(Channel,User,"%s",s.c_str());
+00209 }
+00210 else
+00211 {
+00212 ChanExceptSender(Channel,User,"%s",s.c_str());
+00213 }
+00214 }
+00215
+00216 bool Server::CommonChannels(userrec* u1, userrec* u2)
+00217 {
+00218 return (common_channels(u1,u2) != 0);
+00219 }
+00220
+00221 void Server::SendCommon(userrec* User, std::string text,bool IncludeSender)
+00222 {
+00223 if (IncludeSender)
+00224 {
+00225 WriteCommon(User,"%s",text.c_str());
+00226 }
+00227 else
+00228 {
+00229 WriteCommonExcept(User,"%s",text.c_str());
+00230 }
+00231 }
+00232
+00233 void Server::SendWallops(userrec* User, std::string text)
+00234 {
+00235 WriteWallOps(User,"%s",text.c_str());
+00236 }
+00237
+00238 bool Server::IsNick(std::string nick)
+00239 {
+00240 return (isnick(nick.c_str()) != 0);
+00241 }
+00242
+00243 userrec* Server::FindNick(std::string nick)
+00244 {
+00245 return Find(nick);
+00246 }
+00247
+00248 chanrec* Server::FindChannel(std::string channel)
+00249 {
+00250 return FindChan(channel.c_str());
+00251 }
+00252
+00253 std::string Server::ChanMode(userrec* User, chanrec* Chan)
+00254 {
+00255 return cmode(User,Chan);
+00256 }
+00257
+00258 std::string Server::GetServerName()
+00259 {
+00260 return getservername();
+00261 }
+00262
+00263 std::string Server::GetNetworkName()
+00264 {
+00265 return getnetworkname();
+00266 }
+00267
+00268 Admin Server::GetAdmin()
+00269 {
+00270 return Admin(getadminname(),getadminemail(),getadminnick());
+00271 }
00272
-00273 bool Server::AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
-00274 {
-00275 if (type == MT_SERVER)
-00276 {
-00277 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00278 return false;
-00279 }
-00280 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00281 {
-00282 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00283 return false;
-00284 }
-00285 if ((params_when_on>1) || (params_when_off>1))
-00286 {
-00287 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00288 return false;
-00289 }
-00290 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00291 }
-00292
-00293
-00294 ConfigReader::ConfigReader()
-00295 {
-00296 fname = CONFIG_FILE;
-00297 }
-00298
-00299
-00300 ConfigReader::~ConfigReader()
-00301 {
-00302 }
-00303
-00304
-00305 ConfigReader::ConfigReader(std::string filename) : fname(filename) { };
+00273
+00274
+00275 bool Server::AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
+00276 {
+00277 if (type == MT_SERVER)
+00278 {
+00279 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00280 return false;
+00281 }
+00282 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00283 {
+00284 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00285 return false;
+00286 }
+00287 if ((params_when_on>1) || (params_when_off>1))
+00288 {
+00289 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00290 return false;
+00291 }
+00292 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00293 }
+00294
+00295
+00296 ConfigReader::ConfigReader()
+00297 {
+00298 fname = CONFIG_FILE;
+00299 }
+00300
+00301
+00302 ConfigReader::~ConfigReader()
+00303 {
+00304 }
+00305
00306
-00307 std::string ConfigReader::ReadValue(std::string tag, std::string name, int index)
-00308 {
-00309 char val[MAXBUF];
-00310 ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00311 return val;
-00312 }
-00313
-00314
-00315 int ConfigReader::Enumerate(std::string tag)
-00316 {
-00317 return EnumConf(fname.c_str(),tag.c_str());
-00318 }
-00319
-00320
-00321 bool ConfigReader::Verify()
-00322 {
-00323 return true;
-00324 }
-00325
-00326
-00327 FileReader::FileReader(std::string filename)
-00328 {
-00329 file_cache c;
-00330 readfile(c,filename.c_str());
-00331 this->fc = c;
-00332 }
-00333
-00334 FileReader::FileReader()
-00335 {
-00336 }
-00337
-00338 void FileReader::LoadFile(std::string filename)
-00339 {
-00340 file_cache c;
-00341 readfile(c,filename.c_str());
-00342 this->fc = c;
-00343 }
-00344
-00345
-00346 FileReader::~FileReader()
-00347 {
-00348 }
-00349
-00350 bool FileReader::Exists()
-00351 {
-00352 if (fc.size() == 0)
-00353 {
-00354 return(false);
-00355 }
-00356 else
-00357 {
-00358 return(true);
-00359 }
-00360 }
-00361
-00362 std::string FileReader::GetLine(int x)
-00363 {
-00364 if ((x<0) || (x>fc.size()))
-00365 return "";
-00366 return fc[x];
-00367 }
-00368
-00369 int FileReader::FileSize()
-00370 {
-00371 return fc.size();
-00372 }
-00373
-00374
-00375 std::vector<Module*> modules(255);
-00376 std::vector<ircd_module*> factory(255);
-00377
-00378 int MODCOUNT = -1;
+00307 ConfigReader::ConfigReader(std::string filename) : fname(filename) { };
+00308
+00309 std::string ConfigReader::ReadValue(std::string tag, std::string name, int index)
+00310 {
+00311 char val[MAXBUF];
+00312 ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
+00313 return val;
+00314 }
+00315
+00316
+00317 int ConfigReader::Enumerate(std::string tag)
+00318 {
+00319 return EnumConf(fname.c_str(),tag.c_str());
+00320 }
+00321
+00322
+00323 bool ConfigReader::Verify()
+00324 {
+00325 return true;
+00326 }
+00327
+00328
+00329 FileReader::FileReader(std::string filename)
+00330 {
+00331 file_cache c;
+00332 readfile(c,filename.c_str());
+00333 this->fc = c;
+00334 }
+00335
+00336 FileReader::FileReader()
+00337 {
+00338 }
+00339
+00340 void FileReader::LoadFile(std::string filename)
+00341 {
+00342 file_cache c;
+00343 readfile(c,filename.c_str());
+00344 this->fc = c;
+00345 }
+00346
+00347
+00348 FileReader::~FileReader()
+00349 {
+00350 }
+00351
+00352 bool FileReader::Exists()
+00353 {
+00354 if (fc.size() == 0)
+00355 {
+00356 return(false);
+00357 }
+00358 else
+00359 {
+00360 return(true);
+00361 }
+00362 }
+00363
+00364 std::string FileReader::GetLine(int x)
+00365 {
+00366 if ((x<0) || (x>fc.size()))
+00367 return "";
+00368 return fc[x];
+00369 }
+00370
+00371 int FileReader::FileSize()
+00372 {
+00373 return fc.size();
+00374 }
+00375
+00376
+00377 std::vector<Module*> modules(255);
+00378 std::vector<ircd_module*> factory(255);
00379
-00380
-
Generated on Tue Apr 6 11:42:30 2004 for InspIRCd by
+00380 int MODCOUNT = -1;
+00381
+00382
+
Generated on Tue Apr 6 21:13:19 2004 for InspIRCd by
1.3-rc3
--
cgit v1.3.1-10-gc9f91