sourcehook/test/testmanual.cpp
author Pavol Marko <pavolmarko@gmail.com>
Sun May 14 19:07:01 2006 +0000 (2006-05-14)
changeset 200 e1426a1a3fcd
parent 199 7a5b326bb7f8
child 211 af7f4f2148f5
permissions -rw-r--r--
Fixed linux/gcc/amd64
     1 #include <string>
     2 #include "sourcehook.h"
     3 #include "sourcehook_test.h"
     4 #include "testevents.h"
     5 
     6 // TESTMANUAL
     7 // Test manual hooks
     8 // :TODO: test more extensively
     9 
    10 namespace
    11 {
    12 	StateList g_States;
    13 	SourceHook::ISourceHook *g_SHPtr;
    14 	SourceHook::Plugin g_PLID;
    15 
    16 	MAKE_STATE_1(State_Func1_Called, void*);				// param1: This pointer
    17 	MAKE_STATE_2(State_Func2_Called, void*, int);			// param1: This pointer; param2: parameter
    18 	MAKE_STATE_1(State_Func3_Called, void*);				// param1: This pointer
    19 	MAKE_STATE_2(State_Func4_Called, void*, int);			// param1: This pointer; param2: parameter
    20 	MAKE_STATE_1(State_Func5_Called, void*);				// param1: This pointer
    21 
    22 	MAKE_STATE_1(State_Func1H_Called, void*);
    23 	MAKE_STATE_2(State_Func2H_Called, void*, int);
    24 	MAKE_STATE_1(State_Func3H_Called, void*);
    25 	MAKE_STATE_2(State_Func4H_Called, void*, int);
    26 
    27 	MAKE_STATE_1(State_Return, short);
    28 
    29 	class TheWall
    30 	{
    31 	public:
    32 		virtual void Func1()
    33 		{
    34 			ADD_STATE(State_Func1_Called(reinterpret_cast<void*>(this)));
    35 		}
    36 		virtual void Func2(int x)
    37 		{
    38 			ADD_STATE(State_Func2_Called(reinterpret_cast<void*>(this), x));
    39 		}
    40 
    41 		virtual short Func3()
    42 		{
    43 			ADD_STATE(State_Func3_Called(reinterpret_cast<void*>(this)));
    44 			return 3;
    45 		}
    46 		virtual short Func4(int x)
    47 		{
    48 			ADD_STATE(State_Func4_Called(reinterpret_cast<void*>(this), x));
    49 			return 4;
    50 		}
    51 		virtual void Func5()
    52 		{
    53 			ADD_STATE(State_Func5_Called(reinterpret_cast<void*>(this)));
    54 		}
    55 	};
    56 
    57 	SH_DECL_HOOK0_void(TheWall, Func1, SH_NOATTRIB, 0);
    58 	SH_DECL_HOOK1_void(TheWall, Func2, SH_NOATTRIB, 0, int);
    59 	SH_DECL_HOOK0(TheWall, Func3, SH_NOATTRIB, 0, short);
    60 	SH_DECL_HOOK1(TheWall, Func4, SH_NOATTRIB, 0, short, int);
    61 
    62 	SH_DECL_MANUALHOOK0_void(TheWall_Func1, 0, 0, 0);
    63 	SH_DECL_MANUALHOOK1_void(TheWall_Func2, 1, 0, 0, int);
    64 	SH_DECL_MANUALHOOK0(TheWall_Func3, 2, 0, 0, short);
    65 	SH_DECL_MANUALHOOK1(TheWall_Func4, 3, 0, 0, short, int);
    66 
    67 	typedef void (SourceHook::EmptyClass::*MFP_Func1)();
    68 	typedef void (SourceHook::EmptyClass::*MFP_Func2)(int);
    69 	typedef short (SourceHook::EmptyClass::*MFP_Func3)();
    70 	typedef short (SourceHook::EmptyClass::*MFP_Func4)(int);
    71 
    72 	void Handler_Func1()
    73 	{
    74 		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    75 	}
    76 	void Handler_Func2(int x)
    77 	{
    78 		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
    79 	}
    80 	short Handler_Func3()
    81 	{
    82 		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
    83 		return 0;
    84 	}
    85 	short Handler_Func4(int x)
    86 	{
    87 		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
    88 		return 0;
    89 	}
    90 
    91 	struct AnotherBrick
    92 	{
    93 		void Handler_Func1()
    94 		{
    95 			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    96 			RETURN_META(MRES_SUPERCEDE);
    97 		}
    98 	};
    99 }
   100 
   101 bool TestManual(std::string &error)
   102 {
   103 	GET_SHPTR(g_SHPtr);
   104 	g_PLID = 1337;
   105 
   106 	TheWall inst;
   107 	TheWall *p = &inst;
   108 
   109 	SourceHook::ManualCallClass *cc = SH_GET_MCALLCLASS(p, sizeof(void*));
   110 
   111 	// 1)
   112 	// Call each function
   113 	p->Func1();
   114 	p->Func2(200);
   115 	ADD_STATE(State_Return(p->Func3()));
   116 	ADD_STATE(State_Return(p->Func4(400)));
   117 
   118 	CHECK_STATES((&g_States,
   119 		new State_Func1_Called(p),
   120 		new State_Func2_Called(p, 200),
   121 		new State_Func3_Called(p),
   122 		new State_Return(3),
   123 		new State_Func4_Called(p, 400),
   124 		new State_Return(4),
   125 		NULL), "Part 1");
   126 
   127 	// 1.1)
   128 	// Now call each function through the manual call class, using the hook decl and manually
   129 	SH_MCALL(cc, TheWall_Func1)();
   130 	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   131 	SH_MCALL(cc, TheWall_Func2)(200);
   132 	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   133 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   134 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   135 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   136 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   137 
   138 	CHECK_STATES((&g_States,
   139 		new State_Func1_Called(p),
   140 		new State_Func1_Called(p),
   141 		new State_Func2_Called(p, 200),
   142 		new State_Func2_Called(p, 200),
   143 		new State_Func3_Called(p),
   144 		new State_Return(3),
   145 		new State_Func3_Called(p),
   146 		new State_Return(3),
   147 		new State_Func4_Called(p, 400),
   148 		new State_Return(4),
   149 		new State_Func4_Called(p, 400),
   150 		new State_Return(4),
   151 		NULL), "Part 1.1");
   152 
   153 	// 2)
   154 	// Hook each function normally, call them
   155 	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   156 	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   157 	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   158 	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   159 
   160 	p->Func1();
   161 	p->Func2(200);
   162 	ADD_STATE(State_Return(p->Func3()));
   163 	ADD_STATE(State_Return(p->Func4(400)));
   164 
   165 	CHECK_STATES((&g_States,
   166 		new State_Func1H_Called(p),
   167 		new State_Func1_Called(p),
   168 		new State_Func2H_Called(p, 200),
   169 		new State_Func2_Called(p, 200),
   170 		new State_Func3H_Called(p),
   171 		new State_Func3_Called(p),
   172 		new State_Return(3),
   173 		new State_Func4H_Called(p, 400),
   174 		new State_Func4_Called(p, 400),
   175 		new State_Return(4),
   176 		NULL), "Part 2");
   177 
   178 	// Call them through the mcallclass
   179 	// 2.1)
   180 	// Now call each function through the manual call class, using the hook decl and manually
   181 	SH_MCALL(cc, TheWall_Func1)();
   182 	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   183 	SH_MCALL(cc, TheWall_Func2)(200);
   184 	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   185 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   186 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   187 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   188 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   189 
   190 	CHECK_STATES((&g_States,
   191 		new State_Func1_Called(p),
   192 		new State_Func1_Called(p),
   193 		new State_Func2_Called(p, 200),
   194 		new State_Func2_Called(p, 200),
   195 		new State_Func3_Called(p),
   196 		new State_Return(3),
   197 		new State_Func3_Called(p),
   198 		new State_Return(3),
   199 		new State_Func4_Called(p, 400),
   200 		new State_Return(4),
   201 		new State_Func4_Called(p, 400),
   202 		new State_Return(4),
   203 		NULL), "Part 2.1");
   204 
   205 	// Unhook them
   206 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   207 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   208 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   209 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   210 
   211 	// 3)
   212 	// Hook each function manually, call them
   213 
   214 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   215 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   216 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   217 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   218 
   219 	p->Func1();
   220 	p->Func2(200);
   221 	ADD_STATE(State_Return(p->Func3()));
   222 	ADD_STATE(State_Return(p->Func4(400)));
   223 
   224 	CHECK_STATES((&g_States,
   225 		new State_Func1H_Called(p),
   226 		new State_Func1_Called(p),
   227 		new State_Func2H_Called(p, 200),
   228 		new State_Func2_Called(p, 200),
   229 		new State_Func3H_Called(p),
   230 		new State_Func3_Called(p),
   231 		new State_Return(3),
   232 		new State_Func4H_Called(p, 400),
   233 		new State_Func4_Called(p, 400),
   234 		new State_Return(4),
   235 		NULL), "Part 3");
   236 
   237 	// Now through the mcallclass
   238 
   239 	// Call them through the mcallclass
   240 	// 3.1)
   241 	// Now call each function through the manual call class, using the hook decl and manually
   242 	SH_MCALL(cc, TheWall_Func1)();
   243 	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   244 	SH_MCALL(cc, TheWall_Func2)(200);
   245 	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   246 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   247 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   248 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   249 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   250 
   251 	CHECK_STATES((&g_States,
   252 		new State_Func1_Called(p),
   253 		new State_Func1_Called(p),
   254 		new State_Func2_Called(p, 200),
   255 		new State_Func2_Called(p, 200),
   256 		new State_Func3_Called(p),
   257 		new State_Return(3),
   258 		new State_Func3_Called(p),
   259 		new State_Return(3),
   260 		new State_Func4_Called(p, 400),
   261 		new State_Return(4),
   262 		new State_Func4_Called(p, 400),
   263 		new State_Return(4),
   264 		NULL), "Part 3.1");
   265 
   266 	// Unhook them
   267 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   268 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   269 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   270 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   271 
   272 	// 4)
   273 	// Hook each function manually, then normally, call, unhook
   274 
   275 	AnotherBrick handler_inst;
   276 
   277 	// Why this?
   278 	// 1) tests sh_add_manualhook_memfunc
   279 	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
   280 	//    (because there are no attribs for manual hooks).
   281 	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
   282 	//    already was one for this vfnptr. This hook manager stored the pointer of the original
   283 	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
   284 	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
   285 	//    does) will supercede the second hook func from being called - thus bypassing the call
   286 	//    of the auto hook here.
   287 	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   288 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   289 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   290 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   291 
   292 	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   293 	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   294 	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   295 	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   296 
   297 	p->Func1();
   298 	p->Func2(200);
   299 	ADD_STATE(State_Return(p->Func3()));
   300 	ADD_STATE(State_Return(p->Func4(400)));
   301 
   302 	CHECK_STATES((&g_States,
   303 		new State_Func1H_Called(p),
   304 		new State_Func1H_Called(p),
   305 		//new State_Func1_Called(p),
   306 		new State_Func2H_Called(p, 200),
   307 		new State_Func2H_Called(p, 200),
   308 		new State_Func2_Called(p, 200),
   309 		new State_Func3H_Called(p),
   310 		new State_Func3H_Called(p),
   311 		new State_Func3_Called(p),
   312 		new State_Return(3),
   313 		new State_Func4H_Called(p, 400),
   314 		new State_Func4H_Called(p, 400),
   315 		new State_Func4_Called(p, 400),
   316 		new State_Return(4),
   317 		NULL), "Part 4");
   318 
   319 	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   320 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   321 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   322 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   323 
   324 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   325 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   326 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   327 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   328 
   329 	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
   330 	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
   331 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   332 
   333 	p->Func5();
   334 
   335 	CHECK_STATES((&g_States,
   336 		new State_Func1H_Called(p),
   337 		new State_Func5_Called(p),
   338 		NULL), "Part 5");
   339 
   340 	// 6) Test auto-remove on reconfig
   341 	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
   342 
   343 	p->Func1();
   344 	p->Func5();
   345 	
   346 	CHECK_STATES((&g_States,
   347 		new State_Func1_Called(p),
   348 		new State_Func5_Called(p),
   349 		NULL), "Part 6");
   350 
   351 	return true;
   352 }
   353