threaded_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/logger/log.hxx>
#include <StormByte/thread_lock.hxx>
 
#include <cstddef>
#include <memory>
#include <span>
#include <string_view>
 
namespace StormByte::Logger {
    class STORMBYTE_LOGGER_PUBLIC ThreadedLog : public Log {
        public:
            ThreadedLog(std::ostream& out, const Level& level = Level::Info, const std::string& format = "[%L] %T");
 
            ThreadedLog(const ThreadedLog&) = default;
 
            ThreadedLog(ThreadedLog&&) noexcept = default;
 
            ~ThreadedLog() noexcept override = default;
 
            ThreadedLog& operator=(const ThreadedLog&) = default;
 
            ThreadedLog& operator=(ThreadedLog&&) noexcept = default;
 
            Log& Color(const Level& level, const StormByte::Logger::Color& color) override;
 
            StormByte::Logger::Color Color(const Level& level) const override;
 
            Log& Color(const std::string& component, const Level& level, const StormByte::Logger::Color& color) override;
 
            StormByte::Logger::Color Color(const std::string& component, const Level& level) const override;
 
            Log& Format(const std::string& format) override;
 
            const std::string& Format() const override;
 
            Log& Format(const std::string& component, const std::string& format) override;
 
            const std::string& Format(const std::string& component) const override;
 
            Log& Throttle(const ThrottleSpec& spec) override;
 
            Log& NoThrottle(const ThrottleSpec& spec) override;
 
            Log& Throttle(double rate, std::size_t burst) override;
 
            Log& Throttle(double rate, std::size_t burst, ThrottlePolicy policy, std::size_t value, std::size_t period = 0) override;
 
            Log& Throttle(const Level& level, double rate, std::size_t burst) override;
 
            Log& Throttle(GroupManip group, double rate, std::size_t burst) override;
 
            Log& Throttle(ComponentManip component, double rate, std::size_t burst) override;
 
            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) override;
 
            Log& NoThrottle() override;
 
            Log& NoThrottle(const Level& level) override;
 
            Log& NoThrottle(GroupManip group) override;
 
            Log& NoThrottle(ComponentManip component) override;
 
            Log& NoThrottle(ComponentManip component, const Level& level, GroupManip group) override;
 
            Log& FlushThrottle() override;
 
            Log& FlushThrottle(const ThrottleSpec& spec) override;
 
            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:
            PointerType Clone() const override;
 
            PointerType Move() override;
 
        private:
            std::shared_ptr<ThreadLock> m_lock; 
 
            void Write(bool v) override;
            void Write(char v) override;
            void Write(signed char v) override;
            void Write(unsigned char v) override;
            void Write(short v) override;
            void Write(unsigned short v) override;
            void Write(int v) override;
            void Write(unsigned int v) override;
            void Write(long v) override;
            void Write(unsigned long v) override;
            void Write(long long v) override;
            void Write(unsigned long long v) override;
            void Write(float v) override;
            void Write(double v) override;
            void Write(long double v) override;
            void Write(std::string_view v) override;
            void Write(const char* v) override;
            void Write(std::wstring_view v) override;
            void Write(const wchar_t* v) override;
            void Write(std::span<const std::byte> v) override;
            void Write(const Level& level) override;
            void Write(std::ostream& (*manip)(std::ostream&)) override;
            void Write(Log& (*manip)(Log&) noexcept) override;
            void Write(RedactManip m) override;
            void Write(HexManip m) override;
            void Write(NoHexManip m) override;
            void Write(ColorManip manip) override;
            void Write(NoColorManip manip) override;
            void Write(FormatManip manip) override;
            void Write(PopFormatManip manip) override;
            void Write(GroupManip manip) override;
            void Write(ComponentManip manip) override;
            void Write(PopComponentManip manip) override;
            void Write(ResetComponentManip manip) override;
    };
}