一、add_custom_command

1.执行有输出文件的自定义操作

add_custom_command 向目标添加规则，并通过执行命令生成输出。

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])
OUTPUT：指定命令预期生成的输出文件。3.20版本以后，输出参数可使用一组受限的生成器表达式。

COMMAND：指定生成时要执行的命令行。

MAIN_DEPENDENCY：指定命令的主输入源文件。类似于DEPENDS。

DEPENDS：指定命令所依赖的文件。

BYPRODUCTS：指定命令预期生成的文件，但其修改时间可能比依赖项的新，也可能不比依赖项的新。

IMPLICIT_DEPENDS：请求扫描输入文件的隐式依赖项。此选项不能与DEPFILE选项同时指定。

WORKING_DIRECTORY：指定在何处执行命令。

COMMENT：指定在生成时执行命令之前显示的消息。

DEPFILE：指定保存自定义命令依赖项的depfile。它通常由自定义命令本身发出。仅当生成器支持此关键字时，才能使用此关键字。

JOB_POOL：为Ninja生成器指定一个池。

VERBATIM：对于构建工具，命令的所有参数都将被正确转义，以便被调用的命令接收到的每个参数不变。请注意，在add_custom_command甚至看到参数之前，CMake语言处理器仍然使用一级转义。建议使用VERBATIM，因为它可以保证正确的行为。如果不指定VERBATIM，则行为是依赖于平台的，因为CMake没有针对于特定工具中特殊字符的保护措施。

APPEND：将COMMAND和DEPENDS 附加到第一个指定输出的自定义命令。

USES_TERMINAL：如果可能，该命令将被授予直接访问终端的权限。

COMMAND_EXPAND_LISTS：命令参数中的列表将展开，包括使用生成器表达式创建的列表。

add_custom_command 有两个限制：

只有在相同的 CMakeLists.txt 中，指定了所有依赖于其输出的目标时才有效。

对于不同的独立目标，使用 add_custom_command 的输出可以重新执行定制命令。这可能会导致冲突，应该避免这种情况的发生。

第二个限制，可以使用 add_dependencies 来避免。不过，规避这两个限制的正确方法是使用 add_custom_target 命令。

2.执行没有输出的自定义操作

向目标（如库或可执行文件）添加自定义命令。这对于在构建目标之前或之后执行操作非常有用。该命令成为目标的一部分，仅在构建目标本身时执行。如果目标已生成，则不会执行该命令。

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])
TARGET：由 add_executable 或 add_library 生成的目标文件名称；

PRE_BUILD | PRE_LINK | POST_BUILD：分别表示编译之前执行命令，链接之前执行命令，生成目标文件后执行命令；

COMMAND：需要执行的命令；

BYPRODUCTS：指定命令预期生成的文件，但其修改时间可能比依赖项的新，也可能不比依赖项的新。

WORKING_DIRECTORY：指定在何处执行命令。

COMMENT：指定在生成时执行命令之前显示的消息。

VERBATIM：对于构建工具，命令的所有参数都将被正确转义，以便被调用的命令接收到的每个参数不变。请注意，在add_custom_command甚至看到参数之前，CMake语言处理器仍然使用一级转义。建议使用VERBATIM，因为它可以保证正确的行为。如果不指定VERBATIM，则行为是依赖于平台的，因为CMake没有针对于特定工具中特殊字符的保护措施。

USES_TERMINAL：如果可能，该命令将被授予直接访问终端的权限。

COMMAND_EXPAND_LISTS：命令参数中的列表将展开，包括使用生成器表达式创建的列表。

补充：

PRE_BUILD：在执行与目标相关的任何其他规则之前执行的命令。

PRE_LINK：使用此选项，命令在编译目标之后，调用链接器或归档器之前执行。Visual Studio 7或更高版本之外的生成器中使用 PRE_BUILD 将被解释为 PRE_LINK 。

POST_BUILD：如前所述，这些命令将在执行给定目标的所有规则之后运行。

二、应用

1.执行有输出文件的自定义操作

下面的例子实现的是：声明自定义命令来提取wrap_BLAS_LAPACK.tar.gz压缩包，并更新提取文件的时间戳。

#声明一个变量 wrap_BLAS_LAPACK_sources来保存wrap_BLAS_LAPACK.tar.gz 压缩包文件的名称
set(wrap_BLAS_LAPACK_sources${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxBLAS.hpp${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxBLAS.cpp${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxLAPACK.hpp${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxLAPACK.cpp)#当目标wrap_BLAS_LAPACK_sources 被新生成时，执行COMMAND 后面的命令
add_custom_command(OUTPUT${wrap_BLAS_LAPACK_sources}COMMAND #在构建时提取打包文件${CMAKE_COMMAND} -E tar xzf ${CMAKE_CURRENT_SOURCE_DIR}/wrap_BLAS_LAPACK.tar.gzCOMMAND #更新提取文件的时间戳${CMAKE_COMMAND} -E touch ${wrap_BLAS_LAPACK_sources}WORKING_DIRECTORY #指定在何处执行命令${CMAKE_CURRENT_BINARY_DIR}DEPENDS #列出了自定义命令的依赖项${CMAKE_CURRENT_SOURCE_DIR}/wrap_BLAS_LAPACK.tar.gzCOMMENT #在构建时打印状态消息"Unpacking C++ wrappers for BLAS/LAPACK"VERBATIM #告诉CMake为生成器和平台生成正确的命令，从而确保完全独立。)

2.执行没有输出的自定义操作

使用 add_custom_command 的第二种方式，在构建目标之前打印目标的链接：

add_executable(example "")target_sources(examplePRIVATEexample.f90)add_custom_command(TARGETexamplePRE_LINKCOMMAND${PYTHON_EXECUTABLE}${CMAKE_CURRENT_SOURCE_DIR}/echo-file.py${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/example.dir/link.txtCOMMENT"link line:"VERBATIM)

PRE_LINK 命令将 ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/example.dir/link.txt 的内容打印到屏幕上：

link line:
/usr/bin/f95 -O3 -DNDEBUG -O3 CMakeFiles/example.dir/example.f90.o -o example

CMake I add_custom_command命令详解（构建）相关推荐

CMake | include_guard命令详解
目录一.命令详解二.简单使用 1.CMakeLists.txt 2.cmake/custom.cmake 3.配置三.为低于3.10的版本自定义"包含保护"机制 1.cmak ...
cmake(8)：install命令详解
1. 说明之前的示例中有提到使用cmake的install命令来自动安装库和头文件,但是只是使用到了install命令很基础很少的部分,其实该命令作用十分丰富,本篇文档用于说明该命令的详细使用方法. ...
Android自动化测试环境部署及adb sdkmanager avdmanager Monitor DDMS工具使用及命令详解
环境部署及工具使用系列文章前言环境部署硬件环境软件环境 ADB工具 adb组成 adb命令 android命令 sdkmanager 命令 avdmanager命令管理模拟器 monito ...
docker常用命令详解
docker常用命令详解本文只记录docker命令在大部分情境下的使用,如果想了解每一个选项的细节,请参考官方文档,这里只作为自己以后的备忘记录下来. 根据自己的理解,总的来说分为以下几种: Doc ...
超级干货：3个性能监控和优化命令详解
小编为大家整理出了三个有关性能监控和优化命令详细讲解,别看只有三个,但不影响他噎啊,本篇文章很长,涉及top命令.free命令和vmstat命令,真的是很详细的讲解,希望能帮到大家,另外还有两条相关的 ...
nmcli命令详解_【高新课堂】第一百二十五期Liunx必备命令
点击上方"蓝字"关注我们吧! Liunx系统启动默认为字符界面,一般不会启用图像界面,所以对命令行的熟练程度能更加高效.便捷的管理Liunx服务器. 这节课向读者介绍Liunx系统 ...
Dockerfile命令详解
使用docker就会避免不了的要做各种镜像,就会用到dockerfile,记录一下dockerfile的主要命令 1.主要组成部分 dockerfile执行build命令时,是从上倒下依次执行 ...
linux的strace命令(详解)
linux的strace命令(详解) 本文详细讲述linux下的strace命令的用法. strace 命令是一种强大的工具,它能够显示所有由用户空间程序发出的系统调用. strace 显示这些调用的 ...
【转】tftp命令详解
转自:tftp命令详解 - 张大猛 - 博客园介绍一个 FTP客户端-IIS7服务器管理工具作为FTP客户端,它支持批量管理ftp站点.定时上传和定时下载,定时备份,且操作简洁.同时iis ...

CMake I add_custom_command命令详解（构建）

一、add_custom_command

1.执行有输出文件的自定义操作

2.执行没有输出的自定义操作

二、应用

1.执行有输出文件的自定义操作

2.执行没有输出的自定义操作

CMake I add_custom_command命令详解（构建）相关推荐

最新文章

热门文章