CMake 系列(四):用条件控制编译

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

提示:本示例在 CMake 3.5 或更高版本中有效,并已在 GNU/Linux、macOS 和 Windows 上测试通过。

注意:CMake 语言相当庞杂,由基本的控制结构、特定于 CMake 的命令,以及使用新函数模块化扩展语言的基础设施组成。

具体实施

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

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

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

首先,定义最低 CMake 版本、项目名称和支持的语言:

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)

project(recipe-04 LANGUAGES CXX)

我们引入了一个新变量 USE_LIBRARY,这是一个逻辑变量,值为 OFF。我们还打印了它的值:

set(USE_LIBRARY OFF)

message(STATUS "Use library: ${USE_LIBRARY}")

在 CMake 中定义 BUILD_SHARED_LIBS 全局变量,并设置为 OFF。调用 add_library() 并省略第二个参数,将构建一个静态库:

set(BUILD_SHARED_LIBS OFF)

然后,引入一个变量 _sources,包括 Message.hpp 和 Message.cpp:

list(APPEND _sources Message.hpp Message.cpp)

再引入一个基于 USE_LIBRARY 值的 if-else 语句。如果逻辑为真,则 Message.hpp 和 Message.cpp 将打包成一个库:

if(USE_LIBRARY)
  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()

我们可以再次使用相同的命令集进行构建。由于 USE_LIBRARY 为 OFF,hello-world 可执行文件将使用所有源文件来编译,可以通过在 GNU/Linux 上运行 objdump -x 命令进行验证。

工作原理

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

  • 如果将逻辑变量设置为以下任意一种:1、ON、YES、true、Y 或非零数,则该变量为真;
  • 如果将逻辑变量设置为以下任意一种:0、OFF、NO、false、N、IGNORE、NOTFOUND、空字符串,或者以 -NOTFOUND 为后缀,则该变量为假。

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

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

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

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

系列导航


   转载规则


《CMake 系列(四):用条件控制编译》 由 吴杭沉 采用 知识共享署名 4.0 国际许可协议 进行许可。
 上一篇
CMake 系列(五):指定编译器 CMake 系列(五):指定编译器
前面的示例中,我们还没有过多考虑如何选择编译器。CMake 可以根据平台和生成器选择编译器,还能将编译器标志设置为默认值。然而,我们通常希望能够控制编译器的选择。后面的示例中,我们还将考虑构建类型的选择,并展示如何控制编译器标志。 提示:
2022-04-12
下一篇 
CMake 系列(三):构建和链接静态库与动态库 CMake 系列(三):构建和链接静态库与动态库
上一篇中,我们只用单个源文件构建可执行文件。实际项目中往往会有多个源文件,通常分布在不同子目录中。这种实践有助于理顺项目的源代码结构,支持模块化、代码重用和关注点分离,还可以简化并加速项目的重新编译。本篇将展示如何将源代码编译成库,以及如何
2022-03-29
  目录