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