Handle optional dependency SuiteSparse by directly passing HAVE_xxx flags

Summary

This MR tries to solve an issue with localized config.h files as introduces in !1262 (merged) in the handling of optional dependencies. For a package that is found in an upstream module, like dune-common, but that is used for the first time in a downstream module, we cannot fix the flags HAVE_SUITESPARSE already in upstream. It might be that a user installs SuiteSparse later. This was no problem in the old handling of config.h files when everything is regenerated downstreams, but we want to generate local config.h files in the modules that provide the flags. For purely optional packages, the solution is to introduce the HAVE_SUITESPARSE flag directly downstream and not with the indirection of an ENABLE_SUITESPARSE flag.

Necessary changes for module authors

Nothing! everything is changed in the add_dune_suitesparse_flags macro and the dune_register_package_flags call. Those are executed in downstream modules as before.

This MR acts as a preprint for changes in other modules that also want to provide purely optional packages that are not used by the module itself, but only by downstream modules. Note that protected headers that are not compiled in a library are still fine to be provided in the upstream module.

Closes #252 (closed)

cmake/modules/AddSuiteSparseFlags.cmake

@@ -18,11 +18,26 @@ include_guard(GLOBAL)
 set(HAVE_SUITESPARSE ${SuiteSparse_FOUND})
 set(HAVE_UMFPACK ${SuiteSparse_UMFPACK_FOUND})
 
+# collect all components that are found
+set(SuiteSparse_FOUND_COMPONENTS)
+foreach(_component ${SUITESPARSE_COMPONENTS})
+  if(SuiteSparse_${_component}_FOUND)
+    list(APPEND SuiteSparse_FOUND_COMPONENTS ${_component})
+  endif()
+endforeach(_component)
+
+
 # register all SuiteSparse related flags
 if(SuiteSparse_FOUND)
+  # set(HAVE_SUITESPARSE_FLAGS "HAVE_SUITESPARSE=1")
+  set(HAVE_SUITESPARSE_FLAGS)
+  foreach(_component ${SuiteSparse_FOUND_COMPONENTS})
+    list(APPEND HAVE_SUITESPARSE_FLAGS "HAVE_SUITESPARSE_${_component}=1")
+  endforeach(_component)
   dune_register_package_flags(
-    COMPILE_DEFINITIONS "ENABLE_SUITESPARSE=1"
+    COMPILE_DEFINITIONS ${HAVE_SUITESPARSE_FLAGS}
     LIBRARIES SuiteSparse::SuiteSparse)
+  unset(HAVE_SUITESPARSE_FLAGS)
 endif()
 
 # Provide function to set target properties for linking to SuiteSparse
@@ -30,7 +45,10 @@ function(add_dune_suitesparse_flags _targets)
   if(SuiteSparse_FOUND)
     foreach(_target ${_targets})
       target_link_libraries(${_target} PUBLIC SuiteSparse::SuiteSparse)
-      target_compile_definitions(${_target} PUBLIC ENABLE_SUITESPARSE=1)
+      # target_compile_definitions(${_target} PUBLIC HAVE_SUITESPARSE=1)
+      foreach(_component ${SuiteSparse_FOUND_COMPONENTS})
+        target_compile_definitions(${_target} PUBLIC HAVE_SUITESPARSE_${_component}=1)
+      endforeach(_component)
     endforeach(_target)
   endif()
 endfunction(add_dune_suitesparse_flags)