build: use file set feature to declare headers

Author: b1ackviking

.github/workflows/ci.yml

@@ -100,7 +100,7 @@ jobs:
           -D ENABLE_FORTIFY_SOURCE:BOOL=${{ matrix.build.type != 'Debug' }}
 
       - name: Build
-        run: uv run cmake --build --preset ${{ matrix.build.preset }}
+        run: uv run cmake --build --preset ${{ matrix.build.preset }} --target all all_verify_interface_header_sets
 
       - name: Run tests
         run: uv run ctest --preset ${{ matrix.build.preset }}
@@ -188,7 +188,7 @@ jobs:
           -D ENABLE_FORTIFY_SOURCE:BOOL=${{ matrix.build.type != 'Debug' }}
 
       - name: Build
-        run: uv run cmake --build --preset ${{ matrix.build.preset }}
+        run: uv run cmake --build --preset ${{ matrix.build.preset }} --target all all_verify_interface_header_sets
 
       - name: Run tests
         run: uv run ctest --preset ${{ matrix.build.preset }}
@@ -273,7 +273,7 @@ jobs:
       - name: Build
         run: >
           build/${{ matrix.build.Type }}/generators/conanbuild.ps1 &&
-          uv run cmake --build --preset ${{ matrix.build.preset }}
+          uv run cmake --build --preset ${{ matrix.build.preset }} --target all all_verify_interface_header_sets
 
       - name: Run tests
         if: matrix.build.type != 'Debug'
@@ -346,7 +346,7 @@ jobs:
         run: uv run cmake --preset ${{ matrix.build.preset }}
 
       - name: Build
-        run: uv run cmake --build --preset ${{ matrix.build.preset }}
+        run: uv run cmake --build --preset ${{ matrix.build.preset }} --target all all_verify_interface_header_sets
 
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@v4

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 4.1 FATAL_ERROR)
+cmake_minimum_required(VERSION 4.2 FATAL_ERROR)
 
 project(
   cpp-project-template

README.md

@@ -80,6 +80,9 @@ cmake --preset <preset> \
 # build
 cmake --build --preset <preset>
 
+# to make sure your library headers are self-contained
+cmake --build --preset <preset> --target all_verify_interface_header_sets
+
 # run tests
 ctest --preset <preset>
 
@@ -121,6 +124,9 @@ cmake --preset <preset> \
 # build
 cmake --build --preset <preset>
 
+# to make sure your library headers are self-contained
+cmake --build --preset <preset> --target all_verify_interface_header_sets
+
 # run tests and collect test coverage (Windows)
 OpenCppCoverage.exe --export_type cobertura:coverage.xml --cover_children -- ctest --preset <preset>
 ```

cmake/defaults.cmake

@@ -16,18 +16,20 @@ endif()
 option(ENABLE_HARDENINGS "Enable hardenings" OFF)
 
 # Useful CMake defaults
+set(CMAKE_ERROR_DEPRECATED ON)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set(CMAKE_FIND_PACKAGE_PREFER_CONFIG ON)
 set(CMAKE_COMPILE_WARNING_AS_ERROR ON)
 set(CMAKE_C_EXTENSIONS OFF)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_SCAN_FOR_MODULES ON)
+set(CMAKE_VERIFY_INTERFACE_HEADER_SETS ON)
+# TODO: set(CMAKE_VERIFY_PRIVATE_HEADER_SETS ON) with cmake 4.3
 set(CMAKE_LINK_WHAT_YOU_USE TRUE)
 set(CMAKE_VS_JUST_MY_CODE_DEBUGGING ON)
 set(CMAKE_COLOR_DIAGNOSTICS ON)
 set(CMAKE_GTEST_DISCOVER_TESTS_DISCOVERY_MODE PRE_TEST)
-set(CMAKE_CTEST_ARGUMENTS --progress --output-on-failure)
-list(APPEND CMAKE_CTEST_ARGUMENTS --parallel)
+set(CMAKE_CTEST_ARGUMENTS --progress --output-on-failure --parallel)
 
 # Set a default build type if none was specified
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
@@ -65,6 +67,7 @@ if(ENABLE_CPPCHECK)
         ${CPPCHECK}
         -v
         --enable=all
+        --disable=unusedFunction
         --inline-suppr
         --error-exitcode=42
         --checkers-report=${CMAKE_BINARY_DIR}/cppcheck.report

lib/math/CMakeLists.txt

@@ -1,4 +1,5 @@
 project(math)
 
 add_library(${PROJECT_NAME} INTERFACE)
-target_include_directories(${PROJECT_NAME} INTERFACE include)
+target_sources(${PROJECT_NAME} INTERFACE FILE_SET HEADERS BASE_DIRS include
+                                         FILES include/math/math.hpp)