CMake笔记之GLOB和GLOB_RECURSE的使用方法

—— 杭州 2024-03-19 夜

1.GLOB使用方法

在 CMake 中，file(GLOB ...) 命令用于将匹配特定模式的文件列表赋值给变量。这可以用来自动收集源代码文件列表，而不是手动指定每个文件。

然而，这种做法有一个潜在的问题：如果新文件被添加到目录中，CMake 不会自动知道需要重新运行以更新文件列表。这意味着您可能需要手动重新运行 CMake 以确保新文件被包含在构建中。由于这个原因，显式指定源文件通常是推荐的做法。

但是，如果你确定要使用 file(GLOB ...)，以下是一个示例：

假设你的项目目录结构如下：

/my_project
|-- CMakeLists.txt
|-- src
|   |-- main.cpp
|   |-- utility.cpp
|   |-- helper.cpp
|-- include
    |-- utility.h
    |-- helper.h

在 /my_project/CMakeLists.txt 中，你可以使用 file(GLOB ...) 来收集源文件：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 设置变量包含所有源文件
file(GLOB MY_PROJECT_SOURCES "src/*.cpp")

# 设置变量包含所有头文件
file(GLOB MY_PROJECT_HEADERS "include/*.h")

# 创建可执行文件
add_executable(MyProject ${MY_PROJECT_SOURCES})

# 包含头文件目录
target_include_directories(MyProject PRIVATE include)

在上面的例子中，file(GLOB MY_PROJECT_SOURCES "src/*.cpp") 将会在 src 目录下匹配所有 .cpp 文件，并将它们的列表赋值给变量 MY_PROJECT_SOURCES。

以下表格总结了 file(GLOB ...) 的基本用法：

命令	描述
file(GLOB VAR <pattern1> [<pattern2> ...])	将所有匹配模式 <pattern> 的文件赋值给变量 VAR。
file(GLOB VAR RELATIVE <path> <pattern1> [<pattern2> ...])	与 GLOB 类似，但是返回的文件路径是相对于给定的 <path>。
file(GLOB_RECURSE VAR <pattern1> [<pattern2> ...])	递归地将所有匹配模式的文件赋值给变量 VAR。
file(GLOB_RECURSE VAR RELATIVE <path> <pattern1> [<pattern2> ...])	与 GLOB_RECURSE 类似，但是返回的文件路径是相对于给定的 <path>。

请记住，GLOB 会捕获所有匹配模式的文件，包括可能不想包含在项目中的文件。另外，由于 GLOB 不会导致 CMake 在新文件添加到目录中时自动重新运行，因此可能会导致构建系统与文件系统状态不同步。因此，谨慎使用，并确保了解其潜在影响。

2.GLOB对比GLOB_RECURSE

使用 file(GLOB_RECURSE ...) 示例：

如果你想要递归地匹配指定模式的文件，可以使用 file(GLOB_RECURSE ...)。例如：

# 递归地搜索所有的 .cpp 文件
file(GLOB_RECURSE SOURCES "src/*.cpp")

# 递归地搜索所有的 .h 文件
file(GLOB_RECURSE HEADERS "include/*.h")

这将会在 src 和 include 目录及其所有子目录中搜索 .cpp 和 .h 文件。

表格说明：

命令	描述	示例
file(GLOB ...)	匹配给定模式的文件，不递归子目录。	file(GLOB MY_SRCS "src/*.cpp")
file(GLOB_RECURSE ...)	递归匹配给定模式的文件。	file(GLOB_RECURSE MY_SRCS "src/**/*.cpp")

在实际项目中，出于上述提到的原因，很多开发者更倾向于显式地列出源文件，以确保 CMake 在文件改动时能够正确地重新生成构建系统。但在某些情况下，如果文件经常变化，而且你不想每次都手动更新 CMakeLists.txt 文件，使用 GLOB 可能会更方便。只要记得在添加或删除文件后，要重新运行 CMake 以更新构建系统。