sourcehook/test/testvphooks.cpp
author Pavol Marko <pavolmarko@gmail.com>
Sat May 12 08:08:01 2007 +0000 (2007-05-12)
changeset 328 3a04ef79edf1
parent 324 257f0837a885
child 333 3813f1ac0cfe
permissions -rw-r--r--
Direct VP hooks, new SH_CALL
     1 #include <string>
     2 #include "sourcehook.h"
     3 #include "sourcehook_test.h"
     4 #include "testevents.h"
     5 
     6 // TEST VP HOOKS
     7 // Test vfnptr-wide hooks
     8 // Also contains a test for removing hooks on deleted instances (by id)
     9 
    10 namespace
    11 {
    12 	StateList g_States;
    13 	SourceHook::ISourceHook *g_SHPtr;
    14 	SourceHook::Plugin g_PLID;
    15 
    16 	class IBase;
    17 
    18 	MAKE_STATE_1(State_D1_Func1, IBase *);
    19 	MAKE_STATE_1(State_D2_Func1, IBase *);
    20 	MAKE_STATE_1(State_Func1_Pre, IBase *);
    21 	MAKE_STATE_1(State_Func1_Post, IBase *);
    22 
    23 	MAKE_STATE_1(State_D1_Func2, IBase *);
    24 	MAKE_STATE_1(State_D2_Func2, IBase *);
    25 	MAKE_STATE_1(State_Func2_Pre, IBase *);
    26 	MAKE_STATE_1(State_Func2_Post, IBase *);
    27 
    28 	MAKE_STATE_2(State_D1_Func3, IBase *, int);
    29 	MAKE_STATE_2(State_D2_Func3, IBase *, int);
    30 	MAKE_STATE_2(State_Func3_Pre, IBase *, int);
    31 	MAKE_STATE_2(State_Func3_Post, IBase *, int);
    32 
    33 	class IBase
    34 	{
    35 	public:
    36 		virtual void Func1() = 0;
    37 		virtual void Func2() = 0;
    38 		virtual void Func3(int x) = 0;
    39 	};
    40 
    41 	class CDerived1 : public IBase
    42 	{
    43 	public:
    44 		virtual void Func1()
    45 		{
    46 			ADD_STATE(State_D1_Func1(this));
    47 		}
    48 		virtual void Func2()
    49 		{
    50 			ADD_STATE(State_D1_Func2(this));
    51 		}
    52 		virtual void Func3(int x)
    53 		{
    54 			ADD_STATE(State_D1_Func3(this, x));
    55 		}
    56 	};
    57 
    58 	class CDerived2 : public IBase
    59 	{
    60 	public:
    61 		virtual void Func1()
    62 		{
    63 			ADD_STATE(State_D2_Func1(this));
    64 		}
    65 		virtual void Func2()
    66 		{
    67 			ADD_STATE(State_D2_Func2(this));
    68 		}
    69 		virtual void Func3(int x)
    70 		{
    71 			ADD_STATE(State_D2_Func3(this, x));
    72 		}
    73 	};
    74 
    75 	void Handler_Func1_Pre()
    76 	{
    77 		ADD_STATE(State_Func1_Pre(META_IFACEPTR(IBase)));
    78 	}
    79 	void Handler_Func1_Post()
    80 	{
    81 		ADD_STATE(State_Func1_Post(META_IFACEPTR(IBase)));
    82 	}
    83 	int g_F2_Pre_HookToRemove = 0;
    84 	void Handler_Func2_Pre()
    85 	{
    86 		ADD_STATE(State_Func2_Pre(META_IFACEPTR(IBase)));
    87 		SH_REMOVE_HOOK_ID(g_F2_Pre_HookToRemove);
    88 	}
    89 	void Handler_Func2_Post()
    90 	{
    91 		ADD_STATE(State_Func2_Post(META_IFACEPTR(IBase)));
    92 	}
    93 
    94 
    95 	void Handler_Func3_Pre(int x)
    96 	{
    97 		ADD_STATE(State_Func3_Pre(META_IFACEPTR(IBase), x));
    98 
    99 		RETURN_META_NEWPARAMS(MRES_IGNORED, &IBase::Func3, (x+1));
   100 	}
   101 	void Handler_Func3_Post(int x)
   102 	{
   103 		ADD_STATE(State_Func3_Post(META_IFACEPTR(IBase), x));
   104 	}
   105 
   106 	SH_DECL_HOOK0_void(IBase, Func1, SH_NOATTRIB, 0);
   107 	SH_DECL_HOOK0_void(IBase, Func2, SH_NOATTRIB, 0);
   108 	SH_DECL_HOOK1_void(IBase, Func3, SH_NOATTRIB, 0, int);
   109 
   110 	SH_DECL_MANUALHOOK1_void(IBase_Func3_Manual, 2, 0, 0, int);
   111 }
   112 
   113 bool TestVPHooks(std::string &error)
   114 {
   115 	GET_SHPTR(g_SHPtr);
   116 	g_PLID = 1337;
   117 
   118 	CDerived1 d1i1;
   119 	CDerived1 d1i2;
   120 	CDerived2 d2i1;
   121 
   122 	IBase *p_d1i1 = &d1i1;
   123 	IBase *p_d1i2 = &d1i2;
   124 	IBase *p_d2i1 = &d2i1;
   125 
   126 	int hook1 = SH_ADD_VPHOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
   127 
   128 	p_d1i1->Func1();
   129 	p_d1i2->Func1();
   130 	p_d2i1->Func1();
   131 
   132 	CHECK_STATES((&g_States,
   133 		new State_Func1_Pre(p_d1i1),
   134 		new State_D1_Func1(p_d1i1),
   135 		
   136 		new State_Func1_Pre(p_d1i2),
   137 		new State_D1_Func1(p_d1i2),
   138 
   139 		new State_D2_Func1(p_d2i1),
   140 		NULL), "Part 1");
   141 
   142 	SH_CALL(p_d1i1, &IBase::Func1)();
   143 	SH_CALL(p_d1i2, &IBase::Func1)();
   144 	SH_CALL(p_d2i1, &IBase::Func1)();
   145 
   146 	CHECK_STATES((&g_States,
   147 		new State_D1_Func1(p_d1i1),
   148 
   149 		new State_D1_Func1(p_d1i2),
   150 
   151 		new State_D2_Func1(p_d2i1),
   152 		NULL), "Part 1.1");
   153 
   154 	SH_REMOVE_HOOK_ID(hook1);
   155 
   156 	p_d1i1->Func1();
   157 	p_d1i2->Func1();
   158 	p_d2i1->Func1();
   159 
   160 	CHECK_STATES((&g_States,
   161 		new State_D1_Func1(p_d1i1),
   162 
   163 		new State_D1_Func1(p_d1i2),
   164 
   165 		new State_D2_Func1(p_d2i1),
   166 		NULL), "Part 2");
   167 
   168 
   169 
   170 	// Normal hook, then vp hook
   171 
   172 	int hook2 = SH_ADD_HOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
   173 	hook1 = SH_ADD_VPHOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
   174 
   175 	p_d1i1->Func1();
   176 	p_d1i2->Func1();
   177 	p_d2i1->Func1();
   178 
   179 	CHECK_STATES((&g_States,
   180 		new State_Func1_Pre(p_d1i1),
   181 		new State_Func1_Pre(p_d1i1),
   182 		new State_D1_Func1(p_d1i1),
   183 
   184 		new State_Func1_Pre(p_d1i2),
   185 		new State_D1_Func1(p_d1i2),
   186 
   187 		new State_D2_Func1(p_d2i1),
   188 		NULL), "Part 3");
   189 
   190 	SH_REMOVE_HOOK_ID(hook1);
   191 
   192 	p_d1i1->Func1();
   193 	p_d1i2->Func1();
   194 	p_d2i1->Func1();
   195 
   196 	CHECK_STATES((&g_States,
   197 		new State_Func1_Pre(p_d1i1),
   198 		new State_D1_Func1(p_d1i1),
   199 
   200 		new State_D1_Func1(p_d1i2),
   201 
   202 		new State_D2_Func1(p_d2i1),
   203 		NULL), "Part 4");
   204 
   205 	SH_REMOVE_HOOK_ID(hook2);
   206 
   207 	p_d1i1->Func1();
   208 	p_d1i2->Func1();
   209 	p_d2i1->Func1();
   210 
   211 	CHECK_STATES((&g_States,
   212 		new State_D1_Func1(p_d1i1),
   213 
   214 		new State_D1_Func1(p_d1i2),
   215 
   216 		new State_D2_Func1(p_d2i1),
   217 		NULL), "Part 5");
   218 
   219 	// Test this:
   220 	// Normal hook AND vp hook on Func2
   221 	// Func2's pre handler removes the VP hook. It has to work anyway :)
   222 
   223 	hook1 = SH_ADD_VPHOOK(IBase, Func2, p_d1i1, SH_STATIC(Handler_Func2_Pre), false);
   224 	hook2 = SH_ADD_HOOK(IBase, Func2, p_d1i1, SH_STATIC(Handler_Func2_Pre), false);
   225 
   226 	g_F2_Pre_HookToRemove = hook1;
   227 	p_d1i1->Func2();
   228 	p_d1i1->Func2();
   229 
   230 	CHECK_STATES((&g_States,
   231 		new State_Func2_Pre(p_d1i1),
   232 		new State_Func2_Pre(p_d1i1),
   233 		new State_D1_Func2(p_d1i1),
   234 
   235 		new State_Func2_Pre(p_d1i1),
   236 		new State_D1_Func2(p_d1i1),
   237 
   238 		NULL), "Part 6");
   239 
   240 	SH_REMOVE_HOOK_ID(hook1);
   241 
   242 	// Hook function 3:
   243 	//  Using manualhook, VP
   244 	hook1 = SH_ADD_MANUALVPHOOK(IBase_Func3_Manual, p_d1i1, SH_STATIC(Handler_Func3_Pre), false);
   245 
   246 	//  Normally, VP
   247 	hook2 = SH_ADD_VPHOOK(IBase, Func3, p_d1i1, SH_STATIC(Handler_Func3_Pre), false);
   248 
   249 	// Normally, no VP
   250 	int hook3 = SH_ADD_HOOK(IBase, Func3, p_d1i1, SH_STATIC(Handler_Func3_Pre), false);
   251 
   252 	p_d1i1->Func3(1);
   253 
   254 	CHECK_STATES((&g_States,
   255 		new State_Func3_Pre(p_d1i1, 1),		// manual vp hook
   256 		new State_Func3_Pre(p_d1i1, 2),		// normal vp hook
   257 		new State_Func3_Pre(p_d1i1, 3),		// normal non-vp hook
   258 
   259 		new State_D1_Func3(p_d1i1, 4),		// function
   260 
   261 		NULL), "Part 7.1");
   262 
   263 	p_d1i2->Func3(1);
   264 
   265 	CHECK_STATES((&g_States,
   266 		new State_Func3_Pre(p_d1i2, 1),		// manual vp hook
   267 		new State_Func3_Pre(p_d1i2, 2),		// normal vp hook
   268 
   269 		new State_D1_Func3(p_d1i2, 3),		// function
   270 
   271 		NULL), "Part 7.2");
   272 
   273 	SH_REMOVE_HOOK_ID(hook1);
   274 	SH_REMOVE_HOOK_ID(hook2);
   275 	SH_REMOVE_HOOK_ID(hook3);
   276 
   277 	// Test direct VP hook
   278 
   279 	p_d1i1->Func1();
   280 	p_d1i2->Func1();
   281 
   282 	// get vtable manually
   283 	void *pVtable = *reinterpret_cast<void**>(p_d1i1);
   284 
   285 	hook1 = SH_ADD_DVPHOOK(IBase, Func1, pVtable, SH_STATIC(Handler_Func1_Pre), false);
   286 
   287 	p_d1i1->Func1();
   288 	p_d1i2->Func1();
   289 
   290 	CHECK_STATES((&g_States,
   291 		new State_D1_Func1(p_d1i1),
   292 		new State_D1_Func1(p_d1i2),
   293 
   294 		new State_Func1_Pre(p_d1i1),
   295 		new State_D1_Func1(p_d1i1),
   296 		new State_Func1_Pre(p_d1i2),
   297 		new State_D1_Func1(p_d1i2),
   298 		NULL), "Part 8.1");
   299 
   300 	SH_REMOVE_HOOK_ID(hook1);
   301 
   302 	// Now try manual dvp hooks
   303 	p_d1i1->Func3(1);
   304 	p_d1i2->Func3(1);
   305 	
   306 	hook1 = SH_ADD_MANUALDVPHOOK(IBase_Func3_Manual, pVtable, SH_STATIC(Handler_Func3_Pre), false);
   307 
   308 	p_d1i1->Func3(1);
   309 	p_d1i2->Func3(1);
   310 
   311 	CHECK_STATES((&g_States,
   312 		new State_D1_Func3(p_d1i1, 1),
   313 		new State_D1_Func3(p_d1i2, 1),
   314 
   315 		new State_Func3_Pre(p_d1i1, 1),		// manual vp hook
   316 		new State_D1_Func3(p_d1i1, 2),		// function
   317 
   318 		new State_Func3_Pre(p_d1i2, 1),		// normal vp hook
   319 		new State_D1_Func3(p_d1i2, 2),		// function
   320 
   321 		NULL), "Part 8.2");
   322 
   323 
   324 	// Test removing normal hooks even though the instance is deleted
   325 	p_d1i1 = new CDerived1;
   326 	SH_ADD_HOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
   327 	delete p_d1i1;
   328 	// The following line may not crash!
   329 	SH_REMOVE_HOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
   330 
   331 	return true;
   332 }
   333