core/sourcehook/test/testvphooks.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 539 db914129ae01
permissions -rw-r--r--
Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (bug 4117, r=dvander).

Games where the above function can crash are handled by detouring tier0's Error() function and jumping back to our own code. So in theory this should work on all games now.
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@324
     8
pavolmarko@324
     9
namespace
pavolmarko@324
    10
{
pavolmarko@324
    11
	StateList g_States;
pavolmarko@324
    12
	SourceHook::ISourceHook *g_SHPtr;
pavolmarko@324
    13
	SourceHook::Plugin g_PLID;
pavolmarko@324
    14
pavolmarko@324
    15
	class IBase;
pavolmarko@324
    16
pavolmarko@324
    17
	MAKE_STATE_1(State_D1_Func1, IBase *);
pavolmarko@324
    18
	MAKE_STATE_1(State_D2_Func1, IBase *);
pavolmarko@324
    19
	MAKE_STATE_1(State_Func1_Pre, IBase *);
pavolmarko@324
    20
	MAKE_STATE_1(State_Func1_Post, IBase *);
pavolmarko@324
    21
pavolmarko@324
    22
	MAKE_STATE_1(State_D1_Func2, IBase *);
pavolmarko@324
    23
	MAKE_STATE_1(State_D2_Func2, IBase *);
pavolmarko@324
    24
	MAKE_STATE_1(State_Func2_Pre, IBase *);
pavolmarko@324
    25
	MAKE_STATE_1(State_Func2_Post, IBase *);
pavolmarko@324
    26
pavolmarko@324
    27
	MAKE_STATE_2(State_D1_Func3, IBase *, int);
pavolmarko@324
    28
	MAKE_STATE_2(State_D2_Func3, IBase *, int);
pavolmarko@324
    29
	MAKE_STATE_2(State_Func3_Pre, IBase *, int);
pavolmarko@324
    30
	MAKE_STATE_2(State_Func3_Post, IBase *, int);
pavolmarko@324
    31
pavolmarko@324
    32
	class IBase
pavolmarko@420
    33
	{
pavolmarko@420
    34
	public:
pavolmarko@420
    35
		virtual void Func1() = 0;
pavolmarko@420
    36
		virtual void Func2() = 0;
pavolmarko@420
    37
		virtual void Func3(int x) = 0;
pavolmarko@324
    38
	};
pavolmarko@324
    39
pavolmarko@324
    40
	class CDerived1 : public IBase
pavolmarko@420
    41
	{
pavolmarko@420
    42
	public:
pavolmarko@420
    43
		virtual void Func1()
pavolmarko@420
    44
		{
pavolmarko@420
    45
			ADD_STATE(State_D1_Func1(this));
pavolmarko@420
    46
		}
pavolmarko@420
    47
		virtual void Func2()
pavolmarko@420
    48
		{
pavolmarko@420
    49
			ADD_STATE(State_D1_Func2(this));
pavolmarko@420
    50
		}
pavolmarko@420
    51
		virtual void Func3(int x)
pavolmarko@420
    52
		{
pavolmarko@420
    53
			ADD_STATE(State_D1_Func3(this, x));
pavolmarko@420
    54
		}
pavolmarko@324
    55
	};
pavolmarko@324
    56
pavolmarko@324
    57
	class CDerived2 : public IBase
pavolmarko@420
    58
	{
pavolmarko@420
    59
	public:
pavolmarko@420
    60
		virtual void Func1()
pavolmarko@420
    61
		{
pavolmarko@420
    62
			ADD_STATE(State_D2_Func1(this));
pavolmarko@420
    63
		}
pavolmarko@420
    64
		virtual void Func2()
pavolmarko@420
    65
		{
pavolmarko@420
    66
			ADD_STATE(State_D2_Func2(this));
pavolmarko@420
    67
		}
pavolmarko@420
    68
		virtual void Func3(int x)
pavolmarko@420
    69
		{
pavolmarko@420
    70
			ADD_STATE(State_D2_Func3(this, x));
pavolmarko@420
    71
		}
pavolmarko@324
    72
	};
pavolmarko@324
    73
pavolmarko@324
    74
	void Handler_Func1_Pre()
pavolmarko@420
    75
	{
pavolmarko@420
    76
		ADD_STATE(State_Func1_Pre(META_IFACEPTR(IBase)));
pavolmarko@324
    77
	}
pavolmarko@324
    78
	void Handler_Func1_Post()
pavolmarko@420
    79
	{
pavolmarko@420
    80
		ADD_STATE(State_Func1_Post(META_IFACEPTR(IBase)));
pavolmarko@324
    81
	}
pavolmarko@324
    82
	int g_F2_Pre_HookToRemove = 0;
pavolmarko@324
    83
	void Handler_Func2_Pre()
pavolmarko@420
    84
	{
pavolmarko@420
    85
		ADD_STATE(State_Func2_Pre(META_IFACEPTR(IBase)));
pavolmarko@420
    86
		SH_REMOVE_HOOK_ID(g_F2_Pre_HookToRemove);
pavolmarko@324
    87
	}
pavolmarko@324
    88
	void Handler_Func2_Post()
pavolmarko@420
    89
	{
pavolmarko@420
    90
		ADD_STATE(State_Func2_Post(META_IFACEPTR(IBase)));
pavolmarko@324
    91
	}
pavolmarko@324
    92
pavolmarko@324
    93
pavolmarko@324
    94
	void Handler_Func3_Pre(int x)
pavolmarko@420
    95
	{
pavolmarko@420
    96
		ADD_STATE(State_Func3_Pre(META_IFACEPTR(IBase), x));
pavolmarko@420
    97
pavolmarko@420
    98
		RETURN_META_NEWPARAMS(MRES_IGNORED, &IBase::Func3, (x+1));
pavolmarko@324
    99
	}
pavolmarko@324
   100
	void Handler_Func3_Post(int x)
pavolmarko@420
   101
	{
pavolmarko@420
   102
		ADD_STATE(State_Func3_Post(META_IFACEPTR(IBase), x));
pavolmarko@324
   103
	}
pavolmarko@324
   104
pavolmarko@324
   105
	SH_DECL_HOOK0_void(IBase, Func1, SH_NOATTRIB, 0);
pavolmarko@324
   106
	SH_DECL_HOOK0_void(IBase, Func2, SH_NOATTRIB, 0);
pavolmarko@324
   107
	SH_DECL_HOOK1_void(IBase, Func3, SH_NOATTRIB, 0, int);
pavolmarko@324
   108
pavolmarko@324
   109
	SH_DECL_MANUALHOOK1_void(IBase_Func3_Manual, 2, 0, 0, int);
pavolmarko@324
   110
}
pavolmarko@324
   111
pavolmarko@324
   112
bool TestVPHooks(std::string &error)
pavolmarko@420
   113
{
pavolmarko@324
   114
	GET_SHPTR(g_SHPtr);
pavolmarko@420
   115
	g_PLID = 1337;
pavolmarko@420
   116
pavolmarko@420
   117
	CDerived1 d1i1;
pavolmarko@420
   118
	CDerived1 d1i2;
pavolmarko@420
   119
	CDerived2 d2i1;
pavolmarko@420
   120
pavolmarko@420
   121
	IBase *p_d1i1 = &d1i1;
pavolmarko@420
   122
	IBase *p_d1i2 = &d1i2;
pavolmarko@420
   123
	IBase *p_d2i1 = &d2i1;
pavolmarko@420
   124
	
pavolmarko@420
   125
	int hook1 = SH_ADD_VPHOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
pavolmarko@420
   126
pavolmarko@420
   127
	p_d1i1->Func1();
pavolmarko@420
   128
	p_d1i2->Func1();
pavolmarko@420
   129
	p_d2i1->Func1();
pavolmarko@420
   130
pavolmarko@324
   131
	CHECK_STATES((&g_States,
pavolmarko@324
   132
		new State_Func1_Pre(p_d1i1),
pavolmarko@324
   133
		new State_D1_Func1(p_d1i1),
pavolmarko@324
   134
		
pavolmarko@324
   135
		new State_Func1_Pre(p_d1i2),
pavolmarko@324
   136
		new State_D1_Func1(p_d1i2),
pavolmarko@324
   137
pavolmarko@324
   138
		new State_D2_Func1(p_d2i1),
pavolmarko@420
   139
		NULL), "Part 1");
pavolmarko@420
   140
pavolmarko@420
   141
	SH_REMOVE_HOOK_ID(hook1);
pavolmarko@420
   142
pavolmarko@420
   143
	p_d1i1->Func1();
pavolmarko@420
   144
	p_d1i2->Func1();
pavolmarko@420
   145
	p_d2i1->Func1();
pavolmarko@420
   146
pavolmarko@328
   147
	CHECK_STATES((&g_States,
pavolmarko@328
   148
		new State_D1_Func1(p_d1i1),
pavolmarko@328
   149
pavolmarko@328
   150
		new State_D1_Func1(p_d1i2),
pavolmarko@328
   151
pavolmarko@328
   152
		new State_D2_Func1(p_d2i1),
pavolmarko@420
   153
		NULL), "Part 2");
pavolmarko@420
   154
pavolmarko@420
   155
pavolmarko@420
   156
	// Normal hook, then vp hook
pavolmarko@420
   157
pavolmarko@420
   158
	int hook2 = SH_ADD_HOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
pavolmarko@420
   159
	hook1 = SH_ADD_VPHOOK(IBase, Func1, p_d1i1, SH_STATIC(Handler_Func1_Pre), false);
pavolmarko@420
   160
pavolmarko@420
   161
	p_d1i1->Func1();
pavolmarko@420
   162
	p_d1i2->Func1();
pavolmarko@420
   163
	p_d2i1->Func1();
pavolmarko@420
   164
pavolmarko@324
   165
	CHECK_STATES((&g_States,
pavolmarko@324
   166
		new State_Func1_Pre(p_d1i1),
pavolmarko@324
   167
		new State_Func1_Pre(p_d1i1),
pavolmarko@324
   168
		new State_D1_Func1(p_d1i1),
pavolmarko@324
   169
pavolmarko@324
   170
		new State_Func1_Pre(p_d1i2),
pavolmarko@324
   171
		new State_D1_Func1(p_d1i2),
pavolmarko@324
   172
pavolmarko@324
   173
		new State_D2_Func1(p_d2i1),
pavolmarko@420
   174
		NULL), "Part 3");
pavolmarko@420
   175
pavolmarko@420
   176
	SH_REMOVE_HOOK_ID(hook1);
pavolmarko@420
   177
pavolmarko@420
   178
	p_d1i1->Func1();
pavolmarko@420
   179
	p_d1i2->Func1();
pavolmarko@420
   180
	p_d2i1->Func1();
pavolmarko@420
   181
pavolmarko@324
   182
	CHECK_STATES((&g_States,
pavolmarko@324
   183
		new State_Func1_Pre(p_d1i1),
pavolmarko@324
   184
		new State_D1_Func1(p_d1i1),
pavolmarko@324
   185
pavolmarko@324
   186
		new State_D1_Func1(p_d1i2),
pavolmarko@324
   187
pavolmarko@324
   188
		new State_D2_Func1(p_d2i1),
pavolmarko@420
   189
		NULL), "Part 4");
pavolmarko@420
   190
pavolmarko@420
   191
	SH_REMOVE_HOOK_ID(hook2);
pavolmarko@420
   192
pavolmarko@420
   193
	p_d1i1->Func1();
pavolmarko@420
   194
	p_d1i2->Func1();
pavolmarko@420
   195
	p_d2i1->Func1();
pavolmarko@420
   196
pavolmarko@324
   197
	CHECK_STATES((&g_States,
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@420
   203
		NULL), "Part 5");
pavolmarko@420
   204
pavolmarko@420
   205
	// Test this:
pavolmarko@420
   206
	// Normal hook AND vp hook on Func2
pavolmarko@420
   207
	// Func2's pre handler removes the VP hook.
pavolmarko@420
   208
pavolmarko@420
   209
	hook1 = SH_ADD_VPHOOK(IBase, Func2, p_d1i1, SH_STATIC(Handler_Func2_Pre), false);
pavolmarko@420
   210
	hook2 = SH_ADD_HOOK(IBase, Func2, p_d1i1, SH_STATIC(Handler_Func2_Pre), false);
pavolmarko@420
   211
pavolmarko@420
   212
	g_F2_Pre_HookToRemove = hook1;
pavolmarko@420
   213
	p_d1i1->Func2();
pavolmarko@420
   214
	p_d1i1->Func2();
pavolmarko@420
   215
pavolmarko@324
   216
	CHECK_STATES((&g_States,
pavolmarko@324
   217
		new State_Func2_Pre(p_d1i1),
pavolmarko@324
   218
		new State_D1_Func2(p_d1i1),
pavolmarko@324
   219
pavolmarko@324
   220
		new State_Func2_Pre(p_d1i1),
pavolmarko@324
   221
		new State_D1_Func2(p_d1i1),
pavolmarko@324
   222
pavolmarko@420
   223
		NULL), "Part 6");
pavolmarko@420
   224
pavolmarko@420
   225
	SH_REMOVE_HOOK_ID(hook1);
pavolmarko@420
   226
pavolmarko@420
   227
	// Hook function 3:
pavolmarko@420
   228
	//  Using manualhook, VP
pavolmarko@420
   229
	hook1 = SH_ADD_MANUALVPHOOK(IBase_Func3_Manual, p_d1i1, SH_STATIC(Handler_Func3_Pre), false);
pavolmarko@420
   230
pavolmarko@420
   231
	//  Normally, VP
pavolmarko@420
   232
	hook2 = SH_ADD_VPHOOK(IBase, Func3, p_d1i1, SH_STATIC(Handler_Func3_Pre), false);
pavolmarko@420
   233
pavolmarko@420
   234
	// Normally, no VP
pavolmarko@420
   235
	int hook3 = SH_ADD_HOOK(IBase, Func3, p_d1i1, SH_STATIC(Handler_Func3_Pre), false);
pavolmarko@420
   236
pavolmarko@420
   237
	p_d1i1->Func3(1);
pavolmarko@420
   238
pavolmarko@324
   239
	CHECK_STATES((&g_States,
pavolmarko@324
   240
		new State_Func3_Pre(p_d1i1, 1),		// manual vp hook
pavolmarko@324
   241
		new State_Func3_Pre(p_d1i1, 2),		// normal vp hook
pavolmarko@324
   242
		new State_Func3_Pre(p_d1i1, 3),		// normal non-vp hook
pavolmarko@324
   243
pavolmarko@324
   244
		new State_D1_Func3(p_d1i1, 4),		// function
pavolmarko@324
   245
pavolmarko@420
   246
		NULL), "Part 7.1");
pavolmarko@420
   247
pavolmarko@420
   248
	p_d1i2->Func3(1);
pavolmarko@420
   249
pavolmarko@324
   250
	CHECK_STATES((&g_States,
pavolmarko@324
   251
		new State_Func3_Pre(p_d1i2, 1),		// manual vp hook
pavolmarko@324
   252
		new State_Func3_Pre(p_d1i2, 2),		// normal vp hook
pavolmarko@324
   253
pavolmarko@324
   254
		new State_D1_Func3(p_d1i2, 3),		// function
pavolmarko@324
   255
pavolmarko@420
   256
		NULL), "Part 7.2");
pavolmarko@420
   257
pavolmarko@420
   258
	return true;
pavolmarko@420
   259
}
pavolmarko@420
   260