.. _program_listing_file__tmp_ws_src_rosidl_rosidl_typesupport_introspection_tests_include_rosidl_typesupport_introspection_tests_helpers.hpp:

Program Listing for File helpers.hpp
====================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_rosidl_rosidl_typesupport_introspection_tests_include_rosidl_typesupport_introspection_tests_helpers.hpp>` (``/tmp/ws/src/rosidl/rosidl_typesupport_introspection_tests/include/rosidl_typesupport_introspection_tests/helpers.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2022 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 ROSIDL_TYPESUPPORT_INTROSPECTION_TESTS__HELPERS_HPP_
   #define ROSIDL_TYPESUPPORT_INTROSPECTION_TESTS__HELPERS_HPP_
   
   #include <rcutils/error_handling.h>
   #include <rcutils/macros.h>
   
   #include <rosidl_runtime_c/primitives_sequence_functions.h>
   #include <rosidl_runtime_c/string_functions.h>
   #include <rosidl_runtime_c/u16string_functions.h>
   
   #include <stdexcept>
   #include <vector>
   
   #include <rosidl_runtime_cpp/bounded_vector.hpp>
   
   
   template<typename T>
   inline T deepcopy(T value) {return value;}
   
   #define DEFINE_DEEPCOPY_OVERLOAD_FOR_C_MESSAGE_MEMBER(type) \
     inline type deepcopy(const type & input) { \
       type output; \
       if (!RCUTILS_JOIN(type, __init)(&output)) { \
         throw std::runtime_error(rcutils_get_error_string().str); \
       } \
       if (!RCUTILS_JOIN(type, __copy)(&input, &output)) { \
         RCUTILS_JOIN(type, __fini)(&output); \
         throw std::runtime_error(rcutils_get_error_string().str); \
       } \
       return output; \
     }
   
   #define DEFINE_DEEPCOPY_OVERLOAD_FOR_C_MESSAGE_SEQUENCE_MEMBER(type) \
     inline type deepcopy(const type & input) { \
       type output; \
       if (!RCUTILS_JOIN(type, __init)(&output, 0u)) { \
         throw std::runtime_error(rcutils_get_error_string().str); \
       } \
       if (!RCUTILS_JOIN(type, __copy)(&input, &output)) { \
         throw std::runtime_error(rcutils_get_error_string().str); \
       } \
       return output; \
     }
   
   template<typename T, size_t N>
   inline constexpr size_t length(const T (&)[N]) {return N;}
   
   template<typename T, size_t N>
   inline constexpr size_t length(const std::array<T, N> &) {return N;}
   
   template<typename T, size_t N>
   inline size_t
   length(const rosidl_runtime_cpp::BoundedVector<T, N> & vector)
   {
     return vector.size();
   }
   
   template<typename T>
   inline size_t
   length(const std::vector<T> & vector)
   {
     return vector.size();
   }
   
   template<typename T>
   inline const T &
   getitem(const T array[], const size_t index)
   {
     return array[index];
   }
   
   template<typename T>
   inline const T &
   getitem(const std::vector<T> & vector, const size_t index)
   {
     return vector[index];
   }
   
   // Deal with std::vector<bool> quirks.
   inline bool
   getitem(const std::vector<bool> & vector, const size_t index)
   {
     return vector[index];
   }
   
   template<typename T, size_t N>
   inline const T & getitem(
     const rosidl_runtime_cpp::BoundedVector<T, N> & vector,
     const size_t index)
   {
     return vector[index];
   }
   
   // Deal with rosidl_runtime_cpp::BoundedVector<bool, N> quirks.
   template<size_t N>
   inline bool getitem(
     const rosidl_runtime_cpp::BoundedVector<bool, N> & vector,
     const size_t index)
   {
     return vector[index];
   }
   
   template<typename T, size_t N>
   inline const T &
   getitem(const std::array<T, N> & array, const size_t index)
   {
     return array[index];
   }
   
   #define DEFINE_GETITEM_OVERLOAD_FOR_C_MESSAGE_SEQUENCE_MEMBER(type) \
     inline auto & getitem(const type & seq, const size_t index) { \
       return seq.data[index]; \
     }
   
   #define DEFINE_LENGTH_OVERLOAD_FOR_C_MESSAGE_SEQUENCE_MEMBER(type) \
     inline size_t length(const type & seq) {return seq.size;}
   
   #define DEFINE_OPERATOR_OVERLOADS_FOR_C_MESSAGE_MEMBER(type) \
     inline bool operator==(const type & lhs, const type & rhs) { \
       return RCUTILS_JOIN(type, __are_equal)(&lhs, &rhs); \
     } \
     inline bool operator!=(const type & lhs, const type & rhs) { \
       return !RCUTILS_JOIN(type, __are_equal)(&lhs, &rhs); \
     }
   
   #define DEFINE_CXX_API_FOR_C_MESSAGE_MEMBER(type) \
     DEFINE_OPERATOR_OVERLOADS_FOR_C_MESSAGE_MEMBER(type) \
     DEFINE_DEEPCOPY_OVERLOAD_FOR_C_MESSAGE_MEMBER(type)
   
   #define DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(type) \
     DEFINE_OPERATOR_OVERLOADS_FOR_C_MESSAGE_MEMBER(type) \
     DEFINE_DEEPCOPY_OVERLOAD_FOR_C_MESSAGE_SEQUENCE_MEMBER(type) \
     DEFINE_GETITEM_OVERLOAD_FOR_C_MESSAGE_SEQUENCE_MEMBER(type) \
     DEFINE_LENGTH_OVERLOAD_FOR_C_MESSAGE_SEQUENCE_MEMBER(type)
   
   #define C_INTERFACE_NAME(package_name, interface_type, interface_name) \
     RCUTILS_JOIN( \
       RCUTILS_JOIN( \
         RCUTILS_JOIN( \
           RCUTILS_JOIN( \
             package_name, __), interface_type), __), interface_name)
   
   #define DEFINE_CXX_API_FOR_C_MESSAGE(package_name, interface_type, message_name) \
     DEFINE_CXX_API_FOR_C_MESSAGE_MEMBER( \
       C_INTERFACE_NAME(package_name, interface_type, message_name)) \
     DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER( \
       RCUTILS_JOIN(C_INTERFACE_NAME(package_name, interface_type, message_name), __Sequence))
   
   #define DEFINE_CXX_API_FOR_C_SERVICE(package_name, interface_type, service_name) \
     DEFINE_CXX_API_FOR_C_MESSAGE_MEMBER( \
       C_INTERFACE_NAME(package_name, interface_type, RCUTILS_JOIN(service_name, _Request))) \
     DEFINE_CXX_API_FOR_C_MESSAGE_MEMBER( \
       C_INTERFACE_NAME(package_name, interface_type, RCUTILS_JOIN(service_name, _Response))) \
     struct C_INTERFACE_NAME (package_name, interface_type, service_name) { \
     using Request = C_INTERFACE_NAME( \
       package_name, interface_type, RCUTILS_JOIN( \
         service_name, \
         _Request)); \
     using Response = \
       C_INTERFACE_NAME(package_name, interface_type, RCUTILS_JOIN(service_name, _Response)); \
   };
   
   // Extra C++ APIs to homogeneize access to rosidl_runtime_c primitives
   DEFINE_CXX_API_FOR_C_MESSAGE_MEMBER(rosidl_runtime_c__String)
   DEFINE_CXX_API_FOR_C_MESSAGE_MEMBER(rosidl_runtime_c__U16String)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__float__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__double__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__long_double__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__char__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__wchar__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__boolean__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__octet__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__uint8__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__int8__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__uint16__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__int16__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__uint32__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__int32__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__uint64__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__int64__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__String__Sequence)
   DEFINE_CXX_API_FOR_C_MESSAGE_SEQUENCE_MEMBER(rosidl_runtime_c__U16String__Sequence)
   
   #endif  // ROSIDL_TYPESUPPORT_INTROSPECTION_TESTS__HELPERS_HPP_