glogger.h

Go to the documentation of this file.

#pragma once
 
// Color conventions and logging macros
#include "gutsConventions.h"
#include "goptions.h"
 
// Geant4
#include "G4UIsession.hh"
#include <atomic>
#include <string>
#include <sstream>
#include <utility>
 
enum debug_type { NORMAL, CONSTRUCTOR, DESTRUCTOR };
 
class GLogger {
public:
    explicit GLogger(GOptions* gopts, std::string vname, std::string cc)
        : verbosity_name(std::move(vname)), calling_class(std::move(cc)), log_counter{0} {
        verbosity_level = gopts->getVerbosityFor(verbosity_name);
        debug_level     = gopts->getDebugFor(verbosity_name);
        debug(CONSTRUCTOR, calling_class, " logger");
    }
 
    // default constructor
    GLogger() = default;
 
    ~GLogger() { debug(DESTRUCTOR, calling_class, " logger"); }
 
    template <typename... Args>
    void debug(debug_type type, Args&&... args) const {
        if (debug_level == 0) return;
 
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
 
        switch (type) {
        case NORMAL:
            G4cout << KCYN << header_string() << "DEBUG " << oss.str() << RST << G4endl;
            break;
        case CONSTRUCTOR:
            G4cout << KCYN << header_string() << "DEBUG " <<
                CONSTRUCTORLOG << " " << oss.str() << " " << CONSTRUCTORLOG << RST << G4endl;
            break;
        case DESTRUCTOR:
            G4cout << KCYN << header_string() << "DEBUG " <<
                DESTRUCTORLOG << " " << oss.str() << " " << DESTRUCTORLOG << RST << G4endl;
            break;
        }
    }
 
    template <typename... Args>
    void info(int level, Args&&... args) const {
        // error if level is not 0, 1 or 2
        if (level != 0 && level != 1 && level != 2) {
            G4cerr << FATALERRORL << header_string() << GWARNING << " Invalid verbosity level requested: " << level <<
                RST << G4endl;
            exit(EC_WRONG_VERBOSITY_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 << KYEL << header_string() << GWARNING << oss.str() << RST << G4endl;
    }
 
    template <typename... Args>
    [[noreturn]] void error(int exit_code, Args&&... args) const {
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
        G4cerr << FATALERRORL << header_string() << KRED << oss.str() << RST << G4endl;
        G4cerr << FATALERRORL << header_string() << KRED << "Exit Code: " << exit_code << RST << G4endl;
        std::exit(exit_code);
    }
 
    template <typename... Args>
    void critical(Args&&... args) const {
        std::ostringstream oss;
        (oss << ... << std::forward<Args>(args));
        G4cout << KBOLD << header_string() << RST << oss.str() << G4endl;
    }
 
 
    std::string get_verbosity_name() const { return verbosity_name; }
 
private:
    std::string verbosity_name;    
    std::string calling_class;     
    int         verbosity_level{}; 
    int         debug_level{};     
 
    mutable std::atomic<int> log_counter{}; 
 
    [[nodiscard]] std::string header_string() const {
        log_counter++;
        return calling_class + " [" + std::to_string(log_counter.load()) + "]: ";
    }
};