core/sourcehook/test/testrefret.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 539 db914129ae01
child 733 2365240861a2
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@234
     1
#include "testevents.h"
pavolmarko@234
     2
#include "sourcehook_test.h"
pavolmarko@234
     3
pavolmarko@234
     4
// Tests support for functions which return references
pavolmarko@234
     5
pavolmarko@234
     6
namespace
pavolmarko@234
     7
{
pavolmarko@234
     8
	StateList g_States;
pavolmarko@234
     9
	SourceHook::ISourceHook *g_SHPtr;
pavolmarko@234
    10
	SourceHook::Plugin g_PLID;
pavolmarko@234
    11
pavolmarko@234
    12
	MAKE_STATE_1(State_Func1_Pre1, int*);			// p1: the ref Func1_Pre1 is going to return
pavolmarko@234
    13
	MAKE_STATE_3(State_Func1_Pre2, META_RES, int*, int*);	// p1: current status
pavolmarko@234
    14
															// p2: override ret
pavolmarko@234
    15
															// p3: what this handler is going to supercede with
pavolmarko@234
    16
	MAKE_STATE_1(State_Func1, int*);				// p1: the ref Func1 is going to return
pavolmarko@234
    17
	MAKE_STATE_2(State_Func1_Post1, int*, int*);	// p1: orig_ret; p2: override_ret
pavolmarko@234
    18
	MAKE_STATE_1(State_Func1_Post2, int*);			// p1: what it's going to return
pavolmarko@234
    19
	MAKE_STATE_1(State_Func1_Ret, int*);			// p1: the ref it returned
pavolmarko@234
    20
pavolmarko@234
    21
pavolmarko@234
    22
	MAKE_STATE_2(State_Func2_Pre1, int, const int*);				// p1: func's p1; p2: what it's going to ret
pavolmarko@234
    23
	MAKE_STATE_2(State_Func2, int, const int*);						// p1: func's p1; p2: what it's going to ret
pavolmarko@234
    24
	MAKE_STATE_3(State_Func2_Post1, int, const int*, const int*);	// p1: func's p1; p2: orig ret; p3: override ret
pavolmarko@234
    25
	MAKE_STATE_1(State_Func2_Ret, const int*);						// p1: ret
pavolmarko@234
    26
pavolmarko@234
    27
	int g_Var;
pavolmarko@234
    28
pavolmarko@234
    29
	class Test
pavolmarko@234
    30
	{
pavolmarko@234
    31
	public:
pavolmarko@234
    32
		int m_Var1;
pavolmarko@234
    33
		int m_Var2;
pavolmarko@234
    34
pavolmarko@234
    35
		Test() : m_Var1(87)
pavolmarko@234
    36
		{
pavolmarko@234
    37
		}
pavolmarko@234
    38
pavolmarko@234
    39
		virtual int& Func1()
pavolmarko@234
    40
		{
pavolmarko@234
    41
			ADD_STATE(State_Func1(&m_Var1));
pavolmarko@234
    42
			return m_Var1;
pavolmarko@234
    43
		}
pavolmarko@234
    44
		virtual const int& Func2(int p1)
pavolmarko@234
    45
		{
pavolmarko@234
    46
			ADD_STATE(State_Func2(p1, &m_Var2));
pavolmarko@234
    47
			m_Var2 = p1;
pavolmarko@234
    48
			return m_Var2;
pavolmarko@234
    49
		}
pavolmarko@234
    50
	};
pavolmarko@234
    51
pavolmarko@234
    52
	class CHook
pavolmarko@234
    53
	{
pavolmarko@234
    54
	public:
pavolmarko@234
    55
		int m_Var;
pavolmarko@234
    56
		virtual int& Func1_Pre1()
pavolmarko@234
    57
		{
pavolmarko@234
    58
			ADD_STATE(State_Func1_Pre1(&m_Var));
pavolmarko@234
    59
			RETURN_META_VALUE(MRES_OVERRIDE, m_Var);
pavolmarko@234
    60
		}
pavolmarko@234
    61
		virtual int &Func1_Pre2()
pavolmarko@234
    62
		{
pavolmarko@234
    63
			int &overrideret = META_RESULT_OVERRIDE_RET(int&);
pavolmarko@234
    64
			overrideret = 1337;
pavolmarko@234
    65
			ADD_STATE(State_Func1_Pre2(META_RESULT_STATUS, &overrideret, &g_Var));
pavolmarko@234
    66
			RETURN_META_VALUE(MRES_SUPERCEDE, g_Var);
pavolmarko@234
    67
		}
pavolmarko@234
    68
		virtual int& Func1_Post1()
pavolmarko@234
    69
		{
pavolmarko@234
    70
			ADD_STATE(State_Func1_Post1(&META_RESULT_ORIG_RET(int&), &META_RESULT_OVERRIDE_RET(int&)));
pavolmarko@234
    71
			RETURN_META_NOREF(MRES_IGNORED, int&);
pavolmarko@234
    72
		}
pavolmarko@234
    73
		virtual int& Func1_Post2()
pavolmarko@234
    74
		{
pavolmarko@234
    75
			ADD_STATE(State_Func1_Post2(&m_Var));
pavolmarko@234
    76
			RETURN_META_VALUE(MRES_OVERRIDE, m_Var);
pavolmarko@234
    77
		}
pavolmarko@234
    78
pavolmarko@234
    79
		virtual const int& Func2_Pre1(int p1)
pavolmarko@234
    80
		{
pavolmarko@234
    81
			ADD_STATE(State_Func2_Pre1(p1, &m_Var));
pavolmarko@234
    82
			RETURN_META_VALUE_NEWPARAMS(MRES_OVERRIDE, m_Var, static_cast<const int& (Test::*)(int)>(&Test::Func2), (1337));
pavolmarko@234
    83
		}
pavolmarko@234
    84
pavolmarko@234
    85
		virtual const int& Func2_Post1(int p1)
pavolmarko@234
    86
		{
pavolmarko@234
    87
			ADD_STATE(State_Func2_Post1(p1, &META_RESULT_ORIG_RET(int&), &META_RESULT_OVERRIDE_RET(int&)));
pavolmarko@234
    88
			RETURN_META_NOREF(MRES_IGNORED, const int&);
pavolmarko@234
    89
		}
pavolmarko@234
    90
	};
pavolmarko@234
    91
pavolmarko@234
    92
	SH_DECL_HOOK0(Test, Func1, SH_NOATTRIB, 0, int&);
pavolmarko@234
    93
	SH_DECL_HOOK1(Test, Func2, SH_NOATTRIB, 0, const int&, int);
pavolmarko@387
    94
pavolmarko@387
    95
	Test *MyTestFactory()
pavolmarko@387
    96
	{
pavolmarko@387
    97
		return new Test;
pavolmarko@387
    98
	}
pavolmarko@234
    99
}
pavolmarko@234
   100
pavolmarko@234
   101
bool TestRefRet(std::string &error)
pavolmarko@234
   102
{
pavolmarko@234
   103
	GET_SHPTR(g_SHPtr);
pavolmarko@234
   104
	g_PLID = 1;
pavolmarko@234
   105
pavolmarko@387
   106
	Test *pTest = MyTestFactory();
pavolmarko@387
   107
	CAutoPtrDestruction<Test> apd(pTest);
pavolmarko@234
   108
	CHook hook;
pavolmarko@234
   109
pavolmarko@234
   110
	int &ret1 = pTest->Func1();
pavolmarko@234
   111
	ADD_STATE(State_Func1_Ret(&ret1));
pavolmarko@234
   112
pavolmarko@234
   113
	CHECK_STATES((&g_States,
pavolmarko@387
   114
		new State_Func1(&pTest->m_Var1),
pavolmarko@387
   115
		new State_Func1_Ret(&pTest->m_Var1),
pavolmarko@234
   116
		NULL), "Part 1");
pavolmarko@234
   117
pavolmarko@234
   118
	// Now add Func1_Pre1, which supercedes and returns hook.m_Var
pavolmarko@387
   119
	SH_ADD_HOOK(Test, Func1, pTest, SH_MEMBER(&hook, &CHook::Func1_Pre1), false);
pavolmarko@234
   120
pavolmarko@234
   121
	int &ret2 = pTest->Func1();
pavolmarko@234
   122
	ADD_STATE(State_Func1_Ret(&ret2));
pavolmarko@234
   123
	
pavolmarko@234
   124
	CHECK_STATES((&g_States,
pavolmarko@234
   125
		new State_Func1_Pre1(&hook.m_Var),		// Pre1 says that it's going to override with hook.m_Var
pavolmarko@387
   126
		new State_Func1(&pTest->m_Var1),			// Function says that it's going to return pTest->m_Var1
pavolmarko@234
   127
		new State_Func1_Ret(&hook.m_Var),		// hook.m_Var is returned
pavolmarko@234
   128
		NULL), "Part 2");
pavolmarko@234
   129
pavolmarko@234
   130
	// Now add Func1_Post1, which only reports orig ret and override ret
pavolmarko@387
   131
	SH_ADD_HOOK(Test, Func1, pTest, SH_MEMBER(&hook, &CHook::Func1_Post1), true);
pavolmarko@234
   132
pavolmarko@234
   133
	int &ret3 = pTest->Func1();
pavolmarko@234
   134
	ADD_STATE(State_Func1_Ret(&ret3));
pavolmarko@234
   135
	
pavolmarko@234
   136
	CHECK_STATES((&g_States,
pavolmarko@234
   137
		new State_Func1_Pre1(&hook.m_Var),		// Pre1 says that it's going to override with hook.m_Var
pavolmarko@387
   138
		new State_Func1(&pTest->m_Var1),			// Function says that it's going to return pTest->m_Var1
pavolmarko@387
   139
		new State_Func1_Post1(&pTest->m_Var1, &hook.m_Var),	// origret(=p1) is what it wanted to
pavolmarko@234
   140
															// return, overrideret(=p2) is pre1's var
pavolmarko@234
   141
		new State_Func1_Ret(&hook.m_Var),		// hook.m_Var is returned
pavolmarko@234
   142
		NULL), "Part 3");
pavolmarko@234
   143
pavolmarko@234
   144
	// Now add Func1_Pre2, which supercedes and returns g_Var (it also sets the override ret from pre1 to 1337)
pavolmarko@234
   145
	// and add Func1_Post2, which overrides and returns hook.m_Var again.
pavolmarko@234
   146
pavolmarko@387
   147
	SH_ADD_HOOK(Test, Func1, pTest, SH_MEMBER(&hook, &CHook::Func1_Pre2), false);
pavolmarko@387
   148
	SH_ADD_HOOK(Test, Func1, pTest, SH_MEMBER(&hook, &CHook::Func1_Post2), true);
pavolmarko@234
   149
pavolmarko@234
   150
	int &ret4 = pTest->Func1();
pavolmarko@234
   151
	ADD_STATE(State_Func1_Ret(&ret4));
pavolmarko@234
   152
pavolmarko@234
   153
	CHECK_STATES((&g_States,
pavolmarko@234
   154
		new State_Func1_Pre1(&hook.m_Var),		// Pre1 says that it's going to override with hook.m_Var
pavolmarko@234
   155
		new State_Func1_Pre2(MRES_OVERRIDE,			// current status
pavolmarko@234
   156
							&hook.m_Var,			// override ret (which it set to 1337)
pavolmarko@234
   157
							&g_Var),				// what it's going to ret, AND supercede with
pavolmarko@234
   158
pavolmarko@234
   159
		new State_Func1_Post1(&g_Var, &g_Var),	// origret(=p1) is what pre2 superceded with,
pavolmarko@234
   160
												//  so  overrideret(=p2) has to be the same
pavolmarko@234
   161
		new State_Func1_Post2(&hook.m_Var),			// post2 is going to override with hook.m_Var again
pavolmarko@234
   162
		new State_Func1_Ret(&hook.m_Var),		// ==>>> hook.m_Var is returned
pavolmarko@234
   163
		NULL), "Part 4");
pavolmarko@234
   164
pavolmarko@234
   165
	CHECK_COND(hook.m_Var == 1337, "Part 4.1");
pavolmarko@234
   166
	
pavolmarko@234
   167
	// Through a callclass
pavolmarko@387
   168
	SourceHook::CallClass<Test> *cc1 = SH_GET_CALLCLASS(pTest);
pavolmarko@380
   169
	int &ret5 = SH_CALL(cc1, &Test::Func1)();
pavolmarko@234
   170
	ADD_STATE(State_Func1_Ret(&ret5));
pavolmarko@234
   171
pavolmarko@234
   172
	CHECK_STATES((&g_States,
pavolmarko@387
   173
		new State_Func1(&pTest->m_Var1),
pavolmarko@387
   174
		new State_Func1_Ret(&pTest->m_Var1),
pavolmarko@234
   175
		NULL), "Part 5");
pavolmarko@234
   176
pavolmarko@380
   177
	SH_RELEASE_CALLCLASS(cc1);
pavolmarko@234
   178
pavolmarko@234
   179
	////////////////////////////////////////////////////////////////////////////////////////
pavolmarko@234
   180
	// Func2 tests
pavolmarko@234
   181
	const int &ret21 = pTest->Func2(500);
pavolmarko@234
   182
	ADD_STATE(State_Func2_Ret(&ret21));
pavolmarko@234
   183
pavolmarko@234
   184
	CHECK_STATES((&g_States,
pavolmarko@387
   185
		new State_Func2(500, &pTest->m_Var2),
pavolmarko@387
   186
		new State_Func2_Ret(&pTest->m_Var2),
pavolmarko@234
   187
		NULL), "Part 6");
pavolmarko@234
   188
pavolmarko@387
   189
	SH_ADD_HOOK(Test, Func2, pTest, SH_MEMBER(&hook, &CHook::Func2_Pre1), false);
pavolmarko@387
   190
	SH_ADD_HOOK(Test, Func2, pTest, SH_MEMBER(&hook, &CHook::Func2_Post1), true);
pavolmarko@234
   191
pavolmarko@234
   192
	const int &ret22 = pTest->Func2(500);
pavolmarko@234
   193
	ADD_STATE(State_Func2_Ret(&ret22));
pavolmarko@234
   194
pavolmarko@234
   195
	CHECK_STATES((&g_States,
pavolmarko@234
   196
		new State_Func2_Pre1(500, &hook.m_Var),		// p1 was 500; it's going to override with hook.m_Var; and also change p1 to 1337
pavolmarko@387
   197
		new State_Func2(1337, &pTest->m_Var2),		// p1 was 1337; it's going to ret pTest->m_Var2
pavolmarko@234
   198
		new State_Func2_Post1(1337,					// p1 was 1337
pavolmarko@387
   199
			&pTest->m_Var2,							// orig ret was pTest->m_Var2
pavolmarko@234
   200
			&hook.m_Var),							// override ret was hook.m_Var
pavolmarko@234
   201
		new State_Func2_Ret(&hook.m_Var),			// really returned hook.m_Var
pavolmarko@234
   202
		NULL), "Part 7");
pavolmarko@234
   203
	
pavolmarko@234
   204
   	return true;
pavolmarko@234
   205
}