log_formatter_interface.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <string>
#include <memory>
#include <functional>
 
namespace kcenon::logger {
 
// Forward declaration
struct log_entry;
 
struct format_options {
    bool include_timestamp = true;
 
    bool include_thread_id = true;
 
    bool include_source_location = true;
 
    bool use_colors = false;
 
    bool include_level = true;
 
    bool pretty_print = false;
};
 
class log_formatter_interface {
public:
    virtual ~log_formatter_interface() = default;
 
    virtual std::string format(const log_entry& entry) const = 0;
 
    virtual void set_options(const format_options& opts) {
        options_ = opts;
    }
 
    virtual format_options get_options() const {
        return options_;
    }
 
    virtual std::string get_name() const = 0;
 
protected:
    format_options options_;
};
 
using formatter_factory = std::function<std::unique_ptr<log_formatter_interface>()>;
 
} // namespace kcenon::logger