InstallBasicPackageFiles: Fix subtle bug of OVERRIDE_MODULE_PATH

CHANGELOG.md

@@ -18,6 +18,7 @@ All notable changes to this project are documented in this file.
 
 ### Fixed
 - Fix the barrier logic for threads synchronization (https://github.com/ami-iit/bipedal-locomotion-framework/pull/811)
+- InstallBasicPackageFiles: Fix bug of OVERRIDE_MODULE_PATH that corrupt CMAKE_MODULE_PATH values set by blf transitive dependencies (https://github.com/ami-iit/bipedal-locomotion-framework/pull/827)
 
 ### Removed
 

cmake/InstallBasicPackageFiles.cmake

@@ -211,7 +211,7 @@
 # :command:`install` commands, otherwise <Name> is used.
 #
 # If the ``OVERRIDE_MODULE_PATH`` is set, the autogenerated ``<Name>Config.cmake``
-# file temporarily overrides the ``CMAKE_MODULE_PATH`` with the specified paths.
+# file temporarily prepends the ``CMAKE_MODULE_PATH`` with the specified paths.
 
 #=============================================================================
 # Copyright 2013 Istituto Italiano di Tecnologia (IIT)
@@ -576,13 +576,11 @@ ${_compatibility_vars}
   endif()
 
   unset(PACKAGE_DEPENDENCIES)
+  set(_overridden_module_path_list "")
   if(DEFINED _IBPF_DEPENDENCIES)
     set(PACKAGE_DEPENDENCIES "#### Expanded from @PACKAGE_DEPENDENCIES@ by install_basic_package_files() ####\n\ninclude(CMakeFindDependencyMacro)\n")
 
     if (DEFINED _IBPF_OVERRIDE_MODULE_PATH)
-
-      string(APPEND PACKAGE_DEPENDENCIES "set(CMAKE_MODULE_PATH_BK_${_IBPF_VARS_PREFIX} \${CMAKE_MODULE_PATH})\n")
-      set(_overridden_module_path "")
       foreach(_path ${_IBPF_OVERRIDE_MODULE_PATH})
 
           if (IS_ABSOLUTE ${_path})
@@ -592,9 +590,12 @@ ${_compatibility_vars}
           endif()
 
           file(RELATIVE_PATH _relative_path ${CMAKE_INSTALL_PREFIX} ${_absolute_module_path})
-          string(APPEND _overridden_module_path " \${PACKAGE_PREFIX_DIR}/${_relative_path}")
+          string(APPEND _overridden_module_path_list ";\${PACKAGE_PREFIX_DIR}/${_relative_path}")
       endforeach()
-      string(APPEND PACKAGE_DEPENDENCIES "set(CMAKE_MODULE_PATH${_overridden_module_path})\n")
+      string(APPEND PACKAGE_DEPENDENCIES "foreach(overridden_module_path ${_overridden_module_path_list})\n")
+      string(APPEND PACKAGE_DEPENDENCIES "    list(PREPEND CMAKE_MODULE_PATH \${overridden_module_path})\n")
+      string(APPEND PACKAGE_DEPENDENCIES "endforeach()\n")
+
       # If OVERRIDE_MODULE_PATH is used, then if a dependency is not found find_dependency will
       # halt the execution of the <package>config.cmake script, never restoring the original
       # value of CMAKE_MODULE_PATH. For this reason, in this case we just use find_package
@@ -654,7 +655,9 @@ endif()
     endif()
 
     if(DEFINED _IBPF_OVERRIDE_MODULE_PATH)
-      string(APPEND PACKAGE_DEPENDENCIES "set(CMAKE_MODULE_PATH \${CMAKE_MODULE_PATH_BK_${_IBPF_VARS_PREFIX}})\n")
+      string(APPEND PACKAGE_DEPENDENCIES "foreach(overridden_module_path ${_overridden_module_path_list})\n")
+      string(APPEND PACKAGE_DEPENDENCIES "    list(REMOVE_ITEM CMAKE_MODULE_PATH \${overridden_module_path})\n")
+      string(APPEND PACKAGE_DEPENDENCIES "endforeach()\n")
     endif()
 
     set(PACKAGE_DEPENDENCIES "${PACKAGE_DEPENDENCIES}\n###############################################################################\n")