2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2012 Adam <Adam@anope.org>
8 * This file is part of InspIRCd. InspIRCd is free software: you can
9 * redistribute it and/or modify it under the terms of the GNU General Public
10 * License as published by the Free Software Foundation, version 2.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 /* Pending some sort of C++11 support */
28 template<typename ReturnType, typename... Args> class CoreExport Handler : public classbase
31 virtual ~Handler() { }
32 virtual ReturnType Call(Args...) = 0;
35 template<typename ReturnType, typename... Args> class CoreExport Caller
38 Handler<ReturnType, Args...>* target;
40 Caller(Handler<ReturnType, Args...>* initial) : target(initial) { }
43 virtual ReturnType operator()(const Args&... params)
45 return this->target->Call(params...);
49 /* Below here is compat with the old API */
50 #define HandlerBase0 Handler
51 #define HandlerBase1 Handler
52 #define HandlerBase2 Handler
53 #define HandlerBase3 Handler
54 #define HandlerBase4 Handler
55 #define HandlerBase5 Handler
56 #define HandlerBase6 Handler
57 #define HandlerBase7 Handler
58 #define HandlerBase8 Handler
60 #define caller1 Caller
61 #define caller2 Caller
62 #define caller3 Caller
63 #define caller4 Caller
64 #define caller5 Caller
65 #define caller6 Caller
66 #define caller7 Caller
67 #define caller8 Caller
69 #define DEFINE_HANDLER0(NAME, RETURN) \
70 class CoreExport NAME : public Handler<RETURN> { public: NAME() { } virtual RETURN Call(); }
72 #define DEFINE_HANDLER1(NAME, RETURN, V1) \
73 class CoreExport NAME : public Handler<RETURN, V1> { public: NAME() { } virtual RETURN Call(V1); }
75 #define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \
76 class CoreExport NAME : public Handler<RETURN, V1, V2> { public: NAME() { } virtual RETURN Call(V1, V2); }
78 #define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \
79 class CoreExport NAME : public Handler<RETURN, V1, V2, V3> { public: NAME() { } virtual RETURN Call(V1, V2, V3); }
81 #define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \
82 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4); }
84 #define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \
85 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4, V5> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5); }
87 #define DEFINE_HANDLER6(NAME, RETURN, V1, V2, V3, V4, V5, V6) \
88 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4, V5, V6> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6); }
90 #define DEFINE_HANDLER7(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7) \
91 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4, V5, V6, V7> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7); }
93 #define DEFINE_HANDLER8(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7, V8) \
94 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4, V5, V6, V7, V8> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7, V8); }
98 /** The templates below can be auto generated by tools/create_templates.pl.
99 * They are used to represent a functor with a given number of parameters and
100 * a specific return type. To prevent passing the wrong number of parameters
101 * and have the compiler detect this error at build-time, each class is numbered
102 * according to the number of parameters it takes, e.g. caller0, caller1, caller2.
103 * These have been generated from zero parameters to eight.
105 * If you want to declare a functor which takes two parameters, a User and a Channel,
106 * and returns bool, simply create it like this:
108 * caller2<bool, User*, Channel*> MyFunction;
110 * and initialize it correctly, when placed into a class you will be able to call it:
112 * bool n = someclass->MyFunction(someuser, somechan);
114 * These functor templates work this way so that you can simply and easily allow
115 * for these class methods to be overridden from within a module, e.g. have a module
116 * which completely replaces the code for IsNick, etc. For example, with the example
119 * MyNewFunction replaceme(ServerInstance);
121 * someclass->MyFunction = \&replaceme;
123 * After this point, calls to someclass->MyFunction will call the new code in your
124 * replacement functor.
126 * This is a very powerful feature which should be considered 'advanced' and not for
127 * beginners. If you do not understand these templates, STAY AWAY from playing with
128 * this until you do, as if you get this wrong, this can generate some pretty long
129 * winded and confusing error messages at compile time.
131 template <typename ReturnType> class CoreExport HandlerBase0 : public classbase
134 virtual ReturnType Call() = 0;
135 virtual ~HandlerBase0() { }
138 template <typename ReturnType, typename Param1> class CoreExport HandlerBase1 : public classbase
141 virtual ReturnType Call(Param1) = 0;
142 virtual ~HandlerBase1() { }
145 template <typename ReturnType, typename Param1, typename Param2> class CoreExport HandlerBase2 : public classbase
148 virtual ReturnType Call(Param1, Param2) = 0;
149 virtual ~HandlerBase2() { }
152 template <typename ReturnType, typename Param1, typename Param2, typename Param3> class CoreExport HandlerBase3 : public classbase
155 virtual ReturnType Call(Param1, Param2, Param3) = 0;
156 virtual ~HandlerBase3() { }
159 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4> class CoreExport HandlerBase4 : public classbase
162 virtual ReturnType Call(Param1, Param2, Param3, Param4) = 0;
163 virtual ~HandlerBase4() { }
166 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5> class CoreExport HandlerBase5 : public classbase
169 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5) = 0;
170 virtual ~HandlerBase5() { }
173 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6> class CoreExport HandlerBase6 : public classbase
176 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6) = 0;
177 virtual ~HandlerBase6() { }
180 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7> class CoreExport HandlerBase7 : public classbase
183 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7) = 0;
184 virtual ~HandlerBase7() { }
187 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7, typename Param8> class CoreExport HandlerBase8 : public classbase
190 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8) = 0;
191 virtual ~HandlerBase8() { }
194 template <typename HandlerType> class CoreExport caller
199 caller(HandlerType* initial)
203 virtual ~caller() { }
206 template <typename ReturnType> class CoreExport caller0 : public caller< HandlerBase0<ReturnType> >
209 caller0(HandlerBase0<ReturnType>* initial)
210 : caller< HandlerBase0<ReturnType> >::caller(initial)
213 virtual ReturnType operator() ()
215 return this->target->Call();
219 template <typename ReturnType, typename Param1> class CoreExport caller1 : public caller< HandlerBase1<ReturnType, Param1> >
222 caller1(HandlerBase1<ReturnType, Param1>* initial)
223 : caller< HandlerBase1<ReturnType, Param1> >(initial)
226 virtual ReturnType operator() (Param1 param1)
228 return this->target->Call(param1);
232 template <typename ReturnType, typename Param1, typename Param2> class CoreExport caller2 : public caller< HandlerBase2<ReturnType, Param1, Param2> >
235 caller2(HandlerBase2<ReturnType, Param1, Param2>* initial)
236 : caller< HandlerBase2<ReturnType, Param1, Param2> >(initial)
239 virtual ReturnType operator() (Param1 param1, Param2 param2)
241 return this->target->Call(param1, param2);
245 template <typename ReturnType, typename Param1, typename Param2, typename Param3> class CoreExport caller3 : public caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >
248 caller3(HandlerBase3<ReturnType, Param1, Param2, Param3>* initial)
249 : caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >(initial)
252 virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3)
254 return this->target->Call(param1, param2, param3);
258 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4> class CoreExport caller4 : public caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >
261 caller4(HandlerBase4<ReturnType, Param1, Param2, Param3, Param4>* initial)
262 : caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >(initial)
265 virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4)
267 return this->target->Call(param1, param2, param3, param4);
271 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> >
274 caller5(HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5>* initial)
275 : caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >(initial)
278 virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5)
280 return this->target->Call(param1, param2, param3, param4, param5);
284 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> >
287 caller6(HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6>* initial)
288 : caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >(initial)
291 virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6)
293 return this->target->Call(param1, param2, param3, param4, param5, param6);
297 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> >
300 caller7(HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7>* initial)
301 : caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >(initial)
304 virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7)
306 return this->target->Call(param1, param2, param3, param4, param5, param6, param7);
310 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> >
313 caller8(HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8>* initial)
314 : caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >(initial)
317 virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7, Param8 param8)
319 return this->target->Call(param1, param2, param3, param4, param5, param6, param7, param8);
323 /** These shorthand macros are used to define a functor class which only implements Call(). Most functors are like this.
324 * If you want something more complex, define them by hand.
326 * The first parameter to each macro is the class name to define, the second parameter is the return value of Call().
327 * The following parameters are the parameter types for Call(), and again, the macro is numbered to match the number of
328 * parameters, to prevent mistakes.
330 #define DEFINE_HANDLER0(NAME, RETURN) \
331 class CoreExport NAME : public HandlerBase0<RETURN> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(); }
333 #define DEFINE_HANDLER1(NAME, RETURN, V1) \
334 class CoreExport NAME : public HandlerBase1<RETURN, V1> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1); }
336 #define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \
337 class CoreExport NAME : public HandlerBase2<RETURN, V1, V2> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2); }
339 #define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \
340 class CoreExport NAME : public HandlerBase3<RETURN, V1, V2, V3> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3); }
342 #define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \
343 class CoreExport NAME : public HandlerBase4<RETURN, V1, V2, V3, V4> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4); }
345 #define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \
346 class CoreExport NAME : public HandlerBase5<RETURN, V1, V2, V3, V4, V5> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5); }
348 #define DEFINE_HANDLER6(NAME, RETURN, V1, V2, V3, V4, V5, V6) \
349 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); }
351 #define DEFINE_HANDLER7(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7) \
352 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); }
354 #define DEFINE_HANDLER8(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7, V8) \
355 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); }