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