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