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

Posted 2023-02-23

【中文标题】如何指定头文件引入的库依赖

【英文标题】：How to specify library dependency introduced by header file

【发布时间】：2012-10-28 09:55:51

【问题描述】：

假设在一个 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的类内联函数，依次调用d.h中的函数等，最后调用库A中的函数。如果b.h被很多文件包含，手动找出所有这些依赖项是不可行的大型项目。

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

谢谢。

【参考方案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 代码，它会准备好所有必要的包含目录。例如。在“YourLibConfig.cmake”中定义一个变量“YOURLIB_INCLUDES”和“YOURLIB_LIBRARIES”，并记录您的图书馆的任何用户都应该导入“YourLibConfig.cmake”。这是几个基于 cmake 的项目采用的方法。例如。 OpenCV安装一个OpenCVConfig.cmake文件，VTK安装一个VTKConfig.cmake并准备一个UseVTK.cmake文件