1.6 指定编译器

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

目前为止,我们还没有过多考虑如何选择编译器。CMake可以根据平台和生成器选择编译器,还能将编译器标志设置为默认值。然而,我们通常控制编译器的选择。在后面的示例中,我们还将考虑构建类型的选择,并展示如何控制编译器标志。

具体实施

如何选择一个特定的编译器?例如,如果想使用Intel或Portland Group编译器怎么办?CMake将语言的编译器存储在CMAKE_<LANG>_COMPILER变量中,其中<LANG>是受支持的任何一种语言,对于我们的目的是CXXCFortran。用户可以通过以下两种方式之一设置此变量:

  1. 使用CLI中的-D选项,例如:

    1. $ cmake -D CMAKE_CXX_COMPILER=clang++ ..
  2. 通过导出环境变量CXX(C++编译器)、CC(C编译器)和FC(Fortran编译器)。例如,使用这个命令使用clang++作为C++编译器:

    1. $ env CXX=clang++ cmake ..

到目前为止讨论的示例,都可以通过传递适当的选项,配置合适的编译器。

NOTE:CMake了解运行环境,可以通过其CLI的-D开关或环境变量设置许多选项。前一种机制覆盖后一种机制,但是我们建议使用-D显式设置选项。显式优于隐式,因为环境变量可能被设置为不适合(当前项目)的值。

我们在这里假设,其他编译器在标准路径中可用,CMake在标准路径中执行查找编译器。如果不是这样,用户将需要将完整的编译器可执行文件或包装器路径传递给CMake。

TIPS:我们建议使用-D CMAKE_<LANG>_COMPILERCLI选项设置编译器,而不是导出CXXCCFC。这是确保跨平台并与非POSIX兼容的唯一方法。为了避免变量污染环境,这些变量可能会影响与项目一起构建的外部库环境。

工作原理

配置时,CMake会进行一系列平台测试,以确定哪些编译器可用,以及它们是否适合当前的项目。一个合适的编译器不仅取决于我们所使用的平台,还取决于我们想要使用的生成器。CMake执行的第一个测试基于项目语言的编译器的名称。例如,cc是一个工作的C编译器,那么它将用作C项目的默认编译器。GNU/Linux上,使用Unix Makefile或Ninja时, GCC家族中的编译器很可能是C++CFortran的默认选择。Microsoft Windows上,将选择Visual Studio中的C++C编译器(前提是Visual Studio是生成器)。如果选择MinGW或MSYS Makefile作为生成器,则默认使用MinGW编译器。

更多信息

我们的平台上的CMake,在哪里可以找到可用的编译器和编译器标志?CMake提供--system-information标志,它将把关于系统的所有信息转储到屏幕或文件中。要查看这个信息,请尝试以下操作:

  1. $ cmake --system-information information.txt

文件中(本例中是information.txt)可以看到CMAKE_CXX_COMPILERCMAKE_C_COMPILERCMAKE_Fortran_COMPILER的默认值,以及默认标志。我们将在下一个示例中看到相关的标志。

CMake提供了额外的变量来与编译器交互:

  • CMAKE_<LANG>_COMPILER_LOADED:如果为项目启用了语言<LANG>,则将设置为TRUE
  • CMAKE_<LANG>_COMPILER_ID:编译器标识字符串,编译器供应商所特有。例如,GCC用于GNU编译器集合,AppleClang用于macOS上的Clang, MSVC用于Microsoft Visual Studio编译器。注意,不能保证为所有编译器或语言定义此变量。
  • CMAKE_COMPILER_IS_GNU<LANG>:如果语言<LANG>是GNU编译器集合的一部分,则将此逻辑变量设置为TRUE。注意变量名的<LANG>部分遵循GNU约定:C语言为CC, C++语言为CXX, Fortran语言为G77
  • CMAKE_<LANG>_COMPILER_VERSION:此变量包含一个字符串,该字符串给定语言的编译器版本。版本信息在major[.minor[.patch[.tweak]]]中给出。但是,对于CMAKE_<LANG>_COMPILER_ID,不能保证所有编译器或语言都定义了此变量。

我们可以尝试使用不同的编译器,配置下面的示例CMakeLists.txt。这个例子中,我们将使用CMake变量来探索已使用的编译器(及版本):

  1. cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
  2. project(recipe-06 LANGUAGES C CXX)
  3. message(STATUS "Is the C++ compiler loaded? ${CMAKE_CXX_COMPILER_LOADED}")
  4. if(CMAKE_CXX_COMPILER_LOADED)
  5. message(STATUS "The C++ compiler ID is: ${CMAKE_CXX_COMPILER_ID}")
  6. message(STATUS "Is the C++ from GNU? ${CMAKE_COMPILER_IS_GNUCXX}")
  7. message(STATUS "The C++ compiler version is: ${CMAKE_CXX_COMPILER_VERSION}")
  8. endif()
  9. message(STATUS "Is the C compiler loaded? ${CMAKE_C_COMPILER_LOADED}")
  10. if(CMAKE_C_COMPILER_LOADED)
  11. message(STATUS "The C compiler ID is: ${CMAKE_C_COMPILER_ID}")
  12. message(STATUS "Is the C from GNU? ${CMAKE_COMPILER_IS_GNUCC}")
  13. message(STATUS "The C compiler version is: ${CMAKE_C_COMPILER_VERSION}")
  14. endif()

注意,这个例子不包含任何目标,没有要构建的东西,我们只关注配置步骤:

  1. $ mkdir -p build
  2. $ cd build
  3. $ cmake ..
  4. ...
  5. -- Is the C++ compiler loaded? 1
  6. -- The C++ compiler ID is: GNU
  7. -- Is the C++ from GNU? 1
  8. -- The C++ compiler version is: 8.1.0
  9. -- Is the C compiler loaded? 1
  10. -- The C compiler ID is: GNU
  11. -- Is the C from GNU? 1
  12. -- The C compiler version is: 8.1.0
  13. ...

当然,输出将取决于可用和已选择的编译器(及版本)。