aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/kernel/objectregistry.h
blob: e1c80c8b364c984a03c4f9963ce0c3c2eaf0c03a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd�rfer
//
// Broken Sword 2.5 is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Broken Sword 2.5 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Broken Sword 2.5; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// -----------------------------------------------------------------------------

#ifndef BS_OBJECTREGISTRY_H
#define BS_OBJECTREGISTRY_H

// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------

#include "kernel/common.h"
#include "kernel/hashmap.h"

// -----------------------------------------------------------------------------
// Klassendeklaration
// -----------------------------------------------------------------------------

template<typename T>
class BS_ObjectRegistry
{
public:
	BS_ObjectRegistry() : m_NextHandle(1) {};

	// -------------------------------------------------------------------------

	unsigned int RegisterObject(T * ObjectPtr)
	{
		// Null-Pointer k�nnen nicht registriert werden.
		if (ObjectPtr == 0)
		{
			LogErrorLn("Cannot register a null pointer.");
			return 0;
		}

		// Falls das Objekt bereits registriert wurde, wird eine Warnung ausgeben und das Handle zur�ckgeben.
		unsigned int Handle = FindHandleByPtr(ObjectPtr);
		if (Handle != 0)
		{
			LogWarningLn("Tried to register a object that was already registered.");
			return Handle;
		}
		// Ansonsten wird das Objekt in beide Maps eingetragen und das neue Handle zur�ckgeben.
		else
		{
			m_Handle2PtrMap[m_NextHandle] = ObjectPtr;
			m_Ptr2HandleMap[ObjectPtr] = m_NextHandle;

			return m_NextHandle++;
		}
	}

	// -----------------------------------------------------------------------------

	unsigned int RegisterObject(T * ObjectPtr, unsigned int Handle)
	{
		// Null-Pointer und Null-Handle k�nnen nicht registriert werden.
		if (ObjectPtr == 0 || Handle == 0)
		{
			LogErrorLn("Cannot register a null pointer or a null handle.");
			return 0;
		}

		// Falls das Objekt bereits registriert wurde, wird ein Fehler ausgegeben und 0 zur�ckgeben.
		unsigned int HandleTest = FindHandleByPtr(ObjectPtr);
		if (HandleTest != 0)
		{
			LogErrorLn("Tried to register a object that was already registered.");
			return 0;
		}
		// Falls das Handle bereits vergeben ist, wird ein Fehler ausgegeben und 0 zur�ckgegeben.
		else if (FindPtrByHandle(Handle) != 0)
		{
			LogErrorLn("Tried to register a handle that is already taken.");
			return 0;
		}
		// Ansonsten wird das Objekt in beide Maps eingetragen und das gew�nschte Handle zur�ckgeben.
		else
		{
			m_Handle2PtrMap[Handle] = ObjectPtr;
			m_Ptr2HandleMap[ObjectPtr] = Handle;

			// Falls das vergebene Handle gr��er oder gleich dem n�chsten automatische vergebenen Handle ist, wird das n�chste automatisch
			// vergebene Handle erh�ht.
			if (Handle >= m_NextHandle) m_NextHandle = Handle + 1;

			return Handle;
		}
	}

	// -----------------------------------------------------------------------------

	void DeregisterObject(T * ObjectPtr)
	{
		unsigned int Handle = FindHandleByPtr(ObjectPtr);

		if (Handle != 0)
		{
			// Registriertes Objekt aus beiden Maps entfernen.
			m_Handle2PtrMap.erase(FindHandleByPtr(ObjectPtr));
			m_Ptr2HandleMap.erase(ObjectPtr);
		}
		else
		{
			LogWarningLn("Tried to remove a object that was not registered.");
		}
	}

	// -----------------------------------------------------------------------------

	T * ResolveHandle(unsigned int Handle)
	{
		// Zum Handle geh�riges Objekt in der Hash-Map finden.
		T * ObjectPtr = FindPtrByHandle(Handle);

		// Pointer zur�ckgeben. Im Fehlerfall ist dieser 0.
		return ObjectPtr;
	}

	// -----------------------------------------------------------------------------

	unsigned int ResolvePtr(T * ObjectPtr)
	{
		// Zum Pointer geh�riges Handle in der Hash-Map finden.
		unsigned int Handle = FindHandleByPtr(ObjectPtr);

		// Handle zur�ckgeben. Im Fehlerfall ist dieses 0.
		return Handle;
	}

protected:
	typedef BS_Hashmap<unsigned int, T *>	HANDLE2PTR_MAP;
	typedef BS_Hashmap<T *, unsigned int> PTR2HANDLE_MAP;

	HANDLE2PTR_MAP	m_Handle2PtrMap;
	PTR2HANDLE_MAP	m_Ptr2HandleMap;
	unsigned int	m_NextHandle;

	// -----------------------------------------------------------------------------

	T * FindPtrByHandle(unsigned int Handle)
	{
		// Zum Handle geh�rigen Pointer finden.
		HANDLE2PTR_MAP::const_iterator it = m_Handle2PtrMap.find(Handle);

		// Pointer zur�ckgeben, oder, falls keiner gefunden wurde, 0 zur�ckgeben.
		return (it != m_Handle2PtrMap.end()) ? it->second : 0;
	}

	// -----------------------------------------------------------------------------

	unsigned int FindHandleByPtr(T * ObjectPtr)
	{
		// Zum Pointer geh�riges Handle finden.
		PTR2HANDLE_MAP::const_iterator it = m_Ptr2HandleMap.find(ObjectPtr);

		// Handle zur�ckgeben, oder, falls keines gefunden wurde, 0 zur�ckgeben.
		return (it != m_Ptr2HandleMap.end()) ? it->second : 0;
	}

	// -----------------------------------------------------------------------------

	virtual void LogErrorLn(const char * Message) const = 0;
	virtual void LogWarningLn(const char * Message) const = 0;
};

#endif