export¶

导出目标或包，以便外部项目直接从当前项目的构建树中使用它们，而无需安装。

请参阅 install(EXPORT) 命令，从安装树导出目标。

概要¶

export(TARGETS <target>... [...])
export(EXPORT <export-name> [...])
export(PACKAGE <PackageName>)
export(SETUP <export-name> [...])

导出目标¶

export(TARGETS <target>... [...])¶

export(TARGETS <target>... [NAMESPACE <namespace>]
       [APPEND] FILE <filename> [EXPORT_LINK_INTERFACE_LIBRARIES]
       [CXX_MODULES_DIRECTORY <directory>])

创建一个文件 <filename>，外部项目可以包含该文件，以便从当前项目的构建树中导入由 <target>... 命名的目标。这在交叉编译期间非常有用，可以在一个项目中构建可在主机平台上运行的实用程序可执行文件，然后将它们导入到为目标平台编译的另一个项目中。

此命令创建的文件特定于构建树，绝不应安装。请参阅 install(EXPORT) 命令，从安装树导出目标。

选项包括

NAMESPACE <namespace>: 将 <namespace> 字符串前置到写入文件的所有目标名称。
APPEND: 追加到文件而不是覆盖它。这可以用于将多个目标增量导出到同一文件。
EXPORT_LINK_INTERFACE_LIBRARIES: 在导出中包含以模式 (IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? 命名的属性的内容，即使策略 CMP0022 为 NEW 时也是如此。这对于支持使用 CMake 版本低于 2.8.12 的消费者很有用。
CXX_MODULES_DIRECTORY <directory>: 在 3.28 版本中添加。

将 C++ 模块属性导出到给定目录下的文件中。每个文件将根据目标的导出名称（不带任何命名空间）命名。这些文件将自动从导出文件中包含。

此签名要求显式列出所有目标。如果导出中包含库目标，但未包含链接到它的目标，则行为未指定。请参阅 export(EXPORT) 签名，以自动从构建树中导出与 install(EXPORT) 从安装树中导出的目标相同的目标。

注意

对象库在 Xcode 下，如果在 CMAKE_OSX_ARCHITECTURES 中列出了多个架构，则具有特殊处理。在这种情况下，它们将导出为接口库，客户端无法使用对象文件。这足以满足链接到其实现中对象库的其他目标的传递使用要求。

此命令从构建树导出所有构建配置。请参阅 CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> 变量，以将依赖项目的配置映射到导出的配置。

将目标导出到 Android.mk¶

export(TARGETS <target>... ANDROID_MK <filename>)

在 3.7 版本中添加。

此签名通过创建引用预构建目标的 Android.mk 文件，将 cmake 构建的目标导出到 android ndk 构建系统。Android NDK 支持使用预构建库，包括静态库和共享库。这允许 cmake 构建项目的库，并使它们可用于 ndk 构建系统，其中包含使用这些库所需的传递依赖项、包含标志和定义。此签名接受目标列表，并将它们放入由给定的 <filename> 指定的 Android.mk 文件中。仅当所有给定目标的策略 CMP0022 为 NEW 时，才能使用此签名。如果其中一个目标的策略设置为 OLD，则会发出错误。

导出与 install(EXPORT) 匹配的目标¶

export(EXPORT <export-name> [...])

export(EXPORT <export-name> [NAMESPACE <namespace>] [FILE <filename>]
       [CXX_MODULES_DIRECTORY <directory>] [EXPORT_PACKAGE_DEPENDENCIES])

创建一个文件 <filename>，外部项目可以包含该文件，以便从当前项目的构建树中导入目标。这与 export(TARGETS) 签名相同，不同之处在于目标未显式列出。相反，它导出与安装导出 <export-name> 关联的目标。可以使用 install(TARGETS) 命令的 EXPORT 选项将目标安装与导出 <export-name> 关联。

EXPORT_PACKAGE_DEPENDENCIES: 注意

实验性功能。由 CMAKE_EXPERIMENTAL_EXPORT_PACKAGE_DEPENDENCIES 控制。

指定应导出 find_dependency() 调用。有关其工作原理的详细信息，请参阅 install(EXPORT)。

导出包¶

export(PACKAGE <PackageName>)¶

export(PACKAGE <PackageName>)

将当前构建目录存储在 CMake 用户包注册表中，用于包 <PackageName>。find_package() 命令在搜索包 <PackageName> 时可能会考虑该目录。这有助于依赖项目从当前项目的构建树中查找和使用包，而无需用户帮助。请注意，此命令在包注册表中创建的条目仅与适用于构建树的包配置文件 (<PackageName>Config.cmake) 结合使用。在某些情况下，例如对于打包和系统范围的安装，不希望写入用户包注册表。

在 3.1 版本中更改: 如果启用了 CMAKE_EXPORT_NO_PACKAGE_REGISTRY 变量，则 export(PACKAGE) 命令将不执行任何操作。

在 3.15 版本中更改: 默认情况下，export(PACKAGE) 命令不执行任何操作（请参阅策略 CMP0090），因为填充用户包注册表具有源树和构建树之外的影响。设置 CMAKE_EXPORT_PACKAGE_REGISTRY 变量以将构建目录添加到 CMake 用户包注册表。

配置导出¶

export(SETUP <export-name> [...])¶

export(SETUP <export-name>
       [PACKAGE_DEPENDENCY <dep>
        [ENABLED (<bool-true>|<bool-false>|AUTO)]
        [EXTRA_ARGS <args>...]
       ] [...]
       [TARGET <target>
        [XCFRAMEWORK_LOCATION <location>]
       ] [...]
       )

在 3.29 版本中添加。

配置导出的参数。参数如下

PACKAGE_DEPENDENCY <dep>

注意

实验性功能。由 CMAKE_EXPERIMENTAL_EXPORT_PACKAGE_DEPENDENCIES 控制。

指定要配置的包依赖项。这将更改在 find_dependency() 调用在 export(EXPORT) 和 install(EXPORT) 期间的写入方式。<dep> 是要导出的包的名称。此参数接受以下附加参数

ENABLED

手动控制是否导出依赖项。这接受以下值

<bool-true>: CMake 识别为“true”的任何值。始终导出依赖项，即使没有导出的目标依赖于它。这可以用于手动将 find_dependency() 调用添加到导出中。
<bool-false>: CMake 识别为“false”的任何值。永远不要导出依赖项，即使导出的目标依赖于它。
AUTO: 仅当导出的目标依赖于依赖项时才导出依赖项。

EXTRA_ARGS <args>

指定在 REQUIRED 参数之后传递给 find_dependency() 的附加参数。

TARGET <target>

指定要在此导出中配置的目标。此参数接受以下附加参数

XCFRAMEWORK_LOCATION: 指定 .xcframework 的位置，其中包含来自此目标的库。如果指定，生成的代码将检查 .xcframework 是否存在，如果存在，它将使用 .xcframework 作为其导入的位置，而不是已安装的库。

export¶

概要¶

导出目标¶

将目标导出到 Android.mk¶

导出与 install(EXPORT) 匹配的目标¶

导出包¶

配置导出¶

目录

上一主题

下一主题

本页