logging.hpp

Go to the documentation of this file.

// generated from rclcpp/resource/logging.hpp.em

// Copyright 2017 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef RCLCPP__LOGGING_HPP_
#define RCLCPP__LOGGING_HPP_

#include <type_traits>

#include "rclcpp/logger.hpp"
#include "rcutils/logging_macros.h"

// These are used for compiling out logging macros lower than a minimum severity.
#define RCLCPP_LOG_MIN_SEVERITY_DEBUG 0
#define RCLCPP_LOG_MIN_SEVERITY_INFO 1
#define RCLCPP_LOG_MIN_SEVERITY_WARN 2
#define RCLCPP_LOG_MIN_SEVERITY_ERROR 3
#define RCLCPP_LOG_MIN_SEVERITY_FATAL 4
#define RCLCPP_LOG_MIN_SEVERITY_NONE 5

#ifndef RCLCPP_LOG_MIN_SEVERITY
#define RCLCPP_LOG_MIN_SEVERITY RCLCPP_LOG_MIN_SEVERITY_DEBUG
#endif

#if (RCLCPP_LOG_MIN_SEVERITY > RCLCPP_LOG_MIN_SEVERITY_DEBUG)
// empty logging macros for severity DEBUG when being disabled at compile time
#define RCLCPP_DEBUG(...)
#define RCLCPP_DEBUG_ONCE(...)
#define RCLCPP_DEBUG_EXPRESSION(...)
#define RCLCPP_DEBUG_FUNCTION(...)
#define RCLCPP_DEBUG_SKIPFIRST(...)

#else

#define RCLCPP_DEBUG(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_DEBUG_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_DEBUG_ONCE(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_DEBUG_ONCE_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_DEBUG_EXPRESSION(logger, expression, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_DEBUG_EXPRESSION_NAMED( \
    expression, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_DEBUG_FUNCTION(logger, function, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_DEBUG_FUNCTION_NAMED( \
    function, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_DEBUG_SKIPFIRST(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_DEBUG_SKIPFIRST_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#endif

#if (RCLCPP_LOG_MIN_SEVERITY > RCLCPP_LOG_MIN_SEVERITY_INFO)
// empty logging macros for severity INFO when being disabled at compile time
#define RCLCPP_INFO(...)
#define RCLCPP_INFO_ONCE(...)
#define RCLCPP_INFO_EXPRESSION(...)
#define RCLCPP_INFO_FUNCTION(...)
#define RCLCPP_INFO_SKIPFIRST(...)

#else

#define RCLCPP_INFO(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_INFO_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_INFO_ONCE(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_INFO_ONCE_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_INFO_EXPRESSION(logger, expression, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_INFO_EXPRESSION_NAMED( \
    expression, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_INFO_FUNCTION(logger, function, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_INFO_FUNCTION_NAMED( \
    function, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_INFO_SKIPFIRST(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_INFO_SKIPFIRST_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#endif

#if (RCLCPP_LOG_MIN_SEVERITY > RCLCPP_LOG_MIN_SEVERITY_WARN)
// empty logging macros for severity WARN when being disabled at compile time
#define RCLCPP_WARN(...)
#define RCLCPP_WARN_ONCE(...)
#define RCLCPP_WARN_EXPRESSION(...)
#define RCLCPP_WARN_FUNCTION(...)
#define RCLCPP_WARN_SKIPFIRST(...)

#else

#define RCLCPP_WARN(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_WARN_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_WARN_ONCE(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_WARN_ONCE_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_WARN_EXPRESSION(logger, expression, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_WARN_EXPRESSION_NAMED( \
    expression, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_WARN_FUNCTION(logger, function, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_WARN_FUNCTION_NAMED( \
    function, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_WARN_SKIPFIRST(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_WARN_SKIPFIRST_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#endif

#if (RCLCPP_LOG_MIN_SEVERITY > RCLCPP_LOG_MIN_SEVERITY_ERROR)
// empty logging macros for severity ERROR when being disabled at compile time
#define RCLCPP_ERROR(...)
#define RCLCPP_ERROR_ONCE(...)
#define RCLCPP_ERROR_EXPRESSION(...)
#define RCLCPP_ERROR_FUNCTION(...)
#define RCLCPP_ERROR_SKIPFIRST(...)

#else

#define RCLCPP_ERROR(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_ERROR_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_ERROR_ONCE(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_ERROR_ONCE_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_ERROR_EXPRESSION(logger, expression, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_ERROR_EXPRESSION_NAMED( \
    expression, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_ERROR_FUNCTION(logger, function, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_ERROR_FUNCTION_NAMED( \
    function, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_ERROR_SKIPFIRST(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_ERROR_SKIPFIRST_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#endif

#if (RCLCPP_LOG_MIN_SEVERITY > RCLCPP_LOG_MIN_SEVERITY_FATAL)
// empty logging macros for severity FATAL when being disabled at compile time
#define RCLCPP_FATAL(...)
#define RCLCPP_FATAL_ONCE(...)
#define RCLCPP_FATAL_EXPRESSION(...)
#define RCLCPP_FATAL_FUNCTION(...)
#define RCLCPP_FATAL_SKIPFIRST(...)

#else

#define RCLCPP_FATAL(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_FATAL_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_FATAL_ONCE(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_FATAL_ONCE_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_FATAL_EXPRESSION(logger, expression, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_FATAL_EXPRESSION_NAMED( \
    expression, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_FATAL_FUNCTION(logger, function, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_FATAL_FUNCTION_NAMED( \
    function, \
    logger.get_name(), \
    __VA_ARGS__)

#define RCLCPP_FATAL_SKIPFIRST(logger, ...) \
  static_assert( \
    ::std::is_same<std::remove_reference<decltype(logger)>::type, ::rclcpp::Logger>::value, \
    "First argument to logging macros must be an rclcpp::Logger"); \
  RCUTILS_LOG_FATAL_SKIPFIRST_NAMED( \
    logger.get_name(), \
    __VA_ARGS__)

#endif


#endif  // RCLCPP__LOGGING_HPP_