From 66f0cd6469d2643858c2fcd14726d362696bd68d Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 24 May 2005 02:34:33 +0000 Subject: New methods, new docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1484 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classchanrec.html | 264 +++++++++++++++++++------------------- 1 file changed, 132 insertions(+), 132 deletions(-) (limited to 'docs/module-doc/classchanrec.html') diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index d40fedbde..e44480b41 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -124,20 +124,20 @@ Creates a channel record and initialises it with default values.

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

References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset.

-

00109 {
-00110         strcpy(name,"");
-00111         strcpy(custom_modes,"");
-00112         strcpy(topic,"");
-00113         strcpy(setby,"");
-00114         strcpy(key,"");
-00115         created = topicset = limit = 0;
-00116         binarymodes = 0;
-00117         internal_userlist.clear();
-00118 }
+
00108 {
+00109         strcpy(name,"");
+00110         strcpy(custom_modes,"");
+00111         strcpy(topic,"");
+00112         strcpy(setby,"");
+00113         strcpy(key,"");
+00114         created = topicset = limit = 0;
+00115         binarymodes = 0;
+00116         internal_userlist.clear();
+00117 }
 
    
   
 
@@ -205,14 +205,14 @@ Add a user pointer to the internal reference list The data inserted into the ref
 

 
 

-Definition at line 202 of file channels.cpp.
+Definition at line 201 of file channels.cpp.
 

 References DEBUG, and internal_userlist.
 

-
00203 {
-00204         internal_userlist.push_back(castuser);
-00205         log(DEBUG,"Added casted user to channel's internal list");
-00206 }
+
00202 {
+00203         internal_userlist.push_back(castuser);
+00204         log(DEBUG,"Added casted user to channel's internal list");
+00205 }
 
    
   
 
@@ -246,22 +246,22 @@ Delete a user pointer to the internal reference list The data removed from the r
 

 
 

-Definition at line 208 of file channels.cpp.
+Definition at line 207 of file channels.cpp.
 

 References DEBUG, internal_userlist, and name.
 

-
00209 {
-00210         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
-00211         {
-00212                 if (*a == castuser)
-00213                 {
-00214                         log(DEBUG,"Removed casted user from channel's internal list");
-00215                         internal_userlist.erase(a);
-00216                         return;
-00217                 }
-00218         }
-00219         log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name);
-00220 }
+
00208 {
+00209         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
+00210         {
+00211                 if (*a == castuser)
+00212                 {
+00213                         log(DEBUG,"Removed casted user from channel's internal list");
+00214                         internal_userlist.erase(a);
+00215                         return;
+00216                 }
+00217         }
+00218         log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name);
+00219 }
 
    
   
 
@@ -295,23 +295,23 @@ Returns the parameter for a custom mode on a channel.
 

 For example if "+L #foo" is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.
 

-Definition at line 182 of file channels.cpp.
-

-References custom_mode_params.
-

-
00183 {
-00184         if (custom_mode_params.size())
-00185         {
-00186                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00187                 {
-00188                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00189                         {
-00190                                 return i->parameter;
-00191                         }
-00192                 }
-00193         }
-00194         return "";
-00195 }
+Definition at line 181 of file channels.cpp.
+

+References custom_mode_params.
+

+
00182 {
+00183         if (custom_mode_params.size())
+00184         {
+00185                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00186                 {
+00187                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00188                         {
+00189                                 return i->parameter;
+00190                         }
+00191                 }
+00192         }
+00193         return "";
+00194 }
 
    
   
 
@@ -344,13 +344,13 @@ Obtain the channel "user counter" This returns the channel reference counter, wh
 

 
 

-Definition at line 197 of file channels.cpp.
+Definition at line 196 of file channels.cpp.
 

 References internal_userlist.
 

-
00198 {
-00199         return (this->internal_userlist.size());
-00200 }
+
00197 {
+00198         return (this->internal_userlist.size());
+00199 }
 
    
   
 
@@ -383,15 +383,15 @@ Obrain the internal reference list The internal reference list contains a list o
 

 These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.
 

-Definition at line 222 of file channels.cpp.
+Definition at line 221 of file channels.cpp.
 

 References internal_userlist.
 

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

-
00223 {
-00224         return &internal_userlist;
-00225 }
+
00222 {
+00223         return &internal_userlist;
+00224 }
 
    
   
 
@@ -425,14 +425,14 @@ Returns true if a custom mode is set on a channel.
 

 
 

-Definition at line 176 of file channels.cpp.
+Definition at line 175 of file channels.cpp.
 

 References DEBUG.
 

-
00177 {
-00178         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
-00179         return (strchr(this->custom_modes,mode) != 0);
-00180 }
+
00176 {
+00177         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
+00178         return (strchr(this->custom_modes,mode) != 0);
+00179 }
 
    
   
 
@@ -475,32 +475,32 @@ Sets or unsets a custom mode in the channels info.
 

 
 

-Definition at line 120 of file channels.cpp.
-

-References custom_modes, DEBUG, and SetCustomModeParam().
-

-
00121 {
-00122         if (mode_on) {
-00123                 static char m[3];
-00124                 m[0] = mode;
-00125                 m[1] = '\0';
-00126                 if (!strchr(this->custom_modes,mode))
-00127                 {
-00128                         strlcat(custom_modes,m,MAXMODES);
-00129                 }
-00130                 log(DEBUG,"Custom mode %c set",mode);
-00131         }
-00132         else {
-00133 
-00134                 std::string a = this->custom_modes;
-00135                 int pos = a.find(mode);
-00136                 a.erase(pos,1);
-00137                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
-00138 
-00139                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
-00140                 this->SetCustomModeParam(mode,"",false);
-00141         }
-00142 }
+Definition at line 119 of file channels.cpp.
+

+References custom_modes, DEBUG, and SetCustomModeParam().
+

+
00120 {
+00121         if (mode_on) {
+00122                 static char m[3];
+00123                 m[0] = mode;
+00124                 m[1] = '\0';
+00125                 if (!strchr(this->custom_modes,mode))
+00126                 {
+00127                         strlcat(custom_modes,m,MAXMODES);
+00128                 }
+00129                 log(DEBUG,"Custom mode %c set",mode);
+00130         }
+00131         else {
+00132 
+00133                 std::string a = this->custom_modes;
+00134                 int pos = a.find(mode);
+00135                 a.erase(pos,1);
+00136                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
+00137 
+00138                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
+00139                 this->SetCustomModeParam(mode,"",false);
+00140         }
+00141 }
 
    
   
 
@@ -549,41 +549,41 @@ Sets or unsets the parameters for a custom mode in a channels info.
 

 
 

-Definition at line 145 of file channels.cpp.
-

-References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
-

-Referenced by SetCustomMode().
-

-
00146 {
-00147 
-00148         log(DEBUG,"SetCustomModeParam called");
-00149         ModeParameter M;
-00150         M.mode = mode;
-00151         strlcpy(M.channel,this->name,CHANMAX);
-00152         strlcpy(M.parameter,parameter,MAXBUF);
-00153         if (mode_on)
-00154         {
-00155                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
-00156                 custom_mode_params.push_back(M);
-00157         }
-00158         else
-00159         {
-00160                 if (custom_mode_params.size())
-00161                 {
-00162                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00163                         {
-00164                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00165                                 {
-00166                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
-00167                                         custom_mode_params.erase(i);
-00168                                         return;
-00169                                 }
-00170                         }
-00171                 }
-00172                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
-00173         }
-00174 }
+Definition at line 144 of file channels.cpp.
+

+References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
+

+Referenced by SetCustomMode().
+

+
00145 {
+00146 
+00147         log(DEBUG,"SetCustomModeParam called");
+00148         ModeParameter M;
+00149         M.mode = mode;
+00150         strlcpy(M.channel,this->name,CHANMAX);
+00151         strlcpy(M.parameter,parameter,MAXBUF);
+00152         if (mode_on)
+00153         {
+00154                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
+00155                 custom_mode_params.push_back(M);
+00156         }
+00157         else
+00158         {
+00159                 if (custom_mode_params.size())
+00160                 {
+00161                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00162                         {
+00163                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00164                                 {
+00165                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
+00166                                         custom_mode_params.erase(i);
+00167                                         return;
+00168                                 }
+00169                         }
+00170                 }
+00171                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
+00172         }
+00173 }
 
    
   
 
@@ -639,7 +639,7 @@ Contains a bitmask of the CM_* builtin (RFC) binary mode symbols.
 

 Definition at line 145 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -667,7 +667,7 @@ Creation time.
 

 Definition at line 123 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -695,7 +695,7 @@ Plugins may use this field in any way they see fit.
 

 Definition at line 110 of file channels.h.
 

-Referenced by chanrec(), and SetCustomMode().    
+Referenced by chanrec(), and SetCustomMode().    
   
 
 

@@ -723,7 +723,7 @@ User list (casted to char*'s to stop forward declaration stuff) (chicken and egg
 

 Definition at line 115 of file channels.h.
 

-Referenced by AddUser(), chanrec(), DelUser(), GetUserCounter(), and GetUsers().    
+Referenced by AddUser(), chanrec(), DelUser(), GetUserCounter(), and GetUsers().    
   
 
 

@@ -751,7 +751,7 @@ If this value is an empty string, there is no channel key in place.
 

 Definition at line 141 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -779,7 +779,7 @@ If this value is zero, there is no limit in place.
 

 Definition at line 136 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -807,7 +807,7 @@ The channels name.
 

 Definition at line 106 of file channels.h.
 

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

@@ -835,7 +835,7 @@ If this member is an empty string, no topic was ever set.
 

 Definition at line 131 of file channels.h.
 

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

@@ -863,7 +863,7 @@ If this is an empty string, no channel topic is set.
 

 Definition at line 120 of file channels.h.
 

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

@@ -891,12 +891,12 @@ If no topic was ever set, this will be equal to 127 of file channels.h.
 

-Referenced by chanrec(), and Server::PseudoToUser().    
+Referenced by chanrec(), and Server::PseudoToUser().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Sun May 15 18:37:45 2005 for InspIRCd by
+
Generated on Tue May 24 02:31:34 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3