|
pavolmarko@1
|
1 |
/* ======== SourceHook ======== |
|
ds@294
|
2 |
* Copyright (C) 2004-2007 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" |
|
pavolmarko@324
|
19 |
#include "sh_listcat.h" |
|
ds@86
|
20 |
|
|
pavolmarko@163
|
21 |
/* |
|
pavolmarko@163
|
22 |
|
|
pavolmarko@163
|
23 |
IMPLEMENTATION INFO |
|
pavolmarko@163
|
24 |
|
|
pavolmarko@163
|
25 |
--------------------------------------- |
|
pavolmarko@163
|
26 |
Protos ("Prototypes") |
|
pavolmarko@163
|
27 |
The purpose of protos is to provide the amount of type information about a function |
|
pavolmarko@163
|
28 |
which is required to be able to execute a function call without corrupting the stack. |
|
pavolmarko@233
|
29 |
Our protos do not fully do this, but they provide the size of the return value, the number of |
|
pavolmarko@233
|
30 |
parameters, and the size of each parameter, which is enough for most situations. |
|
pavolmarko@163
|
31 |
|
|
pavolmarko@163
|
32 |
There are two version of protos: |
|
pavolmarko@163
|
33 |
OLD: |
|
pavolmarko@163
|
34 |
C-Style strings. |
|
pavolmarko@163
|
35 |
|
|
pavolmarko@163
|
36 |
0_void: |
|
pavolmarko@163
|
37 |
"attrib" |
|
pavolmarko@163
|
38 |
1_void: |
|
pavolmarko@163
|
39 |
"attrib|param1_type" |
|
pavolmarko@163
|
40 |
2_void: |
|
pavolmarko@163
|
41 |
"attrib|param1_type|param2_type |
|
pavolmarko@163
|
42 |
0: |
|
pavolmarko@163
|
43 |
"attrib|ret_type" |
|
pavolmarko@163
|
44 |
1: |
|
pavolmarko@163
|
45 |
"attrib|ret_type|param1_type" |
|
pavolmarko@163
|
46 |
2: |
|
pavolmarko@163
|
47 |
"attrib|ret_type|param2_type" |
|
pavolmarko@163
|
48 |
|
|
pavolmarko@163
|
49 |
Old protos are deprecated. |
|
pavolmarko@163
|
50 |
|
|
pavolmarko@163
|
51 |
NEW: |
|
pavolmarko@163
|
52 |
New protos are in fact pointers to the ProtoInfo structure (see sourcehook.h) |
|
pavolmarko@163
|
53 |
|
|
pavolmarko@163
|
54 |
Old protos begin with a non-zero byte, new protos begin with a zero byte. |
|
pavolmarko@163
|
55 |
|
|
pavolmarko@163
|
56 |
Protos are usually stored in a CProto instance. |
|
pavolmarko@163
|
57 |
|
|
pavolmarko@163
|
58 |
--------------------------------------- |
|
pavolmarko@163
|
59 |
Hook managers and hook manager containers |
|
pavolmarko@163
|
60 |
Each hookman container is tied to _one_ proto/vtable index/vtable offset info. |
|
pavolmarko@163
|
61 |
Hookman containers then contain a list of hook managers provided by plugins, sorted by version. |
|
pavolmarko@163
|
62 |
(higher versions come first) |
|
pavolmarko@163
|
63 |
|
|
pavolmarko@163
|
64 |
Duplicate hook managers are ignored (ie. hook managers where proto, vtable index, vtable offset, |
|
pavolmarko@163
|
65 |
plugin, version are the same as in an already exisiting hook manager) |
|
pavolmarko@163
|
66 |
|
|
pavolmarko@163
|
67 |
A new hook manager is always added to the end of the version group in the corresponding |
|
pavolmarko@163
|
68 |
hook container. |
|
pavolmarko@163
|
69 |
|
|
pavolmarko@163
|
70 |
If the new hook manager was added to the beginning of the container (which only happens if |
|
pavolmarko@163
|
71 |
it is the first one or if it has a higher version than the previously first hook manager), |
|
pavolmarko@163
|
72 |
the now second hook manager is shut down and the new hook manager takes its job. |
|
pavolmarko@163
|
73 |
|
|
pavolmarko@163
|
74 |
A "hook manager container id" (HMCI) consits of three values: proto, vtbl index, vtbl offset. |
|
pavolmarko@163
|
75 |
--------------------------------------- |
|
pavolmarko@163
|
76 |
Hooks |
|
pavolmarko@163
|
77 |
When adding a hook, first the proposed hook manager is added to the corresponding |
|
pavolmarko@163
|
78 |
hook manager container as described above. |
|
pavolmarko@163
|
79 |
|
|
pavolmarko@163
|
80 |
Then the first hook manager in the the manhook container is chosen to handle the function. |
|
pavolmarko@163
|
81 |
|
|
pavolmarko@163
|
82 |
Removing a hook does not neccessarily unreigster the plugin's hook manager. In order to do this, |
|
pavolmarko@163
|
83 |
use RemoveHookManager or UnloadPlugin/ |
|
pavolmarko@163
|
84 |
|
|
pavolmarko@163
|
85 |
Hooks can be paused - they remain in memory but they are not called. In SH, the hook iterator |
|
pavolmarko@163
|
86 |
classes handle pausing transparently. |
|
pavolmarko@163
|
87 |
|
|
pavolmarko@163
|
88 |
The hook loop is supposed to call ShouldContinue before each iteration. This makes hook handlers |
|
pavolmarko@163
|
89 |
able to remove themselves. |
|
pavolmarko@163
|
90 |
|
|
pavolmarko@163
|
91 |
--------------------------------------- |
|
pavolmarko@163
|
92 |
Call classes |
|
pavolmarko@328
|
93 |
|
|
pavolmarko@328
|
94 |
!! deprecated !! - see below (new SH_CALL) |
|
pavolmarko@328
|
95 |
|
|
pavolmarko@163
|
96 |
Call classes are identified by a this pointer and an instance size |
|
pavolmarko@163
|
97 |
|
|
pavolmarko@163
|
98 |
We use the instance size because a derived class instance and a base class instance could |
|
pavolmarko@163
|
99 |
have the same this pointers, and we want to avoid that the derived class |
|
pavolmarko@163
|
100 |
(which could be bigger) gets the same callclass as the base class (mainly if the |
|
pavolmarko@163
|
101 |
base class' callclass was requested first). |
|
pavolmarko@163
|
102 |
|
|
pavolmarko@163
|
103 |
Call classes are reference counted. |
|
pavolmarko@163
|
104 |
|
|
pavolmarko@163
|
105 |
The original function pointers are stored in a vector (in order to allow fast random access). |
|
pavolmarko@163
|
106 |
These vectors are stored as the value type of a hash. The key type is int and represents the |
|
pavolmarko@163
|
107 |
vtable offset. |
|
pavolmarko@163
|
108 |
|
|
pavolmarko@163
|
109 |
If the hash key doesn't exist or the vtblidx is out of range or the corresponding element in the |
|
pavolmarko@163
|
110 |
vector is NULL, there is no hook on that function. |
|
pavolmarko@163
|
111 |
|
|
pavolmarko@163
|
112 |
--------------------------------------- |
|
pavolmarko@163
|
113 |
Recalls |
|
pavolmarko@163
|
114 |
Recalls are used for the META_RETURN_(VALUE_)NEWPARAMS macros, ie. to change the parameters |
|
pavolmarko@163
|
115 |
in the hook loop on the fly. |
|
pavolmarko@163
|
116 |
|
|
pavolmarko@163
|
117 |
First, the macro calls DoRecall(), then it calls the function the hook is attached to -> it |
|
pavolmarko@163
|
118 |
calls the hookfunc. SourceHook makes sure that the newly invoked hook loop starts where the last |
|
pavolmarko@163
|
119 |
one left off and that status variables like status, previous result, override return are kept. |
|
pavolmarko@163
|
120 |
When this recurisvely called hookfunc returns, the macro returns what it returned |
|
pavolmarko@163
|
121 |
(using MRES_SUPERCEDE). CSourceHookImpl returns false from ShouldContinue so the original hook loop |
|
pavolmarko@163
|
122 |
is abandonned. |
|
pavolmarko@179
|
123 |
|
|
pavolmarko@179
|
124 |
Post Recalls |
|
pavolmarko@179
|
125 |
People wanted to be able to use META_RETURN_(VALUE_)NEWPARAMS from post hooks as well. Crazy people! |
|
pavolmarko@179
|
126 |
Anyway, for this, we have to know where a hook handler is. Is it executing pre or post hooks at the moment? |
|
pavolmarko@179
|
127 |
The only way we can know this is watching when it calls CHookList::GetIter(). So CHookList gets a new variable: |
|
pavolmarko@179
|
128 |
m_RequestedFlag. It also gets two new functions: RQFlagReset() and RQFlagGet(). |
|
pavolmarko@179
|
129 |
HookLoopBegin() calls RQFlagReset on both hooklists of the iface; then DoRecall() checks whether the postlist's |
|
pavolmarko@179
|
130 |
RQ flag is set. if yes, the hook loop is in post mode. |
|
pavolmarko@179
|
131 |
|
|
pavolmarko@179
|
132 |
So, what a about a recall in post mode? The first ShouldContinue returns false and sets Status to supercede. |
|
pavolmarko@179
|
133 |
This way the pre hooks and the function call will be skipped. Then, then next ShouldContinue returns true, so we get |
|
pavolmarko@179
|
134 |
into the post hooks. HA! |
|
pavolmarko@179
|
135 |
|
|
pavolmarko@179
|
136 |
Return Values in Post Recalls |
|
pavolmarko@179
|
137 |
The easy case is when we already have an override return value. In this case, the status register gets transferred, |
|
pavolmarko@179
|
138 |
and so does the override return pointer. So, basically, everything is ok. |
|
pavolmarko@179
|
139 |
|
|
pavolmarko@179
|
140 |
However, what happens if we don't? ie. the status register is on MRES_IGNORED? In this case we'd have to transfer the |
|
pavolmarko@179
|
141 |
orig ret value. But we can't: There's no way to tell the hookfunc: "Use this as orig ret pointer". It uses its own. |
|
pavolmarko@179
|
142 |
So, we emulate it. GetOrigRet will return the orig ret pointer from the old hook loop. If still no one overrides it, |
|
pavolmarko@179
|
143 |
we'd have to return it. BUT! HOW TO DO THIS? Check out SH_RETURN(). First calls HookLoopEnd(), then decides whether |
|
pavolmarko@179
|
144 |
to return the override retval or the orig retval. But it doesn't ask for a new override return. So we give the function |
|
pavolmarko@179
|
145 |
the last orig return value as its new override return value; but leave status where it is so everything works, and in |
|
pavolmarko@179
|
146 |
HookLoopEnd we make sure that status is high enough so that the override return will be returned. crazy. |
|
pavolmarko@179
|
147 |
|
|
pavolmarko@179
|
148 |
All this stuff could be much less complicated if I didn't try to preserve binary compatibility :) |
|
pavolmarko@324
|
149 |
|
|
pavolmarko@324
|
150 |
VP Hooks |
|
pavolmarko@324
|
151 |
VP hooks are hooks which are called on a vfnptr, regardless of the this pointer with which it was called. They are |
|
pavolmarko@324
|
152 |
implemented as a special CIface instance with m_Ptr = NULL. All Hook Lists have a new "ListCatIterator" which |
|
pavolmarko@324
|
153 |
virtually concatenates the NULL-interface-hook-list with their normal hook list. |
|
pavolmarko@324
|
154 |
|
|
pavolmarko@324
|
155 |
|
|
pavolmarko@324
|
156 |
I'm afraid that with the addition of Recalls and VP Hooks, SourceHook is now a pretty complex and hacked-together |
|
pavolmarko@324
|
157 |
binary compatible beast which is pretty hard to maintain unless you've written it :) |
|
pavolmarko@328
|
158 |
|
|
pavolmarko@328
|
159 |
New SH_CALL |
|
pavolmarko@328
|
160 |
The addition of VP hooks messed up the Call Classes concept (see above) - call classes are bound to an |
|
pavolmarko@328
|
161 |
instance pointer; they only work on one of the hooked instances. But VP hooks are called on all instances. |
|
pavolmarko@328
|
162 |
|
|
pavolmarko@328
|
163 |
That's why now, SH_CALL takes an instance pointer instead of a callclass pointer. It basically does this: |
|
pavolmarko@328
|
164 |
1) call SH_GLOB_PTR->SetIgnoreHooks(vfnptr) |
|
pavolmarko@328
|
165 |
2) call this->*mfp |
|
pavolmarko@328
|
166 |
3) call SH_GLOB_PTR->ResetIgnoreHooks(vfnptr) |
|
pavolmarko@328
|
167 |
|
|
pavolmarko@328
|
168 |
SourceHook stroes the "ignored vfnptr" and makes CVfnPtr::FindIface return NULL if the CVfnPtr instance |
|
pavolmarko@328
|
169 |
corresponds to the ignored vfnptr. This way the hook manager thinks that the instance isn't hooked, and calls |
|
pavolmarko@328
|
170 |
the original function. Everything works fine. This works even for VP hooks. |
|
pavolmarko@163
|
171 |
*/ |
|
pavolmarko@163
|
172 |
|
|
pavolmarko@328
|
173 |
// See sourcehook.hxx :) |
|
pavolmarko@328
|
174 |
#undef CallClass |
|
pavolmarko@328
|
175 |
#undef ManualCallClass |
|
pavolmarko@328
|
176 |
|
|
pavolmarko@1
|
177 |
namespace SourceHook |
|
pavolmarko@1
|
178 |
{ |
|
pavolmarko@1
|
179 |
/** |
|
pavolmarko@1
|
180 |
* @brief The SourceHook implementation class |
|
pavolmarko@1
|
181 |
*/ |
|
pavolmarko@1
|
182 |
class CSourceHookImpl : public ISourceHook |
|
pavolmarko@1
|
183 |
{ |
|
pavolmarko@117
|
184 |
private: |
|
pavolmarko@163
|
185 |
class CProto |
|
pavolmarko@163
|
186 |
{ |
|
dvander@181
|
187 |
char *m_Proto; |
|
pavolmarko@163
|
188 |
|
|
pavolmarko@163
|
189 |
static bool Equal(const char *p1, const char *p2); |
|
dvander@181
|
190 |
char *DupProto(const char *src); |
|
dvander@181
|
191 |
void FreeProto(char *prot); |
|
pavolmarko@163
|
192 |
public: |
|
pavolmarko@324
|
193 |
CProto() : m_Proto(NULL) |
|
pavolmarko@324
|
194 |
{ |
|
pavolmarko@324
|
195 |
} |
|
pavolmarko@324
|
196 |
|
|
dvander@181
|
197 |
CProto(const char *szProto) : m_Proto(DupProto(szProto)) |
|
pavolmarko@163
|
198 |
{ |
|
pavolmarko@163
|
199 |
} |
|
pavolmarko@163
|
200 |
|
|
dvander@181
|
201 |
CProto(const CProto &other) : m_Proto(DupProto(other.m_Proto)) |
|
pavolmarko@163
|
202 |
{ |
|
pavolmarko@163
|
203 |
} |
|
pavolmarko@163
|
204 |
|
|
dvander@181
|
205 |
~CProto() |
|
dvander@181
|
206 |
{ |
|
dvander@181
|
207 |
FreeProto(m_Proto); |
|
dvander@181
|
208 |
m_Proto = NULL; |
|
dvander@181
|
209 |
} |
|
dvander@181
|
210 |
|
|
pavolmarko@163
|
211 |
void operator = (const char *szProto) |
|
pavolmarko@163
|
212 |
{ |
|
dvander@181
|
213 |
m_Proto = DupProto(szProto); |
|
pavolmarko@163
|
214 |
} |
|
dvander@181
|
215 |
|
|
pavolmarko@163
|
216 |
void operator = (const CProto &other) |
|
pavolmarko@163
|
217 |
{ |
|
dvander@181
|
218 |
m_Proto = DupProto(other.m_Proto); |
|
pavolmarko@163
|
219 |
} |
|
pavolmarko@163
|
220 |
|
|
pavolmarko@163
|
221 |
bool operator == (const char *szProto) const |
|
pavolmarko@163
|
222 |
{ |
|
pavolmarko@163
|
223 |
return Equal(szProto, m_Proto); |
|
pavolmarko@163
|
224 |
} |
|
pavolmarko@163
|
225 |
bool operator == (const CProto &other) const |
|
pavolmarko@163
|
226 |
{ |
|
pavolmarko@163
|
227 |
return Equal(other.m_Proto, m_Proto); |
|
pavolmarko@163
|
228 |
} |
|
pavolmarko@324
|
229 |
|
|
pavolmarko@324
|
230 |
const char *GetProto() const |
|
pavolmarko@324
|
231 |
{ |
|
pavolmarko@324
|
232 |
return m_Proto; |
|
pavolmarko@324
|
233 |
} |
|
pavolmarko@163
|
234 |
}; |
|
pavolmarko@163
|
235 |
|
|
pavolmarko@163
|
236 |
|
|
pavolmarko@1
|
237 |
/** |
|
pavolmarko@6
|
238 |
* @brief A hook can be removed if you have this information |
|
pavolmarko@1
|
239 |
*/ |
|
pavolmarko@6
|
240 |
struct RemoveHookInfo |
|
pavolmarko@6
|
241 |
{ |
|
pavolmarko@58
|
242 |
RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman, |
|
pavolmarko@41
|
243 |
ISHDelegate *phandler, bool ppost) |
|
pavolmarko@58
|
244 |
: plug(pplug), iface(piface), thisptr_offs(tpo), |
|
pavolmarko@58
|
245 |
hookman(phookman), handler(phandler), post(ppost) |
|
pavolmarko@6
|
246 |
{ |
|
pavolmarko@6
|
247 |
} |
|
pavolmarko@6
|
248 |
|
|
pavolmarko@6
|
249 |
Plugin plug; |
|
pavolmarko@6
|
250 |
void *iface; |
|
pavolmarko@58
|
251 |
int thisptr_offs; |
|
pavolmarko@41
|
252 |
HookManagerPubFunc hookman; |
|
pavolmarko@6
|
253 |
ISHDelegate *handler; |
|
pavolmarko@6
|
254 |
bool post; |
|
pavolmarko@6
|
255 |
}; |
|
pavolmarko@6
|
256 |
|
|
pavolmarko@163
|
257 |
struct RemoveHookManInfo |
|
pavolmarko@163
|
258 |
{ |
|
pavolmarko@163
|
259 |
RemoveHookManInfo(Plugin pplug, HookManagerPubFunc phookman) |
|
pavolmarko@163
|
260 |
: plug(pplug), hookman(phookman) |
|
pavolmarko@163
|
261 |
{ |
|
pavolmarko@163
|
262 |
} |
|
pavolmarko@163
|
263 |
|
|
pavolmarko@163
|
264 |
Plugin plug; |
|
pavolmarko@163
|
265 |
HookManagerPubFunc hookman; |
|
pavolmarko@163
|
266 |
}; |
|
pavolmarko@163
|
267 |
|
|
pavolmarko@324
|
268 |
// Associates hook ids with info about the hooks |
|
pavolmarko@324
|
269 |
// Also used to keep track of used hook ids |
|
pavolmarko@324
|
270 |
class CHookIDManager |
|
pavolmarko@324
|
271 |
{ |
|
pavolmarko@324
|
272 |
public: |
|
pavolmarko@324
|
273 |
struct Entry |
|
pavolmarko@324
|
274 |
{ |
|
pavolmarko@324
|
275 |
bool isfree; |
|
pavolmarko@324
|
276 |
|
|
pavolmarko@324
|
277 |
// hookman info |
|
pavolmarko@324
|
278 |
CProto proto; |
|
pavolmarko@324
|
279 |
int vtbl_offs; |
|
pavolmarko@324
|
280 |
int vtbl_idx; |
|
pavolmarko@324
|
281 |
|
|
pavolmarko@324
|
282 |
// vfnptr |
|
pavolmarko@324
|
283 |
void *vfnptr; |
|
pavolmarko@324
|
284 |
|
|
pavolmarko@324
|
285 |
// iface |
|
pavolmarko@324
|
286 |
void* adjustediface; |
|
pavolmarko@324
|
287 |
|
|
pavolmarko@324
|
288 |
// hook |
|
pavolmarko@324
|
289 |
Plugin plug; |
|
pavolmarko@324
|
290 |
int thisptr_offs; |
|
pavolmarko@324
|
291 |
ISHDelegate *handler; |
|
pavolmarko@324
|
292 |
bool post; |
|
pavolmarko@324
|
293 |
|
|
pavolmarko@324
|
294 |
Entry(const CProto &pprt, int pvo, int pvi, void *pvp, void *pai, Plugin pplug, int pto, |
|
pavolmarko@324
|
295 |
ISHDelegate *ph, bool ppost) |
|
pavolmarko@324
|
296 |
: isfree(false), proto(pprt), vtbl_offs(pvo), vtbl_idx(pvi), vfnptr(pvp), |
|
pavolmarko@324
|
297 |
adjustediface(pai), plug(pplug), thisptr_offs(pto), handler(ph), post(ppost) |
|
pavolmarko@324
|
298 |
{ |
|
pavolmarko@324
|
299 |
} |
|
pavolmarko@324
|
300 |
Entry() |
|
pavolmarko@324
|
301 |
{ |
|
pavolmarko@324
|
302 |
} |
|
pavolmarko@324
|
303 |
}; |
|
pavolmarko@324
|
304 |
private: |
|
pavolmarko@324
|
305 |
// Internally, hookid 1 is stored as m_Entries[0] |
|
pavolmarko@324
|
306 |
|
|
pavolmarko@324
|
307 |
CVector<Entry> m_Entries; |
|
pavolmarko@324
|
308 |
public: |
|
pavolmarko@324
|
309 |
CHookIDManager(); |
|
pavolmarko@324
|
310 |
int New(const CProto &proto, int vtbl_offs, int vtbl_idx, void *vfnptr, void *adjustediface, |
|
pavolmarko@324
|
311 |
Plugin plug, int thisptr_offs, ISHDelegate *handler, bool post); |
|
pavolmarko@324
|
312 |
bool Remove(int hookid); |
|
pavolmarko@324
|
313 |
const Entry * QueryHook(int hookid); |
|
pavolmarko@324
|
314 |
|
|
pavolmarko@324
|
315 |
// Finds all hooks with the given info, and fills the hookids into output. |
|
pavolmarko@324
|
316 |
void FindAllHooks(CVector<int> &output, const CProto &proto, int vtbl_offs, int vtbl_idx, |
|
pavolmarko@324
|
317 |
void *adjustediface, Plugin plug, int thisptr_offs, ISHDelegate *handler, bool post); |
|
pavolmarko@324
|
318 |
|
|
pavolmarko@324
|
319 |
// Removes all hooks with a specified vfnptr |
|
pavolmarko@324
|
320 |
bool RemoveAll(void *vfnptr); |
|
pavolmarko@324
|
321 |
}; |
|
pavolmarko@324
|
322 |
|
|
pavolmarko@117
|
323 |
struct HookInfo |
|
pavolmarko@117
|
324 |
{ |
|
pavolmarko@117
|
325 |
ISHDelegate *handler; //!< Pointer to the handler |
|
pavolmarko@117
|
326 |
bool paused; //!< If true, the hook should not be executed |
|
pavolmarko@117
|
327 |
Plugin plug; //!< The owner plugin |
|
pavolmarko@117
|
328 |
int thisptr_offs; //!< This pointer offset |
|
pavolmarko@324
|
329 |
int hookid; //!< Unique ID given by CHookIDManager |
|
pavolmarko@324
|
330 |
|
|
pavolmarko@324
|
331 |
bool operator==(int otherid) |
|
pavolmarko@324
|
332 |
{ |
|
pavolmarko@324
|
333 |
return hookid == otherid; |
|
pavolmarko@324
|
334 |
} |
|
pavolmarko@117
|
335 |
}; |
|
pavolmarko@117
|
336 |
|
|
pavolmarko@117
|
337 |
class CHookList : public IHookList |
|
pavolmarko@117
|
338 |
{ |
|
pavolmarko@117
|
339 |
public: |
|
pavolmarko@324
|
340 |
List<HookInfo> *m_VPList; // left-hand list for ListCatIterator -> for VP hooks |
|
pavolmarko@117
|
341 |
List<HookInfo> m_List; |
|
pavolmarko@117
|
342 |
|
|
pavolmarko@117
|
343 |
friend class CIter; |
|
pavolmarko@117
|
344 |
|
|
pavolmarko@117
|
345 |
class CIter : public IHookList::IIter |
|
pavolmarko@117
|
346 |
{ |
|
pavolmarko@117
|
347 |
friend class CHookList; |
|
pavolmarko@117
|
348 |
|
|
pavolmarko@117
|
349 |
CHookList *m_pList; |
|
pavolmarko@117
|
350 |
|
|
pavolmarko@117
|
351 |
void SkipPaused(); |
|
pavolmarko@117
|
352 |
public: |
|
pavolmarko@121
|
353 |
|
|
pavolmarko@324
|
354 |
ListCatIterator<HookInfo> m_Iter; |
|
pavolmarko@121
|
355 |
|
|
pavolmarko@117
|
356 |
CIter(CHookList *pList); |
|
pavolmarko@117
|
357 |
|
|
pavolmarko@117
|
358 |
virtual ~CIter(); |
|
pavolmarko@117
|
359 |
|
|
pavolmarko@117
|
360 |
void GoToBegin(); |
|
pavolmarko@162
|
361 |
void Set(CIter *pOther); |
|
pavolmarko@117
|
362 |
|
|
pavolmarko@117
|
363 |
bool End(); |
|
pavolmarko@117
|
364 |
void Next(); |
|
pavolmarko@117
|
365 |
ISHDelegate *Handler(); |
|
pavolmarko@117
|
366 |
int ThisPtrOffs(); |
|
pavolmarko@117
|
367 |
|
|
pavolmarko@121
|
368 |
void Clear(); |
|
pavolmarko@121
|
369 |
|
|
pavolmarko@121
|
370 |
CIter *m_pNext; // When stored in m_FreeIters and m_UsedIters |
|
pavolmarko@121
|
371 |
CIter *m_pPrev; // Only used when stored in m_UsedIters |
|
pavolmarko@117
|
372 |
}; |
|
pavolmarko@117
|
373 |
|
|
pavolmarko@117
|
374 |
CIter *m_FreeIters; |
|
pavolmarko@162
|
375 |
CIter *m_UsedIters; // The last returned and not-yet-released iter is always m_UsedIters |
|
pavolmarko@162
|
376 |
|
|
pavolmarko@162
|
377 |
// For recalls |
|
pavolmarko@162
|
378 |
bool m_Recall; |
|
pavolmarko@179
|
379 |
bool m_RQFlag; |
|
pavolmarko@162
|
380 |
|
|
pavolmarko@162
|
381 |
void SetRecallState(); // Sets the list into a state where the next returned |
|
pavolmarko@162
|
382 |
// iterator (from GetIter) will be a copy of the last |
|
pavolmarko@162
|
383 |
// returned iterator, incremented by one. This is used in Recalls. |
|
pavolmarko@162
|
384 |
// The hook resets this state automatically on: |
|
pavolmarko@162
|
385 |
// GetIter, ReleaseIter |
|
pavolmarko@117
|
386 |
|
|
pavolmarko@179
|
387 |
void RQFlagReset() { m_RQFlag = false; } |
|
pavolmarko@179
|
388 |
bool RQFlagGet() { return m_RQFlag; } |
|
pavolmarko@117
|
389 |
CHookList(); |
|
pavolmarko@117
|
390 |
CHookList(const CHookList &other); |
|
pavolmarko@117
|
391 |
virtual ~CHookList(); |
|
pavolmarko@117
|
392 |
|
|
pavolmarko@117
|
393 |
void operator=(const CHookList &other); |
|
pavolmarko@117
|
394 |
|
|
pavolmarko@117
|
395 |
IIter *GetIter(); |
|
pavolmarko@117
|
396 |
void ReleaseIter(IIter *pIter); |
|
pavolmarko@324
|
397 |
|
|
pavolmarko@324
|
398 |
void SetVPList(List<HookInfo> *newList); |
|
pavolmarko@324
|
399 |
void ClearVPList(); |
|
pavolmarko@117
|
400 |
}; |
|
pavolmarko@117
|
401 |
|
|
pavolmarko@117
|
402 |
// I know, data hiding... But I'm a lazy bastard! |
|
pavolmarko@117
|
403 |
|
|
pavolmarko@117
|
404 |
class CIface : public IIface |
|
pavolmarko@117
|
405 |
{ |
|
pavolmarko@117
|
406 |
public: |
|
pavolmarko@117
|
407 |
void *m_Ptr; |
|
pavolmarko@117
|
408 |
CHookList m_PreHooks; |
|
pavolmarko@117
|
409 |
CHookList m_PostHooks; |
|
pavolmarko@117
|
410 |
public: |
|
pavolmarko@117
|
411 |
CIface(void *ptr); |
|
pavolmarko@117
|
412 |
virtual ~CIface(); |
|
pavolmarko@117
|
413 |
|
|
pavolmarko@117
|
414 |
void *GetPtr(); |
|
pavolmarko@117
|
415 |
IHookList *GetPreHooks(); |
|
pavolmarko@117
|
416 |
IHookList *GetPostHooks(); |
|
pavolmarko@117
|
417 |
|
|
pavolmarko@117
|
418 |
bool operator==(void *ptr) |
|
pavolmarko@117
|
419 |
{ |
|
pavolmarko@117
|
420 |
return m_Ptr == ptr; |
|
pavolmarko@117
|
421 |
} |
|
pavolmarko@324
|
422 |
bool operator!=(void *ptr) |
|
pavolmarko@324
|
423 |
{ |
|
pavolmarko@324
|
424 |
return m_Ptr != ptr; |
|
pavolmarko@324
|
425 |
} |
|
pavolmarko@117
|
426 |
}; |
|
pavolmarko@1
|
427 |
|
|
pavolmarko@117
|
428 |
class CVfnPtr : public IVfnPtr |
|
pavolmarko@117
|
429 |
{ |
|
pavolmarko@117
|
430 |
public: |
|
pavolmarko@117
|
431 |
typedef List<CIface> IfaceList; |
|
pavolmarko@117
|
432 |
typedef IfaceList::iterator IfaceListIter; |
|
pavolmarko@117
|
433 |
|
|
pavolmarko@117
|
434 |
void *m_Ptr; |
|
pavolmarko@117
|
435 |
void *m_OrigEntry; |
|
pavolmarko@117
|
436 |
|
|
pavolmarko@117
|
437 |
IfaceList m_Ifaces; |
|
pavolmarko@117
|
438 |
|
|
pavolmarko@328
|
439 |
void **m_pOneIgnore; |
|
pavolmarko@117
|
440 |
public: |
|
pavolmarko@328
|
441 |
CVfnPtr(void *ptr, void **pOneIgnore); |
|
pavolmarko@117
|
442 |
virtual ~CVfnPtr(); |
|
pavolmarko@117
|
443 |
|
|
pavolmarko@117
|
444 |
void *GetVfnPtr(); |
|
pavolmarko@117
|
445 |
void *GetOrigEntry(); |
|
pavolmarko@117
|
446 |
|
|
pavolmarko@117
|
447 |
virtual IIface *FindIface(void *ptr); |
|
pavolmarko@117
|
448 |
|
|
pavolmarko@117
|
449 |
bool operator==(void *ptr) |
|
pavolmarko@117
|
450 |
{ |
|
pavolmarko@117
|
451 |
return m_Ptr == ptr; |
|
pavolmarko@117
|
452 |
} |
|
pavolmarko@117
|
453 |
}; |
|
pavolmarko@117
|
454 |
|
|
pavolmarko@117
|
455 |
class CHookManagerInfo : public IHookManagerInfo |
|
pavolmarko@41
|
456 |
{ |
|
pavolmarko@117
|
457 |
public: |
|
pavolmarko@117
|
458 |
typedef List<CVfnPtr> VfnPtrList; |
|
pavolmarko@117
|
459 |
typedef VfnPtrList::iterator VfnPtrListIter; |
|
pavolmarko@117
|
460 |
|
|
pavolmarko@117
|
461 |
Plugin m_Plug; |
|
pavolmarko@117
|
462 |
HookManagerPubFunc m_Func; |
|
pavolmarko@117
|
463 |
|
|
pavolmarko@117
|
464 |
int m_VtblOffs; |
|
pavolmarko@117
|
465 |
int m_VtblIdx; |
|
pavolmarko@117
|
466 |
const char *m_Proto; |
|
pavolmarko@117
|
467 |
void *m_HookfuncVfnptr; |
|
pavolmarko@117
|
468 |
|
|
pavolmarko@117
|
469 |
VfnPtrList m_VfnPtrs; |
|
pavolmarko@117
|
470 |
|
|
pavolmarko@163
|
471 |
int m_HookManVersion; |
|
pavolmarko@117
|
472 |
public: |
|
pavolmarko@163
|
473 |
CHookManagerInfo(); |
|
pavolmarko@117
|
474 |
virtual ~CHookManagerInfo(); |
|
pavolmarko@117
|
475 |
|
|
pavolmarko@117
|
476 |
IVfnPtr *FindVfnPtr(void *vfnptr); |
|
pavolmarko@117
|
477 |
|
|
pavolmarko@117
|
478 |
void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto); |
|
pavolmarko@117
|
479 |
void SetHookfuncVfnptr(void *hookfunc_vfnptr); |
|
pavolmarko@163
|
480 |
|
|
pavolmarko@163
|
481 |
void SetVersion(int version); |
|
pavolmarko@163
|
482 |
|
|
pavolmarko@163
|
483 |
bool operator < (const CHookManagerInfo &other) |
|
pavolmarko@163
|
484 |
{ |
|
pavolmarko@163
|
485 |
return m_HookManVersion < other.m_HookManVersion; |
|
pavolmarko@163
|
486 |
} |
|
pavolmarko@163
|
487 |
|
|
pavolmarko@163
|
488 |
struct Descriptor |
|
pavolmarko@163
|
489 |
{ |
|
pavolmarko@163
|
490 |
Descriptor(Plugin pplug, HookManagerPubFunc ppubFunc) : plug(pplug), pubFunc(ppubFunc) |
|
pavolmarko@163
|
491 |
{ |
|
pavolmarko@163
|
492 |
} |
|
pavolmarko@163
|
493 |
|
|
pavolmarko@163
|
494 |
Plugin plug; |
|
pavolmarko@163
|
495 |
HookManagerPubFunc pubFunc; |
|
pavolmarko@163
|
496 |
}; |
|
pavolmarko@163
|
497 |
|
|
pavolmarko@163
|
498 |
bool operator == (const Descriptor desc) |
|
pavolmarko@163
|
499 |
{ |
|
pavolmarko@163
|
500 |
return m_Func == desc.pubFunc && m_Plug == desc.plug; |
|
pavolmarko@163
|
501 |
} |
|
pavolmarko@117
|
502 |
}; |
|
pavolmarko@163
|
503 |
|
|
pavolmarko@117
|
504 |
typedef List<CHookManagerInfo> HookManInfoList; |
|
pavolmarko@117
|
505 |
|
|
pavolmarko@163
|
506 |
class CHookManagerContainer : public HookManInfoList |
|
pavolmarko@163
|
507 |
{ |
|
pavolmarko@163
|
508 |
public: |
|
pavolmarko@163
|
509 |
// HMCI (Hook Manager Container Identification) |
|
pavolmarko@163
|
510 |
class HMCI |
|
pavolmarko@163
|
511 |
{ |
|
pavolmarko@163
|
512 |
CProto m_Proto; |
|
pavolmarko@163
|
513 |
int m_VtableOffset; |
|
pavolmarko@163
|
514 |
int m_VtableIndex; |
|
pavolmarko@163
|
515 |
public: |
|
pavolmarko@163
|
516 |
HMCI(const char *proto, int vtbloffs, int vtblidx) : |
|
pavolmarko@163
|
517 |
m_Proto(proto), m_VtableOffset(vtbloffs), m_VtableIndex(vtblidx) |
|
pavolmarko@163
|
518 |
{ |
|
pavolmarko@163
|
519 |
} |
|
pavolmarko@163
|
520 |
~HMCI() |
|
pavolmarko@163
|
521 |
{ |
|
pavolmarko@163
|
522 |
} |
|
pavolmarko@163
|
523 |
|
|
pavolmarko@163
|
524 |
bool operator==(const HMCI &other) const |
|
pavolmarko@163
|
525 |
{ |
|
pavolmarko@163
|
526 |
return |
|
pavolmarko@163
|
527 |
other.m_VtableIndex == m_VtableIndex && |
|
pavolmarko@163
|
528 |
other.m_Proto == m_Proto && |
|
pavolmarko@163
|
529 |
other.m_VtableOffset == m_VtableOffset; |
|
pavolmarko@163
|
530 |
} |
|
pavolmarko@163
|
531 |
|
|
pavolmarko@163
|
532 |
const CProto &GetProto() const |
|
pavolmarko@163
|
533 |
{ |
|
pavolmarko@163
|
534 |
return m_Proto; |
|
pavolmarko@163
|
535 |
} |
|
pavolmarko@163
|
536 |
int GetVtableOffset() const |
|
pavolmarko@163
|
537 |
{ |
|
pavolmarko@163
|
538 |
return m_VtableOffset; |
|
pavolmarko@163
|
539 |
} |
|
pavolmarko@163
|
540 |
int GetVtableIndex() const |
|
pavolmarko@163
|
541 |
{ |
|
pavolmarko@163
|
542 |
return m_VtableIndex; |
|
pavolmarko@163
|
543 |
} |
|
pavolmarko@163
|
544 |
}; |
|
pavolmarko@163
|
545 |
HMCI m_HCMI; |
|
pavolmarko@163
|
546 |
|
|
pavolmarko@163
|
547 |
public: |
|
pavolmarko@163
|
548 |
CHookManagerContainer(const HMCI &hmci) : m_HCMI(hmci) |
|
pavolmarko@163
|
549 |
{ |
|
pavolmarko@163
|
550 |
} |
|
pavolmarko@163
|
551 |
bool operator == (const HMCI &other) const |
|
pavolmarko@163
|
552 |
{ |
|
pavolmarko@163
|
553 |
return m_HCMI == other; |
|
pavolmarko@163
|
554 |
} |
|
pavolmarko@163
|
555 |
void AddHookManager(Plugin plug, const CHookManagerInfo &hookman); |
|
pavolmarko@163
|
556 |
}; |
|
pavolmarko@163
|
557 |
|
|
pavolmarko@117
|
558 |
class CCallClassImpl : public GenericCallClass |
|
pavolmarko@117
|
559 |
{ |
|
pavolmarko@117
|
560 |
public: |
|
pavolmarko@117
|
561 |
|
|
pavolmarko@117
|
562 |
typedef SourceHook::CVector<void*> OrigFuncs; |
|
pavolmarko@117
|
563 |
typedef SourceHook::THash<int, OrigFuncs> OrigVTables; |
|
pavolmarko@117
|
564 |
|
|
pavolmarko@117
|
565 |
void *m_Ptr; //!< Pointer to the actual object |
|
pavolmarko@117
|
566 |
size_t m_ObjSize; //!< Size of the instance |
|
pavolmarko@117
|
567 |
OrigVTables m_VT; //!< Info about vtables & functions |
|
pavolmarko@117
|
568 |
|
|
pavolmarko@117
|
569 |
int m_RefCounter; |
|
pavolmarko@117
|
570 |
|
|
pavolmarko@117
|
571 |
CCallClassImpl(void *ptr, size_t size); |
|
pavolmarko@117
|
572 |
virtual ~CCallClassImpl(); |
|
pavolmarko@117
|
573 |
|
|
pavolmarko@41
|
574 |
bool operator==(void *other) |
|
pavolmarko@41
|
575 |
{ |
|
pavolmarko@117
|
576 |
return m_Ptr == other; |
|
pavolmarko@41
|
577 |
} |
|
pavolmarko@117
|
578 |
|
|
pavolmarko@117
|
579 |
void *GetThisPtr(); |
|
pavolmarko@117
|
580 |
void *GetOrigFunc(int vtbloffs, int vtblidx); |
|
pavolmarko@117
|
581 |
|
|
pavolmarko@117
|
582 |
void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry); |
|
pavolmarko@117
|
583 |
void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx); |
|
pavolmarko@41
|
584 |
}; |
|
pavolmarko@117
|
585 |
|
|
pavolmarko@1
|
586 |
/** |
|
pavolmarko@41
|
587 |
* @brief A list of CallClass structures |
|
pavolmarko@1
|
588 |
*/ |
|
pavolmarko@117
|
589 |
typedef List<CCallClassImpl> Impl_CallClassList; |
|
pavolmarko@1
|
590 |
|
|
pavolmarko@1
|
591 |
Impl_CallClassList m_CallClasses; //!< A list of already generated callclasses |
|
pavolmarko@163
|
592 |
|
|
pavolmarko@163
|
593 |
/** |
|
pavolmarko@163
|
594 |
* @brief A list of CHookManagerContainers |
|
pavolmarko@163
|
595 |
*/ |
|
pavolmarko@163
|
596 |
typedef List<CHookManagerContainer> HookManContList; |
|
pavolmarko@163
|
597 |
|
|
pavolmarko@163
|
598 |
HookManContList m_HookMans; //!< A list of hook managers |
|
pavolmarko@1
|
599 |
|
|
pavolmarko@128
|
600 |
struct HookLoopInfo |
|
pavolmarko@128
|
601 |
{ |
|
pavolmarko@179
|
602 |
enum RecallType |
|
pavolmarko@179
|
603 |
{ |
|
pavolmarko@179
|
604 |
Recall_No=0, |
|
pavolmarko@179
|
605 |
Recall_Pre, |
|
pavolmarko@179
|
606 |
Recall_Post1, |
|
pavolmarko@179
|
607 |
Recall_Post2 |
|
pavolmarko@179
|
608 |
}; |
|
pavolmarko@179
|
609 |
|
|
pavolmarko@128
|
610 |
META_RES *pStatus; |
|
pavolmarko@128
|
611 |
META_RES *pPrevRes; |
|
pavolmarko@128
|
612 |
META_RES *pCurRes; |
|
pavolmarko@128
|
613 |
|
|
pavolmarko@179
|
614 |
META_RES temporaryStatus; //!< Stored during Post1 recall phase |
|
pavolmarko@128
|
615 |
bool shouldContinue; |
|
pavolmarko@179
|
616 |
RecallType recall; //!< Specifies which kind of recall we're in. |
|
pavolmarko@128
|
617 |
|
|
pavolmarko@128
|
618 |
IIface *pCurIface; |
|
pavolmarko@128
|
619 |
const void *pOrigRet; |
|
pavolmarko@162
|
620 |
void *pOverrideRet; |
|
pavolmarko@128
|
621 |
void **pIfacePtrPtr; |
|
pavolmarko@128
|
622 |
}; |
|
pavolmarko@128
|
623 |
typedef CStack<HookLoopInfo> HookLoopInfoStack; |
|
pavolmarko@128
|
624 |
|
|
pavolmarko@117
|
625 |
void ApplyCallClassPatches(CCallClassImpl &cc); |
|
pavolmarko@58
|
626 |
void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry); |
|
pavolmarko@58
|
627 |
void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx); |
|
pavolmarko@1
|
628 |
|
|
pavolmarko@117
|
629 |
void SetPluginPaused(Plugin plug, bool paused); |
|
pavolmarko@117
|
630 |
|
|
pavolmarko@128
|
631 |
HookLoopInfoStack m_HLIStack; |
|
pavolmarko@324
|
632 |
CHookIDManager m_HookIDMan; |
|
pavolmarko@328
|
633 |
|
|
pavolmarko@328
|
634 |
void *m_OneIgnore; //:TODO: |
|
pavolmarko@328
|
635 |
bool m_IgnoreActive; |
|
pavolmarko@1
|
636 |
public: |
|
pavolmarko@1
|
637 |
CSourceHookImpl(); |
|
pavolmarko@117
|
638 |
virtual ~CSourceHookImpl(); |
|
pavolmarko@1
|
639 |
|
|
pavolmarko@1
|
640 |
/** |
|
pavolmarko@58
|
641 |
* @brief Returns the interface version |
|
pavolmarko@58
|
642 |
*/ |
|
pavolmarko@58
|
643 |
int GetIfaceVersion(); |
|
pavolmarko@58
|
644 |
|
|
pavolmarko@58
|
645 |
/** |
|
pavolmarko@58
|
646 |
* @brief Returns the implemnetation version |
|
pavolmarko@58
|
647 |
*/ |
|
pavolmarko@58
|
648 |
int GetImplVersion(); |
|
pavolmarko@58
|
649 |
|
|
pavolmarko@58
|
650 |
/** |
|
pavolmarko@6
|
651 |
* @brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers |
|
pavolmarko@1
|
652 |
*/ |
|
pavolmarko@1
|
653 |
void UnloadPlugin(Plugin plug); |
|
pavolmarko@1
|
654 |
|
|
pavolmarko@1
|
655 |
/** |
|
pavolmarko@6
|
656 |
* @brief Shut down the whole system, unregister all hook managers |
|
pavolmarko@1
|
657 |
*/ |
|
pavolmarko@1
|
658 |
void CompleteShutdown(); |
|
pavolmarko@1
|
659 |
|
|
pavolmarko@1
|
660 |
/** |
|
pavolmarko@1
|
661 |
* @brief Add a hook. |
|
pavolmarko@1
|
662 |
* |
|
pavolmarko@1
|
663 |
* @return True if the function succeeded, false otherwise |
|
pavolmarko@1
|
664 |
* |
|
pavolmarko@1
|
665 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@1
|
666 |
* @param iface The interface pointer |
|
pavolmarko@6
|
667 |
* @param ifacesize The size of the class iface points to |
|
pavolmarko@6
|
668 |
* @param myHookMan A hook manager function that should be capable of handling the function |
|
pavolmarko@1
|
669 |
* @param handler A pointer to a FastDelegate containing the hook handler |
|
pavolmarko@1
|
670 |
* @param post Set to true if you want a post handler |
|
pavolmarko@1
|
671 |
*/ |
|
pavolmarko@41
|
672 |
bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post); |
|
pavolmarko@1
|
673 |
|
|
pavolmarko@1
|
674 |
/** |
|
pavolmarko@1
|
675 |
* @brief Removes a hook. |
|
pavolmarko@1
|
676 |
* |
|
pavolmarko@1
|
677 |
* @return True if the function succeeded, false otherwise |
|
pavolmarko@1
|
678 |
* |
|
pavolmarko@1
|
679 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@1
|
680 |
* @param iface The interface pointer |
|
pavolmarko@41
|
681 |
* @param thisptr_offs This pointer adjuster |
|
pavolmarko@41
|
682 |
* @param myHookMan A hook manager function that should be capable of handling the function |
|
pavolmarko@41
|
683 |
* @param handler A pointer to a FastDelegate containing the hook handler |
|
pavolmarko@41
|
684 |
* @param post Set to true if you want a post handler |
|
pavolmarko@41
|
685 |
*/ |
|
pavolmarko@41
|
686 |
bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post); |
|
pavolmarko@41
|
687 |
|
|
pavolmarko@41
|
688 |
/** |
|
pavolmarko@41
|
689 |
* @brief Removes a hook. |
|
pavolmarko@41
|
690 |
* |
|
pavolmarko@41
|
691 |
* @ return True if the function succeeded, false otherwise |
|
pavolmarko@41
|
692 |
* |
|
pavolmarko@41
|
693 |
* @param info A RemoveHookInfo structure, describing the hook |
|
pavolmarko@41
|
694 |
*/ |
|
pavolmarko@41
|
695 |
bool RemoveHook(RemoveHookInfo info); |
|
pavolmarko@41
|
696 |
|
|
pavolmarko@41
|
697 |
/** |
|
pavolmarko@6
|
698 |
* @brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins |
|
pavolmarko@1
|
699 |
* |
|
pavolmarko@1
|
700 |
* @param plug The unique identifier of the plugin in question |
|
pavolmarko@1
|
701 |
*/ |
|
pavolmarko@1
|
702 |
bool IsPluginInUse(Plugin plug); |
|
pavolmarko@1
|
703 |
|
|
pavolmarko@1
|
704 |
/** |
|
pavolmarko@8
|
705 |
* @brief Pauses all hooks of a plugin |
|
pavolmarko@8
|
706 |
* |
|
pavolmarko@8
|
707 |
* @param plug The unique identifier of the plugin |
|
pavolmarko@8
|
708 |
*/ |
|
pavolmarko@8
|
709 |
void PausePlugin(Plugin plug); |
|
pavolmarko@8
|
710 |
|
|
pavolmarko@8
|
711 |
/** |
|
pavolmarko@8
|
712 |
* @brief Unpauses all hooks of a plugin |
|
pavolmarko@8
|
713 |
* |
|
pavolmarko@8
|
714 |
* @param plug The unique identifier of the plugin |
|
pavolmarko@8
|
715 |
*/ |
|
pavolmarko@8
|
716 |
void UnpausePlugin(Plugin plug); |
|
pavolmarko@8
|
717 |
|
|
pavolmarko@8
|
718 |
/** |
|
pavolmarko@1
|
719 |
* @brief Return a pointer to a callclass. Generate a new one if required. |
|
pavolmarko@1
|
720 |
* |
|
pavolmarko@1
|
721 |
* @param iface The interface pointer |
|
pavolmarko@58
|
722 |
* @param size Size of the class instance |
|
pavolmarko@1
|
723 |
*/ |
|
pavolmarko@58
|
724 |
GenericCallClass *GetCallClass(void *iface, size_t size); |
|
pavolmarko@1
|
725 |
|
|
pavolmarko@1
|
726 |
/** |
|
pavolmarko@1
|
727 |
* @brief Release a callclass |
|
pavolmarko@1
|
728 |
* |
|
pavolmarko@1
|
729 |
* @param ptr Pointer to the callclass |
|
pavolmarko@1
|
730 |
*/ |
|
pavolmarko@41
|
731 |
virtual void ReleaseCallClass(GenericCallClass *ptr); |
|
pavolmarko@1
|
732 |
|
|
pavolmarko@1
|
733 |
virtual void SetRes(META_RES res); //!< Sets the meta result |
|
pavolmarko@1
|
734 |
virtual META_RES GetPrevRes(); //!< Gets the meta result of the previously called handler |
|
pavolmarko@1
|
735 |
virtual META_RES GetStatus(); //!< Gets the highest meta result |
|
pavolmarko@1
|
736 |
virtual const void *GetOrigRet(); //!< Gets the original result. If not in post function, undefined |
|
pavolmarko@1
|
737 |
virtual const void *GetOverrideRet(); //!< Gets the override result. If none is specified, NULL |
|
pavolmarko@1
|
738 |
virtual void *GetIfacePtr(); //!< Gets the interface pointer |
|
pavolmarko@1
|
739 |
|
|
pavolmarko@1
|
740 |
////////////////////////////////////////////////////////////////////////// |
|
pavolmarko@6
|
741 |
// For hook managers |
|
pavolmarko@128
|
742 |
void HookLoopBegin(IIface *pIface); //!< Should be called when a hook loop begins |
|
pavolmarko@128
|
743 |
void HookLoopEnd(); //!< Should be called when a hook loop exits |
|
pavolmarko@128
|
744 |
void SetCurResPtr(META_RES *mres); //!< Sets pointer to the current meta result |
|
pavolmarko@128
|
745 |
void SetPrevResPtr(META_RES *mres); //!< Sets pointer to previous meta result |
|
pavolmarko@128
|
746 |
void SetStatusPtr(META_RES *mres); //!< Sets pointer to the status variable |
|
pavolmarko@128
|
747 |
void SetIfacePtrPtr(void **pp); //!< Sets pointer to the interface this pointer |
|
pavolmarko@128
|
748 |
void SetOrigRetPtr(const void *ptr); //!< Sets the original return pointer |
|
pavolmarko@162
|
749 |
void SetOverrideRetPtr(void *ptr); //!< Sets the override result pointer |
|
pavolmarko@128
|
750 |
bool ShouldContinue(); //!< Returns false if the hook loop should exit |
|
pavolmarko@157
|
751 |
|
|
pavolmarko@157
|
752 |
/** |
|
pavolmarko@157
|
753 |
* @brief Remove a hook manager. Auto-removes all hooks attached to it from plugin plug. |
|
pavolmarko@157
|
754 |
* |
|
pavolmarko@157
|
755 |
* @param plug The owner of the hook manager |
|
pavolmarko@157
|
756 |
* @param pubFunc The hook manager's info function |
|
pavolmarko@157
|
757 |
*/ |
|
pavolmarko@157
|
758 |
virtual void RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc); |
|
pavolmarko@163
|
759 |
virtual void RemoveHookManager(RemoveHookManInfo info); |
|
pavolmarko@163
|
760 |
|
|
pavolmarko@162
|
761 |
virtual void DoRecall(); //!< Initiates a recall sequence |
|
pavolmarko@162
|
762 |
virtual void *GetOverrideRetPtr(); //!< Returns the pointer set by SetOverrideRetPtr |
|
pavolmarko@162
|
763 |
|
|
pavolmarko@162
|
764 |
virtual void *SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr, |
|
pavolmarko@162
|
765 |
void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr); |
|
pavolmarko@324
|
766 |
|
|
pavolmarko@324
|
767 |
/** |
|
pavolmarko@324
|
768 |
* @brief Add a (VP) hook. |
|
pavolmarko@324
|
769 |
* |
|
pavolmarko@324
|
770 |
* @return non-zero hook id on success, 0 otherwise |
|
pavolmarko@324
|
771 |
* |
|
pavolmarko@324
|
772 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@324
|
773 |
* @param mode Can be either Hook_Normal or Hook_VP (vtable-wide hook) |
|
pavolmarko@324
|
774 |
* @param iface The interface pointer |
|
pavolmarko@328
|
775 |
* The representative interface pointer for VP hooks |
|
pavolmarko@328
|
776 |
* The vtable pointer for direct VP hooks !!! |
|
pavolmarko@324
|
777 |
* @param ifacesize The size of the class iface points to |
|
pavolmarko@324
|
778 |
* @param myHookMan A hook manager function that should be capable of handling the function |
|
pavolmarko@324
|
779 |
* @param handler A pointer to a FastDelegate containing the hook handler |
|
pavolmarko@324
|
780 |
* @param post Set to true if you want a post handler |
|
pavolmarko@324
|
781 |
*/ |
|
pavolmarko@324
|
782 |
virtual int AddHookNew(Plugin plug, AddHookMode mode, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, |
|
pavolmarko@324
|
783 |
ISHDelegate *handler, bool post); |
|
pavolmarko@324
|
784 |
|
|
pavolmarko@324
|
785 |
/** |
|
pavolmarko@324
|
786 |
* @brief Remove a VP hook by ID. |
|
pavolmarko@324
|
787 |
* |
|
pavolmarko@324
|
788 |
* @return true on success, false otherwise |
|
pavolmarko@324
|
789 |
* |
|
pavolmarko@324
|
790 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@324
|
791 |
* @param hookid The hook id (returned by AddHookNew) |
|
pavolmarko@324
|
792 |
*/ |
|
pavolmarko@324
|
793 |
virtual bool RemoveHookByID(Plugin plug, int hookid); |
|
pavolmarko@328
|
794 |
|
|
pavolmarko@328
|
795 |
/** |
|
pavolmarko@328
|
796 |
* @brief Makes sure that hooks are going to be ignored on the next call of vfnptr |
|
pavolmarko@328
|
797 |
* |
|
pavolmarko@328
|
798 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@328
|
799 |
* @param vfnptr The virtual function pointer of the function in question |
|
pavolmarko@328
|
800 |
*/ |
|
pavolmarko@328
|
801 |
virtual void SetIgnoreHooks(Plugin plug, void *vfnptr); |
|
pavolmarko@328
|
802 |
|
|
pavolmarko@328
|
803 |
/** |
|
pavolmarko@328
|
804 |
* @brief Reverses SetIgnoreHooks' effect |
|
pavolmarko@328
|
805 |
* |
|
pavolmarko@328
|
806 |
* @param plug The unique identifier of the plugin that calls this function |
|
pavolmarko@328
|
807 |
* @param vfnptr The virtual function pointer of the function in question |
|
pavolmarko@328
|
808 |
*/ |
|
pavolmarko@328
|
809 |
virtual void ResetIgnoreHooks(Plugin plug, void *vfnptr); |
|
pavolmarko@1
|
810 |
}; |
|
pavolmarko@1
|
811 |
} |
|
pavolmarko@1
|
812 |
|
|
dvander@34
|
813 |
#endif |