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
|
/*
* This file is part of the Colobot: Gold Edition source code
* Copyright (C) 2001-2023, Daniel Roux, EPSITEC SA & TerranovaTeam
* http://epsitec.ch; http://colobot.info; http://github.com/colobot
*
* 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 3 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, see http://gnu.org/licenses
*/
/**
* \file common/logger.h
* \brief Class for logging information to file or console
*/
#pragma once
#include "common/singleton.h"
#include <string>
#include <cstdarg>
#include <cstdio>
#include <vector>
/**
* \public
* \enum LogLevel common/logger.h
* \brief Enum representing log level
**/
enum LogLevel
{
LOG_TRACE = 1, /*!< lowest level, execution tracing */
LOG_DEBUG = 2, /*!< debugging messages */
LOG_INFO = 3, /*!< information */
LOG_WARN = 4, /*!< warning */
LOG_ERROR = 5, /*!< error */
LOG_NONE = 6 /*!< none level, used for custom messages */
};
/**
* @class CLogger
*
* @brief Class for loggin information to file or console
*
*/
class CLogger : public CSingleton<CLogger>
{
public:
CLogger();
~CLogger();
/** Write message to console or file
* \param str - message to write
* \param ... - additional arguments
*/
void Message(const char *str, ...);
/** Write message to console or file with LOG_TRACE level
* \param str - message to write
* \param ... - additional arguments
*/
void Trace(const char *str, ...);
/** Write message to console or file with LOG_DEBUG level
* \param str - message to write
* \param ... - additional arguments
*/
void Debug(const char *str, ...);
/** Write message to console or file with LOG_INFO level
* \param str - message to write
* \param ... - additional arguments
*/
void Info(const char *str, ...);
/** Write message to console or file with LOG_WARN level
* \param str - message to write
* \param ... - additional arguments
*/
void Warn(const char *str, ...);
/** Write message to console or file with LOG_ERROR level
* \param str - message to write
* \param ... - additional arguments
*/
void Error(const char *str, ...);
/** Write message to console or file with given log level
* \param logLevel - log level
* \param str - message to write
* \param ... - additional arguments
*/
void Log(LogLevel logLevel, const char *str, ...);
/** Set output file to write logs to
* The given file will be automatically closed when the logger exits
* \param file - file pointer to write to
*/
void AddOutput(FILE* file);
/** Set log level. Logs with level below will not be shown
* \param level - minimum log level to write
*/
void SetLogLevel(LogLevel level);
/** Parses string as a log level
* \param str string to parse
* \param logLevel result log level
*
* Valid values are "trace", "debug", "info", "warn", "error" and "none".
* On invalid value, returns \c false.
*/
static bool ParseLogLevel(const std::string& str, LogLevel& logLevel);
private:
std::vector<FILE*> m_outputs;
LogLevel m_logLevel;
void Log(LogLevel type, const char* str, va_list args);
};
//! Global function to get Logger instance
inline CLogger* GetLogger()
{
return CLogger::GetInstancePointer();
}
|