log.hpp

Go to the documentation of this file.

/* 
 * This file is part of PLaSK (https://plask.app) by Photonics Group at TUL
 * Copyright (c) 2022 Lodz University of Technology
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
#ifndef PLASK__LOG_LOG_H
#define PLASK__LOG_LOG_H
 
#include <iostream>
#include <string>
 
#include "../memory.hpp"
#include "../utils/format.hpp"
 
namespace plask {
 
PLASK_API std::string host_name();
 
enum LogLevel {
    LOG_CRITICAL_ERROR = 0, 
    LOG_ERROR = 1,          
    LOG_ERROR_DETAIL = 2,   
    LOG_WARNING = 3,        
    LOG_IMPORTANT = 4,      
    LOG_INFO = 5,           
    LOG_RESULT = 6,         
    LOG_DATA = 7,           
    LOG_DETAIL = 8,         
    LOG_DEBUG = 9           
};
 
PLASK_API extern LogLevel maxLoglevel;
PLASK_API extern bool forcedLoglevel;
 
class PLASK_API NoLogging {
    bool old_state;
 
  public:
    NoLogging();
 
    NoLogging(bool silent);
 
    ~NoLogging();
 
    void set(bool silent);
 
    void silence() { set(true); }
};
 
class PLASK_API Logger {
 
    bool silent;
 
    friend class NoLogging;
 
    friend void writelog(LogLevel level, const std::string& msg);
 
    template<typename... Args>
    friend void writelog(LogLevel level, const std::string& msg, Args&&... params);
 
  protected:
 
    std::string prefix;
 
  public:
 
    enum ColorMode {
        COLOR_NONE,
        COLOR_ANSI
#if defined(_WIN32) || defined(__WIN32__) || defined(WIN32)
        , COLOR_WINDOWS
#endif
    };
 
    ColorMode color;
 
    Logger();
 
    virtual ~Logger() {}
 
    virtual void writelog(LogLevel level, const std::string& msg) = 0;
 
};
 
PLASK_API extern shared_ptr<Logger> default_logger;
 
PLASK_API void createDefaultLogger();
 
inline void writelog(LogLevel level, const std::string& msg) {
    if (!default_logger) createDefaultLogger();
    if (level <= maxLoglevel && (!default_logger->silent || level <= LOG_WARNING)) {
        default_logger->writelog(level, msg);
    }
}
 
template<typename... Args>
inline void writelog(LogLevel level, const std::string& msg, Args&&... params) {
    if (!default_logger) createDefaultLogger();
    if (level <= maxLoglevel && (!default_logger->silent || level <= LOG_WARNING)) {
        default_logger->writelog(level, format(msg, std::forward<Args>(params)...));
    }
}
 
}   // namespace plask
 
#ifdef NDEBUG
#   define write_debug(...) void(0)
#else
#   define write_debug(...) writelog(LOG_DEBUG, __VA_ARGS__)
#endif
 
#endif // PLASK__LOG_LOG_H