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