blob: 90c3a689fa1a51514a713e23463aa50da1c5342d (
plain) (
blame)
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
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2013 The ManaPlus Developers
*
* This file is part of The ManaPlus 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 LOGGER_H
#define LOGGER_H
#include "main.h"
#include <fstream>
#include "localconsts.h"
class ChatWindow;
#ifdef ENABLEDEBUGLOG
#define DEBUGLOG(msg) if (logger) logger->dlog(msg)
#else
#define DEBUGLOG(msg) {}
#endif
/**
* The Log Class : Useful to write debug or info messages
*/
class Logger final
{
public:
/**
* Constructor.
*/
Logger();
A_DELETE_COPY(Logger)
/**
* Destructor, closes log file.
*/
~Logger();
/**
* Sets the file to log to and opens it
*/
void setLogFile(const std::string &logFilename);
/**
* Sets whether the log should be written to standard output.
*/
void setLogToStandardOut(const bool value)
{ mLogToStandardOut = value; }
/**
* Enables logging to chat window
*/
void setChatWindow(ChatWindow *const window)
{ mChatWindow = window; }
/**
* Enters a message in the log. The message will be timestamped.
*/
void log(const char *const log_text, ...)
#ifdef __GNUC__
#ifdef __OpenBSD__
__attribute__((__format__(printf, 2, 3)))
#else
__attribute__((__format__(gnu_printf, 2, 3)))
#endif
#endif
;
/**
* Enters a message in the log. The message will be timestamped.
*/
void log1(const char *const log_text);
/**
* Enters a message in the log. The message will be timestamped.
*/
void log(const std::string &str);
#ifdef ENABLEDEBUGLOG
/**
* Enters debug message in the log. The message will be timestamped.
*/
void dlog(const std::string &str);
#endif
void setDebugLog(const bool n)
{ mDebugLog = n; }
/**
* Log an error and quit. The error will pop-up on Windows and Mac, and
* will be printed to standard error everywhere else.
*/
void error(const std::string &error_text) __attribute__ ((noreturn));
/**
* Log an error and quit. The error will pop-up on Windows and Mac, and
* will be printed to standard error everywhere else.
*/
void safeError(const std::string &error_text)
__attribute__ ((noreturn));
private:
std::ofstream mLogFile;
bool mLogToStandardOut;
ChatWindow *mChatWindow;
bool mDebugLog;
};
extern Logger *logger;
#endif // LOGGER_H
|
