Cmake:多库包导出中的依赖关系管理

时间:2016-03-19 14:36:11

标签: c++ cmake dependencies dependency-management

我有一个名为 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相同,但lib1没有add_dependencies()target_include/link(),因为它没有。{/ p>

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

@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 info 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()读取配置文件时会出错。不确定传递依赖性如何工作tbh。由于这些库是include()来自同一个导出文件,有没有办法告诉cmake配置文件或 lib2 的导出文件中的依赖关系,因为我们知道依赖项的导出文件将在系统上?我可以看到target_link_libraries()有一个PUBLIC选项。我应该如何使用它?会有什么帮助吗?

1 个答案:

答案 0 :(得分:4)

首先,您可以删除add_dependencies行。见https://stackoverflow.com/a/27305021/2428389

其次,你有

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

您将lib1lib2导出到两个单独的导出集中' - lib1Exportslib2Exports。将它们放在一个出口套装中。将解决问题并成为最简单的方法,至少在双目标示例中。

猜测您知道并且您没有这样做,因为您的构建系统的规模大于两个目标。但是,这直接导致了您的问题 - 这意味着您必须管理“导出集”之间的订单依赖关系。

这是目标之间依赖关系的独立。一个'出口集'是一个不同的单位'具有独立的依赖图。 CMake无法帮助您管理它。您必须管理'导出集'之间的依赖关系。问题是您当前没有管理或表达这些依赖项。请参阅下文,了解有关表达这些依赖关系的选项。

target_link_libraries(PUBLIC)对您没有帮助。在此处阅读:https://cmake.org/cmake/help/v3.4/manual/cmake-buildsystem.7.html#transitive-usage-requirements

如果您想到与预处理程序文件类比,您可能会看到您的选项。想想lib2_private.h没有#include lib1_private.halllibs.h需要include这两个按正确的顺序排列。因为_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. 在Config文件中管理它们 - 用硬编码的有序列表替换循环
  2. 在填充MYPROJ_EXPORT_SETS变量的任何位置添加更多变量来表示导出集的依赖关系,并将Config文件中的循环替换为考虑这些依赖项的更复杂的循环。
  3. 与(2)相同,但生成中间文件,并不关心Config文件中的包含顺序。
  4. (1)可能最有意义,但你可能还要退后一步,更加努力地思考你所创造的抽象/包装,这些都是你带来的。