typesupport_helpers.cpp

// Copyright 2018, Bosch Software Innovations GmbH.
// Copyright 2021, Apex.AI 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.
 
#include "rclcpp/typesupport_helpers.hpp"
 
#include <algorithm>
#include <filesystem>
#include <functional>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <string>
#include <tuple>
#include <utility>
 
#include "ament_index_cpp/get_package_prefix.hpp"
#include "ament_index_cpp/get_resources.hpp"
#include "rcpputils/shared_library.hpp"
#include "rcpputils/find_library.hpp"
#include "rosidl_runtime_cpp/message_type_support_decl.hpp"
 
namespace rclcpp
{
 
namespace
{
 
const void * get_typesupport_handle_impl(
  const std::string & type,
  const std::string & typesupport_identifier,
  const std::string & typesupport_name,
  const std::string & symbol_part_name,
  const std::string & middle_module_additional,
  rcpputils::SharedLibrary & library)
{
  std::string package_name;
  std::string middle_module;
  std::string type_name;
  std::tie(package_name, middle_module, type_name) = extract_type_identifier(type);
 
  if (middle_module.empty()) {
    middle_module = middle_module_additional;
  }
 
  auto mk_error = [&package_name, &type_name, &typesupport_name](auto reason) {
      std::stringstream rcutils_dynamic_loading_error;
      rcutils_dynamic_loading_error <<
        "Something went wrong loading the typesupport library for " <<
        typesupport_name << " type " << package_name <<
        "/" << type_name << ". " << reason;
      return rcutils_dynamic_loading_error.str();
    };
 
  try {
    std::string symbol_name = typesupport_identifier + symbol_part_name +
      package_name + "__" + middle_module + "__" + type_name;
    const void * (* get_ts)() = nullptr;
    // This will throw runtime_error if the symbol was not found.
    get_ts = reinterpret_cast<decltype(get_ts)>(library.get_symbol(symbol_name));
    return get_ts();
  } catch (std::runtime_error &) {
    throw std::runtime_error{mk_error("Library could not be found.")};
  }
}
 
// Trim leading and trailing whitespace from the string.
std::string string_trim(std::string_view str_v)
{
  auto begin = std::find_if_not(str_v.begin(), str_v.end(), [](unsigned char ch) {
        return std::isspace(ch);
  });
  auto end = std::find_if_not(str_v.rbegin(), str_v.rend(), [](unsigned char ch) {
        return std::isspace(ch);
  }).base();
  if (begin >= end) {
    return {};
  }
  return std::string(begin, end);
}
 
}  // anonymous namespace
 
std::tuple<std::string, std::string, std::string>
extract_type_identifier(const std::string & full_type)
{
  char type_separator = '/';
  auto sep_position_back = full_type.find_last_of(type_separator);
  auto sep_position_front = full_type.find_first_of(type_separator);
  if (sep_position_back == std::string::npos ||
    sep_position_front == 0 ||
    sep_position_back == 0 ||
    sep_position_back == full_type.length() - 1)
  {
    throw std::runtime_error(
      "Message type is not of the form package/type and cannot be processed");
  }
 
  std::string package_name = full_type.substr(0, sep_position_front);
  std::string middle_module = "";
  if (sep_position_back - sep_position_front > 0) {
    middle_module =
      full_type.substr(sep_position_front + 1, sep_position_back - sep_position_front - 1);
  }
  std::string type_name = full_type.substr(sep_position_back + 1);
 
  return std::make_tuple(
    string_trim(package_name), string_trim(middle_module), string_trim(type_name));
}
 
std::string get_typesupport_library_path(
  const std::string & package_name, const std::string & typesupport_identifier)
{
  const char * dynamic_library_folder;
#ifdef _WIN32
  dynamic_library_folder = "bin";
#elif __APPLE__
  dynamic_library_folder = "lib";
#else
  dynamic_library_folder = "lib";
#endif
 
  std::filesystem::path package_prefix;
  try {
    ament_index_cpp::get_package_prefix(package_name, package_prefix);
  } catch (ament_index_cpp::PackageNotFoundError & e) {
    throw std::runtime_error(e.what());
  }
 
  const std::string library_path = rcpputils::path_for_library(
    (package_prefix / dynamic_library_folder).string(),
    package_name + "__" + typesupport_identifier);
  if (library_path.empty()) {
    throw std::runtime_error(
      "Typesupport library for " + package_name + " does not exist in '" +
        package_prefix.string() + "'.");
  }
  return library_path;
}
 
std::shared_ptr<rcpputils::SharedLibrary>
get_typesupport_library(const std::string & type, const std::string & typesupport_identifier)
{
  auto package_name = std::get<0>(extract_type_identifier(type));
  auto library_path = get_typesupport_library_path(package_name, typesupport_identifier);
  return std::make_shared<rcpputils::SharedLibrary>(library_path);
}
 
const rosidl_message_type_support_t * get_message_typesupport_handle(
  const std::string & type,
  const std::string & typesupport_identifier,
  rcpputils::SharedLibrary & library)
{
  static const std::string typesupport_name = "message";
  static const std::string symbol_part_name = "__get_message_type_support_handle__";
  static const std::string middle_module_additional = "msg";
 
  return static_cast<const rosidl_message_type_support_t *>(get_typesupport_handle_impl(
           type, typesupport_identifier, typesupport_name, symbol_part_name,
           middle_module_additional, library
  ));
}
 
const rosidl_service_type_support_t * get_service_typesupport_handle(
  const std::string & type,
  const std::string & typesupport_identifier,
  rcpputils::SharedLibrary & library)
{
  static const std::string typesupport_name = "service";
  static const std::string symbol_part_name = "__get_service_type_support_handle__";
  static const std::string middle_module_additional = "srv";
 
  return static_cast<const rosidl_service_type_support_t *>(get_typesupport_handle_impl(
           type, typesupport_identifier, typesupport_name, symbol_part_name,
           middle_module_additional, library
  ));
}
 
const rosidl_action_type_support_t * get_action_typesupport_handle(
  const std::string & type,
  const std::string & typesupport_identifier,
  rcpputils::SharedLibrary & library)
{
  static const std::string typesupport_name = "action";
  static const std::string symbol_part_name = "__get_action_type_support_handle__";
  static const std::string middle_module_additional = "action";
 
  return static_cast<const rosidl_action_type_support_t *>(get_typesupport_handle_impl(
           type, typesupport_identifier, typesupport_name, symbol_part_name,
           middle_module_additional, library
  ));
}
 
}  // namespace rclcpp