CMake入门教程【基础篇】有效源文件组织

开始

定义模块

选择 add_executable 或 add_library

创建源文件列表

使用子目录

应用变量和循环

注意事项

完成源文件组织

概述

在任何软件项目中，合理组织源文件是至关重要的。在CMake项目中，这一点尤其重要，因为源文件的组织方式直接影响构建配置的复杂性和维护性。本教程将介绍如何在CMake项目中有效地组织源文件。

1. 基本原则

在CMake中组织源文件时，应遵循以下基本原则：

• 模块化：将相关的源文件组织到同一目录下，形成模块。
• 清晰结构：源文件的目录结构应清晰、有逻辑，便于理解和维护。
• 避免冗余：避免重复的文件和代码，确保项目的整洁。

2. 使用 add_executable 和 add_library

• add_executable：用于指定生成可执行文件所需的源文件。
• add_library：用于创建库文件，可以是静态库或动态库。

示例

cmakeCopy codeadd_executable(my_app main.cpp helper.cpp)
add_library(my_lib STATIC util.cpp logger.cpp)

3. 源文件列表

创建包含所有源文件的变量，然后在add_executable或add_library中使用这个变量。

示例

cmakeCopy codeset(SOURCE_FILES main.cpp helper.cpp util.cpp logger.cpp)
add_executable(my_app ${SOURCE_FILES})

4. 使用子目录

对于大型项目，使用add_subdirectory将项目划分为多个子目录，每个子目录包含其专属的CMakeLists.txt文件。

示例

假设项目结构如下：

objectivecCopy codeproject/
│
├── CMakeLists.txt
│
├── src/
│   ├── CMakeLists.txt
│   └── main.cpp
│
└── lib/
    ├── CMakeLists.txt
    └── helper.cpp

在顶层CMakeLists.txt中：

cmakeCopy codeadd_subdirectory(src)
add_subdirectory(lib)

5. 使用变量和循环

当源文件数量较多时，可以使用变量和循环来简化CMakeLists.txt。

示例

cmakeCopy codefile(GLOB_RECURSE MY_SOURCES "src/*.cpp")
add_executable(my_app ${MY_SOURCES})

注意事项

• 文件路径：确保使用正确的相对路径或绝对路径。
• 文件扩展名：注意不同平台文件扩展名的区别，特别是在跨平台项目中。
• GLOB使用：虽然file(GLOB ...)和file(GLOB_RECURSE ...)方便，但它们可能会导致构建系统在新文件添加时不稳定。

总结

开发者 CMake脚本 定义源文件和模块 应用 add_executable/add_library 整合源文件列表 划分子目录 使用变量和循环 完成源文件组织 开发者 CMake脚本

有效地组织源文件是CMake项目成功的关键之一。通过采用模块化的方法、合理使用CMake命令和结构化的项目布局，您可以创建清晰、可维护的构建配置。随着项目的增长，这些实践将确保您的CMake项目能够轻松适应变化和扩展。