如何在CMake构建阶段添加步骤？解决Perl脚本Shebang替换需求

要解决configure_file()替换Perl数组符号@的问题，同时实现构建阶段自动更新变更的脚本，最优方案是用CMake自定义命令+目标，既避开configure_file的替换逻辑，又能让构建系统自动追踪文件变化。

标准化实现（跨平台兼容） #

步骤1：编写Shebang替换脚本 #

在项目根目录创建replace_shebang.cmake脚本，专门处理Shebang替换，避免依赖系统命令：

# replace_shebang.cmake
set(SRC_FILE ${ARGV0})
set(DST_FILE ${ARGV1})
set(PERL_PATH ${ARGV2})

# 读取源脚本内容
file(READ ${SRC_FILE} CONTENT)

# 替换现有Shebang（如果存在），无则在开头添加
string(REGEX REPLACE "^#!.*perl.*\n" "#!${PERL_PATH}\n" NEW_CONTENT "${CONTENT}")
if(NEW_CONTENT STREQUAL CONTENT)
  set(NEW_CONTENT "#!${PERL_PATH}\n${CONTENT}")
endif()

# 写入处理后的脚本
file(WRITE ${DST_FILE} "${NEW_CONTENT}")

步骤2：主CMakeLists.txt配置 #

在主构建脚本中，自动识别Perl路径，批量处理所有目标脚本：

# 查找系统Perl路径
find_program(PERL_EXECUTABLE perl REQUIRED)

# 定义需要处理的Perl脚本列表
set(PERL_SCRIPTS
  scripts/user_script.pl
  scripts/admin_tool.pl
  # 添加更多脚本...
)

set(PROCESSED_SCRIPTS)
foreach(SCRIPT ${PERL_SCRIPTS})
  get_filename_component(SCRIPT_NAME ${SCRIPT} NAME)
  # 构建输出路径（可根据需求调整）
  set(DST_SCRIPT ${CMAKE_BINARY_DIR}/bin/${SCRIPT_NAME})
  list(APPEND PROCESSED_SCRIPTS ${DST_SCRIPT})

  # 添加自定义命令：仅当源脚本或替换脚本变更时执行
  add_custom_command(
    OUTPUT ${DST_SCRIPT}
    COMMAND ${CMAKE_COMMAND} -P ${CMAKE_SOURCE_DIR}/replace_shebang.cmake ${CMAKE_SOURCE_DIR}/${SCRIPT} ${DST_SCRIPT} ${PERL_EXECUTABLE}
    DEPENDS ${CMAKE_SOURCE_DIR}/${SCRIPT} ${CMAKE_SOURCE_DIR}/replace_shebang.cmake
    COMMENT "Processing Perl script: ${SCRIPT}"
  )
endforeach()

# 创建自定义目标，确保构建时自动处理所有脚本
add_custom_target(perl_scripts ALL DEPENDS ${PROCESSED_SCRIPTS})

# 可选：将处理后的脚本安装到系统目录
install(FILES ${PROCESSED_SCRIPTS} 
        DESTINATION ${CMAKE_INSTALL_BINDIR}
        PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)

临时简化方案（依赖系统命令） #

如果不想编写额外CMake脚本，可直接用系统cat/tail命令替换Shebang，适合Linux/macOS环境：

find_program(PERL_EXECUTABLE perl REQUIRED)

set(PERL_SCRIPTS scripts/script1.pl scripts/script2.pl)
set(PROCESSED_SCRIPTS)

foreach(SCRIPT ${PERL_SCRIPTS})
  get_filename_component(SCRIPT_NAME ${SCRIPT} NAME)
  set(DST_SCRIPT ${CMAKE_BINARY_DIR}/bin/${SCRIPT_NAME})
  list(APPEND PROCESSED_SCRIPTS ${DST_SCRIPT})

  # 先复制原文件（COPYONLY模式不替换@）
  configure_file(${SCRIPT} ${DST_SCRIPT} COPYONLY)

  # 替换Shebang：保留原脚本除第一行外的内容，在开头插入新Shebang
  add_custom_command(
    OUTPUT ${DST_SCRIPT}.updated
    COMMAND echo "#!${PERL_EXECUTABLE}" | cat - ${DST_SCRIPT} | tail -n +2 > ${DST_SCRIPT}.updated && mv ${DST_SCRIPT}.updated ${DST_SCRIPT}
    DEPENDS ${SCRIPT}
    COMMENT "Updating shebang for ${SCRIPT}"
  )
endforeach()

add_custom_target(perl_scripts ALL DEPENDS ${PROCESSED_SCRIPTS})

方案优势 #

• 构建阶段自动触发：无需重新运行cmake -B，执行cmake --build时自动检测脚本变更并更新。
• 增量处理：仅当源脚本或替换逻辑变更时，才重新生成对应文件，避免全量处理。
• 环境适配：自动获取系统Perl路径，无需硬编码Shebang。

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