如何构建 CMake 项目

Question

我开始使用 CMake，但不确定如何在以下设置中使用它。

我有一些 library-cmake-projects（源代码），它们可能相互依赖。

Libs
-A
-B
-C

（假设A 取决于C 和B 取决于C）

如何让 cmake 知道其他目录中需要的模块？

Answer 1

关于 add_subdirectory，您应该像您的源代码一样对其进行结构化。

所以，假设您的文件夹结构如下所示：

/
-- App
-- libs
  -- A
  -- B
  -- C

然后你会像这样放置 CMakeLists.txt：

/
-- CMakeLists.txt
-- App
  -- CMakeLists.txt
-- libs
  -- CMakeLists.txt
  -- A
    -- CMakeLsts.txt
  -- B
    -- CMakeLists.txt
  -- C
    -- CMakeLists.txt

/CMakeLists.txt

add_subdirectory(App)
add_subdirectory(libs)

/App/CMakeLists.txt

add_executable(App ...)
target_link_libraries(App A B)

/libs/CMakeLists.txt

add_subdirectory(A)
add_subdirectory(B)
add_subdirectory(C)

/libs/A/CMakeListst.txt

add_library(A ...)
target_link_libraries(A C)

/libs/B/CMakeListst.txt

add_library(B ...)
target_link_libraries(B C)

/libs/C/CMakeListst.txt

add_library(C ...)

认为 add_subdirectory 与依赖管理有任何关系是不好的，它与源文件和构建文件的组织方式有关。它也有作用域，但大多数时候你不需要担心它。如果您直接将所有三个 add_subdirectory 调用放在顶级 CMakeLists.txt 中，则不一定需要 /libs/CMakelists.txt，但它可以帮助组织。

例如，我会避免使用 add_subdirectory 来包含相邻文件夹。假设目标在那里，并从更高的地方包含进来。

请注意，这是我通常会推荐的，因为它似乎是设计师的想法，但如果您出于某种原因需要其他东西，或者对什么是正确的设计有不同的看法，那么请随意构建不一样。

Answer 2

add_subdirectory 是正确的做法吗？

不，add_subdirectory() 用于遍历 CMake 项目中的其他 CMakeLists.txt 文件。它没有指定依赖项。在现代 CMake 中，您实际上只需要 target_link_libraries 来指定依赖项，正如 this answer 中所建议的那样。

如何将C 添加到A 以使此构建成为可能？

我不想将C 直接添加到App。

您可以通过将先前定义的目标C 链接到A 来使A 依赖于C

add_library(C SHARED ... )

...

add_library(A SHARED ... )

target_link_libraries(A PUBLIC C)

注意，这里使用PUBLIC 确保C 被添加到A 的链接接口，因此它将被传播 到消费目标。现在，当您将A 链接到App 时，您将获得C，并且无需显式指定C。

# Link A (and C) to App.
target_link_libraries(App PRIVATE A)

App也依赖B的情况如何处理？使用add_subdirectory 并且不小心，这将尝试定义C 两次。包含警卫是正确的解决方案吗？

根据我的经验，这不是问题，链接器能够找出重复链接的 C 库。如果它确实成为一个问题，您可以简单地使B 依赖关系PRIVATE 的范围。这样，C 就不会通过B 传播到App：

target_link_libraries(B PRIVATE C)

...

target_link_libraries(App PRIVATE B A)

我鼓励您通读链接的 target_link_libraries() 文档，其中有许多关于这些类型依赖项的推荐 CMake 用法示例。