1. CMake简介与基础知识
1.1 CMake的基本概念（CMake Basic Concepts）
CMake（Cross-Platform Make）是一个跨平台的、开源的构建系统，它被广泛应用于各种大小的项目中。CMake使用一种名为 CMakeLists.txt 的文件来描述构建过程，这种文件的语法相对简单，但功能强大，可以满足各种复杂的构建需求。
CMake的主要概念包括以下几个部分：
1.1.1 项目（Project）
在CMake中，一个项目（Project）通常对应一个软件产品或库。每个项目都有一个名字，这个名字在整个CMake构建过程中都是唯一的。一个项目可以包含多个子项目（Subproject），子项目可以独立构建，也可以作为父项目的一部分构建。
1.1.2 目标（Target）
目标（Target）是CMake构建过程中的一个基本单位，它可以是一个可执行文件、一个库，或者一个自定义的命令。每个目标都有一个名字，这个名字在同一个项目中必须是唯一的。目标之间可以存在依赖关系，CMake会自动处理这些依赖关系，确保目标按照正确的顺序构建。
1.1.3 命令（Command）
命令（Command）是CMake的基本操作单位，每个命令都有一个名字和一组参数。CMake提供了大量的内置命令，这些命令可以用来定义目标、设置变量、控制流程等。用户也可以定义自己的命令，这就是我们今天主要讨论的 add_custom_command。
1.1.4 变量（Variable）
变量（Variable）是CMake中的一个重要概念，它可以用来保存各种类型的值，包括字符串、数字、列表等。变量的值可以在构建过程中动态改变，这使得CMake的构建过程具有很高的灵活性。
以上就是CMake的一些基本概念，理解这些概念对于深入理解CMake的工作原理和使用方法非常重要。在接下来的章节中，我们将深入探讨 add_custom_command 命令，以及如何利用.
1.2 CMake的工作原理（How CMake Works）
CMake的工作过程可以分为两个主要阶段：配置阶段和生成阶段。
1.2.1 配置阶段（Configuration Phase）
在配置阶段，CMake首先会读取 CMakeLists.txt 文件，解析其中的命令和变量。这个过程中，CMake会检查系统环境，确定编译器、库和工具的位置，以及其他的构建参数。这些信息会被保存在一个名为 CMakeCache.txt 的文件中，以便在后续的构建过程中使用。
配置阶段的主要任务是确定构建的目标和依赖关系。CMake会根据 CMakeLists.txt 文件中的命令，创建一系列的目标。每个目标都有一组源文件和一组依赖目标。CMake会检查这些源文件和依赖目标，确定目标的构建顺序。
1.2.2 生成阶段（Generation Phase）
在生成阶段，CMake会根据配置阶段得到的信息，生成实际的构建文件。这些构建文件可以是Makefile，也可以是其他的构建系统的配置文件，如Ninja、Visual Studio的项目文件等。
生成阶段的主要任务是将目标和依赖关系转化为具体的构建规则。CMake会为每个目标生成一组构建规则，这些规则描述了如何从源文件和依赖目标构建出目标。这些构建规则会被写入到构建文件中，供后续的构建过程使用。
以上就是CMake的工作原理的基本概述。理解这个过程对于理解CMake的工作方式和如何使用CMake进行项目构建非常重要。在接下来的章节中，我们将深入探讨 add_custom_command 命令，以及如何利用这个命令在CMake的构建过程中添加自定义的操作。
2. add_custom_command命令详解
2.1 add_custom_command命令的基本语法
在深入探讨add_custom_command命令之前，我们首先需要理解其基本的语法结构。在CMake中，add_custom_command命令的基本语法如下：
add_custom_command( OUTPUT output1 [output2 ...] COMMAND command1 [ARGS] [args1...] [COMMAND command2 [ARGS] [args2...] ...] [MAIN_DEPENDENCY depend] [DEPENDS [depends...]] [BYPRODUCTS [files...]] [WORKING_DIRECTORY dir] [COMMENT comment] [VERBATIM] )
这个命令的主要作用是定义一条自定义的构建规则，这条规则可以在构建过程中执行一系列的命令。下面我们来详细解析这个命令的各个参数。
OUTPUT output1 [output2 ...]：这个参数用于指定自定义命令的输出文件。这些文件在构建过程中会被生成，如果这些文件不存在，那么CMake就会执行这条自定义命令。COMMAND command1 [ARGS] [args1...]：这个参数用于指定要执行的命令。你可以提供任何有效的命令，包括系统命令、脚本，或者其他的构建工具。ARGS关键字后面可以跟随一系列的参数，这些参数会被传递给命令。MAIN_DEPENDENCY depend：这个参数用于指定自定义命令的主要依赖。如果这个依赖的文件被修改，那么自定义命令就会被执行。DEPENDS [depends...]：这个参数用于指定自定义命令的其他依赖。如果这些依赖的文件被修改，那么自定义命令也会被执行。BYPRODUCTS [files...]：这个参数用于指定自定义命令的副产品。如果你指定了一个或多个文件作为副产品，那么这些文件将会被添加到构建系统的清理列表中。WORKING_DIRECTORY dir：这个参数用于指定自定义命令的工作目录。如果你没有指定这个参数，那么自定义命令将会在当前的源码目录中执行。COMMENT comment：这个参数用于指定一个注释，这个注释将会在执行自定义命令时被打印出来。VERBATIM：这个参数用于控制命令参数的处理方式。如果你指定了VERBATIM，那么命令参数将会被按照字面意义处理，而不会被解析为变量或表达式。
2.2 add_custom_command命令的主要选项详解（Detailed Explanation of Main Options in add_custom_command）
2.2.1 TARGET选项（TARGET Option）
在CMake中，add_custom_command命令的TARGET选项是一个非常重要的参数。它的主要作用是指定一个目标，自定义命令将会在构建这个目标时被执行。这个目标可以是任何CMake支持的目标类型，包括库（Library）、可执行文件（Executable）、测试（Test）等。
使用方法
TARGET选项的使用方法非常简单。在add_custom_command命令中，我们只需要在TARGET后面添加我们想要指定的目标名称即可。例如：
add_custom_command( TARGET my_target COMMAND echo "This is a custom command for my_target." )
在这个例子中，我们指定了my_target为目标，当我们构建my_target时，会执行echo "This is a custom command for my_target."这个命令。
注意事项
在使用TARGET选项时，有几点需要注意：
TARGET指定的目标必须是已经存在的目标。如果你试图指定一个不存在的目标，CMake会在配置阶段报错。TARGET选项只能用在add_custom_command命令中，不能用在add_custom_target命令中。这是因为add_custom_target命令是用来创建一个新的目标的，而add_custom_command命令是用来给已经存在的目标添加自定义命令的。TARGET选项指定的目标，必须是在add_custom_command命令之前定义的。如果你试图在add_custom_command命令之后定义目标，CMake会在配置阶段报错。
实际应用
在实际的项目中，TARGET选项常常被用来添加一些在构建过程中需要执行的额外命令。例如，我们可能需要在构建一个库之前，先生成一些需要的源代码；或者在构建一个可执行文件之后，复制一些资源文件到指定的目录。这些操作都可以通过TARGET选项和add_custom_command命令来实现。
总的来说，TARGET选项是add_custom_command命令中一个非常重要的选项，它让我们可以在构建过程中添加自定义的命令，从而使得构建过程更加灵活和可控。
2.2.2 PRE_BUILD、PRE_LINK 和 POST_BUILD选项（PRE_BUILD, PRE_LINK and POST_BUILD Options）
在CMake的add_custom_command命令中，PRE_BUILD、PRE_LINK和POST_BUILD是非常重要的选项，它们用于指定自定义命令在构建过程中的执行时机。理解这三个选项的含义和使用方法，对于我们精确控制构建过程具有重要意义。
PRE_BUILD（预构建）
PRE_BUILD选项表示在所有其他步骤之前执行自定义命令。这个选项非常适合用于执行一些预处理任务，例如清理上一次构建的残留文件，或者检查某些必要的条件是否满足。
例如，我们可以使用PRE_BUILD选项来确保在构建开始之前，输出目录是干净的：
add_custom_command( TARGET MyTarget PRE_BUILD COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_BINARY_DIR}/output COMMENT "Cleaning up the output directory before build" )
在这个例子中，我们使用了CMake的remove_directory命令来删除输出目录。这个命令会在每次构建MyTarget目标之前执行。
PRE_LINK（链接前）
PRE_LINK选项表示在链接步骤之前执行自定义命令。这个选项通常用于执行一些需要在编译完成但链接未开始之前的任务，例如生成或更新一些需要链接的库文件。
例如，我们可以使用PRE_LINK选项来生成一个静态库：
add_custom_command( TARGET MyTarget PRE_LINK COMMAND ${CMAKE_AR} rcs libMyLib.a ${MY_LIB_OBJECTS} DEPENDS ${MY_LIB_OBJECTS} COMMENT "Creating static library libMyLib.a" )
在这个例子中，我们使用了ar命令来创建一个静态库libMyLib.a。这个命令会在链接MyTarget目标之前执行。
POST_BUILD（构建后）
POST_BUILD选项表示在所有步骤之后执行自定义命令。这个选项通常用于执行一些后处理任务，例如复制生成的文件到指定的目录，或者执行一些测试和验证任务。
例如，我们可以使用POST_BUILD选项来复制生成的可执行文件到一个指定的目录：
add_custom_command( TARGET MyTarget POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:MyTarget> ${CMAKE_CURRENT_BINARY_DIR}/bin COMMENT "Copying the executable to the bin directory" )
在这个例子中，我们使用了CMake的
copy命令来复制生成的可执行文件到bin目录。这个命令会在构建MyTarget目标之后执行。
以下表格对比了PRE_BUILD、PRE_LINK和POST_BUILD这三个选项的主要差异：
| 选项 | 执行时机 | 常见用途 |
| PRE_BUILD（预构建） | 在所有其他步骤之前 | 执行预处理任务，如清理上一次构建的残留文件，检查某些必要的条件是否满足 |
| PRE_LINK（链接前） | 在链接步骤之前 | 执行需要在编译完成但链接未开始之前的任务，如生成或更新一些需要链接的库文件 |
| POST_BUILD（构建后） | 在所有步骤之后 | 执行后处理任务，如复制生成的文件到指定的目录，执行一些测试和验证任务 |
总的来说，PRE_BUILD、PRE_LINK和POST_BUILD这三个选项为我们提供了在不同阶段插入自定义命令的能力，使我们能够更灵活地控制构建过程。在实际使用中，我们应根据实际需求选择合适的选项。
2.2.3 COMMAND选项（COMMAND Option）
在CMake的add_custom_command命令中，COMMAND选项是一个核心的组成部分，它用于指定我们想要执行的命令。这个命令可以是任何有效的命令，包括系统命令、脚本，或者其他的构建工具。下面我们将详细介绍COMMAND选项的使用方法和注意事项。
2.2.3.1 COMMAND选项的基本用法
COMMAND选项后面通常跟随着我们想要执行的命令，例如：
add_custom_command( TARGET myTarget POST_BUILD COMMAND echo "This is a custom command." )
在这个例子中，我们在myTarget的构建过程中添加了一个自定义命令，这个命令会在所有步骤之后（POST_BUILD）执行，命令的内容是echo "This is a custom command."，这条命令会在终端打印出一段文字。
2.2.3.2 COMMAND选项的高级用法
COMMAND选项不仅可以执行简单的系统命令，还可以执行复杂的脚本或者其他构建工具。例如，我们可以使用COMMAND选项来执行一个Python脚本：
add_custom_command( TARGET myTarget POST_BUILD COMMAND python3 myScript.py )
在这个例子中，我们在myTarget的构建过程中添加了一个自定义命令，这个命令会在所有步骤之后（POST_BUILD）执行，命令的内容是python3 myScript.py，这条命令会执行一个Python脚本。
2.2.3.3 COMMAND选项的注意事项
在使用COMMAND选项时，有一些需要注意的地方：
COMMAND选项后面的命令需要是有效的，否则CMake会在构建过程中报错。- 如果
COMMAND选项后面的命令需要接收参数，那么这些参数需要以空格分隔的形式提供，例如：
add_custom_command( TARGET myTarget POST_BUILD COMMAND echo "This is a custom command." > output.txt )
在这个例子中，我们在myTarget的构建过程中添加了一个自定义命令，这个命令会在所有步骤之后（POST_BUILD）执行，命令的内容是echo "This is a custom command." > output.txt，这条命令会在终端打印出一段文字，并将这段文字重定向到output.txt文件中。
- 如果
COMMAND选项后面的命令是一个路径，那么这个路径需要是绝对路径，否则CMake可能无法找到这个命令。
以上就是关于CMake的add_custom_command命令中`
COMMAND选项的详细介绍。在实际使用中，我们可以根据需要灵活地使用COMMAND选项，执行各种不同的命令，从而实现复杂的构建流程。
2.2.3.4 COMMAND选项的实践应用
在实际项目中，COMMAND选项的应用场景非常广泛。例如，我们可以使用COMMAND选项来执行一些预处理或后处理任务，如代码格式化、单元测试、文档生成等。下面是一个使用COMMAND选项进行单元测试的例子：
add_custom_command( TARGET myTarget POST_BUILD COMMAND ctest -R myTest )
在这个例子中，我们在myTarget的构建过程中添加了一个自定义命令，这个命令会在所有步骤之后（POST_BUILD）执行，命令的内容是ctest -R myTest，这条命令会执行名为myTest的单元测试。
此外，COMMAND选项还可以用于执行一些复杂的构建任务，如调用其他构建工具、执行脚本等。这些高级用法可以帮助我们实现更复杂、更灵活的构建流程。
总的来说，COMMAND选项是add_custom_command命令中非常重要的一个选项，通过灵活地使用COMMAND选项，我们可以在CMake中实现各种复杂的构建任务。
2.2.4 DEPENDS选项详解
DEPENDS选项（DEPENDS Option）在add_custom_command命令中扮演着非常重要的角色。它用于指定自定义命令的依赖关系。在实际的编程过程中，我们经常会遇到一些任务需要在其他任务完成后才能进行，这就是所谓的依赖关系。在CMake中，我们可以通过DEPENDS选项来明确指定这种依赖关系。
DEPENDS选项接受一个或多个文件名作为参数。这些文件名代表了自定义命令的依赖。当这些文件被修改后，自定义命令才会被执行。这种机制保证了我们的构建过程是有效和准确的，只有当依赖的文件发生变化时，相关的构建任务才会被执行，从而避免了不必要的构建任务。
以下是一个使用DEPENDS选项的示例：
add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/foo.cpp COMMAND generate_foo_cpp DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/foo.template )
在这个示例中，我们定义了一个自定义命令，这个命令的任务是生成一个名为foo.cpp的文件。这个命令依赖于一个名为foo.template的文件，只有当foo.template文件被修改后，这个命令才会被执行。
这就是DEPENDS选项的基本用法和工作原理。在实际的项目中，我们可以根据需要灵活地使用DEPENDS选项，来控制我们的构建过程。
2.2.5 BYPRODUCTS选项详解
在CMake的add_custom_command命令中，BYPRODUCTS选项是一个非常重要的参数。它用于指定自定义命令的副产品。如果你指定了一个或多个文件作为副产品，那么这些文件将会被添加到构建系统的清理列表中。这意味着，当你执行清理操作时，这些被标记为副产品的文件也会被清理掉。
让我们通过一个具体的例子来理解BYPRODUCTS选项的作用。假设我们有一个自定义命令，它的任务是生成一些临时文件，这些临时文件在构建过程中会被使用，但是在构建完成后，这些文件就没有用处了。这时，我们就可以使用BYPRODUCTS选项来指定这些临时文件，这样在执行清理操作时，这些临时文件也会被清理掉。
以下是一个使用BYPRODUCTS选项的例子：
add_custom_command( OUTPUT output.txt COMMAND ${CMAKE_COMMAND} -E echo "Hello, World!" > output.txt BYPRODUCTS temp.txt )
在这个例子中，我们的自定义命令会生成一个名为output.txt的文件，同时还会生成一个名为temp.txt的临时文件。我们使用BYPRODUCTS选项指定了temp.txt为副产品，这样在执行清理操作时，temp.txt也会被清理掉。
需要注意的是，BYPRODUCTS选项只能在add_custom_command命令中使用，不能在add_custom_target命令中使用。这是因为add_custom_target命令是用来定义一个目标的，而不是用来定义一个命令的。
总的来说，BYPRODUCTS选项是一个非常有用的工具，它可以帮助我们管理构建过程中生成的临时文件，使我们的构建环境保持整洁。
CMake深度解析：掌握add_custom_command，精通Makefile生成规则（二）https://developer.aliyun.com/article/1465045
