X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcaller.h;h=40574771efff63b5e5c678b0f50f85f160da8009;hb=402a1bb010522a35600325c1a3084e092b40ca22;hp=396a5ba5a660c9da4f2813e49b6c28c4fe5591e9;hpb=529f16e84b4ba1328a13be32e40a71156c4725f8;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/caller.h b/include/caller.h index 396a5ba5a..40574771e 100644 --- a/include/caller.h +++ b/include/caller.h @@ -1,30 +1,37 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __CALLER__H__ -#define __CALLER__H__ -/* The templates below can be auto generated by tools/create_templates.pl. +#ifndef CALLER_H +#define CALLER_H + +/** The templates below can be auto generated by tools/create_templates.pl. * They are used to represent a functor with a given number of parameters and * a specific return type. To prevent passing the wrong number of parameters * and have the compiler detect this error at build-time, each class is numbered * according to the number of parameters it takes, e.g. caller0, caller1, caller2. * These have been generated from zero parameters to eight. * - * If you want to declare a functor which takes two parameters, a userrec and a chanrec, + * If you want to declare a functor which takes two parameters, a User and a Channel, * and returns bool, simply create it like this: * - * caller2 MyFunction; + * caller2 MyFunction; * * and initialize it correctly, when placed into a class you will be able to call it: * @@ -32,77 +39,85 @@ * * These functor templates work this way so that you can simply and easily allow * for these class methods to be overridden from within a module, e.g. have a module - * which completely replaces the code for IsNick, etc. This is a very powerful feature - * which should be considered 'advanced' and not for beginners. If you do not - * understand these templates, STAY AWAY from playing with this until you do, as if - * you get this wrong, this can generate some pretty long winded and confusing error - * messages at compile time. + * which completely replaces the code for IsNick, etc. For example, with the example + * above: + * + * MyNewFunction replaceme(ServerInstance); + * + * someclass->MyFunction = \&replaceme; + * + * After this point, calls to someclass->MyFunction will call the new code in your + * replacement functor. + * + * This is a very powerful feature which should be considered 'advanced' and not for + * beginners. If you do not understand these templates, STAY AWAY from playing with + * this until you do, as if you get this wrong, this can generate some pretty long + * winded and confusing error messages at compile time. */ - -template class CoreExport HandlerBase0 +template class CoreExport HandlerBase0 : public classbase { public: virtual ReturnType Call() = 0; virtual ~HandlerBase0() { } }; -template class CoreExport HandlerBase1 +template class CoreExport HandlerBase1 : public classbase { public: virtual ReturnType Call(Param1) = 0; virtual ~HandlerBase1() { } }; -template class CoreExport HandlerBase2 +template class CoreExport HandlerBase2 : public classbase { public: virtual ReturnType Call(Param1, Param2) = 0; virtual ~HandlerBase2() { } }; -template class CoreExport HandlerBase3 +template class CoreExport HandlerBase3 : public classbase { public: virtual ReturnType Call(Param1, Param2, Param3) = 0; virtual ~HandlerBase3() { } }; -template class CoreExport HandlerBase4 +template class CoreExport HandlerBase4 : public classbase { public: virtual ReturnType Call(Param1, Param2, Param3, Param4) = 0; virtual ~HandlerBase4() { } }; -template class CoreExport HandlerBase5 +template class CoreExport HandlerBase5 : public classbase { public: virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5) = 0; virtual ~HandlerBase5() { } }; -template class CoreExport HandlerBase6 +template class CoreExport HandlerBase6 : public classbase { public: virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6) = 0; virtual ~HandlerBase6() { } }; -template class CoreExport HandlerBase7 +template class CoreExport HandlerBase7 : public classbase { public: virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7) = 0; virtual ~HandlerBase7() { } }; -template class CoreExport HandlerBase8 +template class CoreExport HandlerBase8 : public classbase { public: virtual ReturnType Call(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8) = 0; virtual ~HandlerBase8() { } }; -template class CoreExport caller +template class caller { public: HandlerType* target; @@ -112,139 +127,157 @@ template class CoreExport caller { } virtual ~caller() { } - - caller& operator=(HandlerType* newtarget) - { - target = newtarget; - return *this; - } }; -template class CoreExport caller0 : public caller< HandlerBase0 > +template class caller0 : public caller< HandlerBase0 > { public: caller0(HandlerBase0* initial) : caller< HandlerBase0 >::caller(initial) { } - virtual ReturnType operator() () + ReturnType operator() () { return this->target->Call(); } }; -template class CoreExport caller1 : public caller< HandlerBase1 > +template class caller1 : public caller< HandlerBase1 > { public: caller1(HandlerBase1* initial) - : caller< HandlerBase1 >::caller(initial) + : caller< HandlerBase1 >(initial) { } - virtual ReturnType operator() (Param1 param1) + ReturnType operator() (Param1 param1) { return this->target->Call(param1); } }; -template class CoreExport caller2 : public caller< HandlerBase2 > +template class caller2 : public caller< HandlerBase2 > { public: caller2(HandlerBase2* initial) - : caller< HandlerBase2 >::caller(initial) + : caller< HandlerBase2 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2) + ReturnType operator() (Param1 param1, Param2 param2) { return this->target->Call(param1, param2); } }; -template class CoreExport caller3 : public caller< HandlerBase3 > +template class caller3 : public caller< HandlerBase3 > { public: caller3(HandlerBase3* initial) - : caller< HandlerBase3 >::caller(initial) + : caller< HandlerBase3 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3) + ReturnType operator() (Param1 param1, Param2 param2, Param3 param3) { return this->target->Call(param1, param2, param3); } }; -template class CoreExport caller4 : public caller< HandlerBase4 > +template class caller4 : public caller< HandlerBase4 > { public: caller4(HandlerBase4* initial) - : caller< HandlerBase4 >::caller(initial) + : caller< HandlerBase4 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4) + ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4) { return this->target->Call(param1, param2, param3, param4); } }; -template class CoreExport caller5 : public caller< HandlerBase5 > +template class caller5 : public caller< HandlerBase5 > { public: caller5(HandlerBase5* initial) - : caller< HandlerBase5 >::caller(initial) + : caller< HandlerBase5 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5) + ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5) { return this->target->Call(param1, param2, param3, param4, param5); } }; -template class CoreExport caller6 : public caller< HandlerBase6 > +template class caller6 : public caller< HandlerBase6 > { public: caller6(HandlerBase6* initial) - : caller< HandlerBase6 >::caller(initial) + : caller< HandlerBase6 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6) + ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6) { return this->target->Call(param1, param2, param3, param4, param5, param6); } }; -template class CoreExport caller7 : public caller< HandlerBase7 > +template class caller7 : public caller< HandlerBase7 > { public: caller7(HandlerBase7* initial) - : caller< HandlerBase7 >::caller(initial) + : caller< HandlerBase7 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7) + ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7) { return this->target->Call(param1, param2, param3, param4, param5, param6, param7); } }; -template class CoreExport caller8 : public caller< HandlerBase8 > +template class caller8 : public caller< HandlerBase8 > { public: caller8(HandlerBase8* initial) - : caller< HandlerBase8 >::caller(initial) + : caller< HandlerBase8 >(initial) { } - virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7, Param8 param8) + ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7, Param8 param8) { return this->target->Call(param1, param2, param3, param4, param5, param6, param7, param8); } }; +/** These shorthand macros are used to define a functor class which only implements Call(). Most functors are like this. + * If you want something more complex, define them by hand. + * + * The first parameter to each macro is the class name to define, the second parameter is the return value of Call(). + * The following parameters are the parameter types for Call(), and again, the macro is numbered to match the number of + * parameters, to prevent mistakes. + */ #define DEFINE_HANDLER0(NAME, RETURN) \ - class CoreExport NAME : public HandlerBase0 { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(); }; + class CoreExport NAME : public HandlerBase0 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(); } #define DEFINE_HANDLER1(NAME, RETURN, V1) \ - class CoreExport NAME : public HandlerBase1 { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V1); }; + class CoreExport NAME : public HandlerBase1 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1); } #define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \ - class CoreExport NAME : public HandlerBase2 { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V2); }; + class CoreExport NAME : public HandlerBase2 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2); } -#endif +#define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \ + class CoreExport NAME : public HandlerBase3 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3); } + +#define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \ + class CoreExport NAME : public HandlerBase4 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4); } + +#define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \ + class CoreExport NAME : public HandlerBase5 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5); } +#define DEFINE_HANDLER6(NAME, RETURN, V1, V2, V3, V4, V5, V6) \ + class CoreExport NAME : public HandlerBase6 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6); } + +#define DEFINE_HANDLER7(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7) \ + class CoreExport NAME : public HandlerBase7 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7); } + +#define DEFINE_HANDLER8(NAME, RETURN, V1, V2, V3, V4, V5, V6, V7, V8) \ + class CoreExport NAME : public HandlerBase8 { public: NAME() { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7, V8); } + +#endif