Skip to content

cmake: surface headers in Visual Studio solution #1222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cnaples79 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

cmake: surface headers in Visual Studio solution #1222

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45dcb68
cmake: surface headers in Visual Studio solution
cnaples79 Oct 6, 2025
5146d31
cmake: fix interface header paths
cnaples79 Oct 7, 2025
d43635b
cmake: glob headers and surface solution docs
cnaples79 Oct 8, 2025
8fce2e7
cmake: avoid VS solution items property
cnaples79 Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,49 @@ target_compile_features(GSL INTERFACE "cxx_std_14")
# Setup include directory
add_subdirectory(include)

target_sources(GSL INTERFACE $<BUILD_INTERFACE:${GSL_SOURCE_DIR}/GSL.natvis>)
file(GLOB GSL_HEADER_FILES
RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}/include"
"${CMAKE_CURRENT_SOURCE_DIR}/include/gsl/*"
)

# Build/install interface lists ensure CMake is happy when exporting headers via
# INTERFACE sources. Absolute paths would be rejected starting with CMake 4.1.2.
set(GSL_HEADER_INTERFACE_SOURCES)
foreach(header ${GSL_HEADER_FILES})
list(APPEND GSL_HEADER_INTERFACE_SOURCES
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/${header}>
$<INSTALL_INTERFACE:include/${header}>
)
endforeach()

target_sources(GSL INTERFACE
${GSL_HEADER_INTERFACE_SOURCES}
Copy link
Member

@carsonRadtke carsonRadtke Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: According to https://github.com/microsoft/GSL/pull/1112/files#r1190452831 this only affects VS solutions. Let's move it into your new if (CMAKE_GENERATOR MATCHES "Visual Studio") block and combine it with the other target_sources (which doesn't yet exist; see my comment about VS_SOLUTION_ITEMS).

$<BUILD_INTERFACE:${GSL_SOURCE_DIR}/GSL.natvis>
)

if (CMAKE_GENERATOR MATCHES "Visual Studio")
file(GLOB GSL_WORKSPACE_FILES "${CMAKE_CURRENT_SOURCE_DIR}/include/gsl/*")
list(APPEND GSL_WORKSPACE_FILES
${GSL_SOURCE_DIR}/.clang-format
${GSL_SOURCE_DIR}/.gitattributes
${GSL_SOURCE_DIR}/.gitignore
${GSL_SOURCE_DIR}/CMakeSettings.json
${GSL_SOURCE_DIR}/CONTRIBUTING.md
${GSL_SOURCE_DIR}/LICENSE
${GSL_SOURCE_DIR}/README.md
${GSL_SOURCE_DIR}/SECURITY.md
${GSL_SOURCE_DIR}/ThirdPartyNotices.txt
)

target_sources(GSL PRIVATE ${GSL_WORKSPACE_FILES})

set(GSL_HEADER_ABSOLUTE_PATHS)
foreach(header ${GSL_HEADER_FILES})
list(APPEND GSL_HEADER_ABSOLUTE_PATHS ${GSL_SOURCE_DIR}/include/${header})
endforeach()
source_group(TREE ${GSL_SOURCE_DIR}/include PREFIX "Header Files" FILES ${GSL_HEADER_ABSOLUTE_PATHS})
source_group("Solution Items" FILES ${GSL_WORKSPACE_FILES})
endif()

if (GSL_TEST)
enable_testing()
Expand Down