C++-Cmake指令：add_custom_target【增加一个没有输出的目标，使得它总是被构建】

曾经终败给现在 2023-09-25 13:08 72阅读 0赞

## 一、add\_custom\_target语法 ##

在很多时候，需要在`cmake`中创建一些目标，如`clean`、`copy`等等，这就需要通过`add_custom_target`来指定。同时，`add_custom_command`可以用来完成对`add_custom_target`生成的`target`的补充。

**`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...]])

该命令的其他一些参数的含义：

*  ALL：表明该目标会被添加到默认的构建目标，使得它每次都被运行；
 *  COMMAND：指定要在构建时执行的命令行；
 *  DEPENDS：指定命令所依赖的文件；
 *  COMMENT：在构建时执行命令之前显示给定消息；
 *  WORKING\_DIRECTORY：使用给定的当前工作目录执行命令。如果它是相对路径，它将相对于对应于当前源目录的构建树目录；
 *  BYPRODUCTS：指定命令预期产生的文件。

## 二、add\_custom\_target案例 ##

**`add_custom_target`**创建target，用于make。 例子：

cmake_minimum_required(VERSION 3.0)
    project(test)
    
    add_custom_target(CopyTask
      COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/config 
      ${CMAKE_CURRENT_SOURCE_DIR}/etc
      COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/log.txt  
      ${CMAKE_CURRENT_SOURCE_DIR}/etc
      )

初始目录结构：

运行上述CMakeList.txt文件：

mkdir build && cd build
    cmake ..
    make CopyTask

运行后目录结构，如下：

其实可以看出，这段代码的目的就是将`config`文件夹的内容和`log.txt`文件复制到新的`etc`文件夹内。

`add_custom_target`生成一个目标`CopyTask`，该目标是用来复制文件夹或者复制文件的！也就是`COMMAND`中定义的操作。

*  target是后面的命令的目标。
 *  command就是生成目标文件的命令，一般就是编译命令。

即make target相当于执行后面的所有命令。

*  上面的命令为将config目录下的内容拷贝到etc目录下，将log.txt文件拷贝到etc目录下。
 *  $\{CMAKE\_COMMAND\}**是CMake的路径，**
 *  **-E使CMake运行命令而不是构建**
 *  **copy\_directory和copy是cmake\_command\_line，再后面两个就是command\_line的参数**

当然，生成文件不仅仅只能是复制，还可以是其他的操作。而**这些COMMAND操作，都在command\_line中规定了**。

至于`cmake_command_line`的内容，可参考`cmake`的官方资料：[Run a Command-Line Tool][]。

[cmake的add\_custom\_target指令学习 - lypbendlf - 博客园][cmake_add_custom_target_ - lypbendlf -]

[【CMake】cmake的add\_custom\_command和add\_custom\_target指令\_Yngz\_Miao的博客-CSDN博客][CMake_cmake_add_custom_command_add_custom_target_Yngz_Miao_-CSDN]

[add\_custom\_target — CMake 3.0.2 Documentation][add_custom_target _ CMake 3.0.2 Documentation]

[CMake之add\_custom\_target\_kendyChina的博客-CSDN博客][CMake_add_custom_target_kendyChina_-CSDN]

[Run a Command-Line Tool]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#run-a-command-line-tool
[cmake_add_custom_target_ - lypbendlf -]: https://www.cnblogs.com/BlueBlueSea/p/16530438.html
[CMake_cmake_add_custom_command_add_custom_target_Yngz_Miao_-CSDN]: https://blog.csdn.net/qq_38410730/article/details/102797448
[add_custom_target _ CMake 3.0.2 Documentation]: https://cmake.org/cmake/help/v3.0/command/add_custom_target.html
[CMake_add_custom_target_kendyChina_-CSDN]: https://blog.csdn.net/MacKendy/article/details/122693478