From 71bedf497cde8b0b38afbb366828b3df9c2803d6 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:04:22 +0000 Subject: git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2578 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h.html | 519 +++++++++++++++++++++++++--------------- 1 file changed, 323 insertions(+), 196 deletions(-) (limited to 'docs/module-doc/modules_8h.html') diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index 9ccdc3d84..032239f66 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -18,18 +18,18 @@

Include dependency graph for modules.h:

- - - - + + +

This graph shows which files directly or indirectly include this file:

- - - + + + +

@@ -122,12 +122,28 @@ This graph shows which files directly or indirectly include this file:

#define VF_COMMON   8 -#define FOREACH_MOD   for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]-> +#define FOREACH_MOD   for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]-> #define FOREACH_RESULT(x) #define FD_MAGIC_NUMBER   -42 +#define IS_LOCAL(x)   (x->fd > -1) + +#define IS_REMOTE(x)   (x->fd < 0) + +#define IS_MODULE_CREATED(x)   (x->fd == FD_MAGIC_NUMBER) + +#define WM_AND   1 + +#define WM_OR   2 + +#define TYPE_USER   1 + +#define TYPE_CHANNEL   2 + +#define TYPE_SERVER   3 + #define CONF_NOT_A_NUMBER   0x000010 #define CONF_NOT_UNSIGNED   0x000080 @@ -148,10 +164,6 @@ This graph shows which files directly or indirectly include this file:

typedef DLLFactory< ModuleFactory > ircd_module

Functions

-void createcommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) - -void server_mode (char **parameters, int pcnt, userrec *user) - bool ModeDefined (char c, int i) bool ModeDefinedOper (char c, int i) @@ -444,7 +456,7 @@ Used with OnAccessCheck() method of modules.

Definition at line 37 of file modules.h.

-Referenced by kick_channel(), and Module::OnAccessCheck(). +Referenced by kick_channel(), and Module::OnAccessCheck().

@@ -496,9 +508,9 @@ Referenced by kick_channel

-Definition at line 1523 of file modules.h. +Definition at line 1541 of file modules.h.

-Referenced by ConfigReader::ConfigReader(). +Referenced by ConfigReader::ConfigReader().

@@ -523,9 +535,9 @@ Referenced by ConfigReader:

-Definition at line 1520 of file modules.h. +Definition at line 1538 of file modules.h.

-Referenced by ConfigReader::ReadInteger(). +Referenced by ConfigReader::ReadInteger().

@@ -550,9 +562,9 @@ Referenced by ConfigReader:

-Definition at line 1521 of file modules.h. +Definition at line 1539 of file modules.h.

-Referenced by ConfigReader::ReadInteger(). +Referenced by ConfigReader::ReadInteger().

@@ -577,9 +589,9 @@ Referenced by ConfigReader:

-Definition at line 1522 of file modules.h. +Definition at line 1540 of file modules.h.

-Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). +Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().

@@ -656,9 +668,9 @@ Definition at line 25 of

-Definition at line 101 of file modules.h. +Definition at line 102 of file modules.h.

-Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +Referenced by Server::PseudoToUser(), and Server::UserToPseudo().

@@ -667,7 +679,7 @@ Referenced by Server::Pseud - +
#define FOREACH_MOD   for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]-> #define FOREACH_MOD   for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]->
@@ -683,9 +695,9 @@ Referenced by Server::Pseud

-Definition at line 81 of file modules.h. +Definition at line 82 of file modules.h.

-Referenced by del_channel(), ForceChan(), kick_channel(), and Event::Send(). +Referenced by del_channel(), ForceChan(), FullConnectUser(), kick_channel(), kill_link(), kill_link_silent(), and Event::Send().

@@ -724,9 +736,99 @@ Referenced by del_channel( }

-Definition at line 89 of file modules.h. +Definition at line 90 of file modules.h. +

+Referenced by add_channel(), force_nickchange(), and kick_channel(). + + +

+ + + + +
+ + + + + + + + + +
#define IS_LOCAL ( x   )    (x->fd > -1)
+
+ + + + + +
+   + + +

+ +

+Definition at line 106 of file modules.h.

+

+ + + + +
+ + + + + + + + + +
#define IS_MODULE_CREATED ( x   )    (x->fd == FD_MAGIC_NUMBER)
+
+ + + + + +
+   + + +

+ +

+Definition at line 108 of file modules.h.

+

+ + + + +
+ + + + + + + + + +
#define IS_REMOTE ( x   )    (x->fd < 0)
+
+ + + + +Definition at line 107 of file modules.h.
+   + + +

+

-Referenced by add_channel(), and kick_channel().

@@ -755,7 +857,7 @@ Used with OnExtendedMode() method of modules.

Definition at line 31 of file modules.h.

-Referenced by Server::AddExtendedListMode(), and ModeMakeList(). +Referenced by Server::AddExtendedListMode(), and ModeMakeList().

@@ -782,7 +884,7 @@ Referenced by Server::AddEx

Definition at line 32 of file modules.h.

-Referenced by Server::AddExtendedMode(). +Referenced by Server::AddExtendedMode().

@@ -809,7 +911,7 @@ Referenced by Server::AddEx

Definition at line 33 of file modules.h.

-Referenced by Server::AddExtendedMode(). +Referenced by Server::AddExtendedMode().

@@ -862,6 +964,81 @@ Definition at line 27 of Definition at line 26 of file modules.h. +

+ + + + +
+ + + + +
#define TYPE_CHANNEL   2
+
+ + + + + +
+   + + +

+ +

+Definition at line 118 of file modules.h.

+

+ + + + +
+ + + + +
#define TYPE_SERVER   3
+
+ + + + + +
+   + + +

+ +

+Definition at line 119 of file modules.h.

+

+ + + + +
+ + + + +
#define TYPE_USER   1
+
+ + + + + +
+   + + +

+ +

+Definition at line 117 of file modules.h.

@@ -988,17 +1165,16 @@ Definition at line 52 of

Definition at line 53 of file modules.h.

-Referenced by Module::GetVersion(). +Referenced by Module::GetVersion().

-

Typedef Documentation

-

+

@@ -1012,20 +1188,18 @@ Referenced by Module::GetVe +Definition at line 112 of file modules.h.
- +
typedef std::deque<userrec*> chanuserlist #define WM_AND   1

-Holds a list of users in a channel. -

-Definition at line 74 of file modules.h.

-

+

@@ -1039,20 +1213,19 @@ Definition at line 74 of +Definition at line 113 of file modules.h.
- +
typedef std::deque<std::string> file_cache #define WM_OR   2

-Low level definition of a FileReader classes file cache area. -

-Definition at line 65 of file modules.h.

-

+

Typedef Documentation

+

@@ -1066,18 +1239,20 @@ Definition at line 65 of +Definition at line 75 of file modules.h.
- +
typedef DLLFactory<ModuleFactory> ircd_module typedef std::deque<userrec*> chanuserlist

+Holds a list of users in a channel. +

-Definition at line 1689 of file modules.h.

-

+

@@ -1091,51 +1266,45 @@ Definition at line 1689 o +Definition at line 66 of file modules.h.
- +
typedef file_cache string_list typedef std::deque<std::string> file_cache

+Low level definition of a FileReader classes file cache area. +

-Definition at line 70 of file modules.h.

-

Function Documentation

-

+

+ +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
void createcommand ( char *  cmd,
handlerfunc  f,
char  flags,
int  minparams,
char *  sourcetypedef DLLFactory<ModuleFactory> ircd_module
+
+ + + + + +
+   + + +

+ +

+Definition at line 1707 of file modules.h.

+

+ + + @@ -1151,9 +1320,10 @@ Definition at line 70 of

-Referenced by Server::AddCommand(). +Definition at line 71 of file modules.h.

+ - - - +
) typedef file_cache string_list
+

Function Documentation

@@ -1190,20 +1360,20 @@ Referenced by Server::AddCo

-Definition at line 71 of file modules.cpp. +Definition at line 70 of file modules.cpp.

-References EMode. +References EMode.

-Referenced by DoAddExtendedMode().

00072 {
-00073         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00074         {
-00075                 if ((i->modechar == modechar) && (i->type == type))
-00076                 {
-00077                         return true;
-00078                 }
-00079         }
-00080         return false;
-00081 }
+Referenced by DoAddExtendedMode().
00071 {
+00072         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00073         {
+00074                 if ((i->modechar == modechar) && (i->type == type))
+00075                 {
+00076                         return true;
+00077                 }
+00078         }
+00079         return false;
+00080 }
 

 

     
@@ -1245,18 +1415,18 @@ Referenced by DoAddExtended
 

 
 

-Definition at line 121 of file modules.cpp.
+Definition at line 120 of file modules.cpp.
 

-References EMode.
00122 {
-00123         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00124         {
-00125                 if ((i->modechar == modechar) && (i->type == type))
-00126                 {
-00127                         return i->params_when_off;
-00128                 }
-00129         }
-00130         return 0;
-00131 }
+References EMode.
00121 {
+00122         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00123         {
+00124                 if ((i->modechar == modechar) && (i->type == type))
+00125                 {
+00126                         return i->params_when_off;
+00127                 }
+00128         }
+00129         return 0;
+00130 }
 

 

     
@@ -1298,18 +1468,18 @@ References EMode.

 
 

-Definition at line 108 of file modules.cpp.
+Definition at line 107 of file modules.cpp.
 

-References EMode.
00109 {
-00110         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00111         {
-00112                 if ((i->modechar == modechar) && (i->type == type))
-00113                 {
-00114                         return i->params_when_on;
-00115                 }
-00116         }
-00117         return 0;
-00118 }
+References EMode.
00108 {
+00109         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00110         {
+00111                 if ((i->modechar == modechar) && (i->type == type))
+00112                 {
+00113                         return i->params_when_on;
+00114                 }
+00115         }
+00116         return 0;
+00117 }
 

 

     
@@ -1351,18 +1521,18 @@ References EMode.

 
 

-Definition at line 95 of file modules.cpp.
+Definition at line 94 of file modules.cpp.
 

-References EMode.
00096 {
-00097         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00098         {
-00099                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-00100                 {
-00101                         return true;
-00102                 }
-00103         }
-00104         return false;
-00105 }
+References EMode.
00095 {
+00096         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00097         {
+00098                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+00099                 {
+00100                         return true;
+00101                 }
+00102         }
+00103         return false;
+00104 }
 

 

     
@@ -1404,18 +1574,18 @@ References EMode.

 
 

-Definition at line 83 of file modules.cpp.
+Definition at line 82 of file modules.cpp.
 

-References EMode.
00084 {
-00085         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00086         {
-00087                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
-00088                 {
-00089                         return true;
-00090                 }
-00091         }
-00092         return false;
-00093 }
+References EMode.
00083 {
+00084         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00085         {
+00086                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00087                 {
+00088                         return true;
+00089                 }
+00090         }
+00091         return false;
+00092 }
 

 

     
@@ -1448,70 +1618,27 @@ References EMode.

 
 

-Definition at line 144 of file modules.cpp.
+Definition at line 143 of file modules.cpp.
 

-References EMode, and MT_CHANNEL.
+References EMode, and MT_CHANNEL.
 

-Referenced by Server::AddExtendedListMode().
00145 {
-00146         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00147         {
-00148                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-00149                 {
-00150                         i->list = true;
-00151                         return;
-00152                 }
-00153         }
-00154         return;
-00155 }
+Referenced by Server::AddExtendedListMode().
00144 {
+00145         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00146         {
+00147                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+00148                 {
+00149                         i->list = true;
+00150                         return;
+00151                 }
+00152         }
+00153         return;
+00154 }
-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
void server_mode ( char **  parameters,
int  pcnt,
userrec *  user
) 
-
- - - - - -
-   - - -

-

-

Generated on Thu Dec 15 11:14:16 2005 for InspIRCd by  +
Generated on Mon Dec 19 18:02:14 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3