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