Mercurial > hg > orthanc
diff OrthancFramework/Sources/Logging.h @ 5807:8279eaab0d1d attach-custom-data
merged default -> attach-custom-data
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Tue, 24 Sep 2024 11:39:52 +0200 |
parents | f7adfb22e20e |
children |
line wrap: on
line diff
--- a/OrthancFramework/Sources/Logging.h Thu Sep 15 18:13:17 2022 +0200 +++ b/OrthancFramework/Sources/Logging.h Tue Sep 24 11:39:52 2024 +0200 @@ -2,8 +2,9 @@ * Orthanc - A Lightweight, RESTful DICOM Store * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2022 Osimis S.A., Belgium - * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium + * Copyright (C) 2017-2023 Osimis S.A., Belgium + * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium + * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium * * This program is free software: you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public License @@ -28,6 +29,7 @@ #include "Compatibility.h" #include <iostream> +#include <stdint.h> #if !defined(ORTHANC_ENABLE_LOGGING) # error The macro ORTHANC_ENABLE_LOGGING must be defined @@ -46,12 +48,13 @@ { namespace Logging { + // Note: these values must match the ones in OrthancCPlugin.h enum LogLevel { - LogLevel_ERROR, - LogLevel_WARNING, - LogLevel_INFO, - LogLevel_TRACE + LogLevel_ERROR = 0, + LogLevel_WARNING = 1, + LogLevel_INFO = 2, + LogLevel_TRACE = 3 }; /** @@ -59,6 +62,7 @@ * mask. As a consequence, there can be up to 31 log categories * (not 32, as the value GENERIC is reserved for the log commands * that don't fall in a specific category). + * Note: these values must match the ones in OrthancCPlugin.h **/ enum LogCategory { @@ -78,6 +82,9 @@ // "pluginContext" must be of type "OrthancPluginContext" ORTHANC_PUBLIC void InitializePluginContext(void* pluginContext); + ORTHANC_PUBLIC void InitializePluginContext(void* pluginContext, + const std::string& pluginName); + ORTHANC_PUBLIC void Initialize(); ORTHANC_PUBLIC void Finalize(); @@ -86,6 +93,12 @@ ORTHANC_PUBLIC void Flush(); + ORTHANC_PUBLIC void SetCurrentThreadName(const std::string& name); + + ORTHANC_PUBLIC bool HasCurrentThreadName(); + + ORTHANC_PUBLIC void EnableThreadNames(bool enabled); + ORTHANC_PUBLIC void EnableInfoLevel(bool enabled); ORTHANC_PUBLIC void EnableTraceLevel(bool enabled); @@ -156,16 +169,36 @@ # define LOG(level) ::Orthanc::Logging::NullStream() # define VLOG(unused) ::Orthanc::Logging::NullStream() # define CLOG(level, category) ::Orthanc::Logging::NullStream() +# define LOG_FROM_PLUGIN(level, category, pluginName, file, line) ::Orthanc::Logging::NullStream() #else /* ORTHANC_ENABLE_LOGGING == 1 */ -# define LOG(level) ::Orthanc::Logging::InternalLogger \ - (::Orthanc::Logging::LogLevel_ ## level, \ - ::Orthanc::Logging::LogCategory_GENERIC, __FILE__, __LINE__) -# define VLOG(unused) ::Orthanc::Logging::InternalLogger \ - (::Orthanc::Logging::LogLevel_TRACE, \ - ::Orthanc::Logging::LogCategory_GENERIC, __FILE__, __LINE__) + +#if !defined(__ORTHANC_FILE__) +# if defined(_MSC_VER) +# pragma message("Warning: Macro __ORTHANC_FILE__ is not defined, this will leak the full path of the source files in the binaries") +# else +# warning Warning: Macro __ORTHANC_FILE__ is not defined, this will leak the full path of the source files in the binaries +# endif +# define __ORTHANC_FILE__ __FILE__ +#endif + +# define LOG(level) ::Orthanc::Logging::InternalLogger \ + (::Orthanc::Logging::LogLevel_ ## level, \ + ::Orthanc::Logging::LogCategory_GENERIC, NULL /* no plugin */, \ + __ORTHANC_FILE__, __LINE__) + +# define VLOG(unused) ::Orthanc::Logging::InternalLogger \ + (::Orthanc::Logging::LogLevel_TRACE, \ + ::Orthanc::Logging::LogCategory_GENERIC, NULL /* no plugin */, \ + __ORTHANC_FILE__, __LINE__) + # define CLOG(level, category) ::Orthanc::Logging::InternalLogger \ (::Orthanc::Logging::LogLevel_ ## level, \ - ::Orthanc::Logging::LogCategory_ ## category, __FILE__, __LINE__) + ::Orthanc::Logging::LogCategory_ ## category, NULL /* no plugin */, \ + __ORTHANC_FILE__, __LINE__) + +# define LOG_FROM_PLUGIN(level, category, pluginName, file, line) \ + ::Orthanc::Logging::InternalLogger(level, category, pluginName, file, line) + #endif @@ -192,6 +225,7 @@ public: InternalLogger(LogLevel level, LogCategory category, + const char* pluginName /* ignored */, const char* file /* ignored */, int line /* ignored */) : level_(level), @@ -199,15 +233,6 @@ { } - // For backward binary compatibility with Orthanc Framework <= 1.8.0 - InternalLogger(LogLevel level, - const char* file /* ignored */, - int line /* ignored */) : - level_(level), - category_(LogCategory_GENERIC) - { - } - ~InternalLogger(); template <typename T> @@ -242,19 +267,14 @@ LogLevel level_; std::unique_ptr<std::stringstream> pluginStream_; std::ostream* stream_; - - void Setup(LogCategory category, - const char* file, - int line); + LogCategory category_; + const char* file_; + uint32_t line_; public: InternalLogger(LogLevel level, LogCategory category, - const char* file, - int line); - - // For backward binary compatibility with Orthanc Framework <= 1.8.0 - InternalLogger(LogLevel level, + const char* pluginName, const char* file, int line);