core-legacy/sourcehook/test/testmanual.cpp
author David Anderson <dvander@alliedmods.net>
Wed Oct 28 23:14:32 2009 -0700 (2009-10-28)
changeset 659 b35a5fdbc654
parent 545 07e5df11f9fc
permissions -rw-r--r--
Merged PM's unreleased SourceHook-legacy, getting us VP hooks (bug 4019, r=ds).
dvander@541
     1
#include <string>
dvander@541
     2
#include "sourcehook.h"
dvander@541
     3
#include "sourcehook_test.h"
dvander@541
     4
#include "testevents.h"
dvander@541
     5
dvander@541
     6
// TESTMANUAL
dvander@541
     7
// Test manual hooks
dvander@541
     8
// :TODO: test more extensively
dvander@541
     9
dvander@541
    10
namespace
dvander@541
    11
{
dvander@541
    12
	StateList g_States;
dvander@541
    13
	SourceHook::ISourceHook *g_SHPtr;
dvander@541
    14
	SourceHook::Plugin g_PLID;
dvander@541
    15
dvander@541
    16
	MAKE_STATE_1(State_Func1_Called, void*);				// param1: This pointer
dvander@541
    17
	MAKE_STATE_2(State_Func2_Called, void*, int);			// param1: This pointer; param2: parameter
dvander@541
    18
	MAKE_STATE_1(State_Func3_Called, void*);				// param1: This pointer
dvander@541
    19
	MAKE_STATE_2(State_Func4_Called, void*, int);			// param1: This pointer; param2: parameter
dvander@541
    20
	MAKE_STATE_1(State_Func5_Called, void*);				// param1: This pointer
dvander@541
    21
dvander@541
    22
	MAKE_STATE_1(State_Func1H_Called, void*);
dvander@541
    23
	MAKE_STATE_2(State_Func2H_Called, void*, int);
dvander@541
    24
	MAKE_STATE_1(State_Func3H_Called, void*);
dvander@541
    25
	MAKE_STATE_2(State_Func4H_Called, void*, int);
dvander@541
    26
dvander@541
    27
	MAKE_STATE_1(State_Return, short);
dvander@541
    28
dvander@541
    29
	class TheWall
dvander@541
    30
	{
dvander@541
    31
	public:
dvander@541
    32
		virtual void Func1()
dvander@541
    33
		{
dvander@541
    34
			ADD_STATE(State_Func1_Called(reinterpret_cast<void*>(this)));
dvander@541
    35
		}
dvander@541
    36
		virtual void Func2(int x)
dvander@541
    37
		{
dvander@541
    38
			ADD_STATE(State_Func2_Called(reinterpret_cast<void*>(this), x));
dvander@541
    39
		}
dvander@541
    40
dvander@541
    41
		virtual short Func3()
dvander@541
    42
		{
dvander@541
    43
			ADD_STATE(State_Func3_Called(reinterpret_cast<void*>(this)));
dvander@541
    44
			return 3;
dvander@541
    45
		}
dvander@541
    46
		virtual short Func4(int x)
dvander@541
    47
		{
dvander@541
    48
			ADD_STATE(State_Func4_Called(reinterpret_cast<void*>(this), x));
dvander@541
    49
			return 4;
dvander@541
    50
		}
dvander@541
    51
		virtual void Func5()
dvander@541
    52
		{
dvander@541
    53
			ADD_STATE(State_Func5_Called(reinterpret_cast<void*>(this)));
dvander@541
    54
		}
dvander@659
    55
dvander@659
    56
	};
dvander@659
    57
	// GCC's optimizer is too good. I had to add this in order to make it execute a virtual table lookup!
dvander@659
    58
	class Whatever : public TheWall
dvander@659
    59
	{
dvander@541
    60
	};
dvander@541
    61
dvander@541
    62
	SH_DECL_HOOK0_void(TheWall, Func1, SH_NOATTRIB, 0);
dvander@541
    63
	SH_DECL_HOOK1_void(TheWall, Func2, SH_NOATTRIB, 0, int);
dvander@541
    64
	SH_DECL_HOOK0(TheWall, Func3, SH_NOATTRIB, 0, short);
dvander@541
    65
	SH_DECL_HOOK1(TheWall, Func4, SH_NOATTRIB, 0, short, int);
dvander@541
    66
dvander@541
    67
	SH_DECL_MANUALHOOK0_void(TheWall_Func1, 0, 0, 0);
dvander@541
    68
	SH_DECL_MANUALHOOK1_void(TheWall_Func2, 1, 0, 0, int);
dvander@541
    69
	SH_DECL_MANUALHOOK0(TheWall_Func3, 2, 0, 0, short);
dvander@541
    70
	SH_DECL_MANUALHOOK1(TheWall_Func4, 3, 0, 0, short, int);
dvander@541
    71
dvander@541
    72
	typedef void (SourceHook::EmptyClass::*MFP_Func1)();
dvander@541
    73
	typedef void (SourceHook::EmptyClass::*MFP_Func2)(int);
dvander@541
    74
	typedef short (SourceHook::EmptyClass::*MFP_Func3)();
dvander@541
    75
	typedef short (SourceHook::EmptyClass::*MFP_Func4)(int);
dvander@541
    76
dvander@541
    77
	void Handler_Func1()
dvander@541
    78
	{
dvander@541
    79
		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
dvander@541
    80
	}
dvander@541
    81
	void Handler_Func2(int x)
dvander@541
    82
	{
dvander@541
    83
		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
dvander@541
    84
		RETURN_META_MNEWPARAMS(MRES_IGNORED, TheWall_Func2, (0x87654321));
dvander@541
    85
	}
dvander@541
    86
	short Handler_Func3()
dvander@541
    87
	{
dvander@541
    88
		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
dvander@541
    89
		return 0;
dvander@541
    90
	}
dvander@541
    91
	short Handler_Func4(int x)
dvander@541
    92
	{
dvander@541
    93
		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
dvander@541
    94
dvander@541
    95
		// newparams (recall) using the manual hook declaration!
dvander@541
    96
		RETURN_META_VALUE_MNEWPARAMS(MRES_IGNORED, 0, TheWall_Func4, (0x12345678));
dvander@541
    97
	}
dvander@541
    98
dvander@541
    99
	struct AnotherBrick
dvander@541
   100
	{
dvander@541
   101
		void Handler_Func1()
dvander@541
   102
		{
dvander@541
   103
			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
dvander@541
   104
			RETURN_META(MRES_SUPERCEDE);
dvander@541
   105
		}
dvander@541
   106
	};
dvander@541
   107
}
dvander@541
   108
dvander@541
   109
bool TestManual(std::string &error)
dvander@541
   110
{
dvander@541
   111
	GET_SHPTR(g_SHPtr);
dvander@541
   112
	g_PLID = 1337;
dvander@541
   113
dvander@659
   114
	Whatever inst;
dvander@541
   115
	TheWall *p = &inst;
dvander@541
   116
dvander@541
   117
	// 1)
dvander@541
   118
	// Call each function
dvander@541
   119
	p->Func1();
dvander@541
   120
	p->Func2(200);
dvander@541
   121
	ADD_STATE(State_Return(p->Func3()));
dvander@541
   122
	ADD_STATE(State_Return(p->Func4(400)));
dvander@541
   123
dvander@541
   124
	CHECK_STATES((&g_States,
dvander@541
   125
		new State_Func1_Called(p),
dvander@541
   126
		new State_Func2_Called(p, 200),
dvander@541
   127
		new State_Func3_Called(p),
dvander@541
   128
		new State_Return(3),
dvander@541
   129
		new State_Func4_Called(p, 400),
dvander@541
   130
		new State_Return(4),
dvander@541
   131
		NULL), "Part 1");
dvander@541
   132
dvander@541
   133
	// 1.1)
dvander@541
   134
	// Now call each function through the manual call class, using the hook decl and manually
dvander@659
   135
	SH_MCALL(p, TheWall_Func1)();
dvander@659
   136
	SH_MCALL2(p, MFP_Func1(), 0, 0, 0)();
dvander@659
   137
	SH_MCALL(p, TheWall_Func2)(200);
dvander@659
   138
	SH_MCALL2(p, MFP_Func2(), 1, 0, 0)(200);
dvander@659
   139
	ADD_STATE(State_Return(SH_MCALL(p, TheWall_Func3)()));
dvander@659
   140
	ADD_STATE(State_Return(SH_MCALL2(p, MFP_Func3(), 2, 0, 0)()));
dvander@659
   141
	ADD_STATE(State_Return(SH_MCALL(p, TheWall_Func4)(400)));
dvander@659
   142
	ADD_STATE(State_Return(SH_MCALL2(p, MFP_Func4(), 3, 0, 0)(400)));
dvander@541
   143
dvander@541
   144
	CHECK_STATES((&g_States,
dvander@541
   145
		new State_Func1_Called(p),
dvander@541
   146
		new State_Func1_Called(p),
dvander@541
   147
		new State_Func2_Called(p, 200),
dvander@541
   148
		new State_Func2_Called(p, 200),
dvander@541
   149
		new State_Func3_Called(p),
dvander@541
   150
		new State_Return(3),
dvander@541
   151
		new State_Func3_Called(p),
dvander@541
   152
		new State_Return(3),
dvander@541
   153
		new State_Func4_Called(p, 400),
dvander@541
   154
		new State_Return(4),
dvander@541
   155
		new State_Func4_Called(p, 400),
dvander@541
   156
		new State_Return(4),
dvander@541
   157
		NULL), "Part 1.1");
dvander@541
   158
dvander@659
   159
	// Compat: really get a manual call class!
dvander@659
   160
	SourceHook::ManualCallClass *pCC = SH_GET_MCALLCLASS(p, sizeof(void*));
dvander@659
   161
	SH_MCALL(pCC, TheWall_Func1)();
dvander@659
   162
	SH_MCALL2(pCC, MFP_Func1(), 0, 0, 0)();
dvander@659
   163
	CHECK_STATES((&g_States,
dvander@659
   164
		new State_Func1_Called(p),
dvander@659
   165
		new State_Func1_Called(p),
dvander@659
   166
		NULL), "Part 1.2");
dvander@659
   167
dvander@659
   168
	SH_RELEASE_CALLCLASS(pCC);
dvander@659
   169
dvander@541
   170
	// 2)
dvander@541
   171
	// Hook each function normally, call them
dvander@659
   172
	SH_ADD_HOOK(TheWall, Func1, p, SH_STATIC(Handler_Func1), false);
dvander@659
   173
	SH_ADD_HOOK(TheWall, Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   174
	SH_ADD_HOOK(TheWall, Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   175
	SH_ADD_HOOK(TheWall, Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   176
dvander@541
   177
	p->Func1();
dvander@541
   178
	p->Func2(200);
dvander@541
   179
	ADD_STATE(State_Return(p->Func3()));
dvander@541
   180
	ADD_STATE(State_Return(p->Func4(400)));
dvander@541
   181
dvander@541
   182
	CHECK_STATES((&g_States,
dvander@541
   183
		new State_Func1H_Called(p),
dvander@541
   184
		new State_Func1_Called(p),
dvander@541
   185
		new State_Func2H_Called(p, 200),
dvander@541
   186
		new State_Func2_Called(p, 0x87654321),
dvander@541
   187
		new State_Func3H_Called(p),
dvander@541
   188
		new State_Func3_Called(p),
dvander@541
   189
		new State_Return(3),
dvander@541
   190
		new State_Func4H_Called(p, 400),
dvander@541
   191
		new State_Func4_Called(p, 0x12345678),
dvander@541
   192
		new State_Return(4),
dvander@541
   193
		NULL), "Part 2");
dvander@541
   194
dvander@541
   195
	// Call them through the mcallclass
dvander@541
   196
	// 2.1)
dvander@541
   197
	// Now call each function through the manual call class, using the hook decl and manually
dvander@659
   198
	SH_MCALL(p, TheWall_Func1)();
dvander@659
   199
	SH_MCALL2(p, MFP_Func1(), 0, 0, 0)();
dvander@659
   200
	SH_MCALL(p, TheWall_Func2)(200);
dvander@659
   201
	SH_MCALL2(p, MFP_Func2(), 1, 0, 0)(200);
dvander@659
   202
	ADD_STATE(State_Return(SH_MCALL(p, TheWall_Func3)()));
dvander@659
   203
	ADD_STATE(State_Return(SH_MCALL2(p, MFP_Func3(), 2, 0, 0)()));
dvander@659
   204
	ADD_STATE(State_Return(SH_MCALL(p, TheWall_Func4)(400)));
dvander@659
   205
	ADD_STATE(State_Return(SH_MCALL2(p, MFP_Func4(), 3, 0, 0)(400)));
dvander@541
   206
dvander@541
   207
	CHECK_STATES((&g_States,
dvander@541
   208
		new State_Func1_Called(p),
dvander@541
   209
		new State_Func1_Called(p),
dvander@541
   210
		new State_Func2_Called(p, 200),
dvander@541
   211
		new State_Func2_Called(p, 200),
dvander@541
   212
		new State_Func3_Called(p),
dvander@541
   213
		new State_Return(3),
dvander@541
   214
		new State_Func3_Called(p),
dvander@541
   215
		new State_Return(3),
dvander@541
   216
		new State_Func4_Called(p, 400),
dvander@541
   217
		new State_Return(4),
dvander@541
   218
		new State_Func4_Called(p, 400),
dvander@541
   219
		new State_Return(4),
dvander@541
   220
		NULL), "Part 2.1");
dvander@541
   221
dvander@541
   222
	// Unhook them
dvander@659
   223
	SH_REMOVE_HOOK(TheWall, Func1, p, SH_STATIC(Handler_Func1), false);
dvander@659
   224
	SH_REMOVE_HOOK(TheWall, Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   225
	SH_REMOVE_HOOK(TheWall, Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   226
	SH_REMOVE_HOOK(TheWall, Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   227
dvander@541
   228
	// 3)
dvander@541
   229
	// Hook each function manually, call them
dvander@541
   230
dvander@659
   231
	SH_ADD_MANUALHOOK(TheWall_Func1, p, SH_STATIC(Handler_Func1), false);
dvander@659
   232
	SH_ADD_MANUALHOOK(TheWall_Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   233
	SH_ADD_MANUALHOOK(TheWall_Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   234
	SH_ADD_MANUALHOOK(TheWall_Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   235
dvander@541
   236
	p->Func1();
dvander@541
   237
	p->Func2(200);
dvander@541
   238
	ADD_STATE(State_Return(p->Func3()));
dvander@541
   239
	ADD_STATE(State_Return(p->Func4(400)));
dvander@541
   240
dvander@541
   241
	CHECK_STATES((&g_States,
dvander@541
   242
		new State_Func1H_Called(p),
dvander@541
   243
		new State_Func1_Called(p),
dvander@541
   244
		new State_Func2H_Called(p, 200),
dvander@541
   245
		new State_Func2_Called(p, 0x87654321),
dvander@541
   246
		new State_Func3H_Called(p),
dvander@541
   247
		new State_Func3_Called(p),
dvander@541
   248
		new State_Return(3),
dvander@541
   249
		new State_Func4H_Called(p, 400),
dvander@541
   250
		new State_Func4_Called(p, 0x12345678),
dvander@541
   251
		new State_Return(4),
dvander@541
   252
		NULL), "Part 3");
dvander@541
   253
dvander@541
   254
	// Now through the mcallclass
dvander@541
   255
dvander@541
   256
	// Call them through the mcallclass
dvander@541
   257
	// 3.1)
dvander@541
   258
	// Now call each function through the manual call class, using the hook decl and manually
dvander@659
   259
	SH_MCALL(p, TheWall_Func1)();
dvander@659
   260
	SH_MCALL2(p, MFP_Func1(), 0, 0, 0)();
dvander@659
   261
	SH_MCALL(p, TheWall_Func2)(200);
dvander@659
   262
	SH_MCALL2(p, MFP_Func2(), 1, 0, 0)(200);
dvander@659
   263
	ADD_STATE(State_Return(SH_MCALL(p, TheWall_Func3)()));
dvander@659
   264
	ADD_STATE(State_Return(SH_MCALL2(p, MFP_Func3(), 2, 0, 0)()));
dvander@659
   265
	ADD_STATE(State_Return(SH_MCALL(p, TheWall_Func4)(400)));
dvander@659
   266
	ADD_STATE(State_Return(SH_MCALL2(p, MFP_Func4(), 3, 0, 0)(400)));
dvander@541
   267
dvander@541
   268
	CHECK_STATES((&g_States,
dvander@541
   269
		new State_Func1_Called(p),
dvander@541
   270
		new State_Func1_Called(p),
dvander@541
   271
		new State_Func2_Called(p, 200),
dvander@541
   272
		new State_Func2_Called(p, 200),
dvander@541
   273
		new State_Func3_Called(p),
dvander@541
   274
		new State_Return(3),
dvander@541
   275
		new State_Func3_Called(p),
dvander@541
   276
		new State_Return(3),
dvander@541
   277
		new State_Func4_Called(p, 400),
dvander@541
   278
		new State_Return(4),
dvander@541
   279
		new State_Func4_Called(p, 400),
dvander@541
   280
		new State_Return(4),
dvander@541
   281
		NULL), "Part 3.1");
dvander@541
   282
dvander@541
   283
	// Unhook them
dvander@659
   284
	SH_REMOVE_MANUALHOOK(TheWall_Func1, p, SH_STATIC(Handler_Func1), false);
dvander@659
   285
	SH_REMOVE_MANUALHOOK(TheWall_Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   286
	SH_REMOVE_MANUALHOOK(TheWall_Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   287
	SH_REMOVE_MANUALHOOK(TheWall_Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   288
dvander@541
   289
	// 4)
dvander@541
   290
	// Hook each function manually, then normally, call, unhook
dvander@541
   291
dvander@541
   292
	AnotherBrick handler_inst;
dvander@541
   293
dvander@541
   294
	// Why this?
dvander@659
   295
	// 1) tests sh_add_manualhook
dvander@541
   296
	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
dvander@541
   297
	//    (because there are no attribs for manual hooks).
dvander@541
   298
	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
dvander@541
   299
	//    already was one for this vfnptr. This hook manager stored the pointer of the original
dvander@541
   300
	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
dvander@541
   301
	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
dvander@541
   302
	//    does) will supercede the second hook func from being called - thus bypassing the call
dvander@541
   303
	//    of the auto hook here.
dvander@659
   304
	SH_ADD_MANUALHOOK(TheWall_Func1, p, SH_MEMBER(&handler_inst, &AnotherBrick::Handler_Func1), false);
dvander@659
   305
	SH_ADD_MANUALHOOK(TheWall_Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   306
	SH_ADD_MANUALHOOK(TheWall_Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   307
	SH_ADD_MANUALHOOK(TheWall_Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   308
dvander@659
   309
	SH_ADD_HOOK(TheWall, Func1, p, SH_STATIC(Handler_Func1), false);
dvander@659
   310
	SH_ADD_HOOK(TheWall, Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   311
	SH_ADD_HOOK(TheWall, Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   312
	SH_ADD_HOOK(TheWall, Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   313
dvander@541
   314
	p->Func1();
dvander@541
   315
	p->Func2(200);
dvander@541
   316
	ADD_STATE(State_Return(p->Func3()));
dvander@541
   317
	ADD_STATE(State_Return(p->Func4(400)));
dvander@541
   318
dvander@541
   319
	CHECK_STATES((&g_States,
dvander@541
   320
		new State_Func1H_Called(p),
dvander@541
   321
		new State_Func1H_Called(p),
dvander@541
   322
		//new State_Func1_Called(p),
dvander@541
   323
		new State_Func2H_Called(p, 200),
dvander@541
   324
		new State_Func2H_Called(p, 0x87654321),
dvander@541
   325
		new State_Func2_Called(p, 0x87654321),
dvander@541
   326
		new State_Func3H_Called(p),
dvander@541
   327
		new State_Func3H_Called(p),
dvander@541
   328
		new State_Func3_Called(p),
dvander@541
   329
		new State_Return(3),
dvander@541
   330
		new State_Func4H_Called(p, 400),
dvander@541
   331
		new State_Func4H_Called(p, 0x12345678),
dvander@541
   332
		new State_Func4_Called(p, 0x12345678),
dvander@541
   333
		new State_Return(4),
dvander@541
   334
		NULL), "Part 4");
dvander@541
   335
dvander@659
   336
	SH_REMOVE_MANUALHOOK(TheWall_Func1, p, SH_MEMBER(&handler_inst, &AnotherBrick::Handler_Func1), false);
dvander@659
   337
	SH_REMOVE_MANUALHOOK(TheWall_Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   338
	SH_REMOVE_MANUALHOOK(TheWall_Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   339
	SH_REMOVE_MANUALHOOK(TheWall_Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   340
dvander@659
   341
	SH_REMOVE_HOOK(TheWall, Func1, p, SH_STATIC(Handler_Func1), false);
dvander@659
   342
	SH_REMOVE_HOOK(TheWall, Func2, p, SH_STATIC(Handler_Func2), false);
dvander@659
   343
	SH_REMOVE_HOOK(TheWall, Func3, p, SH_STATIC(Handler_Func3), false);
dvander@659
   344
	SH_REMOVE_HOOK(TheWall, Func4, p, SH_STATIC(Handler_Func4), false);
dvander@541
   345
dvander@541
   346
	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
dvander@541
   347
	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
dvander@659
   348
	SH_ADD_MANUALHOOK(TheWall_Func1, p, SH_STATIC(Handler_Func1), false);
dvander@541
   349
dvander@541
   350
	p->Func5();
dvander@541
   351
dvander@541
   352
	CHECK_STATES((&g_States,
dvander@541
   353
		new State_Func1H_Called(p),
dvander@541
   354
		new State_Func5_Called(p),
dvander@541
   355
		NULL), "Part 5");
dvander@541
   356
dvander@541
   357
	// 6) Test auto-remove on reconfig
dvander@541
   358
	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
dvander@541
   359
dvander@541
   360
	p->Func1();
dvander@541
   361
	p->Func5();
dvander@541
   362
	
dvander@541
   363
	CHECK_STATES((&g_States,
dvander@541
   364
		new State_Func1_Called(p),
dvander@541
   365
		new State_Func5_Called(p),
dvander@541
   366
		NULL), "Part 6");
dvander@541
   367
dvander@541
   368
	return true;
dvander@541
   369
}