CMake构建时添加额外目录并触发目标重配置的问题

问题背景 #

现有CMake项目通过Python脚本在构建阶段生成源文件，此前已实现源文件变更触发目标重配置。现在需要扩展功能，让脚本同时生成包含目录，但遇到以下问题：

• 首次构建时，CMake无法识别生成的generatedIncludeDirs变量，导致头文件查找失败
• 手动二次调用cmake或make后编译正常
• 尝试过多种方法（如单独生成CMake文件、设置OBJECT_DEPENDS、错误使用CMAKE_CONFIGURE_DEPENDS等）均无效

核心问题分析 #

CMake的配置阶段与构建阶段是分离的：首次配置时Generated.cmake尚未生成，因此generatedIncludeDirs变量未定义；而构建阶段生成文件后，CMake不会自动触发重配置，除非明确告知需要监控该文件。

正确实现步骤 #

1. 调整自定义命令，直接输出Generated.cmake #

将自定义命令的输出改为Generated.cmake，让CMake直接追踪该文件的生成与变更，无需额外的timestamp文件：

add_custom_command(
    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Generated.cmake
    COMMAND ${CMAKE_COMMAND} -E env PYTHONPATH=${CMAKE_SOURCE_DIR}/python ${PYTHON_EXECUTABLE} ${generatorFile} ${ARG_GENERATOR_ARGUMENTS}
    DEPENDS ${generatorFile}
    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
    COMMENT "Generate source code and include dirs from ${generatorFile}"
)

2. 全局配置依赖，触发重配置 #

将Generated.cmake加入全局的CMAKE_CONFIGURE_DEPENDS列表，让CMake在每次构建前检查该文件是否变更，若变更则自动重新配置：

# 将生成的CMake文件加入配置依赖，变更时触发重配置
list(APPEND CMAKE_CONFIGURE_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Generated.cmake)

3. 条件式包含生成的CMake文件 #

首次配置时Generated.cmake不存在，需通过条件判断避免报错，构建阶段生成文件后重配置时再加载变量：

# 仅当文件存在时才加载，首次配置跳过，重配置时读取变量
if(EXISTS ${CMAKE_CURRENT_BINARY_DIR}/Generated.cmake)
    include(${CMAKE_CURRENT_BINARY_DIR}/Generated.cmake)
endif()

4. 安全设置目标的源文件与包含目录 #

基于加载的变量配置目标，添加源文件并设置包含目录，同时处理变量未定义的情况：

# 添加源文件（generatedFiles已在Generated.cmake中标记为GENERATED）
target_sources(${ARG_NAME} PRIVATE 
    ${nonGeneratedFiles}
    ${generatedFiles}   
    ${ARG_FILES} 
    ${cppFiles}
    ${generatorFile}
)

# 仅当变量存在时设置包含目录，避免首次配置报错
if(DEFINED generatedIncludeDirs)
    target_include_directories(${ARG_NAME} PRIVATE ${generatedIncludeDirs})
endif()

5. 调整Python脚本，直接生成完整的Generated.cmake #

去掉脚本中用execute_process创建空文件的步骤，直接写入包含变量定义的完整内容：

# Python脚本示例：直接生成CMake变量定义
import os

binary_dir = os.environ.get("CMAKE_CURRENT_BINARY_DIR")
generated_files_list = "..."  # 替换为实际生成的源文件列表
non_generated_files_list = "..."  # 替换为实际的非生成源文件列表
include_dirs_list = "..."  # 替换为实际生成的包含目录列表

with open(os.path.join(binary_dir, "Generated.cmake"), "w") as f:
    f.write(f"set(generatedFiles {generated_files_list})\n")
    f.write(f"set(nonGeneratedFiles {non_generated_files_list})\n")
    f.write(f"set(generatedIncludeDirs {include_dirs_list})\n")
    f.write(f"set_source_files_properties(${{generatedFiles}} PROPERTIES GENERATED 1)\n")

此前方法失败的原因 #

• 将Generated.cmake加入target_sources：源文件依赖属于构建阶段逻辑，无法触发配置阶段的重配置
• 错误使用CMAKE_CONFIGURE_DEPENDS：该属性是全局属性，不能通过set_target_properties设置到目标上
• 未条件式包含生成文件：首次配置时文件不存在，直接include会导致变量未定义或报错

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