vtd: Update vtd-api packages for 2.0 compatibility

cassava · cassava · commit da467430c56e · 2023-05-12T12:40:31.000+02:00
BREAKING CHANGE: The VTD_API_2_2_0 define is replaced by
VTD_API_VERSION numerical constant for future proofing.

This is split into separate defined components:

- VTD_API_VERSION_EPOCH
- VTD_API_VERSION_MAJOR
- VTD_API_VERSION_MINOR
- VTD_API_VERSION_PATCH

These can be used once the `vtd_version.hpp` header is
included. See this header file for documentation.
diff --git a/optional/vtd/CMakeLists.txt b/optional/vtd/CMakeLists.txt
@@ -24,16 +24,12 @@ add_library(vtd-object-lib STATIC
 )
 target_link_libraries(vtd-object-lib
   PUBLIC
-    vtd-api::vtd-api
+    vtd::api
     cloe::runtime
     cloe::models
     Boost::boost
     open-simulation-interface::open-simulation-interface
 )
-message(STATUS "VTD_API_VERSION: ${VTD_API_VERSION}")
-if (${VTD_API_VERSION} MATCHES "2.2.0")
-    add_compile_definitions("VTD_API_2_2_0")
-endif()
 
 set_target_properties(vtd-object-lib PROPERTIES
     CXX_STANDARD 17
diff --git a/optional/vtd/conanfile.py b/optional/vtd/conanfile.py
@@ -104,15 +104,8 @@ def layout(self):
         cmake.cmake_layout(self)
 
     def generate(self):
-        vtd_api_version = str(self.requires.get("vtd-api"))
-        if "vtd-api/2.2.0" in vtd_api_version:
-            self.vtd_api_version = "2.2.0"
-        else:
-            self.vtd_api_version = "2022.3"
         tc = cmake.CMakeToolchain(self)
         tc.cache_variables["CMAKE_EXPORT_COMPILE_COMMANDS"] = True
-        tc.preprocessor_definitions["VTD_API_VERSION"] = self.vtd_api_version
-        tc.cache_variables["VTD_API_VERSION"] = self.vtd_api_version
         tc.cache_variables["CLOE_PROJECT_VERSION"] = self.version
         tc.cache_variables["TargetLintingExtended"] = self.options.pedantic
         tc.generate()
@@ -124,13 +117,15 @@ def build(self):
         cm.test()
 
     def package(self):
+        vtd_api_version = self.dependencies["vtd-api"].ref.version
+
         cm = cmake.CMake(self)
         cm.install()
         self.copy("vtd-launch", dst="bin", src=f"{self.source_folder}/bin")
         self.copy(
             "*.tar",
             dst=self._setup_folder,
-            src=f"{self.source_folder}/{self._setup_folder}/{self.vtd_api_version}"
+            src=f"{self.source_folder}/{self._setup_folder}/{vtd_api_version}"
         )
 
     def package_id(self):
diff --git a/optional/vtd/src/omni_sensor_component.cpp b/optional/vtd/src/omni_sensor_component.cpp
@@ -27,16 +27,17 @@
 
 #include <Eigen/Geometry>  // for Vector3d, Quaterniond
 
-#ifdef VTD_API_2_2_0
-  #include <viRDBIcd.h>  // for RDB_OBJECT_TYPE_*
-#else
-  #include <VtdToolkit/viRDBIcd.h>
-#endif 
-
 #include <cloe/component/lane_boundary.hpp>  // for LaneBoundary
 #include <cloe/component/object.hpp>         // for Object
 #include <cloe/utility/geometry.hpp>         // for quaternion_from_rpy
 
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
+  #include <viRDBIcd.h>  // for RDB_OBJECT_TYPE_*
+#else
+  #include <VtdToolkit/viRDBIcd.h>
+#endif
+
 #include "vtd_logger.hpp"  // for lane_logger
 
 namespace vtd {
diff --git a/optional/vtd/src/omni_sensor_component.hpp b/optional/vtd/src/omni_sensor_component.hpp
@@ -27,11 +27,12 @@
 #include <memory>  // for shared_ptr<>, unique_ptr<>
 #include <string>  // for string, to_string
 
-#ifdef VTD_API_2_2_0
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
   #include <viRDBIcd.h>  // for RDB_OBJECT_STATE_t, ...
 #else
   #include <VtdToolkit/viRDBIcd.h>
-#endif  
+#endif
 
 #include "rdb_codec.hpp"        // for RdbCodec, RdbTransceiver
 #include "vtd_logger.hpp"       // for vtd_logger
diff --git a/optional/vtd/src/rdb_codec.hpp b/optional/vtd/src/rdb_codec.hpp
@@ -27,13 +27,14 @@
 #include <string>   // for string
 #include <utility>  // for move
 
-// This comes from VTD:
-#ifdef VTD_API_2_2_0
+#include <cloe/core.hpp>  // for Json, Duration
+
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
   #include <RDBHandler.hh>  // for RDB_MSG_t
 #else
   #include <VtdToolkit/RDBHandler.hh>
 #endif
-#include <cloe/core.hpp>  // for Json, Duration
 
 #include "rdb_transceiver.hpp"  // for RdbTransceiver
 
diff --git a/optional/vtd/src/rdb_transceiver.hpp b/optional/vtd/src/rdb_transceiver.hpp
@@ -25,12 +25,15 @@
 
 #include <memory>  // for shared_ptr<>
 #include <vector>  // for vector<>
-#ifdef VTD_API_2_2_0
+
+#include <cloe/core.hpp>  // for Json, Error
+
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
   #include <viRDBIcd.h>  // for RDB_MSG_t
 #else
   #include <VtdToolkit/viRDBIcd.h>
 #endif
-#include <cloe/core.hpp>  // for Json, Error
 
 namespace vtd {
 
diff --git a/optional/vtd/src/rdb_transceiver_shm.cpp b/optional/vtd/src/rdb_transceiver_shm.cpp
@@ -30,11 +30,12 @@
 
 #include <boost/interprocess/xsi_shared_memory.hpp>  // for xsi_shared_memory, ...
 
-#ifdef VTD_API_2_2_0
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
   #include <RDBHandler.hh>  // for RDB_SHM_BUFFER_INFO_t, RDB_MSG_t, ...
 #else
   #include <VtdToolkit/RDBHandler.hh>
-#endif  
+#endif
 
 #include "vtd_logger.hpp"  // for rdb_logger
 
diff --git a/optional/vtd/src/scp_transceiver.cpp b/optional/vtd/src/scp_transceiver.cpp
@@ -24,13 +24,14 @@
 #include <iostream>  // for snprintf
 #include <string>    // for string
 
-#ifdef VTD_API_2_2_0
+#include <cloe/utility/tcp_transceiver.hpp>  // for TcpReadError
+
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
   #include <scpIcd.h> // for SCP_MAGIC_NO, SCP_VERSION, SCP_MSG_HDR_t, ...
 #else
   #include <VtdToolkit/scpIcd.h>
-#endif  
-
-#include <cloe/utility/tcp_transceiver.hpp>  // for TcpReadError
+#endif
 
 namespace vtd {
 
diff --git a/optional/vtd/src/scp_transceiver.hpp b/optional/vtd/src/scp_transceiver.hpp
@@ -36,13 +36,16 @@
 #pragma once
 
 #include <string>  // for string
-#ifdef VTD_API_2_2_0
+
+#include <cloe/core.hpp>                     // for Json, Error
+#include <cloe/utility/tcp_transceiver.hpp>  // for TcpTransceiver
+
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
   #include <scpIcd.h>
 #else
   #include <VtdToolkit/scpIcd.h>
 #endif
-#include <cloe/core.hpp>                     // for Json, Error
-#include <cloe/utility/tcp_transceiver.hpp>  // for TcpTransceiver
 
 #include "vtd_logger.hpp"  // for scp_logger
 
diff --git a/optional/vtd/src/task_control.hpp b/optional/vtd/src/task_control.hpp
@@ -25,15 +25,16 @@
 #include <string>   // for string
 #include <utility>  // for move
 
-#ifdef VTD_API_2_2_0
-  #include <RDBHandler.hh>  
-#else
-  #include <VtdToolkit/RDBHandler.hh>
-#endif  
-
 #include <cloe/component/object.hpp>  // for Object
 #include <cloe/core.hpp>              // for Json
 
+#include "vtd_version.hpp"
+#if (VTD_API_VERSION_EPOCH == 0)
+  #include <RDBHandler.hh>
+#else
+  #include <VtdToolkit/RDBHandler.hh>
+#endif
+
 #include "omni_sensor_component.hpp"  // for VtdOmniSensor
 #include "rdb_codec.hpp"              // for RdbCodec
 #include "vtd_logger.hpp"             // for vtd_logger
diff --git a/optional/vtd/src/vtd_version.hpp b/optional/vtd/src/vtd_version.hpp
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2022 Robert Bosch GmbH
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * \file vtd_version.hpp
+ *
+ * This file just provides version information for the VTD version we
+ * are working with.
+ *
+ * We expect the vtd-api library to define a constant VTD_API_VERSION,
+ * which takes the following format:
+ *
+ *   (EPOCH << 24) | (MAJOR_VERSION << 16) | (MINOR_VERSION << 8) | PATCH_VERSION
+ *
+ * Each version consists of at most 8 bits, so 256 potential values, including 0.
+ * The epoch starts with 0, and is bumped after each version naming scheme.
+ *
+ * The following macros are defined from VTD_API_VERSION:
+ *
+ * - VTD_API_VERSION_EPOCH
+ * - VTD_API_VERSION_MAJOR
+ * - VTD_API_VERSION_MINOR
+ * - VTD_API_VERSION_PATCH
+ *
+ * When years are involved, such as in releases versioned YYYY.MM, use the last
+ * two years, since the full year will not fit in the 8 bits.
+ *
+ * Here are some example versions that could be used with this plugin:
+ *
+ * - VTD 2.1.0    -> Epoch = 0
+ * - VTD 2.2.0
+ * - VTD 2019.1   -> Epoch = 1
+ * - VTD 2022.3
+ *
+ * So in order to target VTD 2.X, we could use `VTD_API_VERSION_EPOCH==0` or
+ * `VTD_API_VERSION_MAJOR==2`.
+ */
+
+#pragma once
+
+#ifndef VTD_API_VERSION
+#error "require VTD_API_VERSION to be defined"
+#endif
+
+#define VTD_API_VERSION_EPOCH ((VTD_API_VERSION >> 24) && 0xff)
+#define VTD_API_VERSION_MAJOR ((VTD_API_VERSION >> 16) && 0xff)
+#define VTD_API_VERSION_MINOR ((VTD_API_VERSION >> 8) && 0xff)
+#define VTD_API_VERSION_PATCH ((VTD_API_VERSION >> 0) && 0xff)
diff --git a/optional/vtd/vendor/vtd-api-2.2.0/CMakeLists.txt b/optional/vtd/vendor/vtd-api-2.2.0/CMakeLists.txt
@@ -2,31 +2,29 @@ cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
 
 project(vtd_api LANGUAGES CXX VERSION 2.2.0)
 
-include(${CMAKE_CURRENT_BINARY_DIR}/conanbuildinfo.cmake)
-conan_basic_setup(TARGETS)
-
-set(target vtd_api)
-
-add_library(${target}
+add_library(vtd-api
     src/Develop/Framework/RDBHandler/RDBHandler.cc
 )
-target_include_directories(${target}
+add_library(vtd::api ALIAS vtd-api)
+target_include_directories(vtd-api
   PUBLIC
-    src/Develop/Framework/inc
-    src/Develop/Framework/RDBHandler
+    "$<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/src/Develop/Framework/inc>"
+    "$<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/src/Develop/Framework/RDBHandler>"
+    "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>"
 )
 
 # Installation -------------------------------------------------------
 include(GNUInstallDirs)
-install(TARGETS ${target}
+install(TARGETS vtd-api
     LIBRARY
         DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE
         DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )
 install(
     DIRECTORY
-        src/Develop/Framework/inc/
-        src/Develop/Framework/RDBHandler/
+        ${CMAKE_BINARY_DIR}/src/Develop/Framework/inc/
+        ${CMAKE_BINARY_DIR}/src/Develop/Framework/RDBHandler/
     DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    PATTERN "*.cc" EXCLUDE
 )
diff --git a/optional/vtd/vendor/vtd-api-2.2.0/conanfile.py b/optional/vtd/vendor/vtd-api-2.2.0/conanfile.py
@@ -3,8 +3,11 @@
 
 from pathlib import Path
 
-from conans import CMake, ConanFile, tools
-from conans.errors import ConanInvalidConfiguration
+from conan import ConanFile
+from conan.errors import ConanInvalidConfiguration
+from conan.tools import cmake, files
+
+required_conan_version = ">=1.52.0"
 
 
 class VtdApiConan(ConanFile):
@@ -31,36 +34,49 @@ class VtdApiConan(ConanFile):
     build_requires = [
         "vtd/2.2.0@cloe-restricted/stable",
     ]
-    generators = "cmake"
-
-    _cmake = None
+    generators = "CMakeDeps", "CMakeToolchain"
 
     def configure(self):
         if self.settings.os == "Windows":
             raise ConanInvalidConfiguration("VTD binaries do not exist for Windows")
 
-    def imports(self):
-        self.copy("*", dst="src/Develop", src="Develop", root_package="vtd")
+    def layout(self):
+        cmake.cmake_layout(self)
 
-    def _configure_cmake(self):
-        if self._cmake:
-            return self._cmake
-        self._cmake = CMake(self)
-        self._cmake.definitions["CMAKE_EXPORT_COMPILE_COMMANDS"] = True
-        self._cmake.configure()
-        return self._cmake
+    def generate(self):
+        files.copy(self, "Develop/*", src=self.dependencies.build["vtd"].package_folder, dst="../src")
 
     def build(self):
-        cmake = self._configure_cmake()
-        cmake.build()
+        cm = cmake.CMake(self)
+        cm.configure()
+        cm.build()
 
     def package(self):
-        cmake = self._configure_cmake()
-        cmake.install()
-        self.copy("Develop", src="src", symlinks=True)
+        cm = cmake.CMake(self)
+        cm.install()
+        files.copy(self, "Develop", src="src", dst=".")
 
     def package_info(self):
-        if self.in_local_cache:
-            self.cpp_info.libs = tools.collect_libs(self)
-        else:
+        self.cpp_info.set_property("cmake_find_mode", "both")
+        self.cpp_info.set_property("cmake_file_name", "vtd-api")
+        self.cpp_info.set_property("cmake_target_name", "vtd::api")
+        self.cpp_info.set_property("pkg_config_name", "vtd-api")
+
+        # This define takes the format:
+        #
+        #   (EPOCH << 24) | (MAJOR_VERSION << 16) | (MINOR_VERSION << 8) | PATCH_VERSION
+        #
+        # Each version consists of at most 8 bits, so 256 potential values, including 0.
+        # The epoch starts with 0, and is bumped after each version naming scheme.
+        #
+        # When years are involved, such as in releases versioned YYYY.MM, use the last
+        # two years, since the full year will not fit in the 8 bits.
+        #
+        # VTD VERSION   : (0)       2        . 2     . 0
+        vtd_api_version = (0<<24) | (2<<16) | (2<<8) | 0
+        self.cpp_info.defines = ["VTD_API_VERSION={vtd_api_version}"]
+
+        if not self.in_local_cache:
             self.cpp_info.libs = ["vtd_api"]
+        else:
+            self.cpp_info.libs = files.collect_libs(self)
diff --git a/optional/vtd/vendor/vtd-api-2022.3/CMakeLists.txt b/optional/vtd/vendor/vtd-api-2022.3/CMakeLists.txt
diff --git a/optional/vtd/vendor/vtd-api-2022.3/conanfile.py b/optional/vtd/vendor/vtd-api-2022.3/conanfile.py
