sourcehook/generate/sourcehook.hxx
author David Anderson <dvander@alliedmods.net>
Thu Sep 27 19:28:30 2007 +0000 (2007-09-27)
branchsourcemm-1.6.0
changeset 357 1319b9ef1c8a
parent 347 e82968c21606
child 361 f34718303c8f
permissions -rwxr-xr-x
initial import of the provider layout for ep1
dvander@347
     1
/* ======== SourceHook ========
dvander@347
     2
* Copyright (C) 2004-2007 Metamod:Source Development Team
dvander@347
     3
* No warranties of any kind
dvander@347
     4
*
dvander@347
     5
* License: zlib/libpng
dvander@347
     6
*
dvander@347
     7
* Author(s): Pavol "PM OnoTo" Marko
dvander@347
     8
* ============================
dvander@347
     9
*/
dvander@347
    10
dvander@347
    11
/**
dvander@347
    12
*	@file sourcehook.h
dvander@347
    13
*	@brief Contains the public SourceHook API
dvander@347
    14
*/
dvander@347
    15
dvander@347
    16
#ifndef __SOURCEHOOK_H__
dvander@347
    17
#define __SOURCEHOOK_H__
dvander@347
    18
dvander@347
    19
// Interface revisions:
dvander@347
    20
//  1 - Initial revision
dvander@347
    21
//  2 - Changed to virtual functions for iterators and all queries
dvander@347
    22
//  3 - Added "hook loop status variable"
dvander@347
    23
//  4 - Reentrant
dvander@347
    24
#define SH_IFACE_VERSION 4
dvander@347
    25
#define SH_IMPL_VERSION 3
dvander@347
    26
dvander@347
    27
// Hookman version:
dvander@347
    28
//  1 - Support for recalls, performance optimisations
dvander@347
    29
#define SH_HOOKMAN_VERSION 1
dvander@347
    30
dvander@347
    31
// The value of SH_GLOB_SHPTR has to be a pointer to SourceHook::ISourceHook
dvander@347
    32
// It's used in various macros
dvander@347
    33
#ifndef SH_GLOB_SHPTR
dvander@347
    34
#define SH_GLOB_SHPTR g_SHPtr
dvander@347
    35
#endif
dvander@347
    36
dvander@347
    37
// Used to identify the current plugin
dvander@347
    38
#ifndef SH_GLOB_PLUGPTR
dvander@347
    39
#define SH_GLOB_PLUGPTR g_PLID
dvander@347
    40
#endif
dvander@347
    41
dvander@347
    42
#ifdef SH_DEBUG
dvander@347
    43
# include <stdio.h>
dvander@347
    44
# include <stdlib.h>
dvander@347
    45
dvander@347
    46
# define SH_ASSERT(x, info) \
dvander@347
    47
	do { \
dvander@347
    48
		if (!(x)) \
dvander@347
    49
		{ \
dvander@347
    50
			printf("SOURCEHOOK DEBUG ASSERTION FAILED: %s:%u(%s): %s: ", __FILE__, __LINE__, __FUNCTION__, #x); \
dvander@347
    51
			printf info; \
dvander@347
    52
			putchar('\n'); \
dvander@347
    53
			abort(); \
dvander@347
    54
		} \
dvander@347
    55
	} while(0)
dvander@347
    56
dvander@347
    57
#else
dvander@347
    58
# define SH_ASSERT(x, info)
dvander@347
    59
#endif
dvander@347
    60
dvander@347
    61
// System
dvander@347
    62
#define SH_SYS_WIN32 1
dvander@347
    63
#define SH_SYS_LINUX 2
dvander@347
    64
dvander@347
    65
#ifdef _WIN32
dvander@347
    66
# define SH_SYS SH_SYS_WIN32
dvander@347
    67
#elif defined __linux__
dvander@347
    68
# define SH_SYS SH_SYS_LINUX
dvander@347
    69
#else
dvander@347
    70
# error Unsupported system
dvander@347
    71
#endif
dvander@347
    72
dvander@347
    73
// Compiler
dvander@347
    74
#define SH_COMP_GCC 1
dvander@347
    75
#define SH_COMP_MSVC 2
dvander@347
    76
dvander@347
    77
#ifdef _MSC_VER
dvander@347
    78
# define SH_COMP SH_COMP_MSVC
dvander@347
    79
#elif defined __GNUC__
dvander@347
    80
# define SH_COMP SH_COMP_GCC
dvander@347
    81
#else
dvander@347
    82
# error Unsupported compiler
dvander@347
    83
#endif
dvander@347
    84
dvander@347
    85
#if SH_COMP==SH_COMP_MSVC
dvander@347
    86
# define vsnprintf _vsnprintf
dvander@347
    87
#endif
dvander@347
    88
dvander@347
    89
#if SH_SYS != SH_SYS_WIN32
dvander@347
    90
# include <unistd.h>
dvander@347
    91
#endif
dvander@347
    92
dvander@347
    93
#define SH_PTRSIZE sizeof(void*)
dvander@347
    94
dvander@347
    95
#include "FastDelegate.h"
dvander@347
    96
#include "sh_memfuncinfo.h"
dvander@347
    97
dvander@347
    98
// Good old metamod!
dvander@347
    99
dvander@347
   100
// Flags returned by a plugin's api function.
dvander@347
   101
// NOTE: order is crucial, as greater/less comparisons are made.
dvander@347
   102
enum META_RES
dvander@347
   103
{
dvander@347
   104
	MRES_IGNORED=0,		// plugin didn't take any action
dvander@347
   105
	MRES_HANDLED,		// plugin did something, but real function should still be called
dvander@347
   106
	MRES_OVERRIDE,		// call real function, but use my return value
dvander@347
   107
	MRES_SUPERCEDE		// skip real function; use my return value
dvander@347
   108
};
dvander@347
   109
dvander@347
   110
dvander@347
   111
namespace SourceHook
dvander@347
   112
{
dvander@347
   113
	/**
dvander@347
   114
	*	@brief	Specifies the size (in bytes) for the internal buffer of vafmt(printf-like) function handlers
dvander@347
   115
	*/
dvander@347
   116
	const int STRBUF_LEN=4096;
dvander@347
   117
dvander@347
   118
	/**
dvander@347
   119
	*	@brief	An empty class. No inheritance used. Used for original-function-call hacks
dvander@347
   120
	*/
dvander@347
   121
	class EmptyClass
dvander@347
   122
	{
dvander@347
   123
	};
dvander@347
   124
dvander@347
   125
	/**
dvander@347
   126
	*	@brief Implicit cast.
dvander@347
   127
	*/
dvander@347
   128
	template <class In, class Out>
dvander@347
   129
		inline Out implicit_cast(In input)
dvander@347
   130
		{
dvander@347
   131
			return input;
dvander@347
   132
		}
dvander@347
   133
dvander@347
   134
	/**
dvander@347
   135
	*	@brief A plugin typedef
dvander@347
   136
	*
dvander@347
   137
	*	SourceHook doesn't really care what this is. As long as the ==, != and = operators work on it and every
dvander@347
   138
	*	plugin has a unique identifier, everything is ok.
dvander@347
   139
	*	It should also be possible to set it to 0.
dvander@347
   140
	*/
dvander@347
   141
	typedef int Plugin;
dvander@347
   142
dvander@347
   143
	struct ProtoInfo
dvander@347
   144
	{
dvander@347
   145
		ProtoInfo(int rtsz, int nop, const int *p) : beginningNull(0), retTypeSize(rtsz), numOfParams(nop), params(p)
dvander@347
   146
		{
dvander@347
   147
		}
dvander@347
   148
		int beginningNull;		//!< To distinguish from old protos (which never begin with 0)
dvander@347
   149
		int retTypeSize;		//!< 0 if void
dvander@347
   150
		int numOfParams;		//!< number of parameters
dvander@347
   151
		const int *params;		//!< params[0]=0 (or -1 for vararg), params[1]=size of first param, ...
dvander@347
   152
	};
dvander@347
   153
dvander@347
   154
	/**
dvander@347
   155
	*	@brief Specifies the actions for hook managers
dvander@347
   156
	*/
dvander@347
   157
	enum HookManagerAction
dvander@347
   158
	{
dvander@347
   159
		HA_GetInfo = 0,			//!< Store info about the hook manager
dvander@347
   160
		HA_Register,			//!< Save the IHookManagerInfo pointer for future reference
dvander@347
   161
		HA_Unregister			//!< Clear the saved pointer
dvander@347
   162
	};
dvander@347
   163
dvander@347
   164
	struct IHookManagerInfo;
dvander@347
   165
dvander@347
   166
	/**
dvander@347
   167
	*	@brief Pointer to hook manager interface function
dvander@347
   168
	*
dvander@347
   169
	*	A "hook manager" is a the only thing that knows the actual protoype of the function at compile time.
dvander@347
   170
	*
dvander@347
   171
	*   @param ha What the hook manager should do
dvander@347
   172
	*	@param hi A pointer to IHookManagerInfo
dvander@347
   173
	*/
dvander@347
   174
	typedef int (*HookManagerPubFunc)(HookManagerAction ha, IHookManagerInfo *hi);
dvander@347
   175
dvander@347
   176
	class ISHDelegate
dvander@347
   177
	{
dvander@347
   178
	public:
dvander@347
   179
		virtual void DeleteThis() = 0;				// Ugly, I know
dvander@347
   180
		virtual bool IsEqual(ISHDelegate *other) = 0;
dvander@347
   181
	};
dvander@347
   182
dvander@347
   183
	template <class T> class CSHDelegate : public ISHDelegate
dvander@347
   184
	{
dvander@347
   185
		T m_Deleg;
dvander@347
   186
	public:
dvander@347
   187
		CSHDelegate(T deleg) : m_Deleg(deleg)
dvander@347
   188
		{
dvander@347
   189
		}
dvander@347
   190
dvander@347
   191
		CSHDelegate(const CSHDelegate &other) : m_Deleg(other.m_Deleg)
dvander@347
   192
		{
dvander@347
   193
		}
dvander@347
   194
dvander@347
   195
		void DeleteThis()
dvander@347
   196
		{
dvander@347
   197
			delete this;
dvander@347
   198
		}
dvander@347
   199
dvander@347
   200
		bool IsEqual(ISHDelegate *other)
dvander@347
   201
		{
dvander@347
   202
			return static_cast<CSHDelegate<T>* >(other)->GetDeleg() == GetDeleg();
dvander@347
   203
		}
dvander@347
   204
dvander@347
   205
		T &GetDeleg()
dvander@347
   206
		{
dvander@347
   207
			return m_Deleg;
dvander@347
   208
		}
dvander@347
   209
	};
dvander@347
   210
dvander@347
   211
	struct IHookList
dvander@347
   212
	{
dvander@347
   213
		struct IIter
dvander@347
   214
		{
dvander@347
   215
			virtual bool End() = 0;
dvander@347
   216
			virtual void Next() = 0;
dvander@347
   217
			virtual ISHDelegate *Handler() = 0;
dvander@347
   218
			virtual int ThisPtrOffs() = 0;
dvander@347
   219
		};
dvander@347
   220
		virtual IIter *GetIter() = 0;
dvander@347
   221
		virtual void ReleaseIter(IIter *pIter) = 0;
dvander@347
   222
	};
dvander@347
   223
dvander@347
   224
	struct IIface
dvander@347
   225
	{
dvander@347
   226
		virtual void *GetPtr() = 0;
dvander@347
   227
		virtual IHookList *GetPreHooks() = 0;
dvander@347
   228
		virtual IHookList *GetPostHooks() = 0;
dvander@347
   229
	};
dvander@347
   230
dvander@347
   231
	struct IVfnPtr
dvander@347
   232
	{
dvander@347
   233
		virtual void *GetVfnPtr() = 0;
dvander@347
   234
		virtual void *GetOrigEntry() = 0;
dvander@347
   235
dvander@347
   236
		virtual IIface *FindIface(void *ptr) = 0;
dvander@347
   237
	};
dvander@347
   238
dvander@347
   239
	struct IHookManagerInfo
dvander@347
   240
	{
dvander@347
   241
		virtual IVfnPtr *FindVfnPtr(void *vfnptr) = 0;
dvander@347
   242
dvander@347
   243
		virtual void SetInfo(int vtbloffs, int vtblidx, const char *proto) = 0;
dvander@347
   244
		virtual void SetHookfuncVfnptr(void *hookfunc_vfnptr) = 0;
dvander@347
   245
dvander@347
   246
		// Added 23.12.2005 (yup! I'm coding RIGHT BEFORE CHRISTMAS!)
dvander@347
   247
		// If the hookman doesn't set this, it defaults 0
dvander@347
   248
		// SourceHook prefers hookmans with higher version numbers
dvander@347
   249
		virtual void SetVersion(int version) = 0;
dvander@347
   250
	};
dvander@347
   251
dvander@347
   252
	class AutoHookIter
dvander@347
   253
	{
dvander@347
   254
		IHookList *m_pList;
dvander@347
   255
		IHookList::IIter *m_pIter;
dvander@347
   256
	public:
dvander@347
   257
		AutoHookIter(IHookList *pList)
dvander@347
   258
			: m_pList(pList), m_pIter(pList->GetIter())
dvander@347
   259
		{
dvander@347
   260
		}
dvander@347
   261
dvander@347
   262
		~AutoHookIter()
dvander@347
   263
		{
dvander@347
   264
			if (m_pList)
dvander@347
   265
				m_pList->ReleaseIter(m_pIter);
dvander@347
   266
		}
dvander@347
   267
dvander@347
   268
		bool End()
dvander@347
   269
		{
dvander@347
   270
			return m_pIter->End();
dvander@347
   271
		}
dvander@347
   272
dvander@347
   273
		void Next()
dvander@347
   274
		{
dvander@347
   275
			m_pIter->Next();
dvander@347
   276
		}
dvander@347
   277
dvander@347
   278
		ISHDelegate *Handler()
dvander@347
   279
		{
dvander@347
   280
			return m_pIter->Handler();
dvander@347
   281
		}
dvander@347
   282
dvander@347
   283
		int ThisPtrOffs()
dvander@347
   284
		{
dvander@347
   285
			return m_pIter->ThisPtrOffs();
dvander@347
   286
		}
dvander@347
   287
dvander@347
   288
		void SetToZero()
dvander@347
   289
		{
dvander@347
   290
			m_pList = 0;
dvander@347
   291
		}
dvander@347
   292
	};
dvander@347
   293
dvander@347
   294
	template<class B> struct CallClass
dvander@347
   295
	{
dvander@347
   296
		virtual B *GetThisPtr() = 0;
dvander@347
   297
		virtual void *GetOrigFunc(int vtbloffs, int vtblidx) = 0;
dvander@347
   298
	};
dvander@347
   299
dvander@347
   300
	typedef CallClass<void> GenericCallClass;
dvander@347
   301
	typedef CallClass<EmptyClass> ManualCallClass;
dvander@347
   302
dvander@347
   303
	// 09.08.2008 (6 AM, I just woke up, the others are still sleeping so i finally can use this notebook !!)
dvander@347
   304
	// - Today is an important day.
dvander@347
   305
	// I'm adding support for functions which return references.
dvander@347
   306
dvander@347
   307
	// How it works:
dvander@347
   308
	//  SH_SETUPCALLS doesn't use plain rettype to store the temporary return values (plugin ret, orig ret,
dvander@347
   309
	//  override ret) anymore; instead, it uses SourceHook::ReferenceCarrier<rettype>::type
dvander@347
   310
	//  this is typedefed to the original rettype normally, but if the rettype is a reference, it's a special class
dvander@347
   311
	//  which stores the reference as a pointer, and implements constructors, operator= and a conversion operator.
dvander@347
   312
	//  special cases were needed for getoverrideret / getorigret; these are implemented through the
dvander@347
   313
	//  SourceHook::MacroRefHelpers structs.
dvander@347
   314
	//  Furthermore, SetOverrideRet had to be changed a bit; see SourceHook::OverrideFunctor somewhere down in this file.
dvander@347
   315
	template <class T> struct ReferenceCarrier
dvander@347
   316
	{
dvander@347
   317
		typedef T type;
dvander@347
   318
	};
dvander@347
   319
dvander@347
   320
	template <class T> struct ReferenceCarrier<T&>
dvander@347
   321
	{
dvander@347
   322
		class type
dvander@347
   323
		{
dvander@347
   324
			T *m_StoredRef;
dvander@347
   325
		public:
dvander@347
   326
			type() : m_StoredRef(NULL)
dvander@347
   327
			{
dvander@347
   328
			}
dvander@347
   329
			type(T& ref) : m_StoredRef(&ref)
dvander@347
   330
			{
dvander@347
   331
			}
dvander@347
   332
dvander@347
   333
			T& operator= (T& ref)
dvander@347
   334
			{
dvander@347
   335
				m_StoredRef = &ref;
dvander@347
   336
				return ref;
dvander@347
   337
			}
dvander@347
   338
dvander@347
   339
			operator T& () const
dvander@347
   340
			{
dvander@347
   341
				return *m_StoredRef;
dvander@347
   342
			}
dvander@347
   343
		};
dvander@347
   344
	};
dvander@347
   345
dvander@347
   346
	/**
dvander@347
   347
	*	@brief The main SourceHook interface
dvander@347
   348
	*/
dvander@347
   349
	class ISourceHook
dvander@347
   350
	{
dvander@347
   351
	public:
dvander@347
   352
		/**
dvander@347
   353
		*	@brief Return interface version
dvander@347
   354
		*/
dvander@347
   355
		virtual int GetIfaceVersion() = 0;
dvander@347
   356
dvander@347
   357
		/**
dvander@347
   358
		*	@brief Return implementation version
dvander@347
   359
		*/
dvander@347
   360
		virtual int GetImplVersion() = 0;
dvander@347
   361
dvander@347
   362
		/**
dvander@347
   363
		*	@brief Add a hook.
dvander@347
   364
		*
dvander@347
   365
		*	@return True if the function succeeded, false otherwise
dvander@347
   366
		*
dvander@347
   367
		*	@param plug The unique identifier of the plugin that calls this function
dvander@347
   368
		*	@param iface The interface pointer
dvander@347
   369
		*	@param ifacesize The size of the class iface points to
dvander@347
   370
		*	@param myHookMan A hook manager function that should be capable of handling the function
dvander@347
   371
		*	@param handler A pointer to a FastDelegate containing the hook handler
dvander@347
   372
		*	@param post Set to true if you want a post handler
dvander@347
   373
		*/
dvander@347
   374
		virtual bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan,
dvander@347
   375
			ISHDelegate *handler, bool post) = 0;
dvander@347
   376
dvander@347
   377
		/**
dvander@347
   378
		*	@brief Removes a hook.
dvander@347
   379
		*
dvander@347
   380
		*	@return True if the function succeeded, false otherwise
dvander@347
   381
		*
dvander@347
   382
		*	@param plug The unique identifier of the plugin that calls this function
dvander@347
   383
		*	@param iface The interface pointer
dvander@347
   384
		*	@param myHookMan A hook manager function that should be capable of handling the function
dvander@347
   385
		*	@param handler A pointer to a FastDelegate containing the hook handler
dvander@347
   386
		*	@param post Set to true if you want a post handler
dvander@347
   387
		*/
dvander@347
   388
		virtual bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan,
dvander@347
   389
			ISHDelegate *handler, bool post) = 0;
dvander@347
   390
dvander@347
   391
		/**
dvander@347
   392
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
dvander@347
   393
		*
dvander@347
   394
		*	@param plug The unique identifier of the plugin in question
dvander@347
   395
		*/
dvander@347
   396
		virtual bool IsPluginInUse(Plugin plug) = 0;
dvander@347
   397
dvander@347
   398
		/**
dvander@347
   399
		*	@brief Return a pointer to a callclass. Generate a new one if required.
dvander@347
   400
		*
dvander@347
   401
		*	@param iface The interface pointer
dvander@347
   402
		*	@param size Size of the class instance
dvander@347
   403
		*/
dvander@347
   404
		virtual GenericCallClass *GetCallClass(void *iface, size_t size) = 0;
dvander@347
   405
dvander@347
   406
		/**
dvander@347
   407
		*	@brief Release a callclass
dvander@347
   408
		*
dvander@347
   409
		*	@param ptr Pointer to the callclass
dvander@347
   410
		*/
dvander@347
   411
		virtual void ReleaseCallClass(GenericCallClass *ptr) = 0;
dvander@347
   412
dvander@347
   413
		virtual void SetRes(META_RES res) = 0;				//!< Sets the meta result
dvander@347
   414
		virtual META_RES GetPrevRes() = 0;					//!< Gets the meta result of the
dvander@347
   415
															//!<  previously calledhandler
dvander@347
   416
		virtual META_RES GetStatus() = 0;					//!< Gets the highest meta result
dvander@347
   417
		virtual const void *GetOrigRet() = 0;				//!< Gets the original result.
dvander@347
   418
															//!<  If not in post function, undefined
dvander@347
   419
		virtual const void *GetOverrideRet() = 0;			//!< Gets the override result.
dvander@347
   420
															//!<  If none is specified, NULL
dvander@347
   421
		virtual void *GetIfacePtr() = 0;					//!< Gets the interface pointer
dvander@347
   422
		//////////////////////////////////////////////////////////////////////////
dvander@347
   423
		// For hook managers
dvander@347
   424
		virtual void HookLoopBegin(IIface *pIface) = 0;			//!< Should be called when a hook loop begins
dvander@347
   425
		virtual void HookLoopEnd() = 0;							//!< Should be called when a hook loop exits
dvander@347
   426
		virtual void SetCurResPtr(META_RES *mres) = 0;			//!< Sets pointer to the current meta result
dvander@347
   427
		virtual void SetPrevResPtr(META_RES *mres) = 0;			//!< Sets pointer to previous meta result
dvander@347
   428
		virtual void SetStatusPtr(META_RES *mres) = 0;			//!< Sets pointer to the status variable
dvander@347
   429
		virtual void SetIfacePtrPtr(void **pp) = 0;				//!< Sets pointer to the interface this pointer
dvander@347
   430
		virtual void SetOrigRetPtr(const void *ptr) = 0;		//!< Sets the original return pointer
dvander@347
   431
		virtual void SetOverrideRetPtr(void *ptr) = 0;			//!< Sets the override result pointer
dvander@347
   432
		virtual bool ShouldContinue() = 0;						//!< Returns false if the hook loop should exit
dvander@347
   433
dvander@347
   434
		/**
dvander@347
   435
		*	@brief Remove a hook manager. Auto-removes all hooks attached to it from plugin plug.
dvander@347
   436
		*
dvander@347
   437
		*	@param plug The owner of the hook manager
dvander@347
   438
		*   @param pubFunc The hook manager's info function
dvander@347
   439
		*/
dvander@347
   440
		virtual void RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc) = 0;
dvander@347
   441
dvander@347
   442
		virtual void DoRecall() = 0;							//!< Initiates a recall sequence
dvander@347
   443
		/*
dvander@347
   444
			HOW RECALLS WORK:
dvander@347
   445
			
dvander@347
   446
			The problem:
dvander@347
   447
				Users want the ability to change parameters of the called function
dvander@347
   448
				from inside their handler.
dvander@347
   449
			The solution:
dvander@347
   450
				1) Mark as "recall"
dvander@347
   451
				2) Recall the function
dvander@347
   452
				3) => SH's hook func gets called:
dvander@347
   453
				  4) The first iterator points at the first hook the last hookfunc didn't execute yet
dvander@347
   454
				  5) does all iteration and returns normally
dvander@347
   455
		        6) The user's handler returns immediately
dvander@347
   456
				7) The hook func returns immediately as well
dvander@347
   457
dvander@347
   458
				Also note that the recalled hookfunc starts with the status the recalling hookfunc
dvander@347
   459
				ended with. The last handler (doing the recall) is also able to specify its own
dvander@347
   460
				META_RES.
dvander@347
   461
		*/
dvander@347
   462
dvander@347
   463
		virtual void *GetOverrideRetPtr() = 0;		//!< Returns the pointer set by SetOverrideRetPtr
dvander@347
   464
dvander@347
   465
		/**
dvander@347
   466
		*	@brief Set up the hook loop. Equivalent to calling:
dvander@347
   467
		*	SetStatusPtr, SetPrevResPtr, SetCurResPtr, SetIfacePtrPtr, SetOrigRetPtr, Get/SetOverrideRetPtr
dvander@347
   468
		*
dvander@347
   469
		*	@param statusPtr		pointer to status variable
dvander@347
   470
		*	@param prevResPtr		pointer to previous result variable
dvander@347
   471
		*	@param curResPtr		pointer to current result variable
dvander@347
   472
		*	@param ifacePtrPtr		pointer to interface this pointer variable
dvander@347
   473
		*	@param origRetPr		pointer to original return value variable. NULL for void funcs
dvander@347
   474
		*	@param overrideRetPtr	pointer to override return value variable. NULL for void funcs
dvander@347
   475
		*	
dvander@347
   476
		*	@return Override Return Pointer the hookfunc should use (may differ from overrideRetPtr
dvander@347
   477
		*		when the hook func is being called as part of a recall
dvander@347
   478
		*/
dvander@347
   479
		virtual void *SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr,
dvander@347
   480
			void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr) = 0;
dvander@347
   481
dvander@347
   482
		//!< 
dvander@347
   483
	};
dvander@347
   484
dvander@347
   485
	// For META_RESULT_ORIG_RET and META_RESULT_OVERRIDE_RET:
dvander@347
   486
	//  These have to be able to return references. If T is a reference, the pointers returned
dvander@347
   487
	//  from the SH_GLOB_SHPTR are pointers to instances of ReferenceCarrier<T>::type.
dvander@347
   488
	template <class T> struct MacroRefHelpers
dvander@347
   489
	{
dvander@347
   490
		inline static const T* GetOrigRet(ISourceHook *shptr)
dvander@347
   491
		{
dvander@347
   492
			return reinterpret_cast<const T*>(shptr->GetOrigRet());
dvander@347
   493
		}
dvander@347
   494
		inline static const T* GetOverrideRet(ISourceHook *shptr)
dvander@347
   495
		{
dvander@347
   496
			return reinterpret_cast<const T*>(shptr->GetOverrideRet());
dvander@347
   497
		}
dvander@347
   498
	};
dvander@347
   499
dvander@347
   500
	template <class T> struct MacroRefHelpers<T&>
dvander@347
   501
	{
dvander@347
   502
		inline static T* GetOrigRet(ISourceHook *shptr)
dvander@347
   503
		{
dvander@347
   504
			T &ref = *reinterpret_cast<const typename ReferenceCarrier<T&>::type *>(shptr->GetOrigRet());
dvander@347
   505
			return &ref;
dvander@347
   506
		}
dvander@347
   507
		inline static T* GetOverrideRet(ISourceHook *shptr)
dvander@347
   508
		{
dvander@347
   509
			T &ref = *reinterpret_cast<const typename ReferenceCarrier<T&>::type *>(shptr->GetOverrideRet());
dvander@347
   510
			return &ref;
dvander@347
   511
		}
dvander@347
   512
	};
dvander@347
   513
}
dvander@347
   514
dvander@347
   515
/************************************************************************/
dvander@347
   516
/* High level interface                                                 */
dvander@347
   517
/************************************************************************/
dvander@347
   518
#define META_RESULT_STATUS					SH_GLOB_SHPTR->GetStatus()
dvander@347
   519
#define META_RESULT_PREVIOUS				SH_GLOB_SHPTR->GetPrevRes()
dvander@347
   520
#define META_RESULT_ORIG_RET(type)			*SourceHook::MacroRefHelpers<type>::GetOrigRet(SH_GLOB_SHPTR)
dvander@347
   521
#define META_RESULT_OVERRIDE_RET(type)		*SourceHook::MacroRefHelpers<type>::GetOverrideRet(SH_GLOB_SHPTR)
dvander@347
   522
#define META_IFACEPTR(type)					reinterpret_cast<type*>(SH_GLOB_SHPTR->GetIfacePtr())
dvander@347
   523
dvander@347
   524
#define SET_META_RESULT(result)				SH_GLOB_SHPTR->SetRes(result)
dvander@347
   525
#define RETURN_META(result)					do { SET_META_RESULT(result); return; } while(0)
dvander@347
   526
#define RETURN_META_VALUE(result, value)	do { SET_META_RESULT(result); return (value); } while(0)
dvander@347
   527
dvander@347
   528
// If a hook on a function which returns a reference does not want to specify a return value,
dvander@347
   529
// it can use this macro.
dvander@347
   530
//   ONLY USE THIS WITH MRES_IGNORED AND MRES_HANDLED !!!
dvander@347
   531
#define RETURN_META_NOREF(result, rettype)	do { SET_META_RESULT(result); return reinterpret_cast<rettype>(*SH_GLOB_SHPTR); } while(0)
dvander@347
   532
dvander@347
   533
// only call these from the hook handlers directly!
dvander@347
   534
// :TODO: enforce it ?
dvander@347
   535
dvander@347
   536
// Why take a memfuncptr instead of iface and func when we have to deduce the iface anyway now?
dvander@347
   537
// Well, without it, there'd be no way to specify which overloaded version we want in _VALUE
dvander@347
   538
dvander@347
   539
// SourceHook::SetOverrideRet is defined later.
dvander@347
   540
#define RETURN_META_NEWPARAMS(result, memfuncptr, newparams) \
dvander@347
   541
	do { \
dvander@347
   542
		SET_META_RESULT(result); \
dvander@347
   543
		SH_GLOB_SHPTR->DoRecall(); \
dvander@347
   544
		(SourceHook::RecallGetIface(SH_GLOB_SHPTR, memfuncptr)->*(memfuncptr)) newparams; \
dvander@347
   545
		RETURN_META(MRES_SUPERCEDE); \
dvander@347
   546
	} while (0)
dvander@347
   547
dvander@347
   548
#define RETURN_META_VALUE_NEWPARAMS(result, value, memfuncptr, newparams) \
dvander@347
   549
	do { \
dvander@347
   550
		SET_META_RESULT(result); \
dvander@347
   551
		SH_GLOB_SHPTR->DoRecall(); \
dvander@347
   552
		if ((result) >= MRES_OVERRIDE) \
dvander@347
   553
		{ \
dvander@347
   554
			/* meh, set the override result here because we don't get a chance to return */ \
dvander@347
   555
			/* before continuing the hook loop through the recall */ \
dvander@347
   556
			SourceHook::SetOverrideResult(memfuncptr)(SH_GLOB_SHPTR, value); \
dvander@347
   557
		} \
dvander@347
   558
		RETURN_META_VALUE(MRES_SUPERCEDE, \
dvander@347
   559
			(SourceHook::RecallGetIface(SH_GLOB_SHPTR, memfuncptr)->*(memfuncptr)) newparams); \
dvander@347
   560
	} while (0)
dvander@347
   561
dvander@347
   562
// :TODO: thisptroffs in MNEWPARAMS ??
dvander@347
   563
dvander@347
   564
#if SH_COMP == SH_COMP_MSVC
dvander@347
   565
dvander@347
   566
#define SOUREHOOK__MNEWPARAMS_PREPAREMFP(hookname) \
dvander@347
   567
	union \
dvander@347
   568
	{ \
dvander@347
   569
		SH_MFHCls(hookname)::ECMFP mfp; \
dvander@347
   570
		void *addr; \
dvander@347
   571
	} u; \
dvander@347
   572
	SourceHook::EmptyClass *thisptr = reinterpret_cast<SourceHook::EmptyClass*>(SH_GLOB_SHPTR->GetIfacePtr()); \
dvander@347
   573
	u.addr = (*reinterpret_cast<void***>(reinterpret_cast<char*>(thisptr) + SH_MFHCls(hookname)::ms_MFI.vtbloffs))[ \
dvander@347
   574
		SH_MFHCls(hookname)::ms_MFI.vtblindex];
dvander@347
   575
dvander@347
   576
#elif SH_COMP == SH_COMP_GCC
dvander@347
   577
dvander@347
   578
#define SOUREHOOK__MNEWPARAMS_PREPAREMFP(hookname) \
dvander@347
   579
	union \
dvander@347
   580
	{ \
dvander@347
   581
		SH_MFHCls(hookname)::ECMFP mfp; \
dvander@347
   582
		struct \
dvander@347
   583
		{ \
dvander@347
   584
			void *addr; \
dvander@347
   585
			intptr_t adjustor; \
dvander@347
   586
		} s; \
dvander@347
   587
	} u; \
dvander@347
   588
	SourceHook::EmptyClass *thisptr = reinterpret_cast<SourceHook::EmptyClass*>(SH_GLOB_SHPTR->GetIfacePtr()); \
dvander@347
   589
	u.s.addr = (*reinterpret_cast<void***>(reinterpret_cast<char*>(thisptr) + SH_MFHCls(hookname)::ms_MFI.vtbloffs))[ \
dvander@347
   590
		SH_MFHCls(hookname)::ms_MFI.vtblindex]; \
dvander@347
   591
	u.s.adjustor = 0;
dvander@347
   592
dvander@347
   593
#endif
dvander@347
   594
dvander@347
   595
#define RETURN_META_MNEWPARAMS(result, hookname, newparams) \
dvander@347
   596
	do { \
dvander@347
   597
		SET_META_RESULT(result); \
dvander@347
   598
		SH_GLOB_SHPTR->DoRecall(); \
dvander@347
   599
		SOUREHOOK__MNEWPARAMS_PREPAREMFP(hookname); \
dvander@347
   600
		(thisptr->*(u.mfp)) newparams; \
dvander@347
   601
		RETURN_META(MRES_SUPERCEDE); \
dvander@347
   602
	} while (0)
dvander@347
   603
dvander@347
   604
#define RETURN_META_VALUE_MNEWPARAMS(result, value, hookname, newparams) \
dvander@347
   605
	do { \
dvander@347
   606
		SET_META_RESULT(result); \
dvander@347
   607
		SH_GLOB_SHPTR->DoRecall(); \
dvander@347
   608
		if ((result) >= MRES_OVERRIDE) \
dvander@347
   609
		{ \
dvander@347
   610
			/* see RETURN_META_VALUE_NEWPARAMS */ \
dvander@347
   611
			SourceHook::SetOverrideResult<SH_MFHCls(hookname)::RetType>(SH_GLOB_SHPTR, value); \
dvander@347
   612
		} \
dvander@347
   613
		SOUREHOOK__MNEWPARAMS_PREPAREMFP(hookname); \
dvander@347
   614
		RETURN_META_VALUE(MRES_SUPERCEDE, (thisptr->*(u.mfp)) newparams); \
dvander@347
   615
	} while (0)
dvander@347
   616
dvander@347
   617
/**
dvander@347
   618
*	@brief Get/generate callclass for an interface pointer
dvander@347
   619
*
dvander@347
   620
*	@param ifaceptr The interface pointer
dvander@347
   621
*/
dvander@347
   622
template<class ifacetype>
dvander@347
   623
inline SourceHook::CallClass<ifacetype> *SH_GET_CALLCLASS_R(SourceHook::ISourceHook *shptr, ifacetype *ptr)
dvander@347
   624
{
dvander@347
   625
	return reinterpret_cast<SourceHook::CallClass<ifacetype>*>(
dvander@347
   626
		shptr->GetCallClass(reinterpret_cast<void*>(ptr), sizeof(ifacetype)));
dvander@347
   627
}
dvander@347
   628
dvander@347
   629
template<class ifacetype>
dvander@347
   630
inline SourceHook::CallClass<ifacetype> *SH_GET_MCALLCLASS_R(SourceHook::ISourceHook *shptr, ifacetype *ptr, int ifacesize)
dvander@347
   631
{
dvander@347
   632
	return reinterpret_cast<SourceHook::CallClass<ifacetype>*>(
dvander@347
   633
		shptr->GetCallClass(reinterpret_cast<void*>(ptr), ifacesize));
dvander@347
   634
}
dvander@347
   635
dvander@347
   636
template<class ifacetype>
dvander@347
   637
inline void SH_RELEASE_CALLCLASS_R(SourceHook::ISourceHook *shptr, SourceHook::CallClass<ifacetype> *ptr)
dvander@347
   638
{
dvander@347
   639
	shptr->ReleaseCallClass(reinterpret_cast<SourceHook::GenericCallClass*>(ptr));
dvander@347
   640
}
dvander@347
   641
dvander@347
   642
#define SH_MANUALHOOK_RECONFIGURE(hookname, pvtblindex, pvtbloffs, pthisptroffs) \
dvander@347
   643
	do { \
dvander@347
   644
		SH_GLOB_SHPTR->RemoveHookManager(SH_GLOB_PLUGPTR, SH_MFHCls(hookname)::HookManPubFunc); \
dvander@347
   645
		SH_MFHCls(hookname)::ms_MFI.thisptroffs = pthisptroffs; \
dvander@347
   646
		SH_MFHCls(hookname)::ms_MFI.vtblindex = pvtblindex; \
dvander@347
   647
		SH_MFHCls(hookname)::ms_MFI.vtbloffs = pvtbloffs; \
dvander@347
   648
	} while (0)
dvander@347
   649
dvander@347
   650
#define SH_GET_CALLCLASS(ptr) SH_GET_CALLCLASS_R(SH_GLOB_SHPTR, ptr)
dvander@347
   651
#define SH_GET_MCALLCLASS(ptr, size) SH_GET_MCALLCLASS_R(SH_GLOB_SHPTR, reinterpret_cast<SourceHook::EmptyClass*>(ptr), size)
dvander@347
   652
#define SH_RELEASE_CALLCLASS(ptr) SH_RELEASE_CALLCLASS_R(SH_GLOB_SHPTR, ptr)
dvander@347
   653
dvander@347
   654
#define SH_ADD_HOOK(ifacetype, ifacefunc, ifaceptr, handler, post) \
dvander@347
   655
	__SourceHook_FHAdd##ifacetype##ifacefunc((void*)SourceHook::implicit_cast<ifacetype*>(ifaceptr), \
dvander@347
   656
	post, handler)
dvander@347
   657
#define SH_ADD_HOOK_STATICFUNC(ifacetype, ifacefunc, ifaceptr, handler, post) \
dvander@347
   658
	SH_ADD_HOOK(ifacetype, ifacefunc, ifaceptr, fastdelegate::MakeDelegate(handler), post)
dvander@347
   659
#define SH_ADD_HOOK_MEMFUNC(ifacetype, ifacefunc, ifaceptr, handler_inst, handler_func, post) \
dvander@347
   660
	SH_ADD_HOOK(ifacetype, ifacefunc, ifaceptr, fastdelegate::MakeDelegate(handler_inst, handler_func), post)
dvander@347
   661
dvander@347
   662
#define SH_REMOVE_HOOK(ifacetype, ifacefunc, ifaceptr, handler, post) \
dvander@347
   663
	__SourceHook_FHRemove##ifacetype##ifacefunc((void*)SourceHook::implicit_cast<ifacetype*>(ifaceptr), \
dvander@347
   664
	post, handler)
dvander@347
   665
#define SH_REMOVE_HOOK_STATICFUNC(ifacetype, ifacefunc, ifaceptr, handler, post) \
dvander@347
   666
	SH_REMOVE_HOOK(ifacetype, ifacefunc, ifaceptr, fastdelegate::MakeDelegate(handler), post)
dvander@347
   667
#define SH_REMOVE_HOOK_MEMFUNC(ifacetype, ifacefunc, ifaceptr, handler_inst, handler_func, post) \
dvander@347
   668
	SH_REMOVE_HOOK(ifacetype, ifacefunc, ifaceptr, fastdelegate::MakeDelegate(handler_inst, handler_func), post)
dvander@347
   669
dvander@347
   670
dvander@347
   671
#define SH_ADD_MANUALHOOK(hookname, ifaceptr, handler, post) \
dvander@347
   672
	__SourceHook_FHMAdd##hookname(reinterpret_cast<void*>(ifaceptr), post, handler)
dvander@347
   673
#define SH_ADD_MANUALHOOK_STATICFUNC(hookname, ifaceptr, handler, post) \
dvander@347
   674
	SH_ADD_MANUALHOOK(hookname, ifaceptr, fastdelegate::MakeDelegate(handler), post)
dvander@347
   675
#define SH_ADD_MANUALHOOK_MEMFUNC(hookname, ifaceptr, handler_inst, handler_func, post) \
dvander@347
   676
	SH_ADD_MANUALHOOK(hookname, ifaceptr, fastdelegate::MakeDelegate(handler_inst, handler_func), post)
dvander@347
   677
dvander@347
   678
#define SH_REMOVE_MANUALHOOK(hookname, ifaceptr, handler, post) \
dvander@347
   679
	__SourceHook_FHMRemove##hookname(reinterpret_cast<void*>(ifaceptr), post, handler)
dvander@347
   680
#define SH_REMOVE_MANUALHOOK_STATICFUNC(hookname, ifaceptr, handler, post) \
dvander@347
   681
	SH_REMOVE_MANUALHOOK(hookname, ifaceptr, fastdelegate::MakeDelegate(handler), post)
dvander@347
   682
#define SH_REMOVE_MANUALHOOK_MEMFUNC(hookname, ifaceptr, handler_inst, handler_func, post) \
dvander@347
   683
	SH_REMOVE_MANUALHOOK(hookname, ifaceptr, fastdelegate::MakeDelegate(handler_inst, handler_func), post)
dvander@347
   684
dvander@347
   685
dvander@347
   686
#define SH_NOATTRIB
dvander@347
   687
dvander@347
   688
dvander@347
   689
dvander@347
   690
dvander@347
   691
#if SH_COMP == SH_COMP_MSVC
dvander@347
   692
# define SH_SETUP_MFP(mfp) \
dvander@347
   693
	reinterpret_cast<void**>(&mfp)[0] = vfnptr_origentry;
dvander@347
   694
#elif SH_COMP == SH_COMP_GCC
dvander@347
   695
# define SH_SETUP_MFP(mfp) \
dvander@347
   696
	reinterpret_cast<void**>(&mfp)[0] = vfnptr_origentry; \
dvander@347
   697
	reinterpret_cast<void**>(&mfp)[1] = 0;
dvander@347
   698
#else
dvander@347
   699
# error Not supported yet.
dvander@347
   700
#endif
dvander@347
   701
dvander@347
   702
//////////////////////////////////////////////////////////////////////////
dvander@347
   703
#define SH_FHCls(ift, iff, ov) __SourceHook_FHCls_##ift##iff##ov
dvander@347
   704
#define SH_MFHCls(hookname) __SourceHook_MFHCls_##hookname
dvander@347
   705
dvander@347
   706
#define SHINT_MAKE_HOOKMANPUBFUNC(ifacetype, ifacefunc, overload, funcptr) \
dvander@347
   707
	SH_FHCls(ifacetype,ifacefunc,overload)() \
dvander@347
   708
	{ \
dvander@347
   709
		GetFuncInfo(funcptr, ms_MFI); \
dvander@347
   710
	} \
dvander@347
   711
	\
dvander@347
   712
	static int HookManPubFunc(::SourceHook::HookManagerAction action, ::SourceHook::IHookManagerInfo *param) \
dvander@347
   713
	{ \
dvander@347
   714
		using namespace ::SourceHook; \
dvander@347
   715
		GetFuncInfo(funcptr, ms_MFI); \
dvander@347
   716
		/* Verify interface version */ \
dvander@347
   717
		if (SH_GLOB_SHPTR->GetIfaceVersion() != SH_IFACE_VERSION) \
dvander@347
   718
			return 1; \
dvander@347
   719
		\
dvander@347
   720
		if (action == HA_GetInfo) \
dvander@347
   721
		{ \
dvander@347
   722
			param->SetVersion(SH_HOOKMAN_VERSION); \
dvander@347
   723
			param->SetInfo(ms_MFI.vtbloffs, ms_MFI.vtblindex, \
dvander@347
   724
				reinterpret_cast<const char*>(&ms_Proto)); \
dvander@347
   725
			\
dvander@347
   726
			MemFuncInfo mfi = {true, -1, 0, 0}; \
dvander@347
   727
			GetFuncInfo(&SH_FHCls(ifacetype,ifacefunc,overload)::Func, mfi); \
dvander@347
   728
			param->SetHookfuncVfnptr( \
dvander@347
   729
				reinterpret_cast<void**>(reinterpret_cast<char*>(&ms_Inst) + mfi.vtbloffs)[mfi.vtblindex]); \
dvander@347
   730
			return 0; \
dvander@347
   731
		} \
dvander@347
   732
		else if (action == HA_Register) \
dvander@347
   733
		{ \
dvander@347
   734
			ms_HI = param; \
dvander@347
   735
			return 0; \
dvander@347
   736
		} \
dvander@347
   737
		else if (action == HA_Unregister) \
dvander@347
   738
		{ \
dvander@347
   739
			ms_HI = NULL; \
dvander@347
   740
			return 0; \
dvander@347
   741
		} \
dvander@347
   742
		else \
dvander@347
   743
			return 1; \
dvander@347
   744
	}
dvander@347
   745
dvander@347
   746
// It has to be possible to use the macros in namespaces
dvander@347
   747
// -> So we need to access and extend the global SourceHook namespace
dvander@347
   748
// We use a namespace alias for this
dvander@347
   749
#define SHINT_MAKE_GENERICSTUFF_BEGIN(ifacetype, ifacefunc, overload, funcptr) \
dvander@347
   750
	struct SH_FHCls(ifacetype,ifacefunc,overload) \
dvander@347
   751
	{ \
dvander@347
   752
		static SH_FHCls(ifacetype,ifacefunc,overload) ms_Inst; \
dvander@347
   753
		static ::SourceHook::MemFuncInfo ms_MFI; \
dvander@347
   754
		static ::SourceHook::IHookManagerInfo *ms_HI; \
dvander@347
   755
		static ::SourceHook::ProtoInfo ms_Proto; \
dvander@347
   756
		SHINT_MAKE_HOOKMANPUBFUNC(ifacetype, ifacefunc, overload, funcptr)
dvander@347
   757
dvander@347
   758
#define SHINT_MAKE_GENERICSTUFF_END(ifacetype, ifacefunc, overload, funcptr) \
dvander@347
   759
	}; \
dvander@347
   760
	SH_FHCls(ifacetype,ifacefunc,overload) SH_FHCls(ifacetype,ifacefunc,overload)::ms_Inst; \
dvander@347
   761
	::SourceHook::MemFuncInfo SH_FHCls(ifacetype,ifacefunc,overload)::ms_MFI; \
dvander@347
   762
	::SourceHook::IHookManagerInfo *SH_FHCls(ifacetype,ifacefunc,overload)::ms_HI; \
dvander@347
   763
	bool __SourceHook_FHAdd##ifacetype##ifacefunc(void *iface, bool post, \
dvander@347
   764
		SH_FHCls(ifacetype,ifacefunc,overload)::FD handler) \
dvander@347
   765
	{ \
dvander@347
   766
		using namespace ::SourceHook; \
dvander@347
   767
		MemFuncInfo mfi = {true, -1, 0, 0}; \
dvander@347
   768
		GetFuncInfo(funcptr, mfi); \
dvander@347
   769
		if (mfi.thisptroffs < 0 || !mfi.isVirtual) \
dvander@347
   770
			return false; /* No non-virtual functions / virtual inheritance supported */ \
dvander@347
   771
		\
dvander@347
   772
		return SH_GLOB_SHPTR->AddHook(SH_GLOB_PLUGPTR, iface, mfi.thisptroffs, \
dvander@347
   773
			SH_FHCls(ifacetype,ifacefunc,overload)::HookManPubFunc, \
dvander@347
   774
			new CSHDelegate<SH_FHCls(ifacetype,ifacefunc,overload)::FD>(handler), post); \
dvander@347
   775
	} \
dvander@347
   776
	bool __SourceHook_FHRemove##ifacetype##ifacefunc(void *iface, bool post, \
dvander@347
   777
		SH_FHCls(ifacetype,ifacefunc,overload)::FD handler) \
dvander@347
   778
	{ \
dvander@347
   779
		using namespace ::SourceHook; \
dvander@347
   780
		MemFuncInfo mfi = {true, -1, 0, 0}; \
dvander@347
   781
		GetFuncInfo(funcptr, mfi); \
dvander@347
   782
		if (mfi.thisptroffs < 0) \
dvander@347
   783
			return false; /* No virtual inheritance supported */ \
dvander@347
   784
		\
dvander@347
   785
		CSHDelegate<SH_FHCls(ifacetype,ifacefunc,overload)::FD> tmp(handler); \
dvander@347
   786
		return SH_GLOB_SHPTR->RemoveHook(SH_GLOB_PLUGPTR, iface, mfi.thisptroffs, \
dvander@347
   787
			SH_FHCls(ifacetype,ifacefunc,overload)::HookManPubFunc, &tmp, post); \
dvander@347
   788
	} \
dvander@347
   789
dvander@347
   790
#define SHINT_MAKE_GENERICSTUFF_BEGIN_MANUAL(hookname, pvtbloffs, pvtblidx, pthisptroffs) \
dvander@347
   791
	struct SH_MFHCls(hookname) \
dvander@347
   792
	{ \
dvander@347
   793
		static SH_MFHCls(hookname) ms_Inst; \
dvander@347
   794
		static ::SourceHook::MemFuncInfo ms_MFI; \
dvander@347
   795
		static ::SourceHook::IHookManagerInfo *ms_HI; \
dvander@347
   796
		static ::SourceHook::ProtoInfo ms_Proto; \
dvander@347
   797
		\
dvander@347
   798
		SH_MFHCls(hookname)() \
dvander@347
   799
		{ \
dvander@347
   800
			ms_MFI.isVirtual = true; \
dvander@347
   801
			ms_MFI.thisptroffs = pthisptroffs; \
dvander@347
   802
			ms_MFI.vtblindex = pvtblidx; \
dvander@347
   803
			ms_MFI.vtbloffs = pvtbloffs; \
dvander@347
   804
		} \
dvander@347
   805
		static int HookManPubFunc(::SourceHook::HookManagerAction action, ::SourceHook::IHookManagerInfo *param) \
dvander@347
   806
		{ \
dvander@347
   807
			using namespace ::SourceHook; \
dvander@347
   808
			/* we don't set ms_MFI here because manual hookmans can be reconfigured */ \
dvander@347
   809
			/* :FIXME: possible problem: someone adding a hook from a constructor of a global entity */ \
dvander@347
   810
			/* which is construced before SH_MFHCls(hookname)() gets called? */ \
dvander@347
   811
			/* Verify interface version */ \
dvander@347
   812
			if (SH_GLOB_SHPTR->GetIfaceVersion() != SH_IFACE_VERSION) \
dvander@347
   813
				return 1; \
dvander@347
   814
			\
dvander@347
   815
			if (action == HA_GetInfo) \
dvander@347
   816
			{ \
dvander@347
   817
				param->SetVersion(SH_HOOKMAN_VERSION); \
dvander@347
   818
				param->SetInfo(ms_MFI.vtbloffs, ms_MFI.vtblindex, \
dvander@347
   819
					reinterpret_cast<const char*>(&ms_Proto)); \
dvander@347
   820
				\
dvander@347
   821
				MemFuncInfo mfi = {true, -1, 0, 0}; \
dvander@347
   822
				GetFuncInfo(&SH_MFHCls(hookname)::Func, mfi); \
dvander@347
   823
				param->SetHookfuncVfnptr( \
dvander@347
   824
					reinterpret_cast<void**>(reinterpret_cast<char*>(&ms_Inst) + mfi.vtbloffs)[mfi.vtblindex]); \
dvander@347
   825
				return 0; \
dvander@347
   826
			} \
dvander@347
   827
			else if (action == HA_Register) \
dvander@347
   828
			{ \
dvander@347
   829
				ms_HI = param; \
dvander@347
   830
				return 0; \
dvander@347
   831
			} \
dvander@347
   832
			else if (action == HA_Unregister) \
dvander@347
   833
			{ \
dvander@347
   834
				ms_HI = NULL; \
dvander@347
   835
				return 0; \
dvander@347
   836
			} \
dvander@347
   837
			else \
dvander@347
   838
				return 1; \
dvander@347
   839
		}
dvander@347
   840
dvander@347
   841
#define SHINT_MAKE_GENERICSTUFF_END_MANUAL(hookname, pvtbloffs, pvtblidx, pthisptroffs) \
dvander@347
   842
	}; \
dvander@347
   843
	SH_MFHCls(hookname) SH_MFHCls(hookname)::ms_Inst; \
dvander@347
   844
	::SourceHook::MemFuncInfo SH_MFHCls(hookname)::ms_MFI; \
dvander@347
   845
	::SourceHook::IHookManagerInfo *SH_MFHCls(hookname)::ms_HI; \
dvander@347
   846
	bool __SourceHook_FHMAdd##hookname(void *iface, bool post, \
dvander@347
   847
		SH_MFHCls(hookname)::FD handler) \
dvander@347
   848
	{ \
dvander@347
   849
		return SH_GLOB_SHPTR->AddHook(SH_GLOB_PLUGPTR, iface, pthisptroffs, \
dvander@347
   850
			SH_MFHCls(hookname)::HookManPubFunc, \
dvander@347
   851
			new ::SourceHook::CSHDelegate<SH_MFHCls(hookname)::FD>(handler), post); \
dvander@347
   852
	} \
dvander@347
   853
	bool __SourceHook_FHMRemove##hookname(void *iface, bool post, \
dvander@347
   854
		SH_MFHCls(hookname)::FD handler) \
dvander@347
   855
	{ \
dvander@347
   856
		::SourceHook::CSHDelegate<SH_MFHCls(hookname)::FD> tmp(handler); \
dvander@347
   857
		return SH_GLOB_SHPTR->RemoveHook(SH_GLOB_PLUGPTR, iface, pthisptroffs, \
dvander@347
   858
			SH_MFHCls(hookname)::HookManPubFunc, &tmp, post); \
dvander@347
   859
	} \
dvander@347
   860
dvander@347
   861
dvander@347
   862
#define SH_SETUPCALLS(rettype, paramtypes, params) \
dvander@347
   863
	/* 1) Find the vfnptr */ \
dvander@347
   864
	using namespace ::SourceHook; \
dvander@347
   865
	void *ourvfnptr = reinterpret_cast<void*>( \
dvander@347
   866
		*reinterpret_cast<void***>(reinterpret_cast<char*>(this) + ms_MFI.vtbloffs) + ms_MFI.vtblindex); \
dvander@347
   867
	IVfnPtr *vfnptr = ms_HI->FindVfnPtr(ourvfnptr); \
dvander@347
   868
	SH_ASSERT(vfnptr, ("Called with vfnptr 0x%p which couldn't be found in the list", ourvfnptr)); \
dvander@347
   869
	\
dvander@347
   870
	void *vfnptr_origentry = vfnptr->GetOrigEntry(); \
dvander@347
   871
	/* ... and the iface */ \
dvander@347
   872
	IIface *ifinfo = vfnptr->FindIface(reinterpret_cast<void*>(this)); \
dvander@347
   873
	if (!ifinfo) \
dvander@347
   874
	{ \
dvander@347
   875
		/* The iface info was not found. Redirect the call to the original function. */ \
dvander@347
   876
		rettype (EmptyClass::*mfp)paramtypes; \
dvander@347
   877
		SH_SETUP_MFP(mfp); \
dvander@347
   878
		return (reinterpret_cast<EmptyClass*>(this)->*mfp)params; \
dvander@347
   879
	} \
dvander@347
   880
	/* 2) Declare some vars and set it up */ \
dvander@347
   881
	SH_GLOB_SHPTR->HookLoopBegin(ifinfo); \
dvander@347
   882
	IHookList *prelist = ifinfo->GetPreHooks(); \
dvander@347
   883
	IHookList *postlist = ifinfo->GetPostHooks(); \
dvander@347
   884
	META_RES status = MRES_IGNORED; \
dvander@347
   885
	META_RES prev_res; \
dvander@347
   886
	META_RES cur_res; \
dvander@347
   887
	typedef ReferenceCarrier<rettype>::type my_rettype; \
dvander@347
   888
	my_rettype orig_ret; \
dvander@347
   889
	my_rettype override_ret; \
dvander@347
   890
	my_rettype plugin_ret; \
dvander@347
   891
	void* ifptr; \
dvander@347
   892
	my_rettype *pOverrideRet = reinterpret_cast<my_rettype*>(SH_GLOB_SHPTR->SetupHookLoop( \
dvander@347
   893
		&status, &prev_res, &cur_res, &ifptr, &orig_ret, &override_ret));
dvander@347
   894
dvander@347
   895
#define SH_CALL_HOOKS(post, params) \
dvander@347
   896
	if (SH_GLOB_SHPTR->ShouldContinue()) \
dvander@347
   897
	{ \
dvander@347
   898
		prev_res = MRES_IGNORED; \
dvander@347
   899
		for (AutoHookIter iter(post##list); !iter.End(); iter.Next()) \
dvander@347
   900
		{ \
dvander@347
   901
			cur_res = MRES_IGNORED; \
dvander@347
   902
			ifptr = reinterpret_cast<void*>(reinterpret_cast<char*>(this) - iter.ThisPtrOffs()); \
dvander@347
   903
			plugin_ret = reinterpret_cast<CSHDelegate<FD>*>(iter.Handler())->GetDeleg() params; \
dvander@347
   904
			prev_res = cur_res; \
dvander@347
   905
			if (cur_res > status) \
dvander@347
   906
				status = cur_res; \
dvander@347
   907
			if (cur_res >= MRES_OVERRIDE) \
dvander@347
   908
				*pOverrideRet = plugin_ret; \
dvander@347
   909
			if (!SH_GLOB_SHPTR->ShouldContinue()) \
dvander@347
   910
			{ \
dvander@347
   911
				iter.SetToZero(); \
dvander@347
   912
				break; \
dvander@347
   913
			} \
dvander@347
   914
		} \
dvander@347
   915
	}
dvander@347
   916
dvander@347
   917
#define SH_CALL_ORIG(rettype, paramtypes, params) \
dvander@347
   918
	if (status != MRES_SUPERCEDE) \
dvander@347
   919
	{ \
dvander@347
   920
		rettype (EmptyClass::*mfp)paramtypes; \
dvander@347
   921
		SH_SETUP_MFP(mfp); \
dvander@347
   922
		orig_ret = (reinterpret_cast<EmptyClass*>(this)->*mfp)params; \
dvander@347
   923
	} \
dvander@347
   924
	else \
dvander@347
   925
		orig_ret = override_ret; \
dvander@347
   926
dvander@347
   927
#define SH_RETURN() \
dvander@347
   928
	SH_GLOB_SHPTR->HookLoopEnd(); \
dvander@347
   929
	return status >= MRES_OVERRIDE ? *pOverrideRet : orig_ret;
dvander@347
   930
dvander@347
   931
#define SH_HANDLEFUNC(paramtypes, params, rettype) \
dvander@347
   932
	SH_SETUPCALLS(rettype, paramtypes, params) \
dvander@347
   933
	SH_CALL_HOOKS(pre, params) \
dvander@347
   934
	SH_CALL_ORIG(rettype, paramtypes, params) \
dvander@347
   935
	SH_CALL_HOOKS(post, params) \
dvander@347
   936
	SH_RETURN()
dvander@347
   937
dvander@347
   938
//////////////////////////////////////////////////////////////////////////
dvander@347
   939
#define SH_SETUPCALLS_void(paramtypes, params) \
dvander@347
   940
	/* 1) Find the vfnptr */ \
dvander@347
   941
	using namespace ::SourceHook; \
dvander@347
   942
	void *ourvfnptr = reinterpret_cast<void*>( \
dvander@347
   943
		*reinterpret_cast<void***>(reinterpret_cast<char*>(this) + ms_MFI.vtbloffs) + ms_MFI.vtblindex); \
dvander@347
   944
	IVfnPtr *vfnptr = ms_HI->FindVfnPtr(ourvfnptr); \
dvander@347
   945
	SH_ASSERT(vfnptr, ("Called with vfnptr 0x%p which couldn't be found in the list", ourvfnptr)); \
dvander@347
   946
	\
dvander@347
   947
	void *vfnptr_origentry = vfnptr->GetOrigEntry(); \
dvander@347
   948
	/* ... and the iface */ \
dvander@347
   949
	IIface *ifinfo = vfnptr->FindIface(reinterpret_cast<void*>(this)); \
dvander@347
   950
	if (!ifinfo) \
dvander@347
   951
	{ \
dvander@347
   952
		/* The iface info was not found. Redirect the call to the original function. */ \
dvander@347
   953
		void (EmptyClass::*mfp)paramtypes; \
dvander@347
   954
		SH_SETUP_MFP(mfp); \
dvander@347
   955
		(reinterpret_cast<EmptyClass*>(this)->*mfp)params; \
dvander@347
   956
		return; \
dvander@347
   957
	} \
dvander@347
   958
	/* 2) Declare some vars and set it up */ \
dvander@347
   959
	SH_GLOB_SHPTR->HookLoopBegin(ifinfo); \
dvander@347
   960
	IHookList *prelist = ifinfo->GetPreHooks(); \
dvander@347
   961
	IHookList *postlist = ifinfo->GetPostHooks(); \
dvander@347
   962
	META_RES status = MRES_IGNORED; \
dvander@347
   963
	META_RES prev_res; \
dvander@347
   964
	META_RES cur_res; \
dvander@347
   965
	void* ifptr; \
dvander@347
   966
	SH_GLOB_SHPTR->SetupHookLoop(&status, &prev_res, &cur_res, &ifptr, NULL, NULL); \
dvander@347
   967
dvander@347
   968
#define SH_CALL_HOOKS_void(post, params) \
dvander@347
   969
	if (SH_GLOB_SHPTR->ShouldContinue()) \
dvander@347
   970
	{ \
dvander@347
   971
		prev_res = MRES_IGNORED; \
dvander@347
   972
		for (AutoHookIter iter(post##list); !iter.End(); iter.Next()) \
dvander@347
   973
		{ \
dvander@347
   974
			cur_res = MRES_IGNORED; \
dvander@347
   975
			ifptr = reinterpret_cast<void*>(reinterpret_cast<char*>(this) - iter.ThisPtrOffs()); \
dvander@347
   976
			reinterpret_cast<CSHDelegate<FD>*>(iter.Handler())->GetDeleg() params; \
dvander@347
   977
			prev_res = cur_res; \
dvander@347
   978
			if (cur_res > status) \
dvander@347
   979
				status = cur_res; \
dvander@347
   980
			if (!SH_GLOB_SHPTR->ShouldContinue()) \
dvander@347
   981
			{ \
dvander@347
   982
				iter.SetToZero(); \
dvander@347
   983
				break; \
dvander@347
   984
			} \
dvander@347
   985
		} \
dvander@347
   986
	}
dvander@347
   987
dvander@347
   988
#define SH_CALL_ORIG_void(paramtypes, params) \
dvander@347
   989
	if (status != MRES_SUPERCEDE) \
dvander@347
   990
	{ \
dvander@347
   991
		void (EmptyClass::*mfp)paramtypes; \
dvander@347
   992
		SH_SETUP_MFP(mfp); \
dvander@347
   993
		(reinterpret_cast<EmptyClass*>(this)->*mfp)params; \
dvander@347
   994
	}
dvander@347
   995
dvander@347
   996
#define SH_RETURN_void() \
dvander@347
   997
	SH_GLOB_SHPTR->HookLoopEnd();
dvander@347
   998
dvander@347
   999
#define SH_HANDLEFUNC_void(paramtypes, params) \
dvander@347
  1000
	SH_SETUPCALLS_void(paramtypes, params) \
dvander@347
  1001
	SH_CALL_HOOKS_void(pre, params) \
dvander@347
  1002
	SH_CALL_ORIG_void(paramtypes, params) \
dvander@347
  1003
	SH_CALL_HOOKS_void(post, params) \
dvander@347
  1004
	SH_RETURN_void()
dvander@347
  1005
dvander@347
  1006
dvander@347
  1007
// Special vafmt handlers
dvander@347
  1008
// :TODO: what
dvander@347
  1009
#define SH_HANDLEFUNC_vafmt(paramtypes, params_orig, params_plug, rettype) \
dvander@347
  1010
	SH_SETUPCALLS(rettype, paramtypes, params_orig) \
dvander@347
  1011
	SH_CALL_HOOKS(pre, params_plug) \
dvander@347
  1012
	SH_CALL_ORIG(rettype, paramtypes, params_orig) \
dvander@347
  1013
	SH_CALL_HOOKS(post, params_plug) \
dvander@347
  1014
	SH_RETURN()
dvander@347
  1015
dvander@347
  1016
#define SH_HANDLEFUNC_void_vafmt(paramtypes, params_orig, params_plug) \
dvander@347
  1017
	SH_SETUPCALLS_void(paramtypes, params_orig) \
dvander@347
  1018
	SH_CALL_HOOKS_void(pre, params_plug) \
dvander@347
  1019
	SH_CALL_ORIG_void(paramtypes, params_orig) \
dvander@347
  1020
	SH_CALL_HOOKS_void(post, params_plug) \
dvander@347
  1021
	SH_RETURN_void()
dvander@347
  1022
dvander@347
  1023
//////////////////////////////////////////////////////////////////////////
dvander@347
  1024
dvander@347
  1025
// :FIXME:
dvander@347
  1026
//  sizeof on references returns the size of the datatype, NOT the pointer size or something
dvander@347
  1027
//  -> one should probably flag references in __SourceHook_ParamSizes_* !
dvander@347
  1028
//		or simply assume that their size is sizeof(void*)=SH_PTRSIZE... could be doable through a simple template
dvander@347
  1029
dvander@347
  1030
@[$1,0,$a:
dvander@347
  1031
// ********* Support for $1 arguments *********
dvander@347
  1032
#define SH_DECL_HOOK$1(ifacetype, ifacefunc, attr, overload, rettype@[$2,1,$1:, param$2@]) \
dvander@347
  1033
	SHINT_MAKE_GENERICSTUFF_BEGIN(ifacetype, ifacefunc, overload, (static_cast<rettype (ifacetype::*)(@[$2,1,$1|, :param$2@]) attr> \
dvander@347
  1034
		(&ifacetype::ifacefunc))) \
dvander@347
  1035
		typedef fastdelegate::FastDelegate$1<@[$2,1,$1|, :param$2@]@[$1!=0:, @]rettype> FD; \
dvander@347
  1036
		virtual rettype Func(@[$2,1,$1|, :param$2 p$2@]) \
dvander@347
  1037
		{ SH_HANDLEFUNC((@[$2,1,$1|, :param$2@]), (@[$2,1,$1|, :p$2@]), rettype); } \
dvander@347
  1038
	SHINT_MAKE_GENERICSTUFF_END(ifacetype, ifacefunc, overload, \
dvander@347
  1039
		(static_cast<rettype (ifacetype::*)(@[$2,1,$1|, :param$2@]) attr>(&ifacetype::ifacefunc))) \
dvander@347
  1040
	\
dvander@347
  1041
	const int __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload[] = { 0@[$2,1,$1:, sizeof(param$2)@] }; \
dvander@347
  1042
	::SourceHook::ProtoInfo SH_FHCls(ifacetype, ifacefunc, overload)::ms_Proto(sizeof(rettype), \
dvander@347
  1043
		$1, __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload);
dvander@347
  1044
dvander@347
  1045
#define SH_DECL_HOOK$1_void(ifacetype, ifacefunc, attr, overload@[$2,1,$1:, param$2@]) \
dvander@347
  1046
	SHINT_MAKE_GENERICSTUFF_BEGIN(ifacetype, ifacefunc, overload, (static_cast<void (ifacetype::*)(@[$2,1,$1|, :param$2@]) attr> \
dvander@347
  1047
		(&ifacetype::ifacefunc))) \
dvander@347
  1048
		typedef fastdelegate::FastDelegate$1<@[$2,1,$1|, :param$2@]> FD; \
dvander@347
  1049
		virtual void Func(@[$2,1,$1|, :param$2 p$2@]) \
dvander@347
  1050
		{ SH_HANDLEFUNC_void((@[$2,1,$1|, :param$2@]), (@[$2,1,$1|, :p$2@])); } \
dvander@347
  1051
	SHINT_MAKE_GENERICSTUFF_END(ifacetype, ifacefunc, overload, \
dvander@347
  1052
		(static_cast<void (ifacetype::*)(@[$2,1,$1|, :param$2@]) attr>(&ifacetype::ifacefunc))) \
dvander@347
  1053
	\
dvander@347
  1054
	\
dvander@347
  1055
	const int __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload[] = { 0@[$2,1,$1:, sizeof(param$2)@] }; \
dvander@347
  1056
	::SourceHook::ProtoInfo SH_FHCls(ifacetype, ifacefunc, overload)::ms_Proto(0, \
dvander@347
  1057
		$1, __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload);
dvander@347
  1058
dvander@347
  1059
#define SH_DECL_HOOK$1_vafmt(ifacetype, ifacefunc, attr, overload, rettype@[$2,1,$1:, param$2@]) \
dvander@347
  1060
	SHINT_MAKE_GENERICSTUFF_BEGIN(ifacetype, ifacefunc, overload, (static_cast<rettype (ifacetype::*)(@[$2,1,$1|, :param$2@]@[$1!=0:, @]const char *, ...) attr> \
dvander@347
  1061
		(&ifacetype::ifacefunc))) \
dvander@347
  1062
		typedef fastdelegate::FastDelegate@($1+1)<@[$2,1,$1|, :param$2@]@[$1!=0:, @]const char *, rettype> FD; \
dvander@347
  1063
		virtual rettype Func(@[$2,1,$1|, :param$2 p$2@]@[$1!=0:, @]const char *fmt, ...) \
dvander@347
  1064
		{ \
dvander@347
  1065
			char buf[::SourceHook::STRBUF_LEN]; \
dvander@347
  1066
			va_list ap; \
dvander@347
  1067
			va_start(ap, fmt); \
dvander@347
  1068
			vsnprintf(buf, sizeof(buf), fmt, ap); \
dvander@347
  1069
			va_end(ap); \
dvander@347
  1070
			SH_HANDLEFUNC_vafmt((@[$2,1,$1|, :param$2@]@[$1!=0:, @]...), (@[$2,1,$1|, :p$2@]@[$1!=0:, @]"%s", buf), (@[$2,1,$1|, :p$2@]@[$1!=0:, @]buf), rettype); \
dvander@347
  1071
		} \
dvander@347
  1072
	SHINT_MAKE_GENERICSTUFF_END(ifacetype, ifacefunc, overload, \
dvander@347
  1073
		(static_cast<rettype (ifacetype::*)(@[$2,1,$1|, :param$2@]@[$1!=0:, @]const char *, ...) attr>(&ifacetype::ifacefunc))) \
dvander@347
  1074
	\
dvander@347
  1075
	const int __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload[] = { -1@[$2,1,$1:, sizeof(param$2)@] }; \
dvander@347
  1076
	::SourceHook::ProtoInfo SH_FHCls(ifacetype, ifacefunc, overload)::ms_Proto(sizeof(rettype), \
dvander@347
  1077
		$1, __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload);
dvander@347
  1078
dvander@347
  1079
#define SH_DECL_HOOK$1_void_vafmt(ifacetype, ifacefunc, attr, overload@[$2,1,$1:, param$2@]) \
dvander@347
  1080
	SHINT_MAKE_GENERICSTUFF_BEGIN(ifacetype, ifacefunc, overload, (static_cast<void (ifacetype::*)(@[$2,1,$1|, :param$2@]@[$1!=0:, @]const char *, ...) attr> \
dvander@347
  1081
		(&ifacetype::ifacefunc))) \
dvander@347
  1082
		typedef fastdelegate::FastDelegate@($1+1)<@[$2,1,$1|, :param$2@]@[$1!=0:, @]const char *> FD; \
dvander@347
  1083
		virtual void Func(@[$2,1,$1|, :param$2 p$2@]@[$1!=0:, @]const char *fmt, ...) \
dvander@347
  1084
		{ \
dvander@347
  1085
			char buf[::SourceHook::STRBUF_LEN]; \
dvander@347
  1086
			va_list ap; \
dvander@347
  1087
			va_start(ap, fmt); \
dvander@347
  1088
			vsnprintf(buf, sizeof(buf), fmt, ap); \
dvander@347
  1089
			va_end(ap); \
dvander@347
  1090
			SH_HANDLEFUNC_void_vafmt((@[$2,1,$1|, :param$2@]@[$1!=0:, @]...), (@[$2,1,$1|, :p$2@]@[$1!=0:, @]"%s", buf), (@[$2,1,$1|, :p$2@]@[$1!=0:, @]buf)); \
dvander@347
  1091
		} \
dvander@347
  1092
	SHINT_MAKE_GENERICSTUFF_END(ifacetype, ifacefunc, overload, \
dvander@347
  1093
		(static_cast<void (ifacetype::*)(@[$2,1,$1|, :param$2@]@[$1!=0:, @]const char *, ...) attr>(&ifacetype::ifacefunc))) \
dvander@347
  1094
	\
dvander@347
  1095
	const int __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload[] = { -1@[$2,1,$1:, sizeof(param$2)@] }; \
dvander@347
  1096
	::SourceHook::ProtoInfo SH_FHCls(ifacetype, ifacefunc, overload)::ms_Proto(0, \
dvander@347
  1097
		$1, __SourceHook_ParamSizes_##ifacetype##ifacefunc##overload);
dvander@347
  1098
dvander@347
  1099
#define SH_DECL_MANUALHOOK$1(hookname, vtblidx, vtbloffs, thisptroffs, rettype@[$2,1,$1:, param$2@]) \
dvander@347
  1100
	SHINT_MAKE_GENERICSTUFF_BEGIN_MANUAL(hookname, vtbloffs, vtblidx, thisptroffs) \
dvander@347
  1101
		typedef fastdelegate::FastDelegate$1<@[$2,1,$1|, :param$2@]@[$1!=0:, @]rettype> FD; \
dvander@347
  1102
		virtual rettype Func(@[$2,1,$1|, :param$2 p$2@]) \
dvander@347
  1103
		{ SH_HANDLEFUNC((@[$2,1,$1|, :param$2@]), (@[$2,1,$1|, :p$2@]), rettype); } \
dvander@347
  1104
		typedef rettype(::SourceHook::EmptyClass::*ECMFP)(@[$2,1,$1|, :param$2@]); \
dvander@347
  1105
		typedef rettype RetType; \
dvander@347
  1106
	SHINT_MAKE_GENERICSTUFF_END_MANUAL(hookname, vtbloffs, vtblidx, thisptroffs) \
dvander@347
  1107
	\
dvander@347
  1108
	const int __SourceHook_ParamSizesM_##hookname[] = { 0@[$2,1,$1:, sizeof(param$2)@] }; \
dvander@347
  1109
	::SourceHook::ProtoInfo SH_MFHCls(hookname)::ms_Proto(sizeof(rettype), \
dvander@347
  1110
		$1, __SourceHook_ParamSizesM_##hookname); \
dvander@347
  1111
dvander@347
  1112
#define SH_DECL_MANUALHOOK$1_void(hookname, vtblidx, vtbloffs, thisptroffs@[$2,1,$1:, param$2@]) \
dvander@347
  1113
	SHINT_MAKE_GENERICSTUFF_BEGIN_MANUAL(hookname, vtbloffs, vtblidx, thisptroffs) \
dvander@347
  1114
		typedef fastdelegate::FastDelegate$1<@[$2,1,$1|, :param$2@]> FD; \
dvander@347
  1115
		virtual void Func(@[$2,1,$1|, :param$2 p$2@]) \
dvander@347
  1116
		{ SH_HANDLEFUNC_void((@[$2,1,$1|, :param$2@]), (@[$2,1,$1|, :p$2@])); } \
dvander@347
  1117
		typedef void(::SourceHook::EmptyClass::*ECMFP)(@[$2,1,$1|, :param$2@]); \
dvander@347
  1118
	SHINT_MAKE_GENERICSTUFF_END_MANUAL(hookname, vtbloffs, vtblidx, thisptroffs) \
dvander@347
  1119
	\
dvander@347
  1120
	const int __SourceHook_ParamSizesM_##hookname[] = { 0@[$2,1,$1:, sizeof(param$2)@] }; \
dvander@347
  1121
	::SourceHook::ProtoInfo SH_MFHCls(hookname)::ms_Proto(0, \
dvander@347
  1122
		$1, __SourceHook_ParamSizesM_##hookname); \
dvander@347
  1123
dvander@347
  1124
@]
dvander@347
  1125
dvander@347
  1126
dvander@347
  1127
//////////////////////////////////////////////////////////////////////////
dvander@347
  1128
// SH_CALL
dvander@347
  1129
dvander@347
  1130
#if SH_COMP == SH_COMP_MSVC
dvander@347
  1131
dvander@347
  1132
# define SH_MAKE_EXECUTABLECLASS_OB(call, prms) \
dvander@347
  1133
{ \
dvander@347
  1134
	using namespace ::SourceHook; \
dvander@347
  1135
	MemFuncInfo mfi = {true, -1, 0, 0}; \
dvander@347
  1136
	GetFuncInfo(m_CC->GetThisPtr(), m_MFP, mfi); \
dvander@347
  1137
	void *origfunc = m_CC->GetOrigFunc(mfi.thisptroffs + mfi.vtbloffs, mfi.vtblindex); \
dvander@347
  1138
	if (!origfunc) \
dvander@347
  1139
		return (m_CC->GetThisPtr()->*m_MFP)call; \
dvander@347
  1140
	\
dvander@347
  1141
	/* It's hooked. Call the original function. */ \
dvander@347
  1142
	union \
dvander@347
  1143
	{ \
dvander@347
  1144
		RetType(EmptyClass::*mfpnew)prms; \
dvander@347
  1145
		void *addr; \
dvander@347
  1146
	} u; \
dvander@347
  1147
	u.addr = origfunc; \
dvander@347
  1148
	\
dvander@347
  1149
	void *adjustedthisptr = reinterpret_cast<void*>(reinterpret_cast<char*>(m_CC->GetThisPtr()) + mfi.thisptroffs); \
dvander@347
  1150
	return (reinterpret_cast<EmptyClass*>(adjustedthisptr)->*u.mfpnew)call; \
dvander@347
  1151
}
dvander@347
  1152
dvander@347
  1153
# define SH_MAKE_MEXECUTABLECLASS_OB(call, prms) \
dvander@347
  1154
{ \
dvander@347
  1155
	using namespace ::SourceHook; \
dvander@347
  1156
	char *adjustedthisptr = reinterpret_cast<char*>(m_CC->GetThisPtr()) + m_ThisPtrOffs; \
dvander@347
  1157
	union \
dvander@347
  1158
	{ \
dvander@347
  1159
		RetType(EmptyClass::*mfpnew)prms; \
dvander@347
  1160
		void *addr; \
dvander@347
  1161
	} u; \
dvander@347
  1162
	u.addr = m_CC->GetOrigFunc(m_ThisPtrOffs + m_VtblOffs, m_VtblIdx); \
dvander@347
  1163
	if (!u.addr) \
dvander@347
  1164
		u.addr = (*reinterpret_cast<void***>(adjustedthisptr + m_VtblOffs))[m_VtblIdx]; \
dvander@347
  1165
	\
dvander@347
  1166
	return (reinterpret_cast<EmptyClass*>(adjustedthisptr)->*u.mfpnew)call; \
dvander@347
  1167
}
dvander@347
  1168
dvander@347
  1169
#elif SH_COMP == SH_COMP_GCC
dvander@347
  1170
dvander@347
  1171
# define SH_MAKE_EXECUTABLECLASS_OB(call, prms) \
dvander@347
  1172
{ \
dvander@347
  1173
	using namespace ::SourceHook; \
dvander@347
  1174
	MemFuncInfo mfi = {true, -1, 0, 0}; \
dvander@347
  1175
	GetFuncInfo(m_CC->GetThisPtr(), m_MFP, mfi); \
dvander@347
  1176
	void *origfunc = m_CC->GetOrigFunc(mfi.thisptroffs + mfi.vtbloffs, mfi.vtblindex); \
dvander@347
  1177
	if (!origfunc) \
dvander@347
  1178
		return (m_CC->GetThisPtr()->*m_MFP)call; \
dvander@347
  1179
	\
dvander@347
  1180
	/* It's hooked. Call the original function. */ \
dvander@347
  1181
	union \
dvander@347
  1182
	{ \
dvander@347
  1183
		RetType(EmptyClass::*mfpnew)prms; \
dvander@347
  1184
		struct \
dvander@347
  1185
		{ \
dvander@347
  1186
			void *addr; \
dvander@347
  1187
			intptr_t adjustor; \
dvander@347
  1188
		} s; \
dvander@347
  1189
	} u; \
dvander@347
  1190
	u.s.addr = origfunc; \
dvander@347
  1191
	u.s.adjustor = mfi.thisptroffs; \
dvander@347
  1192
	\
dvander@347
  1193
	return (reinterpret_cast<EmptyClass*>(m_CC->GetThisPtr())->*u.mfpnew)call; \
dvander@347
  1194
}
dvander@347
  1195
dvander@347
  1196
# define SH_MAKE_MEXECUTABLECLASS_OB(call, prms) \
dvander@347
  1197
{ \
dvander@347
  1198
	using namespace ::SourceHook; \
dvander@347
  1199
	char *thisptr = reinterpret_cast<char*>(m_CC->GetThisPtr()); \
dvander@347
  1200
	union \
dvander@347
  1201
	{ \
dvander@347
  1202
		RetType(EmptyClass::*mfpnew)prms; \
dvander@347
  1203
		struct { \
dvander@347
  1204
			void *addr; \
dvander@347
  1205
			intptr_t adjustor; \
dvander@347
  1206
		} s; \
dvander@347
  1207
	} u; \
dvander@347
  1208
	u.s.addr = m_CC->GetOrigFunc(m_ThisPtrOffs + m_VtblOffs, m_VtblIdx); \
dvander@347
  1209
	if (!u.s.addr) \
dvander@347
  1210
		u.s.addr = (*reinterpret_cast<void***>(thisptr + m_ThisPtrOffs + m_VtblOffs))[m_VtblIdx]; \
dvander@347
  1211
	\
dvander@347
  1212
	u.s.adjustor = m_ThisPtrOffs; \
dvander@347
  1213
	return (reinterpret_cast<EmptyClass*>(thisptr)->*u.mfpnew)call; \
dvander@347
  1214
}
dvander@347
  1215
dvander@347
  1216
#endif
dvander@347
  1217
dvander@347
  1218
namespace SourceHook
dvander@347
  1219
{
dvander@347
  1220
@[$1,0,$a:
dvander@347
  1221
	// Support for $1 arguments
dvander@347
  1222
	template<class CCType, class MFPType, class RetType@[$2,1,$1:, class Param$2@]> class ExecutableClass$1
dvander@347
  1223
	{
dvander@347
  1224
	   CCType *m_CC;
dvander@347
  1225
	   MFPType m_MFP;
dvander@347
  1226
	public:
dvander@347
  1227
	   ExecutableClass$1(CCType *cc, MFPType mfp) : m_CC(cc), m_MFP(mfp) { }
dvander@347
  1228
	
dvander@347
  1229
	   RetType operator()(@[$2,1,$1|, :Param$2 p$2@]) const
dvander@347
  1230
	      SH_MAKE_EXECUTABLECLASS_OB((@[$2,1,$1|, :p$2@]), (@[$2,1,$1|, :Param$2@]))
dvander@347
  1231
	         
dvander@347
  1232
	   @[$2,$1+1,$a:
dvander@347
  1233
	   template <@[$3,$1+1,$2|, :class Param$3@]> RetType operator()(@[$3,1,$2|, :Param$3 p$3@]) const
dvander@347
  1234
	      SH_MAKE_EXECUTABLECLASS_OB((@[$3,1,$2|, :p$3@]), (@[$3,1,$2|, :Param$3@]))
dvander@347
  1235
	   @]
dvander@347
  1236
	};
dvander@347
  1237
dvander@347
  1238
	template <class RetType@[$2,1,$1:, class Param$2@]> class MExecutableClass$1
dvander@347
  1239
	{
dvander@347
  1240
		ManualCallClass *m_CC;
dvander@347
  1241
		int m_ThisPtrOffs;
dvander@347
  1242
		int m_VtblIdx;
dvander@347
  1243
		int m_VtblOffs;
dvander@347
  1244
	public:
dvander@347
  1245
		MExecutableClass$1(ManualCallClass *cc, int vtbloffs, int vtblidx, int thisptroffs) : m_CC(cc),
dvander@347
  1246
			m_ThisPtrOffs(thisptroffs), m_VtblIdx(vtblidx), m_VtblOffs(vtbloffs) { }
dvander@347
  1247
dvander@347
  1248
		RetType operator()(@[$2,1,$1|, :Param$2 p$2@]) const
dvander@347
  1249
			SH_MAKE_MEXECUTABLECLASS_OB((@[$2,1,$1|, :p$2@]), (@[$2,1,$1|, :Param$2@]))
dvander@347
  1250
dvander@347
  1251
		@[$2,$1+1,$a:
dvander@347
  1252
		template <@[$3,$1+1,$2|, :class Param$3@]> RetType operator()(@[$3,1,$2|, :Param$3 p$3@]) const
dvander@347
  1253
			SH_MAKE_MEXECUTABLECLASS_OB((@[$3,1,$2|, :p$3@]), (@[$3,1,$2|, :Param$3@]))
dvander@347
  1254
		@]
dvander@347
  1255
	};
dvander@347
  1256
@]
dvander@347
  1257
dvander@347
  1258
}
dvander@347
  1259
dvander@347
  1260
// SH_CALL needs to deduce the return type -> it uses templates and function overloading
dvander@347
  1261
// That's why SH_CALL takes two parameters: "mfp2" of type RetType(X::*mfp)(params), and "mfp" of type MFP
dvander@347
  1262
// The only purpose of the mfp2 parameter is to extract the return type
dvander@347
  1263
dvander@347
  1264
@[$1,0,$a:
dvander@347
  1265
// Support for $1 arguments
dvander@347
  1266
template <class X, class Y, class MFP, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1267
SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>
dvander@347
  1268
SH_CALL2(SourceHook::CallClass<Y> *ptr, MFP mfp, RetType(X::*mfp2)(@[$2,1,$1|, :Param$2@]))
dvander@347
  1269
{
dvander@347
  1270
	return SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>(ptr, mfp);
dvander@347
  1271
}
dvander@347
  1272
dvander@347
  1273
template <class X, class Y, class MFP, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1274
SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>
dvander@347
  1275
SH_CALL2(SourceHook::CallClass<Y> *ptr, MFP mfp, RetType(X::*mfp2)(@[$2,1,$1|, :Param$2@])const)
dvander@347
  1276
{
dvander@347
  1277
	return SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>(ptr, mfp);
dvander@347
  1278
}
dvander@347
  1279
dvander@347
  1280
template <class X, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1281
SourceHook::MExecutableClass$1<RetType@[$2,1,$1:, Param$2@]>
dvander@347
  1282
SH_MCALL2(SourceHook::ManualCallClass *ptr, RetType(X::*mfp)(@[$2,1,$1|, :Param$2@]), int vtblidx, int vtbloffs, int thisptroffs)
dvander@347
  1283
{
dvander@347
  1284
	return SourceHook::MExecutableClass$1<RetType@[$2,1,$1:, Param$2@]>(ptr, vtbloffs, vtblidx, thisptroffs);
dvander@347
  1285
}
dvander@347
  1286
@]
dvander@347
  1287
dvander@347
  1288
#if SH_COMP != SH_COMP_MSVC || _MSC_VER > 1300
dvander@347
  1289
// GCC & MSVC 7.1 need this, MSVC 7.0 doesn't like it
dvander@347
  1290
dvander@347
  1291
@[$1,0,$a:
dvander@347
  1292
// Support for $1 arguments
dvander@347
  1293
template <class X, class Y, class MFP, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1294
SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>
dvander@347
  1295
SH_CALL2(SourceHook::CallClass<Y> *ptr, MFP mfp, RetType(X::*mfp2)(@[$2,1,$1|, :Param$2@]@[$1!=0:, @]...))
dvander@347
  1296
{
dvander@347
  1297
	return SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>(ptr, mfp);
dvander@347
  1298
}
dvander@347
  1299
dvander@347
  1300
template <class X, class Y, class MFP, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1301
SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>
dvander@347
  1302
SH_CALL2(SourceHook::CallClass<Y> *ptr, MFP mfp, RetType(X::*mfp2)(@[$2,1,$1|, :Param$2@]@[$1!=0:, @]...)const)
dvander@347
  1303
{
dvander@347
  1304
	return SourceHook::ExecutableClass$1<SourceHook::CallClass<Y>, MFP, RetType@[$2,1,$1:, Param$2@]>(ptr, mfp);
dvander@347
  1305
}
dvander@347
  1306
dvander@347
  1307
@]
dvander@347
  1308
dvander@347
  1309
#endif
dvander@347
  1310
dvander@347
  1311
#define SH_CALL(ptr, mfp) SH_CALL2((ptr), (mfp), (mfp))
dvander@347
  1312
#define SH_MCALL(ptr, mhookname) SH_MCALL2((ptr), SH_MFHCls(mhookname)::ECMFP(), SH_MFHCls(mhookname)::ms_MFI.vtblindex, \
dvander@347
  1313
	SH_MFHCls(mhookname)::ms_MFI.vtbloffs, SH_MFHCls(mhookname)::ms_MFI.thisptroffs)
dvander@347
  1314
dvander@347
  1315
#undef SH_MAKE_EXECUTABLECLASS_OB
dvander@347
  1316
dvander@347
  1317
//////////////////////////////////////////////////////////////////////////
dvander@347
  1318
// SetOverrideRet and RecallGetIface for recalls
dvander@347
  1319
// These take a ISourceHook pointer instead of using SH_GLOB_SHPTR directly
dvander@347
  1320
// The reason is that the user may want to redefine SH_GLOB_SHPTR - then the macros
dvander@347
  1321
// (META_RETURN_VALUE_NEWPARAMS) should obey the new pointer.
dvander@347
  1322
dvander@347
  1323
namespace SourceHook
dvander@347
  1324
{
dvander@347
  1325
	template <class RetType>
dvander@347
  1326
	void SetOverrideResult(ISourceHook *shptr, const RetType res)
dvander@347
  1327
	{
dvander@347
  1328
		*reinterpret_cast<RetType*>(shptr->GetOverrideRetPtr()) = res;
dvander@347
  1329
	}
dvander@347
  1330
dvander@347
  1331
	// SetOverrideResult used to be implemented like this:
dvander@347
  1332
	//  SetOverrideResult(shptr, memfuncptr, return);
dvander@347
  1333
	//  normally the compiler can deduce the return type from memfuncptr, but (at least msvc8) failed when it was a reference
dvander@347
  1334
	//  (it thought it was ambigous - the ref and non-ref type)
dvander@347
  1335
	//  so now SetOverrideResult(memfuncptr) deduces the ret type, and returns a functor which does the work
dvander@347
  1336
	//  new syntax: SetOverrideResult(memfuncptr)(shptr, return)
dvander@347
  1337
	// This also allows us to create a special version for references which respects ReferenceCarrier.
dvander@347
  1338
dvander@347
  1339
	template <class T> struct OverrideFunctor
dvander@347
  1340
	{
dvander@347
  1341
		void operator()(ISourceHook *shptr, T res)
dvander@347
  1342
		{
dvander@347
  1343
			*reinterpret_cast<T*>(shptr->GetOverrideRetPtr()) = res;
dvander@347
  1344
		}
dvander@347
  1345
	};
dvander@347
  1346
	template <class T> struct OverrideFunctor<T&>
dvander@347
  1347
	{
dvander@347
  1348
		void operator()(ISourceHook *shptr, T &res)
dvander@347
  1349
		{
dvander@347
  1350
			// overrideretptr points to ReferenceCarrier<T&>
dvander@347
  1351
			*reinterpret_cast<typename ReferenceCarrier<T&>::type *>(shptr->GetOverrideRetPtr()) = res;
dvander@347
  1352
		}
dvander@347
  1353
	};
dvander@347
  1354
@[$1,0,$a:
dvander@347
  1355
	template <class Iface, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1356
	OverrideFunctor<RetType> SetOverrideResult(RetType (Iface::*mfp)(@[$2,1,$1|, :Param$2@]))
dvander@347
  1357
	{
dvander@347
  1358
		return OverrideFunctor<RetType>();
dvander@347
  1359
	}
dvander@347
  1360
dvander@347
  1361
	template <class Iface, class RetType@[$2,1,$1:, class Param$2@]>
dvander@347
  1362
	Iface *RecallGetIface(ISourceHook *shptr, RetType (Iface::*mfp)(@[$2,1,$1|, :Param$2@]))
dvander@347
  1363
	{
dvander@347
  1364
		return reinterpret_cast<Iface*>(shptr->GetIfacePtr());
dvander@347
  1365
	}
dvander@347
  1366
@]
dvander@347
  1367
}
dvander@347
  1368
dvander@347
  1369
#endif
dvander@347
  1370
	// The pope is dead. -> :(