C++ 怎么在 CMake 构建系统中集成自定义的编译器插件与静态检查步骤

大伟君_1918

大伟君_1918

2026-11-05

481人浏览

原创

CMake本身不支持“编译器插件”,因其仅为构建系统,不解析语法或加载插件;所谓集成实为透传参数(如-Xclang -load)或添加自定义检查任务(如cppcheck、clang-tidy)。

c++ 怎么在 cmake 构建系统中集成自定义的编译器插件与静态检查步骤

为什么 CMake 本身不支持“编译器插件”这个概念

CMake 不是编译器,它不解析语法、不执行语义检查,也不加载插件。所谓“集成编译器插件”,实际是指在构建流程中插入额外的静态分析命令(比如 cppcheck、clang-tidy),或通过编译器前端参数(如 -Xclang -load)让 Clang 加载自定义 AST 插件——但后者要求你已编译好插件 so/dll,并且 CMake 只负责把参数透传过去。

绝大多数开发者真正需要的,不是写 LLVM 插件,而是让 cppcheck 或 clang-tidy 在 cmake --build 过程中自动运行一次,并把结果暴露在终端或日志里。这和“插件”无关,本质是任务编排。

用 add_custom_target 实现 cppcheck 静态检查步骤

这是最轻量、最可控的方式:不侵入编译逻辑,不拖慢常规构建,但能一键触发检查。适用于 Windows + MinGW 或 Linux/macOS 环境。

  • cppcheck 必须已安装并可在命令行直接调用(cppcheck --version 能成功)
  • 在项目根目录的 CMakeLists.txt 末尾添加:
add_custom_target(check-code
    COMMAND cppcheck --enable=all --inconclusive --suppress=missingIncludeSystem
        --project=${CMAKE_BINARY_DIR}/compile_commands.json
    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
    COMMENT "Running cppcheck static analysis"
)
  • --project=... 参数依赖 compile_commands.json,所以需先启用导出:set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  • 若不用 JSON,可直接指定源码路径:COMMAND cppcheck --enable=all src/ include/
  • 执行检查只需:cmake --build build --target check-code(Windows 下用 mingw32-make check-code)

Clang-Tidy 怎么在 CMake 中启用并绑定到 build 步骤

Clang-Tidy 是更贴近“编译器集成”的选择,它能读取编译选项、理解模板实例化,还能自动修复部分问题。但它对 MinGW 工具链支持有限,更适合 Clang/LLVM 环境(如 MSVC+Clang-CL 或 WSL+Clang)。

C++14
C++14

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

下载
  • 确保 clang-tidy 可执行文件在 PATH 中(clang-tidy --version 成功)
  • 在 CMakeLists.txt 中开启支持:
set(CMAKE_CXX_CLANG_TIDY "clang-tidy;-checks=-*,cppcoreguidelines-*,-cppcoreguidelines-pro-bounds-array-to-pointer-decay")
set(CMAKE_C_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY})
  • 上述配置会让每次 cmake --build 编译 .cpp 文件时,自动跑一遍 clang-tidy;警告会混在编译输出里(不是独立 target)
  • 若想只检查不编译,加 -quiet 并配合 add_custom_target;若要生成 HTML 报告,得自己封装脚本调用 clang-tidy -export-fixes
  • 注意:MinGW-w64 默认用 GCC,不带 clang-tidy 支持;强行指定会失败,报错类似 clang-tidy: command not found 或 unsupported compiler

Clang 自定义 AST 插件的极简接入方式(仅限 Clang 环境)

如果你真写了 .so 插件(比如检测某个内部宏展开规则),CMake 唯一要做的就是把加载指令塞进编译参数。它不验证插件是否存在,也不管符号导出是否正确——这些全由 Clang 运行时决定。

  • 假设插件路径为 ${CMAKE_SOURCE_DIR}/plugins/libMyChecker.so,且已通过 clang++ -Xclang -load -Xclang libMyChecker.so 验证可用
  • 在 CMakeLists.txt 中添加:
if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Xclang -load -Xclang $<mychecker_plugin>")
    # 或更稳妥的绝对路径写法:
    # set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Xclang -load -Xclang ${CMAKE_SOURCE_DIR}/plugins/libMyChecker.so")
endif()</mychecker_plugin>
  • mychecker_plugin 是一个 dummy target,仅用于生成路径(可选);多数人直接写死绝对路径更可靠
  • 插件必须与当前 Clang 版本 ABI 兼容,否则编译时会静默失败或崩溃;建议用 llvm-config --version 和插件编译时的版本严格对齐
  • 这种做法无法跨平台,MSVC/MinGW 完全不识别 -Xclang 参数,CMake 不报错但编译器会忽略或报错

真正难的从来不是怎么写那几行 CMake,而是插件本身的 ABI 稳定性、错误处理粒度、以及如何让它在 CI 中稳定产出可读报告——这些 CMake 一概不管。

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

相关专题

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

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

2024.03.14

2288

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

347

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

1429

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人学习