core/sourcehook/test/testevents.h
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@58
     1
/* ======== SourceHook ========
ds@523
     2
* Copyright (C) 2004-2008 Metamod:Source Development Team
pavolmarko@58
     3
* No warranties of any kind
pavolmarko@58
     4
*
pavolmarko@58
     5
* License: zlib/libpng
pavolmarko@58
     6
*
pavolmarko@58
     7
* Author(s): Pavol "PM OnoTo" Marko
pavolmarko@58
     8
* ============================
pavolmarko@58
     9
*/
pavolmarko@58
    10
pavolmarko@43
    11
#ifndef __TESTEVENTS_H__
pavolmarko@43
    12
#define __TESTEVENTS_H__
pavolmarko@43
    13
pavolmarko@48
    14
#include <typeinfo>
pavolmarko@48
    15
#include <stdarg.h>
pavolmarko@50
    16
#include <iostream>
dvander@96
    17
#include <list>
pavolmarko@60
    18
#include <string>
pavolmarko@50
    19
pavolmarko@50
    20
extern bool g_Verbose;
pavolmarko@48
    21
pavolmarko@480
    22
static unsigned int MakeHash(const char *name)
pavolmarko@480
    23
{
pavolmarko@480
    24
	int a = 0;
pavolmarko@480
    25
	unsigned int res = 0xFFFFFFFF;
pavolmarko@480
    26
pavolmarko@480
    27
	while (*name)
pavolmarko@480
    28
	{
pavolmarko@480
    29
		res ^= ((unsigned int)*name << ((a++ % 4)*8));
pavolmarko@480
    30
		++name;
pavolmarko@480
    31
	}
pavolmarko@480
    32
	return res;
pavolmarko@480
    33
}
pavolmarko@480
    34
pavolmarko@163
    35
struct State
pavolmarko@163
    36
{
pavolmarko@163
    37
	virtual ~State()
pavolmarko@163
    38
	{
pavolmarko@163
    39
pavolmarko@163
    40
	}
pavolmarko@163
    41
pavolmarko@163
    42
	virtual bool IsEqual(State *other)
pavolmarko@163
    43
	{
pavolmarko@480
    44
		return (MakeHash(GetName()) == MakeHash(other->GetName())) ? true : false;
pavolmarko@480
    45
	}
pavolmarko@480
    46
pavolmarko@480
    47
	virtual bool Ignore()
pavolmarko@480
    48
	{
pavolmarko@480
    49
		return false;
pavolmarko@163
    50
	}
pavolmarko@163
    51
pavolmarko@163
    52
	virtual void Dump() = 0;
pavolmarko@480
    53
	virtual const char *GetName() = 0;
pavolmarko@480
    54
};
pavolmarko@480
    55
pavolmarko@480
    56
struct IgnoreState : public State
pavolmarko@480
    57
{
pavolmarko@480
    58
	virtual bool Ignore()
pavolmarko@480
    59
	{
pavolmarko@480
    60
		return true;
pavolmarko@480
    61
	}
pavolmarko@480
    62
	virtual void Dump()
pavolmarko@480
    63
	{
pavolmarko@480
    64
	}
pavolmarko@163
    65
};
pavolmarko@163
    66
pavolmarko@163
    67
typedef std::list<State*> StateList;
pavolmarko@45
    68
namespace
pavolmarko@43
    69
{
pavolmarko@60
    70
	void DumpStates(StateList *sl)
pavolmarko@60
    71
	{
pavolmarko@60
    72
		for (StateList::iterator iter = sl->begin(); iter != sl->end(); ++iter)
pavolmarko@60
    73
			(*iter)->Dump();
pavolmarko@60
    74
	}
pavolmarko@60
    75
pavolmarko@45
    76
	bool StatesOk(StateList *sl, ...)
pavolmarko@43
    77
	{
pavolmarko@45
    78
		StateList requiredstates;
pavolmarko@45
    79
		va_list argptr;
pavolmarko@45
    80
		va_start(argptr, sl);
pavolmarko@45
    81
		while (true)
pavolmarko@45
    82
		{
pavolmarko@45
    83
			State *cs = va_arg(argptr, State*);
pavolmarko@45
    84
			if (!cs)
pavolmarko@45
    85
				break;
pavolmarko@480
    86
			if (cs->Ignore())
pavolmarko@480
    87
				continue;
pavolmarko@45
    88
			requiredstates.push_back(cs);
pavolmarko@45
    89
		}
pavolmarko@45
    90
		va_end(argptr);
pavolmarko@43
    91
pavolmarko@45
    92
		if (requiredstates.size() != sl->size())
pavolmarko@45
    93
		{
pavolmarko@60
    94
			if (g_Verbose)
pavolmarko@60
    95
			{
pavolmarko@60
    96
				std::cout << std::endl << "FAIL: Should be:" << std::endl;
pavolmarko@60
    97
				DumpStates(&requiredstates);
pavolmarko@60
    98
				std::cout << std::endl << "FAIL: Is:" << std::endl;
pavolmarko@60
    99
				DumpStates(sl);
pavolmarko@60
   100
			}
pavolmarko@60
   101
pavolmarko@45
   102
			for (StateList::iterator iter = requiredstates.begin(); iter != requiredstates.end(); ++iter)
pavolmarko@45
   103
				delete *iter;
pavolmarko@45
   104
			for (StateList::iterator iter = sl->begin(); iter != sl->end(); ++iter)
pavolmarko@45
   105
				delete *iter;
pavolmarko@45
   106
			sl->clear();
pavolmarko@45
   107
			return false;
pavolmarko@45
   108
		}
pavolmarko@45
   109
pavolmarko@45
   110
		bool ok = true;
pavolmarko@45
   111
		StateList::iterator req_iter = requiredstates.begin();
pavolmarko@45
   112
		for (StateList::iterator o_iter = sl->begin(); o_iter != sl->end(); ++o_iter, ++req_iter)
pavolmarko@45
   113
		{
pavolmarko@45
   114
			if (!(*o_iter)->IsEqual(*req_iter))
pavolmarko@45
   115
			{
pavolmarko@45
   116
				ok = false;
pavolmarko@45
   117
				break;
pavolmarko@45
   118
			}
pavolmarko@45
   119
		}
pavolmarko@45
   120
pavolmarko@462
   121
		if (!ok && g_Verbose)
pavolmarko@462
   122
		{
pavolmarko@462
   123
			std::cout << std::endl << "FAIL: Should be:" << std::endl;
pavolmarko@462
   124
			DumpStates(&requiredstates);
pavolmarko@462
   125
			std::cout << std::endl << "FAIL: Is:" << std::endl;
pavolmarko@462
   126
			DumpStates(sl);
pavolmarko@462
   127
		}
pavolmarko@462
   128
pavolmarko@43
   129
		for (StateList::iterator iter = requiredstates.begin(); iter != requiredstates.end(); ++iter)
pavolmarko@43
   130
			delete *iter;
pavolmarko@43
   131
		for (StateList::iterator iter = sl->begin(); iter != sl->end(); ++iter)
pavolmarko@43
   132
			delete *iter;
pavolmarko@43
   133
		sl->clear();
pavolmarko@45
   134
pavolmarko@45
   135
		return ok;
pavolmarko@43
   136
	}
pavolmarko@43
   137
}
pavolmarko@43
   138
pavolmarko@162
   139
#define ADD_STATE(name) g_States.push_back(new name)
pavolmarko@162
   140
#define ADD_STATE_PTR(statesptr, name) statesptr->push_back(new name)
pavolmarko@162
   141
pavolmarko@61
   142
#define CHECK_STATES(mwah, myerr) if (!StatesOk mwah) { error=myerr; return false; } else if (g_Verbose) { std::cout << "No error: " << myerr << std::endl; }
pavolmarko@43
   143
pavolmarko@60
   144
#define MAKE_STATE(name) struct name : State { \
pavolmarko@60
   145
		virtual void Dump() { \
pavolmarko@60
   146
			std::cout << "  " << #name << std::endl; } \
pavolmarko@480
   147
		const char *GetName() { return #name; } \
pavolmarko@60
   148
	};
pavolmarko@60
   149
pavolmarko@49
   150
#define MAKE_STATE_1(name, p1_type) struct name : State { \
pavolmarko@49
   151
		p1_type m_Param1; \
pavolmarko@49
   152
		name(p1_type param1) : m_Param1(param1) {} \
pavolmarko@49
   153
		virtual bool IsEqual(State *other) { \
pavolmarko@480
   154
			if (MakeHash(GetName()) != MakeHash(other->GetName())) \
pavolmarko@49
   155
				return false; \
pavolmarko@480
   156
			name *other2 = static_cast<name*>(other); \
pavolmarko@49
   157
			return other2->m_Param1 == m_Param1;\
pavolmarko@49
   158
		} \
pavolmarko@60
   159
		virtual void Dump() { \
pavolmarko@60
   160
			std::cout << "  " << #name << "; Param1=" << m_Param1 << std::endl; } \
pavolmarko@480
   161
		const char *GetName() { return #name; } \
pavolmarko@49
   162
	}
pavolmarko@49
   163
pavolmarko@49
   164
#define MAKE_STATE_2(name, p1_type, p2_type) struct name : State { \
pavolmarko@49
   165
		p1_type m_Param1; \
pavolmarko@49
   166
		p2_type m_Param2; \
pavolmarko@49
   167
		name(p1_type param1, p2_type param2) : m_Param1(param1), m_Param2(param2) {} \
pavolmarko@49
   168
		virtual bool IsEqual(State *other) { \
pavolmarko@480
   169
			if (MakeHash(GetName()) != MakeHash(other->GetName())) \
pavolmarko@49
   170
				return false; \
pavolmarko@480
   171
			name *other2 = static_cast<name*>(other); \
pavolmarko@49
   172
			return other2->m_Param1 == m_Param1 && other2->m_Param2 == m_Param2;\
pavolmarko@49
   173
		} \
pavolmarko@60
   174
		virtual void Dump() { \
pavolmarko@60
   175
			std::cout << "  " << #name << "; Param1=" << m_Param1 << "; Param2=" << m_Param2 << std::endl; } \
pavolmarko@480
   176
		const char *GetName() { return #name; } \
pavolmarko@49
   177
	}
pavolmarko@128
   178
pavolmarko@128
   179
#define MAKE_STATE_3(name, p1_type, p2_type, p3_type) struct name : State { \
pavolmarko@128
   180
		p1_type m_Param1; \
pavolmarko@128
   181
		p2_type m_Param2; \
pavolmarko@128
   182
		p3_type m_Param3; \
pavolmarko@128
   183
		name(p1_type param1, p2_type param2, p3_type param3) : m_Param1(param1), m_Param2(param2), m_Param3(param3) {} \
pavolmarko@128
   184
		virtual bool IsEqual(State *other) { \
pavolmarko@480
   185
			if (MakeHash(GetName()) != MakeHash(other->GetName())) \
pavolmarko@128
   186
				return false; \
pavolmarko@480
   187
			name *other2 = static_cast<name*>(other); \
pavolmarko@128
   188
			return other2->m_Param1 == m_Param1 && other2->m_Param2 == m_Param2 && other2->m_Param3 == m_Param3;\
pavolmarko@128
   189
		} \
pavolmarko@128
   190
		virtual void Dump() { \
pavolmarko@128
   191
			std::cout << "  " << #name << "; Param1=" << m_Param1 << "; Param2=" << m_Param2 << "; Param3=" << m_Param3 << std::endl; } \
pavolmarko@480
   192
		const char *GetName() { return #name; } \
pavolmarko@480
   193
	}
pavolmarko@480
   194
pavolmarko@480
   195
#define MAKE_STATE_4(name, p1_type, p2_type, p3_type, p4_type) struct name : State { \
pavolmarko@480
   196
		p1_type m_Param1; \
pavolmarko@480
   197
		p2_type m_Param2; \
pavolmarko@480
   198
		p3_type m_Param3; \
pavolmarko@480
   199
		p4_type m_Param4; \
pavolmarko@480
   200
		name(p1_type param1, p2_type param2, p3_type param3, p4_type param4) : m_Param1(param1), m_Param2(param2), m_Param3(param3), m_Param4(param4) {} \
pavolmarko@480
   201
		virtual bool IsEqual(State *other) { \
pavolmarko@480
   202
			if (MakeHash(GetName()) != MakeHash(other->GetName())) \
pavolmarko@480
   203
				return false; \
pavolmarko@480
   204
			name *other2 = static_cast<name*>(other); \
pavolmarko@480
   205
			return other2->m_Param1 == m_Param1 && other2->m_Param2 == m_Param2 && other2->m_Param3 == m_Param3 && other2->m_Param4 == m_Param4;\
pavolmarko@480
   206
		} \
pavolmarko@480
   207
		virtual void Dump() { \
pavolmarko@480
   208
			std::cout << "  " << #name << "; Param1=" << m_Param1 << "; Param2=" << m_Param2 << "; Param3=" << m_Param3 << "; Param4=" << m_Param4 << std::endl; } \
pavolmarko@480
   209
		const char *GetName() { return #name; } \
pavolmarko@128
   210
	}
pavolmarko@128
   211
pavolmarko@128
   212
#define CHECK_COND(c, err) if (!(c)) { error = err; return false; }
pavolmarko@128
   213
pavolmarko@48
   214
#endif