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