C++在CMake中如何把源文件自动加入编译列表(aux_source_directory)

千丽小哥_8383

千丽小哥_8383

2026-10-25

813人浏览

原创

aux_source_directory 仅在配置阶段扫描一次,不感知新增文件,导致链接错误;应配合 target_sources() 增量注册,并避免直接用于 add_executable,file(glob) 同样不可靠且更危险。

c++在cmake中如何把源文件自动加入编译列表(aux_source_directory)

aux_source_directory 会漏掉新添加的 .cpp 文件

aux_source_directory 只在 CMake 配置阶段(即运行 cmake 命令时)扫描一次目录,它不会自动感知后续手动新增的源文件。如果你在 build/ 目录外编辑并保存了一个新 .cpp 文件,再直接 make 或 ninja,CMake 不会重新运行、也不会把该文件加进编译列表——结果就是链接时报 undefined reference,但连编译警告都没有。

常见误用场景:团队协作中有人加了新文件,却忘了告诉别人要重跑 cmake;或者 CI 脚本里只执行 make,没触发 CMake 重新配置。

  • 它只匹配当前目录(不递归子目录),除非你显式对每个子目录都调一次
  • 匹配规则是 shell glob,不是正则:*.cpp 可以,*.cc|*.cpp 不行
  • 不会包含头文件(.h/.hpp),这点没问题,但有人误以为能自动处理头依赖
  • 生成的变量是普通 list,不能直接传给 target_sources()(后者要求命名 target)

正确写法:用 list(APPEND) + target_sources() 替代 add_executable() 的全量参数

现代 CMake(3.10+)推荐显式管理源文件,但若真想“半自动”,应避免把 aux_source_directory 结果直接塞进 add_executable(myapp main.cpp ${SRC_LIST}) —— 这种写法会让 CMake 无法跟踪源文件变更,IDE(如 CLion)也无法索引新文件。

更可靠的做法是:先用 aux_source_directory 收集,再用 target_sources() 增量注册到已有 target:

add_executable(myapp main.cpp)
aux_source_directory(src SRC_LIST)
target_sources(myapp PRIVATE ${SRC_LIST})

这样 CMake 能识别这些文件属于 myapp,支持 IDE 刷新、依赖自动推导、甚至 Ninja 的增量构建感知。

  • PRIVATE 表示这些源只用于本 target,不影响接口
  • 如果源文件需要被其他 target include(比如含模板实现),改用 PUBLIC 并配合 target_include_directories()
  • 注意 ${SRC_LIST} 是空字符串时不会报错,但 target 会少文件——建议加 message(WARNING "No sources found in src/") 辅助调试

为什么不用 file(GLOB)?它比 aux_source_directory 更危险

file(GLOB) 看似更灵活(支持 ** 递归、可过滤子目录),但它和 aux_source_directory 有同一个致命问题:CMake 不监视 glob 匹配结果的变化。更糟的是,file(GLOB) 的结果是静态快照,连配置阶段新增的文件都捕获不到(除非手动删 CMakeCache.txt 强制重扫)。

C++14
C++14

C++14 对 C++11 的修正与增强版本,适合旧系统维护和较老工具链兼容。

下载

官方文档明确说:“We do not recommend using GLOB to collect a list of source files from your source tree. If no CMakeLists.txt file changes when a source is added or removed then the generated build system cannot know when to ask CMake to regenerate.”

  • 哪怕你写了 file(GLOB_RECURSE SRC "*.cpp"),新增 src/util/new.cpp 后,不重跑 cmake 就不会编译它
  • file(GLOB) 不区分大小写(Windows/macOS 默认行为),可能意外匹配到 .CPP 或 .CpP,而编译器不一定认
  • 某些旧版 CMake(** 支持不一致,跨平台 CI 容易出问题

真正省心的做法:用现代 CMake 的源文件自动发现(CMake 3.20+)

CMake 3.20 引入了 file(GLOB_RECURSE ... CONFIGURE_DEPENDS),这个标记会让 CMake 在构建前检查 glob 匹配的文件是否变动,并自动触发重新配置。但它仅在部分生成器(Ninja、Makefiles)上有效,且 Windows MSVC 下不可靠。

更稳的路径是放弃“自动发现”,改用脚本辅助管理——例如写个 Python 小脚本扫描 src/ 下所有 .cpp,输出标准格式的 set(SRC_LIST ...) 到临时 sources.cmake,然后在 CMakeLists.txt 里 include(sources.cmake)。这样既保持 CMakeLists 清洁,又让 IDE 和构建系统都能感知变化。

不过多数项目走到这一步,其实更适合回归显式列表——因为文件增删本就是开发者的主动行为,值得在版本控制里留下明确痕迹。一个清晰的 add_executable(...) 参数列表,比任何自动机制都更易审查、迁移和调试。

最常被忽略的一点:即使用了 CONFIGURE_DEPENDS,CMake 也只检查文件是否存在/被删除,不检查文件内容是否从 .txt 改成了 .cpp——这种边界情况,只有显式声明才真正可靠。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.14

2248

9

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

1039

6

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

447

5

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

327

5

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

426

5

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

600

5

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.21

1409

9

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

2024.03.22

1237

7

c++和c语言学习顺序推荐
c++和c语言学习顺序推荐

对于初学者,建议先学习C语言,掌握编程基础后再转入C++,便于理解面向对象编程概念。有编程经验者可直接学习C++,快速接触高级编程技术。想了解更多c++和c语言的相关内容,可以阅读本专题下面的文章。

2024.03.25

1325

9

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习