sourcehook/sourcehook_impl.h
author David Anderson <dvander@alliedmods.net>
Tue Sep 18 20:03:47 2007 +0000 (2007-09-18)
branchsourcemm-1.6.0
changeset 347 e82968c21606
child 361 f34718303c8f
permissions -rw-r--r--
branched 1.4.2 to 1.6.0
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
#ifndef __SOURCEHOOK_IMPL_H__
dvander@347
    12
#define __SOURCEHOOK_IMPL_H__
dvander@347
    13
dvander@347
    14
#include "sourcehook.h"
dvander@347
    15
#include "sh_list.h"
dvander@347
    16
#include "sh_vector.h"
dvander@347
    17
#include "sh_tinyhash.h"
dvander@347
    18
#include "sh_stack.h"
dvander@347
    19
dvander@347
    20
/*
dvander@347
    21
dvander@347
    22
IMPLEMENTATION INFO
dvander@347
    23
dvander@347
    24
---------------------------------------
dvander@347
    25
Protos ("Prototypes")
dvander@347
    26
	The purpose of protos is to provide the amount of type information about a function
dvander@347
    27
	which is required to be able to execute a function call without corrupting the stack.
dvander@347
    28
	Our protos do not fully do this, but they provide the size of the return value, the number of
dvander@347
    29
	parameters, and the size of each parameter, which is enough for most situations.
dvander@347
    30
dvander@347
    31
	There are two version of protos:
dvander@347
    32
	OLD:
dvander@347
    33
		C-Style strings.
dvander@347
    34
dvander@347
    35
		0_void:
dvander@347
    36
		"attrib"
dvander@347
    37
		1_void:
dvander@347
    38
		"attrib|param1_type"
dvander@347
    39
		2_void:
dvander@347
    40
		"attrib|param1_type|param2_type
dvander@347
    41
		0:
dvander@347
    42
		"attrib|ret_type"
dvander@347
    43
		1:
dvander@347
    44
		"attrib|ret_type|param1_type"
dvander@347
    45
		2:
dvander@347
    46
		"attrib|ret_type|param2_type"
dvander@347
    47
dvander@347
    48
		Old protos are deprecated.
dvander@347
    49
dvander@347
    50
	NEW:
dvander@347
    51
		New protos are in fact pointers to the ProtoInfo structure (see sourcehook.h)
dvander@347
    52
dvander@347
    53
	Old protos begin with a non-zero byte, new protos begin with a zero byte.
dvander@347
    54
dvander@347
    55
	Protos are usually stored in a CProto instance.
dvander@347
    56
dvander@347
    57
---------------------------------------
dvander@347
    58
Hook managers and hook manager containers
dvander@347
    59
	Each hookman container is tied to _one_ proto/vtable index/vtable offset info.
dvander@347
    60
	Hookman containers then contain a list of hook managers provided by plugins, sorted by version.
dvander@347
    61
	(higher versions come first)
dvander@347
    62
dvander@347
    63
	Duplicate hook managers are ignored (ie. hook managers where proto, vtable index, vtable offset,
dvander@347
    64
	plugin, version are the same as in an already exisiting hook manager)
dvander@347
    65
dvander@347
    66
	A new hook manager is always added to the end of the version group in the corresponding
dvander@347
    67
	hook container. 
dvander@347
    68
dvander@347
    69
	If the new hook manager was added to the beginning of the container (which only happens if
dvander@347
    70
	it is the first one or if it has a higher version than the previously first hook manager),
dvander@347
    71
	the now second hook manager is shut down and the new hook manager takes its job.
dvander@347
    72
dvander@347
    73
	A "hook manager container id" (HMCI) consits of three values: proto, vtbl index, vtbl offset.
dvander@347
    74
---------------------------------------
dvander@347
    75
Hooks 
dvander@347
    76
	When adding a hook, first the proposed hook manager is added to the corresponding
dvander@347
    77
	hook manager container as described above.
dvander@347
    78
dvander@347
    79
	Then the first hook manager in the the manhook container is chosen to handle the function.
dvander@347
    80
dvander@347
    81
	Removing a hook does not neccessarily unreigster the plugin's hook manager. In order to do this,
dvander@347
    82
	use RemoveHookManager or UnloadPlugin/
dvander@347
    83
dvander@347
    84
	Hooks can be paused - they remain in memory but they are not called. In SH, the hook iterator
dvander@347
    85
	classes handle pausing transparently.
dvander@347
    86
dvander@347
    87
	The hook loop is supposed to call ShouldContinue before each iteration. This makes hook handlers
dvander@347
    88
	able to remove themselves.
dvander@347
    89
dvander@347
    90
---------------------------------------
dvander@347
    91
Call classes
dvander@347
    92
	Call classes are identified by a this pointer and an instance size
dvander@347
    93
dvander@347
    94
	We use the instance size because a derived class instance and a base class instance could
dvander@347
    95
	have the same this pointers, and we want to avoid that the derived class
dvander@347
    96
	(which could be bigger) gets the same callclass as the base class (mainly if the
dvander@347
    97
	base class' callclass was requested first).
dvander@347
    98
dvander@347
    99
	Call classes are reference counted.
dvander@347
   100
dvander@347
   101
	The original function pointers are stored in a vector (in order to allow fast random access).
dvander@347
   102
	These vectors are stored as the value type of a hash. The key type is int and represents the
dvander@347
   103
	vtable offset.
dvander@347
   104
dvander@347
   105
	If the hash key doesn't exist or the vtblidx is out of range or the corresponding element in the
dvander@347
   106
	vector is NULL, there is no hook on that function.
dvander@347
   107
dvander@347
   108
---------------------------------------
dvander@347
   109
Recalls
dvander@347
   110
	Recalls are used for the META_RETURN_(VALUE_)NEWPARAMS macros, ie. to change the parameters
dvander@347
   111
	in the hook loop on the fly.
dvander@347
   112
	
dvander@347
   113
	First, the macro calls DoRecall(), then it calls the function the hook is attached to -> it 
dvander@347
   114
	calls the hookfunc. SourceHook makes sure that the newly invoked hook loop starts where the last
dvander@347
   115
	one left off and that status variables like status, previous result, override return are kept.
dvander@347
   116
	When this recurisvely called hookfunc returns, the macro returns what it returned
dvander@347
   117
	(using MRES_SUPERCEDE). CSourceHookImpl returns false from ShouldContinue so the original hook loop
dvander@347
   118
	is abandonned.
dvander@347
   119
dvander@347
   120
Post Recalls
dvander@347
   121
	People wanted to be able to use META_RETURN_(VALUE_)NEWPARAMS from post hooks as well. Crazy people!
dvander@347
   122
	Anyway, for this, we have to know where a hook handler is. Is it executing pre or post hooks at the moment?
dvander@347
   123
	The only way we can know this is watching when it calls CHookList::GetIter(). So CHookList gets a new variable:
dvander@347
   124
	m_RequestedFlag. It also gets two new functions: RQFlagReset() and RQFlagGet().
dvander@347
   125
	HookLoopBegin() calls RQFlagReset on both hooklists of the iface; then DoRecall() checks whether the postlist's 
dvander@347
   126
	RQ flag is set. if yes, the hook loop is in post mode.
dvander@347
   127
dvander@347
   128
	So, what a about a recall in post mode? The first ShouldContinue returns false and sets Status to supercede. 
dvander@347
   129
	This way the pre hooks and the function call will be skipped. Then, then next ShouldContinue returns true, so we get
dvander@347
   130
	into the post hooks. HA!
dvander@347
   131
dvander@347
   132
Return Values in Post Recalls
dvander@347
   133
	The easy case is when we already have an override return value. In this case, the status register gets transferred,
dvander@347
   134
	and so does the override return pointer. So, basically, everything is ok.
dvander@347
   135
dvander@347
   136
	However, what happens if we don't? ie. the status register is on MRES_IGNORED? In this case we'd have to transfer the
dvander@347
   137
	orig ret value. But we can't: There's no way to tell the hookfunc: "Use this as orig ret pointer". It uses its own.
dvander@347
   138
	So, we emulate it. GetOrigRet will return the orig ret pointer from the old hook loop. If still no one overrides it,
dvander@347
   139
	we'd have to return it. BUT! HOW TO DO THIS? Check out SH_RETURN(). First calls HookLoopEnd(), then decides whether
dvander@347
   140
	to return the override retval or the orig retval. But it doesn't ask for a new override return. So we give the function
dvander@347
   141
	the last orig return value as its new override return value; but leave status where it is so everything works, and in
dvander@347
   142
	HookLoopEnd we make sure that status is high enough so that the override return will be returned. crazy.
dvander@347
   143
dvander@347
   144
	All this stuff could be much less complicated if I didn't try to preserve binary compatibility :)
dvander@347
   145
*/
dvander@347
   146
dvander@347
   147
namespace SourceHook
dvander@347
   148
{
dvander@347
   149
	/**
dvander@347
   150
	*	@brief The SourceHook implementation class
dvander@347
   151
	*/
dvander@347
   152
	class CSourceHookImpl : public ISourceHook
dvander@347
   153
	{
dvander@347
   154
	private:
dvander@347
   155
		class CProto
dvander@347
   156
		{
dvander@347
   157
			char *m_Proto;
dvander@347
   158
dvander@347
   159
			static bool Equal(const char *p1, const char *p2);
dvander@347
   160
			char *DupProto(const char *src);
dvander@347
   161
			void FreeProto(char *prot);
dvander@347
   162
		public:
dvander@347
   163
			CProto(const char *szProto) : m_Proto(DupProto(szProto))
dvander@347
   164
			{
dvander@347
   165
			}
dvander@347
   166
dvander@347
   167
			CProto(const CProto &other) : m_Proto(DupProto(other.m_Proto))
dvander@347
   168
			{
dvander@347
   169
			}
dvander@347
   170
dvander@347
   171
			~CProto()
dvander@347
   172
			{
dvander@347
   173
				FreeProto(m_Proto);
dvander@347
   174
				m_Proto = NULL;
dvander@347
   175
			}
dvander@347
   176
dvander@347
   177
			void operator = (const char *szProto)
dvander@347
   178
			{
dvander@347
   179
				m_Proto = DupProto(szProto);
dvander@347
   180
			}
dvander@347
   181
dvander@347
   182
			void operator = (const CProto &other)
dvander@347
   183
			{
dvander@347
   184
				m_Proto = DupProto(other.m_Proto);
dvander@347
   185
			}
dvander@347
   186
dvander@347
   187
			bool operator == (const char *szProto) const
dvander@347
   188
			{
dvander@347
   189
				return Equal(szProto, m_Proto);
dvander@347
   190
			}
dvander@347
   191
			bool operator == (const CProto &other) const
dvander@347
   192
			{
dvander@347
   193
				return Equal(other.m_Proto, m_Proto);
dvander@347
   194
			}
dvander@347
   195
		};
dvander@347
   196
dvander@347
   197
dvander@347
   198
		/**
dvander@347
   199
		*	@brief A hook can be removed if you have this information
dvander@347
   200
		*/
dvander@347
   201
		struct RemoveHookInfo
dvander@347
   202
		{
dvander@347
   203
			RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman,
dvander@347
   204
				ISHDelegate *phandler, bool ppost)
dvander@347
   205
				: plug(pplug), iface(piface), thisptr_offs(tpo),
dvander@347
   206
				hookman(phookman), handler(phandler), post(ppost)
dvander@347
   207
			{
dvander@347
   208
			}
dvander@347
   209
dvander@347
   210
			Plugin plug;
dvander@347
   211
			void *iface;
dvander@347
   212
			int thisptr_offs;
dvander@347
   213
			HookManagerPubFunc hookman;
dvander@347
   214
			ISHDelegate *handler;
dvander@347
   215
			bool post;
dvander@347
   216
		};
dvander@347
   217
dvander@347
   218
		struct RemoveHookManInfo
dvander@347
   219
		{
dvander@347
   220
			RemoveHookManInfo(Plugin pplug, HookManagerPubFunc phookman)
dvander@347
   221
				: plug(pplug), hookman(phookman)
dvander@347
   222
			{
dvander@347
   223
			}
dvander@347
   224
dvander@347
   225
			Plugin plug;
dvander@347
   226
			HookManagerPubFunc hookman;
dvander@347
   227
		};
dvander@347
   228
dvander@347
   229
		struct HookInfo
dvander@347
   230
		{
dvander@347
   231
			ISHDelegate *handler;			//!< Pointer to the handler
dvander@347
   232
			bool paused;					//!< If true, the hook should not be executed
dvander@347
   233
			Plugin plug;					//!< The owner plugin
dvander@347
   234
			int thisptr_offs;				//!< This pointer offset
dvander@347
   235
		};
dvander@347
   236
dvander@347
   237
		class CHookList : public IHookList
dvander@347
   238
		{
dvander@347
   239
		public:
dvander@347
   240
			List<HookInfo> m_List;
dvander@347
   241
dvander@347
   242
			friend class CIter;
dvander@347
   243
dvander@347
   244
			class CIter : public IHookList::IIter
dvander@347
   245
			{
dvander@347
   246
				friend class CHookList;
dvander@347
   247
dvander@347
   248
				CHookList *m_pList;
dvander@347
   249
dvander@347
   250
				void SkipPaused();
dvander@347
   251
			public:
dvander@347
   252
dvander@347
   253
				List<HookInfo>::iterator m_Iter;
dvander@347
   254
dvander@347
   255
				CIter(CHookList *pList);
dvander@347
   256
dvander@347
   257
				virtual ~CIter();
dvander@347
   258
dvander@347
   259
				void GoToBegin();
dvander@347
   260
				void Set(CIter *pOther);
dvander@347
   261
dvander@347
   262
				bool End();
dvander@347
   263
				void Next();
dvander@347
   264
				ISHDelegate *Handler();
dvander@347
   265
				int ThisPtrOffs();
dvander@347
   266
dvander@347
   267
				void Clear();
dvander@347
   268
dvander@347
   269
				CIter *m_pNext;		// When stored in m_FreeIters and m_UsedIters
dvander@347
   270
				CIter *m_pPrev;		// Only used when stored in m_UsedIters
dvander@347
   271
			};
dvander@347
   272
dvander@347
   273
			CIter *m_FreeIters;
dvander@347
   274
			CIter *m_UsedIters;		// The last returned and not-yet-released iter is always m_UsedIters
dvander@347
   275
dvander@347
   276
			// For recalls
dvander@347
   277
			bool m_Recall;
dvander@347
   278
			bool m_RQFlag;
dvander@347
   279
dvander@347
   280
			void SetRecallState();	// Sets the list into a state where the next returned
dvander@347
   281
									// iterator (from GetIter) will be a copy of the last
dvander@347
   282
									// returned iterator, incremented by one. This is used in Recalls.
dvander@347
   283
									// The hook resets this state automatically on:
dvander@347
   284
									// GetIter, ReleaseIter
dvander@347
   285
dvander@347
   286
			void RQFlagReset() { m_RQFlag = false; }
dvander@347
   287
			bool RQFlagGet() { return m_RQFlag; }
dvander@347
   288
			CHookList();
dvander@347
   289
			CHookList(const CHookList &other);
dvander@347
   290
			virtual ~CHookList();
dvander@347
   291
dvander@347
   292
			void operator=(const CHookList &other);
dvander@347
   293
dvander@347
   294
			IIter *GetIter();
dvander@347
   295
			void ReleaseIter(IIter *pIter);
dvander@347
   296
		};
dvander@347
   297
dvander@347
   298
		// I know, data hiding... But I'm a lazy bastard!
dvander@347
   299
dvander@347
   300
		class CIface : public IIface
dvander@347
   301
		{
dvander@347
   302
		public:
dvander@347
   303
			void *m_Ptr;
dvander@347
   304
			CHookList m_PreHooks;
dvander@347
   305
			CHookList m_PostHooks;
dvander@347
   306
		public:
dvander@347
   307
			CIface(void *ptr);
dvander@347
   308
			virtual ~CIface();
dvander@347
   309
dvander@347
   310
			void *GetPtr();
dvander@347
   311
			IHookList *GetPreHooks();
dvander@347
   312
			IHookList *GetPostHooks();
dvander@347
   313
dvander@347
   314
			bool operator==(void *ptr)
dvander@347
   315
			{
dvander@347
   316
				return m_Ptr == ptr;
dvander@347
   317
			}
dvander@347
   318
		};
dvander@347
   319
dvander@347
   320
		class CVfnPtr : public IVfnPtr
dvander@347
   321
		{
dvander@347
   322
		public:
dvander@347
   323
			typedef List<CIface> IfaceList;
dvander@347
   324
			typedef IfaceList::iterator IfaceListIter;
dvander@347
   325
dvander@347
   326
			void *m_Ptr;
dvander@347
   327
			void *m_OrigEntry;
dvander@347
   328
dvander@347
   329
			IfaceList m_Ifaces;
dvander@347
   330
dvander@347
   331
		public:
dvander@347
   332
			CVfnPtr(void *ptr);
dvander@347
   333
			virtual ~CVfnPtr();
dvander@347
   334
dvander@347
   335
			void *GetVfnPtr();
dvander@347
   336
			void *GetOrigEntry();
dvander@347
   337
dvander@347
   338
			virtual IIface *FindIface(void *ptr);
dvander@347
   339
dvander@347
   340
			bool operator==(void *ptr)
dvander@347
   341
			{
dvander@347
   342
				return m_Ptr == ptr;
dvander@347
   343
			}
dvander@347
   344
		};
dvander@347
   345
dvander@347
   346
		class CHookManagerInfo : public IHookManagerInfo
dvander@347
   347
		{
dvander@347
   348
		public:
dvander@347
   349
			typedef List<CVfnPtr> VfnPtrList;
dvander@347
   350
			typedef VfnPtrList::iterator VfnPtrListIter;
dvander@347
   351
dvander@347
   352
			Plugin m_Plug;
dvander@347
   353
			HookManagerPubFunc m_Func;
dvander@347
   354
dvander@347
   355
			int m_VtblOffs;
dvander@347
   356
			int m_VtblIdx;
dvander@347
   357
			const char *m_Proto;
dvander@347
   358
			void *m_HookfuncVfnptr;
dvander@347
   359
dvander@347
   360
			VfnPtrList m_VfnPtrs;
dvander@347
   361
dvander@347
   362
			int m_HookManVersion;
dvander@347
   363
		public:
dvander@347
   364
			CHookManagerInfo();
dvander@347
   365
			virtual ~CHookManagerInfo();
dvander@347
   366
dvander@347
   367
			IVfnPtr *FindVfnPtr(void *vfnptr);
dvander@347
   368
dvander@347
   369
			void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto);
dvander@347
   370
			void SetHookfuncVfnptr(void *hookfunc_vfnptr);
dvander@347
   371
dvander@347
   372
			void SetVersion(int version);
dvander@347
   373
dvander@347
   374
			bool operator < (const CHookManagerInfo &other)
dvander@347
   375
			{
dvander@347
   376
				return m_HookManVersion < other.m_HookManVersion;
dvander@347
   377
			}
dvander@347
   378
dvander@347
   379
			struct Descriptor
dvander@347
   380
			{
dvander@347
   381
				Descriptor(Plugin pplug, HookManagerPubFunc ppubFunc) : plug(pplug), pubFunc(ppubFunc)
dvander@347
   382
				{
dvander@347
   383
				}
dvander@347
   384
dvander@347
   385
				Plugin plug;
dvander@347
   386
				HookManagerPubFunc pubFunc;
dvander@347
   387
			};
dvander@347
   388
dvander@347
   389
			bool operator == (const Descriptor desc)
dvander@347
   390
			{
dvander@347
   391
				return m_Func == desc.pubFunc && m_Plug == desc.plug;
dvander@347
   392
			}
dvander@347
   393
		};
dvander@347
   394
dvander@347
   395
		typedef List<CHookManagerInfo> HookManInfoList;
dvander@347
   396
dvander@347
   397
		class CHookManagerContainer : public HookManInfoList
dvander@347
   398
		{
dvander@347
   399
		public:
dvander@347
   400
			// HMCI (Hook Manager Container Identification)
dvander@347
   401
			class HMCI
dvander@347
   402
			{
dvander@347
   403
				CProto m_Proto;
dvander@347
   404
				int m_VtableOffset;
dvander@347
   405
				int m_VtableIndex;
dvander@347
   406
			public:
dvander@347
   407
				HMCI(const char *proto, int vtbloffs, int vtblidx) :
dvander@347
   408
				  m_Proto(proto), m_VtableOffset(vtbloffs), m_VtableIndex(vtblidx)
dvander@347
   409
				  {
dvander@347
   410
				  }
dvander@347
   411
				  ~HMCI()
dvander@347
   412
				  {
dvander@347
   413
				  }
dvander@347
   414
dvander@347
   415
				  bool operator==(const HMCI &other) const
dvander@347
   416
				  {
dvander@347
   417
					  return
dvander@347
   418
						  other.m_VtableIndex == m_VtableIndex &&
dvander@347
   419
						  other.m_Proto == m_Proto &&
dvander@347
   420
						  other.m_VtableOffset == m_VtableOffset;
dvander@347
   421
				  }
dvander@347
   422
dvander@347
   423
				  const CProto &GetProto() const
dvander@347
   424
				  {
dvander@347
   425
					  return m_Proto;
dvander@347
   426
				  }
dvander@347
   427
				  int GetVtableOffset() const
dvander@347
   428
				  {
dvander@347
   429
					  return m_VtableOffset;
dvander@347
   430
				  }
dvander@347
   431
				  int GetVtableIndex() const
dvander@347
   432
				  {
dvander@347
   433
					  return m_VtableIndex;
dvander@347
   434
				  }
dvander@347
   435
			};
dvander@347
   436
			HMCI m_HCMI;
dvander@347
   437
dvander@347
   438
		public:
dvander@347
   439
			CHookManagerContainer(const HMCI &hmci) : m_HCMI(hmci)
dvander@347
   440
			{
dvander@347
   441
			}
dvander@347
   442
			bool operator == (const HMCI &other) const
dvander@347
   443
			{
dvander@347
   444
				return m_HCMI == other;
dvander@347
   445
			}
dvander@347
   446
			void AddHookManager(Plugin plug, const CHookManagerInfo &hookman);
dvander@347
   447
		};
dvander@347
   448
dvander@347
   449
		class CCallClassImpl : public GenericCallClass
dvander@347
   450
		{
dvander@347
   451
		public:
dvander@347
   452
dvander@347
   453
			typedef SourceHook::CVector<void*> OrigFuncs;
dvander@347
   454
			typedef SourceHook::THash<int, OrigFuncs> OrigVTables;
dvander@347
   455
dvander@347
   456
			void *m_Ptr;			//!< Pointer to the actual object
dvander@347
   457
			size_t m_ObjSize;		//!< Size of the instance
dvander@347
   458
			OrigVTables m_VT;		//!< Info about vtables & functions
dvander@347
   459
dvander@347
   460
			int m_RefCounter;
dvander@347
   461
dvander@347
   462
			CCallClassImpl(void *ptr, size_t size);
dvander@347
   463
			virtual ~CCallClassImpl();
dvander@347
   464
dvander@347
   465
			bool operator==(void *other)
dvander@347
   466
			{
dvander@347
   467
				return m_Ptr == other;
dvander@347
   468
			}
dvander@347
   469
dvander@347
   470
			void *GetThisPtr();
dvander@347
   471
			void *GetOrigFunc(int vtbloffs, int vtblidx);
dvander@347
   472
dvander@347
   473
			void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry);
dvander@347
   474
			void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx);
dvander@347
   475
		};
dvander@347
   476
dvander@347
   477
		/**
dvander@347
   478
		*	@brief A list of CallClass structures
dvander@347
   479
		*/
dvander@347
   480
		typedef List<CCallClassImpl> Impl_CallClassList;
dvander@347
   481
dvander@347
   482
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
dvander@347
   483
dvander@347
   484
		/**
dvander@347
   485
		*	@brief A list of CHookManagerContainers
dvander@347
   486
		*/
dvander@347
   487
		typedef List<CHookManagerContainer> HookManContList;
dvander@347
   488
dvander@347
   489
		HookManContList m_HookMans;					//!< A list of hook managers
dvander@347
   490
dvander@347
   491
		struct HookLoopInfo
dvander@347
   492
		{
dvander@347
   493
			enum RecallType
dvander@347
   494
			{
dvander@347
   495
				Recall_No=0,
dvander@347
   496
				Recall_Pre,
dvander@347
   497
				Recall_Post1,
dvander@347
   498
				Recall_Post2
dvander@347
   499
			};
dvander@347
   500
dvander@347
   501
			META_RES *pStatus;
dvander@347
   502
			META_RES *pPrevRes;
dvander@347
   503
			META_RES *pCurRes;
dvander@347
   504
dvander@347
   505
			META_RES temporaryStatus;				//!< Stored during Post1 recall phase
dvander@347
   506
			bool shouldContinue;
dvander@347
   507
			RecallType recall;						//!< Specifies which kind of recall we're in.
dvander@347
   508
dvander@347
   509
			IIface *pCurIface;
dvander@347
   510
			const void *pOrigRet;
dvander@347
   511
			void *pOverrideRet;
dvander@347
   512
			void **pIfacePtrPtr;
dvander@347
   513
		};
dvander@347
   514
		typedef CStack<HookLoopInfo> HookLoopInfoStack;
dvander@347
   515
dvander@347
   516
		void ApplyCallClassPatches(CCallClassImpl &cc);
dvander@347
   517
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
dvander@347
   518
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
dvander@347
   519
dvander@347
   520
		void SetPluginPaused(Plugin plug, bool paused);
dvander@347
   521
dvander@347
   522
		HookLoopInfoStack m_HLIStack;
dvander@347
   523
	public:
dvander@347
   524
		CSourceHookImpl();
dvander@347
   525
		virtual ~CSourceHookImpl();
dvander@347
   526
dvander@347
   527
		/**
dvander@347
   528
		*	@brief Returns the interface version
dvander@347
   529
		*/
dvander@347
   530
		int GetIfaceVersion();
dvander@347
   531
dvander@347
   532
		/**
dvander@347
   533
		*	@brief Returns the implemnetation version
dvander@347
   534
		*/
dvander@347
   535
		int GetImplVersion();
dvander@347
   536
dvander@347
   537
		/**
dvander@347
   538
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
dvander@347
   539
		*/
dvander@347
   540
		void UnloadPlugin(Plugin plug);
dvander@347
   541
dvander@347
   542
		/**
dvander@347
   543
		*	@brief Shut down the whole system, unregister all hook managers
dvander@347
   544
		*/
dvander@347
   545
		void CompleteShutdown();
dvander@347
   546
dvander@347
   547
		/**
dvander@347
   548
		*	@brief Add a hook.
dvander@347
   549
		*
dvander@347
   550
		*	@return True if the function succeeded, false otherwise
dvander@347
   551
		*
dvander@347
   552
		*	@param plug The unique identifier of the plugin that calls this function
dvander@347
   553
		*	@param iface The interface pointer
dvander@347
   554
		*	@param ifacesize The size of the class iface points to
dvander@347
   555
		*	@param myHookMan A hook manager function that should be capable of handling the function
dvander@347
   556
		*	@param handler A pointer to a FastDelegate containing the hook handler
dvander@347
   557
		*	@param post Set to true if you want a post handler
dvander@347
   558
		*/
dvander@347
   559
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
dvander@347
   560
dvander@347
   561
		/**
dvander@347
   562
		*	@brief Removes a hook.
dvander@347
   563
		*
dvander@347
   564
		*	@return True if the function succeeded, false otherwise
dvander@347
   565
		*
dvander@347
   566
		*	@param plug The unique identifier of the plugin that calls this function
dvander@347
   567
		*	@param iface The interface pointer
dvander@347
   568
		*	@param thisptr_offs This pointer adjuster
dvander@347
   569
		*	@param myHookMan A hook manager function that should be capable of handling the function
dvander@347
   570
		*	@param handler A pointer to a FastDelegate containing the hook handler
dvander@347
   571
		*	@param post Set to true if you want a post handler
dvander@347
   572
		*/
dvander@347
   573
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
dvander@347
   574
dvander@347
   575
		/**
dvander@347
   576
		*	@brief Removes a hook.
dvander@347
   577
		*
dvander@347
   578
		*	@ return True if the function succeeded, false otherwise
dvander@347
   579
		*
dvander@347
   580
		*	@param info A RemoveHookInfo structure, describing the hook
dvander@347
   581
		*/
dvander@347
   582
		bool RemoveHook(RemoveHookInfo info);
dvander@347
   583
dvander@347
   584
		/**
dvander@347
   585
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
dvander@347
   586
		*
dvander@347
   587
		*	@param plug The unique identifier of the plugin in question
dvander@347
   588
		*/
dvander@347
   589
		bool IsPluginInUse(Plugin plug);
dvander@347
   590
dvander@347
   591
		/**
dvander@347
   592
		*	@brief Pauses all hooks of a plugin
dvander@347
   593
		*
dvander@347
   594
		*	@param plug The unique identifier of the plugin
dvander@347
   595
		*/
dvander@347
   596
		void PausePlugin(Plugin plug);
dvander@347
   597
dvander@347
   598
		/**
dvander@347
   599
		*	@brief Unpauses all hooks of a plugin
dvander@347
   600
		*
dvander@347
   601
		*	@param plug The unique identifier of the plugin
dvander@347
   602
		*/
dvander@347
   603
		void UnpausePlugin(Plugin plug);
dvander@347
   604
dvander@347
   605
		/**
dvander@347
   606
		*	@brief Return a pointer to a callclass. Generate a new one if required.
dvander@347
   607
		*
dvander@347
   608
		*	@param iface The interface pointer
dvander@347
   609
		*	@param size Size of the class instance
dvander@347
   610
		*/
dvander@347
   611
		GenericCallClass *GetCallClass(void *iface, size_t size);
dvander@347
   612
dvander@347
   613
		/**
dvander@347
   614
		*	@brief Release a callclass
dvander@347
   615
		*
dvander@347
   616
		*	@param ptr Pointer to the callclass
dvander@347
   617
		*/
dvander@347
   618
		virtual void ReleaseCallClass(GenericCallClass *ptr);
dvander@347
   619
dvander@347
   620
		virtual void SetRes(META_RES res);				//!< Sets the meta result
dvander@347
   621
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
dvander@347
   622
		virtual META_RES GetStatus();					//!< Gets the highest meta result
dvander@347
   623
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
dvander@347
   624
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
dvander@347
   625
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
dvander@347
   626
dvander@347
   627
		//////////////////////////////////////////////////////////////////////////
dvander@347
   628
		// For hook managers
dvander@347
   629
		void HookLoopBegin(IIface *pIface);			//!< Should be called when a hook loop begins
dvander@347
   630
		void HookLoopEnd();							//!< Should be called when a hook loop exits
dvander@347
   631
		void SetCurResPtr(META_RES *mres);			//!< Sets pointer to the current meta result
dvander@347
   632
		void SetPrevResPtr(META_RES *mres);			//!< Sets pointer to previous meta result
dvander@347
   633
		void SetStatusPtr(META_RES *mres);			//!< Sets pointer to the status variable
dvander@347
   634
		void SetIfacePtrPtr(void **pp);				//!< Sets pointer to the interface this pointer
dvander@347
   635
		void SetOrigRetPtr(const void *ptr);		//!< Sets the original return pointer
dvander@347
   636
		void SetOverrideRetPtr(void *ptr);			//!< Sets the override result pointer
dvander@347
   637
		bool ShouldContinue();						//!< Returns false if the hook loop should exit
dvander@347
   638
dvander@347
   639
		/**
dvander@347
   640
		*	@brief Remove a hook manager. Auto-removes all hooks attached to it from plugin plug.
dvander@347
   641
		*
dvander@347
   642
		*	@param plug The owner of the hook manager
dvander@347
   643
		*   @param pubFunc The hook manager's info function
dvander@347
   644
		*/
dvander@347
   645
		virtual void RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc);
dvander@347
   646
		virtual void RemoveHookManager(RemoveHookManInfo info);
dvander@347
   647
dvander@347
   648
		virtual void DoRecall();					//!< Initiates a recall sequence
dvander@347
   649
		virtual void *GetOverrideRetPtr();			//!< Returns the pointer set by SetOverrideRetPtr
dvander@347
   650
dvander@347
   651
		virtual void *SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr,
dvander@347
   652
			void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr);
dvander@347
   653
	};
dvander@347
   654
}
dvander@347
   655
dvander@347
   656
#endif