sourcehook/sourcehook_impl.h
author Pavol Marko <pavolmarko@gmail.com>
Fri Dec 23 11:58:11 2005 +0000 (2005-12-23)
changeset 162 a95db73792e5
parent 157 064f77cac7ab
child 163 377bdd31c28d
permissions -rw-r--r--
One bugfix, addition of META_RETURN_(VALUE_)NEWPARAMS (implemented using recalls), tests now support compiling against an older version of sourcehook.h (through the sourcehook_test.h file) while main.cpp which now also acts as a CSourceHookImpl factory compiles against the new version.
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@1
    20
namespace SourceHook
pavolmarko@1
    21
{
pavolmarko@1
    22
	/**
pavolmarko@1
    23
	*	@brief The SourceHook implementation class
pavolmarko@1
    24
	*/
pavolmarko@1
    25
	class CSourceHookImpl : public ISourceHook
pavolmarko@1
    26
	{
pavolmarko@117
    27
	private:
pavolmarko@1
    28
		/**
pavolmarko@6
    29
		*	@brief A hook can be removed if you have this information
pavolmarko@1
    30
		*/
pavolmarko@6
    31
		struct RemoveHookInfo
pavolmarko@6
    32
		{
pavolmarko@58
    33
			RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman,
pavolmarko@41
    34
				ISHDelegate *phandler, bool ppost)
pavolmarko@58
    35
				: plug(pplug), iface(piface), thisptr_offs(tpo),
pavolmarko@58
    36
				hookman(phookman), handler(phandler), post(ppost)
pavolmarko@6
    37
			{
pavolmarko@6
    38
			}
pavolmarko@6
    39
pavolmarko@6
    40
			Plugin plug;
pavolmarko@6
    41
			void *iface;
pavolmarko@58
    42
			int thisptr_offs;
pavolmarko@41
    43
			HookManagerPubFunc hookman;
pavolmarko@6
    44
			ISHDelegate *handler;
pavolmarko@6
    45
			bool post;
pavolmarko@6
    46
		};
pavolmarko@6
    47
pavolmarko@117
    48
		struct HookInfo
pavolmarko@117
    49
		{
pavolmarko@117
    50
			ISHDelegate *handler;			//!< Pointer to the handler
pavolmarko@117
    51
			bool paused;					//!< If true, the hook should not be executed
pavolmarko@117
    52
			Plugin plug;					//!< The owner plugin
pavolmarko@117
    53
			int thisptr_offs;				//!< This pointer offset
pavolmarko@117
    54
		};
pavolmarko@117
    55
pavolmarko@117
    56
		class CHookList : public IHookList
pavolmarko@117
    57
		{
pavolmarko@117
    58
		public:
pavolmarko@117
    59
			List<HookInfo> m_List;
pavolmarko@117
    60
pavolmarko@117
    61
			friend class CIter;
pavolmarko@117
    62
pavolmarko@117
    63
			class CIter : public IHookList::IIter
pavolmarko@117
    64
			{
pavolmarko@117
    65
				friend class CHookList;
pavolmarko@117
    66
pavolmarko@117
    67
				CHookList *m_pList;
pavolmarko@117
    68
pavolmarko@117
    69
				void SkipPaused();
pavolmarko@117
    70
			public:
pavolmarko@121
    71
pavolmarko@121
    72
				List<HookInfo>::iterator m_Iter;
pavolmarko@121
    73
pavolmarko@117
    74
				CIter(CHookList *pList);
pavolmarko@117
    75
pavolmarko@117
    76
				virtual ~CIter();
pavolmarko@117
    77
pavolmarko@117
    78
				void GoToBegin();
pavolmarko@162
    79
				void Set(CIter *pOther);
pavolmarko@117
    80
pavolmarko@117
    81
				bool End();
pavolmarko@117
    82
				void Next();
pavolmarko@117
    83
				ISHDelegate *Handler();
pavolmarko@117
    84
				int ThisPtrOffs();
pavolmarko@117
    85
pavolmarko@121
    86
				void Clear();
pavolmarko@121
    87
pavolmarko@121
    88
				CIter *m_pNext;		// When stored in m_FreeIters and m_UsedIters
pavolmarko@121
    89
				CIter *m_pPrev;		// Only used when stored in m_UsedIters
pavolmarko@117
    90
			};
pavolmarko@117
    91
pavolmarko@117
    92
			CIter *m_FreeIters;
pavolmarko@162
    93
			CIter *m_UsedIters;		// The last returned and not-yet-released iter is always m_UsedIters
pavolmarko@162
    94
pavolmarko@162
    95
			// For recalls
pavolmarko@162
    96
			bool m_Recall;
pavolmarko@162
    97
pavolmarko@162
    98
			void SetRecallState();	// Sets the list into a state where the next returned
pavolmarko@162
    99
									// iterator (from GetIter) will be a copy of the last
pavolmarko@162
   100
									// returned iterator, incremented by one. This is used in Recalls.
pavolmarko@162
   101
									// The hook resets this state automatically on:
pavolmarko@162
   102
									// GetIter, ReleaseIter
pavolmarko@117
   103
pavolmarko@117
   104
			CHookList();
pavolmarko@117
   105
			CHookList(const CHookList &other);
pavolmarko@117
   106
			virtual ~CHookList();
pavolmarko@117
   107
pavolmarko@117
   108
			void operator=(const CHookList &other);
pavolmarko@117
   109
pavolmarko@117
   110
			IIter *GetIter();
pavolmarko@117
   111
			void ReleaseIter(IIter *pIter);
pavolmarko@117
   112
		};
pavolmarko@117
   113
pavolmarko@117
   114
		// I know, data hiding... But I'm a lazy bastard!
pavolmarko@117
   115
pavolmarko@117
   116
		class CIface : public IIface
pavolmarko@117
   117
		{
pavolmarko@117
   118
		public:
pavolmarko@117
   119
			void *m_Ptr;
pavolmarko@117
   120
			CHookList m_PreHooks;
pavolmarko@117
   121
			CHookList m_PostHooks;
pavolmarko@117
   122
		public:
pavolmarko@117
   123
			CIface(void *ptr);
pavolmarko@117
   124
			virtual ~CIface();
pavolmarko@117
   125
pavolmarko@117
   126
			void *GetPtr();
pavolmarko@117
   127
			IHookList *GetPreHooks();
pavolmarko@117
   128
			IHookList *GetPostHooks();
pavolmarko@117
   129
pavolmarko@117
   130
			bool operator==(void *ptr)
pavolmarko@117
   131
			{
pavolmarko@117
   132
				return m_Ptr == ptr;
pavolmarko@117
   133
			}
pavolmarko@117
   134
		};
pavolmarko@1
   135
pavolmarko@117
   136
		class CVfnPtr : public IVfnPtr
pavolmarko@117
   137
		{
pavolmarko@117
   138
		public:
pavolmarko@117
   139
			typedef List<CIface> IfaceList;
pavolmarko@117
   140
			typedef IfaceList::iterator IfaceListIter;
pavolmarko@117
   141
pavolmarko@117
   142
			void *m_Ptr;
pavolmarko@117
   143
			void *m_OrigEntry;
pavolmarko@117
   144
pavolmarko@117
   145
			IfaceList m_Ifaces;
pavolmarko@117
   146
pavolmarko@117
   147
		public:
pavolmarko@117
   148
			CVfnPtr(void *ptr);
pavolmarko@117
   149
			virtual ~CVfnPtr();
pavolmarko@117
   150
pavolmarko@117
   151
			void *GetVfnPtr();
pavolmarko@117
   152
			void *GetOrigEntry();
pavolmarko@117
   153
pavolmarko@117
   154
			virtual IIface *FindIface(void *ptr);
pavolmarko@117
   155
pavolmarko@117
   156
			bool operator==(void *ptr)
pavolmarko@117
   157
			{
pavolmarko@117
   158
				return m_Ptr == ptr;
pavolmarko@117
   159
			}
pavolmarko@117
   160
		};
pavolmarko@117
   161
pavolmarko@117
   162
		class CHookManagerInfo : public IHookManagerInfo
pavolmarko@41
   163
		{
pavolmarko@117
   164
		public:
pavolmarko@117
   165
			typedef List<CVfnPtr> VfnPtrList;
pavolmarko@117
   166
			typedef VfnPtrList::iterator VfnPtrListIter;
pavolmarko@117
   167
pavolmarko@117
   168
			Plugin m_Plug;
pavolmarko@117
   169
			HookManagerPubFunc m_Func;
pavolmarko@117
   170
pavolmarko@117
   171
			int m_VtblOffs;
pavolmarko@117
   172
			int m_VtblIdx;
pavolmarko@117
   173
			const char *m_Proto;
pavolmarko@117
   174
			void *m_HookfuncVfnptr;
pavolmarko@117
   175
pavolmarko@117
   176
			VfnPtrList m_VfnPtrs;
pavolmarko@117
   177
pavolmarko@162
   178
			int m_HookFuncVersion;
pavolmarko@162
   179
pavolmarko@117
   180
		public:
pavolmarko@117
   181
			virtual ~CHookManagerInfo();
pavolmarko@117
   182
pavolmarko@117
   183
			IVfnPtr *FindVfnPtr(void *vfnptr);
pavolmarko@117
   184
pavolmarko@117
   185
			void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto);
pavolmarko@117
   186
			void SetHookfuncVfnptr(void *hookfunc_vfnptr);
pavolmarko@117
   187
		};
pavolmarko@117
   188
		/**
pavolmarko@117
   189
		*	@brief A list of CHookManagerInfo classes
pavolmarko@117
   190
		*/
pavolmarko@117
   191
		typedef List<CHookManagerInfo> HookManInfoList;
pavolmarko@117
   192
pavolmarko@117
   193
		class CCallClassImpl : public GenericCallClass
pavolmarko@117
   194
		{
pavolmarko@117
   195
		public:
pavolmarko@117
   196
pavolmarko@117
   197
			typedef SourceHook::CVector<void*> OrigFuncs;
pavolmarko@117
   198
			typedef SourceHook::THash<int, OrigFuncs> OrigVTables;
pavolmarko@117
   199
pavolmarko@117
   200
			void *m_Ptr;			//!< Pointer to the actual object
pavolmarko@117
   201
			size_t m_ObjSize;		//!< Size of the instance
pavolmarko@117
   202
			OrigVTables m_VT;		//!< Info about vtables & functions
pavolmarko@117
   203
pavolmarko@117
   204
			int m_RefCounter;
pavolmarko@117
   205
pavolmarko@117
   206
			CCallClassImpl(void *ptr, size_t size);
pavolmarko@117
   207
			virtual ~CCallClassImpl();
pavolmarko@117
   208
pavolmarko@41
   209
			bool operator==(void *other)
pavolmarko@41
   210
			{
pavolmarko@117
   211
				return m_Ptr == other;
pavolmarko@41
   212
			}
pavolmarko@117
   213
pavolmarko@117
   214
			void *GetThisPtr();
pavolmarko@117
   215
			void *GetOrigFunc(int vtbloffs, int vtblidx);
pavolmarko@117
   216
pavolmarko@117
   217
			void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@117
   218
			void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx);
pavolmarko@41
   219
		};
pavolmarko@117
   220
pavolmarko@1
   221
		/**
pavolmarko@41
   222
		*	@brief A list of CallClass structures
pavolmarko@1
   223
		*/
pavolmarko@117
   224
		typedef List<CCallClassImpl> Impl_CallClassList;
pavolmarko@1
   225
pavolmarko@1
   226
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@6
   227
		HookManInfoList m_HookMans;					//!< A list of hook managers
pavolmarko@1
   228
pavolmarko@128
   229
		struct HookLoopInfo
pavolmarko@128
   230
		{
pavolmarko@128
   231
			META_RES *pStatus;
pavolmarko@128
   232
			META_RES *pPrevRes;
pavolmarko@128
   233
			META_RES *pCurRes;
pavolmarko@128
   234
pavolmarko@128
   235
			bool shouldContinue;
pavolmarko@162
   236
			bool recall;							//!< True if we're in a recall, eh.
pavolmarko@128
   237
pavolmarko@128
   238
			IIface *pCurIface;
pavolmarko@128
   239
			const void *pOrigRet;
pavolmarko@162
   240
			void *pOverrideRet;
pavolmarko@128
   241
			void **pIfacePtrPtr;
pavolmarko@128
   242
		};
pavolmarko@128
   243
		typedef CStack<HookLoopInfo> HookLoopInfoStack;
pavolmarko@128
   244
pavolmarko@1
   245
		/**
pavolmarko@6
   246
		*	@brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
   247
		*/
pavolmarko@117
   248
		HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end,
pavolmarko@41
   249
			const char *proto, int vtblofs, int vtblidx);
pavolmarko@1
   250
pavolmarko@117
   251
		void ApplyCallClassPatches(CCallClassImpl &cc);
pavolmarko@58
   252
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@58
   253
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
pavolmarko@1
   254
pavolmarko@117
   255
		void SetPluginPaused(Plugin plug, bool paused);
pavolmarko@117
   256
pavolmarko@157
   257
		bool ProtosEquiv(const char *p1, const char *p2);
pavolmarko@157
   258
pavolmarko@128
   259
		HookLoopInfoStack m_HLIStack;
pavolmarko@1
   260
	public:
pavolmarko@1
   261
		CSourceHookImpl();
pavolmarko@117
   262
		virtual ~CSourceHookImpl();
pavolmarko@1
   263
pavolmarko@1
   264
		/**
pavolmarko@58
   265
		*	@brief Returns the interface version
pavolmarko@58
   266
		*/
pavolmarko@58
   267
		int GetIfaceVersion();
pavolmarko@58
   268
pavolmarko@58
   269
		/**
pavolmarko@58
   270
		*	@brief Returns the implemnetation version
pavolmarko@58
   271
		*/
pavolmarko@58
   272
		int GetImplVersion();
pavolmarko@58
   273
pavolmarko@58
   274
		/**
pavolmarko@6
   275
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
   276
		*/
pavolmarko@1
   277
		void UnloadPlugin(Plugin plug);
pavolmarko@1
   278
pavolmarko@1
   279
		/**
pavolmarko@6
   280
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
   281
		*/
pavolmarko@1
   282
		void CompleteShutdown();
pavolmarko@1
   283
pavolmarko@1
   284
		/**
pavolmarko@1
   285
		*	@brief Add a hook.
pavolmarko@1
   286
		*
pavolmarko@1
   287
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   288
		*
pavolmarko@1
   289
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   290
		*	@param iface The interface pointer
pavolmarko@6
   291
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
   292
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   293
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   294
		*	@param post Set to true if you want a post handler
pavolmarko@1
   295
		*/
pavolmarko@41
   296
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   297
pavolmarko@1
   298
		/**
pavolmarko@1
   299
		*	@brief Removes a hook.
pavolmarko@1
   300
		*
pavolmarko@1
   301
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   302
		*
pavolmarko@1
   303
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   304
		*	@param iface The interface pointer
pavolmarko@41
   305
		*	@param thisptr_offs This pointer adjuster
pavolmarko@41
   306
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@41
   307
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@41
   308
		*	@param post Set to true if you want a post handler
pavolmarko@41
   309
		*/
pavolmarko@41
   310
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@41
   311
pavolmarko@41
   312
		/**
pavolmarko@41
   313
		*	@brief Removes a hook.
pavolmarko@41
   314
		*
pavolmarko@41
   315
		*	@ return True if the function succeeded, false otherwise
pavolmarko@41
   316
		*
pavolmarko@41
   317
		*	@param info A RemoveHookInfo structure, describing the hook
pavolmarko@41
   318
		*/
pavolmarko@41
   319
		bool RemoveHook(RemoveHookInfo info);
pavolmarko@41
   320
pavolmarko@41
   321
		/**
pavolmarko@6
   322
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   323
		*
pavolmarko@1
   324
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   325
		*/
pavolmarko@1
   326
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   327
pavolmarko@1
   328
		/**
pavolmarko@8
   329
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   330
		*
pavolmarko@8
   331
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   332
		*/
pavolmarko@8
   333
		void PausePlugin(Plugin plug);
pavolmarko@8
   334
pavolmarko@8
   335
		/**
pavolmarko@8
   336
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   337
		*
pavolmarko@8
   338
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   339
		*/
pavolmarko@8
   340
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   341
pavolmarko@8
   342
		/**
pavolmarko@1
   343
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   344
		*
pavolmarko@1
   345
		*	@param iface The interface pointer
pavolmarko@58
   346
		*	@param size Size of the class instance
pavolmarko@1
   347
		*/
pavolmarko@58
   348
		GenericCallClass *GetCallClass(void *iface, size_t size);
pavolmarko@1
   349
pavolmarko@1
   350
		/**
pavolmarko@1
   351
		*	@brief Release a callclass
pavolmarko@1
   352
		*
pavolmarko@1
   353
		*	@param ptr Pointer to the callclass
pavolmarko@1
   354
		*/
pavolmarko@41
   355
		virtual void ReleaseCallClass(GenericCallClass *ptr);
pavolmarko@1
   356
pavolmarko@1
   357
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   358
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   359
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   360
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   361
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   362
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   363
pavolmarko@1
   364
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   365
		// For hook managers
pavolmarko@128
   366
		void HookLoopBegin(IIface *pIface);			//!< Should be called when a hook loop begins
pavolmarko@128
   367
		void HookLoopEnd();							//!< Should be called when a hook loop exits
pavolmarko@128
   368
		void SetCurResPtr(META_RES *mres);			//!< Sets pointer to the current meta result
pavolmarko@128
   369
		void SetPrevResPtr(META_RES *mres);			//!< Sets pointer to previous meta result
pavolmarko@128
   370
		void SetStatusPtr(META_RES *mres);			//!< Sets pointer to the status variable
pavolmarko@128
   371
		void SetIfacePtrPtr(void **pp);				//!< Sets pointer to the interface this pointer
pavolmarko@128
   372
		void SetOrigRetPtr(const void *ptr);		//!< Sets the original return pointer
pavolmarko@162
   373
		void SetOverrideRetPtr(void *ptr);			//!< Sets the override result pointer
pavolmarko@128
   374
		bool ShouldContinue();						//!< Returns false if the hook loop should exit
pavolmarko@157
   375
pavolmarko@157
   376
		/**
pavolmarko@157
   377
		*	@brief Remove a hook manager. Auto-removes all hooks attached to it from plugin plug.
pavolmarko@157
   378
		*
pavolmarko@157
   379
		*	@param plug The owner of the hook manager
pavolmarko@157
   380
		*   @param pubFunc The hook manager's info function
pavolmarko@157
   381
		*/
pavolmarko@157
   382
		virtual void RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc);
pavolmarko@162
   383
		virtual void DoRecall();					//!< Initiates a recall sequence
pavolmarko@162
   384
		virtual void *GetOverrideRetPtr();			//!< Returns the pointer set by SetOverrideRetPtr
pavolmarko@162
   385
pavolmarko@162
   386
		virtual void *SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr,
pavolmarko@162
   387
			void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr);
pavolmarko@1
   388
	};
pavolmarko@1
   389
}
pavolmarko@1
   390
dvander@34
   391
#endif
dvander@34
   392