forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkLogger.cxx
447 lines (405 loc) · 12.2 KB
/
vtkLogger.cxx
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
/*=========================================================================
Program: Visualization Toolkit
Module: vtkLogger.cxx
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
#include "vtkLogger.h"
#include "vtkObjectFactory.h"
#if VTK_MODULE_ENABLE_VTK_loguru
#include <vtk_loguru.h>
#endif
#include <cstdlib>
#include <memory>
#include <mutex>
#include <sstream>
#include <thread>
#include <unordered_map>
#include <vector>
//=============================================================================
class vtkLogger::LogScopeRAII::LSInternals
{
public:
#if VTK_MODULE_ENABLE_VTK_loguru
std::unique_ptr<loguru::LogScopeRAII> Data;
#endif
};
vtkLogger::LogScopeRAII::LogScopeRAII()
: Internals(nullptr)
{
}
vtkLogger::LogScopeRAII::LogScopeRAII(
vtkLogger::Verbosity verbosity, const char* fname, unsigned int lineno, const char* format, ...)
#if VTK_MODULE_ENABLE_VTK_loguru
: Internals(new LSInternals())
#else
: Internals(nullptr)
#endif
{
#if VTK_MODULE_ENABLE_VTK_loguru
va_list vlist;
va_start(vlist, format);
auto result = loguru::vstrprintf(format, vlist);
va_end(vlist);
this->Internals->Data.reset(new loguru::LogScopeRAII(
static_cast<loguru::Verbosity>(verbosity), fname, lineno, "%s", result.c_str()));
#else
(void)verbosity;
(void)fname;
(void)lineno;
(void)format;
#endif
}
vtkLogger::LogScopeRAII::~LogScopeRAII()
{
delete this->Internals;
}
//=============================================================================
namespace detail
{
#if VTK_MODULE_ENABLE_VTK_loguru
using scope_pair = std::pair<std::string, std::shared_ptr<loguru::LogScopeRAII>>;
static std::mutex g_mutex;
static std::unordered_map<std::thread::id, std::vector<scope_pair>> g_vectors;
static std::vector<scope_pair>& get_vector()
{
std::lock_guard<std::mutex> guard(g_mutex);
return g_vectors[std::this_thread::get_id()];
}
static void push_scope(const char* id, std::shared_ptr<loguru::LogScopeRAII> ptr)
{
get_vector().emplace_back(std::string(id), ptr);
}
static void pop_scope(const char* id)
{
auto& vector = get_vector();
if (!vector.empty() && vector.back().first == id)
{
vector.pop_back();
if (vector.empty())
{
std::lock_guard<std::mutex> guard(g_mutex);
g_vectors.erase(std::this_thread::get_id());
}
}
else
{
LOG_F(ERROR, "Mismatched scope! expected (%s), got (%s)", vector.back().first.c_str(), id);
}
}
#endif
}
//=============================================================================
bool vtkLogger::EnableUnsafeSignalHandler = true;
vtkLogger::Verbosity vtkLogger::InternalVerbosityLevel = vtkLogger::VERBOSITY_1;
std::string vtkLogger::ThreadName;
//------------------------------------------------------------------------------
vtkLogger::vtkLogger() = default;
//------------------------------------------------------------------------------
vtkLogger::~vtkLogger() = default;
//------------------------------------------------------------------------------
void vtkLogger::Init(int& argc, char* argv[], const char* verbosity_flag /*= "-v"*/)
{
#if VTK_MODULE_ENABLE_VTK_loguru
if (argc == 0)
{ // loguru::init can't handle this case -- call the no-arg overload.
vtkLogger::Init();
return;
}
loguru::g_preamble_date = false;
loguru::g_preamble_time = false;
loguru::g_internal_verbosity = static_cast<loguru::Verbosity>(vtkLogger::InternalVerbosityLevel);
const auto current_stderr_verbosity = loguru::g_stderr_verbosity;
if (loguru::g_internal_verbosity > loguru::g_stderr_verbosity)
{
// this avoids printing the preamble-header on stderr except for cases
// where the stderr log is guaranteed to have some log text generated.
loguru::g_stderr_verbosity = loguru::Verbosity_WARNING;
}
loguru::Options options;
options.verbosity_flag = verbosity_flag;
options.unsafe_signal_handler = vtkLogger::EnableUnsafeSignalHandler;
if (!vtkLogger::ThreadName.empty())
{
options.main_thread_name = vtkLogger::ThreadName.c_str();
}
loguru::init(argc, argv, options);
loguru::g_stderr_verbosity = current_stderr_verbosity;
#else
(void)argc;
(void)argv;
(void)verbosity_flag;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::Init()
{
int argc = 1;
char dummy[1] = { '\0' };
char* argv[2] = { dummy, nullptr };
vtkLogger::Init(argc, argv);
}
//------------------------------------------------------------------------------
void vtkLogger::SetStderrVerbosity(vtkLogger::Verbosity level)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::g_stderr_verbosity = static_cast<loguru::Verbosity>(level);
#else
(void)level;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::SetInternalVerbosityLevel(vtkLogger::Verbosity level)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::g_internal_verbosity = static_cast<loguru::Verbosity>(level);
vtkLogger::InternalVerbosityLevel = level;
#else
(void)level;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::LogToFile(
const char* path, vtkLogger::FileMode filemode, vtkLogger::Verbosity verbosity)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::add_file(
path, static_cast<loguru::FileMode>(filemode), static_cast<loguru::Verbosity>(verbosity));
#else
(void)path;
(void)filemode;
(void)verbosity;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::EndLogToFile(const char* path)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::remove_callback(path);
#else
(void)path;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::SetThreadName(const std::string& name)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::set_thread_name(name.c_str());
// Save threadname so if this is called before `Init`, we can pass the thread
// name to loguru::init().
vtkLogger::ThreadName = name;
#else
(void)name;
#endif
}
//------------------------------------------------------------------------------
std::string vtkLogger::GetThreadName()
{
#if VTK_MODULE_ENABLE_VTK_loguru
char buffer[128];
loguru::get_thread_name(buffer, 128, false);
return std::string(buffer);
#else
return std::string("N/A");
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::AddCallback(const char* id, vtkLogger::LogHandlerCallbackT callback,
void* user_data, vtkLogger::Verbosity verbosity, vtkLogger::CloseHandlerCallbackT on_close,
vtkLogger::FlushHandlerCallbackT on_flush)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::add_callback(id, reinterpret_cast<loguru::log_handler_t>(callback), user_data,
static_cast<loguru::Verbosity>(verbosity), reinterpret_cast<loguru::close_handler_t>(on_close),
reinterpret_cast<loguru::flush_handler_t>(on_flush));
#else
(void)id;
(void)callback;
(void)user_data;
(void)verbosity;
(void)on_close;
(void)on_flush;
#endif
}
//------------------------------------------------------------------------------
bool vtkLogger::RemoveCallback(const char* id)
{
#if VTK_MODULE_ENABLE_VTK_loguru
return loguru::remove_callback(id);
#else
(void)id;
return false;
#endif
}
//------------------------------------------------------------------------------
std::string vtkLogger::GetIdentifier(vtkObjectBase* obj)
{
if (obj)
{
std::ostringstream str;
str << obj->GetClassName() << " (" << obj << ")";
return str.str();
}
return "(nullptr)";
}
//------------------------------------------------------------------------------
void vtkLogger::PrintSelf(ostream& os, vtkIndent indent)
{
this->vtkObjectBase::PrintSelf(os, indent);
}
//------------------------------------------------------------------------------
bool vtkLogger::IsEnabled()
{
#if VTK_MODULE_ENABLE_VTK_loguru
return true;
#else
return false;
#endif
}
//------------------------------------------------------------------------------
vtkLogger::Verbosity vtkLogger::GetCurrentVerbosityCutoff()
{
#if VTK_MODULE_ENABLE_VTK_loguru
return static_cast<vtkLogger::Verbosity>(loguru::current_verbosity_cutoff());
#else
return VERBOSITY_INVALID; // return lowest value so no logging macros will be evaluated.
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::Log(
vtkLogger::Verbosity verbosity, const char* fname, unsigned int lineno, const char* txt)
{
#if VTK_MODULE_ENABLE_VTK_loguru
loguru::log(static_cast<loguru::Verbosity>(verbosity), fname, lineno, "%s", txt);
#else
(void)verbosity;
(void)fname;
(void)lineno;
(void)txt;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::LogF(
vtkLogger::Verbosity verbosity, const char* fname, unsigned int lineno, const char* format, ...)
{
#if VTK_MODULE_ENABLE_VTK_loguru
va_list vlist;
va_start(vlist, format);
auto result = loguru::vstrprintf(format, vlist);
va_end(vlist);
vtkLogger::Log(verbosity, fname, lineno, result.c_str());
#else
(void)verbosity;
(void)fname;
(void)lineno;
(void)format;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::StartScope(
Verbosity verbosity, const char* id, const char* fname, unsigned int lineno)
{
#if VTK_MODULE_ENABLE_VTK_loguru
detail::push_scope(id,
verbosity > vtkLogger::GetCurrentVerbosityCutoff()
? std::make_shared<loguru::LogScopeRAII>()
: std::make_shared<loguru::LogScopeRAII>(
static_cast<loguru::Verbosity>(verbosity), fname, lineno, "%s", id));
#else
(void)verbosity;
(void)id;
(void)fname;
(void)lineno;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::EndScope(const char* id)
{
#if VTK_MODULE_ENABLE_VTK_loguru
detail::pop_scope(id);
#else
(void)id;
#endif
}
//------------------------------------------------------------------------------
void vtkLogger::StartScopeF(Verbosity verbosity, const char* id, const char* fname,
unsigned int lineno, const char* format, ...)
{
#if VTK_MODULE_ENABLE_VTK_loguru
if (verbosity > vtkLogger::GetCurrentVerbosityCutoff())
{
detail::push_scope(id, std::make_shared<loguru::LogScopeRAII>());
}
else
{
va_list vlist;
va_start(vlist, format);
auto result = loguru::vstrprintf(format, vlist);
va_end(vlist);
detail::push_scope(id,
std::make_shared<loguru::LogScopeRAII>(
static_cast<loguru::Verbosity>(verbosity), fname, lineno, "%s", result.c_str()));
}
#else
(void)verbosity;
(void)id;
(void)fname;
(void)lineno;
(void)format;
#endif
}
//------------------------------------------------------------------------------
vtkLogger::Verbosity vtkLogger::ConvertToVerbosity(int value)
{
if (value <= vtkLogger::VERBOSITY_INVALID)
{
return vtkLogger::VERBOSITY_INVALID;
}
else if (value > vtkLogger::VERBOSITY_MAX)
{
return vtkLogger::VERBOSITY_MAX;
}
return static_cast<vtkLogger::Verbosity>(value);
}
//------------------------------------------------------------------------------
vtkLogger::Verbosity vtkLogger::ConvertToVerbosity(const char* text)
{
if (text != nullptr)
{
char* end = nullptr;
const int ivalue = static_cast<int>(std::strtol(text, &end, 10));
if (end != text && *end == '\0')
{
return vtkLogger::ConvertToVerbosity(ivalue);
}
if (!strcmp(text, "OFF"))
{
return vtkLogger::VERBOSITY_OFF;
}
else if (!strcmp(text, "ERROR"))
{
return vtkLogger::VERBOSITY_ERROR;
}
else if (!strcmp(text, "WARNING"))
{
return vtkLogger::VERBOSITY_WARNING;
}
else if (!strcmp(text, "INFO"))
{
return vtkLogger::VERBOSITY_INFO;
}
else if (!strcmp(text, "TRACE"))
{
return vtkLogger::VERBOSITY_TRACE;
}
else if (!strcmp(text, "MAX"))
{
return vtkLogger::VERBOSITY_MAX;
}
}
return vtkLogger::VERBOSITY_INVALID;
}