sourcehook/test/testmanual.cpp
branchsourcemm-1.6.0
changeset 347 e82968c21606
child 361 f34718303c8f
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/sourcehook/test/testmanual.cpp	Tue Sep 18 20:03:47 2007 +0000
     1.3 @@ -0,0 +1,355 @@
     1.4 +#include <string>
     1.5 +#include "sourcehook.h"
     1.6 +#include "sourcehook_test.h"
     1.7 +#include "testevents.h"
     1.8 +
     1.9 +// TESTMANUAL
    1.10 +// Test manual hooks
    1.11 +// :TODO: test more extensively
    1.12 +
    1.13 +namespace
    1.14 +{
    1.15 +	StateList g_States;
    1.16 +	SourceHook::ISourceHook *g_SHPtr;
    1.17 +	SourceHook::Plugin g_PLID;
    1.18 +
    1.19 +	MAKE_STATE_1(State_Func1_Called, void*);				// param1: This pointer
    1.20 +	MAKE_STATE_2(State_Func2_Called, void*, int);			// param1: This pointer; param2: parameter
    1.21 +	MAKE_STATE_1(State_Func3_Called, void*);				// param1: This pointer
    1.22 +	MAKE_STATE_2(State_Func4_Called, void*, int);			// param1: This pointer; param2: parameter
    1.23 +	MAKE_STATE_1(State_Func5_Called, void*);				// param1: This pointer
    1.24 +
    1.25 +	MAKE_STATE_1(State_Func1H_Called, void*);
    1.26 +	MAKE_STATE_2(State_Func2H_Called, void*, int);
    1.27 +	MAKE_STATE_1(State_Func3H_Called, void*);
    1.28 +	MAKE_STATE_2(State_Func4H_Called, void*, int);
    1.29 +
    1.30 +	MAKE_STATE_1(State_Return, short);
    1.31 +
    1.32 +	class TheWall
    1.33 +	{
    1.34 +	public:
    1.35 +		virtual void Func1()
    1.36 +		{
    1.37 +			ADD_STATE(State_Func1_Called(reinterpret_cast<void*>(this)));
    1.38 +		}
    1.39 +		virtual void Func2(int x)
    1.40 +		{
    1.41 +			ADD_STATE(State_Func2_Called(reinterpret_cast<void*>(this), x));
    1.42 +		}
    1.43 +
    1.44 +		virtual short Func3()
    1.45 +		{
    1.46 +			ADD_STATE(State_Func3_Called(reinterpret_cast<void*>(this)));
    1.47 +			return 3;
    1.48 +		}
    1.49 +		virtual short Func4(int x)
    1.50 +		{
    1.51 +			ADD_STATE(State_Func4_Called(reinterpret_cast<void*>(this), x));
    1.52 +			return 4;
    1.53 +		}
    1.54 +		virtual void Func5()
    1.55 +		{
    1.56 +			ADD_STATE(State_Func5_Called(reinterpret_cast<void*>(this)));
    1.57 +		}
    1.58 +	};
    1.59 +
    1.60 +	SH_DECL_HOOK0_void(TheWall, Func1, SH_NOATTRIB, 0);
    1.61 +	SH_DECL_HOOK1_void(TheWall, Func2, SH_NOATTRIB, 0, int);
    1.62 +	SH_DECL_HOOK0(TheWall, Func3, SH_NOATTRIB, 0, short);
    1.63 +	SH_DECL_HOOK1(TheWall, Func4, SH_NOATTRIB, 0, short, int);
    1.64 +
    1.65 +	SH_DECL_MANUALHOOK0_void(TheWall_Func1, 0, 0, 0);
    1.66 +	SH_DECL_MANUALHOOK1_void(TheWall_Func2, 1, 0, 0, int);
    1.67 +	SH_DECL_MANUALHOOK0(TheWall_Func3, 2, 0, 0, short);
    1.68 +	SH_DECL_MANUALHOOK1(TheWall_Func4, 3, 0, 0, short, int);
    1.69 +
    1.70 +	typedef void (SourceHook::EmptyClass::*MFP_Func1)();
    1.71 +	typedef void (SourceHook::EmptyClass::*MFP_Func2)(int);
    1.72 +	typedef short (SourceHook::EmptyClass::*MFP_Func3)();
    1.73 +	typedef short (SourceHook::EmptyClass::*MFP_Func4)(int);
    1.74 +
    1.75 +	void Handler_Func1()
    1.76 +	{
    1.77 +		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    1.78 +	}
    1.79 +	void Handler_Func2(int x)
    1.80 +	{
    1.81 +		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
    1.82 +		RETURN_META_MNEWPARAMS(MRES_IGNORED, TheWall_Func2, (0x87654321));
    1.83 +	}
    1.84 +	short Handler_Func3()
    1.85 +	{
    1.86 +		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
    1.87 +		return 0;
    1.88 +	}
    1.89 +	short Handler_Func4(int x)
    1.90 +	{
    1.91 +		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
    1.92 +
    1.93 +		// newparams (recall) using the manual hook declaration!
    1.94 +		RETURN_META_VALUE_MNEWPARAMS(MRES_IGNORED, 0, TheWall_Func4, (0x12345678));
    1.95 +	}
    1.96 +
    1.97 +	struct AnotherBrick
    1.98 +	{
    1.99 +		void Handler_Func1()
   1.100 +		{
   1.101 +			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
   1.102 +			RETURN_META(MRES_SUPERCEDE);
   1.103 +		}
   1.104 +	};
   1.105 +}
   1.106 +
   1.107 +bool TestManual(std::string &error)
   1.108 +{
   1.109 +	GET_SHPTR(g_SHPtr);
   1.110 +	g_PLID = 1337;
   1.111 +
   1.112 +	TheWall inst;
   1.113 +	TheWall *p = &inst;
   1.114 +
   1.115 +	SourceHook::ManualCallClass *cc = SH_GET_MCALLCLASS(p, sizeof(void*));
   1.116 +
   1.117 +	// 1)
   1.118 +	// Call each function
   1.119 +	p->Func1();
   1.120 +	p->Func2(200);
   1.121 +	ADD_STATE(State_Return(p->Func3()));
   1.122 +	ADD_STATE(State_Return(p->Func4(400)));
   1.123 +
   1.124 +	CHECK_STATES((&g_States,
   1.125 +		new State_Func1_Called(p),
   1.126 +		new State_Func2_Called(p, 200),
   1.127 +		new State_Func3_Called(p),
   1.128 +		new State_Return(3),
   1.129 +		new State_Func4_Called(p, 400),
   1.130 +		new State_Return(4),
   1.131 +		NULL), "Part 1");
   1.132 +
   1.133 +	// 1.1)
   1.134 +	// Now call each function through the manual call class, using the hook decl and manually
   1.135 +	SH_MCALL(cc, TheWall_Func1)();
   1.136 +	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   1.137 +	SH_MCALL(cc, TheWall_Func2)(200);
   1.138 +	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   1.139 +	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   1.140 +	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   1.141 +	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   1.142 +	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   1.143 +
   1.144 +	CHECK_STATES((&g_States,
   1.145 +		new State_Func1_Called(p),
   1.146 +		new State_Func1_Called(p),
   1.147 +		new State_Func2_Called(p, 200),
   1.148 +		new State_Func2_Called(p, 200),
   1.149 +		new State_Func3_Called(p),
   1.150 +		new State_Return(3),
   1.151 +		new State_Func3_Called(p),
   1.152 +		new State_Return(3),
   1.153 +		new State_Func4_Called(p, 400),
   1.154 +		new State_Return(4),
   1.155 +		new State_Func4_Called(p, 400),
   1.156 +		new State_Return(4),
   1.157 +		NULL), "Part 1.1");
   1.158 +
   1.159 +	// 2)
   1.160 +	// Hook each function normally, call them
   1.161 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.162 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.163 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.164 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.165 +
   1.166 +	p->Func1();
   1.167 +	p->Func2(200);
   1.168 +	ADD_STATE(State_Return(p->Func3()));
   1.169 +	ADD_STATE(State_Return(p->Func4(400)));
   1.170 +
   1.171 +	CHECK_STATES((&g_States,
   1.172 +		new State_Func1H_Called(p),
   1.173 +		new State_Func1_Called(p),
   1.174 +		new State_Func2H_Called(p, 200),
   1.175 +		new State_Func2_Called(p, 0x87654321),
   1.176 +		new State_Func3H_Called(p),
   1.177 +		new State_Func3_Called(p),
   1.178 +		new State_Return(3),
   1.179 +		new State_Func4H_Called(p, 400),
   1.180 +		new State_Func4_Called(p, 0x12345678),
   1.181 +		new State_Return(4),
   1.182 +		NULL), "Part 2");
   1.183 +
   1.184 +	// Call them through the mcallclass
   1.185 +	// 2.1)
   1.186 +	// Now call each function through the manual call class, using the hook decl and manually
   1.187 +	SH_MCALL(cc, TheWall_Func1)();
   1.188 +	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   1.189 +	SH_MCALL(cc, TheWall_Func2)(200);
   1.190 +	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   1.191 +	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   1.192 +	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   1.193 +	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   1.194 +	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   1.195 +
   1.196 +	CHECK_STATES((&g_States,
   1.197 +		new State_Func1_Called(p),
   1.198 +		new State_Func1_Called(p),
   1.199 +		new State_Func2_Called(p, 200),
   1.200 +		new State_Func2_Called(p, 200),
   1.201 +		new State_Func3_Called(p),
   1.202 +		new State_Return(3),
   1.203 +		new State_Func3_Called(p),
   1.204 +		new State_Return(3),
   1.205 +		new State_Func4_Called(p, 400),
   1.206 +		new State_Return(4),
   1.207 +		new State_Func4_Called(p, 400),
   1.208 +		new State_Return(4),
   1.209 +		NULL), "Part 2.1");
   1.210 +
   1.211 +	// Unhook them
   1.212 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.213 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.214 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.215 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.216 +
   1.217 +	// 3)
   1.218 +	// Hook each function manually, call them
   1.219 +
   1.220 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   1.221 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.222 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.223 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.224 +
   1.225 +	p->Func1();
   1.226 +	p->Func2(200);
   1.227 +	ADD_STATE(State_Return(p->Func3()));
   1.228 +	ADD_STATE(State_Return(p->Func4(400)));
   1.229 +
   1.230 +	CHECK_STATES((&g_States,
   1.231 +		new State_Func1H_Called(p),
   1.232 +		new State_Func1_Called(p),
   1.233 +		new State_Func2H_Called(p, 200),
   1.234 +		new State_Func2_Called(p, 0x87654321),
   1.235 +		new State_Func3H_Called(p),
   1.236 +		new State_Func3_Called(p),
   1.237 +		new State_Return(3),
   1.238 +		new State_Func4H_Called(p, 400),
   1.239 +		new State_Func4_Called(p, 0x12345678),
   1.240 +		new State_Return(4),
   1.241 +		NULL), "Part 3");
   1.242 +
   1.243 +	// Now through the mcallclass
   1.244 +
   1.245 +	// Call them through the mcallclass
   1.246 +	// 3.1)
   1.247 +	// Now call each function through the manual call class, using the hook decl and manually
   1.248 +	SH_MCALL(cc, TheWall_Func1)();
   1.249 +	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   1.250 +	SH_MCALL(cc, TheWall_Func2)(200);
   1.251 +	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   1.252 +	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   1.253 +	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   1.254 +	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   1.255 +	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   1.256 +
   1.257 +	CHECK_STATES((&g_States,
   1.258 +		new State_Func1_Called(p),
   1.259 +		new State_Func1_Called(p),
   1.260 +		new State_Func2_Called(p, 200),
   1.261 +		new State_Func2_Called(p, 200),
   1.262 +		new State_Func3_Called(p),
   1.263 +		new State_Return(3),
   1.264 +		new State_Func3_Called(p),
   1.265 +		new State_Return(3),
   1.266 +		new State_Func4_Called(p, 400),
   1.267 +		new State_Return(4),
   1.268 +		new State_Func4_Called(p, 400),
   1.269 +		new State_Return(4),
   1.270 +		NULL), "Part 3.1");
   1.271 +
   1.272 +	// Unhook them
   1.273 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   1.274 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.275 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.276 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.277 +
   1.278 +	// 4)
   1.279 +	// Hook each function manually, then normally, call, unhook
   1.280 +
   1.281 +	AnotherBrick handler_inst;
   1.282 +
   1.283 +	// Why this?
   1.284 +	// 1) tests sh_add_manualhook_memfunc
   1.285 +	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
   1.286 +	//    (because there are no attribs for manual hooks).
   1.287 +	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
   1.288 +	//    already was one for this vfnptr. This hook manager stored the pointer of the original
   1.289 +	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
   1.290 +	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
   1.291 +	//    does) will supercede the second hook func from being called - thus bypassing the call
   1.292 +	//    of the auto hook here.
   1.293 +	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   1.294 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.295 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.296 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.297 +
   1.298 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.299 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.300 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.301 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.302 +
   1.303 +	p->Func1();
   1.304 +	p->Func2(200);
   1.305 +	ADD_STATE(State_Return(p->Func3()));
   1.306 +	ADD_STATE(State_Return(p->Func4(400)));
   1.307 +
   1.308 +	CHECK_STATES((&g_States,
   1.309 +		new State_Func1H_Called(p),
   1.310 +		new State_Func1H_Called(p),
   1.311 +		//new State_Func1_Called(p),
   1.312 +		new State_Func2H_Called(p, 200),
   1.313 +		new State_Func2H_Called(p, 0x87654321),
   1.314 +		new State_Func2_Called(p, 0x87654321),
   1.315 +		new State_Func3H_Called(p),
   1.316 +		new State_Func3H_Called(p),
   1.317 +		new State_Func3_Called(p),
   1.318 +		new State_Return(3),
   1.319 +		new State_Func4H_Called(p, 400),
   1.320 +		new State_Func4H_Called(p, 0x12345678),
   1.321 +		new State_Func4_Called(p, 0x12345678),
   1.322 +		new State_Return(4),
   1.323 +		NULL), "Part 4");
   1.324 +
   1.325 +	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   1.326 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.327 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.328 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.329 +
   1.330 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.331 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.332 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.333 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.334 +
   1.335 +	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
   1.336 +	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
   1.337 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   1.338 +
   1.339 +	p->Func5();
   1.340 +
   1.341 +	CHECK_STATES((&g_States,
   1.342 +		new State_Func1H_Called(p),
   1.343 +		new State_Func5_Called(p),
   1.344 +		NULL), "Part 5");
   1.345 +
   1.346 +	// 6) Test auto-remove on reconfig
   1.347 +	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
   1.348 +
   1.349 +	p->Func1();
   1.350 +	p->Func5();
   1.351 +	
   1.352 +	CHECK_STATES((&g_States,
   1.353 +		new State_Func1_Called(p),
   1.354 +		new State_Func5_Called(p),
   1.355 +		NULL), "Part 6");
   1.356 +
   1.357 +	return true;
   1.358 +}