首选cmake项目结构

Question

我想要以下结构A -> B -> C，其中：

• C 是样板代码、第三方库的包装器、非常基本的代码等。
• B 是特定于项目域的公共类、函数和数据结构。
• A 是项目本身。

我想让它易于重用C或B(+C)将来在我的其他项目中使用。此外，我还有以下要求：

1. 由于所有三个项目都在建，我想有建设的能力C，C+B并C+B+A一个炮打响。
2. 我宁愿在动态静态链接，这样C和C+B将静态库，并且C+B+A将可执行
3. 我想让 cmake 列表和配置文件保持简单和干净。我在官方维基和互联网上找到的例子非常庞大和可怕。
4. 如果我更改A,B或C文件系统中的位置，它不需要更改多于几行，那就太好了。
5. 所有这三个组件都在使用 google-test，但我不确定它对项目布局是否重要。

我对 cmake 很陌生，我什至不明白写文件XXXConfig.cmake或FindXXX.cmake文件更好。另外，我不确定，我应该如何使用X_INCLUDE_DIRS.

Answer 1

首先，我必须承认我同意@Tsyvarev。您的 CMake 环境应适合您的流程/工作流程，并应考虑项目规模和团队结构。或者一般来说，CMake 将被使用的环境。这往往 - 从积极的方面 - 非常活跃。

所以你的这部分问题很难回答，我将专注于技术部分：

1. CMake 必须知道依赖项的位置 - 相对或绝对 - 通过
   • 拥有一个单一的源代码树（你不再想要的那个）
     • 具有多个可执行文件的 CMake 共享库
     • CMake：如何设置 Source、Library 和 CMakeLists.txt 依赖项？
   • 包含/库/二进制文件的公共目录位置
     • CMake 库输出的自定义目录
     • cmake install 不在 Windows 上安装库
   • 通过配置文件/变量定义获取路径
     • 如何让 cmake 找到我的替代 boost 安装？
     • 如何为 CMake 构建过程本身添加_custom_command()？
   • 使用主机上提供的数据库注册或安装
     • 使其他 cmake 包自动访问 cmake 库
     • cmake 不会在 ExternalProject_Add 中正确运行 build_command
2. 为了让您的 CMake 文件尽可能简单，我建议将您的 CMake 代码分组到单独的专用文件中：
   • 优先使用工具链文件而不是if(SomeCompiler)语句
   • 将公共/重复代码部分作为function()主体移动到共享的 CMake 包含文件中
   • 将复杂的非目标特定代码部分移动到它们自己的 (CMake) 脚本文件中

示例代码

由于您特别要求使用该find_package()变体，因此请在您的 CMake 项目中使用启用 CMake 的库以及上面列出的内容：

MyCommonCode.cmake

cmake_policy(SET CMP0022 NEW)

function(my_export_target _target _include_dir)
    file(
        WRITE "${CMAKE_CURRENT_BINARY_DIR}/${_target}Config.cmake"
        "
            include(\"\$\{CMAKE_CURRENT_LIST_DIR\}/${_target}Targets.cmake\")
            set_property(
                TARGET ${_target} 
                APPEND PROPERTY 
                    INTERFACE_INCLUDE_DIRECTORIES \"${_include_dir}\"
            )
        "
    )

    export(
        TARGETS ${_target} 
        FILE "${CMAKE_CURRENT_BINARY_DIR}/${_target}Targets.cmake"
        EXPORT_LINK_INTERFACE_LIBRARIES
    )
    export(PACKAGE ${_target}) 
endfunction(my_export_target)

C/CMakeLists.txt

include(MyCommonCode.cmake)
...
my_export_target(C "${CMAKE_CURRENT_SOURCE_DIR}/include")

B/CMakeLists.txt

include(MyCommonCode.cmake)

find_package(C REQUIRED)
...
target_link_libraries(B C)
my_export_target(B "${CMAKE_CURRENT_SOURCE_DIR}/include")

A/CMakeLists.txt

include(MyCommonCode.cmake)

find_package(B REQUIRED)
...
target_link_libraries(A B)

这将所有 3 个构建环境分开，仅共享相对静态的MyCommonCode.cmake文件。因此，在这种方法中，到目前为止我还没有涵盖您的第一点，但建议使用外部脚本来链接/触发 A/B/C 的构建步骤。