cmake用于具有通用代码的更大项目

时间:2017-03-21 17:19:40

标签: makefile module cmake libraries

我刚进入cmake,因为我开始研究一个更大的项目。我需要添加模块测试。 有几个嵌入式设备,每个都有自己的应用程序运行。

这些应用程序中的大多数共享代码。 所以代码分为模块。问题是大多数其他模块都使用了一些模块。这些模块是常见的,通用网和日志。

设备的简化项目(app)具有以下结构:

    .
    |-- CMakeLists.txt (for app)
    |-- LICENSE
    |-- app
    |   |-- inc
    |   |   |-- appfile1.hpp
    |   |   `-- appfile2.hpp
    |   `-- src
    |       |-- appfile1.cpp
    |       |-- appfile2.cpp
    |       `-- main.cpp
    |-- comp
    |   |-- comp1
    |   |   |-- CMakeLists.txt (for test)
    |   |   |-- comp
    |   |   |   |-- CMakeLists.txt (for lib)
    |   |   |   |-- intf
    |   |   |   |   |-- comp1file.hpp
    |   |   |   |   `-- comp1file.hpp
    |   |   |   `-- src
    |   |   |       |-- comp1file.cpp
    |   |   |       `-- comp1file.cpp
    |   |   `-- test
    |   |       `-- src
    |   |           `-- comp1testfile.cpp
    |   |-- comp2
    |   |   |-- CMakeLists.txt (for test)
    |   |   |-- comp
    |   |   |   |-- CMakeLists.txt (for lib)
    |   |   |   |-- inc
    |   |   |   |   `-- comp2file1.hpp
    |   |   |   |-- intf
    |   |   |   |   |-- comp2file2.hpp
    |   |   |   |   |-- comp2file3.hpp
    |   |   |   |   |-- comp2file4.hpp
    |   |   |   `-- src
    |   |   |       |-- comp2file1.cpp
    |   |   |       |-- comp2file2.cpp
    |   |   |       `-- comp2file3.cpp
    |   |   `-- test
    |   |       |-- inc
    |   |       |   `-- comp2testfile.hpp
    |   |       `-- src
    |   |           `-- comp2testfile.cpp
    |   |-- common
    |   |   |-- CMakeLists.txt (for test)
    |   |   `-- comp
    |   |       |-- inc
    |   |       |   |-- commonfile1.hpp
    |   |       |   `-- commonfile2.hpp
    |   |       `-- src
    |   |           `-- commonfile1.cpp
    |   |-- common-net
    |   |   |-- CMakeLists.txt (for test)
    |   |   |-- comp
    |   |   |   |-- inc
    |   |   |   |   |-- netfile1.hpp
    |   |   |   |   |-- netfile2.hpp
    |   |   |   |   |-- netfile3.hpp
    |   |   |   |   |-- netfile4.hpp
    |   |   |   |   |-- netfile5.hpp
    |   |   |   `-- src
    |   |   |       |-- netfile1.cpp
    |   |   |       |-- netfile2.cpp
    |   |   |       |-- netfile3.cpp
    |   |   |       |-- netfile4.cpp
    |   |   |       |-- netfile5.cpp
    |   |   `-- test
    |   |       |-- inc
    |   |       |   |-- nettestfile1.hpp
    |   |       `-- src
    |   |           |-- nettestfile1.cpp
    |   |           |-- nettestfile2.cpp
    |   |           |-- nettestfile3.cpp
    |   |-- comp3
    |   |   |-- CMakeLists.txt (for test)
    |   |   |-- comp
    |   |   |   |-- CMakeLists.txt (for lib)
    |   |   |   |-- intf
    |   |   |   |   |-- comp3file1.hpp
    |   |   |   |   `-- comp3file2.hpp
    |   |   |   `-- src
    |   |   |       `-- comp3file1.cpp
    |   |   `-- test
    |   |       `-- src
    |   |           `-- comp3testfile1.cpp
    |   |-- log
    |   |   `-- comp
    |   |       |-- inc
    |   |       |   |-- logfile1.hpp
    |   |       |   |-- logfile2.hpp
    |   |       |-- intf
    |   |       |   |-- logfile3.hpp
    |   |       |   |-- logfile4.hpp
    |   |       `-- src
    |   |           |-- logfile1.cpp
    |   |           |-- logfile2.cpp
    |   |           |-- logfile3.cpp
    |   |           `-- logfile4.cpp
    |   |-- comp4
    |   |   |-- CMakeLists.txt (for test)
    |   |   |-- comp
    |   |   |   |-- CMakeLists.txt (for lib)
    |   |   |   |-- intf
    |   |   |   |   |-- comp4file1.hpp
    |   |   |   |   |-- comp4file2.hpp
    |   |   |   |   |-- comp4file3.hpp
    |   |   |   `-- src
    |   |   |       |-- comp4file1.cpp
    |   |   |       |-- comp4file2.cpp
    |   |   |       `-- comp4file3.cpp
    |   |   `-- test
    |   |       |-- inc
    |   |       |   |-- comp4testfile1.hpp
    |   |       |   `-- comp4testfile2.hpp
    |   |       `-- src
    |   |           |-- comp4testfile1.cpp
    |   |           |-- comp4testfile2.cpp
    |   |           |-- comp4testfile3.cpp
    |   |           |-- comp4testfile4.cpp
    |   |           `-- comp4testfile5.cpp
    |-- gcc-4.8.cmake
    |-- gcc-4.9.cmake
    `-- gcc-default.cmake

我知道它中有很多“comp”,但这个命名并不取决于我......

每个comp都有2个CMakefiles: 最高级别是创建一个单元测试可执行文件来测试模块。 comp中的一个是创建一个库。这样它就可以与app CMakefile中的add_subdirectory一起使用。

问题是很多模块都依赖于common,common-net和log。 目前,这些部件不是作为库构建的。我猜是因为如果在多个模块中使用add_subdirectory会出现问题?这个干净吗?

这会导致: 每个从属模块都包含comp CMakefile中的公共头。 在顶层(app CMakefile),公共源被添加到可执行文件中。 但是对于每个模块测试,我还必须将公共源添加到测试可执行文件中。

这对我来说很奇怪,我觉得有些不对劲。但我不知道如何彻底解决它?

查看项目树以及独立测试每个模块的需要。 在顶层添加源的方法是否正确?或者没有完成?

1 个答案:

答案 0 :(得分:4)

因此,如果我理解正确,您有两个不同的问题:必须为每个可执行文件添加公共源,并且必须包含每个可执行文件的公共标头。

您真正应该做的是使每个公共代码库成为CMake静态库目标。 CMake解决了项目中库和可执行文件之间的依赖关系,这就是你所拥有的。只要在使用该代码之前添加公共代码(common,common-net和log)的子目录,就可以执行类似

的操作。
target_link_libraries(comp2 common common-net log)

在每个comp文件夹中,CMake将处理依赖项和链接。

此外,您可以将包含路径(以及其他内容)附加到目标,并且它们将自动应用于链接到目标的任何内容。

因此,例如,对于日志库,您可以使用

target_include_directories(log PUBLIC inc intf)

然后,链接到日志库的任何内容都会自动将comp/log/comp/inccomp/log/comp/intf文件夹添加到其标头路径中。

最后,如果我理解正确,当您需要可执行测试时,add_subdirectory - comp4/CMakeLists.txt文件,并在需要构建库时使用comp4/comp/CMakeLists.txt文件包括进入应用程序。更好的方法是让测试也链接到库。

因此,总之,您的项目结构应该看起来像这样:

顶级CMakeLists.txt

add_subdirectory(comp)
add_subdirectory(app)

COMP /的CMakeLists.txt

add_subdirectory(common)
add_subdirectory(common-net)
add_subdirectory(log)
add_subdirectory(comp1)
<and so on for the other comps>

COMP /公共网/的CMakeLists.txt

add_subdirectory(comp)
add_executable(test-common-net <source for test>)
target_link_libraries(test-common-net common-net)

COMP /公共网/ COMP /的CMakeLists.txt

add_library(common-net STATIC <source for common-net>)
target_include_directories(common-net PUBLIC inc)

# assuming common-net depends on common
target_link_libraries(common-net common)

COMP / COMP1 /的CMakeLists.txt

add_subdirectory(comp)
add_executable(test-comp1 <source for test>)
target_link_libraries(test-comp1 comp1)

COMP / COMP1 / COMP /的CMakeLists.txt

add_library(comp1 STATIC <source for common-net>)
target_include_directories(comp1 PUBLIC inc)

target_link_libraries(comp1 common common-net log)

你现在可能已经明白了。您只需要创建一个彼此依赖的库链。