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