|
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@58
|
31 |
RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman, |
|
pavolmarko@41
|
32 |
ISHDelegate *phandler, bool ppost) |
|
pavolmarko@58
|
33 |
: plug(pplug), iface(piface), thisptr_offs(tpo), |
|
pavolmarko@58
|
34 |
hookman(phookman), handler(phandler), post(ppost) |
|
pavolmarko@6
|
35 |
{ |
|
pavolmarko@6
|
36 |
} |
|
pavolmarko@6
|
37 |
|
|
pavolmarko@6
|
38 |
Plugin plug; |
|
pavolmarko@6
|
39 |
void *iface; |
|
pavolmarko@58
|
40 |
int thisptr_offs; |
|
pavolmarko@41
|
41 |
HookManagerPubFunc hookman; |
|
pavolmarko@6
|
42 |
ISHDelegate *handler; |
|
pavolmarko@6
|
43 |
bool post; |
|
pavolmarko@6
|
44 |
}; |
|
pavolmarko@6
|
45 |
|
|
pavolmarko@6
|
46 |
/** |
|
pavolmarko@6
|
47 |
* @brief A list of HookManagerInfo structures |
|
pavolmarko@6
|
48 |
*/ |
|
pavolmarko@6
|
49 |
typedef std::list<HookManagerInfo> HookManInfoList; |
|
pavolmarko@1
|
50 |
|
|
pavolmarko@41
|
51 |
struct CallClassInfo |
|
pavolmarko@41
|
52 |
{ |
|
pavolmarko@41
|
53 |
GenericCallClass cc; |
|
pavolmarko@41
|
54 |
int refcounter; |
|
pavolmarko@41
|
55 |
bool operator==(void *other) |
|
pavolmarko@41
|
56 |
{ |
|
pavolmarko@41
|
57 |
return cc.ptr == other; |
|
pavolmarko@41
|
58 |
} |
|
pavolmarko@41
|
59 |
}; |
|
pavolmarko@1
|
60 |
/** |
|
pavolmarko@41
|
61 |
* @brief A list of CallClass structures |
|
pavolmarko@1
|
62 |
*/ |
|
pavolmarko@41
|
63 |
typedef std::list<CallClassInfo> Impl_CallClassList; |
|
pavolmarko@1
|
64 |
|
|
pavolmarko@1
|
65 |
Impl_CallClassList m_CallClasses; //!< A list of already generated callclasses |
|
pavolmarko@6
|
66 |
HookManInfoList m_HookMans; //!< A list of hook managers |
|
pavolmarko@1
|
67 |
|
|
pavolmarko@1
|
68 |
/** |
|
pavolmarko@6
|
69 |
* @brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index |
|
pavolmarko@1
|
70 |
*/ |
|
pavolmarko@6
|
71 |
HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end, |
|
pavolmarko@41
|
72 |
const char *proto, int vtblofs, int vtblidx); |
|
pavolmarko@1
|
73 |
|
|
pavolmarko@41
|
74 |
void ApplyCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx, void *orig_entry); |
|
pavolmarko@58
|
75 |
void ApplyCallClassPatches(CallClassInfo &cc); |
|
pavolmarko@58
|
76 |
void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry); |
|
pavolmarko@42
|
77 |
void RemoveCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx); |
|
pavolmarko@58
|
78 |
void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx); |
|
pavolmarko@1
|
79 |
|
|
pavolmarko@1
|
80 |
META_RES m_Status, m_PrevRes, m_CurRes; |
|
pavolmarko@1
|
81 |
const void *m_OrigRet; |
|
pavolmarko@1
|
82 |
const void *m_OverrideRet; |
|
pavolmarko@1
|
83 |
void *m_IfacePtr; |
|
pavolmarko@1
|
84 |
public: |
|
pavolmarko@1
|
85 |
CSourceHookImpl(); |
|
pavolmarko@1
|
86 |
~CSourceHookImpl(); |
|
pavolmarko@1
|
87 |
|
|
pavolmarko@1
|
88 |
/** |
|
pavolmarko@58
|
89 |
* @brief Returns the interface version |
|
pavolmarko@58
|
90 |
*/ |
|
pavolmarko@58
|
91 |
int GetIfaceVersion(); |
|
pavolmarko@58
|
92 |
|
|
pavolmarko@58
|
93 |
/** |
|
pavolmarko@58
|
94 |
* @brief Returns the implemnetation version |
|
pavolmarko@58
|
95 |
*/ |
|
pavolmarko@58
|
96 |
int GetImplVersion(); |
|
pavolmarko@58
|
97 |
|
|
pavolmarko@58
|
98 |
/** |
|
pavolmarko@6
|
99 |
* @brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers |
|
pavolmarko@1
|
100 |
*/ |
|
pavolmarko@1
|
101 |
void UnloadPlugin(Plugin plug); |
|
pavolmarko@1
|
102 |
|
|
pavolmarko@1
|
103 |
/** |
|
pavolmarko@6
|
104 |
* @brief Shut down the whole system, unregister all hook managers |
|
pavolmarko@1
|
105 |
*/ |
|
pavolmarko@1
|
106 |
void CompleteShutdown(); |
|
pavolmarko@1
|
107 |
|
|
pavolmarko@1
|
108 |
/** |
|
pavolmarko@1
|
109 |
* @brief Add a hook. |
|
pavolmarko@1
|
110 |
* |
|
pavolmarko@1
|
111 |
* @return True if the function succeeded, false otherwise |
|
pavolmarko@1
|
112 |
* |
|
pavolmarko@1
|
113 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@1
|
114 |
* @param iface The interface pointer |
|
pavolmarko@6
|
115 |
* @param ifacesize The size of the class iface points to |
|
pavolmarko@6
|
116 |
* @param myHookMan A hook manager function that should be capable of handling the function |
|
pavolmarko@1
|
117 |
* @param handler A pointer to a FastDelegate containing the hook handler |
|
pavolmarko@1
|
118 |
* @param post Set to true if you want a post handler |
|
pavolmarko@1
|
119 |
*/ |
|
pavolmarko@41
|
120 |
bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post); |
|
pavolmarko@1
|
121 |
|
|
pavolmarko@1
|
122 |
/** |
|
pavolmarko@1
|
123 |
* @brief Removes a hook. |
|
pavolmarko@1
|
124 |
* |
|
pavolmarko@1
|
125 |
* @return True if the function succeeded, false otherwise |
|
pavolmarko@1
|
126 |
* |
|
pavolmarko@1
|
127 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@1
|
128 |
* @param iface The interface pointer |
|
pavolmarko@41
|
129 |
* @param thisptr_offs This pointer adjuster |
|
pavolmarko@41
|
130 |
* @param myHookMan A hook manager function that should be capable of handling the function |
|
pavolmarko@41
|
131 |
* @param handler A pointer to a FastDelegate containing the hook handler |
|
pavolmarko@41
|
132 |
* @param post Set to true if you want a post handler |
|
pavolmarko@41
|
133 |
*/ |
|
pavolmarko@41
|
134 |
bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post); |
|
pavolmarko@41
|
135 |
|
|
pavolmarko@41
|
136 |
/** |
|
pavolmarko@41
|
137 |
* @brief Removes a hook. |
|
pavolmarko@41
|
138 |
* |
|
pavolmarko@41
|
139 |
* @ return True if the function succeeded, false otherwise |
|
pavolmarko@41
|
140 |
* |
|
pavolmarko@41
|
141 |
* @param info A RemoveHookInfo structure, describing the hook |
|
pavolmarko@41
|
142 |
*/ |
|
pavolmarko@41
|
143 |
bool RemoveHook(RemoveHookInfo info); |
|
pavolmarko@41
|
144 |
|
|
pavolmarko@41
|
145 |
/** |
|
pavolmarko@6
|
146 |
* @brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins |
|
pavolmarko@1
|
147 |
* |
|
pavolmarko@1
|
148 |
* @param plug The unique identifier of the plugin in question |
|
pavolmarko@1
|
149 |
*/ |
|
pavolmarko@1
|
150 |
bool IsPluginInUse(Plugin plug); |
|
pavolmarko@1
|
151 |
|
|
pavolmarko@1
|
152 |
/** |
|
pavolmarko@8
|
153 |
* @brief Pauses all hooks of a plugin |
|
pavolmarko@8
|
154 |
* |
|
pavolmarko@8
|
155 |
* @param plug The unique identifier of the plugin |
|
pavolmarko@8
|
156 |
*/ |
|
pavolmarko@8
|
157 |
void PausePlugin(Plugin plug); |
|
pavolmarko@8
|
158 |
|
|
pavolmarko@8
|
159 |
/** |
|
pavolmarko@8
|
160 |
* @brief Unpauses all hooks of a plugin |
|
pavolmarko@8
|
161 |
* |
|
pavolmarko@8
|
162 |
* @param plug The unique identifier of the plugin |
|
pavolmarko@8
|
163 |
*/ |
|
pavolmarko@8
|
164 |
void UnpausePlugin(Plugin plug); |
|
pavolmarko@8
|
165 |
|
|
pavolmarko@8
|
166 |
/** |
|
pavolmarko@1
|
167 |
* @brief Return a pointer to a callclass. Generate a new one if required. |
|
pavolmarko@1
|
168 |
* |
|
pavolmarko@1
|
169 |
* @param iface The interface pointer |
|
pavolmarko@58
|
170 |
* @param size Size of the class instance |
|
pavolmarko@1
|
171 |
*/ |
|
pavolmarko@58
|
172 |
GenericCallClass *GetCallClass(void *iface, size_t size); |
|
pavolmarko@1
|
173 |
|
|
pavolmarko@1
|
174 |
/** |
|
pavolmarko@1
|
175 |
* @brief Release a callclass |
|
pavolmarko@1
|
176 |
* |
|
pavolmarko@1
|
177 |
* @param ptr Pointer to the callclass |
|
pavolmarko@1
|
178 |
*/ |
|
pavolmarko@41
|
179 |
virtual void ReleaseCallClass(GenericCallClass *ptr); |
|
pavolmarko@1
|
180 |
|
|
pavolmarko@1
|
181 |
virtual void SetRes(META_RES res); //!< Sets the meta result |
|
pavolmarko@1
|
182 |
virtual META_RES GetPrevRes(); //!< Gets the meta result of the previously called handler |
|
pavolmarko@1
|
183 |
virtual META_RES GetStatus(); //!< Gets the highest meta result |
|
pavolmarko@1
|
184 |
virtual const void *GetOrigRet(); //!< Gets the original result. If not in post function, undefined |
|
pavolmarko@1
|
185 |
virtual const void *GetOverrideRet(); //!< Gets the override result. If none is specified, NULL |
|
pavolmarko@1
|
186 |
virtual void *GetIfacePtr(); //!< Gets the interface pointer |
|
pavolmarko@1
|
187 |
|
|
pavolmarko@1
|
188 |
////////////////////////////////////////////////////////////////////////// |
|
pavolmarko@6
|
189 |
// For hook managers |
|
pavolmarko@58
|
190 |
virtual META_RES &GetCurResRef(); //!< Gets the reference to the current meta result |
|
pavolmarko@58
|
191 |
virtual META_RES &GetPrevResRef(); //!< Gets the reference to the previous meta result |
|
pavolmarko@58
|
192 |
virtual META_RES &GetStatusRef(); //!< Gets the reference to the status variable |
|
pavolmarko@58
|
193 |
virtual void* &GetIfacePtrRef(); //!< Gets the reference to the iface ptr |
|
pavolmarko@1
|
194 |
virtual void SetOrigRet(const void *ptr); //!< Sets the original return pointer |
|
pavolmarko@1
|
195 |
virtual void SetOverrideRet(const void *ptr); //!< Sets the override result pointer |
|
pavolmarko@1
|
196 |
}; |
|
pavolmarko@1
|
197 |
} |
|
pavolmarko@1
|
198 |
|
|
dvander@34
|
199 |
#endif |
|
dvander@34
|
200 |
|