c++ - CMake:多库包导出中的依赖管理

Question

我有一个名为 MYLIBS 的包，包含两个库，lib1 和 lib2，我想通过配置文件导出它们包裹。项目结构如下:

├── Lib1
│   ├── CMakeLists.txt
│   ├── lib1-class.cpp
│   └── lib1-class.h
├── lib2
│   └── CMakeLists.txt
│   ├── lib2-class.cpp
│   ├── lib2-class.h
├── cmake
│   └── LIBSConfig.cmake.in
├── CMakeLists.txt

在 lib2 我有:

add_library(lib2
        STATIC
        ${SOURCE_FILES}
        )
target_include_directories(lib2 PRIVATE /path/to/lib1)
target_link_libraries(lib2 PUBLIC lib1)
add_dependencies(lib2 lib1)
install(
        TARGETS
        lib2
        DESTINATION
        lib/MYLIBS/lib2
        EXPORT
        lib2Exports
)
install(
        EXPORT
        lib2Exports
        DESTINATION
        lib/MYLIBS/lib2
)

除了 lib1 没有 add_dependencies() 和 target_include/link() 外，与 lib1 相同。

在我的配置文件模板中，我有:

@PACKAGE_INIT@
## PROJECT_LIBRARIES is filled-in during the package build. in this case : lib1,lib2
set(@PROJECT_NAME@_LIBRARIES @PROJECT_LIBRARIES@)

## The public variables to be used by the client project:
#PROJECT_NAME_INCLUDE_DIRS is all the include paths
#PROJECT_NAME_LIBRARIES is the name of all the libraries

unset(@PROJECT_NAME@_INCLUDE_DIRS)
foreach(INCLUDE_DIR ${INCLUDE_DIRS})
    set_and_check(@PROJECT_NAME@_INCLUDE_DIR ${INCLUDE_DIR})
    list(APPEND @PROJECT_NAME@_INCLUDE_DIRS ${@PROJECT_NAME@_INCLUDE_DIR})
endforeach()

## PACKAGE_PACKAGE_DIRNAME_include is filled-in during the package build
foreach(lib ${@PROJECT_NAME@_LIBRARIES})
    list(APPEND INCLUDE_DIRS @PACKAGE_PACKAGE_DIRNAME_include@/${lib})
endforeach(lib)

# Looks up the information about the exported targets in this package
foreach(lib ${@PROJECT_NAME@_LIBRARIES})
    if(NOT TARGET ${lib})
        include(@PACKAGE_PACKAGE_DIRNAME_lib@/${lib}/${lib}Exports.cmake)
    endif()
endforeach(lib)

所以我一个一个地检查库的导出文件并包含它们。问题是我必须以正确的顺序执行此操作，即首先是 lib1，然后是 lib2，否则在通过 FindPackage() 读取配置文件时会出现错误。

我不太确定传递依赖项是如何工作的。由于这些库是从同一个导出文件include()编辑的，是否有一种方法可以告诉 CMake 关于配置文件或 lib2 导出文件中的依赖关系，考虑到我们知道依赖项的导出文件将在系统上的什么位置？

我可以看到 target_link_libraries() 有一个 PUBLIC 选项。我该如何使用它？有什么用吗？

Answer 1

首先，您可以删除 add_dependencies 行。参见 target_link_libraries and add_dependencies .

其次，你有

target_include_directories(lib2 PRIVATE /path/to/lib1)

但这不应该是必需的。相反，删除它，并将其添加到 lib1:

target_include_directories(lib1 PUBLIC /path/to/lib1)

不过，这些只是清理工作。

你没有发布错误，而且你的帖子中还遗漏了很多其他重要信息，所以我做了一些猜测。

我猜想错误与

类似

The following imported targets are referenced, but are missing: lib2

您在两个单独的“导出集”中导出 lib1 和 lib2 - lib1Exports 和 lib2Exports。将它们放在一个“导出集”中可以解决问题，并且是最简单的前进方式，至少在双目标示例中是这样。

我猜想您知道这一点，但您没有这样做是因为您构建系统的规模大于两个目标。但是，这直接导致您的问题 - 这意味着您必须管理“导出集”之间的顺序依赖关系。

这与目标之间的依赖关系独立。 “导出集”是具有独立依赖图的不同“单元”。 CMake 不会帮你管理它。您必须管理“导出集”之间的依赖关系。问题是您当前没有管理或表达这些依赖关系。有关表达这些依赖关系的选项，请参见下文。

target_link_libraries(PUBLIC) 对您没有帮助。阅读 Transitive Usage Requirements .

如果您想到预处理器文件的类比，您可能会看到您的选项。想想 lib2_private.h，它没有 #include lib1_private.h。 alllibs.h 需要以正确的顺序包含 这两个。因为 _private header 是私有(private)的，并且因为客户端将始终包含 alllibs.h，所以这将起作用。在这种方法中，您可以在一个地方管理整个依赖关系树。

另一种方法是创建包含

的 lib2_internal.h

#include "lib1_private.h"
#include "lib2_private.h" 

和包含

的 lib1_internal.h

#include "lib1_private.h"

在这种方法中，您可以在靠近其依赖者的地方管理依赖关系，因此您可以在多个位置指定总依赖关系树的子集。 alllibs.h 可以使用

#include "lib1_internal.h"
#include "lib2_internal.h" 

或

#include "lib2_internal.h"
#include "lib1_internal.h" 

并且顺序无关紧要。

带有循环的配置文件是 alllibs.h - 它是客户端包含的唯一文件。你能完全在那里管理订单吗？是的，如果您可以在 @PROJECT_NAME@_LIBRARIES 变量中管理顺序。顺便说一下，你应该调用那个@PROJECT_NAME@_EXPORT_SETS。如果您不明白为什么，请再看看我上面所说的它是一个不同的“单元”。

你没有提供太多信息，但我猜想你用多个

list(APPEND MYPROJ_EXPORT_SETS fooExports)

调用，也许在一些宏中。所以顺序不容易维护，因为它会作为单个 set() 调用。

因此，您表达“导出集”依赖项的选项是:

1. 在配置文件中管理它们——用硬编码的有序列表替换循环
2. 在填充 MYPROJ_EXPORT_SETS 变量的任何地方添加更多变量来表达导出集的依赖关系，并将配置文件中的循环替换为考虑到这些依赖关系的更复杂的东西。
3. 与(2)相同，但生成中间文件并且不关心配置文件中的包含顺序。

(1) 可能是最有道理的，但您可能还必须退后一步，更加认真地思考您正在创建的抽象/包装器是什么导致您来到这里。