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/>.
24 #if defined HAS_CXX11_VARIADIC_TEMPLATES
26 template<typename ReturnType, typename... Args> class CoreExport Handler : public classbase
29 virtual ~Handler() { }
30 virtual ReturnType Call(Args...) = 0;
33 template<typename ReturnType, typename... Args> class CoreExport Caller
36 Handler<ReturnType, Args...>* target;
38 Caller(Handler<ReturnType, Args...>* initial) : target(initial) { }
41 virtual ReturnType operator()(const Args&... params)
43 return this->target->Call(params...);
47 /* Below here is compat with the old API */
48 #define HandlerBase0 Handler
49 #define HandlerBase1 Handler
50 #define HandlerBase2 Handler
51 #define HandlerBase3 Handler
52 #define HandlerBase4 Handler
53 #define HandlerBase5 Handler
54 #define HandlerBase6 Handler
55 #define HandlerBase7 Handler
56 #define HandlerBase8 Handler
58 #define caller1 Caller
59 #define caller2 Caller
60 #define caller3 Caller
61 #define caller4 Caller
62 #define caller5 Caller
63 #define caller6 Caller
64 #define caller7 Caller
65 #define caller8 Caller
67 #define DEFINE_HANDLER0(NAME, RETURN) \
68 class CoreExport NAME : public Handler<RETURN> { public: NAME() { } virtual RETURN Call(); }
70 #define DEFINE_HANDLER1(NAME, RETURN, V1) \
71 class CoreExport NAME : public Handler<RETURN, V1> { public: NAME() { } virtual RETURN Call(V1); }
73 #define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \
74 class CoreExport NAME : public Handler<RETURN, V1, V2> { public: NAME() { } virtual RETURN Call(V1, V2); }
76 #define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \
77 class CoreExport NAME : public Handler<RETURN, V1, V2, V3> { public: NAME() { } virtual RETURN Call(V1, V2, V3); }
79 #define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \
80 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4); }
82 #define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \
83 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4, V5> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5); }
85 #define DEFINE_HANDLER6(NAME, RETURN, V1, V2, V3, V4, V5, V6) \
86 class CoreExport NAME : public Handler<RETURN, V1, V2, V3, V4, V5, V6> { public: NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6); }
88 #define DEFINE_HANDLER7(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7) \
89 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); }
91 #define DEFINE_HANDLER8(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7, V8) \
92 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); }
96 /** The templates below can be auto generated by tools/create_templates.pl.
97 * They are used to represent a functor with a given number of parameters and
98 * a specific return type. To prevent passing the wrong number of parameters
99 * and have the compiler detect this error at build-time, each class is numbered
100 * according to the number of parameters it takes, e.g. caller0, caller1, caller2.
101 * These have been generated from zero parameters to eight.
103 * If you want to declare a functor which takes two parameters, a User and a Channel,
104 * and returns bool, simply create it like this:
106 * caller2<bool, User*, Channel*> MyFunction;
108 * and initialize it correctly, when placed into a class you will be able to call it:
110 * bool n = someclass->MyFunction(someuser, somechan);
112 * These functor templates work this way so that you can simply and easily allow
113 * for these class methods to be overridden from within a module, e.g. have a module
114 * which completely replaces the code for IsNick, etc. For example, with the example
117 * MyNewFunction replaceme(ServerInstance);
119 * someclass->MyFunction = \&replaceme;
121 * After this point, calls to someclass->MyFunction will call the new code in your
122 * replacement functor.
124 * This is a very powerful feature which should be considered 'advanced' and not for
125 * beginners. If you do not understand these templates, STAY AWAY from playing with
126 * this until you do, as if you get this wrong, this can generate some pretty long
127 * winded and confusing error messages at compile time.
129 template <typename ReturnType> class CoreExport HandlerBase0 : public classbase
132 virtual ReturnType Call() = 0;
133 virtual ~HandlerBase0() { }
136 template <typename ReturnType, typename Param1> class CoreExport HandlerBase1 : public classbase
139 virtual ReturnType Call(Param1) = 0;
140 virtual ~HandlerBase1() { }
143 template <typename ReturnType, typename Param1, typename Param2> class CoreExport HandlerBase2 : public classbase
146 virtual ReturnType Call(Param1, Param2) = 0;
147 virtual ~HandlerBase2() { }
150 template <typename ReturnType, typename Param1, typename Param2, typename Param3> class CoreExport HandlerBase3 : public classbase
153 virtual ReturnType Call(Param1, Param2, Param3) = 0;
154 virtual ~HandlerBase3() { }
157 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4> class CoreExport HandlerBase4 : public classbase
160 virtual ReturnType Call(Param1, Param2, Param3, Param4) = 0;
161 virtual ~HandlerBase4() { }
164 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5> class CoreExport HandlerBase5 : public classbase
167 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5) = 0;
168 virtual ~HandlerBase5() { }
171 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6> class CoreExport HandlerBase6 : public classbase
174 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6) = 0;
175 virtual ~HandlerBase6() { }
178 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7> class CoreExport HandlerBase7 : public classbase
181 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7) = 0;
182 virtual ~HandlerBase7() { }
185 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7, typename Param8> class CoreExport HandlerBase8 : public classbase
188 virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8) = 0;
189 virtual ~HandlerBase8() { }
192 template <typename HandlerType> class caller
197 caller(HandlerType* initial)
201 virtual ~caller() { }
204 template <typename ReturnType> class caller0 : public caller< HandlerBase0<ReturnType> >
207 caller0(HandlerBase0<ReturnType>* initial)
208 : caller< HandlerBase0<ReturnType> >::caller(initial)
211 ReturnType operator() ()
213 return this->target->Call();
217 template <typename ReturnType, typename Param1> class caller1 : public caller< HandlerBase1<ReturnType, Param1> >
220 caller1(HandlerBase1<ReturnType, Param1>* initial)
221 : caller< HandlerBase1<ReturnType, Param1> >(initial)
224 ReturnType operator() (Param1 param1)
226 return this->target->Call(param1);
230 template <typename ReturnType, typename Param1, typename Param2> class caller2 : public caller< HandlerBase2<ReturnType, Param1, Param2> >
233 caller2(HandlerBase2<ReturnType, Param1, Param2>* initial)
234 : caller< HandlerBase2<ReturnType, Param1, Param2> >(initial)
237 ReturnType operator() (Param1 param1, Param2 param2)
239 return this->target->Call(param1, param2);
243 template <typename ReturnType, typename Param1, typename Param2, typename Param3> class caller3 : public caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >
246 caller3(HandlerBase3<ReturnType, Param1, Param2, Param3>* initial)
247 : caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >(initial)
250 ReturnType operator() (Param1 param1, Param2 param2, Param3 param3)
252 return this->target->Call(param1, param2, param3);
256 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4> class caller4 : public caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >
259 caller4(HandlerBase4<ReturnType, Param1, Param2, Param3, Param4>* initial)
260 : caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >(initial)
263 ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4)
265 return this->target->Call(param1, param2, param3, param4);
269 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5> class caller5 : public caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >
272 caller5(HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5>* initial)
273 : caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >(initial)
276 ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5)
278 return this->target->Call(param1, param2, param3, param4, param5);
282 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6> class caller6 : public caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >
285 caller6(HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6>* initial)
286 : caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >(initial)
289 ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6)
291 return this->target->Call(param1, param2, param3, param4, param5, param6);
295 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7> class caller7 : public caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >
298 caller7(HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7>* initial)
299 : caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >(initial)
302 ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7)
304 return this->target->Call(param1, param2, param3, param4, param5, param6, param7);
308 template <typename ReturnType, typename Param1, typename Param2, typename Param3, typename Param4, typename Param5, typename Param6, typename Param7, typename Param8> class caller8 : public caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >
311 caller8(HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8>* initial)
312 : caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >(initial)
315 ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7, Param8 param8)
317 return this->target->Call(param1, param2, param3, param4, param5, param6, param7, param8);
321 /** These shorthand macros are used to define a functor class which only implements Call(). Most functors are like this.
322 * If you want something more complex, define them by hand.
324 * The first parameter to each macro is the class name to define, the second parameter is the return value of Call().
325 * The following parameters are the parameter types for Call(), and again, the macro is numbered to match the number of
326 * parameters, to prevent mistakes.
328 #define DEFINE_HANDLER0(NAME, RETURN) \
329 class CoreExport NAME : public HandlerBase0<RETURN> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(); }
331 #define DEFINE_HANDLER1(NAME, RETURN, V1) \
332 class CoreExport NAME : public HandlerBase1<RETURN, V1> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1); }
334 #define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \
335 class CoreExport NAME : public HandlerBase2<RETURN, V1, V2> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2); }
337 #define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \
338 class CoreExport NAME : public HandlerBase3<RETURN, V1, V2, V3> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3); }
340 #define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \
341 class CoreExport NAME : public HandlerBase4<RETURN, V1, V2, V3, V4> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4); }
343 #define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \
344 class CoreExport NAME : public HandlerBase5<RETURN, V1, V2, V3, V4, V5> { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5); }
346 #define DEFINE_HANDLER6(NAME, RETURN, V1, V2, V3, V4, V5, V6) \
347 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); }
349 #define DEFINE_HANDLER7(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7) \
350 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); }
352 #define DEFINE_HANDLER8(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7, V8) \
353 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); }