5.4 构建时运行自定义命令:Ⅱ. 使用add_custom_target

NOTE:此示例代码可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-5/recipe-04 中找到,其中包含一个C++例子。该示例在CMake 3.5版(或更高版本)中是有效的,并且已经在GNU/Linux、macOS和Windows上进行过测试。

我们在前面的示例,讨论了add_custom_command有一些限制,可以通过add_custom_target绕过这些限制。这个CMake命令将引入新的目标,与add_custom_command相反,这些目标依次执行不返回输出。可以将add_custom_targetadd_custom_command结合使用。使用这种方法,可以与其依赖项所在目录不同的目录指定自定义目标,CMake基础设施对项目设计模块化非常有用。

准备工作

我们将重用前一节示例,对源码进行简单的修改。特别是,将把压缩后的tar打包文件放在名为deps的子目录中,而不是存储在主目录中。这个子目录包含它自己的CMakeLists.txt,将由主CMakeLists.txt调用。

具体实施

我们将从主CMakeLists.txt开始,然后讨论deps/CMakeLists.txt:

  1. 声明启用C++11:

    1. cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
    2. project(recipe-04 LANGUAGES CXX Fortran)
    3. set(CMAKE_CXX_STANDARD 11)
    4. set(CMAKE_CXX_EXTENSIONS OFF)
    5. set(CMAKE_CXX_STANDARD_REQUIRED ON)
  2. 现在,继续讨论deps/CMakeLists.txt。这通过add_subdirectory命令实现:

    1. add_subdirectory(deps)
  3. deps/CMakeLists.txt中,我们首先定位必要的库(BLAS和LAPACK):

    1. find_package(BLAS REQUIRED)
    2. find_package(LAPACK REQUIRED)
  4. 然后,我们将tar包的内容汇集到一个变量MATH_SRCS中:

    1. set(MATH_SRCS
    2. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxBLAS.cpp
    3. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxLAPACK.cpp
    4. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxBLAS.hpp
    5. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxLAPACK.hpp
    6. )
  5. 列出要打包的源之后,定义一个目标和一个命令。这个组合用于提取${CMAKE_CURRENT_BINARY_DIR}中的包。但是,这里我们在一个不同的范围内,引用deps/CMakeLists.txt,因此tar包将存放在到主项目构建目录下的deps子目录中:

    1. add_custom_target(BLAS_LAPACK_wrappers
    2. WORKING_DIRECTORY
    3. ${CMAKE_CURRENT_BINARY_DIR}
    4. DEPENDS
    5. ${MATH_SRCS}
    6. COMMENT
    7. "Intermediate BLAS_LAPACK_wrappers target"
    8. VERBATIM
    9. )
    10. add_custom_command(
    11. OUTPUT
    12. ${MATH_SRCS}
    13. COMMAND
    14. ${CMAKE_COMMAND} -E tar xzf ${CMAKE_CURRENT_SOURCE_DIR}/wrap_BLAS_LAPACK.tar.gz
    15. WORKING_DIRECTORY
    16. ${CMAKE_CURRENT_BINARY_DIR}
    17. DEPENDS
    18. ${CMAKE_CURRENT_SOURCE_DIR}/wrap_BLAS_LAPACK.tar.gz
    19. COMMENT
    20. "Unpacking C++ wrappers for BLAS/LAPACK"
    21. )
  6. 添加数学库作为目标,并指定相应的源,包括目录和链接库:

    1. add_library(math "")
    2. target_sources(math
    3. PRIVATE
    4. ${MATH_SRCS}
    5. )
    6. target_include_directories(math
    7. INTERFACE
    8. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK
    9. )
    10. # BLAS_LIBRARIES are included in LAPACK_LIBRARIES
    11. target_link_libraries(math
    12. PUBLIC
    13. ${LAPACK_LIBRARIES}
    14. )
  7. 执行完deps/CMakeLists.txt中的命令,返回到父范围,定义可执行目标,并将其链接到另一个目录的数学库:

    1. add_executable(linear-algebra linear-algebra.cpp)
    2. target_link_libraries(linear-algebra
    3. PRIVATE
    4. math
    5. )

工作原理

用户可以使用add_custom_target,在目标中执行定制命令。这与我们前面讨论的add_custom_command略有不同。add_custom_target添加的目标没有输出,因此总会执行。因此,可以在子目录中引入自定义目标,并且仍然能够在主CMakeLists.txt中引用它。

本例中,使用add_custom_targetadd_custom_command提取了源文件的包。这些源文件稍后用于编译另一个库,我们设法在另一个(父)目录范围内链接这个库。构建CMakeLists.txt文件的过程中,tar包是在deps下,deps是项目构建目录下的一个子目录。这是因为在CMake中,构建树的结构与源树的层次结构相同。

这个示例中有一个值得注意的细节,就是我们把数学库的源标记为PRIVATE:

  1. set(MATH_SRCS
  2. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxBLAS.cpp
  3. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxLAPACK.cpp
  4. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxBLAS.hpp
  5. ${CMAKE_CURRENT_BINARY_DIR}/wrap_BLAS_LAPACK/CxxLAPACK.hpp
  6. )
  7. # ...
  8. add_library(math "")
  9. target_sources(math
  10. PRIVATE
  11. ${MATH_SRCS}
  12. )
  13. # ...

虽然这些源代码是PRIVATE,但我们在父范围内编译了linear-algebra.cpp,并且这个源代码包括CxxBLAS.hppCxxLAPACK.hpp。为什么这里使用PRIVATE,以及如何编译linear-algebra.cpp,并构建可执行文件呢?如果将头文件标记为PUBLIC, CMake就会在创建时停止,并出现一个错误,“无法找到源文件”,因为要生成(提取)还不存在于文件树中的源文件。

这是一个已知的限制(参见https://gitlab.kitware.com/cmake/cmake/issues/1633 ,以及相关的博客文章:https://samthursfield.wordpress.com/2015/11/21/cmake-depende-ncies-targets-and-files-and-custom-commands )。我们通过声明源代码为PRIVATE来解决这个限制。这样CMake时,没有获得对不存在源文件的依赖。但是,CMake内置的C/C++文件依赖关系扫描器在构建时获取它们,并编译和链接源代码。