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