CMake 和子目录取决于父目录

Question

如何在 CMake 中处理这种编译情况？假设我们有一个包含如下子目录的源代码目录

src:
 helper:
  innerpkg:
   a.cpp
   a.h
  helper.cpp
  helper.h
 main.cpp
 main.h

文件 a.cpp 调用文件 helper.cpp 中的内容，尽管 helper.cpp 可能不会调用 a.cpp 中的任何内容。因此，如果我们将 helper 子目录设为一个库，并将 innerpkg 设为一个库，我们就会遇到一个问题，即 helper 需要包含 innerpkg，但 innerpkg 也需要 helper —— 一个循环依赖项。处理这个问题的正确方法是什么，并且仍然在 helper 中保留一些源文件？顺便说一句，我对使用 CMake 还很陌生。

编辑:innerpkg 中的 CMakeLists.txt 文件可能如下所示:

 include_directories(${CCMBS_SOURCE_DIR})
 set(INNERPKG_SRC a.cpp)
 add_library(innerpkg ${INNKERPKG_SRC})

在助手中:

 include_directories(${PROJ_SOURCE_DIR})
 add_subdirectory(innerpkg)
 set(HELPER_SRC helper.cpp)
 add_library(helper ${HELPER_SRC})

 target_link_libraries(ui "-Wl,--whole-archive")
 target_link_libraries(ui innerpkg)
 target_link_libraries(ui "-Wl,--no-whole-archive")

如果这有帮助。需要如何设置才能解决这个问题？

编辑:确切的依赖结构是这样的:innerpkg 中的内容依赖于 helper 中的内容。 innerpkg 由 main 使用。另一种情况是 helper 也依赖 innerpkg 中的东西，即循环依赖，而 main 使用 helper 或 innerpkg。

Answer 1

我觉得您假设基于 CMake 的项目中的每个目录都必须包含自己的 CMakeLists.txt 文件并构建自己的库/可执行文件。

这个问题其实和CMake没有关系。几乎所有构建系统都会遇到同样的问题。这里的问题是你的依赖树不清楚。应不惜一切代价避免循环依赖。

与 Java 及其基于包的系统相反，C++ 应用程序没有强制执行目录布局，甚至 CMake 也没有。
依赖关系只能用库和可执行程序来表示，前者主要用于避免在使用相同功能的不同程序之间重复代码。

在您的具体情况下，不清楚谁在使用 helper 和 innerpkg 库。因此，让我们做出几个假设。

1。你有几个程序使用这两个库

那么拥有单独的库是非常有意义的，除了将它们表示为平面目录结构要好得多，以便清楚地分离每个库和程序。

src
├─ helper
│  ├─ helper.cpp
│  └─ helper.h
├─ innerpkg
│  ├─ a.cpp
│  └─ a.h
├─ main
│  ├─ main.cpp
│  └─ main.h
└─ main2
   ├─ main2.cpp
   └─ main2.h

显然，既然你是说 helper.cpp 不需要调用 a.cpp 中定义的东西，那么 helper 库不依赖于 innerpkg , 因此不存在循环依赖。

在 CMake 方面，每个目录(包括根目录)中将有一个 CMakeLists.txt 文件，总共有五个。
最上面的一个将只包含每个子目录，而其余四个将负责构建每个二进制文件。只有 main 和 main2 中的 CMake 列表会实际调用 target_link_libraries()。

2。源代码只编译了一个程序，而且只有它使用了两个库

那你为什么首先需要库？

由于只有一个可执行程序main，所以没有重复的代码和功能。

在这种情况下，解决方案是保留您当前的目录结构，其中子目录不是库而是主题。
我所说的主题是指最终程序功能的一个子集，为了便于维护而明确分开，但它不暗示与其他主题的依赖关系。

在那种情况下为什么不关心依赖关系？仅仅是因为您不需要创建库。只需将每个 cpp 文件添加为 main 程序的源，这样依赖关系就会在链接时一次性自动解决。

对于 CMake，您只需要在顶部有一个 CMakeLists.txt 文件，它只会构建一个程序并列出每个子目录中的每个 cpp 文件，如下所示:

add_executable(main
    main.cpp
    helper/helper.cpp
    helper/innerpkg/a.cpp
)

3。主程序使用一个库，每个库使用另一个库

这还假设您确实需要生成一个库，它将成为项目安装部分的一部分，以便第三方应用程序使用。

在这种情况下，通过使helper 和innerpkg 成为唯一一个库来解决循环依赖问题。
然后你应该有一个如下所示的目录结构:

src
├─ helper
│  ├─ helper.cpp
│  ├─ helper.h
│  └─ innerpkg
│     ├─ a.cpp
│     └─ a.h
└─ main
   ├─ main.cpp
   └─ main.h

与上一点一样，helper 下的目录结构没有隐含依赖关系，因为只会编译一个库。

此外，即使 main 使用 innerpkg 的功能，它也只是作为 helper 的一部分透明公开。

就 CMake 而言，您将拥有一个包含两个子目录的顶级 CMakeLists.txt，一个在 helper 中列出 helper 和 innerpkg 中的每个 cpp 文件以构建库，一个在 main 列出 main 中的每个文件，并与帮助程序库链接。