145 #include "vtkSetGet.h"
149 #if defined(_MSC_VER)
154 #if defined(__clang__) || defined(__GNUC__)
157 #define VTK_PRINTF_LIKE(fmtarg, firstvararg) \
158 __attribute__((__format__(__printf__, fmtarg, firstvararg)))
159 #define VTK_FORMAT_STRING_TYPE const char*
160 #elif defined(_MSC_VER)
161 #define VTK_PRINTF_LIKE(fmtarg, firstvararg)
162 #define VTK_FORMAT_STRING_TYPE _In_z_ _Printf_format_string_ const char*
164 #define VTK_PRINTF_LIKE(fmtarg, firstvararg)
165 #define VTK_FORMAT_STRING_TYPE const char*
168 VTK_ABI_NAMESPACE_BEGIN
178 VERBOSITY_INVALID = -10,
183 VERBOSITY_ERROR = -2,
184 VERBOSITY_WARNING = -1,
204 VERBOSITY_TRACE = +9,
247 static void Init(
int& argc,
char* argv[],
const char* verbosity_flag =
"-v");
257 static void SetStderrVerbosity(Verbosity
level);
265 static void SetInternalVerbosityLevel(Verbosity
level);
283 static void LogToFile(
const char* path, FileMode filemode, Verbosity verbosity);
288 static void EndLogToFile(
const char* path);
346 static bool RemoveCallback(
const char*
id);
351 static bool IsEnabled();
358 static Verbosity GetCurrentVerbosityCutoff();
374 static Verbosity ConvertToVerbosity(
const char* text);
384 static void StartScope(
386 static void EndScope(
const char*
id);
387 #if !defined(__WRAP__)
400 #if defined(_MSC_VER) && _MSC_VER > 1800
402 LogScopeRAII(LogScopeRAII&& other)
403 : Internals(other.Internals)
405 other.Internals =
nullptr;
408 LogScopeRAII(LogScopeRAII&&) =
default;
412 LogScopeRAII(
const LogScopeRAII&) =
delete;
413 void operator=(
const LogScopeRAII&) =
delete;
415 LSInternals* Internals;
452 #define vtkVLogF(level, ...) \
453 ((level) > vtkLogger::GetCurrentVerbosityCutoff()) \
455 : vtkLogger::LogF(level, __FILE__, __LINE__, __VA_ARGS__)
456 #define vtkLogF(verbosity_name, ...) vtkVLogF(vtkLogger::VERBOSITY_##verbosity_name, __VA_ARGS__)
457 #define vtkVLog(level, x) \
458 if ((level) <= vtkLogger::GetCurrentVerbosityCutoff()) \
460 vtkOStrStreamWrapper::EndlType const endl; \
461 vtkOStrStreamWrapper::UseEndl(endl); \
462 vtkOStrStreamWrapper vtkmsg; \
464 vtkLogger::Log(level, __FILE__, __LINE__, vtkmsg.str()); \
465 vtkmsg.rdbuf()->freeze(0); \
467 #define vtkLog(verbosity_name, x) vtkVLog(vtkLogger::VERBOSITY_##verbosity_name, x)
483 #define vtkVLogIfF(level, cond, ...) \
484 ((level) > vtkLogger::GetCurrentVerbosityCutoff() || (cond) == false) \
486 : vtkLogger::LogF(level, __FILE__, __LINE__, __VA_ARGS__)
488 #define vtkLogIfF(verbosity_name, cond, ...) \
489 vtkVLogIfF(vtkLogger::VERBOSITY_##verbosity_name, cond, __VA_ARGS__)
491 #define vtkVLogIf(level, cond, x) \
492 if ((level) <= vtkLogger::GetCurrentVerbosityCutoff() && (cond)) \
494 vtkOStrStreamWrapper::EndlType endl; \
495 vtkOStrStreamWrapper::UseEndl(endl); \
496 vtkOStrStreamWrapper vtkmsg; \
498 vtkLogger::Log(level, __FILE__, __LINE__, vtkmsg.str()); \
499 vtkmsg.rdbuf()->freeze(0); \
501 #define vtkLogIf(verbosity_name, cond, x) vtkVLogIf(vtkLogger::VERBOSITY_##verbosity_name, cond, x)
504 #define VTKLOG_CONCAT_IMPL(s1, s2) s1##s2
505 #define VTKLOG_CONCAT(s1, s2) VTKLOG_CONCAT_IMPL(s1, s2)
506 #define VTKLOG_ANONYMOUS_VARIABLE(x) VTKLOG_CONCAT(x, __LINE__)
508 #define vtkVLogScopeF(level, ...) \
509 auto VTKLOG_ANONYMOUS_VARIABLE(msg_context) = ((level) > vtkLogger::GetCurrentVerbosityCutoff()) \
510 ? vtkLogger::LogScopeRAII() \
511 : vtkLogger::LogScopeRAII(level, __FILE__, __LINE__, __VA_ARGS__)
513 #define vtkLogScopeF(verbosity_name, ...) \
514 vtkVLogScopeF(vtkLogger::VERBOSITY_##verbosity_name, __VA_ARGS__)
516 #define vtkLogScopeFunction(verbosity_name) vtkLogScopeF(verbosity_name, "%s", __func__)
517 #define vtkVLogScopeFunction(level) vtkVLogScopeF(level, "%s", __func__)
524 #define vtkLogStartScope(verbosity_name, id) \
525 vtkLogger::StartScope(vtkLogger::VERBOSITY_##verbosity_name, id, __FILE__, __LINE__)
526 #define vtkLogEndScope(id) vtkLogger::EndScope(id)
528 #define vtkLogStartScopeF(verbosity_name, id, ...) \
529 vtkLogger::StartScopeF(vtkLogger::VERBOSITY_##verbosity_name, id, __FILE__, __LINE__, __VA_ARGS__)
531 #define vtkVLogStartScope(level, id) vtkLogger::StartScope(level, id, __FILE__, __LINE__)
532 #define vtkVLogStartScopeF(level, id, ...) \
533 vtkLogger::StartScopeF(level, id, __FILE__, __LINE__, __VA_ARGS__)
541 #define vtkLogIdentifier(vtkobject) vtkLogger::GetIdentifier(vtkobject).c_str()
543 VTK_ABI_NAMESPACE_END
The message structure that is passed to custom callbacks registered using vtkLogger::AddCallback.
void(*)(void *user_data) CloseHandlerCallbackT
Callback handle types.
virtual void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
void(*)(void *user_data) FlushHandlerCallbackT
Callback handle types.
logging framework for use in VTK and in applications based on VTK
a simple class to control print indentation
#define VTK_PRINTF_LIKE(fmtarg, firstvararg)
abstract base class for most VTK objects
void(*)(void *user_data, const Message &message) LogHandlerCallbackT
Callback handle types.
static bool EnableUnsafeSignalHandler
Flag to enable/disable the logging frameworks printing of a stack trace when catching signals...
#define VTK_FORMAT_STRING_TYPE
void operator=(const vtkObjectBase &)
FileMode
Support log file modes: TRUNCATE truncates the file clearing any existing contents while APPEND appen...