include/caller.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef CALLER_H
  15 #define CALLER_H
  16
  17 /** The templates below can be auto generated by tools/create_templates.pl.
  18  * They are used to represent a functor with a given number of parameters and
  19  * a specific return type. To prevent passing the wrong number of parameters
  20  * and have the compiler detect this error at build-time, each class is numbered
  21  * according to the number of parameters it takes, e.g. caller0, caller1, caller2.
  22  * These have been generated from zero parameters to eight.
  23  *
  24  * If you want to declare a functor which takes two parameters, a User and a Channel,
  25  * and returns bool, simply create it like this:
  26  *
  27  * caller2<bool, User*, Channel*> MyFunction;
  28  *
  29  * and initialize it correctly, when placed into a class you will be able to call it:
  30  *
  31  * bool n = someclass->MyFunction(someuser, somechan);
  32  *
  33  * These functor templates work this way so that you can simply and easily allow
  34  * for these class methods to be overridden from within a module, e.g. have a module
  35  * which completely replaces the code for IsNick, etc. For example, with the example
  36  * above:
  37  *
  38  * MyNewFunction replaceme(ServerInstance);
  39  *
  40  * someclass->MyFunction = &replaceme;
  41  *
  42  * After this point, calls to someclass->MyFunction will call the new code in your
  43  * replacement functor.
  44  *
  45  * This is a very powerful feature which should be considered 'advanced' and not for
  46  * beginners. If you do not understand these templates, STAY AWAY from playing with
  47  * this until you do, as if you get this wrong, this can generate some pretty long
  48  * winded and confusing error messages at compile time.
  49  */
  50 template <typename ReturnType> class CoreExport HandlerBase0 : public classbase
  51 {
  52  public:
  53         virtual ReturnType Call() = 0;
  54         virtual ~HandlerBase0() { }
  55 };
  56
  57 template <typename ReturnType, typename Param1> class CoreExport HandlerBase1 : public classbase
  58 {
  59  public:
  60         virtual ReturnType Call(Param1) = 0;
  61         virtual ~HandlerBase1() { }
  62 };
  63
  64 template <typename ReturnType, typename Param1, typename Param2> class CoreExport HandlerBase2 : public classbase
  65 {
  66  public:
  67         virtual ReturnType Call(Param1, Param2) = 0;
  68         virtual ~HandlerBase2() { }
  69 };
  70
  71 template <typename ReturnType, typename Param1, typename Param2, typename Param3> class CoreExport HandlerBase3 : public classbase
  72 {
  73  public:
  74         virtual ReturnType Call(Param1, Param2, Param3) = 0;
  75         virtual ~HandlerBase3() { }
  76 };
  77
  78 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4> class CoreExport HandlerBase4 : public classbase
  79 {
  80  public:
  81         virtual ReturnType Call(Param1, Param2, Param3, Param4) = 0;
  82         virtual ~HandlerBase4() { }
  83 };
  84
  85 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5> class CoreExport HandlerBase5 : public classbase
  86 {
  87  public:
  88         virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5) = 0;
  89         virtual ~HandlerBase5() { }
  90 };
  91
  92 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6> class CoreExport HandlerBase6 : public classbase
  93 {
  94  public:
  95         virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6) = 0;
  96         virtual ~HandlerBase6() { }
  97 };
  98
  99 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7> class CoreExport HandlerBase7 : public classbase
 100 {
 101  public:
 102         virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7) = 0;
 103         virtual ~HandlerBase7() { }
 104 };
 105
 106 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7, typename Param8> class CoreExport HandlerBase8 : public classbase
 107 {
 108  public:
 109         virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8) = 0;
 110         virtual ~HandlerBase8() { }
 111 };
 112
 113 template <typename HandlerType> class CoreExport caller
 114 {
 115  public:
 116         HandlerType* target;
 117
 118         caller(HandlerType* initial)
 119         : target(initial)
 120         { }
 121
 122         virtual ~caller() { }
 123 };
 124
 125 template <typename ReturnType> class CoreExport caller0 : public caller< HandlerBase0<ReturnType> >
 126 {
 127  public:
 128         caller0(HandlerBase0<ReturnType>* initial)
 129         : caller< HandlerBase0<ReturnType> >::caller(initial)
 130         { }
 131
 132         virtual ReturnType operator() ()
 133         {
 134                 return this->target->Call();
 135         }
 136 };
 137
 138 template <typename ReturnType, typename Param1> class CoreExport caller1 : public caller< HandlerBase1<ReturnType, Param1> >
 139 {
 140  public:
 141         caller1(HandlerBase1<ReturnType, Param1>* initial)
 142         : caller< HandlerBase1<ReturnType, Param1> >(initial)
 143         { }
 144
 145         virtual ReturnType operator() (Param1 param1)
 146         {
 147                 return this->target->Call(param1);
 148         }
 149 };
 150
 151 template <typename ReturnType, typename Param1, typename Param2> class CoreExport caller2 : public caller< HandlerBase2<ReturnType, Param1, Param2> >
 152 {
 153  public:
 154         caller2(HandlerBase2<ReturnType, Param1, Param2>* initial)
 155         : caller< HandlerBase2<ReturnType, Param1, Param2> >(initial)
 156         { }
 157
 158         virtual ReturnType operator() (Param1 param1, Param2 param2)
 159         {
 160                 return this->target->Call(param1, param2);
 161         }
 162 };
 163
 164 template <typename ReturnType, typename Param1, typename Param2, typename Param3> class CoreExport caller3 : public caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >
 165 {
 166  public:
 167         caller3(HandlerBase3<ReturnType, Param1, Param2, Param3>* initial)
 168         : caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >(initial)
 169         { }
 170
 171         virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3)
 172         {
 173                 return this->target->Call(param1, param2, param3);
 174         }
 175 };
 176
 177 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4> class CoreExport caller4 : public caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >
 178 {
 179  public:
 180         caller4(HandlerBase4<ReturnType, Param1, Param2, Param3, Param4>* initial)
 181         : caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >(initial)
 182         { }
 183
 184         virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4)
 185         {
 186                 return this->target->Call(param1, param2, param3, param4);
 187         }
 188 };
 189
 190 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5> class CoreExport caller5 : public caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >
 191 {
 192  public:
 193         caller5(HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5>* initial)
 194         : caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >(initial)
 195         { }
 196
 197         virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5)
 198         {
 199                 return this->target->Call(param1, param2, param3, param4, param5);
 200         }
 201 };
 202
 203 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6> class CoreExport caller6 : public caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >
 204 {
 205  public:
 206         caller6(HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6>* initial)
 207         : caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >(initial)
 208         { }
 209
 210         virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6)
 211         {
 212                 return this->target->Call(param1, param2, param3, param4, param5, param6);
 213         }
 214 };
 215
 216 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7> class CoreExport caller7 : public caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >
 217 {
 218  public:
 219         caller7(HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7>* initial)
 220         : caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >(initial)
 221         { }
 222
 223         virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7)
 224         {
 225                 return this->target->Call(param1, param2, param3, param4, param5, param6, param7);
 226         }
 227 };
 228
 229 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7, typename Param8> class CoreExport caller8 : public caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >
 230 {
 231  public:
 232         caller8(HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8>* initial)
 233         : caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >(initial)
 234         { }
 235
 236         virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7, Param8 param8)
 237         {
 238                 return this->target->Call(param1, param2, param3, param4, param5, param6, param7, param8);
 239         }
 240 };
 241
 242 /** These shorthand macros are used to define a functor class which only implements Call(). Most functors are like this.
 243  * If you want something more complex, define them by hand.
 244  *
 245  * The first parameter to each macro is the class name to define, the second parameter is the return value of Call().
 246  * The following parameters are the parameter types for Call(), and again, the macro is numbered to match the number of
 247  * parameters, to prevent mistakes.
 248  */
 249 #define DEFINE_HANDLER0(NAME, RETURN) \
 250         class CoreExport NAME : public HandlerBase0<RETURN> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(); }
 251
 252 #define DEFINE_HANDLER1(NAME, RETURN, V1) \
 253         class CoreExport NAME : public HandlerBase1<RETURN, V1> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1); }
 254
 255 #define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \
 256         class CoreExport NAME : public HandlerBase2<RETURN, V1, V2> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2); }
 257
 258 #define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \
 259         class CoreExport NAME : public HandlerBase3<RETURN, V1, V2, V3> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3); }
 260
 261 #define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \
 262         class CoreExport NAME : public HandlerBase4<RETURN, V1, V2, V3, V4> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4); }
 263
 264 #define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \
 265         class CoreExport NAME : public HandlerBase5<RETURN, V1, V2, V3, V4, V5> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5); }
 266
 267 #define DEFINE_HANDLER6(NAME, RETURN, V1, V2, V3, V4, V5, V6) \
 268         class CoreExport NAME : public HandlerBase6<RETURN, V1, V2, V3, V4, V5, V6> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6); }
 269
 270 #define DEFINE_HANDLER7(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7) \
 271         class CoreExport NAME : public HandlerBase7<RETURN, V1, V2, V3, V4, V5, V6, V7> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7); }
 272
 273 #define DEFINE_HANDLER8(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7, V8) \
 274         class CoreExport NAME : public HandlerBase8<RETURN, V1, V2, V3, V4, V5, V6, V7, V8> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7, V8); }
 275
 276 #endif