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
|
/*
* The Mana Server
* Copyright (C) 2004-2010 The Mana World Development Team
* Copyright (C) 2010 The Mana Development Team
*
* This file is part of The Mana Server.
*
* The Mana Server 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.
*
* The Mana Server 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 The Mana Server. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LOGGER_H
#define LOGGER_H
#include <iosfwd>
#include <sstream>
#include <iostream>
namespace utils
{
/**
* A very simple logger that writes messages to a log file.
* If the log file is not set, the messages are routed to the standard output
* or the standard error depending on the level of the message.
* By default, the messages will be timestamped but the logger can be
* configured to not prefix the messages with a timestamp.
*
* Limitations:
* - not thread-safe.
*
* Example of use:
*
* <pre>
* \#include "logger.h"
*
* int main()
* {
* using namespace utils;
*
* Logger::setLogFile("/path/to/logfile");
*
* // log messages using helper macros.
* LOG_DEBUG("level: " << 3)
* LOG_INFO("init sound")
* LOG_WARN("not implemented")
* LOG_ERROR("resource not found")
* LOG_FATAL("unable to init graphics")
*
* // log messages using APIs.
* std::ostringstream os;
* os << "level: " << 3;
* Logger::output(os.str(), Logger::Debug);
*
* Logger::output("init sound", Logger::Info);
* Logger::output("not implemented", Logger::Warn);
* Logger::output("resource not found", Logger::Error);
* Logger::output("unable to init graphics", Logger::Fatal);
*
* return 0;
* }
* </pre>
*/
class Logger
{
public:
enum Level
{
Fatal = 0,
Error,
Warn,
Info,
Debug
};
static void initialize(const std::string &logFile);
/**
* Sets the log file.
*
* This method will open the log file for writing, the former file
* contents are removed.
*
* @param logFile the log file name (may include path).
* @param append whether the file is cleaned up before logging in.
*
* @exception std::ios::failure if the log file could not be opened.
*/
static void setLogFile(const std::string &logFile, bool append = false);
/**
* Add/removes the timestamp.
*
* @param flag if true, a log message will always be timestamped
* (default = true).
*/
static void setTimestamp(bool flag = true)
{ mHasTimestamp = flag; }
/**
* Sets tee mode.
*
* @param flag if true, write messages to both the standard (or error)
* output and the log file (if set) (default = true).
*/
static void setTeeMode(bool flag = true)
{ mTeeMode = flag; }
/**
* Sets the verbosity level of the logger.
*
* @param verbosity is the level of verbosity.
*/
static void setVerbosity(Level verbosity)
{ mVerbosity = verbosity; }
/**
* Enable logrotation based on the maximum filesize given in
* setMaxLogfileSize.
*
* @param enable Set to true to enable logrotation.
*/
static void setLogRotation(bool enable)
{ mLogRotation = enable; }
/**
* Sets the maximum size of a logfile before logrotation occurs.
*
* @param kiloBytes Maximum size of logfile in bytes. Defaults to 1MB.
*/
static void setMaxLogfileSize(long kiloBytes = 1024)
{ mMaxFileSize = kiloBytes; }
/**
* Sets whether the logfile switches when changing date.
*
* @param switchLogEachDay Keeps whether the parameter is activated.
*/
static void setSwitchLogEachDay(bool switchLogEachDay)
{ mSwitchLogEachDay = switchLogEachDay; }
/**
* Logs a generic message.
*
* @param msg the message to log.
*
* @param atVerbosity the minimum verbosity level
* to log this
*
* @exception std::ios::failure.
*/
static void output(const std::string &msg, Level atVerbosity);
static Level mVerbosity; /**< Verbosity level. */
private:
static bool mHasTimestamp; /**< Timestamp flag. */
static bool mTeeMode; /**< Tee mode flag. */
static std::string mFilename; /**< Name of the current logfile. */
/** Enable rotation of logfiles by size. */
static bool mLogRotation;
/** Maximum size of current logfile in bytes */
static long mMaxFileSize;
/** Sets whether the logfile switches when changing date. */
static bool mSwitchLogEachDay;
/**
* Logs a generic message.
*
* @param os the output stream.
* @param msg the message to log.
* @param prefix the message prefix.
*
* @exception std::ios::failure.
*/
static void output(std::ostream &os, const std::string &msg,
const char *prefix);
/**
* Switch the log file based on a maximum size
* and/or and a date change.
*/
static void switchLogs();
};
/**
* Class for temporarily debugging things that are actually not interesting
* to include in the log.
*
* It is used for automatically ending with a newline, putting spaces in
* between different parameters and quoting strings.
*/
class Debug
{
public:
~Debug() { std::cout << std::endl; }
template <class T>
Debug &operator << (T t)
{
std::cout << t << " ";
return *this;
}
};
template <>
inline Debug &Debug::operator << (const std::string &t)
{
std::cout << "\"" << t << "\" ";
return *this;
}
} // namespace utils
// HELPER MACROS
#define LOG(level, msg) \
do if (::utils::Logger::mVerbosity >= ::utils::Logger::level) { \
std::ostringstream os; \
os << msg; \
::utils::Logger::output(os.str(), ::utils::Logger::level); \
} while (0)
#define LOG_DEBUG(msg) LOG(Debug, msg)
#define LOG_INFO(msg) LOG(Info, msg)
#define LOG_WARN(msg) LOG(Warn, msg)
#define LOG_ERROR(msg) LOG(Error, msg)
#define LOG_FATAL(msg) LOG(Fatal, msg)
/**
* Returns an instance of the debug class for printing out a line.
*
* Usage: debug() << "testing" << a << b;
*/
inline ::utils::Debug debug() { return ::utils::Debug(); }
#endif // LOGGER_H
|
