sourcehook/test/testmanual.cpp
author David Anderson <dvander@alliedmods.net>
Sat Apr 29 09:34:08 2006 +0000 (2006-04-29)
changeset 193 184b3f1559c0
parent 162 a95db73792e5
child 199 7a5b326bb7f8
permissions -rw-r--r--
these should be const (more latrE)
     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 	void Handler_Func1()
    68 	{
    69 		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    70 	}
    71 	void Handler_Func2(int x)
    72 	{
    73 		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
    74 	}
    75 	short Handler_Func3()
    76 	{
    77 		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
    78 		return 0;
    79 	}
    80 	short Handler_Func4(int x)
    81 	{
    82 		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
    83 		return 0;
    84 	}
    85 
    86 	struct AnotherBrick
    87 	{
    88 		void Handler_Func1()
    89 		{
    90 			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
    91 			RETURN_META(MRES_SUPERCEDE);
    92 		}
    93 	};
    94 }
    95 
    96 bool TestManual(std::string &error)
    97 {
    98 	GET_SHPTR(g_SHPtr);
    99 	g_PLID = 1337;
   100 
   101 	TheWall inst;
   102 	TheWall *p = &inst;
   103 
   104 	// 1)
   105 	// Call each function
   106 	p->Func1();
   107 	p->Func2(200);
   108 	ADD_STATE(State_Return(p->Func3()));
   109 	ADD_STATE(State_Return(p->Func4(400)));
   110 
   111 	CHECK_STATES((&g_States,
   112 		new State_Func1_Called(p),
   113 		new State_Func2_Called(p, 200),
   114 		new State_Func3_Called(p),
   115 		new State_Return(3),
   116 		new State_Func4_Called(p, 400),
   117 		new State_Return(4),
   118 		NULL), "Part 1");
   119 
   120 	// 2)
   121 	// Hook each function normally, call them, unhook them
   122 	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   123 	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   124 	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   125 	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   126 
   127 	p->Func1();
   128 	p->Func2(200);
   129 	ADD_STATE(State_Return(p->Func3()));
   130 	ADD_STATE(State_Return(p->Func4(400)));
   131 
   132 	CHECK_STATES((&g_States,
   133 		new State_Func1H_Called(p),
   134 		new State_Func1_Called(p),
   135 		new State_Func2H_Called(p, 200),
   136 		new State_Func2_Called(p, 200),
   137 		new State_Func3H_Called(p),
   138 		new State_Func3_Called(p),
   139 		new State_Return(3),
   140 		new State_Func4H_Called(p, 400),
   141 		new State_Func4_Called(p, 400),
   142 		new State_Return(4),
   143 		NULL), "Part 2");
   144 
   145 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   146 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   147 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   148 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   149 
   150 	// 3)
   151 	// Hook each function manually, call them, unhook them
   152 
   153 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   154 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   155 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   156 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   157 
   158 	p->Func1();
   159 	p->Func2(200);
   160 	ADD_STATE(State_Return(p->Func3()));
   161 	ADD_STATE(State_Return(p->Func4(400)));
   162 
   163 	CHECK_STATES((&g_States,
   164 		new State_Func1H_Called(p),
   165 		new State_Func1_Called(p),
   166 		new State_Func2H_Called(p, 200),
   167 		new State_Func2_Called(p, 200),
   168 		new State_Func3H_Called(p),
   169 		new State_Func3_Called(p),
   170 		new State_Return(3),
   171 		new State_Func4H_Called(p, 400),
   172 		new State_Func4_Called(p, 400),
   173 		new State_Return(4),
   174 		NULL), "Part 3");
   175 
   176 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   177 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   178 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   179 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   180 
   181 	// 4)
   182 	// Hook each function manually, then normally, call, unhook
   183 
   184 	AnotherBrick handler_inst;
   185 
   186 	// Why this?
   187 	// 1) tests sh_add_manualhook_memfunc
   188 	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
   189 	//    (because there are no attribs for manual hooks).
   190 	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
   191 	//    already was one for this vfnptr. This hook manager stored the pointer of the original
   192 	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
   193 	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
   194 	//    does) will supercede the second hook func from being called - thus bypassing the call
   195 	//    of the auto hook here.
   196 	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   197 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   198 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   199 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   200 
   201 	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   202 	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   203 	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   204 	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   205 
   206 	p->Func1();
   207 	p->Func2(200);
   208 	ADD_STATE(State_Return(p->Func3()));
   209 	ADD_STATE(State_Return(p->Func4(400)));
   210 
   211 	CHECK_STATES((&g_States,
   212 		new State_Func1H_Called(p),
   213 		new State_Func1H_Called(p),
   214 		//new State_Func1_Called(p),
   215 		new State_Func2H_Called(p, 200),
   216 		new State_Func2H_Called(p, 200),
   217 		new State_Func2_Called(p, 200),
   218 		new State_Func3H_Called(p),
   219 		new State_Func3H_Called(p),
   220 		new State_Func3_Called(p),
   221 		new State_Return(3),
   222 		new State_Func4H_Called(p, 400),
   223 		new State_Func4H_Called(p, 400),
   224 		new State_Func4_Called(p, 400),
   225 		new State_Return(4),
   226 		NULL), "Part 4");
   227 
   228 	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
   229 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
   230 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
   231 	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
   232 
   233 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
   234 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
   235 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
   236 	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
   237 
   238 	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
   239 	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
   240 	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
   241 
   242 	p->Func5();
   243 
   244 	CHECK_STATES((&g_States,
   245 		new State_Func1H_Called(p),
   246 		new State_Func5_Called(p),
   247 		NULL), "Part 5");
   248 
   249 	// 6) Test auto-remove on reconfig
   250 	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
   251 
   252 	p->Func1();
   253 	p->Func5();
   254 	
   255 	CHECK_STATES((&g_States,
   256 		new State_Func1_Called(p),
   257 		new State_Func5_Called(p),
   258 		NULL), "Part 6");
   259 
   260 	return true;
   261 }
   262