logging.hpp

Go to the documentation of this file.

// Copyright (c) 2022 by Apex.AI Inc. All rights reserved.
// Copyright (c) 2023 by ekxide IO GmbH. 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_LOGGING_HPP
#define IOX2_BB_REPORTING_LOGGING_HPP
 
#include "iox2/legacy/log/logstream.hpp"
 
namespace iox2 {
namespace legacy {
namespace log {
namespace internal {
inline auto is_log_level_active(LogLevel log_level) noexcept -> bool {
    // AXIVION Next Construct FaultDetection-DeadBranches this is a configurable compile time option to be able to
    // optimize the logger call away during compilation and intended
    // AXIVION Next Construct AutosarC++19_03-M0.1.2 see justification for FaultDetection-DeadBranches
    // AXIVION Next Construct AutosarC++19_03-M0.1.9 see justification for FaultDetection-DeadBranches
    // AXIVION Next Construct AutosarC++19_03-M5.14.1 getLogLevel is a static method without side effects
    return ((log_level) <= MINIMAL_LOG_LEVEL)
           && (IGNORE_ACTIVE_LOG_LEVEL || ((log_level) <= log::Logger::getLogLevel()));
}
} // namespace internal
} // namespace log
} // namespace legacy
} // namespace iox2
 
// AXIVION Next Construct AutosarC++19_03-A16.0.1 cannot be realized with templates or constexpr functions due to the
// intended lazy evaluation technique with the if statement
// NOLINTBEGIN(cppcoreguidelines-macro-usage)
// NOLINTBEGIN(bugprone-macro-parentheses) 'msg_stream' cannot be wrapped in parentheses due to the '<<' operator
#define IOX2_LOG_INTERNAL(location, level, msg_stream)                                                                 \
    if (iox2::legacy::log::internal::is_log_level_active(level)) {                                                     \
        iox2::legacy::log::LogStream(location, level).self() << msg_stream;                                            \
    }                                                                                                                  \
    []() -> void { }() // the empty lambda forces a semicolon on the caller side
                       // NOLINTEND(bugprone-macro-parentheses)
 
// AXIVION Next Construct AutosarC++19_03-A16.0.1 needed for source code location, safely wrapped in macro
// AXIVION Next Construct AutosarC++19_03-M16.0.6 brackets around macro parameter would lead to compile time failures in this case
// NOLINTJUSTIFICATION __PRETTY_FUNCTION__ would work better in lambdas but especially with
// templates the resulting string is too large; we also get the file name and the line of the invocation which should be
// sufficient for debugging
// NOLINTBEGIN(bugprone-lambda-function-name)
#define IOX2_LOG(level, msg_stream)                                                                                    \
    IOX2_LOG_INTERNAL(iox2::bb::detail::SourceLocation::current(), iox2::legacy::log::LogLevel::level, msg_stream)
// NOLINTEND(bugprone-lambda-function-name)
 
// NOLINTEND(cppcoreguidelines-macro-usage)
 
#endif // IOX2_BB_REPORTING_LOGGING_HPP