CMake中的add_custom_command和add_custom_target指令详解

在CMake构建系统中，add_custom_command和add_custom_target是两个强大的指令，它们允许我们添加自定义的构建规则。这两个指令在复杂的项目中特别有用，因为它们允许我们执行一些标准的构建步骤之外的操作。

add_custom_command

add_custom_command指令用于为生成的目标文件添加自定义构建规则。它通常用于在构建过程中生成源代码、头文件或其他文件。这个指令的基本语法如下：

add_custom_command(
    OUTPUT output1 [output2 ...]
    COMMAND command1 [ARGS] [command2 [ARGS] ...]
    [MAIN_DEPENDENCY source1 [source2 ...]]
    [DEPENDS [depend1 ...]]
    [IMPLICIT_DEPENDS lang1 [NAMES] dep1 ...]
    [VERBATIM]
    [WORKING_DIRECTORY dir]
    [COMMENT comment]
    [PREBUILDS | POSTBUILDS]
    [BYPRODUCTS output1 [output2 ...]]
)

• OUTPUT：指定由命令生成的文件。这些文件将成为后续构建步骤的依赖项。
• COMMAND：要执行的命令。这可以是任何可以在命令行中运行的命令。
• MAIN_DEPENDENCY：可选参数，指定主要依赖项。这通常是一个源文件，当该文件更改时，将重新运行命令。
• DEPENDS：其他依赖项列表。当这些文件更改时，也将重新运行命令。
• IMPLICIT_DEPENDS：隐式依赖项。这允许你指定命令对哪些文件有隐式依赖。
• VERBATIM：如果设置，命令将不会通过CMake的命令行解释器，而是直接传递给构建系统。
• WORKING_DIRECTORY：指定命令的工作目录。
• COMMENT：为构建系统提供的注释，通常用于描述命令的目的。
• PREBUILDS或POSTBUILDS：指定命令是在目标构建之前还是之后运行。
• BYPRODUCTS：指定命令生成的副产品文件。这些文件不会触发重新构建，但如果它们不存在，构建将被视为失败。

add_custom_target

add_custom_target指令用于添加不生成输出文件的自定义目标。这通常用于执行一些不需要生成文件的任务，如运行测试、清理工作区等。它的基本语法如下：

add_custom_target(target_name
    [ALL]
    [DEPENDS dep1 ...]
    [WORKING_DIRECTORY dir]
    [COMMAND command1 [ARGS] [command2 [ARGS] ...]]
    [VERBATIM]
    [SOURCES src1 [src2 ...]]
    [IMPLICIT_DEPENDS lang1 [NAMES] dep1 ...]
    [BYPRODUCTS output1 [output2 ...]]
)

• target_name：自定义目标的名称。
• ALL：可选参数，如果设置，该目标将被添加到默认构建目标中，即执行make或cmake --build时会自动构建。
• DEPENDS：其他依赖项列表。当这些目标或文件更改时，该目标将被重新构建。
• WORKING_DIRECTORY、COMMAND、VERBATIM、IMPLICIT_DEPENDS和BYPRODUCTS的参数与add_custom_command中的相同。

实际应用

在实际项目中，add_custom_command和add_custom_target可以非常有用。例如，你可能需要：

• 使用add_custom_command生成由源代码生成的头文件，如使用protobuf工具生成C++头文件。
• 使用add_custom_target运行测试套件，确保代码质量。
• 使用add_custom_target清理构建过程中生成的文件，以保持工作区的整洁。

通过合理使用这两个指令，你可以极大地扩展CMake的构建能力，使其适应各种复杂的构建需求。