CMAKE_LINK_LIBRARY_<FEATURE>_ATTRIBUTES¶
3.30 版本新增。
此变量定义了指定的链接库 <FEATURE>
的行为。它指定了 <FEATURE>
如何与其他特性进行交互,应何时应用 <FEATURE>
,以及当 CMake 组装最终链接器命令行时 <FEATURE>
应如何处理的方面(例如,去重)。
链接标志的语法 <FEATURE>
由 CMAKE_<LANG>_LINK_LIBRARY_USING_<FEATURE>
和 CMAKE_LINK_LIBRARY_USING_<FEATURE>
变量控制。 CMAKE_<LANG>_LINK_LIBRARY_USING_<FEATURE>_SUPPORTED
和 CMAKE_LINK_LIBRARY_USING_<FEATURE>_SUPPORTED
变量控制 <FEATURE>
是否可用。
当为特定语言 <LANG>
进行链接时,如果 CMAKE_<LANG>_LINK_LIBRARY_<FEATURE>_ATTRIBUTES
变量也为相同的 <FEATURE>
定义,则 CMAKE_LINK_LIBRARY_<FEATURE>_ATTRIBUTES
将被忽略。
在定义目标的目录作用域结束时,CMAKE_LINK_LIBRARY_<FEATURE>_ATTRIBUTES
和 CMAKE_<LANG>_LINK_LIBRARY_<FEATURE>_ATTRIBUTES
的值是至关重要的。
特性属性定义¶
特性属性定义是一个 分号分隔的列表,包含 attribute=value(s)
条目。如果一个属性有多个值,则这些值必须用逗号分隔。
支持以下属性
LIBRARY_TYPE=<library-type-list>
指定特性支持的库类型。支持的值为:
STATIC
、SHARED
、MODULE
和EXECUTABLE
。如果未指定此属性,则默认为
LIBRARY_TYPE=STATIC,SHARED,MODULE,EXECUTABLE
。如果特性与不支持的库类型一起使用,CMake 将发出开发者警告,并且该特性将被忽略。
OVERRIDE=<feature-list>
指定当发生冲突时,此特性会替换哪些特性。此覆盖机制被
LINK_LIBRARY_OVERRIDE
或LINK_LIBRARY_OVERRIDE_<LIBRARY>
目标属性定义(如果已定义)所覆盖。如果未指定此属性,则默认为空列表。
DEDUPLICATION=YES|NO|DEFAULT
指定使用此特性的库的去重策略。
是
库始终会被去重。CMake 通常应用的默认策略将被忽略。
否
库永远不会被去重。CMake 通常应用的默认策略将被忽略。
DEFAULT
让 CMake 自动确定去重策略。
如果未指定此属性,则将使用
DEFAULT
。
示例¶
一个常见的需求是在创建共享库时加载整个归档文件。内置的 WHOLE_ARCHIVE
特性可用于此目的。该内置特性的实现设置了以下链接库特性属性:
set(CMAKE_LINK_LIBRARY_WHOLE_ARCHIVE_ATTRIBUTES
LIBRARY_TYPE=STATIC
OVERRIDE=DEFAULT
DEDUPLICATION=YES
)
LIBRARY_TYPE=STATIC
此特性仅对静态库有意义。
OVERRIDE=DEFAULT
由于
DEFAULT
特性和WHOLE_ARCHIVE
特性是兼容的并且能提升用户体验,因此WHOLE_ARCHIVE
特性将覆盖DEFAULT
特性:可以自由使用标准的库规范和$<LINK_LIBRARY:WHOLE_ARCHIVE>
。DEDUPLICATION=YES
当使用此特性时,链接器会加载静态库中的所有符号,因此无需在链接器命令行中重复指定该库。
可以这样使用 WHOLE_ARCHIVE
特性:
add_library(A STATIC ...)
add_library(B STATIC ...)
target_link_libraries(B PUBLIC A)
target_link_libraries(A PUBLIC B)
add_library(global SHARED ...)
target_link_libraries(global PRIVATE $<LINK_LIBRARY:WHOLE_ARCHIVE,A>)
生成的链接命令将只包含一个 A
库的实例,并且链接器标志将确保从 A
库加载所有符号。