返回介绍

1.4 用条件句控制编译

发布于 2025-05-06 21:45:53 字数 3638 浏览 0 评论 0 收藏

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

目前为止,看到的示例比较简单,CMake 执行流是线性的:从一组源文件到单个可执行文件,也可以生成静态库或动态库。为了确保完全控制构建项目、配置、编译和链接所涉及的所有步骤的执行流,CMake 提供了自己的语言。本节中,我们将探索条件结构 if-else- else-endif 的使用。

NOTE : CMake 语言相当庞杂,由基本的控制结构、特定于 CMake 的命令和使用新函数模块化扩展语言的基础设施组成。完整的概览可以在这里找到: https://cmake.org/cmake/help/latest/manual/cmake-language.7.html

具体实施

从与上一个示例的的源代码开始,我们希望能够在不同的两种行为之间进行切换:

  1. Message.hppMessage.cpp 构建成一个库(静态或动态),然后将生成库链接到 hello-world 可执行文件中。
  2. Message.hppMessage.cpphello-world.cpp 构建成一个可执行文件,但不生成任何一个库。

让我们来看看如何使用 CMakeLists.txt 来实现:

  1. 首先,定义最低 CMake 版本、项目名称和支持的语言:
    cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
    project(recipe-04 LANGUAGES CXX)
  2. 我们引入了一个新变量 USE_LIBRARY ,这是一个逻辑变量,值为 OFF 。我们还打印了它的值:
    set(USE_LIBRARY OFF)
    ​
    message(STATUS "Compile sources into a library? ${USE_LIBRARY}")
  3. CMake 中定义 BUILD_SHARED_LIBS 全局变量,并设置为 OFF 。调用 add_library 并省略第二个参数,将构建一个静态库:
    set(BUILD_SHARED_LIBS OFF)
  4. 然后,引入一个变量 _sources ,包括 Message.hppMessage.cpp
    list(APPEND _sources Message.hpp Message.cpp)
  5. 然后,引入一个基于 USE_LIBRARY 值的 if-else 语句。如果逻辑为真,则 Message.hppMessage.cpp 将打包成一个库:
    if(USE_LIBRARY)
        # add_library will create a static library
        # since BUILD_SHARED_LIBS is OFF
        add_library(message ${_sources})
        add_executable(hello-world hello-world.cpp)
        target_link_libraries(hello-world message)
    else()
        add_executable(hello-world hello-world.cpp ${_sources})
    endif()
  6. 我们可以再次使用相同的命令集进行构建。由于 USE_LIBRARYOFF , hello-world 可执行文件将使用所有源文件来编译。可以通过在 GNU/Linux 上,运行 objdump -x 命令进行验证。

工作原理

我们介绍了两个变量: USE_LIBRARYBUILD_SHARED_LIBS 。这两个变量都设置为 OFF 。如 CMake 语言文档中描述,逻辑真或假可以用多种方式表示:

  • 如果将逻辑变量设置为以下任意一种: 1ONYEStrueY 或非零数,则逻辑变量为 true
  • 如果将逻辑变量设置为以下任意一种: 0OFFNOfalseNIGNORE、NOTFOUND 、空字符串,或者以 -NOTFOUND 为后缀,则逻辑变量为 false

USE_LIBRARY 变量将在第一个和第二个行为之间切换。 BUILD_SHARED_LIBS 是 CMake 的一个全局标志。因为 CMake 内部要查询 BUILD_SHARED_LIBS 全局变量,所以 add_library 命令可以在不传递 STATIC/SHARED/OBJECT 参数的情况下调用;如果为 false 或未定义,将生成一个静态库。

这个例子说明,可以引入条件来控制 CMake 中的执行流。但是,当前的设置不允许从外部切换,不需要手动修改 CMakeLists.txt 。原则上,我们希望能够向用户开放所有设置,这样就可以在不修改构建代码的情况下调整配置,稍后将展示如何做到这一点。

NOTE : else()endif() 中的 () ,可能会让刚开始学习 CMake 代码的同学感到惊讶。其历史原因是,因为其能够指出指令的作用范围。例如,可以使用 if(USE_LIBRARY)…else(USE_LIBRARY)…endif(USE_LIBIRAY) 。这个格式并不唯一,可以根据个人喜好来决定使用哪种格式。

TIPS : _sources 变量是一个局部变量,不应该在当前范围之外使用,可以在名称前加下划线。

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。