吃透 CMake target_compile_features 和 target_compile_options：编译选项控制的艺术

在 CMake 的世界里，target_compile_features 和 target_compile_options 这两个命令扮演着至关重要的角色，它们如同精密的调音器，控制着你的 C++ 项目在不同编译器和标准下的行为。如果你也和我一样，希望能够深入理解 CMake 编译选项管理，打造更健壮、更灵活的项目，那么这篇文章绝对值得你花时间阅读。

为什么要关注编译选项？

想象一下，你开发了一个优秀的 C++ 库，希望它能在各种平台上顺利编译和运行。但是，不同的编译器对 C++ 标准的支持程度不同，对某些特性的实现也可能存在差异。如果没有一套有效的机制来管理编译选项，你的代码可能会在某些环境下出现意想不到的问题。更糟糕的是，你可能需要编写大量的平台相关的代码，这会大大增加维护成本。

CMake 的 target_compile_features 和 target_compile_options 就是为了解决这些问题而生的。它们允许你以一种声明式的方式，指定目标（例如库或可执行文件）所需的编译特性和选项，CMake 会自动根据当前编译器和平台，生成相应的编译命令。

target_compile_features：声明你的 C++ 标准依赖

target_compile_features 命令用于声明目标所需的 C++ 标准特性。它的基本语法如下：

target_compile_features(<target>
  <PRIVATE|PUBLIC|INTERFACE>
  <feature1> [<feature2> ...]
  [<PRIVATE|PUBLIC|INTERFACE> <feature3> [<feature4> ...]]...)

• <target>：目标名称，例如你的库或可执行文件的名称。
• PRIVATE|PUBLIC|INTERFACE：指定特性的可见性。
  • PRIVATE：特性只对当前目标可见，不会传递给依赖于当前目标的其他目标。
  • PUBLIC：特性对当前目标和依赖于当前目标的其他目标都可见。
  • INTERFACE：特性只对依赖于当前目标的其他目标可见，不对当前目标生效。
• <feature1> [<feature2> ...]：一个或多个 C++ 标准特性。CMake 预定义了一系列特性名称，例如 cxx_auto_type（C++11 的 auto 类型推导）、cxx_nullptr（C++11 的 nullptr 关键字）等。你可以在 CMake 的官方文档中找到完整的特性列表。

一个简单的例子

假设你的项目使用了 C++11 的 auto 类型推导和 nullptr 关键字，你可以这样声明：

add_library(mylib ...)

target_compile_features(mylib
  PRIVATE cxx_auto_type cxx_nullptr)

这告诉 CMake，mylib 库需要支持 cxx_auto_type 和 cxx_nullptr 这两个特性。CMake 会自动检查当前编译器是否支持这些特性，如果不支持，CMake 会报错，防止你使用不支持的特性。

PUBLIC、PRIVATE 和 INTERFACE 的区别

理解 PUBLIC、PRIVATE 和 INTERFACE 的区别至关重要。让我们通过一个例子来说明：

假设你有一个库 mylib，它依赖于另一个库 thirdparty。mylib 的代码使用了 C++11 的 lambda 表达式，而 thirdparty 的代码不需要 C++11 特性。

add_library(mylib ...)
add_library(thirdparty ...)

target_compile_features(mylib
  PRIVATE cxx_lambda)

target_link_libraries(mylib thirdparty)

在这个例子中，我们使用 PRIVATE 关键字声明 mylib 库需要支持 cxx_lambda 特性。这意味着只有 mylib 库在编译时会启用 C++11 的 lambda 表达式支持，而 thirdparty 库不会受到影响。这是因为 thirdparty 库不需要 lambda 表达式，所以我们不需要为它启用 C++11 支持。

如果我们将 PRIVATE 改为 PUBLIC：

target_compile_features(mylib
  PUBLIC cxx_lambda)

这意味着 mylib 库和所有依赖于 mylib 库的其他目标都会启用 C++11 的 lambda 表达式支持。如果 thirdparty 库的代码与 C++11 不兼容，可能会导致编译错误。

INTERFACE 关键字则更加特殊。它用于指定只对依赖于当前目标的其他目标生效的特性。例如，假设你有一个头文件库，它只包含头文件，不包含任何实现代码：

add_library(myheaderlib INTERFACE)

target_compile_features(myheaderlib
  INTERFACE cxx_nullptr)

target_include_directories(myheaderlib
  INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/include)

在这个例子中，我们使用 INTERFACE 关键字声明 myheaderlib 库需要支持 cxx_nullptr 特性。这意味着只有使用了 myheaderlib 库的头文件的其他目标才会启用 C++11 的 nullptr 关键字支持，而 myheaderlib 库本身不会受到影响。这是因为 myheaderlib 库只包含头文件，不需要编译，所以我们不需要为它启用 C++11 支持。

target_compile_options：控制编译器的行为

target_compile_options 命令用于指定传递给编译器的选项。它的基本语法如下：

target_compile_options(<target>
  <PRIVATE|PUBLIC|INTERFACE>
  <option1> [<option2> ...]
  [<PRIVATE|PUBLIC|INTERFACE> <option3> [<option4> ...]]...)

• <target>：目标名称，例如你的库或可执行文件的名称。
• PRIVATE|PUBLIC|INTERFACE：指定选项的可见性，与 target_compile_features 命令中的含义相同。
• <option1> [<option2> ...]：一个或多个编译器选项。这些选项是编译器特定的，例如 -Wall（启用所有警告）、-O2（启用二级优化）等。你需要查阅编译器的官方文档，了解支持的选项。

一个例子

假设你希望在编译 mylib 库时启用所有警告，并启用二级优化，你可以这样声明：

add_library(mylib ...)

target_compile_options(mylib
  PRIVATE -Wall -O2)

这告诉 CMake，在编译 mylib 库时，需要将 -Wall 和 -O2 选项传递给编译器。CMake 会自动根据当前编译器，生成相应的编译命令。

编译器特定的选项

不同的编译器支持的选项可能不同。为了处理这种情况，CMake 提供了一种机制，允许你根据编译器类型，指定不同的选项。例如：

add_library(mylib ...)

target_compile_options(mylib
  PRIVATE
    $<$<CXX_COMPILER_ID:GNU>:-Wall -Wextra>
    $<$<CXX_COMPILER_ID:MSVC>:/W3 /WX>)

在这个例子中，我们使用了一个生成器表达式 $<$<CXX_COMPILER_ID:XXX>:YYY>。这个表达式的意思是，如果当前编译器是 XXX，则使用选项 YYY。CXX_COMPILER_ID 是一个 CMake 预定义的变量，它表示当前编译器的 ID。常用的编译器 ID 包括 GNU（GCC）、MSVC（Visual Studio）等。你可以查阅 CMake 的官方文档，了解完整的编译器 ID 列表。

在这个例子中，如果当前编译器是 GCC，则使用 -Wall 和 -Wextra 选项；如果当前编译器是 Visual Studio，则使用 /W3 和 /WX 选项。这样，你就可以根据不同的编译器，指定不同的选项，从而保证代码在各种平台上都能正确编译。

控制 C++ 标准版本

除了控制编译器的行为，target_compile_options 还可以用于控制 C++ 标准版本。例如：

add_library(mylib ...)

target_compile_options(mylib
  PRIVATE $<$<C_CXX_STANDARD:11>:-std=c++11>
  PRIVATE $<$<C_CXX_STANDARD:14>:-std=c++14>
  PRIVATE $<$<C_CXX_STANDARD:17>:-std=c++17>
  PRIVATE $<$<C_CXX_STANDARD:20>:-std=c++20>)

在这个例子中，我们使用了一个生成器表达式 $<$<C_CXX_STANDARD:XXX>:YYY>。这个表达式的意思是，如果当前 C++ 标准版本是 XXX，则使用选项 YYY。C_CXX_STANDARD 是一个 CMake 预定义的变量，它表示当前 C++ 标准版本。常用的 C++ 标准版本包括 11（C++11）、14（C++14）、17（C++17）、20（C++20）等。

在这个例子中，如果当前 C++ 标准版本是 11，则使用 -std=c++11 选项；如果当前 C++ 标准版本是 14，则使用 -std=c++14 选项，以此类推。这样，你就可以根据不同的 C++ 标准版本，指定不同的选项，从而保证代码在各种平台上都能正确编译。

最佳实践

• 尽量使用 target_compile_features 来声明 C++ 标准依赖。target_compile_features 更加清晰和易于维护，它可以帮助你避免使用不支持的特性。
• 只在必要时使用 target_compile_options。target_compile_options 更加灵活，但也更容易出错。只有当你需要控制编译器的特定行为时，才应该使用它。
• 使用 PRIVATE、PUBLIC 和 INTERFACE 关键字来控制选项的可见性。这可以帮助你避免不必要的依赖，并提高代码的可重用性。
• 使用生成器表达式来处理编译器特定的选项。这可以帮助你保证代码在各种平台上都能正确编译。
• 将编译选项集中管理。最好在一个地方定义所有的编译选项，例如在 CMakeLists.txt 文件的顶部。这可以提高代码的可读性和可维护性。

一个完整的例子

让我们通过一个完整的例子来演示如何使用 target_compile_features 和 target_compile_options：

cmake_minimum_required(VERSION 3.15)
project(MyProject)

# 设置 C++ 标准版本
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 添加一个库
add_library(mylib mylib.cpp)

# 声明 C++ 标准依赖
target_compile_features(mylib
  PRIVATE cxx_auto_type cxx_nullptr cxx_lambda)

# 指定编译器选项
target_compile_options(mylib
  PRIVATE -Wall -Wextra -O2
  PRIVATE $<$<CXX_COMPILER_ID:MSVC>:/W3 /WX>)

# 添加一个可执行文件
add_executable(myexe main.cpp)

# 链接库
target_link_libraries(myexe mylib)

在这个例子中，我们首先使用 cmake_minimum_required 命令指定 CMake 的最低版本。然后，我们使用 project 命令指定项目的名称。接下来，我们使用 set 命令设置 C++ 标准版本为 17，并要求编译器必须支持 C++17 标准。

然后，我们使用 add_library 命令添加一个名为 mylib 的库。我们使用 target_compile_features 命令声明 mylib 库需要支持 cxx_auto_type、cxx_nullptr 和 cxx_lambda 这三个 C++11 特性。我们使用 target_compile_options 命令指定编译器选项，包括 -Wall、-Wextra 和 -O2。我们还使用了一个生成器表达式，根据编译器类型，指定不同的选项。如果当前编译器是 Visual Studio，则使用 /W3 和 /WX 选项。

最后，我们使用 add_executable 命令添加一个名为 myexe 的可执行文件。我们使用 target_link_libraries 命令将 myexe 可执行文件链接到 mylib 库。

总结

target_compile_features 和 target_compile_options 是 CMake 中非常强大的命令，它们可以帮助你更好地管理编译选项，打造更健壮、更灵活的项目。希望这篇文章能够帮助你更好地理解这两个命令，并在你的项目中灵活运用它们。记住，掌握这些工具，你就能更好地控制你的代码，让它在各种环境下都能完美运行。

作为一名经验丰富的程序员，我深知编译选项管理的重要性。一个好的编译选项管理方案，可以大大提高代码的可维护性和可移植性。希望我的经验能够帮助你少走弯路，更快地掌握 CMake 的精髓。