CMake项目中自动生成代码的依赖配置方案咨询

问题场景与核心痛点 #

我有一个CMake构建的项目，包含复杂二进制目标X，该目标需编译大量.c文件并引入众多.h文件。希望在构建X前添加自动生成代码的流程Y，要求仅当相关文件变更时才运行Y，避免每次构建都执行耗时的生成操作。当前遇到两个核心问题：

1. 循环依赖：X依赖Y的生成结果，而Y需要依赖X的所有源文件（而非构建产物），形成循环依赖。
2. Glob缺陷：尝试用file(GLOB)关联所有.c和.h文件作为Y的依赖，但新增.h文件时无需重新运行CMake，导致构建系统遗漏依赖，生成过期的自动代码。

可行解决方案 #

1. 用虚拟目标拆解循环依赖 #

打破循环的关键是通过中间虚拟目标传递依赖，避免X和Y直接互斥依赖：

# 显式列出X的所有源文件（不推荐用glob，后续解释）
set(X_SOURCES
    src/file1.c
    src/file2.c
    include/header1.h
    include/header2.h
    # ... 其余源文件
)

# 创建虚拟目标，仅用于承载X的源文件依赖
add_custom_target(Y_deps SOURCES ${X_SOURCES})

# 定义自动生成流程Y
add_custom_command(
    OUTPUT ${GENERATED_FILES}  # 指定Y生成的所有文件
    COMMAND ${Y_GENERATOR_CMD}  # 执行Y的命令（比如脚本、工具）
    DEPENDS Y_deps  # 间接依赖X的所有源文件
    COMMENT "Running code generator Y..."
)

# 创建Y的目标，关联生成文件
add_custom_target(Y DEPENDS ${GENERATED_FILES})

# 定义目标X，依赖Y的生成结果
add_executable(X ${X_SOURCES} ${GENERATED_FILES})
add_dependencies(X Y)

2. 显式声明源文件替代Glob #

Glob的本质缺陷是CMake首次配置后不会自动扫描新增文件，因此最佳实践是显式列出所有源文件：

• 新增文件时只需修改CMakeLists.txt，触发CMake重新配置，确保依赖关系准确。
• 若需简化文件管理，可结合configure_file生成源文件列表：

  # 维护一个sources.txt.in模板，手动新增文件时更新此处
  configure_file(sources.txt.in sources.txt @ONLY)
  
  # 从生成的sources.txt读取源文件列表
  file(READ ${CMAKE_CURRENT_BINARY_DIR}/sources.txt X_SOURCES)
  string(REPLACE "\n" " " X_SOURCES "${X_SOURCES}")
  

3. 利用DEPFILE自动追踪依赖（推荐） #

如果你的代码生成器Y支持输出Makefile风格的.d依赖文件，可通过CMake的DEPFILE参数自动追踪生成文件的依赖：

add_custom_command(
    OUTPUT ${GENERATED_FILES}
    COMMAND ${Y_GENERATOR_CMD} --depfile ${GENERATED_DEP_FILE}
    DEPENDS ${X_SOURCES}
    DEPFILE ${GENERATED_DEP_FILE}  # 让CMake读取生成的依赖文件
    COMMENT "Running code generator Y with dependency tracking..."
)

这种方式无需手动维护所有依赖，即使新增了被生成文件引用的头文件，构建系统也能自动检测并重新运行Y。

4. 临时方案：强制CMake重新扫描文件 #

如果必须使用Glob，可添加自定义命令触发CMake重新配置（不推荐，会降低构建效率）：

file(GLOB_RECURSE HEADER_FILES include/*.h)
add_custom_target(
    force_cmake_reconfig
    COMMAND ${CMAKE_COMMAND} ${CMAKE_SOURCE_DIR}
    DEPENDS ${HEADER_FILES}
)
add_dependencies(Y force_cmake_reconfig)

内容的提问来源于stack exchange，提问作者shaharhoch