sourcehook/sourcehook_impl.h
author Pavol Marko <pavolmarko@gmail.com>
Sat Dec 10 22:37:53 2005 +0000 (2005-12-10)
changeset 157 064f77cac7ab
parent 137 edafdaacae96
child 162 a95db73792e5
permissions -rw-r--r--
Added manual hooks. I hope that I haven't broken binary compatibility - someone might want to test it.
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@117
    79
pavolmarko@117
    80
				bool End();
pavolmarko@117
    81
				void Next();
pavolmarko@117
    82
				ISHDelegate *Handler();
pavolmarko@117
    83
				int ThisPtrOffs();
pavolmarko@117
    84
pavolmarko@121
    85
				void Clear();
pavolmarko@121
    86
pavolmarko@121
    87
				CIter *m_pNext;		// When stored in m_FreeIters and m_UsedIters
pavolmarko@121
    88
				CIter *m_pPrev;		// Only used when stored in m_UsedIters
pavolmarko@117
    89
			};
pavolmarko@117
    90
pavolmarko@117
    91
			CIter *m_FreeIters;
pavolmarko@121
    92
			CIter *m_UsedIters;
pavolmarko@117
    93
pavolmarko@117
    94
			CHookList();
pavolmarko@117
    95
			CHookList(const CHookList &other);
pavolmarko@117
    96
			virtual ~CHookList();
pavolmarko@117
    97
pavolmarko@117
    98
			void operator=(const CHookList &other);
pavolmarko@117
    99
pavolmarko@117
   100
			IIter *GetIter();
pavolmarko@117
   101
			void ReleaseIter(IIter *pIter);
pavolmarko@117
   102
		};
pavolmarko@117
   103
pavolmarko@117
   104
		// I know, data hiding... But I'm a lazy bastard!
pavolmarko@117
   105
pavolmarko@117
   106
		class CIface : public IIface
pavolmarko@117
   107
		{
pavolmarko@117
   108
		public:
pavolmarko@117
   109
			void *m_Ptr;
pavolmarko@117
   110
			CHookList m_PreHooks;
pavolmarko@117
   111
			CHookList m_PostHooks;
pavolmarko@117
   112
		public:
pavolmarko@117
   113
			CIface(void *ptr);
pavolmarko@117
   114
			virtual ~CIface();
pavolmarko@117
   115
pavolmarko@117
   116
			void *GetPtr();
pavolmarko@117
   117
			IHookList *GetPreHooks();
pavolmarko@117
   118
			IHookList *GetPostHooks();
pavolmarko@117
   119
pavolmarko@117
   120
			bool operator==(void *ptr)
pavolmarko@117
   121
			{
pavolmarko@117
   122
				return m_Ptr == ptr;
pavolmarko@117
   123
			}
pavolmarko@117
   124
		};
pavolmarko@1
   125
pavolmarko@117
   126
		class CVfnPtr : public IVfnPtr
pavolmarko@117
   127
		{
pavolmarko@117
   128
		public:
pavolmarko@117
   129
			typedef List<CIface> IfaceList;
pavolmarko@117
   130
			typedef IfaceList::iterator IfaceListIter;
pavolmarko@117
   131
pavolmarko@117
   132
			void *m_Ptr;
pavolmarko@117
   133
			void *m_OrigEntry;
pavolmarko@117
   134
pavolmarko@117
   135
			IfaceList m_Ifaces;
pavolmarko@117
   136
pavolmarko@117
   137
		public:
pavolmarko@117
   138
			CVfnPtr(void *ptr);
pavolmarko@117
   139
			virtual ~CVfnPtr();
pavolmarko@117
   140
pavolmarko@117
   141
			void *GetVfnPtr();
pavolmarko@117
   142
			void *GetOrigEntry();
pavolmarko@117
   143
pavolmarko@117
   144
			virtual IIface *FindIface(void *ptr);
pavolmarko@117
   145
pavolmarko@117
   146
			bool operator==(void *ptr)
pavolmarko@117
   147
			{
pavolmarko@117
   148
				return m_Ptr == ptr;
pavolmarko@117
   149
			}
pavolmarko@117
   150
		};
pavolmarko@117
   151
pavolmarko@117
   152
		class CHookManagerInfo : public IHookManagerInfo
pavolmarko@41
   153
		{
pavolmarko@117
   154
		public:
pavolmarko@117
   155
			typedef List<CVfnPtr> VfnPtrList;
pavolmarko@117
   156
			typedef VfnPtrList::iterator VfnPtrListIter;
pavolmarko@117
   157
pavolmarko@117
   158
			Plugin m_Plug;
pavolmarko@117
   159
			HookManagerPubFunc m_Func;
pavolmarko@117
   160
pavolmarko@117
   161
			int m_VtblOffs;
pavolmarko@117
   162
			int m_VtblIdx;
pavolmarko@117
   163
			const char *m_Proto;
pavolmarko@117
   164
			void *m_HookfuncVfnptr;
pavolmarko@117
   165
pavolmarko@117
   166
			VfnPtrList m_VfnPtrs;
pavolmarko@117
   167
pavolmarko@117
   168
		public:
pavolmarko@117
   169
			virtual ~CHookManagerInfo();
pavolmarko@117
   170
pavolmarko@117
   171
			IVfnPtr *FindVfnPtr(void *vfnptr);
pavolmarko@117
   172
pavolmarko@117
   173
			void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto);
pavolmarko@117
   174
			void SetHookfuncVfnptr(void *hookfunc_vfnptr);
pavolmarko@117
   175
		};
pavolmarko@117
   176
		/**
pavolmarko@117
   177
		*	@brief A list of CHookManagerInfo classes
pavolmarko@117
   178
		*/
pavolmarko@117
   179
		typedef List<CHookManagerInfo> HookManInfoList;
pavolmarko@117
   180
pavolmarko@117
   181
		class CCallClassImpl : public GenericCallClass
pavolmarko@117
   182
		{
pavolmarko@117
   183
		public:
pavolmarko@117
   184
pavolmarko@117
   185
			typedef SourceHook::CVector<void*> OrigFuncs;
pavolmarko@117
   186
			typedef SourceHook::THash<int, OrigFuncs> OrigVTables;
pavolmarko@117
   187
pavolmarko@117
   188
			void *m_Ptr;			//!< Pointer to the actual object
pavolmarko@117
   189
			size_t m_ObjSize;		//!< Size of the instance
pavolmarko@117
   190
			OrigVTables m_VT;		//!< Info about vtables & functions
pavolmarko@117
   191
pavolmarko@117
   192
			int m_RefCounter;
pavolmarko@117
   193
pavolmarko@117
   194
			CCallClassImpl(void *ptr, size_t size);
pavolmarko@117
   195
			virtual ~CCallClassImpl();
pavolmarko@117
   196
pavolmarko@41
   197
			bool operator==(void *other)
pavolmarko@41
   198
			{
pavolmarko@117
   199
				return m_Ptr == other;
pavolmarko@41
   200
			}
pavolmarko@117
   201
pavolmarko@117
   202
			void *GetThisPtr();
pavolmarko@117
   203
			void *GetOrigFunc(int vtbloffs, int vtblidx);
pavolmarko@117
   204
pavolmarko@117
   205
			void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@117
   206
			void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx);
pavolmarko@41
   207
		};
pavolmarko@117
   208
pavolmarko@1
   209
		/**
pavolmarko@41
   210
		*	@brief A list of CallClass structures
pavolmarko@1
   211
		*/
pavolmarko@117
   212
		typedef List<CCallClassImpl> Impl_CallClassList;
pavolmarko@1
   213
pavolmarko@1
   214
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@6
   215
		HookManInfoList m_HookMans;					//!< A list of hook managers
pavolmarko@1
   216
pavolmarko@128
   217
		struct HookLoopInfo
pavolmarko@128
   218
		{
pavolmarko@128
   219
			META_RES *pStatus;
pavolmarko@128
   220
			META_RES *pPrevRes;
pavolmarko@128
   221
			META_RES *pCurRes;
pavolmarko@128
   222
pavolmarko@128
   223
			bool shouldContinue;
pavolmarko@128
   224
pavolmarko@128
   225
			IIface *pCurIface;
pavolmarko@128
   226
			const void *pOrigRet;
pavolmarko@128
   227
			const void *pOverrideRet;
pavolmarko@128
   228
			void **pIfacePtrPtr;
pavolmarko@128
   229
		};
pavolmarko@128
   230
		typedef CStack<HookLoopInfo> HookLoopInfoStack;
pavolmarko@128
   231
pavolmarko@1
   232
		/**
pavolmarko@6
   233
		*	@brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
   234
		*/
pavolmarko@117
   235
		HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end,
pavolmarko@41
   236
			const char *proto, int vtblofs, int vtblidx);
pavolmarko@1
   237
pavolmarko@117
   238
		void ApplyCallClassPatches(CCallClassImpl &cc);
pavolmarko@58
   239
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@58
   240
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
pavolmarko@1
   241
pavolmarko@117
   242
		void SetPluginPaused(Plugin plug, bool paused);
pavolmarko@117
   243
pavolmarko@157
   244
		bool ProtosEquiv(const char *p1, const char *p2);
pavolmarko@157
   245
pavolmarko@128
   246
		HookLoopInfoStack m_HLIStack;
pavolmarko@1
   247
	public:
pavolmarko@1
   248
		CSourceHookImpl();
pavolmarko@117
   249
		virtual ~CSourceHookImpl();
pavolmarko@1
   250
pavolmarko@1
   251
		/**
pavolmarko@58
   252
		*	@brief Returns the interface version
pavolmarko@58
   253
		*/
pavolmarko@58
   254
		int GetIfaceVersion();
pavolmarko@58
   255
pavolmarko@58
   256
		/**
pavolmarko@58
   257
		*	@brief Returns the implemnetation version
pavolmarko@58
   258
		*/
pavolmarko@58
   259
		int GetImplVersion();
pavolmarko@58
   260
pavolmarko@58
   261
		/**
pavolmarko@6
   262
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
   263
		*/
pavolmarko@1
   264
		void UnloadPlugin(Plugin plug);
pavolmarko@1
   265
pavolmarko@1
   266
		/**
pavolmarko@6
   267
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
   268
		*/
pavolmarko@1
   269
		void CompleteShutdown();
pavolmarko@1
   270
pavolmarko@1
   271
		/**
pavolmarko@1
   272
		*	@brief Add a hook.
pavolmarko@1
   273
		*
pavolmarko@1
   274
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   275
		*
pavolmarko@1
   276
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   277
		*	@param iface The interface pointer
pavolmarko@6
   278
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
   279
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   280
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   281
		*	@param post Set to true if you want a post handler
pavolmarko@1
   282
		*/
pavolmarko@41
   283
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   284
pavolmarko@1
   285
		/**
pavolmarko@1
   286
		*	@brief Removes a hook.
pavolmarko@1
   287
		*
pavolmarko@1
   288
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   289
		*
pavolmarko@1
   290
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   291
		*	@param iface The interface pointer
pavolmarko@41
   292
		*	@param thisptr_offs This pointer adjuster
pavolmarko@41
   293
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@41
   294
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@41
   295
		*	@param post Set to true if you want a post handler
pavolmarko@41
   296
		*/
pavolmarko@41
   297
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@41
   298
pavolmarko@41
   299
		/**
pavolmarko@41
   300
		*	@brief Removes a hook.
pavolmarko@41
   301
		*
pavolmarko@41
   302
		*	@ return True if the function succeeded, false otherwise
pavolmarko@41
   303
		*
pavolmarko@41
   304
		*	@param info A RemoveHookInfo structure, describing the hook
pavolmarko@41
   305
		*/
pavolmarko@41
   306
		bool RemoveHook(RemoveHookInfo info);
pavolmarko@41
   307
pavolmarko@41
   308
		/**
pavolmarko@6
   309
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   310
		*
pavolmarko@1
   311
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   312
		*/
pavolmarko@1
   313
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   314
pavolmarko@1
   315
		/**
pavolmarko@8
   316
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   317
		*
pavolmarko@8
   318
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   319
		*/
pavolmarko@8
   320
		void PausePlugin(Plugin plug);
pavolmarko@8
   321
pavolmarko@8
   322
		/**
pavolmarko@8
   323
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   324
		*
pavolmarko@8
   325
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   326
		*/
pavolmarko@8
   327
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   328
pavolmarko@8
   329
		/**
pavolmarko@1
   330
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   331
		*
pavolmarko@1
   332
		*	@param iface The interface pointer
pavolmarko@58
   333
		*	@param size Size of the class instance
pavolmarko@1
   334
		*/
pavolmarko@58
   335
		GenericCallClass *GetCallClass(void *iface, size_t size);
pavolmarko@1
   336
pavolmarko@1
   337
		/**
pavolmarko@1
   338
		*	@brief Release a callclass
pavolmarko@1
   339
		*
pavolmarko@1
   340
		*	@param ptr Pointer to the callclass
pavolmarko@1
   341
		*/
pavolmarko@41
   342
		virtual void ReleaseCallClass(GenericCallClass *ptr);
pavolmarko@1
   343
pavolmarko@1
   344
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   345
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   346
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   347
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   348
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   349
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   350
pavolmarko@1
   351
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   352
		// For hook managers
pavolmarko@128
   353
		void HookLoopBegin(IIface *pIface);			//!< Should be called when a hook loop begins
pavolmarko@128
   354
		void HookLoopEnd();							//!< Should be called when a hook loop exits
pavolmarko@128
   355
		void SetCurResPtr(META_RES *mres);			//!< Sets pointer to the current meta result
pavolmarko@128
   356
		void SetPrevResPtr(META_RES *mres);			//!< Sets pointer to previous meta result
pavolmarko@128
   357
		void SetStatusPtr(META_RES *mres);			//!< Sets pointer to the status variable
pavolmarko@128
   358
		void SetIfacePtrPtr(void **pp);				//!< Sets pointer to the interface this pointer
pavolmarko@128
   359
		void SetOrigRetPtr(const void *ptr);		//!< Sets the original return pointer
pavolmarko@128
   360
		void SetOverrideRetPtr(const void *ptr);	//!< Sets the override result pointer
pavolmarko@128
   361
		bool ShouldContinue();						//!< Returns false if the hook loop should exit
pavolmarko@157
   362
pavolmarko@157
   363
		/**
pavolmarko@157
   364
		*	@brief Remove a hook manager. Auto-removes all hooks attached to it from plugin plug.
pavolmarko@157
   365
		*
pavolmarko@157
   366
		*	@param plug The owner of the hook manager
pavolmarko@157
   367
		*   @param pubFunc The hook manager's info function
pavolmarko@157
   368
		*/
pavolmarko@157
   369
		virtual void RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc);
pavolmarko@1
   370
	};
pavolmarko@1
   371
}
pavolmarko@1
   372
dvander@34
   373
#endif
dvander@34
   374