CMake中add_custom_command指定配置依赖目录OUTPUT的问题

问题根源解析 #

1. 生成表达式解析时机差异：

   • add_custom_command的OUTPUT参数在CMake配置阶段（运行cmake命令时）解析，此时CMake还未完成目标的构建路径计算。
   • COMMAND参数中的生成表达式则在生成阶段（执行make/ninja或IDE构建时）解析，此时目标的输出目录信息已确定。
     这就是$<TARGET_FILE_DIR:test_generator_gen>在COMMAND中能正常工作，但在OUTPUT里会报错“找不到目标”的核心原因。

2. CMAKE_CURRENT_BINARY_DIR导致重复生成：
   在VS、Xcode这类多配置生成器中，CMAKE_CURRENT_BINARY_DIR是所有配置共享的顶层二进制目录。直接用该路径作为生成文件输出，不同配置（Debug/Release等）会往同一文件写入，CMake会判定文件每次都被修改，从而重复触发生成逻辑。

正确的OUTPUT路径指定方式 #

方法1：用$<CONFIG>构造配置专属路径 #

利用CMake的配置生成表达式$<CONFIG>，为每个配置生成独立的输出子目录，完全匹配你期望的目录结构：

# 为每个配置生成专属的输出路径
set(GENERATED_FILES "${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/test_generator_slots.hpp")

add_custom_command(
    OUTPUT ${GENERATED_FILES}
    # 命令中同步使用$<CONFIG>，确保生成器写入正确位置
    COMMAND your_generator_tool --output "$<CONFIG>/test_generator_slots.hpp"
    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
    MAIN_DEPENDENCY your_input_template.in
    COMMENT "Generating test_generator_slots.hpp for $<CONFIG>"
)

这种方式会自动为Debug、Release等配置生成对应的子目录（比如./builds/headers-only/tests/Debug/），避免文件冲突和重复生成。

方法2：兼容单/多配置生成器的写法 #

如果需要兼容Makefile这类单配置生成器，可以结合CMAKE_BUILD_TYPE和$<CONFIG>做兼容处理：

# 单配置生成器用CMAKE_BUILD_TYPE，多配置用$<CONFIG>
if(CMAKE_CONFIGURATION_TYPES)
    set(CONFIG_DIR "$<CONFIG>")
else()
    set(CONFIG_DIR "${CMAKE_BUILD_TYPE}")
endif()

set(GENERATED_FILES "${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_DIR}/test_generator_slots.hpp")

add_custom_command(
    OUTPUT ${GENERATED_FILES}
    COMMAND your_generator_tool --output "${CONFIG_DIR}/test_generator_slots.hpp"
    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
    MAIN_DEPENDENCY your_input_template.in
)

额外注意事项 #

• 确保生成文件被正确关联到目标：如果生成的文件是某个目标的依赖，需要用add_custom_target或直接在add_executable/add_library中包含${GENERATED_FILES}，让CMake能正确追踪依赖关系。
• 避免在OUTPUT中使用目标相关的生成表达式（如$<TARGET_FILE_DIR>），这类表达式仅适用于生成阶段解析的参数（如COMMAND、COMMENT等）。

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