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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#ifndef LOG_SINK_HANDLER_H
#define LOG_SINK_HANDLER_H
#include <string>
#include <vector>
/**
* C++/OO API for log sinks.
* @see MulticastLogSink
*/
class ILogSink {
public:
virtual void RecordLogMessage(const std::string& section, int level,
const std::string& text) = 0;
protected:
~ILogSink() {}
};
/**
* Sends log messages to ILogSink implementations.
*/
class LogSinkHandler {
public:
LogSinkHandler();
~LogSinkHandler();
void AddSink(ILogSink* logSink);
void RemoveSink(ILogSink* logSink);
/**
* @brief Enables/Disables sinking to registered sinks
*
* The list of registered sinks does not get altered when calling this
* function, just its use is enabled or disabled.
* Used, for example, in case the info-console and other in game
* subscribers should not be notified anymore (eg. SDL shutdown).
*/
void SetSinking(bool enabled);
/**
* Indicates whether sinking to registered sinks is enabled
*
* The initial value is true.
*/
bool IsSinking() const;
void RecordLogMessage(const std::string& section, int level,
const std::string& text) const;
private:
std::vector<ILogSink*> sinks;
/**
* Whether log records are passed on to registered sinks, or dismissed.
*/
bool sinking;
};
extern LogSinkHandler logSinkHandler;
#endif // LOG_SINK_HANDLER_H
|
