macros.hpp

Go to the documentation of this file.

// Copyright (c) 2023 by Apex.AI Inc. All rights reserved.
// Copyright (c) 2024 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_ERROR_REPORTING_MACROS_HPP
#define IOX2_BB_REPORTING_ERROR_REPORTING_MACROS_HPP
 
#include "iox2/legacy/error_reporting/configuration.hpp"
#include "iox2/legacy/error_reporting/error_forwarding.hpp"
#include "iox2/legacy/error_reporting/types.hpp"
 
#include "iox2/bb/detail/source_location.hpp"
 
// ***
// * Define public error reporting API
// ***
 
// NOLINTBEGIN(cppcoreguidelines-macro-usage) source location requires macros
 
// The following macros are statements (not expressions).
// This is important, as it enforces correct use to some degree.
// For example they cannot be used as function arguments and must be terminated with a ';'.
//
// Note: once source location becomes available without macro usage this could (and arguably should)
// be transformed into a function API.
 
#define IOX2_REPORT(error, kind)                                                                                       \
    iox2::legacy::er::forwardNonFatalError(                                                                            \
        iox2::legacy::er::toError(error), kind, iox2::bb::detail::SourceLocation::current(), "")
 
#define IOX2_REPORT_FATAL(error)                                                                                       \
    iox2::legacy::er::forwardFatalError(                                                                               \
        iox2::legacy::er::toError(error), iox2::legacy::er::FATAL, iox2::bb::detail::SourceLocation::current(), "")
 
#define IOX2_REPORT_IF(condition, error, kind)                                                                         \
    if (condition) {                                                                                                   \
        iox2::legacy::er::forwardNonFatalError(                                                                        \
            iox2::legacy::er::toError(error), kind, iox2::bb::detail::SourceLocation::current(), #condition);          \
    }                                                                                                                  \
    [] { }() // the empty lambda forces a semicolon on the caller side
 
#define IOX2_REPORT_FATAL_IF(condition, error)                                                                         \
    if (condition) {                                                                                                   \
        iox2::legacy::er::forwardFatalError(iox2::legacy::er::toError(error),                                          \
                                            iox2::legacy::er::FATAL,                                                   \
                                            iox2::bb::detail::SourceLocation::current(),                               \
                                            #condition);                                                               \
    }                                                                                                                  \
    [] { }() // the empty lambda forces a semicolon on the caller side
 
// NOLINTEND(cppcoreguidelines-macro-usage)
 
#endif // IOX2_BB_REPORTING_ERROR_REPORTING_MACROS_HPP