log.h
8.94 KB
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
/* ****************************************************************************
* Copyright 2019 Open Systems Development BV *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the "Software"), *
* to deal in the Software without restriction, including without limitation *
* the rights to use, copy, modify, merge, publish, distribute, sublicense, *
* and/or sell copies of the Software, and to permit persons to whom the *
* Software is furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included in *
* all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *
* DEALINGS IN THE SOFTWARE. *
* ***************************************************************************/
#pragma once
#include <string>
#include <mutex>
#include <syslog.h>
namespace osdev {
namespace components {
namespace log {
#define LogEmergency(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Emergency)\
{ \
osdev::components::log::Log::emergency(__FILE__, __LINE__, context, text); \
}
#define LogAlert(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Alert) \
{ \
osdev::components::log::Log::alert(__FILE__, __LINE__, context, text); \
}
#define LogCritical(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Critical) \
{ \
osdev::components::log::Log::critical(__FILE__, __LINE__, context, text); \
}
#define LogError(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Error) \
{ \
osdev::components::log::Log::error(__FILE__, __LINE__, context, text); \
}
#define LogWarning(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Warning) \
{ \
osdev::components::log::Log::warning(__FILE__, __LINE__, context, text); \
}
#define LogNotice(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Notice) \
{ \
osdev::components::log::Log::notice(__FILE__, __LINE__, context, text); \
}
#define LogInfo(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Info) \
{ \
osdev::components::log::Log::info(__FILE__, __LINE__, context, text); \
}
#define LogDebug(context, text) \
if (osdev::components::log::Log::level() >= osdev::components::log::LogLevel::Debug) \
{ \
osdev::components::log::Log::debug(__FILE__, __LINE__, context, text); \
}
enum class LogLevel
{
Emergency = 0,
Alert,
Critical,
Error,
Warning,
Notice,
Info,
Debug
};
enum class LogMask
{
Mask = 0,
Upto,
None
};
/*! \class Log
\brief Basic logging mechanism.
*/
class Log
{
public:
static void init( const std::string& context,
const std::string& logFile = std::string(),
LogLevel logDepth = LogLevel::Info );
static void terminate();
static void write( const int &priority, const std::string &message, const std::string &context = std::string() );
static void emergency( const char* file, int line, const std::string& category, const std::string& message );
static void alert ( const char* file, int line, const std::string& category, const std::string& message );
static void critical ( const char* file, int line, const std::string& category, const std::string& message );
static void error ( const char* file, int line, const std::string& category, const std::string& message );
static void warning ( const char* file, int line, const std::string& category, const std::string& message );
static void notice ( const char* file, int line, const std::string& category, const std::string& message );
static void info ( const char* file, int line, const std::string& category, const std::string& message );
static void debug ( const char* file, int line, const std::string& category, const std::string& message );
/**
* @return The current log level.
*/
static LogLevel level()
{
if( s_logMask == LogMask::None )
{
return LogLevel::Debug;
}
return s_logLevel;
}
static void setMask ( LogMask logMask ) { s_logMask = logMask; }
static void setLogLevel( LogLevel logLevel ) { s_logLevel = logLevel; }
static void setContext ( std::string context ) { s_context = context; }
protected:
static void emergency( const std::string& category, const std::string& message );
static void alert ( const std::string& category, const std::string& message );
static void critical ( const std::string& category, const std::string& message );
static void error ( const std::string& category, const std::string& message );
static void warning ( const std::string& category, const std::string& message );
static void notice ( const std::string& category, const std::string& message );
static void info ( const std::string& category, const std::string& message );
static void debug ( const std::string& category, const std::string& message );
/**
* @brief Log an error message in a category.
* @param category The category of the message.
* @param message The string to print.
* @param level Selected log level
*/
static void log( const std::string &category,
const std::string &message,
LogLevel level );
private:
/**
* @brief Replace the characters in a std::string with other characters.
* @param strToReplace The string we want to replace characters in
* @param from_chars The characters we want to replace
* @param to_chars The characters we want to replace with.
* @return strToReplace This is the original string with the replaced characters.
*/
static void ReplaceAll( std::string &strToReplace, const std::string& from_chars, const std::string& to_chars );
/**
* @brief Put filename, line-number and message in one string
* @param file Source-file
* @param line Line in source-file
* @param message The string to print
* @return Formatted string with file, line and message
*/
static std::string fileinfoMessage(const char* file, int line,
const std::string& message);
//! The main context.
static std::string s_context;
//! The name of the LogFile.
static std::string s_fileName;
//! The amount of logging
static LogLevel s_logLevel;
//! The mask
static LogMask s_logMask;
//! Mutex to keep the logger thread-safe
static std::mutex m_mutex;
};
} // End namespace log
} // End namespace components
} // End namespace osdev