sourcehook/test/testmanual.cpp
author David Anderson <dvander@alliedmods.net>
Thu Oct 05 06:11:53 2006 +0000 (2006-10-05)
changeset 262 5c2892f5b935
parent 211 af7f4f2148f5
child 294 0d87bc8606f8
permissions -rw-r--r--
string fixups
     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 		RETURN_META_MNEWPARAMS(MRES_IGNORED, TheWall_Func2, (0x87654321));
    80 	}
    81 	short Handler_Func3()
    82 	{
    83 		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
    84 		return 0;
    85 	}
    86 	short Handler_Func4(int x)
    87 	{
    88 		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
    89 
    90 		// newparams (recall) using the manual hook declaration!
    91 		RETURN_META_VALUE_MNEWPARAMS(MRES_IGNORED, 0, TheWall_Func4, (0x12345678));
    92 	}
    93 
    94 	struct AnotherBrick
    95 	{
    96 		void Handler_Func1()
    97 		{
    98 			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    99 			RETURN_META(MRES_SUPERCEDE);
   100 		}
   101 	};
   102 }
   103 
   104 bool TestManual(std::string &error)
   105 {
   106 	GET_SHPTR(g_SHPtr);
   107 	g_PLID = 1337;
   108 
   109 	TheWall inst;
   110 	TheWall *p = &inst;
   111 
   112 	SourceHook::ManualCallClass *cc = SH_GET_MCALLCLASS(p, sizeof(void*));
   113 
   114 	// 1)
   115 	// Call each function
   116 	p->Func1();
   117 	p->Func2(200);
   118 	ADD_STATE(State_Return(p->Func3()));
   119 	ADD_STATE(State_Return(p->Func4(400)));
   120 
   121 	CHECK_STATES((&g_States,
   122 		new State_Func1_Called(p),
   123 		new State_Func2_Called(p, 200),
   124 		new State_Func3_Called(p),
   125 		new State_Return(3),
   126 		new State_Func4_Called(p, 400),
   127 		new State_Return(4),
   128 		NULL), "Part 1");
   129 
   130 	// 1.1)
   131 	// Now call each function through the manual call class, using the hook decl and manually
   132 	SH_MCALL(cc, TheWall_Func1)();
   133 	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   134 	SH_MCALL(cc, TheWall_Func2)(200);
   135 	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   136 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   137 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   138 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   139 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   140 
   141 	CHECK_STATES((&g_States,
   142 		new State_Func1_Called(p),
   143 		new State_Func1_Called(p),
   144 		new State_Func2_Called(p, 200),
   145 		new State_Func2_Called(p, 200),
   146 		new State_Func3_Called(p),
   147 		new State_Return(3),
   148 		new State_Func3_Called(p),
   149 		new State_Return(3),
   150 		new State_Func4_Called(p, 400),
   151 		new State_Return(4),
   152 		new State_Func4_Called(p, 400),
   153 		new State_Return(4),
   154 		NULL), "Part 1.1");
   155 
   156 	// 2)
   157 	// Hook each function normally, call them
   158 	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   159 	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   160 	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   161 	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   162 
   163 	p->Func1();
   164 	p->Func2(200);
   165 	ADD_STATE(State_Return(p->Func3()));
   166 	ADD_STATE(State_Return(p->Func4(400)));
   167 
   168 	CHECK_STATES((&g_States,
   169 		new State_Func1H_Called(p),
   170 		new State_Func1_Called(p),
   171 		new State_Func2H_Called(p, 200),
   172 		new State_Func2_Called(p, 0x87654321),
   173 		new State_Func3H_Called(p),
   174 		new State_Func3_Called(p),
   175 		new State_Return(3),
   176 		new State_Func4H_Called(p, 400),
   177 		new State_Func4_Called(p, 0x12345678),
   178 		new State_Return(4),
   179 		NULL), "Part 2");
   180 
   181 	// Call them through the mcallclass
   182 	// 2.1)
   183 	// Now call each function through the manual call class, using the hook decl and manually
   184 	SH_MCALL(cc, TheWall_Func1)();
   185 	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   186 	SH_MCALL(cc, TheWall_Func2)(200);
   187 	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   188 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   189 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   190 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   191 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   192 
   193 	CHECK_STATES((&g_States,
   194 		new State_Func1_Called(p),
   195 		new State_Func1_Called(p),
   196 		new State_Func2_Called(p, 200),
   197 		new State_Func2_Called(p, 200),
   198 		new State_Func3_Called(p),
   199 		new State_Return(3),
   200 		new State_Func3_Called(p),
   201 		new State_Return(3),
   202 		new State_Func4_Called(p, 400),
   203 		new State_Return(4),
   204 		new State_Func4_Called(p, 400),
   205 		new State_Return(4),
   206 		NULL), "Part 2.1");
   207 
   208 	// Unhook them
   209 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   210 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   211 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   212 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   213 
   214 	// 3)
   215 	// Hook each function manually, call them
   216 
   217 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   218 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   219 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   220 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   221 
   222 	p->Func1();
   223 	p->Func2(200);
   224 	ADD_STATE(State_Return(p->Func3()));
   225 	ADD_STATE(State_Return(p->Func4(400)));
   226 
   227 	CHECK_STATES((&g_States,
   228 		new State_Func1H_Called(p),
   229 		new State_Func1_Called(p),
   230 		new State_Func2H_Called(p, 200),
   231 		new State_Func2_Called(p, 0x87654321),
   232 		new State_Func3H_Called(p),
   233 		new State_Func3_Called(p),
   234 		new State_Return(3),
   235 		new State_Func4H_Called(p, 400),
   236 		new State_Func4_Called(p, 0x12345678),
   237 		new State_Return(4),
   238 		NULL), "Part 3");
   239 
   240 	// Now through the mcallclass
   241 
   242 	// Call them through the mcallclass
   243 	// 3.1)
   244 	// Now call each function through the manual call class, using the hook decl and manually
   245 	SH_MCALL(cc, TheWall_Func1)();
   246 	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
   247 	SH_MCALL(cc, TheWall_Func2)(200);
   248 	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
   249 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
   250 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
   251 	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
   252 	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
   253 
   254 	CHECK_STATES((&g_States,
   255 		new State_Func1_Called(p),
   256 		new State_Func1_Called(p),
   257 		new State_Func2_Called(p, 200),
   258 		new State_Func2_Called(p, 200),
   259 		new State_Func3_Called(p),
   260 		new State_Return(3),
   261 		new State_Func3_Called(p),
   262 		new State_Return(3),
   263 		new State_Func4_Called(p, 400),
   264 		new State_Return(4),
   265 		new State_Func4_Called(p, 400),
   266 		new State_Return(4),
   267 		NULL), "Part 3.1");
   268 
   269 	// Unhook them
   270 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   271 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   272 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   273 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   274 
   275 	// 4)
   276 	// Hook each function manually, then normally, call, unhook
   277 
   278 	AnotherBrick handler_inst;
   279 
   280 	// Why this?
   281 	// 1) tests sh_add_manualhook_memfunc
   282 	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
   283 	//    (because there are no attribs for manual hooks).
   284 	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
   285 	//    already was one for this vfnptr. This hook manager stored the pointer of the original
   286 	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
   287 	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
   288 	//    does) will supercede the second hook func from being called - thus bypassing the call
   289 	//    of the auto hook here.
   290 	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   291 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   292 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   293 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   294 
   295 	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   296 	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   297 	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   298 	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   299 
   300 	p->Func1();
   301 	p->Func2(200);
   302 	ADD_STATE(State_Return(p->Func3()));
   303 	ADD_STATE(State_Return(p->Func4(400)));
   304 
   305 	CHECK_STATES((&g_States,
   306 		new State_Func1H_Called(p),
   307 		new State_Func1H_Called(p),
   308 		//new State_Func1_Called(p),
   309 		new State_Func2H_Called(p, 200),
   310 		new State_Func2H_Called(p, 0x87654321),
   311 		new State_Func2_Called(p, 0x87654321),
   312 		new State_Func3H_Called(p),
   313 		new State_Func3H_Called(p),
   314 		new State_Func3_Called(p),
   315 		new State_Return(3),
   316 		new State_Func4H_Called(p, 400),
   317 		new State_Func4H_Called(p, 0x12345678),
   318 		new State_Func4_Called(p, 0x12345678),
   319 		new State_Return(4),
   320 		NULL), "Part 4");
   321 
   322 	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   323 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   324 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   325 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   326 
   327 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   328 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   329 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   330 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   331 
   332 	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
   333 	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
   334 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   335 
   336 	p->Func5();
   337 
   338 	CHECK_STATES((&g_States,
   339 		new State_Func1H_Called(p),
   340 		new State_Func5_Called(p),
   341 		NULL), "Part 5");
   342 
   343 	// 6) Test auto-remove on reconfig
   344 	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
   345 
   346 	p->Func1();
   347 	p->Func5();
   348 	
   349 	CHECK_STATES((&g_States,
   350 		new State_Func1_Called(p),
   351 		new State_Func5_Called(p),
   352 		NULL), "Part 6");
   353 
   354 	return true;
   355 }
   356