如何构建具有多个相互依赖子目录的c++项目

How can I build a C++ project with multiple interdependent subdirectories?

本文关键字：依赖 子目录 项目 c++ 何构建 构建      更新时间：2023-10-16

我有一个c++项目，我把目录更多地用作组织元素——就像在Java中使用包或在PHP中使用目录一样。目录并不打算成为自给自足的元素，而只是组织整个项目的一种方式，并防止我被资源淹没。我如何构建我的CMakeLists.txt文件来处理这个?创建目录库似乎不适合这里，因为它们都是相互依赖的，并且不打算以这种方式使用。

作为一个相关的问题，我在CMake中看到的多个子目录的大多数例子(并且没有很多这样的例子)都忽略或掩盖了设置include_directories的问题，这是我一直遇到麻烦的事情。缺少梳理我的源文件，以确定哪个文件依赖于哪个文件，在什么目录下，是否有办法将/src/下的所有目录设置为潜在的包含目录，并让CMake计算出哪些实际上是依赖的?

下面是一个结构示例:

--src
  --top1
    --mid1
      --bot1
        --src1.cpp
        --hdr1.h
      --bot2
        --src2.cpp
        --hdr2.h
    --mid2
      --bot3
        --src3.cpp
        --src4.cpp
        --hdr3.h
  --top2
    --mid3
      --src5.cpp
      --hdr4.h

等等。我如何构建我的CMakeLists.txt文件来处理这种结构?

由于项目中的目录结构只是为了保持文件的组织，一种方法是让CMakeLists.txt自动查找src目录中的所有源文件，并将所有目录添加为包含其中有头文件的目录。下面的CMake文件可以作为一个起点:

cmake_minimum_required(VERSION 3.12)
project (Foo)
file (GLOB_RECURSE Foo_SOURCES CONFIGURE_DEPENDS "src/*.cpp")
file (GLOB_RECURSE Foo_HEADERS CONFIGURE_DEPENDS "src/*.h")
set (Foo_INCLUDE_DIRS "")
foreach (_headerFile ${Foo_HEADERS})
    get_filename_component(_dir ${_headerFile} PATH)
    list (APPEND Foo_INCLUDE_DIRS ${_dir})
endforeach()
list (REMOVE_DUPLICATES Foo_INCLUDE_DIRS)
add_executable(FooExe ${Foo_SOURCES})
target_include_directories(FooExe PRIVATE ${Foo_INCLUDE_DIRS})

两个file(GLOB_RECURSE ...命令确定源文件和头文件的集合。foreach循环从所有头文件列表中计算包含目录的集合。CONFIGURE_DEPENDS标志告诉CMake在构建时重新运行glob命令。

计算源文件集的一个缺点是CMake不会自动检测新文件何时添加到源树中。你必须手动重新创建你的构建文件。

虽然@sakra对这个问题给出了一个很好的答案，但我认为更应该深入地探讨这个问题。

我们想把代码分成模块和库有很多原因。比如代码封装、可重用性、更容易调试等。这个想法也会在编译过程中传播。

换句话说，我们希望将编译过程划分为小的编译步骤，每个编译步骤属于一个模块。所以每个模块都必须有自己的编译过程。这就是我们为每个目录使用一个CMakeLists.txt文件的原因。因此，每个目录都会有自己的编译命令，并且在项目的根目录中会有一个主CMakeLists.txt文件。

下面是一个例子。考虑下面的项目结构:

src/
|
- main.cpp
|
_sum/
    |
    - sum.h
    |
    - sum.cpp

每个目录有一个CmakeLists.txt。第一个目录是src/文件夹所在项目的根目录。下面是该文件的内容:

cmake_minimum_required(VERSION 3.4)
project(multi_file)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_FLAGS "-Wall")
add_subdirectory(src)

下一个CMakeLists.txt将位于src/目录:

add_subdirectory("sum")
add_executable(out main.cpp)
target_link_libraries(out sum)

最后一个将在sum/目录:

add_library(sum SHARED sum.cpp)

我希望这对你有帮助。我创建了一个github存储库，以便您需要查看代码或需要进一步解释。

我不是CMake专家，但由于没有其他答案，我将看看文档并尝试一下。在不同的目录中组织源文件和包含文件是很正常的。

看起来CMake允许你给出一个包含目录的列表:http://www.cmake.org/cmake/help/cmake-2-8-docs.html命令:include_directories

比如:

include_directories("src/top1/mid1/bot1" "src/top1/mid1/bot2/" ... )

这些被传递给编译器，以便它可以找到头文件，并将为每个源文件传递。所以你的任何源文件都应该能够包含任何头文件(我认为这是你所要求的)。

与此类似，您应该能够在add_executable命令中列出所有源文件: 
add_executable(name "src/top1/mid1/bot1/src1.cpp" "src/top1/id1/bot2/src2.cpp" ...)

所以这将是一个天真的方式来获得所有的构建。每个源文件将被编译，并将在所有这些目录中查找头文件，然后将目标文件链接在一起。考虑是否有任何方法可以简化这一点，这样您就不需要那么多包含文件夹，也许只有几个通用的头文件需要被所有源文件引用。如果事情变得更复杂，你可以在库中建立子层次结构等等。还要考虑分隔源文件和头文件(例如在src和include中)。

相关文章：