log.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Logger.
 *
 * StormByte-Logger is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * StormByte-Logger 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with StormByte-Logger. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
#include <StormByte/clonable.hxx>
#include <StormByte/logger/manipulators.hxx>
#include <StormByte/logger/typedefs.hxx>
#include <StormByte/type_traits.hxx>
 
#include <cstddef>
#include <memory>
#include <ostream>
#include <span>
#include <string>
#include <string_view>
 
namespace StormByte::Logger {
    class Implementation;
 
    class STORMBYTE_LOGGER_PUBLIC Log : protected StormByte::Clonable<Log, std::shared_ptr<Log>> {
        friend STORMBYTE_LOGGER_PUBLIC Log& humanreadable_number(Log& log) noexcept;
        friend STORMBYTE_LOGGER_PUBLIC Log& humanreadable_bytes(Log& log) noexcept;
        friend STORMBYTE_LOGGER_PUBLIC Log& nohumanreadable(Log& log) noexcept;
        friend STORMBYTE_LOGGER_PUBLIC Log& noredact(Log& log) noexcept;
 
        public:
            using PointerType = StormByte::Clonable<Log, std::shared_ptr<Log>>::PointerType;
 
            Log(std::ostream& out, const Level& level = Level::Info, const std::string& format = "[%L] %T");
 
            Log(const Log&) = default;
 
            Log(Log&&) noexcept = default;
 
            ~Log() noexcept override = default;
 
            Log& operator=(const Log&) = default;
 
            Log& operator=(Log&&) noexcept = default;
 
            PointerType Scope(std::string path);
 
            bool Enabled(const Level& level) const noexcept;
 
            virtual Log& Color(const Level& level, const StormByte::Logger::Color& color);
 
            virtual StormByte::Logger::Color Color(const Level& level) const;
 
            virtual Log& Color(const std::string& component, const Level& level, const StormByte::Logger::Color& color);
 
            virtual StormByte::Logger::Color Color(const std::string& component, const Level& level) const;
 
            virtual Log& Format(const std::string& format);
 
            virtual const std::string& Format() const;
 
            virtual Log& Format(const std::string& component, const std::string& format);
 
            virtual const std::string& Format(const std::string& component) const;
 
            virtual Log& Throttle(const ThrottleSpec& spec);
 
            virtual Log& NoThrottle(const ThrottleSpec& spec);
 
            virtual Log& Throttle(double rate, std::size_t burst);
 
            virtual Log& Throttle(double rate, std::size_t burst, ThrottlePolicy policy, std::size_t value, std::size_t period = 0);
 
            virtual Log& Throttle(const Level& level, double rate, std::size_t burst);
 
            virtual Log& Throttle(GroupManip group, double rate, std::size_t burst);
 
            virtual Log& Throttle(ComponentManip component, double rate, std::size_t burst);
 
            virtual Log& Throttle(ComponentManip component, const Level& level, GroupManip group, double rate, std::size_t burst, ThrottlePolicy policy = ThrottlePolicy::Drop, std::size_t value = 0, std::size_t period = 0);
 
            virtual Log& NoThrottle();
 
            virtual Log& NoThrottle(const Level& level);
 
            virtual Log& NoThrottle(GroupManip group);
 
            virtual Log& NoThrottle(ComponentManip component);
 
            virtual Log& NoThrottle(ComponentManip component, const Level& level, GroupManip group);
 
            virtual Log& FlushThrottle();
 
            virtual Log& FlushThrottle(const ThrottleSpec& spec);
 
            inline Log& operator<<(bool v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(char v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(signed char v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(unsigned char v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(short v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(unsigned short v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(int v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(unsigned int v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(long v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(unsigned long v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(long long v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(unsigned long long v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(float v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(double v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(long double v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(std::string_view v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(const char* v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(std::wstring_view v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(const wchar_t* v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(std::span<const std::byte> v) {
                if (!WillWrite()) [[likely]] return *this;
                Write(v);
                return *this;
            }
            inline Log& operator<<(const Level& level) {
                Write(level);
                return *this;
            }
            inline Log& operator<<(std::ostream& (*manip)(std::ostream&)) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(Log& (*manip)(Log&) noexcept) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(RedactManip m) {
                Write(m);
                return *this;
            }
            inline Log& operator<<(HexManip m) {
                Write(m);
                return *this;
            }
            inline Log& operator<<(NoHexManip m) {
                Write(m);
                return *this;
            }
            inline Log& operator<<(ColorManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(NoColorManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(FormatManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(PopFormatManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(GroupManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(ComponentManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(PopComponentManip manip) {
                Write(manip);
                return *this;
            }
            inline Log& operator<<(ResetComponentManip manip) {
                Write(manip);
                return *this;
            }
 
        protected:
            std::shared_ptr<Implementation> m_impl; 
            std::string m_scope_path;               
 
            bool WillWrite() const noexcept;
 
            bool PrepareLine();
 
            bool HasOpenOutputLine() const noexcept;
 
            bool LineDecided() const noexcept;
 
            bool LineAdmitted() const noexcept;
 
            PointerType Clone() const override;
 
            PointerType Move() override;
 
            virtual void Write(bool v);
            virtual void Write(char v);
            virtual void Write(signed char v);
            virtual void Write(unsigned char v);
            virtual void Write(short v);
            virtual void Write(unsigned short v);
            virtual void Write(int v);
            virtual void Write(unsigned int v);
            virtual void Write(long v);
            virtual void Write(unsigned long v);
            virtual void Write(long long v);
            virtual void Write(unsigned long long v);
            virtual void Write(float v);
            virtual void Write(double v);
            virtual void Write(long double v);
            virtual void Write(std::string_view v);
            virtual void Write(const char* v);
            virtual void Write(std::wstring_view v);
            virtual void Write(const wchar_t* v);
            virtual void Write(std::span<const std::byte> v);
            virtual void Write(const Level& level);
            virtual void Write(std::ostream& (*manip)(std::ostream&));
            virtual void Write(Log& (*manip)(Log&) noexcept);
            virtual void Write(RedactManip m);
            virtual void Write(HexManip m);
            virtual void Write(NoHexManip m);
            virtual void Write(ColorManip manip);
            virtual void Write(NoColorManip manip);
            virtual void Write(FormatManip manip);
            virtual void Write(PopFormatManip manip);
            virtual void Write(GroupManip manip);
            virtual void Write(ComponentManip manip);
            virtual void Write(PopComponentManip manip);
            virtual void Write(ResetComponentManip manip);
    };
 
    template <typename Ptr, typename T>
    Ptr& operator<<(Ptr& logger, const T& value) noexcept
        requires StormByte::Type::DerivedFrom<typename std::remove_cvref_t<Ptr>::element_type, Log> {
        if (logger)
            *logger << value;
        return logger;
    }
 
    template <typename Ptr>
    Ptr& operator<<(Ptr& logger, const Level& level) noexcept
        requires StormByte::Type::DerivedFrom<typename std::remove_cvref_t<Ptr>::element_type, Log> {
        if (logger)
            *logger << level;
        return logger;
    }
 
    template <typename Ptr>
    Ptr& operator<<(Ptr& logger, std::ostream& (*manip)(std::ostream&)) noexcept
        requires StormByte::Type::DerivedFrom<typename std::remove_cvref_t<Ptr>::element_type, Log> {
        if (logger)
            *logger << manip;
        return logger;
    }
}