core/sourcehook/test/testbail.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@75
     1
// TESTBAIL
pavolmarko@162
     2
// This test used to be a test for a bug BAIL found.
pavolmarko@162
     3
// That bug is now fixed so I've granted BAIL the pleasure of being a test for
pavolmarko@162
     4
// the correct priority ordering of hook managers based on their version.
pavolmarko@162
     5
pavolmarko@162
     6
/*
pavolmarko@162
     7
	THE PROBLEM:
pavolmarko@162
     8
		Old hook funcs don't work right when you combine override returns and recalls.
pavolmarko@162
     9
	THE SOLUTION:
pavolmarko@162
    10
		Always use a new hook func when possible. For this, hook funcs have to be able to say
pavolmarko@162
    11
			" HELLO I'M NEW! "
pavolmarko@75
    12
pavolmarko@162
    13
	This file tests that functionality.
pavolmarko@162
    14
pavolmarko@162
    15
	How it works:
pavolmarko@162
    16
		testbail.cpp compiles with old version of sourcehook.h.
pavolmarko@162
    17
		It sets everything up, adds a hook on a function
pavolmarko@162
    18
		Then testbail2.cpp which has the new version adds a hook on the same function and 
pavolmarko@162
    19
		does a recall and overrides the value in it.
pavolmarko@162
    20
*/
pavolmarko@162
    21
#include "sourcehook_test.h"
pavolmarko@75
    22
#include "testbail.h"
pavolmarko@75
    23
pavolmarko@163
    24
namespace N_TestBail
pavolmarko@163
    25
{
pavolmarko@163
    26
	StateList g_States;
pavolmarko@163
    27
	SourceHook::ISourceHook *g_SHPtr;
pavolmarko@163
    28
	IGaben *g_Gabgab;
pavolmarko@163
    29
}
pavolmarko@75
    30
pavolmarko@121
    31
namespace
pavolmarko@121
    32
{
pavolmarko@162
    33
	int EatYams_Handler1(int a)
pavolmarko@121
    34
	{
pavolmarko@162
    35
		ADD_STATE(State_EatYams_Handler1_Called(a));
pavolmarko@162
    36
		RETURN_META_VALUE(MRES_IGNORED, 0);
pavolmarko@121
    37
	}
pavolmarko@162
    38
}
pavolmarko@162
    39
pavolmarko@75
    40
bool TestBail(std::string &error)
pavolmarko@75
    41
{
pavolmarko@162
    42
	GET_SHPTR(g_SHPtr);
pavolmarko@75
    43
	g_PLID = 1;
pavolmarko@75
    44
pavolmarko@75
    45
	g_Gabgab = new IGaben;
pavolmarko@75
    46
pavolmarko@324
    47
	SH_ADD_HOOK(IGaben, EatYams, g_Gabgab, SH_STATIC(EatYams_Handler1), false);
pavolmarko@162
    48
pavolmarko@162
    49
	ADD_STATE(State_EatYams_Return(g_Gabgab->EatYams(0xDEAD)));
pavolmarko@75
    50
pavolmarko@162
    51
	CHECK_STATES((&g_States,
pavolmarko@162
    52
		new State_EatYams_Handler1_Called(0xDEAD),
pavolmarko@162
    53
		new State_EatYams_Called(0xDEAD),
pavolmarko@162
    54
		new State_EatYams_Return(5),
pavolmarko@162
    55
		NULL), "Part 1");
pavolmarko@75
    56
pavolmarko@163
    57
	if (!TestBail2(error))
pavolmarko@162
    58
		return false;
pavolmarko@75
    59
pavolmarko@162
    60
	CHECK_STATES((&g_States,
pavolmarko@162
    61
		new State_EatYams_Handler1_Called(0xDEAD),
pavolmarko@162
    62
		new State_EatYams_Handler2_Called(0xDEAD),
pavolmarko@162
    63
		new State_EatYams_Handler3_Called(0xBEEF),
pavolmarko@162
    64
		new State_EatYams_Called(0xBEEF),
pavolmarko@162
    65
		NULL), "Part 2.1");
pavolmarko@162
    66
pavolmarko@162
    67
	// WHAT IF NOW SOMEONE UNLOADS PLUGIN 2 !?!?!?!?
pavolmarko@162
    68
	Test_UnloadPlugin(g_SHPtr, 2);
pavolmarko@162
    69
pavolmarko@162
    70
	ADD_STATE(State_EatYams_Return(g_Gabgab->EatYams(0xDEAD)));
pavolmarko@75
    71
pavolmarko@162
    72
	CHECK_STATES((&g_States,
pavolmarko@162
    73
		new State_EatYams_Handler1_Called(0xDEAD),
pavolmarko@162
    74
		new State_EatYams_Called(0xDEAD),
pavolmarko@162
    75
		new State_EatYams_Return(5),
pavolmarko@162
    76
		NULL), "Part 3");
pavolmarko@75
    77
pavolmarko@324
    78
	SH_REMOVE_HOOK(IGaben, EatYams, g_Gabgab, SH_STATIC(EatYams_Handler1), false);
pavolmarko@162
    79
pavolmarko@162
    80
	ADD_STATE(State_EatYams_Return(g_Gabgab->EatYams(0xDEAD)));
pavolmarko@162
    81
pavolmarko@162
    82
	CHECK_STATES((&g_States,
pavolmarko@162
    83
		new State_EatYams_Called(0xDEAD),
pavolmarko@162
    84
		new State_EatYams_Return(5),
pavolmarko@162
    85
		NULL), "Part 4");
pavolmarko@75
    86
pavolmarko@163
    87
	// Now, heh, try it the other way round.
pavolmarko@163
    88
pavolmarko@163
    89
	Test_CompleteShutdown(g_SHPtr);
pavolmarko@163
    90
pavolmarko@163
    91
	if (!TestBail2(error))
pavolmarko@163
    92
		return false;
pavolmarko@163
    93
pavolmarko@163
    94
	CHECK_STATES((&g_States,
pavolmarko@163
    95
		new State_EatYams_Handler2_Called(0xDEAD),
pavolmarko@163
    96
		new State_EatYams_Handler3_Called(0xBEEF),
pavolmarko@163
    97
		new State_EatYams_Called(0xBEEF),
pavolmarko@163
    98
		NULL), "Part 5");
pavolmarko@163
    99
pavolmarko@324
   100
	SH_ADD_HOOK(IGaben, EatYams, g_Gabgab, SH_STATIC(EatYams_Handler1), false);
pavolmarko@163
   101
pavolmarko@163
   102
	ADD_STATE(State_EatYams_Return(g_Gabgab->EatYams(0xDEAD)));
pavolmarko@163
   103
pavolmarko@163
   104
	CHECK_STATES((&g_States,
pavolmarko@163
   105
		new State_EatYams_Handler2_Called(0xDEAD),
pavolmarko@163
   106
		new State_EatYams_Handler3_Called(0xBEEF),
pavolmarko@163
   107
		new State_EatYams_Handler1_Called(0xBEEF),
pavolmarko@163
   108
		new State_EatYams_Called(0xBEEF),
pavolmarko@163
   109
		new State_EatYams_Return(6),
pavolmarko@163
   110
		NULL), "Part 6");
pavolmarko@163
   111
pavolmarko@75
   112
	delete g_Gabgab;
pavolmarko@75
   113
pavolmarko@75
   114
	return true;
pavolmarko@75
   115
}