logging.h

Go to the documentation of this file.

// Copyright (c) 2026 Tinverse LLC. All rights reserved.
// SPDX-License-Identifier: LicenseRef-Tinverse-Commercial
 
 
#pragma once
 
#include <cstdint>
 
#include "tsm/core_algorithms.h"
#include "tsm/ticks.h"
 
namespace tsm::log {
 
enum class Kind : std::uint8_t {
    Event,
    Transition,
    GuardRejected,
    Action,
    Entry,
    Exit,
    Unhandled,
};
 
enum class Level : std::uint8_t {
    Debug,
    Info,
    Warn,
    Error,
};
 
struct Record {
    tsm::tick_duration tick{};
    Kind kind{};
    std::uint16_t machine{ tsm::core::npos };
    std::uint16_t from{ tsm::core::npos };
    std::uint16_t event{ tsm::core::npos };
    std::uint16_t to{ tsm::core::npos };
    std::uint16_t transition{ tsm::core::npos };
};
 
} // namespace tsm::log
 
namespace tsm::policy {
 
struct NoLogging {
    static constexpr bool enabled = false;
};
 
template<typename Logger, tsm::log::Level Threshold = tsm::log::Level::Error>
struct Logging {
    static constexpr bool enabled = true;
    static constexpr auto threshold = Threshold;
 
    constexpr Logging() = default;
    constexpr explicit Logging(Logger logger)
      : logger_(logger) {}
 
    constexpr void debug(tsm::log::Kind kind, tsm::log::Record const& record) {
        if constexpr (enabled_for<tsm::log::Level::Debug>()) {
            logger_.debug(kind, record);
        }
    }
 
    constexpr void info(tsm::log::Kind kind, tsm::log::Record const& record) {
        if constexpr (enabled_for<tsm::log::Level::Info>()) {
            logger_.info(kind, record);
        }
    }
 
    constexpr void warn(tsm::log::Kind kind, tsm::log::Record const& record) {
        if constexpr (enabled_for<tsm::log::Level::Warn>()) {
            logger_.warn(kind, record);
        }
    }
 
    constexpr void error(tsm::log::Kind kind, tsm::log::Record const& record) {
        if constexpr (enabled_for<tsm::log::Level::Error>()) {
            logger_.error(kind, record);
        }
    }
 
  private:
    template<tsm::log::Level Level>
    static consteval bool enabled_for() {
        return static_cast<std::uint8_t>(Level) >=
               static_cast<std::uint8_t>(Threshold);
    }
 
    [[no_unique_address]] Logger logger_{};
};
 
} // namespace tsm::policy