logger.hpp

Go to the documentation of this file.

// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2021 - 2022 by Apex.AI Inc. All rights reserved.
// Copyright (c) 2025 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT
 
#ifndef IOX2_BB_REPORTING_LOG_BUILDING_BLOCKS_LOGGER_HPP
#define IOX2_BB_REPORTING_LOG_BUILDING_BLOCKS_LOGGER_HPP
 
#include "iox2/legacy/atomic.hpp"
 
#include <cstdint>
#include <cstring>
#include <mutex>
 
namespace iox2 {
namespace legacy {
namespace log {
class LogStream;
 
enum class LogLevel : uint8_t {
    Off = 0,
    Fatal,
    Error,
    Warn,
    Info,
    Debug,
    Trace,
};
 
// AXIVION Next Construct AutosarC++19_03-A3.9.1 : This function return a string literal
// which corresponds to a const char *
constexpr const char* asStringLiteral(const LogLevel value) noexcept;
 
template <uint32_t N>
// NOLINTJUSTIFICATION required for C-style string comparison; safety guaranteed by strncmp
// NOLINTNEXTLINE(hicpp-avoid-c-arrays, cppcoreguidelines-avoid-c-arrays)
bool equalStrings(const char* lhs, const char (&rhs)[N]) noexcept;
 
LogLevel logLevelFromEnvOr(const LogLevel logLevel) noexcept;
 
namespace internal {
template <typename BaseLogger>
class Logger : public BaseLogger {
  public:
    friend class log::LogStream;
 
    Logger() = default;
 
    Logger(const Logger&) = delete;
    Logger(Logger&&) = delete;
 
    Logger& operator=(const Logger&) = delete;
    Logger& operator=(Logger&&) = delete;
 
    ~Logger() = default;
 
    static Logger& get() noexcept;
 
    static void init(const LogLevel logLevel = logLevelFromEnvOr(LogLevel::Info)) noexcept;
 
    static void setActiveLogger(Logger& newLogger) noexcept;
 
  private:
    static Logger& activeLogger(Logger* newLogger = nullptr) noexcept;
 
    void initLoggerInternal(const LogLevel logLevel) noexcept;
 
  private:
    concurrent::Atomic<bool> m_isActive { true };
    concurrent::Atomic<bool> m_isFinalized { false };
};
 
} // namespace internal
} // namespace log
} // namespace legacy
} // namespace iox2
 
#include "iox2/legacy/detail/log/building_blocks/logger.inl"
 
#endif // IOX2_BB_REPORTING_LOG_BUILDING_BLOCKS_LOGGER_HPP