X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcaller.h;h=77fa5de40e799ae2fb1eafbbf0a75662afcc1248;hb=ffc039651676e0f679726b15fac4bf133e7e5bc2;hp=328aed2c92aa6fb71157a9a53da98d4610d722dd;hpb=0143364a29bb468612b7df5b47af6f6d20a9211a;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/caller.h b/include/caller.h
index 328aed2c9..77fa5de40 100644
--- a/include/caller.h
+++ b/include/caller.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -14,6 +14,39 @@
 #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 User and a Channel,
+ * and returns bool, simply create it like this:
+ *
+ * caller2<bool, User*, Channel*> MyFunction;
+ *
+ * and initialize it correctly, when placed into a class you will be able to call it:
+ *
+ * bool n = someclass->MyFunction(someuser, somechan);
+ *
+ * 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 f r 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 <typename ReturnType> class CoreExport HandlerBase0
 {
  public:
@@ -112,7 +145,7 @@ template <typename ReturnType, typename Param1> class CoreExport caller1 : publi
 {
  public:
 	caller1(HandlerBase1<ReturnType, Param1>* initial)
-	: caller< HandlerBase1<ReturnType, Param1> >::caller(initial)
+	: caller< HandlerBase1<ReturnType, Param1> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1)
@@ -125,7 +158,7 @@ template <typename ReturnType, typename Param1, typename Param2> class CoreExpor
 {
  public:
 	caller2(HandlerBase2<ReturnType, Param1, Param2>* initial)
-	: caller< HandlerBase2<ReturnType, Param1, Param2> >::caller(initial)
+	: caller< HandlerBase2<ReturnType, Param1, Param2> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2)
@@ -138,7 +171,7 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 {
  public:
 	caller3(HandlerBase3<ReturnType, Param1, Param2, Param3>* initial)
-	: caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >::caller(initial)
+	: caller< HandlerBase3<ReturnType, Param1, Param2, Param3> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3)
@@ -151,7 +184,7 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 {
  public:
 	caller4(HandlerBase4<ReturnType, Param1, Param2, Param3, Param4>* initial)
-	: caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >::caller(initial)
+	: caller< HandlerBase4<ReturnType, Param1, Param2, Param3, Param4> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4)
@@ -164,7 +197,7 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 {
  public:
 	caller5(HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5>* initial)
-	: caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >::caller(initial)
+	: caller< HandlerBase5<ReturnType, Param1, Param2, Param3, Param4, Param5> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5)
@@ -177,7 +210,7 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 {
  public:
 	caller6(HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6>* initial)
-	: caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >::caller(initial)
+	: caller< HandlerBase6<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6)
@@ -190,7 +223,7 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 {
  public:
 	caller7(HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7>* initial)
-	: caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >::caller(initial)
+	: caller< HandlerBase7<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7)
@@ -203,7 +236,7 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 {
  public:
 	caller8(HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8>* initial)
-	: caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >::caller(initial)
+	: caller< HandlerBase8<ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8> >(initial)
 	{ }
 
 	virtual ReturnType operator() (Param1 param1, Param2 param2, Param3 param3, Param4 param4, Param5 param5, Param6 param6, Param7 param7, Param8 param8)
@@ -212,5 +245,39 @@ template <typename ReturnType, typename Param1, typename Param2, typename Param3
 	}
 };
 
+/** 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<RETURN> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(); }
+
+#define DEFINE_HANDLER1(NAME, RETURN, V1) \
+	class CoreExport NAME : public HandlerBase1<RETURN, V1> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V1); }
+
+#define DEFINE_HANDLER2(NAME, RETURN, V1, V2) \
+	class CoreExport NAME : public HandlerBase2<RETURN, V1, V2> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V1, V2); }
+
+#define DEFINE_HANDLER3(NAME, RETURN, V1, V2, V3) \
+	class CoreExport NAME : public HandlerBase3<RETURN, V1, V2, V3> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3); }
+
+#define DEFINE_HANDLER4(NAME, RETURN, V1, V2, V3, V4) \
+	class CoreExport NAME : public HandlerBase4<RETURN, V1, V2, V3, V4> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4); }
+
+#define DEFINE_HANDLER5(NAME, RETURN, V1, V2, V3, V4, V5) \
+	class CoreExport NAME : public HandlerBase5<RETURN, V1, V2, V3, V4, V5> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } 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<RETURN, V1, V2, V3, V4, V5, V6> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } 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<RETURN, V1, V2, V3, V4, V5, V6, V7> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } 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<RETURN, V1, V2, V3, V4, V5, V6, V7, V8> { InspIRCd* Server; public: NAME(InspIRCd* Srv) : Server(Srv) { } virtual ~NAME() { } virtual RETURN Call(V1, V2, V3, V4, V5, V6, V7, V8); }
+
 #endif