sourcehook/sourcehook_impl.h
author Pavol Marko <pavolmarko@gmail.com>
Fri Dec 23 23:00:55 2005 +0000 (2005-12-23)
changeset 163 377bdd31c28d
parent 162 a95db73792e5
child 179 3ade923f508b
permissions -rw-r--r--
Added insert(iterator where, const T &what) to sh_list and simplified it on the occasion, hook managers now have (optional) version numbers, everything somehow works! Also changed _NEWPARAMS macro syntax a bit
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@163
   119
*/
pavolmarko@163
   120
pavolmarko@1
   121
namespace SourceHook
pavolmarko@1
   122
{
pavolmarko@1
   123
	/**
pavolmarko@1
   124
	*	@brief The SourceHook implementation class
pavolmarko@1
   125
	*/
pavolmarko@1
   126
	class CSourceHookImpl : public ISourceHook
pavolmarko@1
   127
	{
pavolmarko@117
   128
	private:
pavolmarko@163
   129
		class CProto
pavolmarko@163
   130
		{
pavolmarko@163
   131
			const char *m_Proto;
pavolmarko@163
   132
pavolmarko@163
   133
			static bool Equal(const char *p1, const char *p2);
pavolmarko@163
   134
		public:
pavolmarko@163
   135
			CProto(const char *szProto) : m_Proto(szProto)
pavolmarko@163
   136
			{
pavolmarko@163
   137
			}
pavolmarko@163
   138
pavolmarko@163
   139
			CProto(const CProto &other) : m_Proto(other.m_Proto)
pavolmarko@163
   140
			{
pavolmarko@163
   141
			}
pavolmarko@163
   142
pavolmarko@163
   143
			void operator = (const char *szProto)
pavolmarko@163
   144
			{
pavolmarko@163
   145
				m_Proto = szProto;
pavolmarko@163
   146
			}
pavolmarko@163
   147
			void operator = (const CProto &other)
pavolmarko@163
   148
			{
pavolmarko@163
   149
				m_Proto = other.m_Proto;
pavolmarko@163
   150
			}
pavolmarko@163
   151
pavolmarko@163
   152
			bool operator == (const char *szProto) const
pavolmarko@163
   153
			{
pavolmarko@163
   154
				return Equal(szProto, m_Proto);
pavolmarko@163
   155
			}
pavolmarko@163
   156
			bool operator == (const CProto &other) const
pavolmarko@163
   157
			{
pavolmarko@163
   158
				return Equal(other.m_Proto, m_Proto);
pavolmarko@163
   159
			}
pavolmarko@163
   160
		};
pavolmarko@163
   161
pavolmarko@163
   162
pavolmarko@1
   163
		/**
pavolmarko@6
   164
		*	@brief A hook can be removed if you have this information
pavolmarko@1
   165
		*/
pavolmarko@6
   166
		struct RemoveHookInfo
pavolmarko@6
   167
		{
pavolmarko@58
   168
			RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman,
pavolmarko@41
   169
				ISHDelegate *phandler, bool ppost)
pavolmarko@58
   170
				: plug(pplug), iface(piface), thisptr_offs(tpo),
pavolmarko@58
   171
				hookman(phookman), handler(phandler), post(ppost)
pavolmarko@6
   172
			{
pavolmarko@6
   173
			}
pavolmarko@6
   174
pavolmarko@6
   175
			Plugin plug;
pavolmarko@6
   176
			void *iface;
pavolmarko@58
   177
			int thisptr_offs;
pavolmarko@41
   178
			HookManagerPubFunc hookman;
pavolmarko@6
   179
			ISHDelegate *handler;
pavolmarko@6
   180
			bool post;
pavolmarko@6
   181
		};
pavolmarko@6
   182
pavolmarko@163
   183
		struct RemoveHookManInfo
pavolmarko@163
   184
		{
pavolmarko@163
   185
			RemoveHookManInfo(Plugin pplug, HookManagerPubFunc phookman)
pavolmarko@163
   186
				: plug(pplug), hookman(phookman)
pavolmarko@163
   187
			{
pavolmarko@163
   188
			}
pavolmarko@163
   189
pavolmarko@163
   190
			Plugin plug;
pavolmarko@163
   191
			HookManagerPubFunc hookman;
pavolmarko@163
   192
		};
pavolmarko@163
   193
pavolmarko@117
   194
		struct HookInfo
pavolmarko@117
   195
		{
pavolmarko@117
   196
			ISHDelegate *handler;			//!< Pointer to the handler
pavolmarko@117
   197
			bool paused;					//!< If true, the hook should not be executed
pavolmarko@117
   198
			Plugin plug;					//!< The owner plugin
pavolmarko@117
   199
			int thisptr_offs;				//!< This pointer offset
pavolmarko@117
   200
		};
pavolmarko@117
   201
pavolmarko@117
   202
		class CHookList : public IHookList
pavolmarko@117
   203
		{
pavolmarko@117
   204
		public:
pavolmarko@117
   205
			List<HookInfo> m_List;
pavolmarko@117
   206
pavolmarko@117
   207
			friend class CIter;
pavolmarko@117
   208
pavolmarko@117
   209
			class CIter : public IHookList::IIter
pavolmarko@117
   210
			{
pavolmarko@117
   211
				friend class CHookList;
pavolmarko@117
   212
pavolmarko@117
   213
				CHookList *m_pList;
pavolmarko@117
   214
pavolmarko@117
   215
				void SkipPaused();
pavolmarko@117
   216
			public:
pavolmarko@121
   217
pavolmarko@121
   218
				List<HookInfo>::iterator m_Iter;
pavolmarko@121
   219
pavolmarko@117
   220
				CIter(CHookList *pList);
pavolmarko@117
   221
pavolmarko@117
   222
				virtual ~CIter();
pavolmarko@117
   223
pavolmarko@117
   224
				void GoToBegin();
pavolmarko@162
   225
				void Set(CIter *pOther);
pavolmarko@117
   226
pavolmarko@117
   227
				bool End();
pavolmarko@117
   228
				void Next();
pavolmarko@117
   229
				ISHDelegate *Handler();
pavolmarko@117
   230
				int ThisPtrOffs();
pavolmarko@117
   231
pavolmarko@121
   232
				void Clear();
pavolmarko@121
   233
pavolmarko@121
   234
				CIter *m_pNext;		// When stored in m_FreeIters and m_UsedIters
pavolmarko@121
   235
				CIter *m_pPrev;		// Only used when stored in m_UsedIters
pavolmarko@117
   236
			};
pavolmarko@117
   237
pavolmarko@117
   238
			CIter *m_FreeIters;
pavolmarko@162
   239
			CIter *m_UsedIters;		// The last returned and not-yet-released iter is always m_UsedIters
pavolmarko@162
   240
pavolmarko@162
   241
			// For recalls
pavolmarko@162
   242
			bool m_Recall;
pavolmarko@162
   243
pavolmarko@162
   244
			void SetRecallState();	// Sets the list into a state where the next returned
pavolmarko@162
   245
									// iterator (from GetIter) will be a copy of the last
pavolmarko@162
   246
									// returned iterator, incremented by one. This is used in Recalls.
pavolmarko@162
   247
									// The hook resets this state automatically on:
pavolmarko@162
   248
									// GetIter, ReleaseIter
pavolmarko@117
   249
pavolmarko@117
   250
			CHookList();
pavolmarko@117
   251
			CHookList(const CHookList &other);
pavolmarko@117
   252
			virtual ~CHookList();
pavolmarko@117
   253
pavolmarko@117
   254
			void operator=(const CHookList &other);
pavolmarko@117
   255
pavolmarko@117
   256
			IIter *GetIter();
pavolmarko@117
   257
			void ReleaseIter(IIter *pIter);
pavolmarko@117
   258
		};
pavolmarko@117
   259
pavolmarko@117
   260
		// I know, data hiding... But I'm a lazy bastard!
pavolmarko@117
   261
pavolmarko@117
   262
		class CIface : public IIface
pavolmarko@117
   263
		{
pavolmarko@117
   264
		public:
pavolmarko@117
   265
			void *m_Ptr;
pavolmarko@117
   266
			CHookList m_PreHooks;
pavolmarko@117
   267
			CHookList m_PostHooks;
pavolmarko@117
   268
		public:
pavolmarko@117
   269
			CIface(void *ptr);
pavolmarko@117
   270
			virtual ~CIface();
pavolmarko@117
   271
pavolmarko@117
   272
			void *GetPtr();
pavolmarko@117
   273
			IHookList *GetPreHooks();
pavolmarko@117
   274
			IHookList *GetPostHooks();
pavolmarko@117
   275
pavolmarko@117
   276
			bool operator==(void *ptr)
pavolmarko@117
   277
			{
pavolmarko@117
   278
				return m_Ptr == ptr;
pavolmarko@117
   279
			}
pavolmarko@117
   280
		};
pavolmarko@1
   281
pavolmarko@117
   282
		class CVfnPtr : public IVfnPtr
pavolmarko@117
   283
		{
pavolmarko@117
   284
		public:
pavolmarko@117
   285
			typedef List<CIface> IfaceList;
pavolmarko@117
   286
			typedef IfaceList::iterator IfaceListIter;
pavolmarko@117
   287
pavolmarko@117
   288
			void *m_Ptr;
pavolmarko@117
   289
			void *m_OrigEntry;
pavolmarko@117
   290
pavolmarko@117
   291
			IfaceList m_Ifaces;
pavolmarko@117
   292
pavolmarko@117
   293
		public:
pavolmarko@117
   294
			CVfnPtr(void *ptr);
pavolmarko@117
   295
			virtual ~CVfnPtr();
pavolmarko@117
   296
pavolmarko@117
   297
			void *GetVfnPtr();
pavolmarko@117
   298
			void *GetOrigEntry();
pavolmarko@117
   299
pavolmarko@117
   300
			virtual IIface *FindIface(void *ptr);
pavolmarko@117
   301
pavolmarko@117
   302
			bool operator==(void *ptr)
pavolmarko@117
   303
			{
pavolmarko@117
   304
				return m_Ptr == ptr;
pavolmarko@117
   305
			}
pavolmarko@117
   306
		};
pavolmarko@117
   307
pavolmarko@117
   308
		class CHookManagerInfo : public IHookManagerInfo
pavolmarko@41
   309
		{
pavolmarko@117
   310
		public:
pavolmarko@117
   311
			typedef List<CVfnPtr> VfnPtrList;
pavolmarko@117
   312
			typedef VfnPtrList::iterator VfnPtrListIter;
pavolmarko@117
   313
pavolmarko@117
   314
			Plugin m_Plug;
pavolmarko@117
   315
			HookManagerPubFunc m_Func;
pavolmarko@117
   316
pavolmarko@117
   317
			int m_VtblOffs;
pavolmarko@117
   318
			int m_VtblIdx;
pavolmarko@117
   319
			const char *m_Proto;
pavolmarko@117
   320
			void *m_HookfuncVfnptr;
pavolmarko@117
   321
pavolmarko@117
   322
			VfnPtrList m_VfnPtrs;
pavolmarko@117
   323
pavolmarko@163
   324
			int m_HookManVersion;
pavolmarko@117
   325
		public:
pavolmarko@163
   326
			CHookManagerInfo();
pavolmarko@117
   327
			virtual ~CHookManagerInfo();
pavolmarko@117
   328
pavolmarko@117
   329
			IVfnPtr *FindVfnPtr(void *vfnptr);
pavolmarko@117
   330
pavolmarko@117
   331
			void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto);
pavolmarko@117
   332
			void SetHookfuncVfnptr(void *hookfunc_vfnptr);
pavolmarko@163
   333
pavolmarko@163
   334
			void SetVersion(int version);
pavolmarko@163
   335
pavolmarko@163
   336
			bool operator < (const CHookManagerInfo &other)
pavolmarko@163
   337
			{
pavolmarko@163
   338
				return m_HookManVersion < other.m_HookManVersion;
pavolmarko@163
   339
			}
pavolmarko@163
   340
pavolmarko@163
   341
			struct Descriptor
pavolmarko@163
   342
			{
pavolmarko@163
   343
				Descriptor(Plugin pplug, HookManagerPubFunc ppubFunc) : plug(pplug), pubFunc(ppubFunc)
pavolmarko@163
   344
				{
pavolmarko@163
   345
				}
pavolmarko@163
   346
pavolmarko@163
   347
				Plugin plug;
pavolmarko@163
   348
				HookManagerPubFunc pubFunc;
pavolmarko@163
   349
			};
pavolmarko@163
   350
pavolmarko@163
   351
			bool operator == (const Descriptor desc)
pavolmarko@163
   352
			{
pavolmarko@163
   353
				return m_Func == desc.pubFunc && m_Plug == desc.plug;
pavolmarko@163
   354
			}
pavolmarko@117
   355
		};
pavolmarko@163
   356
pavolmarko@117
   357
		typedef List<CHookManagerInfo> HookManInfoList;
pavolmarko@117
   358
pavolmarko@163
   359
		class CHookManagerContainer : public HookManInfoList
pavolmarko@163
   360
		{
pavolmarko@163
   361
		public:
pavolmarko@163
   362
			// HMCI (Hook Manager Container Identification)
pavolmarko@163
   363
			class HMCI
pavolmarko@163
   364
			{
pavolmarko@163
   365
				CProto m_Proto;
pavolmarko@163
   366
				int m_VtableOffset;
pavolmarko@163
   367
				int m_VtableIndex;
pavolmarko@163
   368
			public:
pavolmarko@163
   369
				HMCI(const char *proto, int vtbloffs, int vtblidx) :
pavolmarko@163
   370
				  m_Proto(proto), m_VtableOffset(vtbloffs), m_VtableIndex(vtblidx)
pavolmarko@163
   371
				  {
pavolmarko@163
   372
				  }
pavolmarko@163
   373
				  ~HMCI()
pavolmarko@163
   374
				  {
pavolmarko@163
   375
				  }
pavolmarko@163
   376
pavolmarko@163
   377
				  bool operator==(const HMCI &other) const
pavolmarko@163
   378
				  {
pavolmarko@163
   379
					  return
pavolmarko@163
   380
						  other.m_VtableIndex == m_VtableIndex &&
pavolmarko@163
   381
						  other.m_Proto == m_Proto &&
pavolmarko@163
   382
						  other.m_VtableOffset == m_VtableOffset;
pavolmarko@163
   383
				  }
pavolmarko@163
   384
pavolmarko@163
   385
				  const CProto &GetProto() const
pavolmarko@163
   386
				  {
pavolmarko@163
   387
					  return m_Proto;
pavolmarko@163
   388
				  }
pavolmarko@163
   389
				  int GetVtableOffset() const
pavolmarko@163
   390
				  {
pavolmarko@163
   391
					  return m_VtableOffset;
pavolmarko@163
   392
				  }
pavolmarko@163
   393
				  int GetVtableIndex() const
pavolmarko@163
   394
				  {
pavolmarko@163
   395
					  return m_VtableIndex;
pavolmarko@163
   396
				  }
pavolmarko@163
   397
			};
pavolmarko@163
   398
			HMCI m_HCMI;
pavolmarko@163
   399
pavolmarko@163
   400
		public:
pavolmarko@163
   401
			CHookManagerContainer(const HMCI &hmci) : m_HCMI(hmci)
pavolmarko@163
   402
			{
pavolmarko@163
   403
			}
pavolmarko@163
   404
			bool operator == (const HMCI &other) const
pavolmarko@163
   405
			{
pavolmarko@163
   406
				return m_HCMI == other;
pavolmarko@163
   407
			}
pavolmarko@163
   408
			void AddHookManager(Plugin plug, const CHookManagerInfo &hookman);
pavolmarko@163
   409
		};
pavolmarko@163
   410
pavolmarko@117
   411
		class CCallClassImpl : public GenericCallClass
pavolmarko@117
   412
		{
pavolmarko@117
   413
		public:
pavolmarko@117
   414
pavolmarko@117
   415
			typedef SourceHook::CVector<void*> OrigFuncs;
pavolmarko@117
   416
			typedef SourceHook::THash<int, OrigFuncs> OrigVTables;
pavolmarko@117
   417
pavolmarko@117
   418
			void *m_Ptr;			//!< Pointer to the actual object
pavolmarko@117
   419
			size_t m_ObjSize;		//!< Size of the instance
pavolmarko@117
   420
			OrigVTables m_VT;		//!< Info about vtables & functions
pavolmarko@117
   421
pavolmarko@117
   422
			int m_RefCounter;
pavolmarko@117
   423
pavolmarko@117
   424
			CCallClassImpl(void *ptr, size_t size);
pavolmarko@117
   425
			virtual ~CCallClassImpl();
pavolmarko@117
   426
pavolmarko@41
   427
			bool operator==(void *other)
pavolmarko@41
   428
			{
pavolmarko@117
   429
				return m_Ptr == other;
pavolmarko@41
   430
			}
pavolmarko@117
   431
pavolmarko@117
   432
			void *GetThisPtr();
pavolmarko@117
   433
			void *GetOrigFunc(int vtbloffs, int vtblidx);
pavolmarko@117
   434
pavolmarko@117
   435
			void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@117
   436
			void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx);
pavolmarko@41
   437
		};
pavolmarko@117
   438
pavolmarko@1
   439
		/**
pavolmarko@41
   440
		*	@brief A list of CallClass structures
pavolmarko@1
   441
		*/
pavolmarko@117
   442
		typedef List<CCallClassImpl> Impl_CallClassList;
pavolmarko@1
   443
pavolmarko@1
   444
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@163
   445
pavolmarko@163
   446
		/**
pavolmarko@163
   447
		*	@brief A list of CHookManagerContainers
pavolmarko@163
   448
		*/
pavolmarko@163
   449
		typedef List<CHookManagerContainer> HookManContList;
pavolmarko@163
   450
pavolmarko@163
   451
		HookManContList m_HookMans;					//!< A list of hook managers
pavolmarko@1
   452
pavolmarko@128
   453
		struct HookLoopInfo
pavolmarko@128
   454
		{
pavolmarko@128
   455
			META_RES *pStatus;
pavolmarko@128
   456
			META_RES *pPrevRes;
pavolmarko@128
   457
			META_RES *pCurRes;
pavolmarko@128
   458
pavolmarko@128
   459
			bool shouldContinue;
pavolmarko@162
   460
			bool recall;							//!< True if we're in a recall, eh.
pavolmarko@128
   461
pavolmarko@128
   462
			IIface *pCurIface;
pavolmarko@128
   463
			const void *pOrigRet;
pavolmarko@162
   464
			void *pOverrideRet;
pavolmarko@128
   465
			void **pIfacePtrPtr;
pavolmarko@128
   466
		};
pavolmarko@128
   467
		typedef CStack<HookLoopInfo> HookLoopInfoStack;
pavolmarko@128
   468
pavolmarko@117
   469
		void ApplyCallClassPatches(CCallClassImpl &cc);
pavolmarko@58
   470
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@58
   471
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
pavolmarko@1
   472
pavolmarko@117
   473
		void SetPluginPaused(Plugin plug, bool paused);
pavolmarko@117
   474
pavolmarko@128
   475
		HookLoopInfoStack m_HLIStack;
pavolmarko@1
   476
	public:
pavolmarko@1
   477
		CSourceHookImpl();
pavolmarko@117
   478
		virtual ~CSourceHookImpl();
pavolmarko@1
   479
pavolmarko@1
   480
		/**
pavolmarko@58
   481
		*	@brief Returns the interface version
pavolmarko@58
   482
		*/
pavolmarko@58
   483
		int GetIfaceVersion();
pavolmarko@58
   484
pavolmarko@58
   485
		/**
pavolmarko@58
   486
		*	@brief Returns the implemnetation version
pavolmarko@58
   487
		*/
pavolmarko@58
   488
		int GetImplVersion();
pavolmarko@58
   489
pavolmarko@58
   490
		/**
pavolmarko@6
   491
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
   492
		*/
pavolmarko@1
   493
		void UnloadPlugin(Plugin plug);
pavolmarko@1
   494
pavolmarko@1
   495
		/**
pavolmarko@6
   496
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
   497
		*/
pavolmarko@1
   498
		void CompleteShutdown();
pavolmarko@1
   499
pavolmarko@1
   500
		/**
pavolmarko@1
   501
		*	@brief Add a hook.
pavolmarko@1
   502
		*
pavolmarko@1
   503
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   504
		*
pavolmarko@1
   505
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   506
		*	@param iface The interface pointer
pavolmarko@6
   507
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
   508
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   509
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   510
		*	@param post Set to true if you want a post handler
pavolmarko@1
   511
		*/
pavolmarko@41
   512
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   513
pavolmarko@1
   514
		/**
pavolmarko@1
   515
		*	@brief Removes a hook.
pavolmarko@1
   516
		*
pavolmarko@1
   517
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   518
		*
pavolmarko@1
   519
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   520
		*	@param iface The interface pointer
pavolmarko@41
   521
		*	@param thisptr_offs This pointer adjuster
pavolmarko@41
   522
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@41
   523
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@41
   524
		*	@param post Set to true if you want a post handler
pavolmarko@41
   525
		*/
pavolmarko@41
   526
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@41
   527
pavolmarko@41
   528
		/**
pavolmarko@41
   529
		*	@brief Removes a hook.
pavolmarko@41
   530
		*
pavolmarko@41
   531
		*	@ return True if the function succeeded, false otherwise
pavolmarko@41
   532
		*
pavolmarko@41
   533
		*	@param info A RemoveHookInfo structure, describing the hook
pavolmarko@41
   534
		*/
pavolmarko@41
   535
		bool RemoveHook(RemoveHookInfo info);
pavolmarko@41
   536
pavolmarko@41
   537
		/**
pavolmarko@6
   538
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   539
		*
pavolmarko@1
   540
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   541
		*/
pavolmarko@1
   542
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   543
pavolmarko@1
   544
		/**
pavolmarko@8
   545
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   546
		*
pavolmarko@8
   547
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   548
		*/
pavolmarko@8
   549
		void PausePlugin(Plugin plug);
pavolmarko@8
   550
pavolmarko@8
   551
		/**
pavolmarko@8
   552
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   553
		*
pavolmarko@8
   554
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   555
		*/
pavolmarko@8
   556
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   557
pavolmarko@8
   558
		/**
pavolmarko@1
   559
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   560
		*
pavolmarko@1
   561
		*	@param iface The interface pointer
pavolmarko@58
   562
		*	@param size Size of the class instance
pavolmarko@1
   563
		*/
pavolmarko@58
   564
		GenericCallClass *GetCallClass(void *iface, size_t size);
pavolmarko@1
   565
pavolmarko@1
   566
		/**
pavolmarko@1
   567
		*	@brief Release a callclass
pavolmarko@1
   568
		*
pavolmarko@1
   569
		*	@param ptr Pointer to the callclass
pavolmarko@1
   570
		*/
pavolmarko@41
   571
		virtual void ReleaseCallClass(GenericCallClass *ptr);
pavolmarko@1
   572
pavolmarko@1
   573
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   574
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   575
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   576
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   577
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   578
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   579
pavolmarko@1
   580
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   581
		// For hook managers
pavolmarko@128
   582
		void HookLoopBegin(IIface *pIface);			//!< Should be called when a hook loop begins
pavolmarko@128
   583
		void HookLoopEnd();							//!< Should be called when a hook loop exits
pavolmarko@128
   584
		void SetCurResPtr(META_RES *mres);			//!< Sets pointer to the current meta result
pavolmarko@128
   585
		void SetPrevResPtr(META_RES *mres);			//!< Sets pointer to previous meta result
pavolmarko@128
   586
		void SetStatusPtr(META_RES *mres);			//!< Sets pointer to the status variable
pavolmarko@128
   587
		void SetIfacePtrPtr(void **pp);				//!< Sets pointer to the interface this pointer
pavolmarko@128
   588
		void SetOrigRetPtr(const void *ptr);		//!< Sets the original return pointer
pavolmarko@162
   589
		void SetOverrideRetPtr(void *ptr);			//!< Sets the override result pointer
pavolmarko@128
   590
		bool ShouldContinue();						//!< Returns false if the hook loop should exit
pavolmarko@157
   591
pavolmarko@157
   592
		/**
pavolmarko@157
   593
		*	@brief Remove a hook manager. Auto-removes all hooks attached to it from plugin plug.
pavolmarko@157
   594
		*
pavolmarko@157
   595
		*	@param plug The owner of the hook manager
pavolmarko@157
   596
		*   @param pubFunc The hook manager's info function
pavolmarko@157
   597
		*/
pavolmarko@157
   598
		virtual void RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc);
pavolmarko@163
   599
		virtual void RemoveHookManager(RemoveHookManInfo info);
pavolmarko@163
   600
pavolmarko@162
   601
		virtual void DoRecall();					//!< Initiates a recall sequence
pavolmarko@162
   602
		virtual void *GetOverrideRetPtr();			//!< Returns the pointer set by SetOverrideRetPtr
pavolmarko@162
   603
pavolmarko@162
   604
		virtual void *SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr,
pavolmarko@162
   605
			void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr);
pavolmarko@1
   606
	};
pavolmarko@1
   607
}
pavolmarko@1
   608
dvander@34
   609
#endif
dvander@34
   610