μHAL (v2.8.17)
Part of the IPbus software repository
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
log.cpp
Go to the documentation of this file.
1
2#include <mutex> // for lock_guard, mutex
3#include <stdlib.h> // for getenv
4
5#include "uhal/log/LogLevels.hpp" // for BaseLogLevel, Info, Info...
6#include "uhal/log/log.hpp" // for log
7#include "uhal/log/log_inserters.quote.hpp" // for operator<<, Quote
8
9
10namespace uhal{
11
12// ======================================================================================================================================================
13// WARNING! This file is automatically generated! Do not modify it! Any changes will be overwritten!
14// ======================================================================================================================================================
15
16void setLogLevelFromEnvironment ( const char* aEnvVar )
17{
18 char * lEnvVar = getenv ( aEnvVar );
19 if( !lEnvVar )
20 {
21 log( Warning() , "No environment variable " , Quote( aEnvVar ) , " set. Using level " , Quote( "Info" ) , " instead." );
22 setLogLevelTo ( Info() );
23 return;
24 }
25
26 //Just comparing the first letter of the environment variable for speed!!!
27 switch ( lEnvVar[0] )
28 {
29 case 'f' :
30 case 'F' :
31 setLogLevelTo ( Fatal() );
32 break;
33 case 'e' :
34 case 'E' :
35 setLogLevelTo ( Error() );
36 break;
37 case 'w' :
38 case 'W' :
39 setLogLevelTo ( Warning() );
40 break;
41 case 'n' :
42 case 'N' :
43 setLogLevelTo ( Notice() );
44 break;
45 case 'i' :
46 case 'I' :
47 setLogLevelTo ( Info() );
48 break;
49 case 'd' :
50 case 'D' :
51 setLogLevelTo ( Debug() );
52 break;
53 default:
54
55 log ( Warning() , "Environment varible has invalid value " , Quote( lEnvVar ) , ". Using level " , Quote ( "Info" ) , " instead." );
56 setLogLevelTo ( Info() );
57 }
58}
59
60// ======================================================================================================================================================
61// WARNING! This file is automatically generated! Do not modify it! Any changes will be overwritten!
62// ======================================================================================================================================================
63
64void disableLogging()
65{
66 log_configuration::mLoggingIncludesFatal = false;
67 log_configuration::mLoggingIncludesError = false;
68 log_configuration::mLoggingIncludesWarning = false;
69 log_configuration::mLoggingIncludesNotice = false;
70 log_configuration::mLoggingIncludesInfo = false;
71 log_configuration::mLoggingIncludesDebug = false;
72}
73
74// ======================================================================================================================================================
75// WARNING! This file is automatically generated! Do not modify it! Any changes will be overwritten!
76// ======================================================================================================================================================
77
78std::mutex& GetLoggingMutex()
79{
80 return log_configuration::mMutex;
81}
82
83// ======================================================================================================================================================
84// WARNING! This file is automatically generated! Do not modify it! Any changes will be overwritten!
85// ======================================================================================================================================================
86
87void setLogLevelTo ( const FatalLevel& )
88{
89 #ifndef LOGGING_EXCLUDE_FATAL // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
90 log_configuration::mLoggingIncludesFatal = true;
91 log_configuration::mLoggingIncludesError = false;
92 log_configuration::mLoggingIncludesWarning = false;
93 log_configuration::mLoggingIncludesNotice = false;
94 log_configuration::mLoggingIncludesInfo = false;
95 log_configuration::mLoggingIncludesDebug = false;
96 #endif
97}
98
99const bool& LoggingIncludes ( const FatalLevel& )
100{
101 #ifndef LOGGING_EXCLUDE_FATAL
102 return log_configuration::mLoggingIncludesFatal;
103 #endif
104 return log_configuration::mFalse;
105}
106
107void setLogLevelTo ( const ErrorLevel& )
108{
109 #ifndef LOGGING_EXCLUDE_FATAL // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
110 log_configuration::mLoggingIncludesFatal = true;
111 #ifndef LOGGING_EXCLUDE_ERROR // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
112 log_configuration::mLoggingIncludesError = true;
113 log_configuration::mLoggingIncludesWarning = false;
114 log_configuration::mLoggingIncludesNotice = false;
115 log_configuration::mLoggingIncludesInfo = false;
116 log_configuration::mLoggingIncludesDebug = false;
117 #endif
118 #endif
119}
120
121const bool& LoggingIncludes ( const ErrorLevel& )
122{
123 #ifndef LOGGING_EXCLUDE_FATAL
124 #ifndef LOGGING_EXCLUDE_ERROR
125 return log_configuration::mLoggingIncludesError;
126 #endif
127 #endif
128 return log_configuration::mFalse;
129}
130
131void setLogLevelTo ( const WarningLevel& )
132{
133 #ifndef LOGGING_EXCLUDE_FATAL // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
134 log_configuration::mLoggingIncludesFatal = true;
135 #ifndef LOGGING_EXCLUDE_ERROR // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
136 log_configuration::mLoggingIncludesError = true;
137 #ifndef LOGGING_EXCLUDE_WARNING // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
138 log_configuration::mLoggingIncludesWarning = true;
139 log_configuration::mLoggingIncludesNotice = false;
140 log_configuration::mLoggingIncludesInfo = false;
141 log_configuration::mLoggingIncludesDebug = false;
142 #endif
143 #endif
144 #endif
145}
146
147const bool& LoggingIncludes ( const WarningLevel& )
148{
149 #ifndef LOGGING_EXCLUDE_FATAL
150 #ifndef LOGGING_EXCLUDE_ERROR
151 #ifndef LOGGING_EXCLUDE_WARNING
152 return log_configuration::mLoggingIncludesWarning;
153 #endif
154 #endif
155 #endif
156 return log_configuration::mFalse;
157}
158
159void setLogLevelTo ( const NoticeLevel& )
160{
161 #ifndef LOGGING_EXCLUDE_FATAL // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
162 log_configuration::mLoggingIncludesFatal = true;
163 #ifndef LOGGING_EXCLUDE_ERROR // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
164 log_configuration::mLoggingIncludesError = true;
165 #ifndef LOGGING_EXCLUDE_WARNING // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
166 log_configuration::mLoggingIncludesWarning = true;
167 #ifndef LOGGING_EXCLUDE_NOTICE // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
168 log_configuration::mLoggingIncludesNotice = true;
169 log_configuration::mLoggingIncludesInfo = false;
170 log_configuration::mLoggingIncludesDebug = false;
171 #endif
172 #endif
173 #endif
174 #endif
175}
176
177const bool& LoggingIncludes ( const NoticeLevel& )
178{
179 #ifndef LOGGING_EXCLUDE_FATAL
180 #ifndef LOGGING_EXCLUDE_ERROR
181 #ifndef LOGGING_EXCLUDE_WARNING
182 #ifndef LOGGING_EXCLUDE_NOTICE
183 return log_configuration::mLoggingIncludesNotice;
184 #endif
185 #endif
186 #endif
187 #endif
188 return log_configuration::mFalse;
189}
190
191void setLogLevelTo ( const InfoLevel& )
192{
193 #ifndef LOGGING_EXCLUDE_FATAL // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
194 log_configuration::mLoggingIncludesFatal = true;
195 #ifndef LOGGING_EXCLUDE_ERROR // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
196 log_configuration::mLoggingIncludesError = true;
197 #ifndef LOGGING_EXCLUDE_WARNING // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
198 log_configuration::mLoggingIncludesWarning = true;
199 #ifndef LOGGING_EXCLUDE_NOTICE // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
200 log_configuration::mLoggingIncludesNotice = true;
201 #ifndef LOGGING_EXCLUDE_INFO // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
202 log_configuration::mLoggingIncludesInfo = true;
203 log_configuration::mLoggingIncludesDebug = false;
204 #endif
205 #endif
206 #endif
207 #endif
208 #endif
209}
210
211const bool& LoggingIncludes ( const InfoLevel& )
212{
213 #ifndef LOGGING_EXCLUDE_FATAL
214 #ifndef LOGGING_EXCLUDE_ERROR
215 #ifndef LOGGING_EXCLUDE_WARNING
216 #ifndef LOGGING_EXCLUDE_NOTICE
217 #ifndef LOGGING_EXCLUDE_INFO
218 return log_configuration::mLoggingIncludesInfo;
219 #endif
220 #endif
221 #endif
222 #endif
223 #endif
224 return log_configuration::mFalse;
225}
226
227void setLogLevelTo ( const DebugLevel& )
228{
229 #ifndef LOGGING_EXCLUDE_FATAL // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
230 log_configuration::mLoggingIncludesFatal = true;
231 #ifndef LOGGING_EXCLUDE_ERROR // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
232 log_configuration::mLoggingIncludesError = true;
233 #ifndef LOGGING_EXCLUDE_WARNING // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
234 log_configuration::mLoggingIncludesWarning = true;
235 #ifndef LOGGING_EXCLUDE_NOTICE // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
236 log_configuration::mLoggingIncludesNotice = true;
237 #ifndef LOGGING_EXCLUDE_INFO // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
238 log_configuration::mLoggingIncludesInfo = true;
239 #ifndef LOGGING_EXCLUDE_DEBUG // A waste of time to change any level below this if it is going to disabled by compile-time checking anyway...
240 log_configuration::mLoggingIncludesDebug = true;
241 #endif
242 #endif
243 #endif
244 #endif
245 #endif
246 #endif
247}
248
249const bool& LoggingIncludes ( const DebugLevel& )
250{
251 #ifndef LOGGING_EXCLUDE_FATAL
252 #ifndef LOGGING_EXCLUDE_ERROR
253 #ifndef LOGGING_EXCLUDE_WARNING
254 #ifndef LOGGING_EXCLUDE_NOTICE
255 #ifndef LOGGING_EXCLUDE_INFO
256 #ifndef LOGGING_EXCLUDE_DEBUG
257 return log_configuration::mLoggingIncludesDebug;
258 #endif
259 #endif
260 #endif
261 #endif
262 #endif
263 #endif
264 return log_configuration::mFalse;
265}
266
267bool log_configuration::mLoggingIncludesFatal = true; // No #ifdefs required here since they are implemented in all the access functions.
268bool log_configuration::mLoggingIncludesError = true; // No #ifdefs required here since they are implemented in all the access functions.
269bool log_configuration::mLoggingIncludesWarning = true; // No #ifdefs required here since they are implemented in all the access functions.
270bool log_configuration::mLoggingIncludesNotice = true; // No #ifdefs required here since they are implemented in all the access functions.
271bool log_configuration::mLoggingIncludesInfo = true; // No #ifdefs required here since they are implemented in all the access functions.
272bool log_configuration::mLoggingIncludesDebug = false; // No #ifdefs required here since they are implemented in all the access functions.
273
274const bool log_configuration::mTrue = true;
275const bool log_configuration::mFalse = false;
276
277std::mutex log_configuration::mMutex;
278
279// ======================================================================================================================================================
280// WARNING! This file is automatically generated! Do not modify it! Any changes will be overwritten!
281// ======================================================================================================================================================
282
283}
284
uhal::DebugLevel
Helper struct representing the Debug log level to allow us to specialize functions according to their...
Definition: LogLevels.hpp:159
uhal::ErrorLevel
Helper struct representing the Error log level to allow us to specialize functions according to their...
Definition: LogLevels.hpp:100
uhal::FatalLevel
Helper struct representing the Fatal log level to allow us to specialize functions according to their...
Definition: LogLevels.hpp:85
uhal::InfoLevel
Helper struct representing the Info log level to allow us to specialize functions according to their ...
Definition: LogLevels.hpp:145
uhal::NoticeLevel
Helper struct representing the Notice log level to allow us to specialize functions according to thei...
Definition: LogLevels.hpp:130
uhal::WarningLevel
Helper struct representing the Warning log level to allow us to specialize functions according to the...
Definition: LogLevels.hpp:116
uhal::log_configuration::mFalse
static const bool mFalse
Define a static const member variable to have a value of false so that we can safely return a const r...
Definition: log.hpp:155
uhal::log_configuration::mLoggingIncludesNotice
static bool mLoggingIncludesNotice
static bool storing whether the Notice level is to be included in the log output
Definition: log.hpp:132
uhal::log_configuration::mLoggingIncludesWarning
static bool mLoggingIncludesWarning
static bool storing whether the Warning level is to be included in the log output
Definition: log.hpp:125
uhal::log_configuration::mLoggingIncludesFatal
static bool mLoggingIncludesFatal
static bool storing whether the Fatal level is to be included in the log output
Definition: log.hpp:111
uhal::log_configuration::mLoggingIncludesError
static bool mLoggingIncludesError
static bool storing whether the Error level is to be included in the log output
Definition: log.hpp:118
uhal::log_configuration::mMutex
static std::mutex mMutex
Define a static Mutex lock for thread safe logging.
Definition: log.hpp:160
uhal::log_configuration::mLoggingIncludesDebug
static bool mLoggingIncludesDebug
static bool storing whether the Debug level is to be included in the log output
Definition: log.hpp:146
uhal::log_configuration::mLoggingIncludesInfo
static bool mLoggingIncludesInfo
static bool storing whether the Info level is to be included in the log output
Definition: log.hpp:139
uhal::log_configuration::mTrue
static const bool mTrue
Define a static const member variable to have a value of true so that we can safely return a const re...
Definition: log.hpp:153
log_inserters.quote.hpp
uhal::Debug
DebugLevel Debug
Definition: LogLevels.cpp:133
uhal::Quote
_Quote< T > Quote(const T &aT)
Definition: log_inserters.quote.hxx:49
uhal::setLogLevelTo
void setLogLevelTo(const FatalLevel &)
Function to specify, at runtime, that only messages with a severity level above Fatal should be logge...
Definition: log.cpp:87
uhal::LoggingIncludes
const bool & LoggingIncludes(const FatalLevel &)
Function to check at runtime whether the level Fatal is to be included in the log output.
Definition: log.cpp:99
uhal::Error
ErrorLevel Error
Definition: LogLevels.cpp:61
uhal::log
void log(FatalLevel &aFatal, const T0 &aArg0)
Function to add a log entry at Fatal level.
Definition: log.hxx:18
uhal::GetLoggingMutex
std::mutex & GetLoggingMutex()
Function to retrieve the mutex lock used by the logger.
Definition: log.cpp:78
uhal::disableLogging
void disableLogging()
Function to disable all logging levels.
Definition: log.cpp:64
uhal::Fatal
FatalLevel Fatal
Definition: LogLevels.cpp:43
uhal::Warning
WarningLevel Warning
Definition: LogLevels.cpp:79
uhal::Info
InfoLevel Info
Definition: LogLevels.cpp:115
uhal::Notice
NoticeLevel Notice
Definition: LogLevels.cpp:97
uhal::setLogLevelFromEnvironment
void setLogLevelFromEnvironment(const char *aEnvVar)
Function to specify that the logging level should be retrieved from an environment variable.
Definition: log.cpp:16
Generated on Sat Mar 15 2025 17:14:07 for μHAL (v2.8.17) by doxygen 1.9.5