cmake add_custom_command详解

在 CMake 中，add_custom_command 命令用于向构建过程添加自定义的命令。这些自定义命令可以用来生成文件、复制文件、执行脚本或其他任何必要的构建步骤。通常情况下，add_custom_command 用于描述某个文件或目标的生成过程。

基本语法

add_custom_command(OUTPUT output1 [output2 ...]
                   COMMAND command1 [args1...]
                   [COMMAND command2 [args2...] ...]
                   [DEPENDS depend1 [depend2 ...]]
                   [WORKING_DIRECTORY dir]
                   [COMMENT comment]
                   [VERBATIM]
                   [USES_TERMINAL]
)

• OUTPUT output1 [output2 …]: 指定自定义命令生成的输出文件或目标。这些文件或目标会成为其他目标的依赖项。
• COMMAND command1 [args1…]: 执行的命令及其参数。
• DEPENDS depend1 [depend2 …]: 指定自定义命令的依赖项，可以是文件或其他目标。
• WORKING_DIRECTORY dir: 指定命令执行的工作目录。
• COMMENT comment: 添加注释，描述自定义命令的作用。
• VERBATIM: 将命令及其参数原样传递给 shell 执行。
• USES_TERMINAL: 指定是否在终端中运行命令。

示例

以下是几个使用 add_custom_command 命令的示例：

1. 生成文件

cmake_minimum_required(VERSION 3.10)
project(CustomCommandExample)

# 添加自定义命令来生成文件
add_custom_command(OUTPUT generated_file.txt
    COMMAND echo "Generating file..." > generated_file.txt
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    COMMENT "Generating a new file"
)

# 添加生成文件的自定义命令到构建过程中
add_custom_target(generate_file_target DEPENDS generated_file.txt)

# 将生成文件的目标添加到构建过程中

在这个示例中，我们使用 add_custom_command 命令创建了一个自定义命令，该命令生成了一个名为 generated_file.txt 的文件。我们还创建了一个自定义目标 generate_file_target，它依赖于 generated_file.txt 文件，这样可以确保在需要生成文件时执行自定义命令。

2. 复制文件

cmake_minimum_required(VERSION 3.10)
project(CopyCommandExample)

# 添加自定义命令来复制文件
add_custom_command(OUTPUT copied_file.txt
    COMMAND ${CMAKE_COMMAND} -E copy_if_different original_file.txt copied_file.txt
    DEPENDS original_file.txt
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    COMMENT "Copying file"
)

# 添加复制文件的自定义命令到构建过程中
add_custom_target(copy_file_target DEPENDS copied_file.txt)

# 将复制文件的目标添加到构建过程中

在这个示例中，我们使用 add_custom_command 命令创建了一个自定义命令，该命令复制 original_file.txt 文件并生成 copied_file.txt。我们通过 DEPENDS 参数指定了复制命令的依赖项，确保在 original_file.txt 发生变化时重新执行命令。

3. 执行脚本

cmake_minimum_required(VERSION 3.10)
project(ScriptCommandExample)

# 添加自定义命令来执行脚本
add_custom_command(OUTPUT output.log
    COMMAND ${CMAKE_COMMAND} -P my_script.cmake
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    COMMENT "Running script"
)

# 添加执行脚本的自定义命令到构建过程中
add_custom_target(run_script_target DEPENDS output.log)

# 将执行脚本的目标添加到构建过程中

在这个示例中，我们使用 add_custom_command 命令创建了一个自定义命令，该命令执行了一个名为 my_script.cmake 的 CMake 脚本，并将输出写入 output.log 文件。我们创建了一个自定义目标 run_script_target，它依赖于 output.log 文件，以确保在需要执行脚本时执行自定义命令。

注意事项

• 输出文件: 使用 OUTPUT 参数指定自定义命令生成的输出文件或目标，这些文件或目标会成为其他目标的依赖项。
• 依赖关系: 使用 DEPENDS 参数可以确保在指定依赖项发生变化时，自定义命令会重新执行。
• 工作目录: 使用 WORKING_DIRECTORY 参数可以指定命令执行的工作目录，这在执行命令时特别有用。
• 终端执行: 使用 USES_TERMINAL 参数可以指定是否在终端中运行命令，这在需要交互式命令时可能会用到。

结论
add_custom_command 命令是 CMake 中用于添加自定义命令到构建过程的重要命令，通过它可以扩展和定制项目的构建流程，执行各种必要的任务，如文件生成、复制、脚本执行等。合理使用 add_custom_command 可以提高项目的灵活性和自动化程度。