Refactored detray::io into a single library.

For the moment removed the DETRAY_IO_CSV and DETRAY_IO_JSON cache variables completely. They were not used correctly in every place anyway. So for now the project would always need dfelibs and nlohmann_json to be available. In the move made sure that every I/O header would actually be tested for working by itelf. Which was mistakenly not the case before.
acts-project · Apr 4, 2023 · 3bb4dec · 3bb4dec
1 parent 68e06a3
commit 3bb4dec
Show file tree

Hide file tree

Showing 21 changed files with 81 additions and 192 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -52,8 +52,6 @@ endif()
 option( DETRAY_EIGEN_PLUGIN "Build Eigen math plugin" ON )
 option( DETRAY_SMATRIX_PLUGIN "Build ROOT/SMatrix math plugin" OFF )
 option( DETRAY_VC_PLUGIN "Build Vc based math plugin" ON )
-option( DETRAY_IO_CSV "Build CSV IO module" ON )
-option( DETRAY_IO_JSON "Build JSON IO module" ON)
 option( DETRAY_SVG_DISPLAY "Build ActSVG display module" OFF)
 option( DETRAY_BUILD_SYCL "Build the SYCL sources included in detray" OFF )
 option( DETRAY_BUILD_CUDA "Build the CUDA sources included in detray"

diff --git a/README.md b/README.md
@@ -34,8 +34,6 @@ project would be built:
   * Note that [Algebra Plugins](https://github.com/acts-project/algebra-plugins)
     must have all of the appropriate options enabled for whichever option
     is turned on from these.
-- `DETRAY_IO_CSV`: Boolean option turning on the build of `detray::io_csv`, the
-  library allowing the reading of geometries from CSV files (`ON` by default);
 - `DETRAY_DISPLAY`: Boolean option turning on the build of `detray::display`,
   and additional helpers for displaying a geometry (`OFF` by default);
 - `DETRAY_BUILD_CUDA`: Boolean option turning on the build of all CUDA code

diff --git a/cmake/detray-config.cmake.in b/cmake/detray-config.cmake.in
@@ -12,7 +12,6 @@
 set( DETRAY_EIGEN_PLUGIN @DETRAY_EIGEN_PLUGIN@ )
 set( DETRAY_SMATRIX_PLUGIN @DETRAY_SMATRIX_PLUGIN@ )
 set( DETRAY_VC_PLUGIN @DETRAY_VC_PLUGIN@ )
-set( DETRAY_IO_CSV @DETRAY_IO_CSV@ )
 set( DETRAY_DISPLAY @DETRAY_DISPLAY@ )
 set( DETRAY_BUILD_CUDA @DETRAY_BUILD_CUDA@ )
 
@@ -27,9 +26,8 @@ include( CMakeFindDependencyMacro )
 find_dependency( algebra-plugins )
 find_dependency( Thrust )
 find_dependency( vecmem )
-if( DETRAY_IO_CSV )
-   find_dependency( dfelibs )
-endif()
+find_dependency( dfelibs )
+find_dependency( nlohmann_json )
 if( DETRAY_DISPLAY )
    find_dependency( Matplot++ )
 endif()

diff --git a/io/CMakeLists.txt b/io/CMakeLists.txt
@@ -1,22 +1,63 @@
 # Detray library, part of the ACTS project (R&D line)
 #
-# (c) 2021 CERN for the benefit of the ACTS project
+# (c) 2021-2023 CERN for the benefit of the ACTS project
 #
 # Mozilla Public License Version 2.0
 
 # Let the user know what's happening.
 message(STATUS "Building 'detray::io' component")
 
-# Create the "main I/O library".
-detray_add_library( detray_io io )
+# Set up the core I/O library.
+file( GLOB _detray_io_public_headers
+   RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
+   "include/detray/io/*.hpp" )
+detray_add_library( detray_io io
+   ${_detray_io_public_headers} )
+target_link_libraries( detray_io INTERFACE
+   dfelibs::dfelibs nlohmann_json::nlohmann_json vecmem::core detray::core )
 
-add_subdirectory ( payload )
+# Set up libraries using particular algebra plugins.
+detray_add_library( detray_io_array io_array )
+target_link_libraries( detray_io_array
+   INTERFACE detray::io detray::algebra_array )
 
-# Include all active components.
-if( DETRAY_IO_CSV )
-   add_subdirectory( csv )
+if( DETRAY_EIGEN_PLUGIN )
+   detray_add_library( detray_io_eigen io_eigen )
+   target_link_libraries( detray_io_eigen
+      INTERFACE detray::io detray::algebra_eigen )
 endif()
 
-if ( DETRAY_IO_JSON )
-   add_subdirectory( json )
-endif()
+if( DETRAY_SMATRIX_PLUGIN )
+   detray_add_library( detray_io_smatrix io_smatrix )
+   target_link_libraries( detray_io_smatrix
+      INTERFACE detray::io detray::algebra_smatrix )
+endif()
+
+if( DETRAY_VC_PLUGIN )
+   detray_add_library( detray_io_vc io_vc )
+   target_link_libraries( detray_io_vc
+      INTERFACE detray::io detray::algebra_vc )
+endif()
+
+# Test the public headers of the detray I/O libraries.
+if( BUILD_TESTING AND DETRAY_BUILD_TESTING )
+   string( REPLACE "include/" "" _detray_io_public_headers
+      "${_detray_io_public_headers}" )
+   detray_test_public_headers( detray_io_array
+      ${_detray_io_public_headers} )
+   if( DETRAY_EIGEN_PLUGIN )
+      detray_test_public_headers( detray_io_eigen
+         ${_detray_io_public_headers} )
+   endif()
+   if( DETRAY_SMATRIX_PLUGIN )
+      detray_test_public_headers( detray_io_smatrix
+         ${_detray_io_public_headers} )
+   endif()
+   if( DETRAY_VC_PLUGIN )
+      detray_test_public_headers( detray_io_vc
+         ${_detray_io_public_headers} )
+   endif()
+endif()
+
+# Clean up.
+unset( _detray_io_public_headers )
diff --git a/io/csv/CMakeLists.txt b/io/csv/CMakeLists.txt
diff --git a/io/csv/include/detray/io/csv_io.hpp → io/include/detray/io/csv_io.hpp b/io/csv/include/detray/io/csv_io.hpp → io/include/detray/io/csv_io.hpp
diff --git a/io/csv/include/detray/io/csv_io_types.hpp → io/include/detray/io/csv_io_types.hpp b/io/csv/include/detray/io/csv_io_types.hpp → io/include/detray/io/csv_io_types.hpp
diff --git a/io/payload/include/detray/io/io_payload.hpp → io/include/detray/io/io_payload.hpp b/io/payload/include/detray/io/io_payload.hpp → io/include/detray/io/io_payload.hpp
diff --git a/...son/include/detray/io/json_algebra_io.hpp → io/include/detray/io/json_algebra_io.hpp b/...son/include/detray/io/json_algebra_io.hpp → io/include/detray/io/json_algebra_io.hpp
diff --git a/io/json/include/detray/io/json_defs.hpp → io/include/detray/io/json_defs.hpp b/io/json/include/detray/io/json_defs.hpp → io/include/detray/io/json_defs.hpp
diff --git a/...on/include/detray/io/json_geometry_io.hpp → io/include/detray/io/json_geometry_io.hpp b/...on/include/detray/io/json_geometry_io.hpp → io/include/detray/io/json_geometry_io.hpp
diff --git a/io/json/include/detray/io/json_grids_io.hpp → io/include/detray/io/json_grids_io.hpp b/io/json/include/detray/io/json_grids_io.hpp → io/include/detray/io/json_grids_io.hpp
@@ -1,20 +1,23 @@
 /** Detray library, part of the ACTS project (R&D line)
  *
- * (c) 2022 CERN for the benefit of the ACTS project
+ * (c) 2022-2023 CERN for the benefit of the ACTS project
  *
  * Mozilla Public License Version 2.0
  */
 
 #pragma once
 
-#include <array>
-#include <optional>
-#include <vector>
-
+// Project include(s).
 #include "detray/definitions/grid_axis.hpp"
 #include "detray/io/io_payload.hpp"
+#include "detray/io/json_algebra_io.hpp"
 #include "detray/io/json_defs.hpp"
 
+// System include(s).
+#include <array>
+#include <optional>
+#include <vector>
+
 namespace detray {
 
 void to_json(nlohmann::json& j, const axis_payload& a) {

diff --git a/io/json/include/detray/io/json_io.hpp → io/include/detray/io/json_io.hpp b/io/json/include/detray/io/json_io.hpp → io/include/detray/io/json_io.hpp
diff --git a/...on/include/detray/io/json_material_io.hpp → io/include/detray/io/json_material_io.hpp b/...on/include/detray/io/json_material_io.hpp → io/include/detray/io/json_material_io.hpp
diff --git a/io/csv/include/detray/io/utils.hpp → io/include/detray/io/utils.hpp b/io/csv/include/detray/io/utils.hpp → io/include/detray/io/utils.hpp
diff --git a/io/json/CMakeLists.txt b/io/json/CMakeLists.txt
diff --git a/io/payload/CMakeLists.txt b/io/payload/CMakeLists.txt
diff --git a/tests/unit_tests/cpu/array/CMakeLists.txt b/tests/unit_tests/cpu/array/CMakeLists.txt
@@ -67,12 +67,11 @@ detray_add_test( array
    "array_volume.cpp"
    LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::algebra_array )
 
-# Set up the "conditional" tests.
-if( DETRAY_IO_CSV )
-   detray_add_test( array_read_detector "array_read_detector.cpp"
-      LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
-                     detray::algebra_array )
-endif()
+detray_add_test( array_read_detector "array_read_detector.cpp"
+   LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
+                  detray::algebra_array )
+
+# Set up the "conditional" test(s).
 if( DETRAY_DISPLAY )
    detray_add_test( array_display_masks "array_display_masks.cpp"
       LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::display

diff --git a/tests/unit_tests/cpu/eigen/CMakeLists.txt b/tests/unit_tests/cpu/eigen/CMakeLists.txt
@@ -67,12 +67,11 @@ detray_add_test( eigen
    "eigen_volume.cpp"
    LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::algebra_eigen )
 
-# Set up the "conditional" tests.
-if( DETRAY_IO_CSV )
-   detray_add_test( eigen_read_detector "eigen_read_detector.cpp"
-      LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
-                     detray::algebra_eigen )
-endif()
+detray_add_test( eigen_read_detector "eigen_read_detector.cpp"
+   LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
+                  detray::algebra_eigen )
+
+# Set up the "conditional" test(s).
 if( DETRAY_DISPLAY )
    detray_add_test( eigen_display_masks "eigen_display_masks.cpp"
       LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::display

diff --git a/tests/unit_tests/cpu/smatrix/CMakeLists.txt b/tests/unit_tests/cpu/smatrix/CMakeLists.txt
@@ -68,12 +68,11 @@ detray_add_test( smatrix
    LINK_LIBRARIES GTest::gtest_main detray_tests_common
                   detray::algebra_smatrix )
 
-# Set up the "conditional" tests.
-if( DETRAY_IO_CSV )
-   detray_add_test( smatrix_read_detector "smatrix_read_detector.cpp"
-      LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
-                     detray::algebra_smatrix )
-endif()
+detray_add_test( smatrix_read_detector "smatrix_read_detector.cpp"
+   LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
+                  detray::algebra_smatrix )
+
+# Set up the "conditional" test(s).
 if( DETRAY_DISPLAY )
    detray_add_test( smatrix_display_masks "smatrix_display_masks.cpp"
       LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::display

diff --git a/tests/unit_tests/cpu/vc/CMakeLists.txt b/tests/unit_tests/cpu/vc/CMakeLists.txt
@@ -67,12 +67,11 @@ detray_add_test( vc_array
    "vc_array_volume.cpp"
    LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::algebra_vc )
 
-# Set up the "conditional" tests.
-if( DETRAY_IO_CSV )
-   detray_add_test( vc_array_read_detector "vc_array_read_detector.cpp"
-      LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
-                     detray::algebra_vc )
-endif()
+detray_add_test( vc_array_read_detector "vc_array_read_detector.cpp"
+   LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::io
+                  detray::algebra_vc )
+
+# Set up the "conditional" test(s).
 if( DETRAY_DISPLAY )
    detray_add_test( vc_array_display_masks "vc_array_display_masks.cpp"
       LINK_LIBRARIES GTest::gtest_main detray_tests_common detray::display