INTERFACE_LINK_LIBRARIES_DIRECT

在 3.24 版本中添加。

消费者应将此库视为直接链接依赖项的库列表。

此目标属性可以设置为包含依赖目标最终直接链接依赖项集中的项。有关排除项，请参阅 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 目标属性。

依赖目标的直接链接依赖项的初始集由其 LINK_LIBRARIES 目标属性指定。间接链接依赖项由直接链接依赖项的 INTERFACE_LINK_LIBRARIES 属性的传递闭包指定。任何链接依赖项都可以使用 INTERFACE_LINK_LIBRARIES_DIRECT 目标属性指定其他直接链接依赖项。然后，直接链接依赖项集将根据任何依赖项的 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 目标属性命名的项进行过滤。

INTERFACE_LINK_LIBRARIES_DIRECT 的值可能使用 生成器表达式。

注意

INTERFACE_LINK_LIBRARIES_DIRECT 目标属性适用于高级用例，例如将静态插件注入到消耗它的可执行文件中。它不应替代对 target_link_libraries() 的常规调用。

直接链接依赖项作为使用要求

INTERFACE_LINK_LIBRARIES_DIRECT 和 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 目标属性是 使用要求。它们的影响会传递给依赖目标，因此可以影响依赖库链中每个目标的直接链接依赖项。每当某个库目标 X 链接到另一个库目标 Y，而 Y 的直接或传递使用要求包含 INTERFACE_LINK_LIBRARIES_DIRECT 或 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 时，这些属性可能会影响 X 的直接链接依赖项列表。

• 如果 X 是共享库或可执行文件，则其依赖项将被链接。它们还会影响 X 的源文件编译时使用的使用要求。

• 如果 X 是静态库或对象库，则它实际上不会被链接，因此其依赖项最多只会影响 X 的源文件编译时使用的使用要求。

这些属性也可能影响 X 的依赖项的直接链接依赖项列表。

• 如果 X 公开链接 Y

  target_link_libraries(X PUBLIC Y)
  

  则 Y 会被放入 X 的 INTERFACE_LINK_LIBRARIES 中，因此 Y 的使用要求，包括 INTERFACE_LINK_LIBRARIES_DIRECT、INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 以及它们添加的直接链接依赖项声明的使用要求，都会传递给 X 的依赖项。

• 如果 X 是静态库或对象库，并且私有链接 Y

  target_link_libraries(X PRIVATE Y)
  

  则 $<LINK_ONLY:Y> 会被放入 X 的 INTERFACE_LINK_LIBRARIES 中。Y 的链接要求，包括 INTERFACE_LINK_LIBRARIES_DIRECT、INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 以及它们添加的直接链接依赖项声明的传递链接依赖项，都会传递给 X 的依赖项。但是，Y 的非链接使用要求会被 LINK_ONLY 生成器表达式阻止，不会传递给 X 的依赖项。

• 如果 X 是共享库或可执行文件，并且私有链接 Y

  target_link_libraries(X PRIVATE Y)
  

  则 Y 不会被放入 X 的 INTERFACE_LINK_LIBRARIES 中，因此 Y 的使用要求，即使是 INTERFACE_LINK_LIBRARIES_DIRECT 和 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE，也不会传递给 X 的依赖项。

• 在所有情况下，X 的 INTERFACE_LINK_LIBRARIES 的内容不受 Y 的 INTERFACE_LINK_LIBRARIES_DIRECT 或 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 的影响。

可以通过使用 TARGET_PROPERTY 生成器表达式来限制 INTERFACE_LINK_LIBRARIES_DIRECT 和 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 对依赖目标子集的影响。例如，要将影响限制在可执行目标，请使用以下形式的条目：

"$<$<STREQUAL:$<TARGET_PROPERTY:TYPE>,EXECUTABLE>:...>"

类似地，要将影响限制在特定目标，请使用以下形式的条目：

"$<$<BOOL:$<TARGET_PROPERTY:USE_IT>>:...>"

此条目仅会影响将 USE_IT 目标属性设置为真值的目标。

直接链接依赖项排序

目标的直接链接依赖项列表是从其 LINK_LIBRARIES 目标属性中的初始有序列表中计算得出的。对于每个项，都会从其直接和传递的 INTERFACE_LINK_LIBRARIES_DIRECT 使用要求中发现其他直接链接依赖项。每个发现的项都会在指定它的项之前注入。但是，发现的项最多只会添加一次，并且仅当它未出现在初始列表中任何位置时才会添加。这使得 LINK_LIBRARIES 可以控制它显式指定的直接链接依赖项的排序。

在收集完所有直接链接依赖项后，将从最终列表中删除所有在其 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 使用要求中命名的项。这不会影响剩余项的顺序。

示例：静态插件

考虑一个静态库 Foo，它为消耗它的应用程序可执行文件提供一个静态插件 FooPlugin，其中插件的实现依赖于 Foo 和其他内容。在这种情况下，应用程序应该直接链接到 FooPlugin，而不是 Foo。但是，应用程序作者只知道 Foo。我们可以这样表达：

# Core library used by other components.
add_library(Core STATIC core.cpp)

# Foo is a static library for use by applications.
# Implementation of Foo depends on Core.
add_library(Foo STATIC foo.cpp foo_plugin_helper.cpp)
target_link_libraries(Foo PRIVATE Core)

# Extra parts of Foo for use by its static plugins.
# Implementation of Foo's extra parts depends on both Core and Foo.
add_library(FooExtras STATIC foo_extras.cpp)
target_link_libraries(FooExtras PRIVATE Core Foo)

# The Foo library has an associated static plugin
# that should be linked into the final executable.
# Implementation of the plugin depends on Core, Foo, and FooExtras.
add_library(FooPlugin STATIC foo_plugin.cpp)
target_link_libraries(FooPlugin PRIVATE Core Foo FooExtras)

# An app that links Foo should link Foo's plugin directly.
set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT FooPlugin)

# An app does not need to link Foo directly because the plugin links it.
set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE Foo)

应用程序 app 只需要指定它链接到 Foo：

add_executable(app main.cpp)
target_link_libraries(app PRIVATE Foo)

Foo 上的 INTERFACE_LINK_LIBRARIES_DIRECT 目标属性告诉 CMake 假装 app 也直接链接到 FooPlugin。Foo 上的 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 目标属性告诉 CMake 假装 app 没有直接链接到 Foo。相反，Foo 将作为 FooPlugin 的依赖项进行链接。app 的最终链接行将按以下顺序链接库：

• FooPlugin 作为 app 的直接链接依赖项（通过 Foo 的使用要求）。

• FooExtras 作为 FooPlugin 的依赖项。

• Foo 作为 FooPlugin 和 FooExtras 的依赖项。

• Core 作为 FooPlugin、FooExtras 和 Foo 的依赖项。

请注意，如果没有 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 目标属性，Foo 将被链接两次：一次作为 app 的直接依赖项，一次作为 FooPlugin 的依赖项。

示例：选择加入静态插件

在上面的 示例：静态插件 中，app 可执行文件指定它直接链接到 Foo。在实际应用程序中，可能有一个中间库。

add_library(app_impl STATIC app_impl.cpp)
target_link_libraries(app_impl PRIVATE Foo)

add_executable(app main.cpp)
target_link_libraries(app PRIVATE app_impl)

在这种情况下，我们不希望 Foo 的 INTERFACE_LINK_LIBRARIES_DIRECT 和 INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE 目标属性影响 app_impl 的直接依赖项。为了避免这种情况，我们可以修改属性值使其效果是选择加入的：

# An app that links Foo should link Foo's plugin directly.
set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT
  "$<$<BOOL:$<TARGET_PROPERTY:FOO_STATIC_PLUGINS>>:FooPlugin>"
)

# An app does not need to link Foo directly because the plugin links it.
set_property(TARGET Foo PROPERTY INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE
  "$<$<BOOL:$<TARGET_PROPERTY:FOO_STATIC_PLUGINS>>:Foo>"
)

现在，app 可执行文件可以选择加入以获取 Foo 的插件：

set_property(TARGET app PROPERTY FOO_STATIC_PLUGINS 1)

app 的最终链接行将按以下顺序链接库：

• FooPlugin 作为 app 的直接链接依赖项（通过 Foo 的使用要求）。

• app_impl 作为 app 的直接链接依赖项。

• FooExtras 作为 FooPlugin 的依赖项。

• Foo 作为 app_impl、FooPlugin 和 FooExtras 的依赖项。

• Core 作为 FooPlugin、FooExtras 和 Foo 的依赖项。