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
|
// -----------------------------------------------------------------------------
// 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
// -----------------------------------------------------------------------------
// Alle Callbackfunktionen die von Objekten gerufen werden, die persistiert werden k�nnen, m�ssen hier registriert werden.
// Beim Speichern wird statt des Pointers der Bezeichner gespeichert. Beim Laden wird der Bezeichner wieder in einen Pointer umgewandelt.
// Diese Klasse f�hrt also so etwas �hnliches wie eine Importtabelle f�r Callback-Funktionen.
//
// Dieses Vorgehen hat mehrere Vorteile:
// 1. Die Speicherst�nde sind plattformunabh�ngig. Es werden keine Pointer auf Funktionen gespeichert, sondern nur Namen von Callbackfunktionen.
// Diese k�nnen beim Laden �ber diese Klasse in systemabh�ngige Pointer umgewandelt werden.
// 2. Speicherst�nde k�nnen auch nach einem Engineupdate weiterhin benutzt werden. Beim Erstellen einer neun Binary verschieben sich h�ufig die
// Funktionen. Eine Callbackfunktion k�nnte sich also nach einem Update an einer anderen Stelle befinden als davor. Wenn im Spielstand der
// Pointer gespeichert war, st�rtzt das Programm beim �ufrufen dieser Callbackfunktion ab. Durch das Aufl�sungverfahren wird beim Laden der
// Callbackbezeichner in den neuen Funktionspointer umgewandelt und der Aufruf kann erfolgen.
// -----------------------------------------------------------------------------
// Logging
// -----------------------------------------------------------------------------
#define BS_LOG_PREFIX "CALLBACKREGISTRY"
// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
#include "callbackregistry.h"
// -----------------------------------------------------------------------------
bool BS_CallbackRegistry::RegisterCallbackFunction(const std::string & Name, void * Ptr)
{
if (Name == "")
{
BS_LOG_ERRORLN("The empty string is not allowed as a callback function name.");
return false;
}
if (FindPtrByName(Name) != 0)
{
BS_LOG_ERRORLN("There is already a callback function with the name \"%s\".", Name.c_str());
return false;
}
if (FindNameByPtr(Ptr) != "")
{
BS_LOG_ERRORLN("There is already a callback function with the pointer 0x%x.", Ptr);
return false;
}
StoreCallbackFunction(Name, Ptr);
return true;
}
// -----------------------------------------------------------------------------
void * BS_CallbackRegistry::ResolveCallbackFunction(const std::string & Name) const
{
void * Result = FindPtrByName(Name);
if (!Result)
{
BS_LOG_ERRORLN("There is no callback function with the name \"%s\".", Name.c_str());
}
return Result;
}
// -----------------------------------------------------------------------------
std::string BS_CallbackRegistry::ResolveCallbackPointer(void * Ptr) const
{
const std::string & Result = FindNameByPtr(Ptr);
if (Result == "")
{
BS_LOG_ERRORLN("There is no callback function with the pointer 0x%x.", Ptr);
}
return Result;
}
// -----------------------------------------------------------------------------
void * BS_CallbackRegistry::FindPtrByName(const std::string & Name) const
{
// Eintrag in der Map finden und den Pointer zur�ckgeben.
NameToPtrMap::const_iterator It = m_NameToPtrMap.find(Name);
return It == m_NameToPtrMap.end() ? 0 : It->second;
}
// -----------------------------------------------------------------------------
std::string BS_CallbackRegistry::FindNameByPtr(void * Ptr) const
{
// Eintrag in der Map finden und den Namen zur�ckgeben.
PtrToNameMap::const_iterator It = m_PtrToNameMap.find(Ptr);
return It == m_PtrToNameMap.end() ? "" : It->second;
}
// -----------------------------------------------------------------------------
void BS_CallbackRegistry::StoreCallbackFunction(const std::string & Name, void * Ptr)
{
// Callback-Funktion in beide Maps eintragen.
m_NameToPtrMap[Name] = Ptr;
m_PtrToNameMap[Ptr] = Name;
}
|
