CMake:如何设置源,库和CMakeLists.txt依赖项?

时间:2015-07-20 09:02:25

标签: c++ cmake

我有几个项目(所有建筑都使用来自相同源树结构的CMake)都使用自己的数十个支持库组合。

所以我想到了如何在CMake中正确设置这个问题。到目前为止,我只找到了 CMake how to correctly create dependencies between targets ,但我仍在努力设置所有具有全局依赖关系(项目级别确实知道所有)或本地依赖关系(每个子级别) target只处理自己的依赖项。)

以下是我的目录结构的简化示例以及我目前使用CMake和本地依赖项创建的示例(该示例仅显示了一个可执行项目App1,但实际上还有更多,App2App3等):

Lib
+-- LibA
    +-- Inc
        +-- a.h
    +-- Src
        +-- a.cc
    +-- CMakeLists.txt
+-- LibB
    +-- Inc
        +-- b.h
    +-- Src
        +-- b.cc
    +-- CMakeLists.txt
+-- LibC
    +-- Inc
        +-- c.h
    +-- Src
        +-- c.cc
    +-- CMakeLists.txt
App1
+-- Src
    +-- main.cc
+-- CMakeLists.txt

LIB / LIBA /的CMakeLists.txt

include_directories(Inc ../LibC/Inc)
add_subdirectory(../LibC LibC)
add_library(LibA Src/a.cc Inc/a.h)
target_link_libraries(LibA LibC)

LIB / LibB /的CMakeLists.txt

include_directories(Inc)
add_library(LibB Src/b.cc Inc/b.h)

LIB /的LibC /的CMakeLists.txt

include_directories(Inc ../LibB/Inc)
add_subdirectory(../LibB LibB)
add_library(LibC Src/c.cc Inc/c.h)
target_link_libraries(LibC LibB)

App1 / CMakeLists.txt (为了便于复制,我在这里生成源/头文件)

cmake_minimum_required(VERSION 2.8)

project(App1 CXX)

file(WRITE "Src/main.cc" "#include \"a.h\"\n#include \"b.h\"\nint main()\n{\na();\nb();\nreturn 0;\n}")
file(WRITE "../Lib/LibA/Inc/a.h" "void a();")
file(WRITE "../Lib/LibA/Src/a.cc" "#include \"c.h\"\nvoid a()\n{\nc();\n}")
file(WRITE "../Lib/LibB/Inc/b.h" "void b();")
file(WRITE "../Lib/LibB/Src/b.cc" "void b() {}")
file(WRITE "../Lib/LibC/Inc/c.h" "void c();")
file(WRITE "../Lib/LibC/Src/c.cc" "#include \"b.h\"\nvoid c()\n{\nb();\n}")

include_directories(
    ../Lib/LibA/Inc
    ../Lib/LibB/Inc
)

add_subdirectory(../Lib/LibA LibA)
add_subdirectory(../Lib/LibB LibB)

add_executable(App1 Src/main.cc)

target_link_libraries(App1 LibA LibB)

上例中的库依赖关系如下所示:

App1 -> LibA -> LibC -> LibB
App1 -> LibB

目前我更喜欢本地依赖变体,因为它更容易使用。我只是使用include_directories()在源级别为依赖项,在target_link_libraries()的链接级别和add_subdirectory()的CMake级别。

有了这个,你不需要知道支持库之间的依赖关系 - 并且 - 使用CMake级别“包括” - 你只会最终得到你真正使用的目标。当然,你可以让全局知道所有包含目录和目标,并让编译器/链接器整理其余部分。但这对我来说似乎是一种臃肿。

我还尝试使用Lib/CMakeLists.txt来处理Lib目录树中的所有依赖项,但我最终得到了很多if ("${PROJECT_NAME}" STREQUAL ...)项检查以及我能解决的问题。 t创建中间库分组目标,而不提供至少一个源文件。

所以上面的例子“到目前为止一直很好”,但它会抛出以下错误,因为你应该/不能两次添加CMakeLists.txt

CMake Error at Lib/LibB/CMakeLists.txt:2 (add_library):
  add_library cannot create target "LibB" because another target with the
  same name already exists.  The existing target is a static library created
  in source directory "Lib/LibB".
  See documentation for policy CMP0002 for more details.

目前我看到了两种解决方案,但我认为这种方式太复杂了。

1。覆盖add_subdirectory()以防止重复

function(add_subdirectory _dir)
    get_filename_component(_fullpath ${_dir} REALPATH)
    if (EXISTS ${_fullpath} AND EXISTS ${_fullpath}/CMakeLists.txt)
        get_property(_included_dirs GLOBAL PROPERTY GlobalAddSubdirectoryOnceIncluded)
        list(FIND _included_dirs "${_fullpath}" _used_index)
        if (${_used_index} EQUAL -1)
            set_property(GLOBAL APPEND PROPERTY GlobalAddSubdirectoryOnceIncluded "${_fullpath}")
            _add_subdirectory(${_dir} ${ARGN})
        endif()
    else()
        message(WARNING "add_subdirectory: Can't find ${_fullpath}/CMakeLists.txt")
    endif()
endfunction(add_subdirectory _dir)

2. 在所有子级别CMakeLists.txt中添加“包含守卫”,例如:

if (NOT TARGET LibA)
    ...
endif()

我一直在测试tamas.kenezm.s.建议的概念,并取得了一些有希望的结果。摘要可以在以下答案中找到:

1 个答案:

答案 0 :(得分:11)

多次添加相同的子目录是不可能的,它不是CMake的工作方式。有两种主要的替代方案可以干净利落:

  1. 在与您的应用相同的项目中构建库。对于您正在积极处理的图书馆(当您正在处理该应用程序时)更喜欢此选项,因此可能会经常对其进行编辑和重建。它们也将出现在同一个IDE项目中。

  2. 在外部项目中构建库(,我不是指ExternalProject )。对于您的应用刚刚使用的库而不是您正在使用的库,请更喜欢此选项。大多数第三方库都是这种情况。它们也不会使IDE工作区混乱。

  3. 方法#1

    • 您的应用CMakeLists.txt添加了图书馆的子目录(以及您的图书馆' CMakeLists.txt不要
    • 您的应用CMakeLists.txt负责添加所有即时和传递依赖关系并按正确顺序添加
    • 它假设添加libx的子目录会创建一些可以与libx
    • 一起使用的目标(比如target_link_libraries

    作为旁注:对于库来说,创建功能齐全的库目标是一种很好的做法,即包含使用库所需的所有信息的库目标:

    add_library(LibB Src/b.cc Inc/b.h)
    target_include_directories(LibB PUBLIC
        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/Inc>)
    

    因此,库的include目录的位置可以保持lib的内部事务。你只需要这样做;

    target_link_libraries(LibC LibB)
    

    然后LibB的包括目录也将添加到LibC的汇编中。如果PRIVATE的公开标题未使用LibB,请使用LibC修饰符:

    target_link_libraries(LibC PRIVATE LibB)
    

    方法#2

    在单独的CMake项目中构建和安装库。您的库将安装一个所谓的 config-module ,它描述了头文件和库文件的位置,还编译了标志。您的应用程序CMakeList.txt假定已经构建并安装了库,并且find_package命令可以找到配置模块。这是另一个故事,所以我不打算在这里详细介绍。

    一些注意事项:

    • 您可以混合#1和#2,因为在大多数情况下,您将拥有正在开发的不变的第三方库和您自己的库。
    • #1和#2之间的妥协是使用ExternalProject module,很多人都喜欢。这就像将您的库的外部项目(在他们自己的构建树中构建)包含到您的应用程序项目中一样。在某种程度上,它结合了两种方法的缺点:您不能将您的库用作目标(因为它们在不同的项目中)并且您无法调用find_package(因为这些库)在您的应用CMakeLists正在配置的时间内未安装。
    • #2的变体是在外部项目中构建库,但不是安装工件,而是从源/构建位置使用它们。有关详情,请参阅export() command