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