开源应用架构（卷 1）
CMake

环境变量（或不使用）

在 1999 年甚至今天的许多构建系统中，在项目的构建过程中使用 shell 级环境变量。项目通常有一个 PROJECT_ROOT 环境变量，指向源树根目录的位置。环境变量还用于指向可选的或外部的软件包。这种方法的问题在于，为了使构建正常工作，每次执行构建时都需要设置所有这些外部变量。为了解决此问题，CMake 有一个缓存文件，用于在一个位置存储构建所需的所有变量。这些不是 shell 或环境变量，而是 CMake 变量。第一次为特定构建树运行 CMake 时，它会创建一个 CMakeCache.txt 文件，其中存储该构建的所有持久变量。由于该文件是构建树的一部分，因此在每次运行期间，变量始终可用于 CMake。

配置步骤

在配置步骤期间，CMake 首先读取先前运行中存在的 CMakeCache.txt（如果存在）。然后它读取 CMakeLists.txt，该文件位于提供给 CMake 的源树的根目录中。在配置步骤期间，CMakeLists.txt 文件由 CMake 语言解析器解析。文件中找到的每个 CMake 命令都由命令模式对象执行。在此步骤期间，可以通过 include 和 add_subdirectory CMake 命令解析其他 CMakeLists.txt 文件。CMake 针对可在 CMake 语言中使用的每个命令都有一个 C++ 对象。一些命令示例包括 add_library、if、add_executable、add_subdirectory 和 include。实际上，CMake 的整个语言都实现为对命令的调用。解析器只是将 CMake 输入文件转换为命令调用和作为命令参数的字符串列表。

配置步骤从本质上“运行”用户提供的 CMake 代码。在所有代码执行完毕且所有缓存变量值都已计算后，CMake 就会拥有要构建的项目的内存表示。这将包括所有库、可执行文件、自定义命令以及创建所选生成器的最终构建文件所需的所有其他信息。此时，CMakeCache.txt 文件将保存到磁盘，以便在将来运行 CMake 时使用。

项目的内存表示是一组目标的集合，目标仅仅是可以构建的事物，例如库和可执行文件。CMake 还支持自定义目标：用户可以定义其输入和输出，并提供在构建时要运行的自定义可执行文件或脚本。CMake 将每个目标存储在 cmTarget 对象中。这些对象依次存储在 cmMakefile 对象中，cmMakefile 对象基本上是源代码树中给定目录中找到的所有目标的存储位置。最终结果是包含 cmTarget 对象映射的 cmMakefile 对象树。

生成步骤

完成配置步骤后，即可进行生成步骤。生成步骤是 CMake 为用户选择的目标构建工具创建构建文件的时间。此时，目标（库、可执行文件、自定义目标）的内部表示将转换为 IDE 构建工具（如 Visual Studio）的输入，或转换为由 make 执行的一组 Makefile。CMake 在配置步骤后的内部表示尽可能通用，以便可以在不同的构建工具之间共享尽可能多的代码和数据结构。

可以在图 5.1中看到该过程的概述。

图 5.1：CMake 过程概述

CMake 对象

CMake 是一个面向对象的系统，使用了继承、设计模式和封装。主要 C++ 对象及其关系可以在图 5.2中看到。

图 5.2：CMake 对象

每个 CMakeLists.txt 文件的解析结果都存储在 cmMakefile 对象中。除了存储有关目录的信息外，cmMakefile 对象还控制 CMakeLists.txt 文件的解析。解析函数调用一个使用基于 lex/yacc 的解析器来解析 CMake 语言的对象。由于 CMake 语言语法变化很少，并且并非所有 CMake 构建系统所在的系统都提供 lex 和 yacc，因此 lex 和 yacc 输出文件会被处理并存储在 Source 目录下，与所有其他手写文件一起进行版本控制。

CMake 中另一个重要的类是 cmCommand。它是 CMake 语言中所有命令实现的基类。每个子类不仅提供命令的实现，还提供其文档。例如，请参阅 cmUnsetCommand 类上的文档方法。

virtual const char* GetTerseDocumentation()
{
    return "Unset a variable, cache variable, or environment variable.";
}

/**
 * More documentation.
 */

virtual const char* GetFullDocumentation()
{
    return
      "  unset(<variable> [CACHE])\n"
      "Removes the specified variable causing it to become undefined.  "
      "If CACHE is present then the variable is removed from the cache "
      "instead of the current scope.\n"
      "<variable> can be an environment variable such as:\n"
      "  unset(ENV{LD_LIBRARY_PATH})\n"
      "in which case the variable will be removed from the current "
      "environment.";
}

依赖项分析

CMake 具有强大的内置依赖项分析功能，可以用于单个 Fortran、C 和 C++ 源代码文件。由于集成开发环境 (IDE) 支持并维护文件依赖项信息，因此 CMake 会为这些构建系统跳过此步骤。对于 IDE 构建，CMake 会创建一个本机 IDE 输入文件，并让 IDE 处理文件级别的依赖项信息。目标级别的依赖项信息将转换为 IDE 用于指定依赖项信息的格式。

对于基于 Makefile 的构建，本机 make 程序不知道如何自动计算和保持依赖项信息是最新的。对于这些构建，CMake 会自动计算 C、C++ 和 Fortran 文件的依赖项信息。CMake 会自动完成这些依赖项的生成和维护。CMake 初次配置项目后，用户只需运行 make，CMake 就会完成其余工作。

尽管用户无需了解 CMake 如何完成这项工作，但查看项目的依赖项信息文件可能会有所帮助。每个目标的信息都存储在四个名为 depend.make、flags.make、build.make 和 DependInfo.cmake 的文件中。depend.make 存储目录中所有目标文件的依赖项信息。flags.make 包含用于此目标源文件的编译标志。如果它们发生更改，则将重新编译文件。DependInfo.cmake 用于保持依赖项信息最新，并包含有关哪些文件是项目的一部分以及它们使用哪种语言的信息。最后，构建依赖项的规则存储在 build.make 中。如果目标的依赖项已过时，则将重新计算该目标的依赖项信息，从而使依赖项信息保持最新。之所以这样做是因为 .h 文件的更改可能会添加新的依赖项。

CTest 和 CPack

在此过程中，CMake 从一个构建系统发展成为一个用于构建、测试和打包软件的工具系列。除了命令行 cmake 和 CMake GUI 程序之外，CMake 还附带了一个测试工具 CTest 和一个打包工具 CPack。CTest 和 CPack 与 CMake 共享相同的代码库，但它们是单独的工具，对于基本构建而言并非必需。

ctest 可执行文件用于运行回归测试。项目可以使用 add_test 命令轻松创建供 CTest 运行的测试。可以使用 CTest 运行测试，CTest 还可以用于将测试结果发送到 CDash 应用程序以在 Web 上查看。CTest 和 CDash 类似于 Hudson 测试工具。它们在一个主要方面有所不同：CTest 旨在允许更分布式的测试环境。可以设置客户端从版本控制系统中提取源代码、运行测试并将结果发送到 CDash。使用 Hudson，客户端机器必须允许 Hudson 通过 ssh 访问该机器，以便可以运行测试。

cpack 可执行文件用于为项目创建安装程序。CPack 的工作方式与 CMake 的构建部分非常相似：它与其他打包工具进行交互。例如，在 Windows 上，NSIS 打包工具用于从项目创建可执行安装程序。CPack 运行项目的安装规则以创建安装树，然后将其提供给像 NSIS 这样的安装程序。CPack 还支持创建 RPM、Debian .deb 文件、.tar、.tar.gz 和自解压 tar 文件。