如何在CMake构建阶段检查头文件是否已生成并按需生成？

要解决配置阶段判断滞后的问题，核心是把头文件有效性检查和生成逻辑放到构建阶段执行，可以通过add_custom_command结合shell/批处理命令实现，以下是具体方案：

1. 先编译生成工具generate_header #

确保生成头文件的可执行文件先被编译，避免找不到命令的问题：

add_executable(generate_header generate_header.cpp)

2. 构建阶段实时检查并生成头文件 #

适用于Linux/macOS（Bash环境） #

# 定义目标头文件路径
set(HEADER_PATH ${CMAKE_CURRENT_SOURCE_DIR}/generated_header.h)

# 自定义命令：仅当头文件不存在或不含指定宏时生成
add_custom_command(
    OUTPUT ${HEADER_PATH}
    COMMAND bash -c "if [ ! -f ${HEADER_PATH} ] || ! grep -q 'HEADER_GENERATED' ${HEADER_PATH}; then $<TARGET_FILE:generate_header>; fi"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    COMMENT "Checking and generating header if needed"
    VERBATIM
)

# 将生成的头文件关联到主目标
add_executable(main_target main.cpp)
add_dependencies(main_target ${HEADER_PATH})

适用于Windows（Cmd环境） #

把Shell命令替换为批处理逻辑：

set(HEADER_PATH ${CMAKE_CURRENT_SOURCE_DIR}/generated_header.h)

add_custom_command(
    OUTPUT ${HEADER_PATH}
    COMMAND cmd /c "if not exist ${HEADER_PATH} findstr /c:\"HEADER_GENERATED\" ${HEADER_PATH} >nul 2>&1 || $<TARGET_FILE:generate_header>"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    COMMENT "Checking and generating header if needed"
    VERBATIM
)

add_executable(main_target main.cpp)
add_dependencies(main_target ${HEADER_PATH})

方案说明 #

• add_custom_command的OUTPUT参数会让CMake跟踪目标头文件的状态，只有当文件需要更新（不存在或不符合检查条件）时，才执行后续命令
• 用构建阶段的shell/批处理命令实时检查：既判断文件是否存在，也验证文件内是否包含HEADER_GENERATED宏，确保头文件有效才跳过生成
• $<TARGET_FILE:generate_header>是CMake的生成器表达式，会自动替换为generate_header可执行文件的绝对路径，避免路径依赖问题

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