-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLog.cpp
More file actions
391 lines (311 loc) · 10.3 KB
/
Log.cpp
File metadata and controls
391 lines (311 loc) · 10.3 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
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
/*
Copyright (C) 1998-2007 Emil Maskovsky
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
@file
Logging subsystem (implementation).
@author Emil Maskovsky
*/
/* Framework libraries. */
#include "mx/LogStdE.hpp"
/* Application specific. */
#include "mx/Log.hpp"
/**
Unregister log target.
Unregisters the log target, if currently registered in the handler.
@param [in] pTarget The log target to be unregistered.
@return
Returns @c true, if the @p pTarget was unregistered (i.e. was registered
before). Returns @c false if current target registered within the handler is
other than the @p pTarget.
*/
/* static */ bool mx::Log::UnregisterTarget(const LogHandler * const pTarget)
{
/// @todo Thread safety.
if (pTarget == sm_pTarget)
{
SetActiveTarget(LogStdErr::Instance());
return true;
}
return false;
}
/**
Flush active log target, if any.
*/
/* static */ void mx::Log::Flush()
{
if (GetActiveTarget())
{
GetActiveTarget()->Flush();
}
}
/// Currently active log target.
/* static */ mx::LogHandler * mx::Log::sm_pTarget = mx::LogStdErr::Instance();
/// File information engine status.
/* static */ bool mx::Log::sm_bFileInfoEnabled = true;
/**
Log the message.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
*/
MX_PRINTFLIKE_METHOD(1, 2) mx::Size mx::Log::LogMessage(
const Char * sFormat, ...) const
{
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogMessage(sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Log the message (vararg version).
@param [in] sFormat @c printf(3) like formatting string.
@param [in] pArguments Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
*/
mx::Size mx::Log::LogMessage(
const Char * sFormat, va_list pArguments) const
{
LogHandler * const pTarget = Log::GetActiveTarget();
if (!pTarget)
{
// None active target selected - logging entirely disabled.
return 0;
}
// Log the message to the log target.
return pTarget->DoLog(m_xFileInfo, m_iType, sFormat, pArguments);
}
/**
Special method for logging of fatal errors.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
This method does never return, always causes the application shutdown via the
standard function abort().
*/
MX_PRINTFLIKE_METHOD(1, 2) MX_NORETURN_TYPE(mx::Size) mx::Log::LogFatal(
const Char * sFormat, ...) const
{
va_list pArgs;
va_start(pArgs, sFormat);
// Does not return.
const Size iResult = LogFatal(sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Special method for logging of fatal errors (vararg version).
@param [in] sFormat @c printf(3) like formatting string.
@param [in] pArguments Argument list matching the @a sFormat string.
@return
This method does never return, always causes the application shutdown via the
standard function abort().
*/
// Does not need to be inline, it cannot be called more than once.
MX_NORETURN_TYPE(mx::Size) mx::Log::LogFatal(
const Char * sFormat, va_list pArguments) const
{
const Size iResult = LogMessage(sFormat, pArguments);
abort();
return iResult;
}
/**
Special method for logging of assertion failure messages.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
This method does never return, always causes the application shutdown via the
standard function abort().
*/
MX_PRINTFLIKE_METHOD(1, 2) MX_NORETURN_TYPE(mx::Size) mx::Log::LogAssert(
const Char * sFormat, ...) const
{
va_list pArgs;
va_start(pArgs, sFormat);
// Does not return.
const Size iResult = LogAssert(sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Special method for logging of assertion failure messages (vararg version).
@param [in] sFormat @c printf(3) like formatting string.
@param [in] pArguments Argument list matching the @a sFormat string.
@return
This method does never return, always causes the application shutdown via the
standard function abort().
*/
// Does not need to be inline, it cannot be called more than once.
MX_NORETURN_TYPE(mx::Size) mx::Log::LogAssert(
const Char * sFormat, va_list pArguments) const
{
return LogFatal(sFormat, pArguments);
}
#ifdef MXCPP_DEBUG_ENABLED
/**
Special method for logging of debug messages.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
*/
MX_PRINTFLIKE_METHOD(1, 2) mx::Size mx::Log::LogDebug(
const Char * sFormat, ...) const
{
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogDebug(sFormat, pArgs);
va_end(pArgs);
return iResult;
}
#endif // MXCPP_DEBUG_ENABLED
/**
Special method for logging of trace messages.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
@note
In addition to normal logging functions behavior, the logging will not be
done and the value of @c 0 will be returned in the case, that the tracing
is disabled for requested trace class and priority level.
*/
MX_PRINTFLIKE_METHOD(1, 2) mx::Size mx::Log::LogTrace(
const Char * sFormat, ...) const
{
if (!Log::TracingEnabled())
{
return 0;
}
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogTrace(sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Special method for logging of trace messages.
@param [in] iClass Trace class.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
@note
In addition to normal logging functions behavior, the logging will not be
done and the value of @c 0 will be returned in the case, that the tracing
is disabled for requested trace class and priority level.
*/
MX_PRINTFLIKE_METHOD(2, 3) mx::Size mx::Log::LogTrace(
const TraceClass iClass,
const Char * sFormat, ...) const
{
if (!Log::TracingEnabled(iClass))
{
return 0;
}
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogTrace(iClass, sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Special method for logging of trace messages.
@param [in] iClass Trace class.
@param [in] iLevel Trace priority level.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
@note
In addition to normal logging functions behavior, the logging will not be
done and the value of @c 0 will be returned in the case, that the tracing
is disabled for requested trace class and priority level.
*/
MX_PRINTFLIKE_METHOD(3, 4) mx::Size mx::Log::LogTrace(
const TraceClass iClass,
const TraceLevel iLevel,
const Char * sFormat, ...) const
{
if (!Log::TracingEnabled(iClass, iLevel))
{
return 0;
}
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogTrace(iClass, iLevel, sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Special method for logging of trace messages (string trace mask variant).
@param [in] sClass Trace class.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
@note
In addition to normal logging functions behavior, the logging will not be
done and the value of @c 0 will be returned in the case, that the tracing
is disabled for requested trace class and priority level.
*/
MX_PRINTFLIKE_METHOD(2, 3) mx::Size mx::Log::LogTrace(
const Char * const sClass,
const Char * sFormat, ...) const
{
if (!Log::TracingEnabled(sClass))
{
return 0;
}
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogTrace(sClass, sFormat, pArgs);
va_end(pArgs);
return iResult;
}
/**
Special method for logging of trace messages (string trace mask variant).
@param [in] sClass Trace class.
@param [in] iLevel Trace priority level.
@param [in] sFormat @c printf(3) like formatting string.
@param [in] ... Argument list matching the @a sFormat string.
@return
See LogHandler::DoLog() for description of return values.
@note
In addition to normal logging functions behavior, the logging will not be
done and the value of @c 0 will be returned in the case, that the tracing
is disabled for requested trace class and priority level.
*/
MX_PRINTFLIKE_METHOD(3, 4) mx::Size mx::Log::LogTrace(
const Char * const sClass,
const TraceLevel iLevel,
const Char * sFormat, ...) const
{
if (!Log::TracingEnabled(sClass, iLevel))
{
return 0;
}
va_list pArgs;
va_start(pArgs, sFormat);
const Size iResult = LogTrace(sClass, iLevel, sFormat, pArgs);
va_end(pArgs);
return iResult;
}
// Define inline methods here if inlining is disabled.
#ifndef MX_INLINE_ENABLED
#include "mx/Log.inl"
#endif
/* EOF */