docs/man/modules.cpp.3

   1 .TH "modules.cpp" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 modules.cpp \-
   6 .SH SYNOPSIS
   7 .br
   8 .PP
   9 \fC#include <typeinfo>\fP
  10 .br
  11 \fC#include <iostream>\fP
  12 .br
  13 \fC#include 'globals.h'\fP
  14 .br
  15 \fC#include 'modules.h'\fP
  16 .br
  17 \fC#include 'ctables.h'\fP
  18 .br
  19 \fC#include 'inspircd_io.h'\fP
  20 .br
  21 \fC#include 'wildcard.h'\fP
  22 .br
  23 \fC#include 'mode.h'\fP
  24 .br
  25 \fC#include 'message.h'\fP
  26 .br
  27 \fC#include 'commands.h'\fP
  28 .br
  29
  30 .SS "Compounds"
  31
  32 .in +1c
  33 .ti -1c
  34 .RI "class \fBExtMode\fP"
  35 .br
  36 .in -1c
  37 .SS "Typedefs"
  38
  39 .in +1c
  40 .ti -1c
  41 .RI "typedef std::vector< \fBExtMode\fP > \fBExtModeList\fP"
  42 .br
  43 .ti -1c
  44 .RI "typedef ExtModeList::iterator \fBExtModeListIter\fP"
  45 .br
  46 .in -1c
  47 .SS "Functions"
  48
  49 .in +1c
  50 .ti -1c
  51 .RI "bool \fBModeDefined\fP (char modechar, int type)"
  52 .br
  53 .ti -1c
  54 .RI "bool \fBModeDefinedOper\fP (char modechar, int type)"
  55 .br
  56 .ti -1c
  57 .RI "int \fBModeDefinedOn\fP (char modechar, int type)"
  58 .br
  59 .ti -1c
  60 .RI "int \fBModeDefinedOff\fP (char modechar, int type)"
  61 .br
  62 .ti -1c
  63 .RI "bool \fBDoAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_on, int params_off)"
  64 .br
  65 .ti -1c
  66 .RI "std::vector< \fBModule\fP * > \fBmodules\fP (255)"
  67 .br
  68 .ti -1c
  69 .RI "std::vector< \fBircd_module\fP * > \fBfactory\fP (255)"
  70 .br
  71 .in -1c
  72 .SS "Variables"
  73
  74 .in +1c
  75 .ti -1c
  76 .RI "\fBExtModeList\fP \fBEMode\fP"
  77 .br
  78 .ti -1c
  79 .RI "int \fBMODCOUNT\fP = -1"
  80 .br
  81 .in -1c
  82 .SH "Typedef Documentation"
  83 .PP
  84 .SS "typedef std::vector<\fBExtMode\fP> ExtModeList"
  85 .PP
  86 Definition at line 32 of file modules.cpp.
  87 .SS "typedef ExtModeList::iterator ExtModeListIter"
  88 .PP
  89 Definition at line 33 of file modules.cpp.
  90 .PP
  91 Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), and ModeDefinedOper().
  92 .SH "Function Documentation"
  93 .PP
  94 .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)"
  95 .PP
  96 Definition at line 93 of file modules.cpp.
  97 .PP
  98 References EMode, and ModeDefined().
  99 .PP
 100 Referenced by Server::AddExtendedMode().
 101 .PP
 102 .nf
 103 94 {
 104 95         if (ModeDefined(modechar,type)) {
 105 96                 return false;
 106 97         }
 107 98         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
 108 99         return true;
 109 100 }
 110 .fi
 111 .SS "std::vector<\fBircd_module\fP*> factory (255)"
 112 .PP
 113 .SS "bool ModeDefined (char modechar, int type)"
 114 .PP
 115 Definition at line 38 of file modules.cpp.
 116 .PP
 117 References EMode, and ExtModeListIter.
 118 .PP
 119 Referenced by DoAddExtendedMode().
 120 .PP
 121 .nf
 122 39 {
 123 40         log(DEBUG,'Size of extmodes vector is %d',EMode.size());
 124 41         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 125 42         {
 126 43                 log(DEBUG,'i->modechar==%c, modechar=%c, i->type=%d, type=%d',i->modechar,modechar,i->type,type);
 127 44                 if ((i->modechar == modechar) && (i->type == type))
 128 45                 {
 129 46                         return true;
 130 47                 }
 131 48         }
 132 49         return false;
 133 50 }
 134 .fi
 135 .SS "int ModeDefinedOff (char modechar, int type)"
 136 .PP
 137 Definition at line 80 of file modules.cpp.
 138 .PP
 139 References EMode, and ExtModeListIter.
 140 .PP
 141 .nf
 142 81 {
 143 82         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 144 83         {
 145 84                 if ((i->modechar == modechar) && (i->type == type))
 146 85                 {
 147 86                         return i->params_when_off;
 148 87                 }
 149 88         }
 150 89         return 0;
 151 90 }
 152 .fi
 153 .SS "int ModeDefinedOn (char modechar, int type)"
 154 .PP
 155 Definition at line 67 of file modules.cpp.
 156 .PP
 157 References EMode, and ExtModeListIter.
 158 .PP
 159 .nf
 160 68 {
 161 69         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 162 70         {
 163 71                 if ((i->modechar == modechar) && (i->type == type))
 164 72                 {
 165 73                         return i->params_when_on;
 166 74                 }
 167 75         }
 168 76         return 0;
 169 77 }
 170 .fi
 171 .SS "bool ModeDefinedOper (char modechar, int type)"
 172 .PP
 173 Definition at line 52 of file modules.cpp.
 174 .PP
 175 References EMode, and ExtModeListIter.
 176 .PP
 177 .nf
 178 53 {
 179 54         log(DEBUG,'Size of extmodes vector is %d',EMode.size());
 180 55         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 181 56         {
 182 57                 log(DEBUG,'i->modechar==%c, modechar=%c, i->type=%d, type=%d',i->modechar,modechar,i->type,type);
 183 58                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
 184 59                 {
 185 60                         return true;
 186 61                 }
 187 62         }
 188 63         return false;
 189 64 }
 190 .fi
 191 .SS "std::vector<\fBModule\fP*> modules (255)"
 192 .PP
 193 .SH "Variable Documentation"
 194 .PP
 195 .SS "\fBExtModeList\fP EMode"
 196 .PP
 197 Definition at line 35 of file modules.cpp.
 198 .PP
 199 Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), and ModeDefinedOper().
 200 .SS "int MODCOUNT = -1"
 201 .PP
 202 Definition at line 442 of file modules.cpp.
 203 .SH "Author"
 204 .PP
 205 Generated automatically by Doxygen for InspIRCd from the source code.