sourcehook/test/testmanual.cpp
author David Anderson <dvander@alliedmods.net>
Tue Sep 18 20:03:47 2007 +0000 (2007-09-18)
branchsourcemm-1.6.0
changeset 347 e82968c21606
child 361 f34718303c8f
permissions -rw-r--r--
branched 1.4.2 to 1.6.0
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@347
    55
	};
dvander@347
    56
dvander@347
    57
	SH_DECL_HOOK0_void(TheWall, Func1, SH_NOATTRIB, 0);
dvander@347
    58
	SH_DECL_HOOK1_void(TheWall, Func2, SH_NOATTRIB, 0, int);
dvander@347
    59
	SH_DECL_HOOK0(TheWall, Func3, SH_NOATTRIB, 0, short);
dvander@347
    60
	SH_DECL_HOOK1(TheWall, Func4, SH_NOATTRIB, 0, short, int);
dvander@347
    61
dvander@347
    62
	SH_DECL_MANUALHOOK0_void(TheWall_Func1, 0, 0, 0);
dvander@347
    63
	SH_DECL_MANUALHOOK1_void(TheWall_Func2, 1, 0, 0, int);
dvander@347
    64
	SH_DECL_MANUALHOOK0(TheWall_Func3, 2, 0, 0, short);
dvander@347
    65
	SH_DECL_MANUALHOOK1(TheWall_Func4, 3, 0, 0, short, int);
dvander@347
    66
dvander@347
    67
	typedef void (SourceHook::EmptyClass::*MFP_Func1)();
dvander@347
    68
	typedef void (SourceHook::EmptyClass::*MFP_Func2)(int);
dvander@347
    69
	typedef short (SourceHook::EmptyClass::*MFP_Func3)();
dvander@347
    70
	typedef short (SourceHook::EmptyClass::*MFP_Func4)(int);
dvander@347
    71
dvander@347
    72
	void Handler_Func1()
dvander@347
    73
	{
dvander@347
    74
		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
dvander@347
    75
	}
dvander@347
    76
	void Handler_Func2(int x)
dvander@347
    77
	{
dvander@347
    78
		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
dvander@347
    79
		RETURN_META_MNEWPARAMS(MRES_IGNORED, TheWall_Func2, (0x87654321));
dvander@347
    80
	}
dvander@347
    81
	short Handler_Func3()
dvander@347
    82
	{
dvander@347
    83
		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
dvander@347
    84
		return 0;
dvander@347
    85
	}
dvander@347
    86
	short Handler_Func4(int x)
dvander@347
    87
	{
dvander@347
    88
		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
dvander@347
    89
dvander@347
    90
		// newparams (recall) using the manual hook declaration!
dvander@347
    91
		RETURN_META_VALUE_MNEWPARAMS(MRES_IGNORED, 0, TheWall_Func4, (0x12345678));
dvander@347
    92
	}
dvander@347
    93
dvander@347
    94
	struct AnotherBrick
dvander@347
    95
	{
dvander@347
    96
		void Handler_Func1()
dvander@347
    97
		{
dvander@347
    98
			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
dvander@347
    99
			RETURN_META(MRES_SUPERCEDE);
dvander@347
   100
		}
dvander@347
   101
	};
dvander@347
   102
}
dvander@347
   103
dvander@347
   104
bool TestManual(std::string &error)
dvander@347
   105
{
dvander@347
   106
	GET_SHPTR(g_SHPtr);
dvander@347
   107
	g_PLID = 1337;
dvander@347
   108
dvander@347
   109
	TheWall inst;
dvander@347
   110
	TheWall *p = &inst;
dvander@347
   111
dvander@347
   112
	SourceHook::ManualCallClass *cc = SH_GET_MCALLCLASS(p, sizeof(void*));
dvander@347
   113
dvander@347
   114
	// 1)
dvander@347
   115
	// Call each function
dvander@347
   116
	p->Func1();
dvander@347
   117
	p->Func2(200);
dvander@347
   118
	ADD_STATE(State_Return(p->Func3()));
dvander@347
   119
	ADD_STATE(State_Return(p->Func4(400)));
dvander@347
   120
dvander@347
   121
	CHECK_STATES((&g_States,
dvander@347
   122
		new State_Func1_Called(p),
dvander@347
   123
		new State_Func2_Called(p, 200),
dvander@347
   124
		new State_Func3_Called(p),
dvander@347
   125
		new State_Return(3),
dvander@347
   126
		new State_Func4_Called(p, 400),
dvander@347
   127
		new State_Return(4),
dvander@347
   128
		NULL), "Part 1");
dvander@347
   129
dvander@347
   130
	// 1.1)
dvander@347
   131
	// Now call each function through the manual call class, using the hook decl and manually
dvander@347
   132
	SH_MCALL(cc, TheWall_Func1)();
dvander@347
   133
	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
dvander@347
   134
	SH_MCALL(cc, TheWall_Func2)(200);
dvander@347
   135
	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
dvander@347
   136
	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
dvander@347
   137
	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
dvander@347
   138
	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
dvander@347
   139
	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
dvander@347
   140
dvander@347
   141
	CHECK_STATES((&g_States,
dvander@347
   142
		new State_Func1_Called(p),
dvander@347
   143
		new State_Func1_Called(p),
dvander@347
   144
		new State_Func2_Called(p, 200),
dvander@347
   145
		new State_Func2_Called(p, 200),
dvander@347
   146
		new State_Func3_Called(p),
dvander@347
   147
		new State_Return(3),
dvander@347
   148
		new State_Func3_Called(p),
dvander@347
   149
		new State_Return(3),
dvander@347
   150
		new State_Func4_Called(p, 400),
dvander@347
   151
		new State_Return(4),
dvander@347
   152
		new State_Func4_Called(p, 400),
dvander@347
   153
		new State_Return(4),
dvander@347
   154
		NULL), "Part 1.1");
dvander@347
   155
dvander@347
   156
	// 2)
dvander@347
   157
	// Hook each function normally, call them
dvander@347
   158
	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
dvander@347
   159
	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
dvander@347
   160
	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
dvander@347
   161
	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
dvander@347
   162
dvander@347
   163
	p->Func1();
dvander@347
   164
	p->Func2(200);
dvander@347
   165
	ADD_STATE(State_Return(p->Func3()));
dvander@347
   166
	ADD_STATE(State_Return(p->Func4(400)));
dvander@347
   167
dvander@347
   168
	CHECK_STATES((&g_States,
dvander@347
   169
		new State_Func1H_Called(p),
dvander@347
   170
		new State_Func1_Called(p),
dvander@347
   171
		new State_Func2H_Called(p, 200),
dvander@347
   172
		new State_Func2_Called(p, 0x87654321),
dvander@347
   173
		new State_Func3H_Called(p),
dvander@347
   174
		new State_Func3_Called(p),
dvander@347
   175
		new State_Return(3),
dvander@347
   176
		new State_Func4H_Called(p, 400),
dvander@347
   177
		new State_Func4_Called(p, 0x12345678),
dvander@347
   178
		new State_Return(4),
dvander@347
   179
		NULL), "Part 2");
dvander@347
   180
dvander@347
   181
	// Call them through the mcallclass
dvander@347
   182
	// 2.1)
dvander@347
   183
	// Now call each function through the manual call class, using the hook decl and manually
dvander@347
   184
	SH_MCALL(cc, TheWall_Func1)();
dvander@347
   185
	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
dvander@347
   186
	SH_MCALL(cc, TheWall_Func2)(200);
dvander@347
   187
	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
dvander@347
   188
	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
dvander@347
   189
	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
dvander@347
   190
	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
dvander@347
   191
	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
dvander@347
   192
dvander@347
   193
	CHECK_STATES((&g_States,
dvander@347
   194
		new State_Func1_Called(p),
dvander@347
   195
		new State_Func1_Called(p),
dvander@347
   196
		new State_Func2_Called(p, 200),
dvander@347
   197
		new State_Func2_Called(p, 200),
dvander@347
   198
		new State_Func3_Called(p),
dvander@347
   199
		new State_Return(3),
dvander@347
   200
		new State_Func3_Called(p),
dvander@347
   201
		new State_Return(3),
dvander@347
   202
		new State_Func4_Called(p, 400),
dvander@347
   203
		new State_Return(4),
dvander@347
   204
		new State_Func4_Called(p, 400),
dvander@347
   205
		new State_Return(4),
dvander@347
   206
		NULL), "Part 2.1");
dvander@347
   207
dvander@347
   208
	// Unhook them
dvander@347
   209
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
dvander@347
   210
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
dvander@347
   211
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
dvander@347
   212
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
dvander@347
   213
dvander@347
   214
	// 3)
dvander@347
   215
	// Hook each function manually, call them
dvander@347
   216
dvander@347
   217
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
dvander@347
   218
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
dvander@347
   219
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
dvander@347
   220
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
dvander@347
   221
dvander@347
   222
	p->Func1();
dvander@347
   223
	p->Func2(200);
dvander@347
   224
	ADD_STATE(State_Return(p->Func3()));
dvander@347
   225
	ADD_STATE(State_Return(p->Func4(400)));
dvander@347
   226
dvander@347
   227
	CHECK_STATES((&g_States,
dvander@347
   228
		new State_Func1H_Called(p),
dvander@347
   229
		new State_Func1_Called(p),
dvander@347
   230
		new State_Func2H_Called(p, 200),
dvander@347
   231
		new State_Func2_Called(p, 0x87654321),
dvander@347
   232
		new State_Func3H_Called(p),
dvander@347
   233
		new State_Func3_Called(p),
dvander@347
   234
		new State_Return(3),
dvander@347
   235
		new State_Func4H_Called(p, 400),
dvander@347
   236
		new State_Func4_Called(p, 0x12345678),
dvander@347
   237
		new State_Return(4),
dvander@347
   238
		NULL), "Part 3");
dvander@347
   239
dvander@347
   240
	// Now through the mcallclass
dvander@347
   241
dvander@347
   242
	// Call them through the mcallclass
dvander@347
   243
	// 3.1)
dvander@347
   244
	// Now call each function through the manual call class, using the hook decl and manually
dvander@347
   245
	SH_MCALL(cc, TheWall_Func1)();
dvander@347
   246
	SH_MCALL2(cc, MFP_Func1(), 0, 0, 0)();
dvander@347
   247
	SH_MCALL(cc, TheWall_Func2)(200);
dvander@347
   248
	SH_MCALL2(cc, MFP_Func2(), 1, 0, 0)(200);
dvander@347
   249
	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func3)()));
dvander@347
   250
	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func3(), 2, 0, 0)()));
dvander@347
   251
	ADD_STATE(State_Return(SH_MCALL(cc, TheWall_Func4)(400)));
dvander@347
   252
	ADD_STATE(State_Return(SH_MCALL2(cc, MFP_Func4(), 3, 0, 0)(400)));
dvander@347
   253
dvander@347
   254
	CHECK_STATES((&g_States,
dvander@347
   255
		new State_Func1_Called(p),
dvander@347
   256
		new State_Func1_Called(p),
dvander@347
   257
		new State_Func2_Called(p, 200),
dvander@347
   258
		new State_Func2_Called(p, 200),
dvander@347
   259
		new State_Func3_Called(p),
dvander@347
   260
		new State_Return(3),
dvander@347
   261
		new State_Func3_Called(p),
dvander@347
   262
		new State_Return(3),
dvander@347
   263
		new State_Func4_Called(p, 400),
dvander@347
   264
		new State_Return(4),
dvander@347
   265
		new State_Func4_Called(p, 400),
dvander@347
   266
		new State_Return(4),
dvander@347
   267
		NULL), "Part 3.1");
dvander@347
   268
dvander@347
   269
	// Unhook them
dvander@347
   270
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
dvander@347
   271
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
dvander@347
   272
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
dvander@347
   273
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
dvander@347
   274
dvander@347
   275
	// 4)
dvander@347
   276
	// Hook each function manually, then normally, call, unhook
dvander@347
   277
dvander@347
   278
	AnotherBrick handler_inst;
dvander@347
   279
dvander@347
   280
	// Why this?
dvander@347
   281
	// 1) tests sh_add_manualhook_memfunc
dvander@347
   282
	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
dvander@347
   283
	//    (because there are no attribs for manual hooks).
dvander@347
   284
	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
dvander@347
   285
	//    already was one for this vfnptr. This hook manager stored the pointer of the original
dvander@347
   286
	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
dvander@347
   287
	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
dvander@347
   288
	//    does) will supercede the second hook func from being called - thus bypassing the call
dvander@347
   289
	//    of the auto hook here.
dvander@347
   290
	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
dvander@347
   291
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
dvander@347
   292
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
dvander@347
   293
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
dvander@347
   294
dvander@347
   295
	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
dvander@347
   296
	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
dvander@347
   297
	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
dvander@347
   298
	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
dvander@347
   299
dvander@347
   300
	p->Func1();
dvander@347
   301
	p->Func2(200);
dvander@347
   302
	ADD_STATE(State_Return(p->Func3()));
dvander@347
   303
	ADD_STATE(State_Return(p->Func4(400)));
dvander@347
   304
dvander@347
   305
	CHECK_STATES((&g_States,
dvander@347
   306
		new State_Func1H_Called(p),
dvander@347
   307
		new State_Func1H_Called(p),
dvander@347
   308
		//new State_Func1_Called(p),
dvander@347
   309
		new State_Func2H_Called(p, 200),
dvander@347
   310
		new State_Func2H_Called(p, 0x87654321),
dvander@347
   311
		new State_Func2_Called(p, 0x87654321),
dvander@347
   312
		new State_Func3H_Called(p),
dvander@347
   313
		new State_Func3H_Called(p),
dvander@347
   314
		new State_Func3_Called(p),
dvander@347
   315
		new State_Return(3),
dvander@347
   316
		new State_Func4H_Called(p, 400),
dvander@347
   317
		new State_Func4H_Called(p, 0x12345678),
dvander@347
   318
		new State_Func4_Called(p, 0x12345678),
dvander@347
   319
		new State_Return(4),
dvander@347
   320
		NULL), "Part 4");
dvander@347
   321
dvander@347
   322
	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
dvander@347
   323
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
dvander@347
   324
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
dvander@347
   325
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
dvander@347
   326
dvander@347
   327
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
dvander@347
   328
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
dvander@347
   329
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
dvander@347
   330
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
dvander@347
   331
dvander@347
   332
	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
dvander@347
   333
	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
dvander@347
   334
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
dvander@347
   335
dvander@347
   336
	p->Func5();
dvander@347
   337
dvander@347
   338
	CHECK_STATES((&g_States,
dvander@347
   339
		new State_Func1H_Called(p),
dvander@347
   340
		new State_Func5_Called(p),
dvander@347
   341
		NULL), "Part 5");
dvander@347
   342
dvander@347
   343
	// 6) Test auto-remove on reconfig
dvander@347
   344
	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
dvander@347
   345
dvander@347
   346
	p->Func1();
dvander@347
   347
	p->Func5();
dvander@347
   348
	
dvander@347
   349
	CHECK_STATES((&g_States,
dvander@347
   350
		new State_Func1_Called(p),
dvander@347
   351
		new State_Func5_Called(p),
dvander@347
   352
		NULL), "Part 6");
dvander@347
   353
dvander@347
   354
	return true;
dvander@347
   355
}