logger.h

// Copyright (c) 2020-now by the Zeek Project. See LICENSE for details.
 
#pragma once
 
#include <map>
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
#include <hilti/ast/node.h>
#include <hilti/base/util.h>
 
#define HILTI_DEBUG(dbg, ...)                                                                                          \
    {                                                                                                                  \
        if ( ::hilti::logger().isEnabled(dbg) )                                                                        \
            ::hilti::logger()._debug(dbg, __VA_ARGS__);                                                                \
    }
 
namespace hilti {
namespace logging {
 
class DebugStream {
public:
    explicit DebugStream(const std::string& name);
    bool operator<(const DebugStream& other) const { return _id < other._id; }
    const auto& name() const { return _name; }
 
    static std::vector<std::string> all();
 
    static const auto& streamForName(const std::string& s) { return _streams().at(s); }
 
private:
    uint64_t _id;
    std::string _name;
    static std::map<std::string, DebugStream>& _streams();
};
 
namespace debug {} // namespace debug
 
enum class Level { Debug, Info, Warning, Error, FatalError, InternalError };
 
namespace detail {
constexpr util::enum_::Value<Level> Levels[] = {
    {.value = Level::Debug, .name = "debug"},
    {.value = Level::Info, .name = "info"},
    {.value = Level::Warning, .name = "warning"},
    {.value = Level::Error, .name = "error"},
    {.value = Level::FatalError, .name = "fatal-error"},
    {.value = Level::InternalError, .name = "internal-error"},
};
} // namespace detail
 
constexpr auto to_string(Level m) { return util::enum_::to_string(m, detail::Levels); }
 
namespace level {
constexpr auto from_string(std::string_view s) { return util::enum_::from_string<Level>(s, detail::Levels); }
} // namespace level
 
class Stream : public std::ostream {
private:
    class Buffer : public std::stringbuf {
    public:
        Buffer(logging::Level level);
        Buffer(logging::DebugStream dbg);
 
    private:
        int overflow(int ch) final;
        int sync() final;
 
        Level _level;
        std::optional<logging::DebugStream> _dbg;
        std::string _buffer;
    };
 
public:
    Stream(logging::Level level) : std::ostream(&_buf), _buf(level) {}
 
    Stream(logging::DebugStream dbg) : std::ostream(&_buf), _buf(std::move(dbg)) {}
 
private:
    Buffer _buf;
};
 
} // namespace logging
 
class Logger;
 
inline Logger& logger();
 
extern std::unique_ptr<Logger> setLogger(std::unique_ptr<Logger> logger);
 
class Logger {
public:
    Logger(std::ostream& output_std = std::cerr, std::ostream& output_debug = std::cerr)
        : _output_std(output_std), _output_debug(output_debug) {}
 
    void log(logging::Level level, std::string_view msg, const Location& l = location::None);
 
    void info(std::string_view msg, const Location& l = location::None);
    void warning(std::string_view msg, const Location& l = location::None);
    void deprecated(std::string_view msg, const Location& l = location::None);
    void error(std::string_view msg, const Location& l = location::None);
    void error(std::string_view msg, const std::vector<std::string>& context, const Location& l = location::None);
    [[noreturn]] void fatalError(std::string_view msg, const Location& l = location::None);
    [[noreturn]] void internalError(std::string_view msg, const Location& l = location::None);
 
    void info(std::string_view msg, const Node* n) { info(msg, n->location()); }
    void warning(std::string_view msg, const Node* n) { warning(msg, n->location()); }
    void deprecated(std::string_view msg, const Node* n) { deprecated(msg, n->location()); }
    void error(std::string_view msg, const Node* n) { error(msg, n->location()); }
    [[noreturn]] void fatalError(std::string_view msg, const Node* n) { fatalError(msg, n->location()); }
    [[noreturn]] void internalError(std::string_view msg, const Node* n) { internalError(msg, n->location()); }
 
    void _debug(const logging::DebugStream& dbg, std::string_view msg, const Location& l = location::None);
 
    template<typename T>
    void log(std::string msg, const std::shared_ptr<T>& n) {
        log(msg, n->location());
    }
 
    template<typename T>
    void info(std::string msg, const std::shared_ptr<T>& n) {
        info(msg, n->location());
    }
 
    template<typename T>
    void warning(std::string msg, const std::shared_ptr<T>& n) {
        warning(msg, n->location());
    }
 
    template<typename T>
    void error(std::string msg, const std::shared_ptr<T>& n) {
        error(msg, n->location());
    }
 
    template<typename T>
    void error(std::string msg, std::vector<std::string> context, const std::shared_ptr<T>& n) {
        error(msg, context, n.location());
    }
 
    template<typename R, typename T>
    void error(Result<R> r, const std::shared_ptr<T>& n) {
        error(r.error().description(), n.location());
    }
 
    template<typename T>
    [[noreturn]] void fatalError(std::string msg, const std::shared_ptr<T>& n) {
        fatalError(msg, n->location());
    }
 
    template<typename T>
    [[noreturn]] void internalError(std::string msg, const std::shared_ptr<T>& n) {
        internalError(msg, n->location());
    }
 
    template<typename T>
    void debug(const logging::DebugStream& dbg, std::string msg, const std::shared_ptr<T>& n) {
        debug(dbg, msg, n->location());
    }
 
    void debugEnable(const logging::DebugStream& dbg);
    bool debugEnable(const std::string& dbg);
    void debugDisable(const logging::DebugStream& dbg) { _debug_streams.erase(dbg); }
    bool debugDisable(const std::string& dbg);
 
    bool isEnabled(const logging::DebugStream& dbg) { return _debug_streams.contains(dbg); }
 
    void debugPushIndent(const logging::DebugStream& dbg) {
        if ( isEnabled(dbg) )
            _debug_streams[dbg] += 1;
    }
 
    void debugPopIndent(const logging::DebugStream& dbg) {
        if ( isEnabled(dbg) )
            _debug_streams[dbg] -= 1;
    }
 
    void debugSetIndent(const logging::DebugStream& dbg, size_t indent) {
        if ( isEnabled(dbg) )
            _debug_streams[dbg] = indent;
    }
 
    int errors() const { return _errors; }
    int warnings() const { return _warnings; }
 
    void reset() { _errors = _warnings = 0; }
 
protected:
    void report(std::ostream& output,
                logging::Level level,
                size_t indent,
                std::string_view addl,
                std::string_view msg,
                const Location& l) const;
 
private:
    friend Logger& logger();                                                  // NOLINT
    friend std::unique_ptr<Logger> setLogger(std::unique_ptr<Logger> logger); // NOLINT
 
    std::ostream& _output_std = std::cerr;
    std::ostream& _output_debug = std::cerr;
 
    int _warnings = 0;
    int _errors = 0;
 
    std::map<logging::DebugStream, size_t> _debug_streams;
 
    constinit inline static std::unique_ptr<Logger> _singleton;
};
 
inline Logger& logger() {
    if ( ! Logger::_singleton )
        Logger::_singleton = std::make_unique<Logger>();
 
    return *Logger::_singleton;
}
 
namespace logging {
 
class DebugPushIndent {
public:
    DebugPushIndent(const logging::DebugStream& dbg) : _dbg(dbg) { logger().debugPushIndent(_dbg); }
    ~DebugPushIndent() { logger().debugPopIndent(_dbg); }
 
    DebugPushIndent() = delete;
    DebugPushIndent(const DebugPushIndent&) = delete;
    DebugPushIndent(DebugPushIndent&&) noexcept = delete;
    DebugPushIndent& operator=(const DebugPushIndent&) = delete;
    DebugPushIndent& operator=(DebugPushIndent&&) noexcept = delete;
 
private:
    const logging::DebugStream& _dbg;
};
 
} // namespace logging
 
} // namespace hilti