154#include "vtkSetGet.h"
163#if defined(__clang__) || defined(__GNUC__)
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*
173#define VTK_PRINTF_LIKE(fmtarg, firstvararg)
174#define VTK_FORMAT_STRING_TYPE const char*
255 static void Init(
int& argc,
char* argv[],
const char* verbosity_flag =
"-v");
395#if !defined(__WRAP__)
408#if defined(_MSC_VER) && _MSC_VER > 1800
411 : Internals(other.Internals)
413 other.Internals =
nullptr;
423 LSInternals* Internals;
460#define vtkVLogF(level, ...) \
461 ((level) > vtkLogger::GetCurrentVerbosityCutoff()) \
463 : vtkLogger::LogF(level, __FILE__, __LINE__, __VA_ARGS__)
464#define vtkLogF(verbosity_name, ...) vtkVLogF(vtkLogger::VERBOSITY_##verbosity_name, __VA_ARGS__)
465#define vtkVLog(level, x) \
466 if ((level) <= vtkLogger::GetCurrentVerbosityCutoff()) \
468 vtkOStrStreamWrapper::EndlType endl; \
469 vtkOStrStreamWrapper::UseEndl(endl); \
470 vtkOStrStreamWrapper vtkmsg; \
472 vtkLogger::Log(level, __FILE__, __LINE__, vtkmsg.str()); \
473 vtkmsg.rdbuf()->freeze(0); \
475#define vtkLog(verbosity_name, x) vtkVLog(vtkLogger::VERBOSITY_##verbosity_name, x)
491#define vtkVLogIfF(level, cond, ...) \
492 ((level) > vtkLogger::GetCurrentVerbosityCutoff() || (cond) == false) \
494 : vtkLogger::LogF(level, __FILE__, __LINE__, __VA_ARGS__)
496#define vtkLogIfF(verbosity_name, cond, ...) \
497 vtkVLogIfF(vtkLogger::VERBOSITY_##verbosity_name, cond, __VA_ARGS__)
499#define vtkVLogIf(level, cond, x) \
500 if ((level) <= vtkLogger::GetCurrentVerbosityCutoff() && (cond)) \
502 vtkOStrStreamWrapper::EndlType endl; \
503 vtkOStrStreamWrapper::UseEndl(endl); \
504 vtkOStrStreamWrapper vtkmsg; \
506 vtkLogger::Log(level, __FILE__, __LINE__, vtkmsg.str()); \
507 vtkmsg.rdbuf()->freeze(0); \
509#define vtkLogIf(verbosity_name, cond, x) vtkVLogIf(vtkLogger::VERBOSITY_##verbosity_name, cond, x)
512#define VTKLOG_CONCAT_IMPL(s1, s2) s1##s2
513#define VTKLOG_CONCAT(s1, s2) VTKLOG_CONCAT_IMPL(s1, s2)
514#define VTKLOG_ANONYMOUS_VARIABLE(x) VTKLOG_CONCAT(x, __LINE__)
516#define vtkVLogScopeF(level, ...) \
517 auto VTKLOG_ANONYMOUS_VARIABLE(msg_context) = ((level) > vtkLogger::GetCurrentVerbosityCutoff()) \
518 ? vtkLogger::LogScopeRAII() \
519 : vtkLogger::LogScopeRAII(level, __FILE__, __LINE__, __VA_ARGS__)
521#define vtkLogScopeF(verbosity_name, ...) \
522 vtkVLogScopeF(vtkLogger::VERBOSITY_##verbosity_name, __VA_ARGS__)
524#define vtkLogScopeFunction(verbosity_name) vtkLogScopeF(verbosity_name, "%s", __func__)
525#define vtkVLogScopeFunction(level) vtkVLogScopeF(level, "%s", __func__)
532#define vtkLogStartScope(verbosity_name, id) \
533 vtkLogger::StartScope(vtkLogger::VERBOSITY_##verbosity_name, id, __FILE__, __LINE__)
534#define vtkLogEndScope(id) vtkLogger::EndScope(id)
536#define vtkLogStartScopeF(verbosity_name, id, ...) \
537 vtkLogger::StartScopeF(vtkLogger::VERBOSITY_##verbosity_name, id, __FILE__, __LINE__, __VA_ARGS__)
539#define vtkVLogStartScope(level, id) vtkLogger::StartScope(level, id, __FILE__, __LINE__)
540#define vtkVLogStartScopeF(level, id, ...) \
541 vtkLogger::StartScopeF(level, id, __FILE__, __LINE__, __VA_ARGS__)
549#define vtkLogIdentifier(vtkobject) vtkLogger::GetIdentifier(vtkobject).c_str()
a simple class to control print indentation
LogScopeRAII(vtkLogger::Verbosity verbosity, const char *fname, unsigned int lineno, VTK_FORMAT_STRING_TYPE format,...) VTK_PRINTF_LIKE(5
LogScopeRAII(LogScopeRAII &&)=default
static bool EnableUnsafeSignalHandler
Flag to enable/disable the logging frameworks printing of a stack trace when catching signals,...
static Verbosity ConvertToVerbosity(int value)
Convenience function to convert an integer to matching verbosity level.
static void static void StartScopeF(Verbosity verbosity, const char *id, VTK_FILEPATH const char *fname, unsigned int lineno, VTK_FORMAT_STRING_TYPE format,...) VTK_PRINTF_LIKE(5
void(*)(void *user_data) CloseHandlerCallbackT
Callback handle types.
void(*)(void *user_data, const Message &message) LogHandlerCallbackT
Callback handle types.
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.
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...
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)
static void LogToFile(const char *path, FileMode filemode, Verbosity verbosity)
Enable logging to a file at the given path.
void operator=(const vtkObjectBase &)
The message structure that is passed to custom callbacks registered using vtkLogger::AddCallback.
#define VTK_FORMAT_STRING_TYPE
#define VTK_PRINTF_LIKE(fmtarg, firstvararg)