core/sourcehook/test/test3.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@58
     1
#include <string>
pavolmarko@162
     2
#include "sourcehook_test.h"
pavolmarko@58
     3
#include "testevents.h"
pavolmarko@58
     4
pavolmarko@58
     5
// TEST3
pavolmarko@58
     6
// Tests with inheritance / thisptroffsets
pavolmarko@58
     7
pavolmarko@58
     8
namespace
pavolmarko@58
     9
{
pavolmarko@58
    10
	StateList g_States;
pavolmarko@58
    11
	SourceHook::ISourceHook *g_SHPtr;
pavolmarko@58
    12
	SourceHook::Plugin g_PLID;
pavolmarko@58
    13
pavolmarko@58
    14
	MAKE_STATE_1(State_Func1_Called, void*);			// param1: This pointer
pavolmarko@58
    15
	MAKE_STATE_1(State_Func2_Called, void*);			// param1: This pointer
pavolmarko@58
    16
	MAKE_STATE_1(State_Func3_Called, void*);			// param1: This pointer
pavolmarko@58
    17
pavolmarko@58
    18
	MAKE_STATE_1(State_Func1H_Called, void*);
pavolmarko@58
    19
	MAKE_STATE_1(State_Func2H_Called, void*);
pavolmarko@58
    20
	MAKE_STATE_1(State_Func3H_Called, void*);
pavolmarko@58
    21
pavolmarko@58
    22
	class Base1
pavolmarko@58
    23
	{
pavolmarko@58
    24
		int a;
pavolmarko@58
    25
	public:
pavolmarko@58
    26
		virtual void Func1()
pavolmarko@58
    27
		{
pavolmarko@58
    28
			ADD_STATE(State_Func1_Called(reinterpret_cast<void*>(this)));
pavolmarko@58
    29
		}
pavolmarko@58
    30
	};
pavolmarko@58
    31
	class Base2
pavolmarko@58
    32
	{
pavolmarko@58
    33
		int b;
pavolmarko@58
    34
	public:
pavolmarko@58
    35
		virtual void Func2()
pavolmarko@58
    36
		{
pavolmarko@58
    37
			ADD_STATE(State_Func2_Called(reinterpret_cast<void*>(this)));
pavolmarko@58
    38
		}
pavolmarko@58
    39
	};
pavolmarko@58
    40
	class Derived : public Base1, public Base2
pavolmarko@58
    41
	{
pavolmarko@58
    42
		int c;
pavolmarko@58
    43
	public:
pavolmarko@58
    44
		virtual void Func3()
pavolmarko@58
    45
		{
pavolmarko@58
    46
			ADD_STATE(State_Func3_Called(reinterpret_cast<void*>(this)));
pavolmarko@58
    47
		}
pavolmarko@58
    48
	};
pavolmarko@58
    49
pavolmarko@58
    50
	SH_DECL_HOOK0_void(Derived, Func1, SH_NOATTRIB, 0);
pavolmarko@58
    51
	SH_DECL_HOOK0_void(Derived, Func2, SH_NOATTRIB, 0);
pavolmarko@58
    52
	SH_DECL_HOOK0_void(Derived, Func3, SH_NOATTRIB, 0);
pavolmarko@58
    53
	SH_DECL_HOOK0_void(Base1, Func1, SH_NOATTRIB, 0);
pavolmarko@58
    54
	SH_DECL_HOOK0_void(Base2, Func2, SH_NOATTRIB, 0);
pavolmarko@58
    55
pavolmarko@58
    56
	void Handler_Func1()
pavolmarko@58
    57
	{
pavolmarko@133
    58
		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
pavolmarko@58
    59
	}
pavolmarko@58
    60
	void Handler_Func2()
pavolmarko@58
    61
	{
pavolmarko@133
    62
		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void)));
pavolmarko@58
    63
	}
pavolmarko@58
    64
	void Handler_Func3()
pavolmarko@58
    65
	{
pavolmarko@133
    66
		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
pavolmarko@58
    67
	}
pavolmarko@387
    68
pavolmarko@387
    69
	Derived *MyInstanceFactory()
pavolmarko@387
    70
	{
pavolmarko@387
    71
		return new Derived;
pavolmarko@387
    72
	}
pavolmarko@58
    73
}
pavolmarko@58
    74
pavolmarko@58
    75
bool TestThisPtrOffs(std::string &error)
pavolmarko@58
    76
{
pavolmarko@162
    77
	GET_SHPTR(g_SHPtr);
pavolmarko@58
    78
	g_PLID = 1337;
pavolmarko@58
    79
pavolmarko@387
    80
	Derived *pD = MyInstanceFactory();
pavolmarko@58
    81
	Base1 *pB1 = pD;
pavolmarko@58
    82
	Base2 *pB2 = pD;
pavolmarko@58
    83
pavolmarko@387
    84
	CAutoPtrDestruction<Derived> apd(pD);
pavolmarko@387
    85
pavolmarko@387
    86
pavolmarko@58
    87
	// It should be:
pavolmarko@58
    88
	// pB1 = pD
pavolmarko@58
    89
	// pB2 > pB1
pavolmarko@58
    90
pavolmarko@58
    91
	// 1)
pavolmarko@58
    92
	//  Get a callclass for pD
pavolmarko@58
    93
	//  Verify whether the this pointers are correct
pavolmarko@58
    94
	//  Also call them normally to make sure that we aren't messing it up ;)
pavolmarko@380
    95
	SourceHook::CallClass<Derived> *pD_CC = SH_GET_CALLCLASS(pD);
pavolmarko@58
    96
pavolmarko@380
    97
	SH_CALL(pD_CC, &Derived::Func1)();
pavolmarko@380
    98
	SH_CALL(pD_CC, &Derived::Func2)();
pavolmarko@380
    99
	SH_CALL(pD_CC, &Derived::Func3)();
pavolmarko@58
   100
	pD->Func1();
pavolmarko@58
   101
	pD->Func2();
pavolmarko@58
   102
	pD->Func3();
pavolmarko@58
   103
pavolmarko@58
   104
	CHECK_STATES((&g_States,
pavolmarko@58
   105
		new State_Func1_Called(pB1),
pavolmarko@58
   106
		new State_Func2_Called(pB2),
pavolmarko@58
   107
		new State_Func3_Called(pD),
pavolmarko@58
   108
		new State_Func1_Called(pB1),
pavolmarko@58
   109
		new State_Func2_Called(pB2),
pavolmarko@58
   110
		new State_Func3_Called(pD),
pavolmarko@58
   111
		NULL), "Part 1");
pavolmarko@58
   112
pavolmarko@380
   113
	SH_CALL(pD_CC, &Base1::Func1)();
pavolmarko@380
   114
	SH_CALL(pD_CC, &Base2::Func2)();
pavolmarko@58
   115
pavolmarko@58
   116
	CHECK_STATES((&g_States,
pavolmarko@58
   117
		new State_Func1_Called(pB1),
pavolmarko@58
   118
		new State_Func2_Called(pB2),
pavolmarko@58
   119
		NULL), "Part 1.1");
pavolmarko@58
   120
pavolmarko@58
   121
	// 2)
pavolmarko@58
   122
	//   Get callclasses for the other ones and verify it as well
pavolmarko@58
   123
pavolmarko@380
   124
	SourceHook::CallClass<Base1> *pB1_CC = SH_GET_CALLCLASS(pB1);
pavolmarko@380
   125
	SourceHook::CallClass<Base2> *pB2_CC = SH_GET_CALLCLASS(pB2);
pavolmarko@380
   126
pavolmarko@380
   127
	SH_CALL(pB1_CC, &Base1::Func1)();
pavolmarko@380
   128
	SH_CALL(pB2_CC, &Base2::Func2)();
pavolmarko@58
   129
pavolmarko@58
   130
	CHECK_STATES((&g_States,
pavolmarko@58
   131
		new State_Func1_Called(pB1),
pavolmarko@58
   132
		new State_Func2_Called(pB2),
pavolmarko@58
   133
		NULL), "Part 2");
pavolmarko@58
   134
pavolmarko@58
   135
pavolmarko@58
   136
	// 3) Add hooks on them (referring to them through pD1 / Derived)
pavolmarko@58
   137
	//   Check whether the hooks are called with the correct this pointer
pavolmarko@58
   138
pavolmarko@324
   139
	SH_ADD_HOOK(Derived, Func1, pD, SH_STATIC(Handler_Func1), false);
pavolmarko@324
   140
	SH_ADD_HOOK(Derived, Func2, pD, SH_STATIC(Handler_Func2), false);
pavolmarko@324
   141
	SH_ADD_HOOK(Derived, Func3, pD, SH_STATIC(Handler_Func3), false);
pavolmarko@58
   142
pavolmarko@58
   143
	pD->Func1();
pavolmarko@58
   144
	pD->Func2();
pavolmarko@58
   145
	pD->Func3();
pavolmarko@58
   146
	pB1->Func1();
pavolmarko@58
   147
	pB2->Func2();
pavolmarko@58
   148
pavolmarko@58
   149
	// The handlers should always be called with the pointer to Derived
pavolmarko@58
   150
	CHECK_STATES((&g_States,
pavolmarko@58
   151
		new State_Func1H_Called(pD),
pavolmarko@58
   152
		new State_Func1_Called(pB1),
pavolmarko@58
   153
		new State_Func2H_Called(pD),
pavolmarko@58
   154
		new State_Func2_Called(pB2),
pavolmarko@58
   155
		new State_Func3H_Called(pD),
pavolmarko@58
   156
		new State_Func3_Called(pD),
pavolmarko@58
   157
		new State_Func1H_Called(pD),
pavolmarko@58
   158
		new State_Func1_Called(pB1),
pavolmarko@58
   159
		new State_Func2H_Called(pD),
pavolmarko@58
   160
		new State_Func2_Called(pB2),
pavolmarko@58
   161
		NULL), "Part 3");
pavolmarko@58
   162
pavolmarko@324
   163
	SH_REMOVE_HOOK(Derived, Func1, pD, SH_STATIC(Handler_Func1), false);
pavolmarko@324
   164
	SH_REMOVE_HOOK(Derived, Func2, pD, SH_STATIC(Handler_Func2), false);
pavolmarko@324
   165
	SH_REMOVE_HOOK(Derived, Func3, pD, SH_STATIC(Handler_Func3), false);
pavolmarko@58
   166
pavolmarko@58
   167
	// 4)
pavolmarko@58
   168
	//   Now add the hooks on Base1 and Base2 and check again
pavolmarko@58
   169
pavolmarko@58
   170
	// Note that the new implicit_cast should convert the pD to Base1*/Base2* :)
pavolmarko@324
   171
	SH_ADD_HOOK(Base1, Func1, pD, SH_STATIC(Handler_Func1), false);
pavolmarko@324
   172
	SH_ADD_HOOK(Base2, Func2, pD, SH_STATIC(Handler_Func2), false);
pavolmarko@324
   173
	SH_ADD_HOOK(Derived, Func3, pD, SH_STATIC(Handler_Func3), false);
pavolmarko@58
   174
pavolmarko@58
   175
	pD->Func1();
pavolmarko@58
   176
	pD->Func2();
pavolmarko@58
   177
	pD->Func3();
pavolmarko@58
   178
	pB1->Func1();
pavolmarko@58
   179
	pB2->Func2();
pavolmarko@58
   180
pavolmarko@58
   181
	// This time, the handlers for Func1 should be called with pB1 and the handlers
pavolmarko@58
   182
	// for Func2 should be called with pB2
pavolmarko@58
   183
	CHECK_STATES((&g_States,
pavolmarko@58
   184
		new State_Func1H_Called(pB1),
pavolmarko@58
   185
		new State_Func1_Called(pB1),
pavolmarko@58
   186
		new State_Func2H_Called(pB2),
pavolmarko@58
   187
		new State_Func2_Called(pB2),
pavolmarko@58
   188
		new State_Func3H_Called(pD),
pavolmarko@58
   189
		new State_Func3_Called(pD),
pavolmarko@58
   190
		new State_Func1H_Called(pB1),
pavolmarko@58
   191
		new State_Func1_Called(pB1),
pavolmarko@58
   192
		new State_Func2H_Called(pB2),
pavolmarko@58
   193
		new State_Func2_Called(pB2),
pavolmarko@58
   194
		NULL), "Part 4");
pavolmarko@58
   195
pavolmarko@324
   196
	SH_REMOVE_HOOK(Base1, Func1, pD, SH_STATIC(Handler_Func1), false);
pavolmarko@324
   197
	SH_REMOVE_HOOK(Base2, Func2, pD, SH_STATIC(Handler_Func2), false);
pavolmarko@324
   198
	SH_REMOVE_HOOK(Derived, Func3, pD, SH_STATIC(Handler_Func3), false);
pavolmarko@58
   199
pavolmarko@58
   200
pavolmarko@58
   201
	// 5)
pavolmarko@58
   202
	//   Add some hooks, and use callclasses
pavolmarko@58
   203
pavolmarko@58
   204
	// 5.1) First off, add all of them on pD
pavolmarko@324
   205
	SH_ADD_HOOK(Derived, Func1, pD, SH_STATIC(Handler_Func1), false);
pavolmarko@324
   206
	SH_ADD_HOOK(Derived, Func2, pD, SH_STATIC(Handler_Func2), false);
pavolmarko@324
   207
	SH_ADD_HOOK(Derived, Func3, pD, SH_STATIC(Handler_Func3), false);
pavolmarko@58
   208
pavolmarko@58
   209
	pD->Func1();
pavolmarko@58
   210
	pD->Func2();
pavolmarko@58
   211
	pD->Func3();
pavolmarko@58
   212
pavolmarko@58
   213
	CHECK_STATES((&g_States,
pavolmarko@58
   214
		new State_Func1H_Called(pD),
pavolmarko@58
   215
		new State_Func1_Called(pB1),
pavolmarko@58
   216
		new State_Func2H_Called(pD),
pavolmarko@58
   217
		new State_Func2_Called(pB2),
pavolmarko@58
   218
		new State_Func3H_Called(pD),
pavolmarko@58
   219
		new State_Func3_Called(pD),
pavolmarko@58
   220
		NULL), "Part 5.1");
pavolmarko@58
   221
pavolmarko@380
   222
	SH_CALL(pD_CC, &Derived::Func1)();
pavolmarko@380
   223
	SH_CALL(pD_CC, &Derived::Func2)();
pavolmarko@380
   224
	SH_CALL(pD_CC, &Derived::Func3)();
pavolmarko@380
   225
	SH_CALL(pB1_CC, &Base1::Func1)();
pavolmarko@380
   226
	SH_CALL(pB2_CC, &Base2::Func2)();
pavolmarko@58
   227
pavolmarko@58
   228
	CHECK_STATES((&g_States,
pavolmarko@58
   229
		new State_Func1_Called(pB1),
pavolmarko@58
   230
		new State_Func2_Called(pB2),
pavolmarko@58
   231
		new State_Func3_Called(pD),
pavolmarko@58
   232
		new State_Func1_Called(pB1),
pavolmarko@58
   233
		new State_Func2_Called(pB2),
pavolmarko@58
   234
		NULL), "Part 5.2");
pavolmarko@58
   235
pavolmarko@324
   236
	SH_REMOVE_HOOK(Derived, Func1, pD, SH_STATIC(Handler_Func1), false);
pavolmarko@324
   237
	SH_REMOVE_HOOK(Derived, Func2, pD, SH_STATIC(Handler_Func2), false);
pavolmarko@324
   238
	SH_REMOVE_HOOK(Derived, Func3, pD, SH_STATIC(Handler_Func3), false);
pavolmarko@58
   239
pavolmarko@380
   240
	SH_RELEASE_CALLCLASS(pB1_CC);
pavolmarko@380
   241
	SH_RELEASE_CALLCLASS(pB2_CC);
pavolmarko@380
   242
	SH_RELEASE_CALLCLASS(pD_CC);
pavolmarko@380
   243
pavolmarko@58
   244
	return true;
pavolmarko@59
   245
}