blob: 10fe96bc6a1126e2e8a75b6a741e96708e5d3f73 (
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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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 (at your option) 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef COMMON_OSD_MESSAGE_QUEUE_H
#define COMMON_OSD_MESSAGE_QUEUE_H
#include "common/events.h"
#include "common/singleton.h"
#include "common/str.h"
#include "common/queue.h"
#include "common/mutex.h"
namespace Common {
/**
* Queue OSD messages from any thread to be displayed by the graphic thread.
*/
class OSDMessageQueue : public Singleton<OSDMessageQueue>, public EventSource {
public:
OSDMessageQueue();
~OSDMessageQueue();
void registerEventSource();
enum {
kMinimumDelay = 1000 /** < Minimum delay between two OSD messages (in milliseconds) */
};
/**
* Add a message to the OSD message queue.
*/
void addMessage(const char *msg);
/**
* Common::EventSource interface
*
* The OSDMessageQueue registers itself as an event source even if it does not
* actually produce events as a mean to be polled periodically by the GUI or
* engine code.
*
* The periodical polling is used to update the OSD messages.
*/
virtual bool pollEvent(Common::Event &event) override;
private:
Mutex _mutex;
Queue<String> _messages;
uint32 _lastUpdate;
};
} // End of namespace Common
#endif
|
