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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/*
* The Mana Client
* Copyright (C) 2010 The Mana Developers
*
* This file is part of The Mana Client.
*
* This program 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
* any later version.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EVENT_H
#define EVENT_H
#include <map>
#include <set>
#include <string>
class ActorSprite;
class Item;
namespace Mana
{
// Possible exception that can be thrown
enum BadEvent {
BAD_KEY,
BAD_VALUE,
KEY_ALREADY_EXISTS
};
class Listener;
typedef std::set<Listener *> ListenerSet;
typedef std::map<std::string, ListenerSet > ListenMap;
class VariableData;
typedef std::map<std::string, VariableData *> VariableMap;
#define SERVER_NOTICE(message) { \
Mana::Event event("ServerNotice"); \
event.setString("message", message); \
event.trigger("Notices", event); }
class Event
{
public:
/**
* Makes an event with the given name.
*/
Event(const std::string &name)
{ mEventName = name; }
~Event();
/**
* Returns the name of the event.
*/
const std::string &getName() const
{ return mEventName; }
// Integers
/**
* Sets the given variable to the given integer, if it isn't already set.
*/
void setInt(const std::string &key, int value) throw (BadEvent);
/**
* Returns the given variable if it is set and an integer.
*/
int getInt(const std::string &key) const throw (BadEvent);
/**
* Returns the given variable if it is set and an integer, returning the
* given default otherwise.
*/
inline int getInt(const std::string &key, int defaultValue) const
{ try { return getInt(key); } catch (BadEvent) { return defaultValue; }}
/**
* Returns true if the given variable exists and is an integer.
*/
bool hasInt(const std::string &key) const;
// Strings
/**
* Sets the given variable to the given string, if it isn't already set.
*/
void setString(const std::string &key, const std::string &value) throw (BadEvent);
/**
* Returns the given variable if it is set and a string.
*/
const std::string &getString(const std::string &key) const throw (BadEvent);
/**
* Returns the given variable if it is set and a string, returning the
* given default otherwise.
*/
inline std::string getString(const std::string &key,
const std::string &defaultValue) const
{ try { return getString(key); } catch (BadEvent) { return defaultValue; }}
/**
* Returns true if the given variable exists and is a string.
*/
bool hasString(const std::string &key) const;
// Floats
/**
* Sets the given variable to the given floating-point, if it isn't already
* set.
*/
void setFloat(const std::string &key, double value) throw (BadEvent);
/**
* Returns the given variable if it is set and a floating-point.
*/
double getFloat(const std::string &key) const throw (BadEvent);
/**
* Returns the given variable if it is set and a floating-point, returning
* the given default otherwise.
*/
inline double getFloat(const std::string &key, float defaultValue) const
{ try { return getFloat(key); } catch (BadEvent) { return defaultValue; }}
/**
* Returns true if the given variable exists and is a floating-point.
*/
bool hasFloat(const std::string &key) const;
// Booleans
/**
* Sets the given variable to the given boolean, if it isn't already set.
*/
void setBool(const std::string &key, bool value) throw (BadEvent);
/**
* Returns the given variable if it is set and a boolean.
*/
bool getBool(const std::string &key) const throw (BadEvent);
/**
* Returns the given variable if it is set and a boolean, returning the
* given default otherwise.
*/
inline bool getBool(const std::string &key, bool defaultValue) const
{ try { return getBool(key); } catch (BadEvent) { return defaultValue; }}
/**
* Returns true if the given variable exists and is a boolean.
*/
bool hasBool(const std::string &key) const;
// Items
/**
* Sets the given variable to the given Item, if it isn't already set.
*/
void setItem(const std::string &key, Item *value) throw (BadEvent);
/**
* Returns the given variable if it is set and an Item.
*/
Item *getItem(const std::string &key) const throw (BadEvent);
/**
* Returns the given variable if it is set and an Item, returning the
* given default otherwise.
*/
inline Item *getItem(const std::string &key, Item *defaultValue) const
{ try { return getItem(key); } catch (BadEvent) { return defaultValue; }}
/**
* Returns true if the given variable exists and is an Item.
*/
bool hasItem(const std::string &key) const;
// ActorSprites
/**
* Sets the given variable to the given actor, if it isn't already set.
*/
void setActor(const std::string &key, ActorSprite *value) throw (BadEvent);
/**
* Returns the given variable if it is set and an actor.
*/
ActorSprite *getActor(const std::string &key) const throw (BadEvent);
/**
* Returns the given variable if it is set and an actor, returning the
* given default otherwise.
*/
inline ActorSprite *getActor(const std::string &key,
ActorSprite *defaultValue) const
{ try { return getActor(key); } catch (BadEvent) { return defaultValue; }}
/**
* Returns true if the given variable exists and is an actor.
*/
bool hasActor(const std::string &key) const;
// Triggers
/**
* Sends this event to all classes listening to the given channel.
*/
inline void trigger(const std::string &channel) const
{ trigger(channel, *this); }
/**
* Sends the given event to all classes listening to the given channel.
*/
static void trigger(const std::string &channel, const Event &event);
/**
* Sends an empty event with the given name to all classes listening to the
* given channel.
*/
static inline void trigger(const std::string& channel,
const std::string& name)
{ trigger(channel, Mana::Event(name)); }
protected:
friend class Listener;
/**
* Binds the given listener to the given channel. The listener will receive
* all events triggered on the channel.
*/
static void bind(Listener *listener, const std::string &channel);
/**
* Unbinds the given listener from the given channel. The listener will no
* longer receive any events from the channel.
*/
static void unbind(Listener *listener, const std::string &channel);
/**
* Unbinds the given listener from all channels.
*/
static void remove(Listener *listener);
private:
static ListenMap mBindings;
std::string mEventName;
VariableMap mData;
};
} // namespace Mana
#endif
|
