VTK  9.1.0
vtkLogger.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLogger.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
150#ifndef vtkLogger_h
151#define vtkLogger_h
152
153#include "vtkObjectBase.h"
154#include "vtkSetGet.h" // needed for macros
155
156#include <string> // needed for std::string
157
158#if defined(_MSC_VER)
159#include <sal.h> // Needed for _In_z_ etc annotations
160#endif
161
162// this is copied from `loguru.hpp`
163#if defined(__clang__) || defined(__GNUC__)
164// Helper macro for declaring functions as having similar signature to printf.
165// This allows the compiler to catch format errors at compile-time.
166#define VTK_PRINTF_LIKE(fmtarg, firstvararg) \
167 __attribute__((__format__(__printf__, fmtarg, firstvararg)))
168#define VTK_FORMAT_STRING_TYPE const char*
169#elif defined(_MSC_VER)
170#define VTK_PRINTF_LIKE(fmtarg, firstvararg)
171#define VTK_FORMAT_STRING_TYPE _In_z_ _Printf_format_string_ const char*
172#else
173#define VTK_PRINTF_LIKE(fmtarg, firstvararg)
174#define VTK_FORMAT_STRING_TYPE const char*
175#endif
176
177class VTKCOMMONCORE_EXPORT vtkLogger : public vtkObjectBase
178{
179public:
181 void PrintSelf(ostream& os, vtkIndent indent) override;
182
184 {
185 // Used to mark an invalid verbosity. Do not log to this level.
186 VERBOSITY_INVALID = -10, // Never do LOG_F(INVALID)
187
188 // You may use VERBOSITY_OFF on g_stderr_verbosity, but for nothing else!
189 VERBOSITY_OFF = -9, // Never do LOG_F(OFF)
190
191 VERBOSITY_ERROR = -2,
192 VERBOSITY_WARNING = -1,
193
194 // Normal messages. By default written to stderr.
195 VERBOSITY_INFO = 0,
196
197 // Same as VERBOSITY_INFO in every way.
198 VERBOSITY_0 = 0,
199
200 // Verbosity levels 1-9 are generally not written to stderr, but are written to file.
201 VERBOSITY_1 = +1,
202 VERBOSITY_2 = +2,
203 VERBOSITY_3 = +3,
204 VERBOSITY_4 = +4,
205 VERBOSITY_5 = +5,
206 VERBOSITY_6 = +6,
207 VERBOSITY_7 = +7,
208 VERBOSITY_8 = +8,
209 VERBOSITY_9 = +9,
210
211 // trace level, same as VERBOSITY_9
212 VERBOSITY_TRACE = +9,
213
214 // Don not use higher verbosity levels, as that will make grepping log files harder.
215 VERBOSITY_MAX = +9,
216 };
217
255 static void Init(int& argc, char* argv[], const char* verbosity_flag = "-v");
256 static void Init();
265 static void SetStderrVerbosity(Verbosity level);
266
274
280 {
282 APPEND
283 };
284
291 static void LogToFile(const char* path, FileMode filemode, Verbosity verbosity);
292
296 static void EndLogToFile(const char* path);
297
299
302 static void SetThreadName(const std::string& name);
303 static std::string GetThreadName();
305
309 static std::string GetIdentifier(vtkObjectBase* obj);
310
315 struct Message
316 {
317 // You would generally print a Message by just concatenating the buffers without spacing.
318 // Optionally, ignore preamble and indentation.
319 Verbosity verbosity; // Already part of preamble
320 const char* filename; // Already part of preamble
321 unsigned line; // Already part of preamble
322 const char* preamble; // Date, time, uptime, thread, file:line, verbosity.
323 const char* indentation; // Just a bunch of spacing.
324 const char* prefix; // Assertion failure info goes here (or "").
325 const char* message; // User message goes here.
326 };
327
329
332 using LogHandlerCallbackT = void (*)(void* user_data, const Message& message);
333 using CloseHandlerCallbackT = void (*)(void* user_data);
334 using FlushHandlerCallbackT = void (*)(void* user_data);
336
346 static void AddCallback(const char* id, LogHandlerCallbackT callback, void* user_data,
347 Verbosity verbosity, CloseHandlerCallbackT on_close = nullptr,
348 FlushHandlerCallbackT on_flush = nullptr);
349
354 static bool RemoveCallback(const char* id);
355
359 static bool IsEnabled();
360
367
374 static Verbosity ConvertToVerbosity(int value);
375
382 static Verbosity ConvertToVerbosity(const char* text);
383
385
390 static void Log(
391 Verbosity verbosity, VTK_FILEPATH const char* fname, unsigned int lineno, const char* txt);
392 static void StartScope(
393 Verbosity verbosity, const char* id, VTK_FILEPATH const char* fname, unsigned int lineno);
394 static void EndScope(const char* id);
395#if !defined(__WRAP__)
396 static void LogF(Verbosity verbosity, VTK_FILEPATH const char* fname, unsigned int lineno,
397 VTK_FORMAT_STRING_TYPE format, ...) VTK_PRINTF_LIKE(4, 5);
398 static void StartScopeF(Verbosity verbosity, const char* id, VTK_FILEPATH const char* fname,
399 unsigned int lineno, VTK_FORMAT_STRING_TYPE format, ...) VTK_PRINTF_LIKE(5, 6);
400
401 class VTKCOMMONCORE_EXPORT LogScopeRAII
402 {
403 public:
405 LogScopeRAII(vtkLogger::Verbosity verbosity, const char* fname, unsigned int lineno,
406 VTK_FORMAT_STRING_TYPE format, ...) VTK_PRINTF_LIKE(5, 6);
408#if defined(_MSC_VER) && _MSC_VER > 1800
409 // see loguru.hpp for the reason why this is needed on MSVC
411 : Internals(other.Internals)
412 {
413 other.Internals = nullptr;
414 }
415#else
417#endif
418
419 private:
420 LogScopeRAII(const LogScopeRAII&) = delete;
421 void operator=(const LogScopeRAII&) = delete;
422 class LSInternals;
423 LSInternals* Internals;
424 };
425#endif
427
434
435protected:
437 ~vtkLogger() override;
438
439private:
440 vtkLogger(const vtkLogger&) = delete;
441 void operator=(const vtkLogger&) = delete;
442 static vtkLogger::Verbosity InternalVerbosityLevel;
443 static std::string ThreadName;
444};
445
447
461#define vtkVLogF(level, ...) \
462 ((level) > vtkLogger::GetCurrentVerbosityCutoff()) \
463 ? (void)0 \
464 : vtkLogger::LogF(level, __FILE__, __LINE__, __VA_ARGS__)
465#define vtkLogF(verbosity_name, ...) vtkVLogF(vtkLogger::VERBOSITY_##verbosity_name, __VA_ARGS__)
466#define vtkVLog(level, x) \
467 if ((level) <= vtkLogger::GetCurrentVerbosityCutoff()) \
468 { \
469 vtkOStrStreamWrapper::EndlType endl; \
470 vtkOStrStreamWrapper::UseEndl(endl); \
471 vtkOStrStreamWrapper vtkmsg; \
472 vtkmsg << "" x; \
473 vtkLogger::Log(level, __FILE__, __LINE__, vtkmsg.str()); \
474 vtkmsg.rdbuf()->freeze(0); \
475 }
476#define vtkLog(verbosity_name, x) vtkVLog(vtkLogger::VERBOSITY_##verbosity_name, x)
478
480
492#define vtkVLogIfF(level, cond, ...) \
493 ((level) > vtkLogger::GetCurrentVerbosityCutoff() || (cond) == false) \
494 ? (void)0 \
495 : vtkLogger::LogF(level, __FILE__, __LINE__, __VA_ARGS__)
496
497#define vtkLogIfF(verbosity_name, cond, ...) \
498 vtkVLogIfF(vtkLogger::VERBOSITY_##verbosity_name, cond, __VA_ARGS__)
499
500#define vtkVLogIf(level, cond, x) \
501 if ((level) <= vtkLogger::GetCurrentVerbosityCutoff() && (cond)) \
502 { \
503 vtkOStrStreamWrapper::EndlType endl; \
504 vtkOStrStreamWrapper::UseEndl(endl); \
505 vtkOStrStreamWrapper vtkmsg; \
506 vtkmsg << "" x; \
507 vtkLogger::Log(level, __FILE__, __LINE__, vtkmsg.str()); \
508 vtkmsg.rdbuf()->freeze(0); \
509 }
510#define vtkLogIf(verbosity_name, cond, x) vtkVLogIf(vtkLogger::VERBOSITY_##verbosity_name, cond, x)
512
513#define VTKLOG_CONCAT_IMPL(s1, s2) s1##s2
514#define VTKLOG_CONCAT(s1, s2) VTKLOG_CONCAT_IMPL(s1, s2)
515#define VTKLOG_ANONYMOUS_VARIABLE(x) VTKLOG_CONCAT(x, __LINE__)
516
517#define vtkVLogScopeF(level, ...) \
518 auto VTKLOG_ANONYMOUS_VARIABLE(msg_context) = ((level) > vtkLogger::GetCurrentVerbosityCutoff()) \
519 ? vtkLogger::LogScopeRAII() \
520 : vtkLogger::LogScopeRAII(level, __FILE__, __LINE__, __VA_ARGS__)
521
522#define vtkLogScopeF(verbosity_name, ...) \
523 vtkVLogScopeF(vtkLogger::VERBOSITY_##verbosity_name, __VA_ARGS__)
524
525#define vtkLogScopeFunction(verbosity_name) vtkLogScopeF(verbosity_name, "%s", __func__)
526#define vtkVLogScopeFunction(level) vtkVLogScopeF(level, "%s", __func__)
527
529
533#define vtkLogStartScope(verbosity_name, id) \
534 vtkLogger::StartScope(vtkLogger::VERBOSITY_##verbosity_name, id, __FILE__, __LINE__)
535#define vtkLogEndScope(id) vtkLogger::EndScope(id)
536
537#define vtkLogStartScopeF(verbosity_name, id, ...) \
538 vtkLogger::StartScopeF(vtkLogger::VERBOSITY_##verbosity_name, id, __FILE__, __LINE__, __VA_ARGS__)
539
540#define vtkVLogStartScope(level, id) vtkLogger::StartScope(level, id, __FILE__, __LINE__)
541#define vtkVLogStartScopeF(level, id, ...) \
542 vtkLogger::StartScopeF(level, id, __FILE__, __LINE__, __VA_ARGS__)
544
550#define vtkLogIdentifier(vtkobject) vtkLogger::GetIdentifier(vtkobject).c_str()
551
552#endif
a simple class to control print indentation
Definition: vtkIndent.h:34
LogScopeRAII(vtkLogger::Verbosity verbosity, const char *fname, unsigned int lineno, VTK_FORMAT_STRING_TYPE format,...) VTK_PRINTF_LIKE(5
LogScopeRAII(LogScopeRAII &&)=default
logging framework for use in VTK and in applications based on VTK
Definition: vtkLogger.h:178
static bool EnableUnsafeSignalHandler
Flag to enable/disable the logging frameworks printing of a stack trace when catching signals,...
Definition: vtkLogger.h:433
static Verbosity ConvertToVerbosity(int value)
Convenience function to convert an integer to matching verbosity level.
void(*)(void *user_data) CloseHandlerCallbackT
Callback handle types.
Definition: vtkLogger.h:333
void(*)(void *user_data, const Message &message) LogHandlerCallbackT
Callback handle types.
Definition: vtkLogger.h:332
static bool RemoveCallback(const char *id)
Remove a callback using the id specified.
static std::string GetIdentifier(vtkObjectBase *obj)
Returns a printable string for a vtkObjectBase instance.
static void EndScope(const char *id)
vtkBaseTypeMacro(vtkLogger, vtkObjectBase)
static std::string GetThreadName()
Get/Set the name to identify the current thread in the log output.
static void SetInternalVerbosityLevel(Verbosity level)
Set internal messages verbosity level.
void(*)(void *user_data) FlushHandlerCallbackT
Callback handle types.
Definition: vtkLogger.h:334
static void AddCallback(const char *id, LogHandlerCallbackT callback, void *user_data, Verbosity verbosity, CloseHandlerCallbackT on_close=nullptr, FlushHandlerCallbackT on_flush=nullptr)
Add a callback to call on each log message with a verbosity less or equal to the given one.
static bool IsEnabled()
Returns true if VTK is built with logging support enabled.
static void SetThreadName(const std::string &name)
Get/Set the name to identify the current thread in the log output.
static Verbosity ConvertToVerbosity(const char *text)
Convenience function to convert a string to matching verbosity level.
static void Init()
Initializes logging.
static void EndLogToFile(const char *path)
Stop logging to a file at the given path.
static void Init(int &argc, char *argv[], const char *verbosity_flag="-v")
Initializes logging.
static void Log(Verbosity verbosity, VTK_FILEPATH const char *fname, unsigned int lineno, const char *txt)
static void SetStderrVerbosity(Verbosity level)
Set the verbosity level for the output logged to stderr.
FileMode
Support log file modes: TRUNCATE truncates the file clearing any existing contents while APPEND appen...
Definition: vtkLogger.h:280
static void LogF(Verbosity verbosity, VTK_FILEPATH const char *fname, unsigned int lineno, VTK_FORMAT_STRING_TYPE format,...) VTK_PRINTF_LIKE(4
static Verbosity GetCurrentVerbosityCutoff()
Returns the maximum verbosity of all log outputs.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void StartScope(Verbosity verbosity, const char *id, VTK_FILEPATH const char *fname, unsigned int lineno)
~vtkLogger() override
static void LogToFile(const char *path, FileMode filemode, Verbosity verbosity)
Enable logging to a file at the given path.
abstract base class for most VTK objects
Definition: vtkObjectBase.h:70
void operator=(const vtkObjectBase &)
The message structure that is passed to custom callbacks registered using vtkLogger::AddCallback.
Definition: vtkLogger.h:316
const char * filename
Definition: vtkLogger.h:320
const char * preamble
Definition: vtkLogger.h:322
Verbosity verbosity
Definition: vtkLogger.h:319
const char * message
Definition: vtkLogger.h:325
const char * indentation
Definition: vtkLogger.h:323
const char * prefix
Definition: vtkLogger.h:324
#define VTK_FORMAT_STRING_TYPE
Definition: vtkLogger.h:174
#define VTK_PRINTF_LIKE(fmtarg, firstvararg)
Definition: vtkLogger.h:173
#define VTK_FILEPATH