CMake深度解析：掌握add_custom_command，精通Makefile生成规则（一）https://developer.aliyun.com/article/1465043
2.2.6 WORKING_DIRECTORY选项
WORKING_DIRECTORY选项是add_custom_command命令中的一个重要参数，它用于指定自定义命令的工作目录。在我们进行项目构建时，有时需要在特定的目录下执行某些命令，这时就可以利用WORKING_DIRECTORY选项来实现。
WORKING_DIRECTORY选项的基本用法
WORKING_DIRECTORY选项的基本用法如下：
add_custom_command( TARGET target COMMAND command WORKING_DIRECTORY dir )
在这个例子中，dir就是我们指定的工作目录。当CMake执行到这个add_custom_command命令时，它会切换到dir目录下，然后在这个目录下执行command命令。
WORKING_DIRECTORY选项的实际应用
在实际的项目构建中，WORKING_DIRECTORY选项的应用非常广泛。例如，我们可能需要在项目的源代码目录下执行一些预处理命令，或者在构建目录下执行一些后处理命令。这时，我们就可以使用WORKING_DIRECTORY选项来指定这些命令的工作目录。
下面是一个实际的例子：
add_custom_command( TARGET my_target PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/config.h.in ${CMAKE_BINARY_DIR}/config.h WORKING_DIRECTORY ${CMAKE_BINARY_DIR} )
在这个例子中，我们在构建目标my_target之前，先执行了一个命令，这个命令是将config.h.in文件从源代码目录复制到构建目录。并且，我们指定了这个命令的工作目录为构建目录。
这样，无论我们在哪里执行构建命令，这个复制文件的操作都会在正确的目录下执行，保证了构建的正确性。
WORKING_DIRECTORY选项的注意事项
在使用WORKING_DIRECTORY选项时，有一些需要注意的地方：
- WORKING_DIRECTORY选项指定的目录必须是存在的，否则CMake会报错。如果你不确定目录是否存在，可以使用
file(MAKE_DIRECTORY dir)命令来确保目录的存在。 - 如果没有指定WORKING_DIRECTORY选项，那么默认的工作目录就是当前的CMakeLists.txt文件所在的目录。
- WORKING_DIRECTORY选项只影响当前的add_custom_command命令，不会影响其他的命令或者CMakeLists.txt文件。
以上就是关于WORKING_DIRECTORY选项的详细介绍，希望对你有所帮助。在实际的项目
构建中，我们可以灵活地使用WORKING_DIRECTORY选项，来控制自定义命令的执行环境，从而提高构建的灵活性和可控性。
WORKING_DIRECTORY选项的高级应用
WORKING_DIRECTORY选项不仅可以用于指定命令的工作目录，还可以用于实现一些高级的构建策略。例如，我们可以利用WORKING_DIRECTORY选项来实现跨平台的构建。
在跨平台的构建中，我们可能需要在不同的平台上使用不同的工作目录。例如，我们可能需要在Windows平台上使用一个目录，而在Linux平台上使用另一个目录。这时，我们可以使用CMake的平台检测功能，结合WORKING_DIRECTORY选项，来实现这个需求。
下面是一个例子：
if(WIN32) set(dir ${CMAKE_SOURCE_DIR}/win) else() set(dir ${CMAKE_SOURCE_DIR}/linux) endif() add_custom_command( TARGET my_target COMMAND command WORKING_DIRECTORY ${dir} )
在这个例子中，我们首先检测了当前的平台。如果是Windows平台，那么我们就设置工作目录为win目录；否则，我们就设置工作目录为linux目录。然后，我们在add_custom_command命令中使用了这个工作目录。
这样，我们就可以在不同的平台上使用不同的工作目录，从而实现跨平台的构建。
以上就是关于WORKING_DIRECTORY选项的详细介绍，希望对你有所帮助。在实际的项目构建中，我们可以灵活地使用WORKING_DIRECTORY选项，来控制自定义命令的执行环境，从而提高构建的灵活性和可控性。
2.2.7 COMMENT选项
COMMENT选项在add_custom_command命令中起到了非常重要的作用。它的主要功能是为自定义命令提供注释，这些注释将在执行自定义命令时被打印出来。这对于理解和调试构建过程非常有帮助。
COMMENT选项的基本用法
COMMENT选项的基本用法非常简单。你只需要在add_custom_command命令中添加COMMENT选项，然后提供一个字符串作为参数。这个字符串就是你想要打印的注释。例如：
add_custom_command( TARGET my_target POST_BUILD COMMAND my_command COMMENT "正在执行 my_command..." )
在这个例子中，每当my_target被构建，且在所有步骤之后，my_command命令就会被执行。同时，"正在执行 my_command…"这个注释也会被打印出来。
COMMENT选项的高级用法
虽然COMMENT选项的基本用法非常简单，但是你可以通过一些高级技巧来更好地利用它。
首先，你可以使用CMake的变量和表达式来动态生成注释。例如，你可以创建一个变量来存储命令的名称，然后在COMMENT选项中使用这个变量：
set(MY_COMMAND_NAME "my_command") add_custom_command( TARGET my_target POST_BUILD COMMAND ${MY_COMMAND_NAME} COMMENT "正在执行 ${MY_COMMAND_NAME}..." )
在这个例子中，${MY_COMMAND_NAME}会被替换为my_command，所以打印的注释将是"正在执行 my_command…"。
此外，你还可以使用if命令来根据条件改变注释。例如，你可以根据构建类型（如Debug或Release）来打印不同的注释：
add_custom_command( TARGET my_target POST_BUILD COMMAND my_command COMMENT $<$<CONFIG:Debug>:"正在执行 my_command (Debug模式)..." $<$<CONFIG:Release>:"正在执行 my_command (Release模式)..."> )
在这个例子中，< C O N F I G : D e b u g > 和 和<CONFIG:Debug>和CONFIG:Release是CMake的生成表达式，它们会根据当前的构建类型来返回true或false。如果当前的构建类型是Debug，那么"正在执行 my_command (Debug模式)…"这个注释将被打印出来。如果当前的构建类型是Release，那么"正在执行 my_command (Release模式)…"这个注释将被打印出来。
COMMENT选项的注意事项
虽然COMMENT选项非常有用，但是在使用它
时，还需要注意一些事项。
首先，COMMENT选项的参数必须是一个字符串。如果你提供的参数不是字符串，CMake将会报错。
其次，COMMENT选项的参数不能包含换行符。如果你的注释需要跨多行，你可以使用多个COMMENT选项，每个选项对应一行注释。
最后，虽然COMMENT选项可以帮助你理解和调试构建过程，但是它并不能替代良好的文档和注释。你应该始终确保你的CMake脚本有足够的注释和文档，以便其他人（或者未来的你）能够理解它。
以上就是关于CMake中add_custom_command命令中COMMENT选项的详细介绍。希望这些信息能帮助你更好地理解和使用这个强大的构建工具。
下图是对本节内容的图形化总结：
2.2.8 VERBATIM选项
VERBATIM选项是add_custom_command命令中的一个重要参数，它的主要作用是控制命令参数的处理方式。当我们在add_custom_command中指定了VERBATIM选项后，命令参数将会被按照字面意义处理，而不会被解析为变量或表达式。
2.2.8.1 VERBATIM选项的基本用法
在CMake的add_custom_command命令中，VERBATIM选项的基本用法如下：
add_custom_command( TARGET target COMMAND command VERBATIM )
在这个例子中，target是我们要构建的目标，command是我们要执行的命令。当我们在命令后面添加了VERBATIM选项后，CMake会按照字面意义来处理command中的参数，而不会将它们解析为变量或表达式。
2.2.8.2 VERBATIM选项的作用
VERBATIM选项的主要作用是防止命令参数的误解析。在CMake中，我们常常需要使用变量或表达式来动态地生成命令参数。然而，如果我们直接将这些变量或表达式写在命令参数中，CMake可能会在解析命令参数时将它们误解析为字面值，从而导致命令执行失败。
为了解决这个问题，CMake提供了VERBATIM选项。当我们在add_custom_command命令中指定了VERBATIM选项后，CMake会按照字面意义来处理命令参数，而不会将它们解析为变量或表达式。这样，我们就可以在命令参数中安全地使用变量和表达式了。
2.2.8.3 VERBATIM选项的注意事项
虽然VERBATIM选项可以帮助我们防止命令参数的误解析，但在使用它时，我们还需要注意以下几点：
- VERBATIM选项只能用在add_custom_command命令中，不能用在其他命令中。
- VERBATIM选项必须放在COMMAND选项之后，否则它将不会生效。
- 当我们在add_custom_command命令中指定了VERBATIM选项后，我们需要确保命令参数中不包含任何需要被解析的变量或表达式。否则，这些变量或表达式将会被按照字面意义处理，而不会被正确地解析。
以上就是关于CMake中add_custom_command命令中VERBATIM
选项的详细介绍。在实际的项目开发中，我们可以根据需要灵活地使用VERBATIM选项，以确保命令参数的正确解析，从而提高我们的构建效率和项目质量。
2.2.8.4 VERBATIM选项的实际应用示例
下面我们通过一个实际的应用示例来进一步理解VERBATIM选项的作用。
假设我们在一个CMake项目中，需要在构建过程中执行一个脚本，这个脚本需要接收一个参数，这个参数是一个文件的路径。我们可以使用add_custom_command命令来实现这个需求，代码如下：
add_custom_command( TARGET target COMMAND ${CMAKE_COMMAND} -E echo "Running script..." COMMAND python3 ${CMAKE_SOURCE_DIR}/script.py ${CMAKE_BINARY_DIR}/output.txt VERBATIM )
在这个例子中，我们首先使用echo命令打印了一条消息，然后我们调用了python3来执行我们的脚本，脚本的路径是${CMAKE_SOURCE_DIR}/script.py，脚本的参数是${CMAKE_BINARY_DIR}/output.txt。我们在命令后面添加了VERBATIM选项，这样CMake就会按照字面意义来处理命令参数，而不会将${CMAKE_SOURCE_DIR}和${CMAKE_BINARY_DIR}解析为变量。
通过这个例子，我们可以看到，VERBATIM选项可以帮助我们在命令参数中安全地使用变量，从而提高我们的构建效率和项目质量。
以上就是关于CMake中add_custom_command命令中VERBATIM选项的详细介绍。希望这些内容能帮助你更好地理解和使用CMake。
3. add_custom_command在实际项目中的应用
3.1 如何使用add_custom_command控制Makefile的生成（How to Control the Generation of Makefile with add_custom_command）
在CMake中，add_custom_command命令是一个非常强大的工具，它可以让我们在构建过程中插入自定义的命令，从而实现对Makefile生成过程的精细控制。下面我们将详细介绍如何使用add_custom_command来控制Makefile的生成。
首先，我们需要理解add_custom_command的基本语法。这个命令的基本形式如下：
add_custom_command( TARGET target PRE_BUILD | PRE_LINK | POST_BUILD COMMAND command1 [ARGS] [args1...] [COMMAND command2 [ARGS] [args2...] ...] [WORKING_DIRECTORY dir] [COMMENT comment] [VERBATIM] )
在这个命令中，TARGET选项用于指定一个目标，自定义命令将会在构建这个目标时被执行。COMMAND选项用于指定要执行的命令，你可以提供任何有效的命令，包括系统命令、脚本，或者其他的构建工具。WORKING_DIRECTORY选项用于指定自定义命令的工作目录。
接下来，我们来看一个具体的例子。假设我们有一个项目，其中包含一个C++源文件main.cpp，我们希望在编译这个文件之前，先执行一个自定义的命令，比如打印一条消息。我们可以使用add_custom_command来实现这个需求：
add_custom_command( TARGET my_target PRE_BUILD COMMAND echo "开始编译main.cpp..." )
在这个例子中，我们指定了TARGET为my_target，这意味着自定义命令将会在构建my_target目标时被执行。我们使用了PRE_BUILD选项，这意味着自定义命令将会在其他所有步骤之前执行。我们的COMMAND是echo "开始编译main.cpp..."，这是一个简单的打印消息的命令。
当我们运行CMake并构建my_target目标时，我们会看到在编译main.cpp之前，控制台上打印出了我们的自定义消息。
通过这个例子，我们可以看到，add_custom_command命令为我们提供了一种强大的方式，来插入自定义的命令，并控制这些命令在构建过程中的执行时机。这使得我们可以实现对Makefile生成过程的精细控制，满足各种复杂的构建需求。
在实际使用中，add_custom_command命令的选项还有很多，比如DEPENDS、BYPRODUCTS、COMMENT和VERBATIM等，这些选项可以
提供更多的控制能力，使得我们可以更精细地控制自定义命令的行为。
例如，DEPENDS选项可以用来指定自定义命令的依赖。如果你指定了一个或多个文件作为依赖，那么只有当这些文件被修改后，自定义命令才会被执行。这可以用来实现增量构建，提高构建效率。
BYPRODUCTS选项可以用来指定自定义命令的副产品。如果你指定了一个或多个文件作为副产品，那么这些文件将会被添加到构建系统的清理列表中，当你执行清理操作时，这些文件将会被删除。
COMMENT选项可以用来指定一个注释，这个注释将会在执行自定义命令时被打印出来，这可以用来提供一些有用的信息，帮助我们理解构建过程。
VERBATIM选项可以用来控制命令参数的处理方式。如果你指定了VERBATIM，那么命令参数将会被按照字面意义处理，而不会被解析为变量或表达式。这可以避免一些常见的错误，比如参数中包含特殊字符或空格时的问题。
通过合理地使用这些选项，我们可以实现各种复杂的构建需求，从而更好地控制Makefile的生成。
在下一节中，我们将介绍如何在实际项目中使用add_custom_command命令。
CMake深度解析：掌握add_custom_command，精通Makefile生成规则（三）https://developer.aliyun.com/article/1465046
