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