Update docs

Co-Authored-By: Dennis Klein <dennis.klein.github@gmail.com>

CMakeLists.txt

@@ -7,7 +7,7 @@
 ################################################################################
 
 cmake_minimum_required(VERSION 3.9.4 FATAL_ERROR)
-cmake_policy(VERSION 3.9...3.14)
+cmake_policy(VERSION 3.9...3.15)
 
 # Project ######################################################################
 set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
@@ -100,7 +100,6 @@ if(NOT USE_EXTERNAL_FMT)
 endif()
 install(TARGETS
   FairLogger
-  ${test_targets}
   ${fmt_target}
 
   EXPORT ${PROJECT_EXPORT_SET}

README.md

@@ -42,7 +42,7 @@ If FairLogger is built with `-DUSE_BOOST_PRETTY_FUNCTION=ON` and/or `-DUSE_EXTER
 ```cmake
 find_package(FairLogger)
 foreach(dep IN LISTS FairLogger_PACKAGE_DEPENDENCIES)
-  find_package(${dep} ${FairLogger_${dep}_VERSION})
+  find_package(${dep} ${FairLogger_${dep}_VERSION})
 endforeach()
 ```
 
@@ -87,21 +87,32 @@ where severity level is one of the following:
 
 ```C++
 "nolog",
-"fatal",
-"error",
-"warn",
-"state",
-"info",
-"debug",
-"debug1",
-"debug2",
-"debug3",
-"debug4",
 "trace",
+"debug4",
+"debug3",
+"debug2",
+"debug1",
+"debug",
+"info",
+"state",
+"warn",
+"error",
+"fatal",
 ```
 
 Logger will log the chosen severity and all above it (except "nolog", which deactivates logging for that sink completely). Fatal severity is always logged.
 
+## 3.1 Compile-time severity switch
+
+The minimum severity level can be configured at compile time via definition of `FAIR_MIN_SEVERITY`:
+
+```C++
+#define FAIR_MIN_SEVERITY warn // only allow severities >= warn
+#include <fairlogger/Logger.h>
+```
+
+When `FAIR_MIN_SEVERITY` is not provided, it will be set to `info` if `NDEBUG` is defined, otherwise all severities will be enabled.
+
 ## 4. Verbosity
 
 The log verbosity is controlled via:
@@ -207,8 +218,20 @@ Here is an example adding a custom sink for all severities ("trace" and above).
 
 If only output from custom sinks is desirable, console/file sinks must be deactivated by setting their severity to `"nolog"`.
 
+## Naming conflicts?
+
+By default, `<fairlogger/Logger.h>` defines unprefixed macros: `LOG`, `LOGV`, `LOGF`, `LOGP`, `LOGN`, `LOGD`, `LOG_IF`.
+
+Define an option `FAIR_NO_LOG*` to prevent the above unprefixed macros to be defined, e.g.
+
+```C++
+#define FAIR_NO_LOG
+#define FAIR_NO_LOGF
+#include <fairlogger/Logger.h>
+```
+
 ## License
 
 GNU Lesser General Public Licence (LGPL) version 3, see [LICENSE](LICENSE).
 
-Copyright (C) 2017-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
+Copyright (C) 2017-2020 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH

logger/Logger.cxx

@@ -7,7 +7,11 @@
  ********************************************************************************/
 #include "Logger.h"
 
+#if FMT_VERSION < 60000
 #include <fmt/time.h>
+#else
+#include <fmt/chrono.h>
+#endif
 
 #include <cstdio> // printf
 #include <iostream>
@@ -108,17 +112,17 @@ const array<string, 12> Logger::fSeverityNames =
 {
     {
         "NOLOG",
-        "FATAL",
-        "ERROR",
-        "WARN",
-        "STATE",
-        "INFO",
-        "DEBUG",
-        "DEBUG1",
-        "DEBUG2",
-        "DEBUG3",
+        "TRACE",
         "DEBUG4",
-        "TRACE"
+        "DEBUG3",
+        "DEBUG2",
+        "DEBUG1",
+        "DEBUG",
+        "INFO",
+        "STATE",
+        "WARN",
+        "ERROR",
+        "FATAL"
     }
 };
 
@@ -421,25 +425,26 @@ void Logger::CycleVerbosityDown()
 
 void Logger::UpdateMinSeverity()
 {
-    fMinSeverity = (fConsoleSeverity <= fFileSeverity) ? fFileSeverity : fConsoleSeverity;
+    if (fFileSeverity == Severity::nolog) {
+        fMinSeverity = fConsoleSeverity;
+    } else {
+        fMinSeverity = std::min(fConsoleSeverity, fFileSeverity);
+    }
 
     for (auto& it : fCustomSinks) {
-        if (fMinSeverity <= it.second.first) {
-            fMinSeverity = it.second.first;
+        if (fMinSeverity == Severity::nolog) {
+            fMinSeverity = std::max(fMinSeverity, it.second.first);
+        } else if (it.second.first != Severity::nolog) {
+            fMinSeverity = std::min(fMinSeverity, it.second.first);
         }
     }
 }
 
 bool Logger::Logging(Severity severity)
 {
-    if (Severity::fatal == severity) {
-        return true;
-    }
-    if (severity <= fMinSeverity && severity > Severity::nolog) {
-        return true;
-    } else {
-        return false;
-    }
+    return (severity >= fMinSeverity &&
+            fMinSeverity > Severity::nolog) ||
+            severity == Severity::fatal;
 }
 
 bool Logger::Logging(const string& severityStr)
@@ -544,22 +549,22 @@ void Logger::RemoveFileSink()
 
 bool Logger::LoggingToConsole() const
 {
-    return (fInfos.severity <= fConsoleSeverity &&
-            fInfos.severity >  Severity::nolog) ||
+    return (fInfos.severity >= fConsoleSeverity &&
+            fConsoleSeverity > Severity::nolog) ||
             fInfos.severity == Severity::fatal;
 }
 
 bool Logger::LoggingToFile() const
 {
-    return (fInfos.severity <= fFileSeverity &&
-            fInfos.severity >  Severity::nolog) ||
+    return (fInfos.severity >= fFileSeverity &&
+            fFileSeverity   >  Severity::nolog) ||
             fInfos.severity == Severity::fatal;
 }
 
 bool Logger::LoggingCustom(const Severity severity) const
 {
-    return (fInfos.severity <= severity &&
-            fInfos.severity >  Severity::nolog) ||
+    return (fInfos.severity >= severity &&
+            severity        > Severity::nolog) ||
             fInfos.severity == Severity::fatal;
 }
 

logger/Logger.h

@@ -13,6 +13,10 @@
 #warning "The symbol 'DEBUG' is used in FairRoot Logger. undefining..."
 #endif
 
+#if !defined(FAIR_MIN_SEVERITY) && defined(NDEBUG)
+#define FAIR_MIN_SEVERITY info
+#endif
+
 #ifdef FAIRLOGGER_USE_BOOST_PRETTY_FUNCTION
 #include <boost/current_function.hpp>
 #endif
@@ -46,33 +50,33 @@ namespace fair
 
 enum class Severity : int
 {
-    nolog,
-    fatal,
-    error,
-    warn,
-    state,
-    info,
-    debug,
-    debug1,
-    debug2,
-    debug3,
-    debug4,
-    trace,
+    nolog = 0,
+    trace = 1,
+    debug4 = 2,
+    debug3 = 3,
+    debug2 = 4,
+    debug1 = 5,
+    debug = 6,
+    info = 7,
+    state = 8,
+    warn = 9,
+    error = 10,
+    fatal = 11,
     // backwards-compatibility:
     NOLOG = nolog,
-    FATAL = fatal,
-    ERROR = error,
-    WARN = warn,
-    warning = warn,
-    WARNING = warn,
-    STATE = state,
-    INFO = info,
-    DEBUG = debug,
-    DEBUG1 = debug1,
-    DEBUG2 = debug2,
-    DEBUG3 = debug3,
+    TRACE = trace,
     DEBUG4 = debug4,
-    TRACE = trace
+    DEBUG3 = debug3,
+    DEBUG2 = debug2,
+    DEBUG1 = debug1,
+    DEBUG = debug,
+    INFO = info,
+    STATE = state,
+    WARNING = warn,
+    warning = warn,
+    WARN = warn,
+    ERROR = error,
+    FATAL = fatal
 };
 
 // verbosity levels:
@@ -313,6 +317,15 @@ class Logger
     static bool fIsDestructed;
     static struct DestructionHelper { ~DestructionHelper() { Logger::fIsDestructed = true; }} fDestructionHelper;
 
+    static bool constexpr SuppressSeverity(Severity sev)
+    {
+#ifdef FAIR_MIN_SEVERITY
+        return sev < Severity::FAIR_MIN_SEVERITY;
+#else
+        return false;
+#endif
+    }
+
   private:
     LogMetaData fInfos;
 
@@ -356,32 +369,73 @@ class Logger
 #define MSG_ORIGIN __FILE__, CONVERTTOSTRING(__LINE__), static_cast<const char*>(__FUNCTION__)
 #endif
 
+// allow user of this header file to prevent definition of the LOG macro, by defining FAIR_NO_LOG before including this header
+#ifndef FAIR_NO_LOG
+#undef LOG
+#define LOG FAIR_LOG
+#endif
+// allow user of this header file to prevent definition of the LOGV macro, by defining FAIR_NO_LOGV before including this header
+#ifndef FAIR_NO_LOGV
+#undef LOGV
+#define LOGV FAIR_LOGV
+#endif
+// allow user of this header file to prevent definition of the LOGF macro, by defining FAIR_NO_LOGF before including this header
+#ifndef FAIR_NO_LOGF
+#undef LOGF
+#define LOGF FAIR_LOGF
+#endif
+// allow user of this header file to prevent definition of the LOGP macro, by defining FAIR_NO_LOGP before including this header
+#ifndef FAIR_NO_LOGP
+#undef LOGP
+#define LOGP FAIR_LOGP
+#endif
+// allow user of this header file to prevent definition of the LOGN macro, by defining FAIR_NO_LOGN before including this header
+#ifndef FAIR_NO_LOGN
+#undef LOGN
+#define LOGN FAIR_LOGN
+#endif
+// allow user of this header file to prevent definition of the LOGD macro, by defining FAIR_NO_LOGD before including this header
+#ifndef FAIR_NO_LOGD
+#undef LOGD
+#define LOGD FAIR_LOGD
+#endif
+// allow user of this header file to prevent definition of the LOG_IF macro, by defining FAIR_NO_LOG_IF before including this header
+#ifndef FAIR_NO_LOG_IF
+#undef LOG_IF
+#define LOG_IF FAIR_LOG_IF
+#endif
+
 // Log line if the provided severity is below or equals the configured one
-#define LOG(severity) \
-    for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(fair::Severity::severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
-        fair::Logger(fair::Severity::severity, MSG_ORIGIN)
+#define FAIR_LOG(severity) \
+    if (fair::Logger::SuppressSeverity(fair::Severity::severity)) ; else \
+        for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(fair::Severity::severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
+            fair::Logger(fair::Severity::severity, MSG_ORIGIN)
 
 // Log line with the given verbosity if the provided severity is below or equals the configured one
-#define LOGV(severity, verbosity) \
-    for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(fair::Severity::severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
-        fair::Logger(fair::Severity::severity, fair::Verbosity::verbosity, MSG_ORIGIN)
+#define FAIR_LOGV(severity, verbosity) \
+    if (fair::Logger::SuppressSeverity(fair::Severity::severity)) ; else \
+        for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(fair::Severity::severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
+            fair::Logger(fair::Severity::severity, fair::Verbosity::verbosity, MSG_ORIGIN)
 
 // Log with fmt- or printf-like formatting
-#define LOGF(severity, ...) LOG(severity) << fmt::format(__VA_ARGS__)
-#define LOGP(severity, ...) LOG(severity) << fmt::sprintf(__VA_ARGS__)
+#define FAIR_LOGF(severity, ...) LOG(severity) << fmt::format(__VA_ARGS__)
+#define FAIR_LOGP(severity, ...) LOG(severity) << fmt::sprintf(__VA_ARGS__)
 
 // Log an empty line
-#define LOGN(severity) \
-    for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(fair::Severity::severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
-        fair::Logger(fair::Severity::severity, fair::Verbosity::verylow, MSG_ORIGIN).LogEmptyLine()
+#define FAIR_LOGN(severity) \
+    if (fair::Logger::SuppressSeverity(fair::Severity::severity)) ; else \
+        for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(fair::Severity::severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
+            fair::Logger(fair::Severity::severity, fair::Verbosity::verylow, MSG_ORIGIN).LogEmptyLine()
 
 // Log with custom file, line, function
-#define LOGD(severity, file, line, f) \
-    for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
-        fair::Logger(severity, file, line, f)
+#define FAIR_LOGD(severity, file, line, f) \
+    if (fair::Logger::SuppressSeverity(severity)) ; else \
+        for (bool fairLOggerunLikelyvariable = false; fair::Logger::Logging(severity) && !fairLOggerunLikelyvariable; fairLOggerunLikelyvariable = true) \
+            fair::Logger(severity, file, line, f)
 
-#define LOG_IF(severity, condition) \
-    for (bool fairLOggerunLikelyvariable2 = false; condition && !fairLOggerunLikelyvariable2; fairLOggerunLikelyvariable2 = true) \
-        LOG(severity)
+#define FAIR_LOG_IF(severity, condition) \
+    if (fair::Logger::SuppressSeverity(fair::Severity::severity)) ; else \
+        for (bool fairLOggerunLikelyvariable2 = false; condition && !fairLOggerunLikelyvariable2; fairLOggerunLikelyvariable2 = true) \
+            LOG(severity)
 
 #endif // FAIR_LOGGER_H