glogger.h

Go to the documentation of this file.

#pragma once
 
// Color conventions and logging macros
#include <gemc/guts/gutsConventions.h>
#include <gemc/goptions/goptions.h>
 
// Geant4
#include "G4UIsession.hh"
#include <atomic>
#include <string>
#include <sstream>
#include <utility>
 

#if defined(__clang__) || defined(__GNUC__)
#define FUNCTION_NAME std::string(__PRETTY_FUNCTION__) + std::string(" > ")
#elif defined(_MSC_VER)
#define FUNCTION_NAME std::string(__FUNCSIG__) + std::string(" > ")
#else
#define FUNCTION_NAME std::string(__func__) + std::string(" > ")
#endif

#define SFUNCTION_NAME std::string(__func__) + std::string(" > ")

enum debug_type { NORMAL, CONSTRUCTOR, DESTRUCTOR };

class GLogger
{
public:
    explicit GLogger(const std::shared_ptr<GOptions>& gopts, const std::string& cname, const std::string& lname = "")
        : class_name(cname), logger_name(lname), log_counter{0} {
        // Resolve the runtime policy for this subsystem name from the global options.
        verbosity_level = gopts->getVerbosityFor(logger_name);
        debug_level     = gopts->getDebugFor(logger_name);
 
        // Optional lifetime trace to help identify logger ownership and construction order.
        debug(CONSTRUCTOR, logger_name, " logger");
    }

    GLogger() = default;

    ~GLogger() { debug(DESTRUCTOR, logger_name, " logger"); }

    template <typename... Args>
    void debug(debug_type type, Args&&... args) const {
        if (debug_level == 0) return; // Debug disabled for this logger instance.
 
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
 
        switch (type) {
        case NORMAL:
            G4cout << guts::KCYN << header_string() << "DEBUG: " << oss.str() << guts::RST << G4endl;
            break;
        case CONSTRUCTOR:
            G4cout << guts::KCYN << header_string() << "DEBUG: " <<
                guts::CONSTRUCTORLOG << " " << oss.str() << " " << guts::CONSTRUCTORLOG << guts::RST << G4endl;
            break;
        case DESTRUCTOR:
            G4cout << guts::KCYN << header_string() << "DEBUG: " <<
                guts::DESTRUCTORLOG << " " << oss.str() << " " << guts::DESTRUCTORLOG << guts::RST << G4endl;
            break;
        }
    }

    template <typename... Args>
    void info(int level, Args&&... args) const {
        // Validate the requested verbosity level early so callers fail fast with a clear message.
        if (level != 0 && level != 1 && level != 2) {
            G4cerr << guts::FATALERRORL << header_string() << guts::GWARNING
                   << " Invalid verbosity level requested: " << level << guts::RST << G4endl;
            exit(goptions::EC_WRONG_VERBOSITY_LEVEL);
        }
 
        // Apply the gating rule associated with the requested level.
        if (level == 0 || (level == 1 && verbosity_level > 0) || (level == 2 && verbosity_level > 1)) {
            std::ostringstream oss;
            (oss << ... << std::forward<Args>(args));
            G4cout << header_string() << "INFO L" << level << ": " << oss.str() << G4endl;
        }
    }

    template <typename... Args>
    void info(Args&&... args) const { info(0, std::forward<Args>(args)...); }

    template <typename... Args>
    void warning(Args&&... args) const {
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
        G4cout << guts::KYEL << header_string() << guts::GWARNING << guts::KYEL << oss.str() << guts::RST << G4endl;
    }

    template <typename... Args>
    [[noreturn]] void error(int exit_code, Args&&... args) const {
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
        G4cerr << guts::FATALERRORL << header_string() << guts::KRED << oss.str() << guts::RST << G4endl;
        G4cerr << guts::FATALERRORL << header_string() << guts::KRED << "Exit Code: " << exit_code << guts::RST
               << G4endl;
        std::exit(exit_code);
    }

    template <typename... Args>
    void critical(Args&&... args) const {
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
        G4cout << guts::KBOLD << header_string() << guts::RST << oss.str() << G4endl;
    }

    [[nodiscard]] std::string get_class_name() const { return class_name; }
 
private:
    std::string class_name; 
    std::string logger_name;
    int verbosity_level{}; 
    int debug_level{};     
 
    mutable std::atomic<int> log_counter{}; 

    [[nodiscard]] std::string header_string() const {
        ++log_counter; // Increment first so the first emitted message is "1" rather than "0".
        return " [ " + logger_name + " - " + std::to_string(log_counter.load()) + " ] ";
    }
};