sourcehook/test/testmanual.cpp
changeset 158 bf2e51526a0e
child 162 a95db73792e5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/sourcehook/test/testmanual.cpp	Sat Dec 10 22:43:51 2005 +0000
     1.3 @@ -0,0 +1,262 @@
     1.4 +#include <string>
     1.5 +#include "sourcehook_impl.h"
     1.6 +#include "testevents.h"
     1.7 +
     1.8 +// TESTMANUAL
     1.9 +// Test manual hooks
    1.10 +// :TODO: test more extensively
    1.11 +
    1.12 +namespace
    1.13 +{
    1.14 +	StateList g_States;
    1.15 +	SourceHook::ISourceHook *g_SHPtr;
    1.16 +	SourceHook::Plugin g_PLID;
    1.17 +
    1.18 +	MAKE_STATE_1(State_Func1_Called, void*);				// param1: This pointer
    1.19 +	MAKE_STATE_2(State_Func2_Called, void*, int);			// param1: This pointer; param2: parameter
    1.20 +	MAKE_STATE_1(State_Func3_Called, void*);				// param1: This pointer
    1.21 +	MAKE_STATE_2(State_Func4_Called, void*, int);			// param1: This pointer; param2: parameter
    1.22 +	MAKE_STATE_1(State_Func5_Called, void*);				// param1: This pointer
    1.23 +
    1.24 +	MAKE_STATE_1(State_Func1H_Called, void*);
    1.25 +	MAKE_STATE_2(State_Func2H_Called, void*, int);
    1.26 +	MAKE_STATE_1(State_Func3H_Called, void*);
    1.27 +	MAKE_STATE_2(State_Func4H_Called, void*, int);
    1.28 +
    1.29 +	MAKE_STATE_1(State_Return, short);
    1.30 +
    1.31 +	class TheWall
    1.32 +	{
    1.33 +	public:
    1.34 +		virtual void Func1()
    1.35 +		{
    1.36 +			ADD_STATE(State_Func1_Called(reinterpret_cast<void*>(this)));
    1.37 +		}
    1.38 +		virtual void Func2(int x)
    1.39 +		{
    1.40 +			ADD_STATE(State_Func2_Called(reinterpret_cast<void*>(this), x));
    1.41 +		}
    1.42 +
    1.43 +		virtual short Func3()
    1.44 +		{
    1.45 +			ADD_STATE(State_Func3_Called(reinterpret_cast<void*>(this)));
    1.46 +			return 3;
    1.47 +		}
    1.48 +		virtual short Func4(int x)
    1.49 +		{
    1.50 +			ADD_STATE(State_Func4_Called(reinterpret_cast<void*>(this), x));
    1.51 +			return 4;
    1.52 +		}
    1.53 +		virtual void Func5()
    1.54 +		{
    1.55 +			ADD_STATE(State_Func5_Called(reinterpret_cast<void*>(this)));
    1.56 +		}
    1.57 +	};
    1.58 +
    1.59 +	SH_DECL_HOOK0_void(TheWall, Func1, SH_NOATTRIB, 0);
    1.60 +	SH_DECL_HOOK1_void(TheWall, Func2, SH_NOATTRIB, 0, int);
    1.61 +	SH_DECL_HOOK0(TheWall, Func3, SH_NOATTRIB, 0, short);
    1.62 +	SH_DECL_HOOK1(TheWall, Func4, SH_NOATTRIB, 0, short, int);
    1.63 +
    1.64 +	SH_DECL_MANUALHOOK0_void(TheWall_Func1, 0, 0, 0);
    1.65 +	SH_DECL_MANUALHOOK1_void(TheWall_Func2, 1, 0, 0, int);
    1.66 +	SH_DECL_MANUALHOOK0(TheWall_Func3, 2, 0, 0, short);
    1.67 +	SH_DECL_MANUALHOOK1(TheWall_Func4, 3, 0, 0, short, int);
    1.68 +
    1.69 +	void Handler_Func1()
    1.70 +	{
    1.71 +		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    1.72 +	}
    1.73 +	void Handler_Func2(int x)
    1.74 +	{
    1.75 +		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
    1.76 +	}
    1.77 +	short Handler_Func3()
    1.78 +	{
    1.79 +		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
    1.80 +		return 0;
    1.81 +	}
    1.82 +	short Handler_Func4(int x)
    1.83 +	{
    1.84 +		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
    1.85 +		return 0;
    1.86 +	}
    1.87 +
    1.88 +	struct AnotherBrick
    1.89 +	{
    1.90 +		void Handler_Func1()
    1.91 +		{
    1.92 +			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    1.93 +			RETURN_META(MRES_SUPERCEDE);
    1.94 +		}
    1.95 +	};
    1.96 +}
    1.97 +
    1.98 +bool TestManual(std::string &error)
    1.99 +{
   1.100 +	SourceHook::CSourceHookImpl g_SHImpl;
   1.101 +	g_SHPtr = &g_SHImpl;
   1.102 +	g_PLID = 1337;
   1.103 +
   1.104 +	TheWall inst;
   1.105 +	TheWall *p = &inst;
   1.106 +
   1.107 +	// 1)
   1.108 +	// Call each function
   1.109 +	p->Func1();
   1.110 +	p->Func2(200);
   1.111 +	ADD_STATE(State_Return(p->Func3()));
   1.112 +	ADD_STATE(State_Return(p->Func4(400)));
   1.113 +
   1.114 +	CHECK_STATES((&g_States,
   1.115 +		new State_Func1_Called(p),
   1.116 +		new State_Func2_Called(p, 200),
   1.117 +		new State_Func3_Called(p),
   1.118 +		new State_Return(3),
   1.119 +		new State_Func4_Called(p, 400),
   1.120 +		new State_Return(4),
   1.121 +		NULL), "Part 1");
   1.122 +
   1.123 +	// 2)
   1.124 +	// Hook each function normally, call them, unhook them
   1.125 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.126 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.127 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.128 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.129 +
   1.130 +	p->Func1();
   1.131 +	p->Func2(200);
   1.132 +	ADD_STATE(State_Return(p->Func3()));
   1.133 +	ADD_STATE(State_Return(p->Func4(400)));
   1.134 +
   1.135 +	CHECK_STATES((&g_States,
   1.136 +		new State_Func1H_Called(p),
   1.137 +		new State_Func1_Called(p),
   1.138 +		new State_Func2H_Called(p, 200),
   1.139 +		new State_Func2_Called(p, 200),
   1.140 +		new State_Func3H_Called(p),
   1.141 +		new State_Func3_Called(p),
   1.142 +		new State_Return(3),
   1.143 +		new State_Func4H_Called(p, 400),
   1.144 +		new State_Func4_Called(p, 400),
   1.145 +		new State_Return(4),
   1.146 +		NULL), "Part 2");
   1.147 +
   1.148 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.149 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.150 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.151 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.152 +
   1.153 +	// 3)
   1.154 +	// Hook each function manually, call them, unhook them
   1.155 +
   1.156 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   1.157 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.158 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.159 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.160 +
   1.161 +	p->Func1();
   1.162 +	p->Func2(200);
   1.163 +	ADD_STATE(State_Return(p->Func3()));
   1.164 +	ADD_STATE(State_Return(p->Func4(400)));
   1.165 +
   1.166 +	CHECK_STATES((&g_States,
   1.167 +		new State_Func1H_Called(p),
   1.168 +		new State_Func1_Called(p),
   1.169 +		new State_Func2H_Called(p, 200),
   1.170 +		new State_Func2_Called(p, 200),
   1.171 +		new State_Func3H_Called(p),
   1.172 +		new State_Func3_Called(p),
   1.173 +		new State_Return(3),
   1.174 +		new State_Func4H_Called(p, 400),
   1.175 +		new State_Func4_Called(p, 400),
   1.176 +		new State_Return(4),
   1.177 +		NULL), "Part 3");
   1.178 +
   1.179 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   1.180 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.181 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.182 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.183 +
   1.184 +	// 4)
   1.185 +	// Hook each function manually, then normally, call, unhook
   1.186 +
   1.187 +	AnotherBrick handler_inst;
   1.188 +
   1.189 +	// Why this?
   1.190 +	// 1) tests sh_add_manualhook_memfunc
   1.191 +	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
   1.192 +	//    (because there are no attribs for manual hooks).
   1.193 +	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
   1.194 +	//    already was one for this vfnptr. This hook manager stored the pointer of the original
   1.195 +	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
   1.196 +	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
   1.197 +	//    does) will supercede the second hook func from being called - thus bypassing the call
   1.198 +	//    of the auto hook here.
   1.199 +	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   1.200 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.201 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.202 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.203 +
   1.204 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.205 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.206 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.207 +	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.208 +
   1.209 +	p->Func1();
   1.210 +	p->Func2(200);
   1.211 +	ADD_STATE(State_Return(p->Func3()));
   1.212 +	ADD_STATE(State_Return(p->Func4(400)));
   1.213 +
   1.214 +	CHECK_STATES((&g_States,
   1.215 +		new State_Func1H_Called(p),
   1.216 +		new State_Func1H_Called(p),
   1.217 +		//new State_Func1_Called(p),
   1.218 +		new State_Func2H_Called(p, 200),
   1.219 +		new State_Func2H_Called(p, 200),
   1.220 +		new State_Func2_Called(p, 200),
   1.221 +		new State_Func3H_Called(p),
   1.222 +		new State_Func3H_Called(p),
   1.223 +		new State_Func3_Called(p),
   1.224 +		new State_Return(3),
   1.225 +		new State_Func4H_Called(p, 400),
   1.226 +		new State_Func4H_Called(p, 400),
   1.227 +		new State_Func4_Called(p, 400),
   1.228 +		new State_Return(4),
   1.229 +		NULL), "Part 4");
   1.230 +
   1.231 +	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   1.232 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   1.233 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   1.234 +	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   1.235 +
   1.236 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   1.237 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   1.238 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   1.239 +	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   1.240 +
   1.241 +	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
   1.242 +	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
   1.243 +	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   1.244 +
   1.245 +	p->Func5();
   1.246 +
   1.247 +	CHECK_STATES((&g_States,
   1.248 +		new State_Func1H_Called(p),
   1.249 +		new State_Func5_Called(p),
   1.250 +		NULL), "Part 5");
   1.251 +
   1.252 +	// 6) Test auto-remove on reconfig
   1.253 +	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
   1.254 +
   1.255 +	p->Func1();
   1.256 +	p->Func5();
   1.257 +	
   1.258 +	CHECK_STATES((&g_States,
   1.259 +		new State_Func1_Called(p),
   1.260 +		new State_Func5_Called(p),
   1.261 +		NULL), "Part 6");
   1.262 +
   1.263 +	return true;
   1.264 +}
   1.265 +