logger.hpp

Go to the documentation of this file.

/*
 *  Cypress -- C++ Spiking Neural Network Simulation Framework
 *  Copyright (C) 2016  Andreas Stöckel
 *
 *  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, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef CYPRESS_UTIL_LOGGER_HPP
#define CYPRESS_UTIL_LOGGER_HPP

#include <ctime>
#include <cstdint>
#include <iostream>
#include <fstream>
#include <memory>
#include <string>

namespace cypress {
/*
 * Forward declarations.
 */
class Logger;
class LoggerImpl;
class LogStreamBackendImpl;

enum LogSeverity : int32_t {
    DEBUG = 10,
    INFO = 20,
    WARNING = 30,
    ERROR = 40,
    FATAL_ERROR = 50
};

class LogBackend {
public:
    virtual void log(LogSeverity lvl, std::time_t time,
                     const std::string &module, const std::string &message) = 0;
    virtual ~LogBackend() {}
};

class LogStreamBackend : public LogBackend {
private:
    std::unique_ptr<LogStreamBackendImpl> m_impl;

public:
    LogStreamBackend(std::ostream &os, bool use_color = false);

    void log(LogSeverity lvl, std::time_t time, const std::string &module,
             const std::string &message) override;
    ~LogStreamBackend() override;
};

class LogFileBackend : public LogStreamBackend {
private:
    std::ofstream m_stream;

public:
    LogFileBackend(const std::string &prefix = "cypress");
    ~LogFileBackend() override;
};

class Logger {
private:
    std::unique_ptr<LoggerImpl> m_impl;

public:
    Logger();

    Logger(std::shared_ptr<LogBackend> backend,
           LogSeverity lvl = LogSeverity::INFO);

    size_t backend_count() const;

    int add_backend(std::shared_ptr<LogBackend> backend,
                     LogSeverity lvl = LogSeverity::INFO);

    void min_level(LogSeverity lvl, int idx = -1);

    LogSeverity min_level(int idx = -1);

    size_t count(LogSeverity lvl = LogSeverity::DEBUG) const;

    void log(LogSeverity lvl, std::time_t time, const std::string &module,
             const std::string &message);
    void debug(const std::string &module, const std::string &message);
    void info(const std::string &module, const std::string &message);
    void warn(const std::string &module, const std::string &message);
    void error(const std::string &module, const std::string &message);
    void fatal_error(const std::string &module, const std::string &message);
};

Logger &global_logger();
}

#endif /* CYPRESS_UTIL_LOGGER_HPP */