cmake - 如何指定头文件引入的库依赖

Question

假设在一个 CMake 项目中，我有一个内置在库中的源代码

// a.cpp
void f() { /* some code*/ }

我有一个标题

// b.h
void f();
struct X { void g() { f(); } };

我有另一个文件:

// main.cpp
#include "b.h"
int main() { X x; x.g(); }

CMakeLists.txt 包含:

add_library(A a.cpp)
add_executable(main main.cpp)
target_link_libraries(main A)

现在看一下 CMakeLists.txt 的最后一行:我需要明确指定 A 作为 main 的依赖项。基本上，我需要为包含 b.h 的每个源指定此类依赖项。由于包含可以是间接的，并且通过包含链一直向下。比如a.cpp调用了c.h的一个类内联函数，c.h又调用了d.h中的函数等，最后调用了库A中的函数。如果b.h被很多文件包含，手动找出所有这些依赖是不可行的大项目。

所以我的问题是，是否有任何规定，对于直接或间接包含 header 的每个源文件，它都需要链接到特定的库？

谢谢。

Answer 1

要弄清楚一件事:你的 a.cpp 被编译成一个库“A”。这意味着 A 的任何用户都需要为 A 指定 target_link_libraries。没有办法绕过它。如果您有 10 个使用 A 的小应用程序，则需要指定 target_link_libraries 十次。

我的回答涉及你问题的第二个问题，我认为这是更重要的一个:

如何摆脱包含链？

通过在 b.h 中包含 a.h 并在 b.h 中使用它的方法，您将添加一个“隐式”依赖项。正如您所注意到的，b.h 的任何用户也需要 a.h。从广义上讲，有两种方法。

好的方法:

这个和CMake无关，是封装的问题。你的库的用户(包括你自己)不需要担心它的内部实现。这意味着:不要在 a.h 中包含 b.h。

相反，将包含移动到 .cpp 文件中。这样，你就打破了链条。例如。类似

// b.h
void f();
struct X
{ 
    void g();
};

// b.cpp
#include b.h
#include a.h
void X::g( )
{
    f();
}

这样，a.h 的使用“包含”在 cpp 文件中，任何使用您库的人只需要包含 b.h 和指向 b.lib 的链接。

备选方案:

现在，有些情况下您必须接受这种“依赖性”，或者这是一种有意识的选择。例如。当您无法控制 A 或当您有意识地决定创建一个根据 A 内部的类/结构定义的库时。

在那种情况下，我建议您编写一段 CMake 代码，它会准备链中所有必要的 include-dirs。例如。在“YourLibConfig.cmake”中定义变量“YOURLIB_INCLUDES”和“YOURLIB_LIBRARIES”，并记录您图书馆的任何用户都应该导入“YourLibConfig.cmake”。这是几个基于 cmake 的项目所采用的方法。例如。 OpenCV 安装一个OpenCVConfig.cmake 文件，VTK 安装一个VTKConfig.cmake 并准备一个UseVTK.cmake 文件