使用add_custom_command复制头文件失效问题排查求助

你的头文件复制失败主要有几个关键问题，我来一步步帮你解决：

1. 核心问题：add_custom_command 未被触发执行 #

你当前的 add_custom_command 存在两个致命问题：

• OUTPUT 参数错误：你把输出设为 ${headerfile}（源文件路径），CMake 会认为这个文件已经存在，完全不会触发复制命令。
• 未关联到构建目标：自定义命令需要被某个目标（比如你的 common 库）依赖，否则CMake 没有理由去执行它。

2. 次要问题：INCLUDE_LIST 可能未正确传递 #

从你的代码看，common/CMakeLists.txt 使用了 ${INCLUDE_LIST}，但没看到 Headers/CMakeLists.txt 里如何定义并传递这个变量——如果这个变量是空的，循环根本不会执行。

完整修复步骤 #

第一步：修复 common/Headers/CMakeLists.txt #

确保正确收集头文件并传递到父目录：

# 收集Headers目录下所有.h文件
file(GLOB_RECURSE INCLUDE_LIST "${CMAKE_CURRENT_SOURCE_DIR}/*.h")
# 将变量传递给父级CMakeLists.txt
set(INCLUDE_LIST ${INCLUDE_LIST} PARENT_SCOPE)

第二步：重写 cmake/CopyHeaderFiles.cmake #

修正命令逻辑，确保复制命令被触发：

# 先确保目标目录存在，避免复制失败
file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/includes)

# 存储所有复制后的目标文件路径
set(COPIED_HEADERS "")

foreach(headerfile ${INCLUDE_LIST})
    # 提取头文件的文件名（去掉源路径）
    get_filename_component(header_filename ${headerfile} NAME)
    # 定义目标文件的完整路径
    set(target_path "${PROJECT_BINARY_DIR}/includes/${header_filename}")

    add_custom_command(
        OUTPUT ${target_path}
        # 复制源文件到目标路径
        COMMAND ${CMAKE_COMMAND} -E copy "${headerfile}" "${target_path}"
        # 当源文件更新时，重新执行复制
        DEPENDS ${headerfile}
        # 显示复制提示信息，方便调试
        COMMENT "Copying ${header_filename} to ${PROJECT_BINARY_DIR}/includes"
    )

    # 将目标文件加入列表，后续用于关联目标
    list(APPEND COPIED_HEADERS ${target_path})
endforeach()

# 创建一个自定义目标，让CMake默认构建时执行复制操作
add_custom_target(copy_headers ALL DEPENDS ${COPIED_HEADERS})

第三步：修改 common/CMakeLists.txt，关联复制目标 #

让你的 common 库依赖复制目标，确保复制完成后再构建库：

cmake_minimum_required (VERSION 3.0)
set(MODULE_NAME common)

add_subdirectory(Headers)
add_subdirectory(Src)

include(${PROJECT_SOURCE_DIR}/cmake/CopyHeaderFiles.cmake)

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -lpthread")
include_directories("${CMAKE_SOURCE_DIR}/common/Headers" )

add_library(${MODULE_NAME} STATIC ${SRC_LIST} ${INCLUDE_LIST})
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

# 关键：让common库依赖copy_headers目标，确保复制先完成
add_dependencies(${MODULE_NAME} copy_headers)

额外说明 #

• 如果需要保留头文件的目录结构（比如 common/Headers/subdir/file.h 复制到 includes/subdir/file.h），可以用 file(RELATIVE_PATH) 替换 get_filename_component，示例：

  file(RELATIVE_PATH relative_path "${PROJECT_SOURCE_DIR}/common/Headers" "${headerfile}")
  set(target_path "${PROJECT_BINARY_DIR}/includes/${relative_path}")
  

• 避免用 GLOB 收集文件？其实对于头文件来说问题不大，但如果需要更严谨的方式，可以手动列出所有头文件，避免CMake遗漏新增文件。

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