Ensure natvis files in the extra/ directory are added to the target's INTERFACE_SOURCES

Author: k3DW

include/BoostInstall.cmake

@@ -215,12 +215,49 @@ function(__boost_install_update_include_directory lib incdir prop)
 
 endfunction()
 
+function(__boost_install_update_natvis lib extradir)
+
+  if(NOT TARGET "${lib}" OR NOT lib MATCHES "^boost_(.*)$")
+    return()
+  endif()
+
+  get_target_property(sources ${lib} INTERFACE_SOURCES)
+  if(NOT sources)
+    return()
+  endif()
+
+  foreach(src IN LISTS sources)
+
+    # Look for .natvis files in the given extra directory
+    if(src MATCHES "\\${extradir}\\/(.*)\\.natvis")
+
+      set(natvis_file "${CMAKE_MATCH_1}.natvis")
+
+      if("${src}" STREQUAL "${extradir}/${natvis_file}" OR "${src}" STREQUAL "$<BUILD_INTERFACE:${extradir}/${natvis_file}>")
+
+        # Remove this .natvis file from the INTERFACE_SOURCES target property,
+        # only if it appears as a direct path, not a generator expression.
+        get_target_property(modified_sources ${lib} INTERFACE_SOURCES)
+        list(REMOVE_ITEM modified_sources "${extradir}/${natvis_file}")
+        set_target_properties(${lib} PROPERTIES INTERFACE_SOURCES "${modified_sources}")
+
+        # Add this .natvis file to the INTERFACE_SOURCES target property, prefixed properly.
+        target_sources("${lib}" INTERFACE $<BUILD_INTERFACE:${extradir}/${natvis_file}> $<INSTALL_INTERFACE:${CMAKE_INSTALL_DATADIR}/${natvis_file}>)
+
+      endif()
+
+    endif()
+
+  endforeach()
+
+endfunction()
+
 # Installs a single target
-# boost_install_target(TARGET target VERSION version [HEADER_DIRECTORY directory])
+# boost_install_target(TARGET target VERSION version [HEADER_DIRECTORY directory] [EXTRA_DIRECTORY directory])
 
 function(boost_install_target)
 
-  cmake_parse_arguments(_ "" "TARGET;VERSION;HEADER_DIRECTORY" "" ${ARGN})
+  cmake_parse_arguments(_ "" "TARGET;VERSION;HEADER_DIRECTORY;EXTRA_DIRECTORY" "" ${ARGN})
 
   if(NOT __TARGET)
 
@@ -317,6 +354,10 @@ function(boost_install_target)
     if(TYPE STREQUAL "STATIC_LIBRARY" AND NOT CMAKE_VERSION VERSION_LESS 3.15)
       install(FILES "$<TARGET_FILE_DIR:${LIB}>/$<TARGET_FILE_PREFIX:${LIB}>$<TARGET_FILE_BASE_NAME:${LIB}>.pdb" DESTINATION ${CMAKE_INSTALL_LIBDIR} OPTIONAL)
     endif()
+
+    if(__EXTRA_DIRECTORY)
+      __boost_install_update_natvis(${LIB} ${__EXTRA_DIRECTORY})
+    endif()
   endif()
 
   install(EXPORT ${LIB}-targets DESTINATION "${CONFIG_INSTALL_DIR}" NAMESPACE Boost:: FILE ${LIB}-targets.cmake)
@@ -560,7 +601,7 @@ function(boost_install)
 
   foreach(target IN LISTS __TARGETS)
 
-    boost_install_target(TARGET ${target} VERSION ${__VERSION} HEADER_DIRECTORY ${__HEADER_DIRECTORY})
+    boost_install_target(TARGET ${target} VERSION ${__VERSION} HEADER_DIRECTORY ${__HEADER_DIRECTORY} EXTRA_DIRECTORY ${__EXTRA_DIRECTORY})
 
   endforeach()