docs/man/man3/modules.cpp.3

   1 .TH "modules.cpp" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 modules.cpp \-
   6 .SH SYNOPSIS
   7 .br
   8 .PP
   9 \fC#include 'inspircd_config.h'\fP
  10 .br
  11 \fC#include 'inspircd.h'\fP
  12 .br
  13 \fC#include 'inspircd_io.h'\fP
  14 .br
  15 \fC#include 'inspircd_util.h'\fP
  16 .br
  17 \fC#include <unistd.h>\fP
  18 .br
  19 \fC#include <sys/errno.h>\fP
  20 .br
  21 \fC#include <time.h>\fP
  22 .br
  23 \fC#include <string>\fP
  24 .br
  25 \fC#include <hash_map>\fP
  26 .br
  27 \fC#include <map>\fP
  28 .br
  29 \fC#include <sstream>\fP
  30 .br
  31 \fC#include <vector>\fP
  32 .br
  33 \fC#include <deque>\fP
  34 .br
  35 \fC#include 'users.h'\fP
  36 .br
  37 \fC#include 'ctables.h'\fP
  38 .br
  39 \fC#include 'globals.h'\fP
  40 .br
  41 \fC#include 'modules.h'\fP
  42 .br
  43 \fC#include 'dynamic.h'\fP
  44 .br
  45 \fC#include 'wildcard.h'\fP
  46 .br
  47 \fC#include 'message.h'\fP
  48 .br
  49 \fC#include 'mode.h'\fP
  50 .br
  51 \fC#include 'xline.h'\fP
  52 .br
  53 \fC#include 'commands.h'\fP
  54 .br
  55 \fC#include 'inspstring.h'\fP
  56 .br
  57 \fC#include 'helperfuncs.h'\fP
  58 .br
  59 \fC#include 'hashcomp.h'\fP
  60 .br
  61 \fC#include 'socket.h'\fP
  62 .br
  63 \fC#include 'socketengine.h'\fP
  64 .br
  65 \fC#include 'typedefs.h'\fP
  66 .br
  67
  68 .SS "Functions"
  69
  70 .in +1c
  71 .ti -1c
  72 .RI "bool \fBModeDefined\fP (char modechar, int type)"
  73 .br
  74 .ti -1c
  75 .RI "bool \fBModeIsListMode\fP (char modechar, int type)"
  76 .br
  77 .ti -1c
  78 .RI "bool \fBModeDefinedOper\fP (char modechar, int type)"
  79 .br
  80 .ti -1c
  81 .RI "int \fBModeDefinedOn\fP (char modechar, int type)"
  82 .br
  83 .ti -1c
  84 .RI "int \fBModeDefinedOff\fP (char modechar, int type)"
  85 .br
  86 .ti -1c
  87 .RI "bool \fBDoAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_on, int params_off)"
  88 .br
  89 .ti -1c
  90 .RI "void \fBModeMakeList\fP (char modechar)"
  91 .br
  92 .ti -1c
  93 .RI "std::vector< \fBModule\fP * > \fBmodules\fP (255)"
  94 .br
  95 .ti -1c
  96 .RI "std::vector< \fBircd_module\fP * > \fBfactory\fP (255)"
  97 .br
  98 .in -1c
  99 .SS "Variables"
 100
 101 .in +1c
 102 .ti -1c
 103 .RI "\fBSocketEngine\fP * \fBSE\fP"
 104 .br
 105 .ti -1c
 106 .RI "\fBServerConfig\fP * \fBConfig\fP"
 107 .br
 108 .ti -1c
 109 .RI "\fBInspIRCd\fP * \fBServerInstance\fP"
 110 .br
 111 .ti -1c
 112 .RI "int \fBMODCOUNT\fP = -1"
 113 .br
 114 .ti -1c
 115 .RI "std::vector< \fBModule\fP * > \fBmodules\fP"
 116 .br
 117 .ti -1c
 118 .RI "std::vector< \fBircd_module\fP * > \fBfactory\fP"
 119 .br
 120 .ti -1c
 121 .RI "std::vector< \fBInspSocket\fP * > \fBmodule_sockets\fP"
 122 .br
 123 .ti -1c
 124 .RI "time_t \fBTIME\fP"
 125 .br
 126 .ti -1c
 127 .RI "\fBuserrec\fP * \fBfd_ref_table\fP [65536]"
 128 .br
 129 .ti -1c
 130 .RI "\fBuser_hash\fP \fBclientlist\fP"
 131 .br
 132 .ti -1c
 133 .RI "\fBchan_hash\fP \fBchanlist\fP"
 134 .br
 135 .ti -1c
 136 .RI "\fBcommand_table\fP \fBcmdlist\fP"
 137 .br
 138 .ti -1c
 139 .RI "\fBExtModeList\fP \fBEMode\fP"
 140 .br
 141 .in -1c
 142 .SH "Function Documentation"
 143 .PP
 144 .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)"
 145 .PP
 146 Definition at line 134 of file modules.cpp.
 147 .PP
 148 References EMode, and ModeDefined().
 149 .PP
 150 Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode().
 151 .PP
 152 .nf
 153 135 {
 154 136         if (ModeDefined(modechar,type)) {
 155 137                 return false;
 156 138         }
 157 139         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
 158 140         return true;
 159 141 }
 160 .fi
 161 .PP
 162 .SS "std::vector<\fBircd_module\fP*> factory (255)"
 163 .PP
 164 .SS "bool ModeDefined (char modechar, int type)"
 165 .PP
 166 Definition at line 71 of file modules.cpp.
 167 .PP
 168 References EMode.
 169 .PP
 170 Referenced by DoAddExtendedMode().
 171 .PP
 172 .nf
 173 72 {
 174 73         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 175 74         {
 176 75                 if ((i->modechar == modechar) && (i->type == type))
 177 76                 {
 178 77                         return true;
 179 78                 }
 180 79         }
 181 80         return false;
 182 81 }
 183 .fi
 184 .PP
 185 .SS "int ModeDefinedOff (char modechar, int type)"
 186 .PP
 187 Definition at line 121 of file modules.cpp.
 188 .PP
 189 References EMode.
 190 .PP
 191 .nf
 192 122 {
 193 123         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 194 124         {
 195 125                 if ((i->modechar == modechar) && (i->type == type))
 196 126                 {
 197 127                         return i->params_when_off;
 198 128                 }
 199 129         }
 200 130         return 0;
 201 131 }
 202 .fi
 203 .PP
 204 .SS "int ModeDefinedOn (char modechar, int type)"
 205 .PP
 206 Definition at line 108 of file modules.cpp.
 207 .PP
 208 References EMode.
 209 .PP
 210 .nf
 211 109 {
 212 110         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 213 111         {
 214 112                 if ((i->modechar == modechar) && (i->type == type))
 215 113                 {
 216 114                         return i->params_when_on;
 217 115                 }
 218 116         }
 219 117         return 0;
 220 118 }
 221 .fi
 222 .PP
 223 .SS "bool ModeDefinedOper (char modechar, int type)"
 224 .PP
 225 Definition at line 95 of file modules.cpp.
 226 .PP
 227 References EMode.
 228 .PP
 229 .nf
 230 96 {
 231 97         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 232 98         {
 233 99                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
 234 100                 {
 235 101                         return true;
 236 102                 }
 237 103         }
 238 104         return false;
 239 105 }
 240 .fi
 241 .PP
 242 .SS "bool ModeIsListMode (char modechar, int type)"
 243 .PP
 244 Definition at line 83 of file modules.cpp.
 245 .PP
 246 References EMode.
 247 .PP
 248 .nf
 249 84 {
 250 85         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 251 86         {
 252 87                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
 253 88                 {
 254 89                         return true;
 255 90                 }
 256 91         }
 257 92         return false;
 258 93 }
 259 .fi
 260 .PP
 261 .SS "void ModeMakeList (char modechar)"
 262 .PP
 263 Definition at line 144 of file modules.cpp.
 264 .PP
 265 References EMode, and MT_CHANNEL.
 266 .PP
 267 Referenced by Server::AddExtendedListMode().
 268 .PP
 269 .nf
 270 145 {
 271 146         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 272 147         {
 273 148                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
 274 149                 {
 275 150                         i->list = true;
 276 151                         return;
 277 152                 }
 278 153         }
 279 154         return;
 280 155 }
 281 .fi
 282 .PP
 283 .SS "std::vector<\fBModule\fP*> modules (255)"
 284 .PP
 285 .SH "Variable Documentation"
 286 .PP
 287 .SS "\fBchan_hash\fP \fBchanlist\fP"
 288 .PP
 289 .SS "\fBuser_hash\fP \fBclientlist\fP"
 290 .PP
 291 .SS "\fBcommand_table\fP \fBcmdlist\fP"
 292 .PP
 293 .SS "\fBServerConfig\fP* \fBConfig\fP"
 294 .PP
 295 .SS "\fBExtModeList\fP \fBEMode\fP"
 296 .PP
 297 Definition at line 68 of file modules.cpp.
 298 .PP
 299 Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().
 300 .SS "std::vector<\fBircd_module\fP*> factory"
 301 .PP
 302 .SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]"
 303 .PP
 304 .SS "int \fBMODCOUNT\fP = -1"
 305 .PP
 306 Definition at line 935 of file modules.cpp.
 307 .SS "std::vector<\fBInspSocket\fP*> \fBmodule_sockets\fP"
 308 .PP
 309 Referenced by Server::AddSocket(), and Server::DelSocket().
 310 .SS "std::vector<\fBModule\fP*> modules"
 311 .PP
 312 .SS "\fBSocketEngine\fP* \fBSE\fP"
 313 .PP
 314 .SS "\fBInspIRCd\fP* \fBServerInstance\fP"
 315 .PP
 316 .SS "time_t \fBTIME\fP"
 317 .PP
 318 .SH "Author"
 319 .PP
 320 Generated automatically by Doxygen for InspIRCd from the source code.