Print Celeritas configuration options when loading downstream (#1802)

* Add packages to components list and always print installed components when finding Celeritas

* Add options to componentslist

Author: sethrj

CMakeLists.txt

@@ -32,7 +32,6 @@ if(NOT CELERITAS_USE_CUDA)
 endif()
 
 # Optional dependencies
-# NOTE: when adding a new dependency, update the CMakeConfig "COMPONENTS"
 celeritas_optional_package(covfie "Use Covfie field integrator")
 celeritas_optional_package(Geant4 "Enable Geant4 adapter tools")
 celeritas_optional_package(HepMC3 "Enable HepMC3 event record reader")
@@ -86,8 +85,8 @@ if(CELERITAS_BUILD_TESTS)
 endif()
 
 # Automatic options
-set(CELERITAS_USE_CLI11 ${CELERITAS_BUILD_APPS})
-set(CELERITAS_USE_GTest ${CELERITAS_BUILD_TESTS})
+celeritas_force_package(CLI11 ${CELERITAS_BUILD_APPS})
+celeritas_force_package(GTest ${CELERITAS_BUILD_TESTS})
 
 #----------------------------------------------------------------------------#
 # CELERITAS CORE IMPLEMENTATION OPTIONS
@@ -337,7 +336,7 @@ if(CELERITAS_USE_CUDA)
   find_package(Thrust)
 endif()
 # Unconditionally set Thrust availability for downstream configuration
-set(CELERITAS_USE_Thrust "${Thrust_FOUND}")
+celeritas_force_package(Thrust "${Thrust_FOUND}")
 
 if(CELERITAS_USE_Geant4 AND NOT Geant4_FOUND)
   find_package(Geant4 REQUIRED)
@@ -619,6 +618,7 @@ set(_cmake_files
   # For now, include in case downstream projects do `include(CudaRdcUtils)`.
   "${_LOCAL_RDCUTILS_FILENAME}"
 )
+# Add packages with custom Celeritas-provided FindX scripts
 foreach(_dep CLI11 covfie Geant4 G4VG HepMC3 Perfetto ROOT Thrust VecGeom)
   if(CELERITAS_USE_${_dep} AND NOT CELERITAS_BUILTIN_${_dep})
     list(APPEND _cmake_files "${PROJECT_SOURCE_DIR}/cmake/Find${_dep}.cmake")
@@ -643,18 +643,22 @@ file(COPY ${_cmake_files}
 # Export all cache variables that start with CELERITAS_
 set(CELERITAS_EXPORT_VARIABLES)
 macro(celeritas_export_var varname)
-  list(APPEND CELERITAS_EXPORT_VARIABLES "set(${varname} \"${${varname}}\")")
+  # Value of _key may be ;-separated list, so we need to escape the ; if present
+  string(REPLACE ";" "\;" _key_val "${${varname}}")
+  list(APPEND CELERITAS_EXPORT_VARIABLES "set(${varname} \"${_key_val}\")")
 endmacro()
 celeritas_export_var(Celeritas_VERSION_STRING)
+list(APPEND CELERITAS_EXPORT_VARIABLES "\n# Components")
+celeritas_export_var(CELERITAS_COMPONENTS)
+celeritas_export_var(CELERITAS_ENABLED_COMPONENTS)
+celeritas_export_var(CELERITAS_OPTION_VARS)
 list(APPEND CELERITAS_EXPORT_VARIABLES "\n# Configuration options")
 get_directory_property(_cachevar_keys CACHE_VARIABLES)
 foreach(_key IN LISTS _cachevar_keys)
   if(_key MATCHES "^CELERITAS_")
     celeritas_export_var(${_key})
   endif()
 endforeach()
-# Thrust dependency is not a cache variable
-celeritas_export_var(CELERITAS_USE_Thrust)
 
 # Save whether we need GDML requirement
 if(Geant4_gdml_FOUND OR VecGeom_GDML_FOUND)
@@ -663,8 +667,11 @@ else()
   set(CELERITAS_USE_GDML OFF)
 endif()
 celeritas_export_var(CELERITAS_USE_GDML)
+foreach(_key IN LISTS CELERITAS_FORCED_PACKAGE_VARS)
+  celeritas_export_var(${_key})
+endforeach()
 
-# Export defaulted variables
+# Export defaulted CMake variables
 list(APPEND CELERITAS_EXPORT_VARIABLES "\n# Defaulted local variables")
 set(_celer_other_cmake_variables)
 if(CELERITAS_USE_CUDA)

cmake/CeleritasConfig.cmake.in

@@ -134,7 +134,6 @@ endif()
 
 if(CELERITAS_USE_Python)
   find_dependency(Python 3.6 REQUIRED COMPONENTS Interpreter)
-  unset(_components)
 endif()
 
 if(CELERITAS_USE_ROOT)
@@ -193,20 +192,29 @@ endif()
 
 #-----------------------------------------------------------------------------#
 # Set components for use by the caller
-
-foreach(_dep
-    CUDA HIP # Languages
-    covfie Geant4 HepMC3 MPI OpenMP Perfetto PNG ROOT VecGeom # Packages
-  )
+foreach(_dep IN LISTS CELERITAS_COMPONENTS)
   set(@PROJECT_NAME@_${_dep}_FOUND ${CELERITAS_USE_${_dep}})
 endforeach()
 unset(_dep)
 
+foreach(_var IN LISTS CELERITAS_OPTION_VARS)
+  set(@PROJECT_NAME@_${_var}=${CELERITAS_${_var}}_FOUND TRUE)
+endforeach()
+
+if(NOT @PROJECT_NAME@_FIND_COMPONENTS)
+  set(@PROJECT_NAME@_FIND_COMPONENTS @CELERITAS_ENABLED_COMPONENTS@)
+  foreach(_var IN LISTS CELERITAS_OPTION_VARS)
+    list(APPEND @PROJECT_NAME@_FIND_COMPONENTS
+      "${_var}=${CELERITAS_${_var}}")
+  endforeach()
+endif()
+unset(_var)
+
 #-----------------------------------------------------------------------------#
 # Print a pretty message if the caller doesn't have a FindCeleritas.cmake
 
 include(FindPackageHandleStandardArgs)
 set(${CMAKE_FIND_PACKAGE_NAME}_CONFIG "${CMAKE_CURRENT_LIST_FILE}")
-find_package_handle_standard_args(@PROJECT_NAME@ CONFIG_MODE)
+find_package_handle_standard_args(@PROJECT_NAME@ CONFIG_MODE HANDLE_COMPONENTS)
 
 #-----------------------------------------------------------------------------#

cmake/CeleritasOptionUtils.cmake

@@ -127,14 +127,29 @@ include_guard(GLOBAL)
 
 include(CheckLanguage)
 
+# List of available components
+set(CELERITAS_COMPONENTS)
+# List of enabled components
+set(CELERITAS_ENABLED_COMPONENTS)
+# List of forced packages
+set(CELERITAS_FORCED_PACKAGE_VARS)
+# List of configurable options
+set(CELERITAS_OPTION_VARS)
 # List of variables configured via `celeritas_set_default`
 set(CELERITAS_DEFAULT_VARIABLES)
 # True if any CELERITAS_BUILTIN_XXX
 set(CELERITAS_BUILTIN FALSE)
 
 #-----------------------------------------------------------------------------#
+macro(_celeritas_append_optional_component var val)
+  # Append to list of components
+  list(APPEND CELERITAS_COMPONENTS ${var})
+  if("${val}")
+    list(APPEND CELERITAS_ENABLED_COMPONENTS ${var})
+  endif()
+endmacro()
 
-function(celeritas_optional_language lang)
+macro(celeritas_optional_language lang)
   set(_var "CELERITAS_USE_${lang}")
   if(DEFINED "${_var}")
     set(_val "${_var}")
@@ -147,8 +162,11 @@ function(celeritas_optional_language lang)
     message(STATUS "Set ${_var}=${_val} based on compiler availability")
   endif()
 
+  # Create option
   option("${_var}" "Enable the ${lang} language" "${_val}" )
-endfunction()
+  # Append to list of components
+  _celeritas_append_optional_component("${lang}" "${${_var}}")
+endmacro()
 
 #-----------------------------------------------------------------------------#
 
@@ -230,7 +248,19 @@ macro(celeritas_optional_package package)
     endif()
   endif()
 
+  # Create option
   option("${_var}" "${_docstring}" "${_val}")
+  # Append to list of components
+  _celeritas_append_optional_component(${package} "${${_var}}")
+endmacro()
+
+macro(celeritas_force_package package value)
+  set(_var "CELERITAS_USE_${package}")
+  set(${_var} ${value})
+  # Append to list of components
+  _celeritas_append_optional_component(${package} "${value}")
+  # Append to list of forced packages for export
+  list(APPEND CELERITAS_FORCED_PACKAGE_VARS ${_var})
 endmacro()
 
 #-----------------------------------------------------------------------------#
@@ -344,6 +374,9 @@ function(celeritas_define_options var doc)
     endif()
   endif()
   set(${_last_var} "${_val}" CACHE INTERNAL "")
+
+  string(REGEX REPLACE "^CELERITAS_" "" _shortvar "${var}")
+  set(CELERITAS_OPTION_VARS ${CELERITAS_OPTION_VARS} ${_shortvar} PARENT_SCOPE)
 endfunction()
 
 #-----------------------------------------------------------------------------#