sourcehook/sourcehook_impl.h
author Pavol Marko <pavolmarko@gmail.com>
Thu Apr 14 12:54:13 2005 +0000 (2005-04-14)
changeset 1 586787053c73
child 6 4803fd7d28bb
permissions -rw-r--r--
Initial import to CVS
pavolmarko@1
     1
/* ======== SourceHook ========
pavolmarko@1
     2
* By PM
pavolmarko@1
     3
* No warranties of any kind
pavolmarko@1
     4
*
pavolmarko@1
     5
* This file declares necessary stuff for the sourcehook implementation.
pavolmarko@1
     6
* ============================
pavolmarko@1
     7
*/
pavolmarko@1
     8
pavolmarko@1
     9
#ifndef __SOURCEHOOK_IMPL_H__
pavolmarko@1
    10
#define __SOURCEHOOK_IMPL_H__
pavolmarko@1
    11
pavolmarko@1
    12
#include "sourcehook.h"
pavolmarko@1
    13
pavolmarko@1
    14
// Set this to 1 to enable runtime code generation (faster)
pavolmarko@1
    15
#define SH_RUNTIME_CODEGEN 1
pavolmarko@1
    16
pavolmarko@1
    17
namespace SourceHook
pavolmarko@1
    18
{
pavolmarko@1
    19
	/**
pavolmarko@1
    20
	*	@brief The SourceHook implementation class
pavolmarko@1
    21
	*/
pavolmarko@1
    22
	class CSourceHookImpl : public ISourceHook
pavolmarko@1
    23
	{
pavolmarko@1
    24
		/**
pavolmarko@1
    25
		*	@brief A list of HookerInfo structures
pavolmarko@1
    26
		*/
pavolmarko@1
    27
		typedef std::list<HookerInfo> HookerInfoList;
pavolmarko@1
    28
pavolmarko@1
    29
pavolmarko@1
    30
		/**
pavolmarko@1
    31
		*	@brief A list of Impl_CallClass structures
pavolmarko@1
    32
		*/
pavolmarko@1
    33
		typedef std::list<CallClass> Impl_CallClassList;
pavolmarko@1
    34
pavolmarko@1
    35
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@1
    36
		HookerInfoList m_Hookers;					//!< A list of hookers
pavolmarko@1
    37
pavolmarko@1
    38
		int m_PageSize;								//!< Stores the system's page size
pavolmarko@1
    39
pavolmarko@1
    40
		/**
pavolmarko@1
    41
		*	@brief Finds a hooker for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
    42
		*/
pavolmarko@1
    43
		HookerInfoList::iterator FindHooker(HookerInfoList::iterator begin, HookerInfoList::iterator end, 
pavolmarko@1
    44
			const char *proto, int vtblofs, int vtblidx, int thisptrofs);
pavolmarko@1
    45
pavolmarko@1
    46
		void FreeCallClass(CallClass &cc);
pavolmarko@1
    47
		bool ApplyCallClassPatch(CallClass &cc, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@1
    48
pavolmarko@1
    49
		static const int MAX_VTABLE_LEN = 4096;		//!< Maximal vtable length in bytes
pavolmarko@1
    50
pavolmarko@1
    51
		META_RES m_Status, m_PrevRes, m_CurRes;
pavolmarko@1
    52
		const void *m_OrigRet;
pavolmarko@1
    53
		const void *m_OverrideRet;
pavolmarko@1
    54
		void *m_IfacePtr;
pavolmarko@1
    55
	public:
pavolmarko@1
    56
		CSourceHookImpl();
pavolmarko@1
    57
		~CSourceHookImpl();
pavolmarko@1
    58
pavolmarko@1
    59
		/**
pavolmarko@1
    60
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hookers
pavolmarko@1
    61
		*/
pavolmarko@1
    62
		void UnloadPlugin(Plugin plug);
pavolmarko@1
    63
pavolmarko@1
    64
		/**
pavolmarko@1
    65
		*	@brief Shut down the whole system, unregister all hookers
pavolmarko@1
    66
		*/
pavolmarko@1
    67
		void CompleteShutdown();
pavolmarko@1
    68
pavolmarko@1
    69
		/**
pavolmarko@1
    70
		*	@brief Add a hook.
pavolmarko@1
    71
		*
pavolmarko@1
    72
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
    73
		*
pavolmarko@1
    74
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
    75
		*	@param iface The interface pointer
pavolmarko@1
    76
		*	@param myHooker A hooker (hook manager) function that should be capable of handling the corresponding function
pavolmarko@1
    77
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
    78
		*	@param post Set to true if you want a post handler
pavolmarko@1
    79
		*/
pavolmarko@1
    80
		bool AddHook(Plugin plug, void *iface, int ifacesize, Hooker myHooker, ISHDelegate *handler, bool post);
pavolmarko@1
    81
pavolmarko@1
    82
		/**
pavolmarko@1
    83
		*	@brief Removes a hook.
pavolmarko@1
    84
		*
pavolmarko@1
    85
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
    86
		*
pavolmarko@1
    87
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
    88
		*	@param iface The interface pointer
pavolmarko@1
    89
		*	@param vtableoffset Offset to the vtable, in bytes
pavolmarko@1
    90
		*	@param vtableidx Pointer to the vtable index of the function
pavolmarko@1
    91
		*	@param proto A text version of the function prototype; generated by the macros
pavolmarko@1
    92
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
    93
		*	@param post Set to true if you want a post handler
pavolmarko@1
    94
		*/
pavolmarko@1
    95
		bool RemoveHook(Plugin plug, void *iface, Hooker myHooker, ISHDelegate *handler, bool post);
pavolmarko@1
    96
pavolmarko@1
    97
		/**
pavolmarko@1
    98
		*	@brief Checks whether a plugin has (a) hooker(s) that is/are currently used by other plugins
pavolmarko@1
    99
		*
pavolmarko@1
   100
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   101
		*/
pavolmarko@1
   102
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   103
pavolmarko@1
   104
		/**
pavolmarko@1
   105
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   106
		*
pavolmarko@1
   107
		*	@param iface The interface pointer
pavolmarko@1
   108
		*/
pavolmarko@1
   109
		void *GetCallClass(void *iface, size_t size);
pavolmarko@1
   110
pavolmarko@1
   111
		/**
pavolmarko@1
   112
		*	@brief Release a callclass
pavolmarko@1
   113
		*
pavolmarko@1
   114
		*	@param ptr Pointer to the callclass
pavolmarko@1
   115
		*/
pavolmarko@1
   116
		virtual void ReleaseCallClass(void *ptr);
pavolmarko@1
   117
pavolmarko@1
   118
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   119
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   120
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   121
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   122
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   123
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   124
pavolmarko@1
   125
		//////////////////////////////////////////////////////////////////////////
pavolmarko@1
   126
		// For hookers
pavolmarko@1
   127
		virtual META_RES &GetCurResRef();				//!< Gets the pointer to the current meta result
pavolmarko@1
   128
		virtual META_RES &GetPrevResRef();				//!< Gets the pointer to the previous meta result
pavolmarko@1
   129
		virtual META_RES &GetStatusRef();				//!< Gets the pointer to the status variable
pavolmarko@1
   130
		virtual void SetOrigRet(const void *ptr);		//!< Sets the original return pointer
pavolmarko@1
   131
		virtual void SetOverrideRet(const void *ptr);	//!< Sets the override result pointer
pavolmarko@1
   132
		virtual void SetIfacePtr(void *ptr);			//!< Sets the interface this pointer
pavolmarko@1
   133
	};
pavolmarko@1
   134
}
pavolmarko@1
   135
pavolmarko@1
   136
#endif