一、背景

在很多時候，需要在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的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。