推荐的 target_include_directories 用法和项目结构以及模块化、相互依赖的静态库

Question

背景

我是 CMake 的新手，虽然我已经阅读了大量文档，并且感觉我在真空中理解了许多概念（至少在基本层面上），但当它出现时我仍然感到非常困惑将其中的几个与更复杂的项目结合使用，其中之一是 target_include_directories()。

当前设置

我目前有一个已重组的库，并将其移植到 CMake，这是一个具有多个组件库/模块的顶级项目，使用 add_subdirectory() 进行处理。希望每个子库都可以用作 CMake 包组件，值得注意的是，某些子库依赖于其他子库。

现在该项目的结构如下：

MyLib/
├── CMakeLists.txt
└── src/
    └── mylib/
        ├── sublibA/
        │   ├── CMakeLists.txt
        │   ├── classA1.h
        │   ├── classA1.cpp
        │   ├── classA1_p.h
        │   ├── classA1_p.cpp
        │   ├── classA2.h
        │   └── ...
        ├── sublibB/
        │   ├── (Similar to Above)
        │   └── ...
        ├── sublibC/
        │   └── ...
        └── ...

在我的顶级 CMakeLists.txt 中，我

include_directories("${CMAKE_SOURCE_DIR}/src")

这样做 因此，当一个子库需要包含来自另一个子库的标头时，我可以简单地执行此操作

// Arbitrary SubLibB source file
#include "mylib/sublibA/classA1.h"

，然后使用尴尬的 PUBLIC_HEADER 属性来提供每个模块的公共 API 的一部分的标头列表（因此没有 *_p.h 文件），以及用于处理的 install(TARGETS ... PUBLIC_HEADER DESTINATION ...) .lib 和公共标头结构安装。接下来是一些 INSTALL(CODE ...)，它利用 configure_file() 在同一安装结构中生成方便的组件级别包含（即 sublibA.h、sublibB .h 等），以便用户可以简单地

#include "mylib/sublibA.h"

包含该组件的所有标头。

这对于构建/安装效果很好，并生成一组可以按原样使用的文件；然而，当涉及到打包时，这已经成为一个噩梦，因为我想为这个库创建一个很好的包，可以轻松地与其他 CMake 项目一起使用。

目标

• 让用户能够通过诸如 find_package(MyLib COMPONENTS SubLibA ...) 之类的方式
• 访问库 拥有统一的公共标头结构，以便用户通过（并且只能通过）执行 '#include "mylib/sublibX/classY.h"' 无论它是哪个子库，受限于已链接到的子库（即如果用户未执行“target_link_libraries(user_target PUBLIC/PRIVATE MyLib::SubLibB)”，则找不到“mylib/sublibB/classZ.h”
• 与上面相同，将其保留在我的构建树中，这样我的子库之一-如果未将其指定为依赖项/库链接，则库无法找到另一个子库标头，以便我知道我的依赖项是直接的（现在是顶层include_directories() 只是绕过了这一要求，稍后我可以更改我的源代码，以便一个子库包含来自新子库的标头，忘记更新我的 CMake 脚本，但构建仍然会完成，就好像一切正​​常一样
• 使用传播的依赖项来避免不必要的用户指定的链接/包含目录。例如，如果 SubLibB 依赖于 SubLibA，但该库的用户仅在 find_package() 中请求 SubLibB 组件，并且也仅链接到它，则自动处理 SubLibA 的链接和标头包含，以便在其末尾不会引发
• 错误能够包含类的直接头文件，就好像它位于同一目录中一样（即 classA1.cpp 中的“#include“classA1.h””）
• 显然没有将私有头文件放入 lib 的 install/package

中 可以

经过大量研究后我了解到，我真的想使用 target_include_directories() 而不是顶级 include_directories()，主要是为了填充每个组件的 INTERFACE_INCLUDE_DIRECTORIES 变量，并且依赖项 起初，我确定如何执行此操作，因为只能指定一个目录，在我的情况下，这会错误地包含私有头文件，但在查看了更简单的示例之后，我认为我已经确定了一种可能有效的通用方法：

新结构：

MyLib/
├── CMakeLists.txt
└── src/
    └── mylib/
        ├── SubLibA/
        │   ├── CMakeLists.txt
        │   ├── include/
        │   │   └── mylib/
        │   │       └── sublibA/
        │   │           ├── classA1.h
        │   │           ├── classA2.h
        │   │           └── ...
        │   └── src/
        │       ├── classA1.cpp
        │       ├── classA1_p.h
        │       ├── classA1_p.cpp
        │       ├── classA2.cpp
        │       └── ...
        ├── SubLibB/
        │   ├── (Similar to Above)
        │   └── ...
        ├── SubLibC/
        │   └── ...
        └── ...

然后对于给定的模块/组件，可以说 SubLibA （不依赖于其他子库）我这样做：

# Allow for including public headers in a given classes .cpp file as if they were in the same directory
target_include_directories(SubLibA PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include/mylib/sublibA)

# Propagate include directory to dependents properly
target_include_directories(SubLibA INTERFACE
                            $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
                            $<INSTALL_INTERFACE:include>
)

最后对于使用其他子库中的标头的组件（即 SubLibB ）做：

target_link_libraries(SubLibB PUBLIC SubLibA)

如果我理解正确，这应该使得：

1. 每个模块“通告”其接口标头，以便在链接到
2. CMake 时自动包含它们知道 SubLibB 需要链接到 SubLibA，并且需要其公共/接口 头
3. 由于我的新结构和预处理器搜索包含目录的方式，用户使用其 CMake 脚本链接到的任何/所有组件都将通过“#include“mylib/SubLibX/[filename.h]”在用户代码中访问其标 '，就好像“mylib”变成了一个大的虚拟目录。

我认为 target_include_directories() 的这种用法也正确设置了要在其目标导出时打包的 SubLib 组件的公共标头，尽管我认为获取包配置文件来处理它们可能需要多一点（另外我如何将生成的标头合并到包中？）。我对这一点特别执着。

因此，除了包装设置中需要采取的步骤之外，我相信所有这些都会实现我的目标。

备注

这些更改是否符合 target_include_directories() 的预期用途以及正确的方向？

为了实现这些目标我还应该做什么/以不同的方式做？

我的 scipts 中确实有基本的 EXPORT 和 cmake 配置生成，但由于这个问题，我暂时停止了对它们的处理。对于如何设置这些的非常基本的想法，这就是顶级 MyLib-config.cmake 的样子：

include(CMakeFindDependencyMacro)
find_dependency(Qt6 6.2)

file(GLOB AVAILABLE_COMPONENT_CONFIGS
    RELATIVE "${CMAKE_CURRENT_LIST_DIR}"
    "${CMAKE_CURRENT_LIST_DIR}/MyLib-*-config.cmake"
)

foreach(component ${MyLib_FIND_COMPONENTS})
    set(component_config MyLib-${component}-config.cmake)

    if (";${AVAILABLE_COMPONENT_CONFIGS};" MATCHES ";${component_config};")
        include("${CMAKE_CURRENT_LIST_DIR}/${component_config}")
    elseif(MyLib_FIND_REQUIRED_${component}})
        set(MyLib_FOUND False)
        set(MyLib_NOT_FOUND_MESSAGE "Unsupported component: ${component}")
    endif()
endforeach()

如果有必要，我可以托管我的源结构的存储库，仅包含 CMake 相关部分以供参考。

编辑： 目前它非常丑陋，仅供个人使用，但无论如何（只是没有必要批评项目本身:)）。这是所提到的当前设置的相关库： https://github.com/obliviocth/Qx/tree/2183a1f7c64be090ebf1cf804a8ecf811d847658