sourcehook/sourcehook_impl.h
author David Anderson <dvander@alliedmods.net>
Sat Apr 16 23:33:57 2005 +0000 (2005-04-16)
changeset 10 406d8e5ddfc4
parent 8 07e339563a28
child 34 11e62a912700
permissions -rw-r--r--
Added license/author tags to files
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@1
    15
pavolmarko@1
    16
// Set this to 1 to enable runtime code generation (faster)
pavolmarko@1
    17
#define SH_RUNTIME_CODEGEN 1
pavolmarko@1
    18
pavolmarko@1
    19
namespace SourceHook
pavolmarko@1
    20
{
pavolmarko@1
    21
	/**
pavolmarko@1
    22
	*	@brief The SourceHook implementation class
pavolmarko@1
    23
	*/
pavolmarko@1
    24
	class CSourceHookImpl : public ISourceHook
pavolmarko@1
    25
	{
pavolmarko@1
    26
		/**
pavolmarko@6
    27
		*	@brief A hook can be removed if you have this information
pavolmarko@1
    28
		*/
pavolmarko@6
    29
		struct RemoveHookInfo
pavolmarko@6
    30
		{
pavolmarko@6
    31
			RemoveHookInfo(Plugin p, void *i, HookManagerPubFunc h, ISHDelegate *hd, bool ps)
pavolmarko@6
    32
				: plug(p), iface(i), hpf(h), handler(hd), post(ps)
pavolmarko@6
    33
			{
pavolmarko@6
    34
			}
pavolmarko@6
    35
pavolmarko@6
    36
			Plugin plug;
pavolmarko@6
    37
			void *iface;
pavolmarko@6
    38
			HookManagerPubFunc hpf;
pavolmarko@6
    39
			ISHDelegate *handler;
pavolmarko@6
    40
			bool post;
pavolmarko@6
    41
		};
pavolmarko@6
    42
pavolmarko@6
    43
		/**
pavolmarko@6
    44
		*	@brief A list of HookManagerInfo structures
pavolmarko@6
    45
		*/
pavolmarko@6
    46
		typedef std::list<HookManagerInfo> HookManInfoList;
pavolmarko@1
    47
pavolmarko@1
    48
pavolmarko@1
    49
		/**
pavolmarko@1
    50
		*	@brief A list of Impl_CallClass structures
pavolmarko@1
    51
		*/
pavolmarko@1
    52
		typedef std::list<CallClass> Impl_CallClassList;
pavolmarko@1
    53
pavolmarko@1
    54
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@6
    55
		HookManInfoList m_HookMans;					//!< A list of hook managers
pavolmarko@1
    56
pavolmarko@1
    57
		int m_PageSize;								//!< Stores the system's page size
pavolmarko@1
    58
pavolmarko@1
    59
		/**
pavolmarko@6
    60
		*	@brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
    61
		*/
pavolmarko@6
    62
		HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end, 
pavolmarko@1
    63
			const char *proto, int vtblofs, int vtblidx, int thisptrofs);
pavolmarko@1
    64
pavolmarko@1
    65
		void FreeCallClass(CallClass &cc);
pavolmarko@1
    66
		bool ApplyCallClassPatch(CallClass &cc, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@1
    67
pavolmarko@1
    68
		static const int MAX_VTABLE_LEN = 4096;		//!< Maximal vtable length in bytes
pavolmarko@1
    69
pavolmarko@1
    70
		META_RES m_Status, m_PrevRes, m_CurRes;
pavolmarko@1
    71
		const void *m_OrigRet;
pavolmarko@1
    72
		const void *m_OverrideRet;
pavolmarko@1
    73
		void *m_IfacePtr;
pavolmarko@1
    74
	public:
pavolmarko@1
    75
		CSourceHookImpl();
pavolmarko@1
    76
		~CSourceHookImpl();
pavolmarko@1
    77
pavolmarko@1
    78
		/**
pavolmarko@6
    79
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
    80
		*/
pavolmarko@1
    81
		void UnloadPlugin(Plugin plug);
pavolmarko@1
    82
pavolmarko@1
    83
		/**
pavolmarko@6
    84
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
    85
		*/
pavolmarko@1
    86
		void CompleteShutdown();
pavolmarko@1
    87
pavolmarko@1
    88
		/**
pavolmarko@1
    89
		*	@brief Add a hook.
pavolmarko@1
    90
		*
pavolmarko@1
    91
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
    92
		*
pavolmarko@1
    93
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
    94
		*	@param iface The interface pointer
pavolmarko@6
    95
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
    96
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
    97
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
    98
		*	@param post Set to true if you want a post handler
pavolmarko@1
    99
		*/
pavolmarko@6
   100
		bool AddHook(Plugin plug, void *iface, int ifacesize, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   101
pavolmarko@1
   102
		/**
pavolmarko@1
   103
		*	@brief Removes a hook.
pavolmarko@1
   104
		*
pavolmarko@1
   105
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   106
		*
pavolmarko@1
   107
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   108
		*	@param iface The interface pointer
pavolmarko@6
   109
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   110
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   111
		*	@param post Set to true if you want a post handler
pavolmarko@1
   112
		*/
pavolmarko@6
   113
		bool RemoveHook(Plugin plug, void *iface, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   114
pavolmarko@1
   115
		/**
pavolmarko@6
   116
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   117
		*
pavolmarko@1
   118
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   119
		*/
pavolmarko@1
   120
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   121
pavolmarko@1
   122
		/**
pavolmarko@8
   123
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   124
		*
pavolmarko@8
   125
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   126
		*/
pavolmarko@8
   127
		void PausePlugin(Plugin plug);
pavolmarko@8
   128
pavolmarko@8
   129
		/**
pavolmarko@8
   130
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   131
		*
pavolmarko@8
   132
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   133
		*/
pavolmarko@8
   134
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   135
pavolmarko@8
   136
		/**
pavolmarko@1
   137
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   138
		*
pavolmarko@1
   139
		*	@param iface The interface pointer
pavolmarko@1
   140
		*/
pavolmarko@1
   141
		void *GetCallClass(void *iface, size_t size);
pavolmarko@1
   142
pavolmarko@1
   143
		/**
pavolmarko@1
   144
		*	@brief Release a callclass
pavolmarko@1
   145
		*
pavolmarko@1
   146
		*	@param ptr Pointer to the callclass
pavolmarko@1
   147
		*/
pavolmarko@1
   148
		virtual void ReleaseCallClass(void *ptr);
pavolmarko@1
   149
pavolmarko@1
   150
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   151
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   152
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   153
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   154
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   155
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   156
pavolmarko@1
   157
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   158
		// For hook managers
pavolmarko@1
   159
		virtual META_RES &GetCurResRef();				//!< Gets the pointer to the current meta result
pavolmarko@1
   160
		virtual META_RES &GetPrevResRef();				//!< Gets the pointer to the previous meta result
pavolmarko@1
   161
		virtual META_RES &GetStatusRef();				//!< Gets the pointer to the status variable
pavolmarko@1
   162
		virtual void SetOrigRet(const void *ptr);		//!< Sets the original return pointer
pavolmarko@1
   163
		virtual void SetOverrideRet(const void *ptr);	//!< Sets the override result pointer
pavolmarko@1
   164
		virtual void SetIfacePtr(void *ptr);			//!< Sets the interface this pointer
pavolmarko@1
   165
	};
pavolmarko@1
   166
}
pavolmarko@1
   167
pavolmarko@1
   168
#endif