manipulators.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 original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Logger source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-String tree and
 * the StormByte Base tree it vendors), which remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * 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
 * version 3 along with StormByte-Logger. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/logger/typedefs.hxx>
#include <StormByte/logger/visibility.h>
#include <StormByte/string/string.hxx>
 
#include <cstddef>
#include <optional>
#include <string_view>
 
namespace StormByte::Logger {
    class Log;
 
    enum class STORMBYTE_LOGGER_PUBLIC ThrottlePolicy : unsigned char {
        Drop,   
        Sample, 
        Window  
    };
 
    struct STORMBYTE_LOGGER_PUBLIC ThrottleSpec {
        std::optional<StormByte::String::String> Component; 
        std::optional<Level> Level;                         
        std::optional<StormByte::String::String> Group;     
        double Rate = 0.0;                                  
        std::size_t Burst = 0;                              
        ThrottlePolicy Policy = ThrottlePolicy::Drop;       
        std::size_t SampleN = 0;                            
        std::size_t WindowKeep = 0;                         
        std::size_t WindowPeriod = 0;                       
    };
 
    struct STORMBYTE_LOGGER_PUBLIC GroupManip {
        StormByte::String::String name; 
    };
 
    STORMBYTE_LOGGER_PUBLIC GroupManip group(StormByte::String::String name);
 
    inline GroupManip group(std::string_view name) {
        return group(StormByte::String::String{name});
    }
 
    struct STORMBYTE_LOGGER_PUBLIC ComponentManip {
        StormByte::String::String name; 
    };
 
    STORMBYTE_LOGGER_PUBLIC ComponentManip component(StormByte::String::String name);
 
    inline ComponentManip component(std::string_view name) {
        return component(StormByte::String::String{name});
    }
 
    struct STORMBYTE_LOGGER_PUBLIC ResetComponentManip {};
 
    inline constexpr ResetComponentManip reset_component{};
 
    struct STORMBYTE_LOGGER_PUBLIC PopComponentManip {};
 
    inline constexpr PopComponentManip pop_component{};
 
    struct STORMBYTE_LOGGER_PUBLIC FormatManip {
        StormByte::String::String format; 
    };
 
    struct STORMBYTE_LOGGER_PUBLIC PopFormatManip {};
 
    STORMBYTE_LOGGER_PUBLIC FormatManip push_format(StormByte::String::String format);
 
    inline FormatManip push_format(std::string_view format) {
        return push_format(StormByte::String::String{format});
    }
 
    inline constexpr PopFormatManip pop_format{};
 
    struct STORMBYTE_LOGGER_PUBLIC ColorManip {
        std::optional<Color> value; 
 
        constexpr ColorManip operator()(Color selected) const noexcept {
            return ColorManip{selected};
        }
    };
 
    inline constexpr ColorManip color{};
 
    struct STORMBYTE_LOGGER_PUBLIC NoColorManip {};
 
    inline constexpr NoColorManip nocolor{};
 
    struct STORMBYTE_LOGGER_PUBLIC RedactManip {
        std::size_t count = 0;     
        bool keep_first = false;   
 
        constexpr RedactManip operator()(std::size_t n) const noexcept {
            return RedactManip{ n, false };
        }
    };
 
    inline constexpr RedactManip redact{};
 
    constexpr RedactManip redact_first(std::size_t n) noexcept {
        return RedactManip{ n, true };
    }
 
    struct STORMBYTE_LOGGER_PUBLIC HexManip {
        std::size_t columns = 16; 
 
        constexpr HexManip operator()(std::size_t n) const noexcept {
            return HexManip{ n };
        }
    };
 
    inline constexpr HexManip hex{};
 
    struct STORMBYTE_LOGGER_PUBLIC NoHexManip {};
 
    inline constexpr NoHexManip nohex{};
 
    STORMBYTE_LOGGER_PUBLIC Log& humanreadable_number(Log& log) noexcept;
 
    STORMBYTE_LOGGER_PUBLIC Log& humanreadable_bytes(Log& log) noexcept;
 
    STORMBYTE_LOGGER_PUBLIC Log& nohumanreadable(Log& log) noexcept;
 
    STORMBYTE_LOGGER_PUBLIC Log& noredact(Log& log) noexcept;
}