CMake（九）：生成器表达式

最新推荐文章于 2025-10-21 19:41:13 发布
原创 最新推荐文章于 2025-10-21 19:41:13 发布 · 4.2k 阅读 · 16 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#cmake

当运行CMake时，开发人员倾向于认为它是一个简单的步骤，需要读取项目的CMakeLists.txt文件，并生成相关的特定于生成器的项目文件集(例如Visual Studio解决方案和项目文件，Xcode项目，Unix Makefiles或Ninja输入文件)。然而，这涉及两个截然不同的步骤。当运行CMake时，输出日志的末尾通常看起来像这样:

-- Configuring done
-- Generating done
-- Build files have been written to: /some/path/build

​ 当CMake被调用时，它首先读取并处理源树顶部的CMakeLists.txt文件，包括它拉进来的任何其他文件。在执行命令、函数等时，创建项目的内部表示。这称为配置步骤。控制台日志的大部分输出都是在此阶段生成的，包括message()命令的任何内容。在configure步骤的末尾，–configure done消息被打印到日志中。

​ 一旦CMake完成了读取和处理CMakeLists.txt文件，它就会执行生成步骤。这是使用在配置步骤中构建的内部表示创建构建工具的项目文件的地方。在大多数情况下，开发人员倾向于忽略生成步骤，只是将其视为配置的最终结果。控制台日志几乎总是在配置步骤完成后立即显示–Generating done消息，所以这是可以理解的。但在某些情况下，将其分为两个不同的阶段尤为重要。

​ 考虑一个项目处理一个多配置的CMake生成器，如Xcode或Visual Studio。当读取CMakeLists.txt文件时，CMake并不知道要为哪个配置构建目标。这是一个多配置的设置，所以有不止一个选择(例如调试，发布，等等)。开发人员在构建时选择配置，在CMake完成之后。如果CMakeLists.txt文件想要做一些事情，比如将文件复制到与给定目标的最终可执行文件相同的目录中，这似乎会出现一个问题，因为该目录的位置取决于正在构建的配置。需要一些占位符来告诉CMake“对于正在构建的任何配置，使用最终可执行文件的目录”。

​ 这是生成器表达式提供的功能的一个主要示例。它们提供了一种对某些逻辑进行编码的方法，这些逻辑在配置时不会计算，而是推迟到项目文件被写入时的生成阶段。它们可以用来执行条件逻辑，输出字符串，提供关于构建的各个方面的信息，如目录、名称、平台细节等。它们甚至可以用于根据正在执行的构建或安装提供不同的内容。

9.1 简单的布尔逻辑

​ 生成器表达式不能在任何地方使用，但是在很多地方都支持它们。在CMake参考文档中，如果一个特定的命令或属性支持生成器表达式，文档中会提到它。随着时间的推移，支持生成器表达式的属性集已经扩展，一些CMake版本也扩展了支持的表达式集。项目应该确认，对于他们所需要的最小CMake版本，被修改的属性确实支持所使用的生成器表达式。

​ 使用语法$<…>指定一个生成器表达式，其中尖括号之间的内容可以采用几种不同的形式。很快就会清楚，一个基本特征是有条件地包含内容。下面是最基本的生成器表达式:

$<1:...>
$<0:...>
$<BOOL:...>

​ 对于$<1:…>，表达式的结果将是…部分，而对于$<0:…>，…部分将被忽略，表达式将产生一个空字符串。 $<BOOL:…>表达式可以用来将任何被CMake识别为布尔型假值的值转换为0，其他值转换为1。这些生成器表达式一起提供了一种简单而强大的方法来选择性地包含内容。还支持逻辑操作:

$<AND:expr[,expr...]>
$<OR:expr[,expr...]>
$<NOT:expr>

​ 每个expr的值预期为1或0。AND和OR表达式可以接受任意数量的逗号分隔参数，并提供相应的逻辑结果，而NOT只接受一个表达式，并将产生其参数的否定。因为AND、OR和NOT要求它们的表达式的值只能为0或1，所以考虑将这些表达式封装在$中，以强制对被认为是true或false的表达式进行更宽容的逻辑处理。

​ 在CMake 3.8及以后的版本中，IF -then-else逻辑也可以非常方便地用一个专用的$表达式来表达:

$<IF:expr,val1,val0>

​ 通常，expr的值必须为1或0。如果expr的值为1，则结果为val1;如果expr的值为0，则结果为val0。在CMake 3.8之前，等价的逻辑必须以以下更冗长的方式表示，需要给出两次表达式:

$<expr:val1>$<$<NOT:expr>:val0>

​ 生成器表达式可以嵌套，允许构造任意复杂度的表达式。上面的例子显示了一个嵌套的条件，但是生成器表达式的任何部分都可以嵌套。下面的例子演示了到目前为止所讨论的特性:

ExpressionResultNotes
$<1:foo>foo
$<0:foo>
$<true:foo>Error, not a 1 or 0
$<$<​BOOL:true>:foo>foo
$<$<​NOT:0>:foo>foo
$<$<NOT:1>:foo>
$<$<NOT:tree>:foo>fooError, NOT requires a 1 or 0
$<$<AND:1,0>:foo>
$<$<OR:1,0>:foo>foo
$<1:$<$<BOOL:false>:foo>>
$<IF:$<BOOL:${foo}>,yes,no>Result will be yes or no depending on ${foo}

​ 就像if()命令一样，CMake也支持在生成器表达式中测试字符串、数字和版本，尽管语法略有不同。如果满足各自的条件，下列所有项的值都为1，否则为0。

$<STREQUAL:string1,string2>
$<EQUAL:number1,number2>
$<VERSION_EQUAL:version1,version2>
$<VERSION_GREATER:version1,version2>
$<VERSION_LESS:version1,version2>

​ 另一个非常有用的条件表达式是测试构建类型:

$<CONFIG:arg>

​ 如果arg对应于实际正在构建的构建类型，那么它的值将为1，对于所有其他构建类型，它的值将为0。它的常用用途是仅为调试构建提供编译器标志，或者为不同的构建类型选择不同的实现。例如:

add_executable(myApp src1.cpp src2.cpp)
# Before CMake 3.8
target_link_libraries(myApp PRIVATE
  $<$<CONFIG:Debug>:checkedAlgo>
  $<$<NOT:$<CONFIG:Debug>>:fastAlgo>
)
# CMake 3.8 or later allows a more concise form
target_link_libraries(myApp PRIVATE
  $<IF:$<CONFIG:Debug>,checkedAlgo,fastAlgo>
)

​ 上面会将可执行文件链接到用于调试构建的checkedAlgo库，以及用于所有其他构建类型的fastAlgo库。$<CONFIG:…> 生成器表达式是健壮地提供这种功能的唯一方法，它适用于所有的CMake项目生成器，包括像Xcode或Visual Studio这样的多配置生成器。

​ CMake提供了更多的基于平台和编译器细节、CMake策略设置等的条件测试。开发人员应该查阅CMake参考文档，了解支持的条件表达式的完整集合。

9.2 目标的细节

​ 生成器表达式的另一个常见用途是提供关于目标的信息。目标的任何属性都可以通过以下两种形式之一获得:

$<TARGET_PROPERTY:target,property>
$<TARGET_PROPERTY:property>

​ 第一个表单提供来自指定目标的命名属性的值，而第二个表单将从使用生成器表达式的目标检索属性。

​ 虽然TARGET_PROPERTY是一种非常灵活的表达式类型，但它并不总是获取目标信息的最佳方式。例如，CMake还提供了其他表达式，它们提供了关于目标构建的二进制文件的目录和文件名的详细信息。这些更直接的表达式负责提取某些属性的部分或基于原始属性计算值。其中最常用的是TARGET_FILE生成器表达式集:

  • TARGET_FILE

    这将生成目标二进制文件的绝对路径和文件名，包括任何与平台相关的文件前缀和后缀(例如.exe， .dylib)。对于基于unix的平台，其中共享库的文件名中通常包含版本细节，这些也将包括在内。

  • TARGET_FILE_NAME

    与TARGET_FILE相同，但没有路径(也就是说，它只提供文件名部分)。

  • TARGET_FILE_DIR

    与TARGET_FILE相同，但没有文件名。这是获取构建最终可执行文件或库所在目录的最健壮的方式。当使用像Xcode或Visual Studio这样的多配置生成器时，它的价值对于不同的构建配置是不同的。

​ 上面的三个TARGET_FILE表达式在定义自定义构建规则以在构建后的步骤中复制文件时特别有用。除了TARGET_FILE表达式外，CMake还提供了一些特定于库的表达式，它们具有类似的作用，只是它们处理文件名前缀和/或后缀细节的方式略有不同。这些表达式的名称以TARGET_LINKER_FILE和TARGET_SONAME_FILE开头，通常不像TARGET_FILE表达式那样频繁使用。

​ 支持Windows平台的项目还可以获取关于给定目标的PDB文件的详细信息。同样，这些都可以在定制构建任务中使用。以TARGET_PDB_FILE开头的表达式遵循与TARGET_PROPERTY类似的模式，提供用于使用生成器表达式的目标的PDB文件的路径和文件名详细信息。

​ 另一个与目标相关的生成器表达式值得特别提及。CMake允许一个库目标被定义为一个对象库，这意味着它不是一个通常意义上的库，它只是一个对象文件的集合，CMake与目标关联，但实际上并不会创建一个最终的库文件。因为它们是目标文件，所以不能作为一个单元链接(尽管CMake 3.12放宽了这个限制)。相反，它们必须以添加源的相同方式添加到目标中。然后CMake在链接阶段包含这些对象文件，就像编译目标的源文件创建的对象文件一样。这是使用 $<TARGET_OBJECTS:…>生成器表达式完成的，它以适合add_executable()或add_library()使用的形式列出了对象文件。

# Define an object library
add_library(objLib OBJECT src1.cpp src2.cpp)
# Define two executables which each have their own source
# file as well as the object files from objLib
add_executable(app1 app1.cpp $<TARGET_OBJECTS:objLib>)
add_executable(app2 app2.cpp $<TARGET_OBJECTS:objLib>)

​ 在上面的例子中，没有为objLib创建单独的库，但是src1.cpp和src2.cpp源文件仍然只编译一次。对于某些构建来说，这可能更方便，因为它可以避免创建静态库的构建时间成本或动态库的符号解析的运行时成本，但仍然可以避免多次编译相同的源代码。

9.3 一般的信息

​ 生成器表达式可以提供关于目标以外的信息。可以获得有关正在使用的编译器、正在构建目标的平台、构建配置的名称等信息。这类表达式倾向于在更高级的情况下使用，例如处理自定义编译器或解决特定编译器或工具链的特定问题。这些表达式也会引起误用，因为它们似乎提供了一种方法来构造路径，而这些路径本可以通过更健壮的方法(如使用TARGET_FILE表达式或其他CMake特性)获得。在依赖更通用的信息生成器表达式作为解决问题的方法之前，开发人员应该仔细考虑。也就是说，有些表达确实有正当的用途。这里列出了一些更常见的表达式和一些实用程序表达式，作为进一步阅读的起点:

  • $<CONFIG>

    计算结果为生成类型。优先使用CMAKE_BUILD_TYPE变量，因为该变量不会在Xcode或Visual Studio等多配置项目生成器中使用。CMake的早期版本使用了现在已弃用的$<CONFIGURATION>表达式，但项目现在应该只使用$<CONFIG>。

  • $<PLATFORM_ID>

    标识正在为其构建目标的平台。这在交叉编译的情况下非常有用，特别是当一个构建可能支持多个平台(例如设备和模拟器构建)时。这个生成器表达式与CMAKE_SYSTEM_NAME变量密切相关，项目应该考虑在特定的情况下使用该变量是否会更简单。

  • $<C_COMPILER_VERSION>, $<CXX_COMPILER_VERSION>

    在某些情况下，只在编译器版本比某个特定版本旧或新时添加内容可能会有用。这可以通过 $<VERSION_???:…>生成器表达式。例如，如果c++编译器的版本小于4.2.0，要生成字符串OLD_COMPILER，可以使用以下表达式:

    $<$<VERSION_LESS:$<CXX_COMPILER_VERSION>,4.2.0>:OLD_COMPILER>

    这样的表达式往往只在以下情况下使用:已知编译器的类型，并且编译器的特定行为需要由项目以某种特殊的方式处理。在特定的情况下，它可能是一种有用的技术，但如果过于依赖这些表达式，它可能会降低项目的可移植性。

  • $<LOWER_CASE:…>, $<UPPER_CASE:…>

    任何内容都可以通过这些表达式转换为小写或大写。这在执行字符串比较之前是非常有用的。例如:

    $<STREQUAL:$<UPPER_CASE:${someVar}>,FOOBAR>

相关代码：https://gitee.com/jiangli01/cmake-learning
更多请关注微信公众号【Hope Hut】：
在这里插入图片描述

CMake基础教程：生成器表达式在嵌入式系统中的应用
CyberBytezZ的博客
09-12 130
生成器表达式是CMake中一种特殊的语法，用于在构建过程中根据条件生成不同的构建规则。它能够根据当前的构建配置、目标平台和其他上下文信息来动态地生成构建参数。生成器表达式通常用在CMake的命令中，例如和等。
cmake生成器表达式
我的博客
11-13 794
CMake生成器表达式语法是为了在构建过程中灵活地指定和操作构建目标的属性和参数。生成器表达式通常在CMakeLists.txt文件中的某些指令或命令中使用，常见的场景包括等。
CMake之生成器表达式
u010378559的博客
05-08 1904
cmake生成器使用总结
CMake进阶：生成器表达式
最新发布
红军不怕远征难，万水千山只等闲
10-21 846
CMake生成器表达式是CMake 3.0+引入的高级特性，用于在生成构建系统时动态计算值，而非配置阶段。它支持多配置构建（如VS的Debug/Release）、跨平台适配和目标类型区分等场景，通过条件表达式、字符串操作和目标相关表达式实现灵活配置。核心语法为$<条件:真结果;假结果>，支持构建配置判断、平台识别、目标类型区分等操作。使用注意事项包括版本兼容性、适用范围限制和调试技巧。掌握生成器表达式可显著提升CMake脚本的动态配置能力，特别适合复杂跨平台项目。
CMake应用：生成器表达式
老狼的专栏
11-29 1944
目录 一 概述 二 常用的生成器表达式 1 布尔生成器表达式 2 字符串值生成器表达式 3 调试 CMake的生成器表达式不算是特别常用，但是有一些场景可能是必须要使用的；或者在针对不同编译类型设置不同编译参数的时候可以巧妙应用，从而减少配置代码。 生成器表达式听起来稍微有点复杂，但是其实只需要掌握一些常用的功能就能够有所裨益，至于更加复杂的写法，在需要的时候研究一下即可。本文主要介绍下生成器表达式的概念、种类、和常用的一些生成器表达
CMake I 生成器表达式
该用户还没想到好的昵称的博客
02-17 2954
bool生成器表达式、字符串值生成器表达式。
CMake 生成器表达式介绍
梦起丶的博客
10-28 1185
生成器表达式在构建系统生成期间进行评估，以生成特定于每个构建配置的信息。它们的形式为$。
CMake-官方教程(4)-生成器表达式-Adding Generator Expressions
mrbone11的博客
01-04 809
cmake构建分为config和build阶段，生成器表达式的值在build阶段才得到。生成器表达式可用于根据某些条件设置某些变量和编译选项。
精选资源
构建魔法：CMake中生成器表达式的深度解析
07-26
### 构建魔法：CMake 中生成器表达式的深度解析 CMake 作为一种跨平台的构建工具，在软件开发领域有着举足轻重的地位。它通过 CMakeLists.txt 文件定义项目的构建逻辑，支持多种编程语言，尤其对 C++ 的支持非常...
CMake-4：生成器表达式【简化cmake的多版本配置语法】【编译期间动态改变代码】
u013250861的博客
06-06 150
【代码】CMake-4：生成器表达式【简化cmake的多版本配置语法】【编译期间动态改变代码】
CMake生成器表达式用法解析
我的博客
07-23 1181
在CMake中，使用了，这是一种在CMake生成构建系统（如Makefile或Ninja文件）时动态求值的特殊语法。
CMake--生成器表达式（Generator Expressions） 的完整解析
weixin_45590420的博客
06-11 458
CMake生成器表达式解析与应用 生成器表达式（$<...>）是CMake在生成构建系统时动态求值的工具，用于根据平台、配置等条件灵活控制编译选项、路径和属性。核心分类包括： 条件表达式（如$<IF:cond,T,F>, $<CONFIG:Debug>）实现逻辑判断； 目标属性查询（如$<TARGET_PROPERTY:lib,INCLUDES>）动态获取构建信息； 路径处理（如$<TARGET_FILE:app>）跨平台兼容； 字符串操作（如$&
cmake生成表达式
feng__shuai的博客
12-08 772
不积小流，无以成江海。
CMake教程（四）：生成器表达式
聚焦C++/Python编程语言、大模型应用开发
09-19 575
本文主要介绍了CMake当中生成器表达式的基本用法。
cmake中的生成表达式
guohw
07-18 775
cmake中的生成表达式。
【CMake】CMake入门（四）生成器表达式 安装与测试 系统特性检测 自定义命令以及输出文件
一点一点变好
05-31 1677
CTest是CMake的测试工具，它可以自动化运行单元测试，收集测试结果并生成报告。使用方式根目录加。使用add_test添加测试。使用添加测试的属性# 用法 关键字 测试名称 关键字 执行的命令 参数# 示例# 用法 测试名称 关键字 属性 值# 示例这里PROPERTIES可以设置的参数有很多，这里设置的表示以正则表达式进行匹配结果。在Linux中，有许多的工具命令，例如lsmvmkdir等。
cmake基础教程（40）生成器表达式
二进制君
08-21 1556
生成器表达式简单来说就是在CMake生成构建系统的时候根据不同配置动态生成特定的内容。条件链接，如针对同一个编译目标，debug版本和release版本链接不同的库文件条件定义，如针对不同编译器，定义不同的宏所以可以看到，其中的要点是条件，之所以需要自动生成，那绝大多数时候肯定是因为开发者无法提前确定某些配置，不能提前确定那往往就是有条件的。生成器表达式的格式形如$，可以嵌套，可以用在很多构建目标的属性设置和特定的CMake命令中。
CMake —— CODE ::cmake生成器（二）
xiaodouhao123456的博客
01-27 342
在CMake 2.8.3平台上，CMake支持下列生成器： Borland Makefiles: 生成Borland makefile。 MSYS Makefiles: 生成MSYS makefile。 生成的makefile用use /bin/sh作为它的shell。在运行CMake的机器上需要安装msys。 MinGW Makefiles: 生成供mingw32-make使用的make file。 生成的makefile使用cmd.exe作为它的shell。生成它们不需要msys或者unix
CMake教程-第 4 步：添加生成器表达式
天使之翼
09-26 1210
CMake 教程提供了一个循序渐进的指南，涵盖了 CMake 可帮助解决的常见构建系统问题。在一个示例项目中了解各个主题是如何协同工作的，会非常有帮助。
cmake 生成器表达式的返回值
06-12
<think>嗯，用户这次想了解CMake生成器表达式的返回值和用途，而且特别提到要参考之前的回答和引用材料。看来用户是在深入学习CMake的高级特性，可能正在处理实际的跨平台构建问题。翻看对话历史，我之前已经详细解释过生成器表达式的作用原理和典型场景，包括条件化配置、避免属性外溢等核心功能。用户现在聚焦在“返回值”这个具体层面，说明ta需要更精确的技术细节。注意到系统指令要求严格的数学公式格式（虽然CMake内容基本用不到LaTeX数学公式），但需要在示例代码中谨慎处理符号转义。用户提供的四个引用材料里，[1][2][3]是CMake官方资源，[4]虽然关于LLVM但展示了AST处理思路，可以类比生成器表达式的解析过程。用户可能遇到的实际问题是：为什么表达式在某些条件下返回空值？或者如何组合多个表达式返回值？尤其需要强调两类返回类型：1）布尔表达式在条件不满足时实际上返回空字符串（相当于false），例如$<CONFIG:Debug>在Release模式下会展开为空2）路径表达式在不同生成器下返回值差异，比如$<TARGET_FILE>在Windows返回.exe，而Linux无扩展名特别要解释清楚“返回值的延迟性”——所有生成器表达式在configure阶段都是未展开的字符串，直到generate阶段才变成具体值。这正好对应引用[2]提到的cmake命令工作流程。在回答结构上，应该先分类返回值类型（布尔/字符串/调试），再分别说明各类的转换规则和典型用途。对于用户可能困惑的点，比如为何布尔表达式不直接返回true/false，而用1/空值，要结合CMake的设计哲学解释（兼容各构建系统语法）。最后生成的相关问题要引导用户走向更深入的应用场景，比如返回值在install规则中的特殊处理（引用[1]的OpenCV项目就大量使用这类技巧）。</think> CMake生成器表达式（Generator Expressions）在生成构建系统时**动态计算并返回字符串或布尔值**，其返回值类型和用途如下： --- ### 一、返回值的两种类型 1. **字符串类型** ```cmake $<TARGET_FILE_BASE_NAME:myapp> # 返回"myapp"(不含扩展名)[^1] $<PLATFORM_ID> # 返回当前平台ID，如"Linux"、"Windows" ``` **用途**：动态生成路径、编译器选项、文件名等，例如： ```cmake set(output_name "$<TARGET_FILE_NAME:app>$<CONFIG:DEBUG>:_debug>") # Release模式返回"app", Debug模式返回"app_debug" ``` 2. **布尔类型（0/1）** ```cmake $<CONFIG:Debug> # Debug模式下返回1，否则0 $<CXX_COMPILER_ID:GNU> # GCC编译器返回1，否则0 ``` **用途**：条件化控制编译逻辑，例如： ```cmake target_compile_options(app PRIVATE "$<$<CONFIG:DEBUG>:-O0;-g>" # 仅Debug模式添加调试选项 ) ``` --- ### 二、核心应用场景 #### 1. 跨平台路径处理 ```cmake install(TARGETS app DESTINATION bin/$<PLATFORM_ID>) # 安装到bin/Linux或bin/Win64[^2] ``` #### 2. 编译器差异化配置 ```cmake target_compile_definitions(app PRIVATE "$<$<CXX_COMPILER_ID:MSVC>:_CRT_SECURE_NO_WARNINGS>" "$<$<CXX_COMPILER_ID:GNU>:USE_GNU_EXTENSIONS>" ) ``` #### 3. 构建/安装路径隔离 ```cmake target_include_directories(app PUBLIC "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>" # 构建时使用源码目录 "$<INSTALL_INTERFACE:include>" # 安装后使用系统目录[^1] ) ``` #### 4. 目标间依赖传递 ```cmake add_custom_command(TARGET app POST_BUILD COMMAND $<TARGET_FILE:test_runner> verify_app # 动态获取test_runner路径[^3] ) ``` --- ### 三、特殊返回规则 1. **嵌套表达式** ```cmake "$<$<AND:$<CONFIG:DEBUG>,$<PLATFORM_ID:Linux>>:-fsanitize=address>" # 仅在Linux+Debug时返回-fsanitize=address ``` 2. **空值处理** 条件不满足时返回空字符串，避免语法错误： ```cmake "$<$<PLATFORM_ID:Darwin>:-framework CoreFoundation>" # 非macOS返回空 ``` > 表达式在`cmake --build`阶段展开（非configure阶段），可通过`cmake -E echo "表达式"`验证返回值[^2]。 --- ### 四、典型示例分析 ```cmake set(EXTENSION "$<$<PLATFORM_ID:Windows>:.exe>") add_executable(app main.cpp) set_target_properties(app PROPERTIES SUFFIX $<CONFIG>_${EXTENSION} # Release模式返回".exe"，Debug返回"_DEBUG.exe" ) ``` - **Windows+Release** → `.exe` - **Windows+Debug** → `_DEBUG.exe` - **Linux+Release** → 空后缀 ---
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值