core/sourcehook/test/testrecall.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@162
     1
#include <string>
pavolmarko@162
     2
#include "sourcehook.h"
pavolmarko@162
     3
#include "sourcehook_test.h"
pavolmarko@162
     4
#include "testevents.h"
pavolmarko@162
     5
pavolmarko@162
     6
// TESTRECALL
pavolmarko@162
     7
// Test modifying parameters from hook handlers
pavolmarko@162
     8
pavolmarko@162
     9
namespace
pavolmarko@162
    10
{
pavolmarko@162
    11
	StateList g_States;
pavolmarko@162
    12
	SourceHook::ISourceHook *g_SHPtr;
pavolmarko@162
    13
	SourceHook::Plugin g_PLID;
pavolmarko@162
    14
pavolmarko@162
    15
	MAKE_STATE_1(State_Func1, int);
pavolmarko@162
    16
	MAKE_STATE_1(State_H1_Func1, int);
pavolmarko@162
    17
	MAKE_STATE_1(State_H2_Func1, int);
pavolmarko@162
    18
	MAKE_STATE_2(State_HP_Func1, int, void*);
pavolmarko@162
    19
pavolmarko@162
    20
	MAKE_STATE_1(State_Func2, int);
pavolmarko@162
    21
	MAKE_STATE_1(State_H1_Func2, int);
pavolmarko@179
    22
	MAKE_STATE_1(State_H2_Func2, int);
pavolmarko@162
    23
	MAKE_STATE_2(State_HP_Func2, int, int);
pavolmarko@162
    24
pavolmarko@179
    25
	MAKE_STATE_2(State_Func22, int, int);
pavolmarko@179
    26
	MAKE_STATE_2(State_H1_Func22, int, int);
pavolmarko@179
    27
	MAKE_STATE_2(State_HP1_Func22, int, int);
pavolmarko@179
    28
	MAKE_STATE_2(State_HP2_Func22, int, int);
pavolmarko@179
    29
pavolmarko@162
    30
	struct Test
pavolmarko@162
    31
	{
pavolmarko@162
    32
		virtual void Func1(int a)
pavolmarko@162
    33
		{
pavolmarko@162
    34
			ADD_STATE(State_Func1(a));
pavolmarko@162
    35
		}
pavolmarko@162
    36
pavolmarko@162
    37
		virtual int Func2(int a)
pavolmarko@162
    38
		{
pavolmarko@162
    39
			ADD_STATE(State_Func2(a));
pavolmarko@162
    40
			return 1000;
pavolmarko@162
    41
		}
pavolmarko@163
    42
pavolmarko@163
    43
		// Overloaded version
pavolmarko@163
    44
		virtual int Func2(int a, int b)
pavolmarko@163
    45
		{
pavolmarko@179
    46
			ADD_STATE(State_Func22(a, b));
pavolmarko@163
    47
			return 0xDEADFC;
pavolmarko@163
    48
		}
pavolmarko@162
    49
	};
pavolmarko@162
    50
pavolmarko@162
    51
	void Handler1_Func1(int a)
pavolmarko@162
    52
	{
pavolmarko@162
    53
		ADD_STATE(State_H1_Func1(a));
pavolmarko@163
    54
		RETURN_META_NEWPARAMS(MRES_IGNORED, &Test::Func1, (5));
pavolmarko@162
    55
	}
pavolmarko@162
    56
	void Handler2_Func1(int a)
pavolmarko@162
    57
	{
pavolmarko@162
    58
		ADD_STATE(State_H2_Func1(a));
pavolmarko@163
    59
		RETURN_META_NEWPARAMS(MRES_IGNORED, &Test::Func1, (a - 5));
pavolmarko@162
    60
	}
pavolmarko@162
    61
	void HandlerPost_Func1(int a)
pavolmarko@162
    62
	{
pavolmarko@162
    63
		ADD_STATE(State_HP_Func1(a, META_IFACEPTR(void)));
pavolmarko@162
    64
	}
pavolmarko@162
    65
pavolmarko@162
    66
pavolmarko@162
    67
	int Handler1_Func2(int a)
pavolmarko@162
    68
	{
pavolmarko@162
    69
		ADD_STATE(State_H1_Func2(a));
pavolmarko@163
    70
		// Pfeeehhh, ugly, I know, but I had to test it :)
pavolmarko@163
    71
		RETURN_META_VALUE_NEWPARAMS(MRES_OVERRIDE, 500, 
pavolmarko@163
    72
			static_cast<int (Test::*)(int)>(&Test::Func2), (a - 10));
pavolmarko@162
    73
	}
pavolmarko@162
    74
pavolmarko@179
    75
	int Handler2_Func2(int a)
pavolmarko@179
    76
	{
pavolmarko@179
    77
		ADD_STATE(State_H2_Func2(a));
pavolmarko@179
    78
		RETURN_META_VALUE_NEWPARAMS(MRES_IGNORED, 0, 
pavolmarko@179
    79
			static_cast<int (Test::*)(int)>(&Test::Func2), (a - 10));
pavolmarko@179
    80
	}
pavolmarko@179
    81
pavolmarko@162
    82
	int HandlerPost_Func2(int a)
pavolmarko@162
    83
	{
pavolmarko@162
    84
		ADD_STATE(State_HP_Func2(a, META_RESULT_ORIG_RET(int)));
pavolmarko@162
    85
		RETURN_META_VALUE(MRES_IGNORED, 0);
pavolmarko@162
    86
	}
pavolmarko@162
    87
pavolmarko@179
    88
	int Handler1_Func22(int a, int b)
pavolmarko@179
    89
	{
pavolmarko@179
    90
		ADD_STATE(State_H1_Func22(a, b));
pavolmarko@179
    91
		RETURN_META_VALUE(MRES_IGNORED, 0);
pavolmarko@179
    92
	}
pavolmarko@179
    93
pavolmarko@179
    94
	int HandlerPost1_Func22(int a, int b)
pavolmarko@179
    95
	{
pavolmarko@179
    96
		ADD_STATE(State_HP1_Func22(a, b));
pavolmarko@179
    97
		RETURN_META_VALUE_NEWPARAMS(MRES_IGNORED, 0, static_cast<int (Test::*)(int, int)>(&Test::Func2), (1, 2));
pavolmarko@179
    98
	}
pavolmarko@179
    99
pavolmarko@179
   100
	int HandlerPost1A_Func22(int a, int b)
pavolmarko@179
   101
	{
pavolmarko@179
   102
		ADD_STATE(State_HP1_Func22(a, b));
pavolmarko@179
   103
		RETURN_META_VALUE_NEWPARAMS(MRES_OVERRIDE, 0, static_cast<int (Test::*)(int, int)>(&Test::Func2), (1, 2));
pavolmarko@179
   104
	}
pavolmarko@179
   105
pavolmarko@179
   106
	int HandlerPost2_Func22(int a, int b)
pavolmarko@179
   107
	{
pavolmarko@179
   108
		ADD_STATE(State_HP2_Func22(a, b));
pavolmarko@179
   109
		RETURN_META_VALUE(MRES_IGNORED, 0);
pavolmarko@179
   110
	}
pavolmarko@179
   111
pavolmarko@162
   112
	SH_DECL_HOOK1_void(Test, Func1, SH_NOATTRIB, 0, int);
pavolmarko@162
   113
	SH_DECL_HOOK1(Test, Func2, SH_NOATTRIB, 0, int, int);
pavolmarko@179
   114
	SH_DECL_HOOK2(Test, Func2, SH_NOATTRIB, 1, int, int, int);
pavolmarko@387
   115
pavolmarko@387
   116
	Test *MyTestFactory()
pavolmarko@387
   117
	{
pavolmarko@387
   118
		return new Test;
pavolmarko@387
   119
	}
pavolmarko@162
   120
}
pavolmarko@162
   121
pavolmarko@162
   122
bool TestRecall(std::string &error)
pavolmarko@162
   123
{
pavolmarko@162
   124
	GET_SHPTR(g_SHPtr);
pavolmarko@162
   125
	g_PLID = 1337;
pavolmarko@162
   126
pavolmarko@387
   127
	Test *ptr = MyTestFactory();
pavolmarko@387
   128
	CAutoPtrDestruction<Test> apd(ptr);
pavolmarko@162
   129
pavolmarko@324
   130
	SH_ADD_HOOK(Test, Func1, ptr, SH_STATIC(Handler1_Func1), false);
pavolmarko@324
   131
	SH_ADD_HOOK(Test, Func1, ptr, SH_STATIC(Handler2_Func1), false);
pavolmarko@324
   132
	SH_ADD_HOOK(Test, Func1, ptr, SH_STATIC(HandlerPost_Func1), true);
pavolmarko@162
   133
pavolmarko@162
   134
	ptr->Func1(77);
pavolmarko@162
   135
pavolmarko@162
   136
	CHECK_STATES((&g_States,
pavolmarko@162
   137
		new State_H1_Func1(77),
pavolmarko@162
   138
		new State_H2_Func1(5),
pavolmarko@162
   139
		new State_Func1(0),
pavolmarko@162
   140
		new State_HP_Func1(0, ptr),
pavolmarko@162
   141
		NULL), "Part 1");
pavolmarko@162
   142
pavolmarko@324
   143
	SH_REMOVE_HOOK(Test, Func1, ptr, SH_STATIC(Handler1_Func1), false);
pavolmarko@324
   144
	SH_ADD_HOOK(Test, Func1, ptr, SH_STATIC(Handler2_Func1), false);
pavolmarko@324
   145
	SH_ADD_HOOK(Test, Func1, ptr, SH_STATIC(Handler2_Func1), false);
pavolmarko@324
   146
	SH_ADD_HOOK(Test, Func1, ptr, SH_STATIC(Handler2_Func1), false);
pavolmarko@162
   147
pavolmarko@162
   148
	ptr->Func1(77);
pavolmarko@162
   149
pavolmarko@162
   150
	CHECK_STATES((&g_States,
pavolmarko@162
   151
		new State_H2_Func1(77),
pavolmarko@162
   152
		new State_H2_Func1(72),
pavolmarko@162
   153
		new State_H2_Func1(67),
pavolmarko@162
   154
		new State_H2_Func1(62),
pavolmarko@162
   155
		new State_Func1(57),
pavolmarko@162
   156
		new State_HP_Func1(57, ptr),
pavolmarko@162
   157
		NULL), "Part 2");
pavolmarko@162
   158
pavolmarko@324
   159
	SH_REMOVE_HOOK(Test, Func1, ptr, SH_STATIC(Handler2_Func1), false);
pavolmarko@324
   160
	SH_REMOVE_HOOK(Test, Func1, ptr, SH_STATIC(HandlerPost_Func1), true);
pavolmarko@162
   161
pavolmarko@162
   162
	ptr->Func1(77);
pavolmarko@162
   163
pavolmarko@162
   164
	CHECK_STATES((&g_States,
pavolmarko@162
   165
		new State_Func1(77),
pavolmarko@162
   166
		NULL), "Part 3");
pavolmarko@162
   167
pavolmarko@162
   168
	// Func2
pavolmarko@162
   169
pavolmarko@324
   170
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(Handler1_Func2), false);
pavolmarko@324
   171
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost_Func2), true);
pavolmarko@162
   172
pavolmarko@162
   173
	int a = ptr->Func2(77);
pavolmarko@162
   174
	CHECK_STATES((&g_States,
pavolmarko@162
   175
		new State_H1_Func2(77),
pavolmarko@162
   176
		new State_Func2(67),
pavolmarko@162
   177
		new State_HP_Func2(67, 1000),			// 1000 because it's the ORIG_RET
pavolmarko@162
   178
		NULL), "Part 4");
pavolmarko@162
   179
pavolmarko@162
   180
	CHECK_COND(a == 500, "Part 4.1");
pavolmarko@162
   181
pavolmarko@179
   182
	// Func2, with other handler
pavolmarko@324
   183
	SH_REMOVE_HOOK(Test, Func2, ptr, SH_STATIC(Handler1_Func2), false);
pavolmarko@324
   184
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(Handler2_Func2), false);
pavolmarko@179
   185
pavolmarko@179
   186
	a = ptr->Func2(77);
pavolmarko@179
   187
	CHECK_STATES((&g_States,
pavolmarko@179
   188
		new State_H2_Func2(77),
pavolmarko@179
   189
		new State_Func2(67),
pavolmarko@179
   190
		new State_HP_Func2(67, 1000),			// 1000 because it's the ORIG_RET
pavolmarko@179
   191
		NULL), "Part 4.2");
pavolmarko@179
   192
pavolmarko@179
   193
	CHECK_COND(a == 1000, "Part 4.2.1");		// Should return 1000 as well.
pavolmarko@179
   194
pavolmarko@179
   195
	// Func22 -> post recalls
pavolmarko@179
   196
pavolmarko@179
   197
	// 1) WITH OVERRIDE
pavolmarko@179
   198
pavolmarko@324
   199
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(Handler1_Func22), false);
pavolmarko@324
   200
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost1A_Func22), true);
pavolmarko@324
   201
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost2_Func22), true);
pavolmarko@179
   202
	
pavolmarko@179
   203
	a = ptr->Func2(10, 11);
pavolmarko@179
   204
	CHECK_STATES((&g_States,
pavolmarko@179
   205
		new State_H1_Func22(10, 11),
pavolmarko@179
   206
		new State_Func22(10, 11),
pavolmarko@179
   207
		new State_HP1_Func22(10, 11),
pavolmarko@179
   208
		new State_HP2_Func22(1, 2),
pavolmarko@179
   209
		NULL), "Part 5");
pavolmarko@179
   210
pavolmarko@179
   211
	CHECK_COND(a == 0, "Part 5.1");
pavolmarko@179
   212
pavolmarko@179
   213
	// 2) WITH IGNORE
pavolmarko@324
   214
	SH_REMOVE_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost1A_Func22), true);
pavolmarko@324
   215
	SH_REMOVE_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost2_Func22), true);
pavolmarko@179
   216
pavolmarko@324
   217
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost1_Func22), true);
pavolmarko@324
   218
	SH_ADD_HOOK(Test, Func2, ptr, SH_STATIC(HandlerPost2_Func22), true);
pavolmarko@179
   219
pavolmarko@179
   220
	a = ptr->Func2(10, 11);
pavolmarko@179
   221
	CHECK_STATES((&g_States,
pavolmarko@179
   222
		new State_H1_Func22(10, 11),
pavolmarko@179
   223
		new State_Func22(10, 11),
pavolmarko@179
   224
		new State_HP1_Func22(10, 11),
pavolmarko@179
   225
		new State_HP2_Func22(1, 2),
pavolmarko@179
   226
		NULL), "Part 5");
pavolmarko@179
   227
pavolmarko@179
   228
	CHECK_COND(a == 0xDEADFC, "Part 5.1");
pavolmarko@179
   229
pavolmarko@162
   230
	return true;
pavolmarko@162
   231
}