本文主要是介绍CMake命令之add_custom_comand 和 add_custom_target，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！
一、背景
在很多时候，需要在cmake中创建一些目标，如clean、copy等等，这就需要通add_custom_target来指定。而add_custom_command则可以用来完成对add_custom_target生成的target的补充。
二、add_custom_target命令
命令的功能：添加一个没有输出的目标，使得它始终被构建。类似于makefile里面的
target ... : prerequisites ... command1command2command3...其中：
target是下面的命令的目标，即下面命令是为了target而生的。这个目标可以是*.o文件，也可以是可执行文件；
prerequisites则是生成该目标所依赖的文件，如果找不到依赖的文件，下面的命令就不会执行，并且会中断make的生成；
command就是生成目标文件的命令，一般就是编译命令。
那么，如果使用CMakeLists.txt如何也生成一个目标来make呢？
这就是add_custom_target的用处：增加一个没有输出的目标，使得它总是被构建。
add_custom_target(Name [ALL] [command1 [args1...]][COMMAND command2 [args2...] ...][DEPENDS depend depend depend ... ][BYPRODUCTS [files...]][WORKING_DIRECTORY dir][COMMENT comment][JOB_POOL job_pool][VERBATIM] [USES_TERMINAL][COMMAND_EXPAND_LISTS][SOURCES src1 [src2...]])add_custom_comand的其他参数含义：
ALL：表明该目标会被添加到默认的构建目标，使得它每次都被运行；COMMAND：指定要在构建时执行的命令行；DEPENDS：指定命令所依赖的文件；COMMENT：在构建时执行命令之前显示给定消息；WORKING_DIRECTORY：使用给定的当前工作目录执行命令。如果它是相对路径，它将相对于对应于当前源目 录的构建树目录；BYPRODUCTS：指定命令预期产生的文件。乍一看，该命令有很多的参数，但其实我们并不需要全部了解，甚至一般情况下只需要用到其中的两三个
举个例子
cmake_minimum_required(VERSION 3.0)
project(test)add_custom_target(CopyTask ALLCOMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/config COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/log.txt COMMAND python ${CMAKE_CURRENT_SOURCE_DIR}/etc.py WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/etc)
其中：${CMAKE_COMMAND}是CMake的路径，-E使CMake运行命令而不是构建，copy_directory和copy是cmake_command_line，再后面两个就是command_line的参数。
当然，生成文件不仅仅只能是复制，还可以是其他的操作。而这些COMMAND操作，都在command_line中规定了，参考cmake_command_line。
这里还可以调用python脚本，或者其他的命令行命令。
二、add_custom_comand的介绍
它有两种命令格式：
第一种是，添加自定义命令，来生成指定的OUTPUT文件。
add_custom_command(OUTPUT output1 [output2 ...]COMMAND command1 [ARGS] [args1...][COMMAND command2 [ARGS] [args2...] ...][MAIN_DEPENDENCY depend][DEPENDS [depends...]][BYPRODUCTS [files...]][IMPLICIT_DEPENDS <lang1> depend1[<lang2> depend2] ...][WORKING_DIRECTORY dir][COMMENT comment][DEPFILE depfile][JOB_POOL job_pool][VERBATIM] [APPEND] [USES_TERMINAL][COMMAND_EXPAND_LISTS])举个例子，添加一个自定义命令来运行someTool来生成out.c文件，然后将生成的源代码编译为库的一部分。每当in.txt更改时，该生成规则将会重新运行 。
add_custom_command(OUTPUT out.cCOMMAND someTool -i ${CMAKE_CURRENT_SOURCE_DIR}/in.txt-o out.cDEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/in.txtVERBATIM)
add_library(myLib out.c)第二种是，将自定义的命令添加到目标（比如lib库或者可执行文件）。
add_custom_command(TARGET <target>PRE_BUILD | PRE_LINK | POST_BUILDCOMMAND command1 [ARGS] [args1...][COMMAND command2 [ARGS] [args2...] ...][BYPRODUCTS [files...]][WORKING_DIRECTORY dir][COMMENT comment][VERBATIM] [USES_TERMINAL][COMMAND_EXPAND_LISTS])这种自定义的命令，可以设置在构建这个目标过程中的某些时刻。也就是就，这种场景可以在目标构建的过程中，添加一些额外执行的命令。这些命令本身将会成为该目标的一部分。注意，仅在目标本身被构建过程才会执行。如果该目标已经构建，命令将不会执行。
那么这些时刻是什么呢？
如下表所示：
举个例子，这里使用了POST_BUILD参数，表示在可执行文件被链接之后，someHasher会生成一个hash文件
add_executable(myExe myExe.c)
add_custom_command(TARGET myExe POST_BUILDCOMMAND someHasher -i "$<TARGET_FILE:myExe>"-o "$<TARGET_FILE:myExe>.hash"VERBATIM)三、实例
set(TEST_FILE "log.txt")add_custom_command(OUTPUT ${TEST_FILE}COMMAND echo "Generating log.txt file..."COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_LIST_FILE} ${TEST_FILE}COMMENT "This is a test")add_custom_target(Test1 ALL DEPENDS ${TEST_FILE})add_custom_command(TARGET Test1PRE_BUILD COMMAND echo "executing a fake command"COMMENT "This command will be executed before building target Test1")
参考：
add_custom_command — CMake 3.22.0 Documentation
add_custom_target — CMake 3.22.0 Documentation
CMake命令之add_custom_comand 和 add_custom_target_山庄来客的专栏-CSDN博客
【CMake】cmake的add_custom_command和add_custom_target指令_Yngz_Miao的博客-CSDN博客_add_custom_command
这篇关于CMake命令之add_custom_comand 和 add_custom_target的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！
