sourcehook/test/testmanual.cpp
author Pavol Marko <pavolmarko@gmail.com>
Fri Dec 23 11:58:11 2005 +0000 (2005-12-23)
changeset 162 a95db73792e5
parent 158 bf2e51526a0e
child 199 7a5b326bb7f8
permissions -rw-r--r--
One bugfix, addition of META_RETURN_(VALUE_)NEWPARAMS (implemented using recalls), tests now support compiling against an older version of sourcehook.h (through the sourcehook_test.h file) while main.cpp which now also acts as a CSourceHookImpl factory compiles against the new version.
pavolmarko@158
     1
#include <string>
pavolmarko@162
     2
#include "sourcehook.h"
pavolmarko@162
     3
#include "sourcehook_test.h"
pavolmarko@158
     4
#include "testevents.h"
pavolmarko@158
     5
pavolmarko@158
     6
// TESTMANUAL
pavolmarko@158
     7
// Test manual hooks
pavolmarko@158
     8
// :TODO: test more extensively
pavolmarko@158
     9
pavolmarko@158
    10
namespace
pavolmarko@158
    11
{
pavolmarko@158
    12
	StateList g_States;
pavolmarko@158
    13
	SourceHook::ISourceHook *g_SHPtr;
pavolmarko@158
    14
	SourceHook::Plugin g_PLID;
pavolmarko@158
    15
pavolmarko@158
    16
	MAKE_STATE_1(State_Func1_Called, void*);				// param1: This pointer
pavolmarko@158
    17
	MAKE_STATE_2(State_Func2_Called, void*, int);			// param1: This pointer; param2: parameter
pavolmarko@158
    18
	MAKE_STATE_1(State_Func3_Called, void*);				// param1: This pointer
pavolmarko@158
    19
	MAKE_STATE_2(State_Func4_Called, void*, int);			// param1: This pointer; param2: parameter
pavolmarko@158
    20
	MAKE_STATE_1(State_Func5_Called, void*);				// param1: This pointer
pavolmarko@158
    21
pavolmarko@158
    22
	MAKE_STATE_1(State_Func1H_Called, void*);
pavolmarko@158
    23
	MAKE_STATE_2(State_Func2H_Called, void*, int);
pavolmarko@158
    24
	MAKE_STATE_1(State_Func3H_Called, void*);
pavolmarko@158
    25
	MAKE_STATE_2(State_Func4H_Called, void*, int);
pavolmarko@158
    26
pavolmarko@158
    27
	MAKE_STATE_1(State_Return, short);
pavolmarko@158
    28
pavolmarko@158
    29
	class TheWall
pavolmarko@158
    30
	{
pavolmarko@158
    31
	public:
pavolmarko@158
    32
		virtual void Func1()
pavolmarko@158
    33
		{
pavolmarko@158
    34
			ADD_STATE(State_Func1_Called(reinterpret_cast<void*>(this)));
pavolmarko@158
    35
		}
pavolmarko@158
    36
		virtual void Func2(int x)
pavolmarko@158
    37
		{
pavolmarko@158
    38
			ADD_STATE(State_Func2_Called(reinterpret_cast<void*>(this), x));
pavolmarko@158
    39
		}
pavolmarko@158
    40
pavolmarko@158
    41
		virtual short Func3()
pavolmarko@158
    42
		{
pavolmarko@158
    43
			ADD_STATE(State_Func3_Called(reinterpret_cast<void*>(this)));
pavolmarko@158
    44
			return 3;
pavolmarko@158
    45
		}
pavolmarko@158
    46
		virtual short Func4(int x)
pavolmarko@158
    47
		{
pavolmarko@158
    48
			ADD_STATE(State_Func4_Called(reinterpret_cast<void*>(this), x));
pavolmarko@158
    49
			return 4;
pavolmarko@158
    50
		}
pavolmarko@158
    51
		virtual void Func5()
pavolmarko@158
    52
		{
pavolmarko@158
    53
			ADD_STATE(State_Func5_Called(reinterpret_cast<void*>(this)));
pavolmarko@158
    54
		}
pavolmarko@158
    55
	};
pavolmarko@158
    56
pavolmarko@158
    57
	SH_DECL_HOOK0_void(TheWall, Func1, SH_NOATTRIB, 0);
pavolmarko@158
    58
	SH_DECL_HOOK1_void(TheWall, Func2, SH_NOATTRIB, 0, int);
pavolmarko@158
    59
	SH_DECL_HOOK0(TheWall, Func3, SH_NOATTRIB, 0, short);
pavolmarko@158
    60
	SH_DECL_HOOK1(TheWall, Func4, SH_NOATTRIB, 0, short, int);
pavolmarko@158
    61
pavolmarko@158
    62
	SH_DECL_MANUALHOOK0_void(TheWall_Func1, 0, 0, 0);
pavolmarko@158
    63
	SH_DECL_MANUALHOOK1_void(TheWall_Func2, 1, 0, 0, int);
pavolmarko@158
    64
	SH_DECL_MANUALHOOK0(TheWall_Func3, 2, 0, 0, short);
pavolmarko@158
    65
	SH_DECL_MANUALHOOK1(TheWall_Func4, 3, 0, 0, short, int);
pavolmarko@158
    66
pavolmarko@158
    67
	void Handler_Func1()
pavolmarko@158
    68
	{
pavolmarko@158
    69
		ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
pavolmarko@158
    70
	}
pavolmarko@158
    71
	void Handler_Func2(int x)
pavolmarko@158
    72
	{
pavolmarko@158
    73
		ADD_STATE(State_Func2H_Called(META_IFACEPTR(void), x));
pavolmarko@158
    74
	}
pavolmarko@158
    75
	short Handler_Func3()
pavolmarko@158
    76
	{
pavolmarko@158
    77
		ADD_STATE(State_Func3H_Called(META_IFACEPTR(void)));
pavolmarko@158
    78
		return 0;
pavolmarko@158
    79
	}
pavolmarko@158
    80
	short Handler_Func4(int x)
pavolmarko@158
    81
	{
pavolmarko@158
    82
		ADD_STATE(State_Func4H_Called(META_IFACEPTR(void), x));
pavolmarko@158
    83
		return 0;
pavolmarko@158
    84
	}
pavolmarko@158
    85
pavolmarko@158
    86
	struct AnotherBrick
pavolmarko@158
    87
	{
pavolmarko@158
    88
		void Handler_Func1()
pavolmarko@158
    89
		{
pavolmarko@158
    90
			ADD_STATE(State_Func1H_Called(META_IFACEPTR(void)));
pavolmarko@158
    91
			RETURN_META(MRES_SUPERCEDE);
pavolmarko@158
    92
		}
pavolmarko@158
    93
	};
pavolmarko@158
    94
}
pavolmarko@158
    95
pavolmarko@158
    96
bool TestManual(std::string &error)
pavolmarko@158
    97
{
pavolmarko@162
    98
	GET_SHPTR(g_SHPtr);
pavolmarko@158
    99
	g_PLID = 1337;
pavolmarko@158
   100
pavolmarko@158
   101
	TheWall inst;
pavolmarko@158
   102
	TheWall *p = &inst;
pavolmarko@158
   103
pavolmarko@158
   104
	// 1)
pavolmarko@158
   105
	// Call each function
pavolmarko@158
   106
	p->Func1();
pavolmarko@158
   107
	p->Func2(200);
pavolmarko@158
   108
	ADD_STATE(State_Return(p->Func3()));
pavolmarko@158
   109
	ADD_STATE(State_Return(p->Func4(400)));
pavolmarko@158
   110
pavolmarko@158
   111
	CHECK_STATES((&g_States,
pavolmarko@158
   112
		new State_Func1_Called(p),
pavolmarko@158
   113
		new State_Func2_Called(p, 200),
pavolmarko@158
   114
		new State_Func3_Called(p),
pavolmarko@158
   115
		new State_Return(3),
pavolmarko@158
   116
		new State_Func4_Called(p, 400),
pavolmarko@158
   117
		new State_Return(4),
pavolmarko@158
   118
		NULL), "Part 1");
pavolmarko@158
   119
pavolmarko@158
   120
	// 2)
pavolmarko@158
   121
	// Hook each function normally, call them, unhook them
pavolmarko@158
   122
	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
pavolmarko@158
   123
	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
pavolmarko@158
   124
	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
pavolmarko@158
   125
	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
pavolmarko@158
   126
pavolmarko@158
   127
	p->Func1();
pavolmarko@158
   128
	p->Func2(200);
pavolmarko@158
   129
	ADD_STATE(State_Return(p->Func3()));
pavolmarko@158
   130
	ADD_STATE(State_Return(p->Func4(400)));
pavolmarko@158
   131
pavolmarko@158
   132
	CHECK_STATES((&g_States,
pavolmarko@158
   133
		new State_Func1H_Called(p),
pavolmarko@158
   134
		new State_Func1_Called(p),
pavolmarko@158
   135
		new State_Func2H_Called(p, 200),
pavolmarko@158
   136
		new State_Func2_Called(p, 200),
pavolmarko@158
   137
		new State_Func3H_Called(p),
pavolmarko@158
   138
		new State_Func3_Called(p),
pavolmarko@158
   139
		new State_Return(3),
pavolmarko@158
   140
		new State_Func4H_Called(p, 400),
pavolmarko@158
   141
		new State_Func4_Called(p, 400),
pavolmarko@158
   142
		new State_Return(4),
pavolmarko@158
   143
		NULL), "Part 2");
pavolmarko@158
   144
pavolmarko@158
   145
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
pavolmarko@158
   146
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
pavolmarko@158
   147
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
pavolmarko@158
   148
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
pavolmarko@158
   149
pavolmarko@158
   150
	// 3)
pavolmarko@158
   151
	// Hook each function manually, call them, unhook them
pavolmarko@158
   152
pavolmarko@158
   153
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
pavolmarko@158
   154
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
pavolmarko@158
   155
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
pavolmarko@158
   156
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
pavolmarko@158
   157
pavolmarko@158
   158
	p->Func1();
pavolmarko@158
   159
	p->Func2(200);
pavolmarko@158
   160
	ADD_STATE(State_Return(p->Func3()));
pavolmarko@158
   161
	ADD_STATE(State_Return(p->Func4(400)));
pavolmarko@158
   162
pavolmarko@158
   163
	CHECK_STATES((&g_States,
pavolmarko@158
   164
		new State_Func1H_Called(p),
pavolmarko@158
   165
		new State_Func1_Called(p),
pavolmarko@158
   166
		new State_Func2H_Called(p, 200),
pavolmarko@158
   167
		new State_Func2_Called(p, 200),
pavolmarko@158
   168
		new State_Func3H_Called(p),
pavolmarko@158
   169
		new State_Func3_Called(p),
pavolmarko@158
   170
		new State_Return(3),
pavolmarko@158
   171
		new State_Func4H_Called(p, 400),
pavolmarko@158
   172
		new State_Func4_Called(p, 400),
pavolmarko@158
   173
		new State_Return(4),
pavolmarko@158
   174
		NULL), "Part 3");
pavolmarko@158
   175
pavolmarko@158
   176
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
pavolmarko@158
   177
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
pavolmarko@158
   178
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
pavolmarko@158
   179
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
pavolmarko@158
   180
pavolmarko@158
   181
	// 4)
pavolmarko@158
   182
	// Hook each function manually, then normally, call, unhook
pavolmarko@158
   183
pavolmarko@158
   184
	AnotherBrick handler_inst;
pavolmarko@158
   185
pavolmarko@158
   186
	// Why this?
pavolmarko@158
   187
	// 1) tests sh_add_manualhook_memfunc
pavolmarko@158
   188
	// 2) in my tests, the proto of the manual hook was not equal to the proto of the auto hook
pavolmarko@158
   189
	//    (because there are no attribs for manual hooks).
pavolmarko@158
   190
	//    sourcehook.cpp did a !strcmp(..), so it assigned a new hook manager even though there
pavolmarko@158
   191
	//    already was one for this vfnptr. This hook manager stored the pointer of the original
pavolmarko@158
   192
	//    hook manager's hookfunc as the orig pointer - everything seemingly worked.
pavolmarko@158
   193
	//    The problem with this is that returning MRES_SUPERCEDE (as AnotherBrick::Handler_Func1
pavolmarko@158
   194
	//    does) will supercede the second hook func from being called - thus bypassing the call
pavolmarko@158
   195
	//    of the auto hook here.
pavolmarko@158
   196
	SH_ADD_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
pavolmarko@158
   197
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
pavolmarko@158
   198
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
pavolmarko@158
   199
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
pavolmarko@158
   200
pavolmarko@158
   201
	SH_ADD_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
pavolmarko@158
   202
	SH_ADD_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
pavolmarko@158
   203
	SH_ADD_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
pavolmarko@158
   204
	SH_ADD_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
pavolmarko@158
   205
pavolmarko@158
   206
	p->Func1();
pavolmarko@158
   207
	p->Func2(200);
pavolmarko@158
   208
	ADD_STATE(State_Return(p->Func3()));
pavolmarko@158
   209
	ADD_STATE(State_Return(p->Func4(400)));
pavolmarko@158
   210
pavolmarko@158
   211
	CHECK_STATES((&g_States,
pavolmarko@158
   212
		new State_Func1H_Called(p),
pavolmarko@158
   213
		new State_Func1H_Called(p),
pavolmarko@158
   214
		//new State_Func1_Called(p),
pavolmarko@158
   215
		new State_Func2H_Called(p, 200),
pavolmarko@158
   216
		new State_Func2H_Called(p, 200),
pavolmarko@158
   217
		new State_Func2_Called(p, 200),
pavolmarko@158
   218
		new State_Func3H_Called(p),
pavolmarko@158
   219
		new State_Func3H_Called(p),
pavolmarko@158
   220
		new State_Func3_Called(p),
pavolmarko@158
   221
		new State_Return(3),
pavolmarko@158
   222
		new State_Func4H_Called(p, 400),
pavolmarko@158
   223
		new State_Func4H_Called(p, 400),
pavolmarko@158
   224
		new State_Func4_Called(p, 400),
pavolmarko@158
   225
		new State_Return(4),
pavolmarko@158
   226
		NULL), "Part 4");
pavolmarko@158
   227
pavolmarko@158
   228
	SH_REMOVE_MANUALHOOK_MEMFUNC(TheWall_Func1, p, &handler_inst, &AnotherBrick::Handler_Func1, false);
pavolmarko@158
   229
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func2, p, Handler_Func2, false);
pavolmarko@158
   230
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func3, p, Handler_Func3, false);
pavolmarko@158
   231
	SH_REMOVE_MANUALHOOK_STATICFUNC(TheWall_Func4, p, Handler_Func4, false);
pavolmarko@158
   232
pavolmarko@158
   233
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func1, p, Handler_Func1, false);
pavolmarko@158
   234
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func2, p, Handler_Func2, false);
pavolmarko@158
   235
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func3, p, Handler_Func3, false);
pavolmarko@158
   236
	SH_REMOVE_HOOK_STATICFUNC(TheWall, Func4, p, Handler_Func4, false);
pavolmarko@158
   237
pavolmarko@158
   238
	// 5) Reconfigure TheWall_Func1 to actually hook Func5:
pavolmarko@158
   239
	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 4, 0, 0);
pavolmarko@158
   240
	SH_ADD_MANUALHOOK_STATICFUNC(TheWall_Func1, p, Handler_Func1, false);
pavolmarko@158
   241
pavolmarko@158
   242
	p->Func5();
pavolmarko@158
   243
pavolmarko@158
   244
	CHECK_STATES((&g_States,
pavolmarko@158
   245
		new State_Func1H_Called(p),
pavolmarko@158
   246
		new State_Func5_Called(p),
pavolmarko@158
   247
		NULL), "Part 5");
pavolmarko@158
   248
pavolmarko@158
   249
	// 6) Test auto-remove on reconfig
pavolmarko@158
   250
	SH_MANUALHOOK_RECONFIGURE(TheWall_Func1, 0, 0, 0);
pavolmarko@158
   251
pavolmarko@158
   252
	p->Func1();
pavolmarko@158
   253
	p->Func5();
pavolmarko@158
   254
	
pavolmarko@158
   255
	CHECK_STATES((&g_States,
pavolmarko@158
   256
		new State_Func1_Called(p),
pavolmarko@158
   257
		new State_Func5_Called(p),
pavolmarko@158
   258
		NULL), "Part 6");
pavolmarko@158
   259
pavolmarko@158
   260
	return true;
pavolmarko@158
   261
}
pavolmarko@158
   262