console_writer.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 "../interfaces/log_writer_interface.h"
#include "../interfaces/log_formatter_interface.h"
#include "../interfaces/writer_category.h"
 
#include <kcenon/logger/logger_export.h>
 
#include <atomic>
#include <mutex>
#include <memory>
 
namespace kcenon::logger {
 
namespace security { class integrity_policy; }
 
class LOGGER_SYSTEM_API console_writer : public log_writer_interface, public sync_writer_tag {
public:
    explicit console_writer(bool use_stderr = false,
                           bool auto_detect_color = true,
                           std::unique_ptr<log_formatter_interface> formatter = nullptr);
 
    ~console_writer() override;
 
    // Non-copyable and non-movable
    console_writer(const console_writer&) = delete;
    console_writer& operator=(const console_writer&) = delete;
    console_writer(console_writer&&) = delete;
    console_writer& operator=(console_writer&&) = delete;
 
    common::VoidResult write(const log_entry& entry) override;
 
    common::VoidResult flush() override;
 
    std::string get_name() const override { return "console"; }
 
    bool is_healthy() const override;
 
    void set_use_stderr(bool use_stderr);
 
    void set_use_color(bool use_color);
 
    bool use_color() const;
 
    void set_integrity_policy(std::shared_ptr<security::integrity_policy> policy);
 
protected:
    std::string format_entry(const log_entry& entry) const;
 
    std::mutex& get_mutex() const { return mutex_; }
 
private:
    bool is_color_supported() const;
 
private:
    bool use_stderr_;
    bool use_color_{true};
    std::unique_ptr<log_formatter_interface> formatter_;
    std::shared_ptr<security::integrity_policy> integrity_policy_;
    mutable std::mutex mutex_;
};
 
} // namespace kcenon::logger