1.2 切换生成器

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

CMake是一个构建系统生成器,可以使用单个CMakeLists.txt为不同平台上的不同工具集配置项目。您可以在CMakeLists.txt中描述构建系统必须运行的操作,以配置并编译代码。基于这些指令,CMake将为所选的构建系统(Unix Makefile、Ninja、Visual Studio等等)生成相应的指令。我们将在第13章中重新讨论生成器。

准备工作

CMake针对不同平台支持本地构建工具列表。同时支持命令行工具(如Unix Makefile和Ninja)和集成开发环境(IDE)工具。用以下命令,可在平台上找到生成器名单,以及已安装的CMake版本:

  1. $ cmake --help

这个命令的输出,将列出CMake命令行界面上所有的选项,您会找到可用生成器的列表。例如,安装了CMake 3.11.2的GNU/Linux机器上的输出:

  1. Generators
  2. The following generators are available on this platform:
  3. Unix Makefiles = Generates standard UNIX makefiles.
  4. Ninja = Generates build.ninja files.
  5. Watcom WMake = Generates Watcom WMake makefiles.
  6. CodeBlocks - Ninja = Generates CodeBlocks project files.
  7. CodeBlocks - Unix Makefiles = Generates CodeBlocks project files.
  8. CodeLite - Ninja = Generates CodeLite project files.
  9. CodeLite - Unix Makefiles = Generates CodeLite project files.
  10. Sublime Text 2 - Ninja = Generates Sublime Text 2 project files.
  11. Sublime Text 2 - Unix Makefiles = Generates Sublime Text 2 project files.
  12. Kate - Ninja = Generates Kate project files.
  13. Kate - Unix Makefiles = Generates Kate project files.
  14. Eclipse CDT4 - Ninja = Generates Eclipse CDT 4.0 project files.
  15. Eclipse CDT4 - Unix Makefiles= Generates Eclipse CDT 4.0 project files.

使用此示例,我们将展示为项目切换生成器是多么EASY

具体实施

我们将重用前一节示例中的hello-world.cppCMakeLists.txt。惟一的区别在使用CMake时,因为现在必须显式地使用命令行方式,用-G切换生成器。

  1. 首先,使用以下步骤配置项目:

    1. $ mkdir -p build
    2. $ cd build
    3. $ cmake -G Ninja ..
    4. -- The CXX compiler identification is GNU 8.1.0
    5. -- Check for working CXX compiler: /usr/bin/c++
    6. -- Check for working CXX compiler: /usr/bin/c++ -- works
    7. -- Detecting CXX compiler ABI info
    8. -- Detecting CXX compiler ABI info - done
    9. -- Detecting CXX compile features
    10. -- Detecting CXX compile features - done
    11. -- Configuring done
    12. -- Generating done
    13. -- Build files have been written to: /home/user/cmake-cookbook/chapter-01/recipe-02/cxx-exampl
  2. 第二步,构建项目:

    1. $ cmake --build .
    2. [2/2] Linking CXX executable hello-world

如何工作

与前一个配置相比,每一步的输出没什么变化。每个生成器都有自己的文件集,所以编译步骤的输出和构建目录的内容是不同的:

  • build.ninjarules.ninja:包含Ninja的所有的构建语句和构建规则。
  • CMakeCache.txt:CMake会在这个文件中进行缓存,与生成器无关。
  • CMakeFiles:包含由CMake在配置期间生成的临时文件。
  • cmake_install.cmake:CMake脚本处理安装规则,并在安装时使用。

cmake --build .ninja命令封装在一个跨平台的接口中。

更多信息

我们将在第13章中讨论可选生成器和交叉编译。

要了解关于生成器的更多信息,CMake官方文档是一个很好的选择: https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html