sourcehook/sourcehook_impl.h
author Pavol Marko <pavolmarko@gmail.com>
Wed Oct 05 21:51:02 2005 +0000 (2005-10-05)
changeset 121 158b860440c0
parent 117 e322da4af2d2
child 123 53e819ac032a
permissions -rw-r--r--
Partial fix
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"
ds@86
    18
pavolmarko@1
    19
// Set this to 1 to enable runtime code generation (faster)
pavolmarko@117
    20
//  (unused at the moment, but may come back, so I'm leaving it in here!)
pavolmarko@1
    21
#define SH_RUNTIME_CODEGEN 1
pavolmarko@1
    22
pavolmarko@1
    23
namespace SourceHook
pavolmarko@1
    24
{
pavolmarko@1
    25
	/**
pavolmarko@1
    26
	*	@brief The SourceHook implementation class
pavolmarko@1
    27
	*/
pavolmarko@1
    28
	class CSourceHookImpl : public ISourceHook
pavolmarko@1
    29
	{
pavolmarko@117
    30
	private:
pavolmarko@1
    31
		/**
pavolmarko@6
    32
		*	@brief A hook can be removed if you have this information
pavolmarko@1
    33
		*/
pavolmarko@6
    34
		struct RemoveHookInfo
pavolmarko@6
    35
		{
pavolmarko@58
    36
			RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman,
pavolmarko@41
    37
				ISHDelegate *phandler, bool ppost)
pavolmarko@58
    38
				: plug(pplug), iface(piface), thisptr_offs(tpo),
pavolmarko@58
    39
				hookman(phookman), handler(phandler), post(ppost)
pavolmarko@6
    40
			{
pavolmarko@6
    41
			}
pavolmarko@6
    42
pavolmarko@6
    43
			Plugin plug;
pavolmarko@6
    44
			void *iface;
pavolmarko@58
    45
			int thisptr_offs;
pavolmarko@41
    46
			HookManagerPubFunc hookman;
pavolmarko@6
    47
			ISHDelegate *handler;
pavolmarko@6
    48
			bool post;
pavolmarko@6
    49
		};
pavolmarko@6
    50
pavolmarko@117
    51
		struct HookInfo
pavolmarko@117
    52
		{
pavolmarko@117
    53
			ISHDelegate *handler;			//!< Pointer to the handler
pavolmarko@117
    54
			bool paused;					//!< If true, the hook should not be executed
pavolmarko@117
    55
			Plugin plug;					//!< The owner plugin
pavolmarko@117
    56
			int thisptr_offs;				//!< This pointer offset
pavolmarko@117
    57
		};
pavolmarko@117
    58
pavolmarko@117
    59
		class CHookList : public IHookList
pavolmarko@117
    60
		{
pavolmarko@117
    61
		public:
pavolmarko@117
    62
			List<HookInfo> m_List;
pavolmarko@117
    63
pavolmarko@117
    64
			friend class CIter;
pavolmarko@117
    65
pavolmarko@117
    66
			class CIter : public IHookList::IIter
pavolmarko@117
    67
			{
pavolmarko@117
    68
				friend class CHookList;
pavolmarko@117
    69
pavolmarko@117
    70
				CHookList *m_pList;
pavolmarko@117
    71
pavolmarko@117
    72
				void SkipPaused();
pavolmarko@117
    73
			public:
pavolmarko@121
    74
pavolmarko@121
    75
				List<HookInfo>::iterator m_Iter;
pavolmarko@121
    76
pavolmarko@117
    77
				CIter(CHookList *pList);
pavolmarko@117
    78
pavolmarko@117
    79
				virtual ~CIter();
pavolmarko@117
    80
pavolmarko@117
    81
				void GoToBegin();
pavolmarko@117
    82
pavolmarko@117
    83
				bool End();
pavolmarko@117
    84
				void Next();
pavolmarko@117
    85
				ISHDelegate *Handler();
pavolmarko@117
    86
				int ThisPtrOffs();
pavolmarko@117
    87
pavolmarko@121
    88
				void Clear();
pavolmarko@121
    89
pavolmarko@121
    90
				CIter *m_pNext;		// When stored in m_FreeIters and m_UsedIters
pavolmarko@121
    91
				CIter *m_pPrev;		// Only used when stored in m_UsedIters
pavolmarko@117
    92
			};
pavolmarko@117
    93
pavolmarko@117
    94
			CIter *m_FreeIters;
pavolmarko@121
    95
			CIter *m_UsedIters;
pavolmarko@117
    96
pavolmarko@117
    97
			CHookList();
pavolmarko@117
    98
			CHookList(const CHookList &other);
pavolmarko@117
    99
			virtual ~CHookList();
pavolmarko@117
   100
pavolmarko@117
   101
			void operator=(const CHookList &other);
pavolmarko@117
   102
pavolmarko@117
   103
			IIter *GetIter();
pavolmarko@117
   104
			void ReleaseIter(IIter *pIter);
pavolmarko@117
   105
		};
pavolmarko@117
   106
pavolmarko@117
   107
		// I know, data hiding... But I'm a lazy bastard!
pavolmarko@117
   108
pavolmarko@117
   109
		class CIface : public IIface
pavolmarko@117
   110
		{
pavolmarko@117
   111
		public:
pavolmarko@117
   112
			void *m_Ptr;
pavolmarko@117
   113
			CHookList m_PreHooks;
pavolmarko@117
   114
			CHookList m_PostHooks;
pavolmarko@117
   115
		public:
pavolmarko@117
   116
			CIface(void *ptr);
pavolmarko@117
   117
			virtual ~CIface();
pavolmarko@117
   118
pavolmarko@117
   119
			void *GetPtr();
pavolmarko@117
   120
			IHookList *GetPreHooks();
pavolmarko@117
   121
			IHookList *GetPostHooks();
pavolmarko@117
   122
pavolmarko@117
   123
			bool operator==(void *ptr)
pavolmarko@117
   124
			{
pavolmarko@117
   125
				return m_Ptr == ptr;
pavolmarko@117
   126
			}
pavolmarko@117
   127
		};
pavolmarko@1
   128
pavolmarko@117
   129
		class CVfnPtr : public IVfnPtr
pavolmarko@117
   130
		{
pavolmarko@117
   131
		public:
pavolmarko@117
   132
			typedef List<CIface> IfaceList;
pavolmarko@117
   133
			typedef IfaceList::iterator IfaceListIter;
pavolmarko@117
   134
pavolmarko@117
   135
			void *m_Ptr;
pavolmarko@117
   136
			void *m_OrigEntry;
pavolmarko@117
   137
pavolmarko@117
   138
			IfaceList m_Ifaces;
pavolmarko@117
   139
pavolmarko@117
   140
		public:
pavolmarko@117
   141
			CVfnPtr(void *ptr);
pavolmarko@117
   142
			virtual ~CVfnPtr();
pavolmarko@117
   143
pavolmarko@117
   144
			void *GetVfnPtr();
pavolmarko@117
   145
			void *GetOrigEntry();
pavolmarko@117
   146
pavolmarko@117
   147
			virtual IIface *FindIface(void *ptr);
pavolmarko@117
   148
pavolmarko@117
   149
			bool operator==(void *ptr)
pavolmarko@117
   150
			{
pavolmarko@117
   151
				return m_Ptr == ptr;
pavolmarko@117
   152
			}
pavolmarko@117
   153
		};
pavolmarko@117
   154
pavolmarko@117
   155
		class CHookManagerInfo : public IHookManagerInfo
pavolmarko@41
   156
		{
pavolmarko@117
   157
		public:
pavolmarko@117
   158
			typedef List<CVfnPtr> VfnPtrList;
pavolmarko@117
   159
			typedef VfnPtrList::iterator VfnPtrListIter;
pavolmarko@117
   160
pavolmarko@117
   161
			Plugin m_Plug;
pavolmarko@117
   162
			HookManagerPubFunc m_Func;
pavolmarko@117
   163
pavolmarko@117
   164
			int m_VtblOffs;
pavolmarko@117
   165
			int m_VtblIdx;
pavolmarko@117
   166
			const char *m_Proto;
pavolmarko@117
   167
			void *m_HookfuncVfnptr;
pavolmarko@117
   168
pavolmarko@117
   169
			VfnPtrList m_VfnPtrs;
pavolmarko@117
   170
pavolmarko@117
   171
		public:
pavolmarko@117
   172
			virtual ~CHookManagerInfo();
pavolmarko@117
   173
pavolmarko@117
   174
			IVfnPtr *FindVfnPtr(void *vfnptr);
pavolmarko@117
   175
pavolmarko@117
   176
			void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto);
pavolmarko@117
   177
			void SetHookfuncVfnptr(void *hookfunc_vfnptr);
pavolmarko@117
   178
		};
pavolmarko@117
   179
		/**
pavolmarko@117
   180
		*	@brief A list of CHookManagerInfo classes
pavolmarko@117
   181
		*/
pavolmarko@117
   182
		typedef List<CHookManagerInfo> HookManInfoList;
pavolmarko@117
   183
pavolmarko@117
   184
		class CCallClassImpl : public GenericCallClass
pavolmarko@117
   185
		{
pavolmarko@117
   186
		public:
pavolmarko@117
   187
pavolmarko@117
   188
			typedef SourceHook::CVector<void*> OrigFuncs;
pavolmarko@117
   189
			typedef SourceHook::THash<int, OrigFuncs> OrigVTables;
pavolmarko@117
   190
pavolmarko@117
   191
			void *m_Ptr;			//!< Pointer to the actual object
pavolmarko@117
   192
			size_t m_ObjSize;		//!< Size of the instance
pavolmarko@117
   193
			OrigVTables m_VT;		//!< Info about vtables & functions
pavolmarko@117
   194
pavolmarko@117
   195
			int m_RefCounter;
pavolmarko@117
   196
pavolmarko@117
   197
			CCallClassImpl(void *ptr, size_t size);
pavolmarko@117
   198
			virtual ~CCallClassImpl();
pavolmarko@117
   199
pavolmarko@41
   200
			bool operator==(void *other)
pavolmarko@41
   201
			{
pavolmarko@117
   202
				return m_Ptr == other;
pavolmarko@41
   203
			}
pavolmarko@117
   204
pavolmarko@117
   205
			void *GetThisPtr();
pavolmarko@117
   206
			void *GetOrigFunc(int vtbloffs, int vtblidx);
pavolmarko@117
   207
pavolmarko@117
   208
			void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@117
   209
			void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx);
pavolmarko@41
   210
		};
pavolmarko@117
   211
pavolmarko@1
   212
		/**
pavolmarko@41
   213
		*	@brief A list of CallClass structures
pavolmarko@1
   214
		*/
pavolmarko@117
   215
		typedef List<CCallClassImpl> Impl_CallClassList;
pavolmarko@1
   216
pavolmarko@1
   217
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@6
   218
		HookManInfoList m_HookMans;					//!< A list of hook managers
pavolmarko@1
   219
pavolmarko@1
   220
		/**
pavolmarko@6
   221
		*	@brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
   222
		*/
pavolmarko@117
   223
		HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end,
pavolmarko@41
   224
			const char *proto, int vtblofs, int vtblidx);
pavolmarko@1
   225
pavolmarko@117
   226
		void ApplyCallClassPatches(CCallClassImpl &cc);
pavolmarko@58
   227
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@58
   228
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
pavolmarko@1
   229
pavolmarko@117
   230
		void SetPluginPaused(Plugin plug, bool paused);
pavolmarko@117
   231
pavolmarko@1
   232
		META_RES m_Status, m_PrevRes, m_CurRes;
pavolmarko@1
   233
		const void *m_OrigRet;
pavolmarko@1
   234
		const void *m_OverrideRet;
pavolmarko@1
   235
		void *m_IfacePtr;
pavolmarko@1
   236
	public:
pavolmarko@1
   237
		CSourceHookImpl();
pavolmarko@117
   238
		virtual ~CSourceHookImpl();
pavolmarko@1
   239
pavolmarko@1
   240
		/**
pavolmarko@58
   241
		*	@brief Returns the interface version
pavolmarko@58
   242
		*/
pavolmarko@58
   243
		int GetIfaceVersion();
pavolmarko@58
   244
pavolmarko@58
   245
		/**
pavolmarko@58
   246
		*	@brief Returns the implemnetation version
pavolmarko@58
   247
		*/
pavolmarko@58
   248
		int GetImplVersion();
pavolmarko@58
   249
pavolmarko@58
   250
		/**
pavolmarko@6
   251
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
   252
		*/
pavolmarko@1
   253
		void UnloadPlugin(Plugin plug);
pavolmarko@1
   254
pavolmarko@1
   255
		/**
pavolmarko@6
   256
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
   257
		*/
pavolmarko@1
   258
		void CompleteShutdown();
pavolmarko@1
   259
pavolmarko@1
   260
		/**
pavolmarko@1
   261
		*	@brief Add a hook.
pavolmarko@1
   262
		*
pavolmarko@1
   263
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   264
		*
pavolmarko@1
   265
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   266
		*	@param iface The interface pointer
pavolmarko@6
   267
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
   268
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   269
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   270
		*	@param post Set to true if you want a post handler
pavolmarko@1
   271
		*/
pavolmarko@41
   272
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   273
pavolmarko@1
   274
		/**
pavolmarko@1
   275
		*	@brief Removes a hook.
pavolmarko@1
   276
		*
pavolmarko@1
   277
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   278
		*
pavolmarko@1
   279
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   280
		*	@param iface The interface pointer
pavolmarko@41
   281
		*	@param thisptr_offs This pointer adjuster
pavolmarko@41
   282
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@41
   283
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@41
   284
		*	@param post Set to true if you want a post handler
pavolmarko@41
   285
		*/
pavolmarko@41
   286
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@41
   287
pavolmarko@41
   288
		/**
pavolmarko@41
   289
		*	@brief Removes a hook.
pavolmarko@41
   290
		*
pavolmarko@41
   291
		*	@ return True if the function succeeded, false otherwise
pavolmarko@41
   292
		*
pavolmarko@41
   293
		*	@param info A RemoveHookInfo structure, describing the hook
pavolmarko@41
   294
		*/
pavolmarko@41
   295
		bool RemoveHook(RemoveHookInfo info);
pavolmarko@41
   296
pavolmarko@41
   297
		/**
pavolmarko@6
   298
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   299
		*
pavolmarko@1
   300
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   301
		*/
pavolmarko@1
   302
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   303
pavolmarko@1
   304
		/**
pavolmarko@8
   305
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   306
		*
pavolmarko@8
   307
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   308
		*/
pavolmarko@8
   309
		void PausePlugin(Plugin plug);
pavolmarko@8
   310
pavolmarko@8
   311
		/**
pavolmarko@8
   312
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   313
		*
pavolmarko@8
   314
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   315
		*/
pavolmarko@8
   316
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   317
pavolmarko@8
   318
		/**
pavolmarko@1
   319
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   320
		*
pavolmarko@1
   321
		*	@param iface The interface pointer
pavolmarko@58
   322
		*	@param size Size of the class instance
pavolmarko@1
   323
		*/
pavolmarko@58
   324
		GenericCallClass *GetCallClass(void *iface, size_t size);
pavolmarko@1
   325
pavolmarko@1
   326
		/**
pavolmarko@1
   327
		*	@brief Release a callclass
pavolmarko@1
   328
		*
pavolmarko@1
   329
		*	@param ptr Pointer to the callclass
pavolmarko@1
   330
		*/
pavolmarko@41
   331
		virtual void ReleaseCallClass(GenericCallClass *ptr);
pavolmarko@1
   332
pavolmarko@1
   333
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   334
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   335
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   336
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   337
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   338
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   339
pavolmarko@1
   340
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   341
		// For hook managers
pavolmarko@58
   342
		virtual META_RES &GetCurResRef();				//!< Gets the reference to the current meta result
pavolmarko@58
   343
		virtual META_RES &GetPrevResRef();				//!< Gets the reference to the previous meta result
pavolmarko@58
   344
		virtual META_RES &GetStatusRef();				//!< Gets the reference to the status variable
pavolmarko@58
   345
		virtual void* &GetIfacePtrRef();				//!< Gets the reference to the iface ptr
pavolmarko@1
   346
		virtual void SetOrigRet(const void *ptr);		//!< Sets the original return pointer
pavolmarko@1
   347
		virtual void SetOverrideRet(const void *ptr);	//!< Sets the override result pointer
pavolmarko@1
   348
	};
pavolmarko@1
   349
}
pavolmarko@1
   350
dvander@34
   351
#endif
dvander@34
   352