2 // Efficient delegates in C++ that generate only two lines of asm code!
3 // Documentation is found at http://www.codeproject.com/cpp/FastDelegate.asp
5 // - Don Clugston, Mar 2004.
6 // Major contributions were made by Jody Hagins.
8 // 24-Apr-04 1.0 Submitted to CodeProject.
9 // 28-Apr-04 1.1 * Prevent most unsafe uses of evil static function hack.
10 // * Improved syntax for horrible_cast (thanks Paul Bludov).
11 // * Tested on Metrowerks MWCC and Intel ICL (IA32)
12 // * Compiled, but not run, on Comeau C++ and Intel Itanium ICL.
13 // 27-Jun-04 1.2 * Now works on Borland C++ Builder 5.5
14 // * Now works on /clr "managed C++" code on VC7, VC7.1
15 // * Comeau C++ now compiles without warnings.
16 // * Prevent the virtual inheritance case from being used on
17 // VC6 and earlier, which generate incorrect code.
18 // * Improved warning and error messages. Non-standard hacks
19 // now have compile-time checks to make them safer.
20 // * implicit_cast used instead of static_cast in many cases.
21 // * If calling a const member function, a const class pointer can be used.
22 // * MakeDelegate() global helper function added to simplify pass-by-value.
23 // * Added fastdelegate.clear()
24 // 16-Jul-04 1.2.1* Workaround for gcc bug (const member function pointers in templates)
25 // 30-Oct-04 1.3 * Support for (non-void) return values.
26 // * No more workarounds in client code!
27 // MSVC and Intel now use a clever hack invented by John Dlugosz:
28 // - The FASTDELEGATEDECLARE workaround is no longer necessary.
29 // - No more warning messages for VC6
30 // * Less use of macros. Error messages should be more comprehensible.
31 // * Added include guards
32 // * Added FastDelegate::empty() to test if invocation is safe (Thanks Neville Franks).
33 // * Now tested on VS 2005 Beta, PGI C++
34 // 24-Dec-04 1.4 * Added DelegateMemento, to allow collections of disparate delegates.
35 // * <,>,<=,>= comparison operators to allow storage in ordered containers.
36 // * Substantial reduction of code size, especially the 'Closure' class.
37 // * Standardised all the compiler-specific workarounds.
38 // * MFP conversion now works for CodePlay (but not yet supported in the full code).
39 // * Now compiles without warnings on _any_ compiler, including BCC 5.5.1
40 // * New syntax: FastDelegate< int (char *, double) >.
42 #ifndef FASTDELEGATE_H
43 #define FASTDELEGATE_H
48 # endif // _MSC_VER > 1000
49 #endif // #ifdef _MSC_VER
51 #include <memory.h> // to allow <,> comparisons
53 ////////////////////////////////////////////////////////////////////////////////
54 // Configuration options
56 ////////////////////////////////////////////////////////////////////////////////
58 // Uncomment the following #define for optimally-sized delegates.
59 // In this case, the generated asm code is almost identical to the code you'd get
60 // if the compiler had native support for delegates.
61 // It will not work on systems where sizeof(dataptr) < sizeof(codeptr).
62 // Thus, it will not work for DOS compilers using the medium model.
63 // It will also probably fail on some DSP systems.
64 #define FASTDELEGATE_USESTATICFUNCTIONHACK
66 // Uncomment the next line to allow function declarator syntax.
67 // It is automatically enabled for those compilers where it is known to work.
68 //#define FASTDELEGATE_ALLOW_FUNCTION_TYPE_SYNTAX
70 ////////////////////////////////////////////////////////////////////////////////
71 // Compiler identification for workarounds
73 ////////////////////////////////////////////////////////////////////////////////
75 // Compiler identification. It's not easy to identify Visual C++ because
76 // many vendors fraudulently define Microsoft's identifiers.
77 #if defined(_MSC_VER) && !defined(__MWERKS__) && !defined(__VECTOR_C) && !defined(__ICL) && !defined(__BORLANDC__)
78 #define FASTDLGT_ISMSVC
80 #if (_MSC_VER <1300) // Many workarounds are required for VC6.
82 #pragma warning(disable:4786) // disable this ridiculous warning
87 // Does the compiler uses Microsoft's member function pointer structure?
88 // If so, it needs special treatment.
89 // Metrowerks CodeWarrior, Intel, and CodePlay fraudulently define Microsoft's
90 // identifier, _MSC_VER. We need to filter Metrowerks out.
91 #if defined(_MSC_VER) && !defined(__MWERKS__)
92 #define FASTDLGT_MICROSOFT_MFP
94 #if !defined(__VECTOR_C)
95 // CodePlay doesn't have the __single/multi/virtual_inheritance keywords
96 #define FASTDLGT_HASINHERITANCE_KEYWORDS
100 // Does it allow function declarator syntax? The following compilers are known to work:
101 #if defined(FASTDLGT_ISMSVC) && (_MSC_VER >=1310) // VC 7.1
102 #define FASTDELEGATE_ALLOW_FUNCTION_TYPE_SYNTAX
105 // Gcc(2.95+), and versions of Digital Mars, Intel and Comeau in common use.
106 #if defined (__DMC__) || defined(__GNUC__) || defined(__ICL) || defined(__COMO__)
107 #define FASTDELEGATE_ALLOW_FUNCTION_TYPE_SYNTAX
110 // It works on Metrowerks MWCC 3.2.2. From boost.Config it should work on earlier ones too.
111 #if defined (__MWERKS__)
112 #define FASTDELEGATE_ALLOW_FUNCTION_TYPE_SYNTAX
115 #ifdef __GNUC__ // Workaround GCC bug #8271
116 // At present, GCC doesn't recognize constness of MFPs in templates
117 #define FASTDELEGATE_GCC_BUG_8271
122 ////////////////////////////////////////////////////////////////////////////////
123 // General tricks used in this code
125 // (a) Error messages are generated by typdefing an array of negative size to
126 // generate compile-time errors.
127 // (b) Warning messages on MSVC are generated by declaring unused variables, and
128 // enabling the "variable XXX is never used" warning.
129 // (c) Unions are used in a few compiler-specific cases to perform illegal casts.
130 // (d) For Microsoft and Intel, when adjusting the 'this' pointer, it's cast to
131 // (char *) first to ensure that the correct number of *bytes* are added.
133 ////////////////////////////////////////////////////////////////////////////////
136 ////////////////////////////////////////////////////////////////////////////////
139 namespace fastdelegate {
140 namespace detail { // we'll hide the implementation details in a nested namespace.
143 // I believe this was originally going to be in the C++ standard but
144 // was left out by accident. It's even milder than static_cast.
145 // I use it instead of static_cast<> to emphasize that I'm not doing
147 // Usage is identical to static_cast<>
148 template <class OutputClass, class InputClass>
149 inline OutputClass implicit_cast(InputClass input){
154 // This is truly evil. It completely subverts C++'s type system, allowing you
155 // to cast from any class to any other class. Technically, using a union
156 // to perform the cast is undefined behaviour (even in C). But we can see if
157 // it is OK by checking that the union is the same size as each of its members.
158 // horrible_cast<> should only be used for compiler-specific workarounds.
159 // Usage is identical to reinterpret_cast<>.
161 // This union is declared outside the horrible_cast because BCC 5.5.1
162 // can't inline a function with a nested class, and gives a warning.
163 template <class OutputClass, class InputClass>
164 union horrible_union{
169 template <class OutputClass, class InputClass>
170 inline OutputClass horrible_cast(const InputClass input){
171 horrible_union<OutputClass, InputClass> u;
172 // Cause a compile-time error if in, out and u are not the same size.
173 // If the compile fails here, it means the compiler has peculiar
174 // unions which would prevent the cast from working.
175 typedef int ERROR_CantUseHorrible_cast[sizeof(InputClass)==sizeof(u)
176 && sizeof(InputClass)==sizeof(OutputClass) ? 1 : -1];
181 ////////////////////////////////////////////////////////////////////////////////
184 ////////////////////////////////////////////////////////////////////////////////
186 // Backwards compatibility: This macro used to be necessary in the virtual inheritance
187 // case for Intel and Microsoft. Now it just forward-declares the class.
188 #define FASTDELEGATEDECLARE(CLASSNAME) class CLASSNAME;
190 // Prevent use of the static function hack with the DOS medium model.
192 #undef FASTDELEGATE_USESTATICFUNCTIONHACK
195 // DefaultVoid - a workaround for 'void' templates in VC6.
197 // (1) VC6 and earlier do not allow 'void' as a default template argument.
198 // (2) They also doesn't allow you to return 'void' from a function.
200 // Workaround for (1): Declare a dummy type 'DefaultVoid' which we use
201 // when we'd like to use 'void'. We convert it into 'void' and back
202 // using the templates DefaultVoidToVoid<> and VoidToDefaultVoid<>.
203 // Workaround for (2): On VC6, the code for calling a void function is
204 // identical to the code for calling a non-void function in which the
205 // return value is never used, provided the return value is returned
206 // in the EAX register, rather than on the stack.
207 // This is true for most fundamental types such as int, enum, void *.
208 // Const void * is the safest option since it doesn't participate
209 // in any automatic conversions. But on a 16-bit compiler it might
210 // cause extra code to be generated, so we disable it for all compilers
211 // except for VC6 (and VC5).
214 typedef const void * DefaultVoid;
216 // On any other compiler, just use a normal void.
217 typedef void DefaultVoid;
220 // Translate from 'DefaultVoid' to 'void'.
221 // Everything else is unchanged
223 struct DefaultVoidToVoid { typedef T type; };
226 struct DefaultVoidToVoid<DefaultVoid> { typedef void type; };
228 // Translate from 'void' into 'DefaultVoid'
229 // Everything else is unchanged
231 struct VoidToDefaultVoid { typedef T type; };
234 struct VoidToDefaultVoid<void> { typedef DefaultVoid type; };
238 ////////////////////////////////////////////////////////////////////////////////
239 // Fast Delegates, part 1:
241 // Conversion of member function pointer to a standard form
243 ////////////////////////////////////////////////////////////////////////////////
245 // GenericClass is a fake class, ONLY used to provide a type.
246 // It is vitally important that it is never defined, so that the compiler doesn't
247 // think it can optimize the invocation. For example, Borland generates simpler
248 // code if it knows the class only uses single inheritance.
250 // Compilers using Microsoft's structure need to be treated as a special case.
251 #ifdef FASTDLGT_MICROSOFT_MFP
253 #ifdef FASTDLGT_HASINHERITANCE_KEYWORDS
254 // For Microsoft and Intel, we want to ensure that it's the most efficient type of MFP
255 // (4 bytes), even when the /vmg option is used. Declaring an empty class
256 // would give 16 byte pointers in this case....
257 class __single_inheritance GenericClass;
259 // ...but for Codeplay, an empty class *always* gives 4 byte pointers.
260 // If compiled with the /clr option ("managed C++"), the JIT compiler thinks
261 // it needs to load GenericClass before it can call any of its functions,
262 // (compiles OK but crashes at runtime!), so we need to declare an
263 // empty class to make it happy.
264 // Codeplay and VC4 can't cope with the unknown_inheritance case either.
265 class GenericClass {};
270 // The size of a single inheritance member function pointer.
271 const int SINGLE_MEMFUNCPTR_SIZE = sizeof(void (GenericClass::*)());
273 // SimplifyMemFunc< >::Convert()
275 // A template function that converts an arbitrary member function pointer into the
276 // simplest possible form of member function pointer, using a supplied 'this' pointer.
277 // According to the standard, this can be done legally with reinterpret_cast<>.
278 // For (non-standard) compilers which use member function pointers which vary in size
279 // depending on the class, we need to use knowledge of the internal structure of a
280 // member function pointer, as used by the compiler. Template specialization is used
281 // to distinguish between the sizes. Because some compilers don't support partial
282 // template specialisation, I use full specialisation of a wrapper struct.
284 // general case -- don't know how to convert it. Force a compile failure
286 struct SimplifyMemFunc {
287 template <class X, class XFuncType, class GenericMemFuncType>
288 inline static GenericClass *Convert(X *pthis, XFuncType function_to_bind,
289 GenericMemFuncType &bound_func) {
290 // Unsupported member function type -- force a compile failure.
291 // (it's illegal to have a array with negative size).
292 typedef char ERROR_Unsupported_member_function_pointer_on_this_compiler[N-100];
297 // For compilers where all member func ptrs are the same size, everything goes here.
298 // For non-standard compilers, only single_inheritance classes go here.
300 struct SimplifyMemFunc<SINGLE_MEMFUNCPTR_SIZE> {
301 template <class X, class XFuncType, class GenericMemFuncType>
302 inline static GenericClass *Convert(X *pthis, XFuncType function_to_bind,
303 GenericMemFuncType &bound_func) {
305 // Digital Mars doesn't allow you to cast between abitrary PMF's,
306 // even though the standard says you can. The 32-bit compiler lets you
307 // static_cast through an int, but the DOS compiler doesn't.
308 bound_func = horrible_cast<GenericMemFuncType>(function_to_bind);
310 bound_func = reinterpret_cast<GenericMemFuncType>(function_to_bind);
312 return reinterpret_cast<GenericClass *>(pthis);
316 ////////////////////////////////////////////////////////////////////////////////
317 // Fast Delegates, part 1b:
319 // Workarounds for Microsoft and Intel
321 ////////////////////////////////////////////////////////////////////////////////
324 // Compilers with member function pointers which violate the standard (MSVC, Intel, Codeplay),
325 // need to be treated as a special case.
326 #ifdef FASTDLGT_MICROSOFT_MFP
328 // We use unions to perform horrible_casts. I would like to use #pragma pack(push, 1)
329 // at the start of each function for extra safety, but VC6 seems to ICE
330 // intermittently if you do this inside a template.
332 // __multiple_inheritance classes go here
333 // Nasty hack for Microsoft and Intel (IA32 and Itanium)
335 struct SimplifyMemFunc< SINGLE_MEMFUNCPTR_SIZE + sizeof(int) > {
336 template <class X, class XFuncType, class GenericMemFuncType>
337 inline static GenericClass *Convert(X *pthis, XFuncType function_to_bind,
338 GenericMemFuncType &bound_func) {
339 // We need to use a horrible_cast to do this conversion.
340 // In MSVC, a multiple inheritance member pointer is internally defined as:
344 GenericMemFuncType funcaddress; // points to the actual member function
345 int delta; // #BYTES to be added to the 'this' pointer
348 // Check that the horrible_cast will work
349 typedef int ERROR_CantUsehorrible_cast[sizeof(function_to_bind)==sizeof(u.s)? 1 : -1];
350 u.func = function_to_bind;
351 bound_func = u.s.funcaddress;
352 return reinterpret_cast<GenericClass *>(reinterpret_cast<char *>(pthis) + u.s.delta);
356 // virtual inheritance is a real nuisance. It's inefficient and complicated.
357 // On MSVC and Intel, there isn't enough information in the pointer itself to
358 // enable conversion to a closure pointer. Earlier versions of this code didn't
359 // work for all cases, and generated a compile-time error instead.
360 // But a very clever hack invented by John M. Dlugosz solves this problem.
361 // My code is somewhat different to his: I have no asm code, and I make no
362 // assumptions about the calling convention that is used.
364 // In VC++ and ICL, a virtual_inheritance member pointer
365 // is internally defined as:
366 struct MicrosoftVirtualMFP {
367 void (GenericClass::*codeptr)(); // points to the actual member function
368 int delta; // #bytes to be added to the 'this' pointer
369 int vtable_index; // or 0 if no virtual inheritance
371 // The CRUCIAL feature of Microsoft/Intel MFPs which we exploit is that the
372 // m_codeptr member is *always* called, regardless of the values of the other
373 // members. (This is *not* true for other compilers, eg GCC, which obtain the
374 // function address from the vtable if a virtual function is being called).
375 // Dlugosz's trick is to make the codeptr point to a probe function which
376 // returns the 'this' pointer that was used.
378 // Define a generic class that uses virtual inheritance.
379 // It has a trival member function that returns the value of the 'this' pointer.
380 struct GenericVirtualClass : virtual public GenericClass
382 typedef GenericVirtualClass * (GenericVirtualClass::*ProbePtrType)();
383 GenericVirtualClass * GetThis() { return this; }
386 // __virtual_inheritance classes go here
388 struct SimplifyMemFunc<SINGLE_MEMFUNCPTR_SIZE + 2*sizeof(int) >
391 template <class X, class XFuncType, class GenericMemFuncType>
392 inline static GenericClass *Convert(X *pthis, XFuncType function_to_bind,
393 GenericMemFuncType &bound_func) {
396 GenericClass* (X::*ProbeFunc)();
397 MicrosoftVirtualMFP s;
399 u.func = function_to_bind;
400 bound_func = reinterpret_cast<GenericMemFuncType>(u.s.codeptr);
402 GenericVirtualClass::ProbePtrType virtfunc;
403 MicrosoftVirtualMFP s;
405 // Check that the horrible_cast<>s will work
406 typedef int ERROR_CantUsehorrible_cast[sizeof(function_to_bind)==sizeof(u.s)
407 && sizeof(function_to_bind)==sizeof(u.ProbeFunc)
408 && sizeof(u2.virtfunc)==sizeof(u2.s) ? 1 : -1];
409 // Unfortunately, taking the address of a MF prevents it from being inlined, so
410 // this next line can't be completely optimised away by the compiler.
411 u2.virtfunc = &GenericVirtualClass::GetThis;
412 u.s.codeptr = u2.s.codeptr;
413 return (pthis->*u.ProbeFunc)();
419 // Nasty hack for Microsoft Visual C++ 6.0
420 // unknown_inheritance classes go here
421 // There is a compiler bug in MSVC6 which generates incorrect code in this case!!
423 struct SimplifyMemFunc<SINGLE_MEMFUNCPTR_SIZE + 3*sizeof(int) >
425 template <class X, class XFuncType, class GenericMemFuncType>
426 inline static GenericClass *Convert(X *pthis, XFuncType function_to_bind,
427 GenericMemFuncType &bound_func) {
428 // There is an apalling but obscure compiler bug in MSVC6 and earlier:
429 // vtable_index and 'vtordisp' are always set to 0 in the
430 // unknown_inheritance case!
431 // This means that an incorrect function could be called!!!
432 // Compiling with the /vmg option leads to potentially incorrect code.
433 // This is probably the reason that the IDE has a user interface for specifying
434 // the /vmg option, but it is disabled - you can only specify /vmg on
435 // the command line. In VC1.5 and earlier, the compiler would ICE if it ever
436 // encountered this situation.
437 // It is OK to use the /vmg option if /vmm or /vms is specified.
439 // Fortunately, the wrong function is only called in very obscure cases.
440 // It only occurs when a derived class overrides a virtual function declared
441 // in a virtual base class, and the member function
442 // points to the *Derived* version of that function. The problem can be
443 // completely averted in 100% of cases by using the *Base class* for the
444 // member fpointer. Ie, if you use the base class as an interface, you'll
445 // stay out of trouble.
446 // Occasionally, you might want to point directly to a derived class function
447 // that isn't an override of a base class. In this case, both vtable_index
448 // and 'vtordisp' are zero, but a virtual_inheritance pointer will be generated.
449 // We can generate correct code in this case. To prevent an incorrect call from
450 // ever being made, on MSVC6 we generate a warning, and call a function to
451 // make the program crash instantly.
452 typedef char ERROR_VC6CompilerBug[-100];
460 // Nasty hack for Microsoft and Intel (IA32 and Itanium)
461 // unknown_inheritance classes go here
462 // This is probably the ugliest bit of code I've ever written. Look at the casts!
463 // There is a compiler bug in MSVC6 which prevents it from using this code.
465 struct SimplifyMemFunc<SINGLE_MEMFUNCPTR_SIZE + 3*sizeof(int) >
467 template <class X, class XFuncType, class GenericMemFuncType>
468 inline static GenericClass *Convert(X *pthis, XFuncType function_to_bind,
469 GenericMemFuncType &bound_func) {
470 // The member function pointer is 16 bytes long. We can't use a normal cast, but
471 // we can use a union to do the conversion.
474 // In VC++ and ICL, an unknown_inheritance member pointer
475 // is internally defined as:
477 GenericMemFuncType m_funcaddress; // points to the actual member function
478 int delta; // #bytes to be added to the 'this' pointer
479 int vtordisp; // #bytes to add to 'this' to find the vtable
480 int vtable_index; // or 0 if no virtual inheritance
483 // Check that the horrible_cast will work
484 typedef int ERROR_CantUsehorrible_cast[sizeof(XFuncType)==sizeof(u.s)? 1 : -1];
485 u.func = function_to_bind;
486 bound_func = u.s.funcaddress;
487 int virtual_delta = 0;
488 if (u.s.vtable_index) { // Virtual inheritance is used
489 // First, get to the vtable.
490 // It is 'vtordisp' bytes from the start of the class.
491 const int * vtable = *reinterpret_cast<const int *const*>(
492 reinterpret_cast<const char *>(pthis) + u.s.vtordisp );
494 // 'vtable_index' tells us where in the table we should be looking.
495 virtual_delta = u.s.vtordisp + *reinterpret_cast<const int *>(
496 reinterpret_cast<const char *>(vtable) + u.s.vtable_index);
498 // The int at 'virtual_delta' gives us the amount to add to 'this'.
499 // Finally we can add the three components together. Phew!
500 return reinterpret_cast<GenericClass *>(
501 reinterpret_cast<char *>(pthis) + u.s.delta + virtual_delta);
504 #endif // MSVC 7 and greater
506 #endif // MS/Intel hacks
508 } // namespace detail
510 ////////////////////////////////////////////////////////////////////////////////
511 // Fast Delegates, part 2:
513 // Define the delegate storage, and cope with static functions
515 ////////////////////////////////////////////////////////////////////////////////
517 // DelegateMemento -- an opaque structure which can hold an arbitary delegate.
518 // It knows nothing about the calling convention or number of arguments used by
519 // the function pointed to.
520 // It supplies comparison operators so that it can be stored in STL collections.
521 // It cannot be set to anything other than null, nor invoked directly:
522 // it must be converted to a specific delegate.
525 // There are two possible implementations: the Safe method and the Evil method.
526 // DelegateMemento - Safe version
528 // This implementation is standard-compliant, but a bit tricky.
529 // A static function pointer is stored inside the class.
530 // Here are the valid values:
531 // +-- Static pointer --+--pThis --+-- pMemFunc-+-- Meaning------+
532 // | 0 | 0 | 0 | Empty |
533 // | !=0 |(dontcare)| Invoker | Static function|
534 // | 0 | !=0 | !=0 | Method call |
535 // +--------------------+----------+------------+----------------+
536 // When stored stored inside a specific delegate, the 'dontcare' entries are replaced
537 // with a reference to the delegate itself. This complicates the = and == operators
538 // for the delegate class.
540 // DelegateMemento - Evil version
542 // For compilers where data pointers are at least as big as code pointers, it is
543 // possible to store the function pointer in the this pointer, using another
544 // horrible_cast. In this case the DelegateMemento implementation is simple:
545 // +--pThis --+-- pMemFunc-+-- Meaning---------------------+
547 // | !=0 | !=0 | Static function or method call|
548 // +----------+------------+-------------------------------+
549 // Note that the Sun C++ and MSVC documentation explicitly state that they
550 // support static_cast between void * and function pointers.
552 class DelegateMemento {
554 // the data is protected, not private, because many
555 // compilers have problems with template friends.
556 typedef void (detail::GenericClass::*GenericMemFuncType)(); // arbitrary MFP.
557 detail::GenericClass *m_pthis;
558 GenericMemFuncType m_pFunction;
560 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
561 typedef void (*GenericFuncPtr)(); // arbitrary code pointer
562 GenericFuncPtr m_pStaticFunction;
566 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
567 DelegateMemento() : m_pthis(0), m_pFunction(0), m_pStaticFunction(0) {};
569 m_pthis=0; m_pFunction=0; m_pStaticFunction=0;
572 DelegateMemento() : m_pthis(0), m_pFunction(0) {};
574 m_pthis=0; m_pFunction=0;
578 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
579 inline bool IsEqual (const DelegateMemento &x) const{
580 // We have to cope with the static function pointers as a special case
581 if (m_pFunction!=x.m_pFunction) return false;
582 // the static function ptrs must either both be equal, or both be 0.
583 if (m_pStaticFunction!=x.m_pStaticFunction) return false;
584 if (m_pStaticFunction!=0) return m_pthis==x.m_pthis;
588 inline bool IsEqual (const DelegateMemento &x) const{
589 return m_pthis==x.m_pthis && m_pFunction==x.m_pFunction;
592 // Provide a strict weak ordering for DelegateMementos.
593 inline bool IsLess(const DelegateMemento &right) const {
594 // deal with static function pointers first
595 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
596 if (m_pStaticFunction !=0 || right.m_pStaticFunction!=0)
597 return m_pStaticFunction < right.m_pStaticFunction;
599 if (m_pthis !=right.m_pthis) return m_pthis < right.m_pthis;
600 // There are no ordering operators for member function pointers,
601 // but we can fake one by comparing each byte. The resulting ordering is
602 // arbitrary (and compiler-dependent), but it permits storage in ordered STL containers.
603 return memcmp(&m_pFunction, &right.m_pFunction, sizeof(m_pFunction)) < 0;
606 inline bool operator ! () const // Is it bound to anything?
607 { return m_pFunction==0; }
609 DelegateMemento & operator = (const DelegateMemento &right) {
610 SetMementoFrom(right);
613 inline bool operator <(const DelegateMemento &right) {
614 return IsLess(right);
616 inline bool operator >(const DelegateMemento &right) {
617 return right.IsLess(*this);
619 DelegateMemento (const DelegateMemento &right) :
620 m_pthis(right.m_pthis), m_pFunction(right.m_pFunction)
621 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
622 , m_pStaticFunction (right.m_pStaticFunction)
626 void SetMementoFrom(const DelegateMemento &right) {
627 m_pFunction = right.m_pFunction;
628 m_pthis = right.m_pthis;
629 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
630 m_pStaticFunction = right.m_pStaticFunction;
638 // A private wrapper class that adds function signatures to DelegateMemento.
639 // It's the class that does most of the actual work.
640 // The signatures are specified by:
641 // GenericMemFunc: must be a type of GenericClass member function pointer.
642 // StaticFuncPtr: must be a type of function pointer with the same signature
643 // as GenericMemFunc.
644 // UnvoidStaticFuncPtr: is the same as StaticFuncPtr, except on VC6
645 // where it never returns void (returns DefaultVoid instead).
647 // An outer class, FastDelegateN<>, handles the invoking and creates the
648 // necessary typedefs.
649 // This class does everything else.
653 template < class GenericMemFunc, class StaticFuncPtr, class UnvoidStaticFuncPtr>
654 class ClosurePtr : public DelegateMemento {
656 // These functions are for setting the delegate to a member function.
658 // Here's the clever bit: we convert an arbitrary member function into a
659 // standard form. XMemFunc should be a member function of class X, but I can't
660 // enforce that here. It needs to be enforced by the wrapper class.
661 template < class X, class XMemFunc >
662 inline void bindmemfunc(X *pthis, XMemFunc function_to_bind ) {
663 m_pthis = SimplifyMemFunc< sizeof(function_to_bind) >
664 ::Convert(pthis, function_to_bind, m_pFunction);
665 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
666 m_pStaticFunction = 0;
669 // For const member functions, we only need a const class pointer.
670 // Since we know that the member function is const, it's safe to
671 // remove the const qualifier from the 'this' pointer with a const_cast.
672 // VC6 has problems if we just overload 'bindmemfunc', so we give it a different name.
673 template < class X, class XMemFunc>
674 inline void bindconstmemfunc(const X *pthis, XMemFunc function_to_bind) {
675 m_pthis= SimplifyMemFunc< sizeof(function_to_bind) >
676 ::Convert(const_cast<X*>(pthis), function_to_bind, m_pFunction);
677 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
678 m_pStaticFunction = 0;
681 #ifdef FASTDELEGATE_GCC_BUG_8271 // At present, GCC doesn't recognize constness of MFPs in templates
682 template < class X, class XMemFunc>
683 inline void bindmemfunc(const X *pthis, XMemFunc function_to_bind) {
684 bindconstmemfunc(pthis, function_to_bind);
685 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
686 m_pStaticFunction = 0;
690 // These functions are required for invoking the stored function
691 inline GenericClass *GetClosureThis() const { return m_pthis; }
692 inline GenericMemFunc GetClosureMemPtr() const { return reinterpret_cast<GenericMemFunc>(m_pFunction); }
694 // There are a few ways of dealing with static function pointers.
695 // There's a standard-compliant, but tricky method.
696 // There's also a straightforward hack, that won't work on DOS compilers using the
697 // medium memory model. It's so evil that I can't recommend it, but I've
698 // implemented it anyway because it produces very nice asm code.
700 #if !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
702 // ClosurePtr<> - Safe version
704 // This implementation is standard-compliant, but a bit tricky.
705 // I store the function pointer inside the class, and the delegate then
706 // points to itself. Whenever the delegate is copied, these self-references
707 // must be transformed, and this complicates the = and == operators.
709 // The next two functions are for operator ==, =, and the copy constructor.
710 // We may need to convert the m_pthis pointers, so that
711 // they remain as self-references.
712 template< class DerivedClass >
713 inline void CopyFrom (DerivedClass *pParent, const DelegateMemento &x) {
715 if (m_pStaticFunction!=0) {
716 // transform self references...
717 m_pthis=reinterpret_cast<GenericClass *>(pParent);
720 // For static functions, the 'static_function_invoker' class in the parent
721 // will be called. The parent then needs to call GetStaticFunction() to find out
722 // the actual function to invoke.
723 template < class DerivedClass, class ParentInvokerSig >
724 inline void bindstaticfunc(DerivedClass *pParent, ParentInvokerSig static_function_invoker,
725 StaticFuncPtr function_to_bind ) {
726 bindmemfunc(pParent, static_function_invoker);
727 m_pStaticFunction=reinterpret_cast<GenericFuncPtr>(function_to_bind);
729 inline UnvoidStaticFuncPtr GetStaticFunction() const {
730 return reinterpret_cast<UnvoidStaticFuncPtr>(m_pStaticFunction);
734 // ClosurePtr<> - Evil version
736 // For compilers where data pointers are at least as big as code pointers, it is
737 // possible to store the function pointer in the this pointer, using another
738 // horrible_cast. Invocation isn't any faster, but it saves 4 bytes, and
739 // speeds up comparison and assignment. If C++ provided direct language support
740 // for delegates, they would produce asm code that was almost identical to this.
741 // Note that the Sun C++ and MSVC documentation explicitly state that they
742 // support static_cast between void * and function pointers.
744 template< class DerivedClass >
745 inline void CopyFrom (DerivedClass *pParent, const DelegateMemento &right) {
746 SetMementoFrom(right);
748 // For static functions, the 'static_function_invoker' class in the parent
749 // will be called. The parent then needs to call GetStaticFunction() to find out
750 // the actual function to invoke.
751 // ******** EVIL, EVIL CODE! *******
752 template < class DerivedClass, class ParentInvokerSig>
753 inline void bindstaticfunc(DerivedClass *pParent, ParentInvokerSig static_function_invoker,
754 StaticFuncPtr function_to_bind) {
755 // We'll be ignoring the 'this' pointer, but we need to make sure we pass
756 // a valid value to bindmemfunc().
757 bindmemfunc(pParent, static_function_invoker);
759 // WARNING! Evil hack. We store the function in the 'this' pointer!
760 // Ensure that there's a compilation failure if function pointers
761 // and data pointers have different sizes.
762 // If you get this error, you need to #undef FASTDELEGATE_USESTATICFUNCTIONHACK.
763 typedef int ERROR_CantUseEvilMethod[sizeof(GenericClass *)==sizeof(function_to_bind) ? 1 : -1];
764 m_pthis = horrible_cast<GenericClass *>(function_to_bind);
765 // MSVC, SunC++ and DMC accept the following (non-standard) code:
766 // m_pthis = static_cast<GenericClass *>(static_cast<void *>(function_to_bind));
767 // BCC32, Comeau and DMC accept this method. MSVC7.1 needs __int64 instead of long
768 // m_pthis = reinterpret_cast<GenericClass *>(reinterpret_cast<long>(function_to_bind));
770 // ******** EVIL, EVIL CODE! *******
771 // This function will be called with an invalid 'this' pointer!!
772 // We're just returning the 'this' pointer, converted into
773 // a function pointer!
774 inline UnvoidStaticFuncPtr GetStaticFunction() const {
775 // Ensure that there's a compilation failure if function pointers
776 // and data pointers have different sizes.
777 // If you get this error, you need to #undef FASTDELEGATE_USESTATICFUNCTIONHACK.
778 typedef int ERROR_CantUseEvilMethod[sizeof(UnvoidStaticFuncPtr)==sizeof(this) ? 1 : -1];
779 return horrible_cast<UnvoidStaticFuncPtr>(this);
781 #endif // !defined(FASTDELEGATE_USESTATICFUNCTIONHACK)
786 } // namespace detail
788 ////////////////////////////////////////////////////////////////////////////////
789 // Fast Delegates, part 3:
791 // Wrapper classes to ensure type safety
793 ////////////////////////////////////////////////////////////////////////////////
796 // Once we have the member function conversion templates, it's easy to make the
797 // wrapper classes. So that they will work with as many compilers as possible,
798 // the classes are of the form
799 // FastDelegate3<int, char *, double>
800 // They can cope with any combination of parameters. The max number of parameters
801 // allowed is 8, but it is trivial to increase this limit.
802 // Note that we need to treat const member functions seperately.
803 // All this class does is to enforce type safety, and invoke the delegate with
804 // the correct list of parameters.
806 // Because of the weird rule about the class of derived member function pointers,
807 // you sometimes need to apply a downcast to the 'this' pointer.
808 // This is the reason for the use of "implicit_cast<X*>(pthis)" in the code below.
809 // If CDerivedClass is derived from CBaseClass, but doesn't override SimpleVirtualFunction,
810 // without this trick you'd need to write:
811 // MyDelegate(static_cast<CBaseClass *>(&d), &CDerivedClass::SimpleVirtualFunction);
812 // but with the trick you can write
813 // MyDelegate(&d, &CDerivedClass::SimpleVirtualFunction);
815 // RetType is the type the compiler uses in compiling the template. For VC6,
816 // it cannot be void. DesiredRetType is the real type which is returned from
817 // all of the functions. It can be void.
820 template<@CLASSARGS, class RetType=detail::DefaultVoid>
821 class FastDelegate@NUM {
823 typedef typename detail::DefaultVoidToVoid<RetType>::type DesiredRetType;
824 typedef DesiredRetType (*StaticFunctionPtr)(@FUNCARGS);
825 typedef RetType (*UnvoidStaticFunctionPtr)(@FUNCARGS);
826 typedef RetType (detail::GenericClass::*GenericMemFn)(@FUNCARGS);
827 detail::ClosurePtr<GenericMemFn, StaticFunctionPtr, UnvoidStaticFunctionPtr> m_Closure;
829 // Typedefs to aid generic programming
830 typedef FastDelegate@NUM type;
832 // Construction and comparison functions
833 FastDelegate@NUM() { clear(); }
834 FastDelegate@NUM(const FastDelegate@NUM &x) {
835 m_Closure.CopyFrom(this, x.m_Closure); }
836 void operator = (const FastDelegate@NUM &x) {
837 m_Closure.CopyFrom(this, x.m_Closure); }
838 bool operator ==(const FastDelegate@NUM &x) const {
839 return m_Closure.IsEqual(x.m_Closure); }
840 bool operator !=(const FastDelegate@NUM &x) const {
841 return !m_Closure.IsEqual(x.m_Closure); }
842 bool operator <(const FastDelegate@NUM &x) const {
843 return m_Closure.IsLess(x.m_Closure); }
844 bool operator >(const FastDelegate@NUM &x) const {
845 return x.m_Closure.IsLess(m_Closure); }
846 // Binding to non-const member functions
847 template < class X, class Y >
848 FastDelegate@NUM(Y *pthis, DesiredRetType (X::* function_to_bind)(@FUNCARGS) ) {
849 m_Closure.bindmemfunc(detail::implicit_cast<X*>(pthis), function_to_bind); }
850 template < class X, class Y >
851 inline void bind(Y *pthis, DesiredRetType (X::* function_to_bind)(@FUNCARGS)) {
852 m_Closure.bindmemfunc(detail::implicit_cast<X*>(pthis), function_to_bind); }
853 // Binding to const member functions.
854 template < class X, class Y >
855 FastDelegate@NUM(const Y *pthis, DesiredRetType (X::* function_to_bind)(@FUNCARGS) const) {
856 m_Closure.bindconstmemfunc(detail::implicit_cast<const X*>(pthis), function_to_bind); }
857 template < class X, class Y >
858 inline void bind(const Y *pthis, DesiredRetType (X::* function_to_bind)(@FUNCARGS) const) {
859 m_Closure.bindconstmemfunc(detail::implicit_cast<const X *>(pthis), function_to_bind); }
860 // Static functions. We convert them into a member function call.
861 // Note that this also provides a conversion from static functions.
862 FastDelegate@NUM(DesiredRetType (*function_to_bind)(@FUNCARGS) ) {
863 bind(function_to_bind); }
864 inline void bind(DesiredRetType (*function_to_bind)(@FUNCARGS)) {
865 m_Closure.bindstaticfunc(this, &FastDelegate@NUM::InvokeStaticFunction,
867 RetType operator() (@FUNCARGS) const { // Invoke the delegate
868 // this next line is the only one that violates the standard
869 return (m_Closure.GetClosureThis()->*(m_Closure.GetClosureMemPtr()))(@INVOKEARGS); }
870 inline bool operator ! () const { // Is it bound to anything?
872 inline bool empty() const {
874 void clear() { m_Closure.clear();}
875 // Conversion to and from the DelegateMemento storage class
876 const DelegateMemento & GetMemento() { return m_Closure; }
877 void SetMemento(const DelegateMemento &any) { m_Closure.CopyFrom(this, any); }
879 private: // Invoker for static functions
880 RetType InvokeStaticFunction(@FUNCARGS) const {
881 return (*(m_Closure.GetStaticFunction()))(@INVOKEARGS); }
886 ////////////////////////////////////////////////////////////////////////////////
887 // Fast Delegates, part 4:
889 // FastDelegate<> class (Original author: Jody Hagins)
890 // Allows boost::function style syntax like:
891 // FastDelegate< double (int, long) >
893 // FastDelegate2< int, long, double >
895 ////////////////////////////////////////////////////////////////////////////////
897 #ifdef FASTDELEGATE_ALLOW_FUNCTION_TYPE_SYNTAX
899 // Declare FastDelegate as a class template. It will be specialized
900 // later for all number of arguments.
901 template <typename Signature>
905 // Specialization to allow use of
906 // FastDelegate< R ( @SELARGS ) >
908 // FastDelegate@NUM < @SELARGS, R >
909 template<typename R, @CLASSARGS>
910 class FastDelegate< R ( @SELARGS ) >
911 // Inherit from FastDelegate@NUM so that it can be treated just
912 // like a FastDelegate@NUM
913 : public FastDelegate@NUM < @SELARGS, R >
916 // Make using the base type a bit easier via typedef.
917 typedef FastDelegate@NUM < @SELARGS, R > BaseType;
919 // Allow users access to the specific type of this delegate.
920 typedef FastDelegate SelfType;
922 // Mimic the base class constructors.
923 FastDelegate() : BaseType() { }
925 template < class X, class Y >
926 FastDelegate(Y * pthis,
927 R (X::* function_to_bind)( @FUNCARGS ))
928 : BaseType(pthis, function_to_bind) { }
930 template < class X, class Y >
931 FastDelegate(const Y *pthis,
932 R (X::* function_to_bind)( @FUNCARGS ) const)
933 : BaseType(pthis, function_to_bind)
936 FastDelegate(R (*function_to_bind)( @FUNCARGS ))
937 : BaseType(function_to_bind) { }
938 void operator = (const BaseType &x) {
939 *static_cast<BaseType*>(this) = x; }
944 #endif //FASTDELEGATE_ALLOW_FUNCTION_TYPE_SYNTAX
946 ////////////////////////////////////////////////////////////////////////////////
947 // Fast Delegates, part 5:
949 // MakeDelegate() helper function
951 // MakeDelegate(&x, &X::func) returns a fastdelegate of the type
952 // necessary for calling x.func() with the correct number of arguments.
953 // This makes it possible to eliminate many typedefs from user code.
955 ////////////////////////////////////////////////////////////////////////////////
957 // Also declare overloads of a MakeDelegate() global function to
958 // reduce the need for typedefs.
959 // We need seperate overloads for const and non-const member functions.
960 // Also, because of the weird rule about the class of derived member function pointers,
961 // implicit downcasts may need to be applied later to the 'this' pointer.
962 // That's why two classes (X and Y) appear in the definitions. Y must be implicitly
965 // Workaround for VC6. VC6 needs void return types converted into DefaultVoid.
966 // GCC 3.2 and later won't compile this unless it's preceded by 'typename',
967 // but VC6 doesn't allow 'typename' in this context.
968 // So, I have to use a macro.
971 #define FASTDLGT_RETTYPE detail::VoidToDefaultVoid<RetType>::type
973 #define FASTDLGT_RETTYPE RetType
977 template <class X, class Y, @CLASSARGS, class RetType>
978 FastDelegate@NUM<@SELARGS, FASTDLGT_RETTYPE> MakeDelegate(Y* x, RetType (X::*func)(@FUNCARGS)) {
979 return FastDelegate@NUM<@SELARGS, FASTDLGT_RETTYPE>(x, func);
982 template <class X, class Y, @CLASSARGS, class RetType>
983 FastDelegate@NUM<@SELARGS, FASTDLGT_RETTYPE> MakeDelegate(Y* x, RetType (X::*func)(@FUNCARGS) const) {
984 return FastDelegate@NUM<@SELARGS, FASTDLGT_RETTYPE>(x, func);
987 template <@CLASSARGS, class RetType>
988 FastDelegate@NUM<@SELARGS, FASTDLGT_RETTYPE> MakeDelegate(RetType (*func)(@FUNCARGS)) {
989 return FastDelegate@NUM<@SELARGS, FASTDLGT_RETTYPE>(func);
994 // clean up after ourselves...
995 #undef FASTDLGT_RETTYPE
997 } // namespace fastdelegate
999 #endif // !defined(FASTDELEGATE_H)