CMake如何支持在源码内build目录下使用target_sources FILE_SET

问题背景 #

环境：CMake 3.31.6

• 外部构建（cmake -S . -B /tmp/build）可正常生成version.h并完成构建
• 在源码根目录下创建build子目录，执行cmake ..时构建失败，报错核心信息：

  文件集的基础目录不能互为子目录，且文件不在指定基础目录内

核心原因：当构建目录（CMAKE_CURRENT_BINARY_DIR）作为源码目录（CMAKE_CURRENT_SOURCE_DIR）的子目录时，target_sources的FILE_SET特性无法处理跨源码、二进制目录的文件集合——CMake对FILE_SET的基础目录有约束，不允许包含互为父子层级的目录，同时要求所有文件必须位于基础目录或其子目录下，生成的version.h处于二进制目录，触发了这个约束冲突。

解决方案 #

方案1：拆分FILE_SET，分别处理源码头文件与生成头文件 #

将源码目录下的头文件和二进制目录下的生成文件拆分为两个独立的FILE_SET，各自指定对应的基础目录，避免目录嵌套冲突：

add_executable(myapp)

# 生成version.h
configure_file(version.h.in ${CMAKE_CURRENT_BINARY_DIR}/version.h @ONLY)

# 处理源码目录下的头文件
target_sources(myapp
  PRIVATE
    src/main.cpp
  PUBLIC
    FILE_SET SOURCE_HEADERS
    BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/include
    FILES
      include/myapp.h
)

# 处理二进制目录下的生成头文件
target_sources(myapp
  PUBLIC
    FILE_SET GENERATED_HEADERS
    BASE_DIRS ${CMAKE_CURRENT_BINARY_DIR}
    FILES
      ${CMAKE_CURRENT_BINARY_DIR}/version.h
)

# 按需安装两个FILE_SET的头文件
install(TARGETS myapp
  FILE_SET SOURCE_HEADERS DESTINATION include
  FILE_SET GENERATED_HEADERS DESTINATION include
)

方案2：放弃FILE_SET处理生成头文件，改用包含路径+直接指定源文件 #

如果不需要严格使用FILE_SET特性，可直接将生成的头文件添加为目标源文件，同时通过target_include_directories让编译时能找到该文件：

add_executable(myapp)

# 生成version.h
configure_file(version.h.in ${CMAKE_CURRENT_BINARY_DIR}/version.h @ONLY)

# 添加源码、生成文件作为目标源文件
target_sources(myapp
  PRIVATE
    src/main.cpp
  PUBLIC
    include/myapp.h
    ${CMAKE_CURRENT_BINARY_DIR}/version.h
)

# 添加源码include目录和二进制目录到包含路径
target_include_directories(myapp
  PUBLIC
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
    $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
    $<INSTALL_INTERFACE:include>
)

# 按需安装头文件
install(FILES include/myapp.h ${CMAKE_CURRENT_BINARY_DIR}/version.h DESTINATION include)

原理说明 #

CMake的FILE_SET特性要求：

1. 所有指定的FILES必须位于BASE_DIRS中某个目录的子路径下
2. BASE_DIRS中的目录不能存在互为父子的嵌套关系

当构建目录是源码目录的子目录时，CMAKE_CURRENT_SOURCE_DIR（源码根）和CMAKE_CURRENT_BINARY_DIR（build子目录）是父子层级，将两者同时加入同一个FILE_SET的BASE_DIRS会触发约束检查失败。拆分FILE_SET或绕过FILE_SET处理生成文件，就能避开这个冲突。

内容的提问来源于stack exchange，提问作者Marcus Müller