使用 Cppcheck 进行静态代码分析:一个完整的shell脚本

2024-06-08 12:52

本文主要是介绍使用 Cppcheck 进行静态代码分析:一个完整的shell脚本,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 使用 Cppcheck 进行静态代码分析:一个完整的 shell脚本
    • 安装 Cppcheck
      • 1. 克隆 Cppcheck 仓库
      • 2. 构建和安装 Cppcheck
    • 检测原理
    • 脚本介绍
    • 脚本详解
      • 1. 基本选项
      • 2. 额外选项
      • 3. 抑制选项
      • 4. 包含路径
    • 检测
      • 1. 使用 CMake 生成 `compile_commands.json`
      • 2. 运行 Cppcheck
    • 结果示例

使用 Cppcheck 进行静态代码分析:一个完整的 shell脚本

本文将介绍如何使用 Cppcheck 进行静态代码分析,并提供一个完整的shell脚本。

安装 Cppcheck

1. 克隆 Cppcheck 仓库

首先,从 GitHub 克隆 Cppcheck 仓库:

git clone https://github.com/danmar/cppcheck.git
cd cppcheck

2. 构建和安装 Cppcheck

使用以下命令构建和安装 Cppcheck:

mkdir build
cd build
cmake ..
make
sudo make install

检测原理

Cppcheck 使用多种技术来分析 C/C++ 代码,包括但不限于以下几种:

  1. 语法解析:Cppcheck 使用自定义的语法解析器来理解 C/C++ 代码的结构。这包括函数、类、变量的定义和使用等。

  2. 数据流分析:Cppcheck 分析变量和数据在代码中的流动情况,以检测未初始化变量、空指针引用等问题。

  3. 符号执行:通过模拟代码执行路径,Cppcheck 能够发现逻辑错误和潜在的运行时问题。

  4. 配置驱动:Cppcheck 允许用户通过配置文件和命令行参数定制检查规则和抑制特定的警告,以减少误报并专注于真正的问题。

  5. 编译数据库:Cppcheck 支持读取编译数据库(如 compile_commands.json),从而准确地了解项目的编译选项和文件依赖关系。

通过以上技术,Cppcheck 能够在不需要编译代码的情况下,提供深入且全面的代码质量检查。

脚本介绍

下面是一个用于运行 Cppcheck 的 Bash 脚本。该脚本配置了多个选项和抑制规则,以减少误报并生成详细的检查器报告。

#!/bin/bash# cppcheck 命令行选项
OPTIONS="--enable=style \--enable=performance \--enable=portability \--check-level=exhaustive"# 根据你的配置,添加相应的检查项
EXTRA_OPTIONS="--enable=information \--enable=unusedFunction"# 根据你的配置,添加相应的抑制选项
SUPPRESS="--suppress=information \--suppress=missingInclude \--suppress=missingIncludeSystem \--suppress=unmatchedSuppression \--suppress=passedByValue \--suppress=unusedFunction \--suppress=uninitMemberVar \--suppress=uninitvar \--suppress=nullPointer \--suppress=shadowVariable \--suppress=variableScope \--suppress=duplicateExpression \--suppress=useInitializationList"# 包含路径
INCLUDE="-I /usr/include -I/usr/local/include"# 运行 cppcheck
cppcheck --project=compile_commands.json $OPTIONS $EXTRA_OPTIONS $SUPPRESS $INCLUDE --checkers-report=checkers_report.txt

脚本详解

1. 基本选项

OPTIONS="--enable=style \--enable=performance \--enable=portability \--check-level=exhaustive"
  • --enable=style:启用代码风格检查。
  • --enable=performance:启用性能检查。
  • --enable=portability:启用可移植性检查。
  • --check-level=exhaustive:进行详尽的检查,分析所有代码分支,尽管这样可能会增加分析时间。

2. 额外选项

EXTRA_OPTIONS="--enable=information \--enable=unusedFunction"
  • --enable=information:启用信息级别的检查。
  • --enable=unusedFunction:启用未使用函数的检查。

3. 抑制选项

SUPPRESS="--suppress=information \--suppress=missingInclude \--suppress=missingIncludeSystem \--suppress=unmatchedSuppression \--suppress=passedByValue \--suppress=unusedFunction \--suppress=uninitMemberVar \--suppress=uninitvar \--suppress=nullPointer \--suppress=shadowVariable \--suppress=variableScope \--suppress=duplicateExpression \--suppress=useInitializationList"

这些选项用于抑制特定类型的警告,减少误报。例如:

  • --suppress=missingIncludeSystem:忽略缺少系统包含文件的警告。
  • --suppress=uninitMemberVar:忽略未初始化成员变量的警告。

4. 包含路径

INCLUDE="-I /usr/include -I/usr/local/include"

指定包含路径,以确保分析过程中能找到所有必要的头文件。

检测

1. 使用 CMake 生成 compile_commands.json

为了使用 Cppcheck 的 --project 选项,你需要一个 compile_commands.json 文件。这个文件是一个编译数据库,包含项目中所有源文件的编译信息。
如果你的项目使用 CMake 构建,可以通过以下命令生成 compile_commands.json 文件:

cd /path/to/your/project
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .

运行上述命令后,会在项目的构建目录中生成一个 compile_commands.json 文件。

2. 运行 Cppcheck

cppcheck --project=compile_commands.json $OPTIONS $EXTRA_OPTIONS $SUPPRESS $INCLUDE --checkers-report=checkers_report.txt
  • --project=compile_commands.json:指定项目的编译数据库文件。
  • --checkers-report=checkers_report.txt:生成包含所有检查器详细信息的报告文件。

结果示例

Checking /home/test/cppcheck/example.cpp ...
Checking /home/test/cppcheck/example.cpp: ALLOC_HOOK_VERSION=0xfe9abbf;__PIC__=1...
/home/test/cppcheck/example.cpp:13:10: style: Variable 'intPtr' can be declared as pointer to const [constVariablePointer]int* intPtr = new int[100];  // 分配int类型的内存^
/home/test/cppcheck/example.cpp:18:13: style: Variable 'doublePtr' can be declared as pointer to const [constVariablePointer]double* doublePtr = new double(3.14);  // 分配double类型的内存^
/home/test/cppcheck/example.cpp:23:18: style: Variable 'strPtr' can be declared as pointer to const [constVariablePointer]std::string* strPtr = new std::string("Hello, World!");  // 分配字符串类型的内存^
/home/test/cppcheck/example.cpp:40:11: style: Variable 'mmapPtr' can be declared as pointer to const [constVariablePointer]void* mmapPtr = mmap(nullptr, mmapSize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);

这篇关于使用 Cppcheck 进行静态代码分析:一个完整的shell脚本的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/1042243

相关文章

Java中的Cursor使用详解

《Java中的Cursor使用详解》本文介绍了Java中的Cursor接口及其在大数据集处理中的优势,包括逐行读取、分页处理、流控制、动态改变查询、并发控制和减少网络流量等,感兴趣的朋友一起看看吧... 最近看代码,有一段代码涉及到Cursor,感觉写法挺有意思的。注意是Cursor,而不是Consumer

javaScript在表单提交时获取表单数据的示例代码

《javaScript在表单提交时获取表单数据的示例代码》本文介绍了五种在JavaScript中获取表单数据的方法:使用FormData对象、手动提取表单数据、使用querySelector获取单个字... 方法 1:使用 FormData 对象FormData 是一个方便的内置对象,用于获取表单中的键值

Vue ElementUI中Upload组件批量上传的实现代码

《VueElementUI中Upload组件批量上传的实现代码》ElementUI中Upload组件批量上传通过获取upload组件的DOM、文件、上传地址和数据,封装uploadFiles方法,使... ElementUI中Upload组件如何批量上传首先就是upload组件 <el-upl

Node.js net模块的使用示例

《Node.jsnet模块的使用示例》本文主要介绍了Node.jsnet模块的使用示例,net模块支持TCP通信,处理TCP连接和数据传输,具有一定的参考价值,感兴趣的可以了解一下... 目录简介引入 net 模块核心概念TCP (传输控制协议)Socket服务器TCP 服务器创建基本服务器服务器配置选项服

Python3脚本实现Excel与TXT的智能转换

《Python3脚本实现Excel与TXT的智能转换》在数据处理的日常工作中,我们经常需要将Excel中的结构化数据转换为其他格式,本文将使用Python3实现Excel与TXT的智能转换,需要的可以... 目录场景应用:为什么需要这种转换技术解析:代码实现详解核心代码展示改进点说明实战演练:从Excel到

如何使用CSS3实现波浪式图片墙

《如何使用CSS3实现波浪式图片墙》:本文主要介绍了如何使用CSS3的transform属性和动画技巧实现波浪式图片墙,通过设置图片的垂直偏移量,并使用动画使其周期性地改变位置,可以创建出动态且具有波浪效果的图片墙,同时,还强调了响应式设计的重要性,以确保图片墙在不同设备上都能良好显示,详细内容请阅读本文,希望能对你有所帮助...

Rust中的注释使用解读

《Rust中的注释使用解读》本文介绍了Rust中的行注释、块注释和文档注释的使用方法,通过示例展示了如何在实际代码中应用这些注释,以提高代码的可读性和可维护性... 目录Rust 中的注释使用指南1. 行注释示例:行注释2. 块注释示例:块注释3. 文档注释示例:文档注释4. 综合示例总结Rust 中的注释

Python脚本实现图片文件批量命名

《Python脚本实现图片文件批量命名》这篇文章主要为大家详细介绍了一个用python第三方库pillow写的批量处理图片命名的脚本,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录前言源码批量处理图片尺寸脚本源码GUI界面源码打包成.exe可执行文件前言本文介绍一个用python第三方库pi

Linux使用cut进行文本提取的操作方法

《Linux使用cut进行文本提取的操作方法》Linux中的cut命令是一个命令行实用程序,用于从文件或标准输入中提取文本行的部分,本文给大家介绍了Linux使用cut进行文本提取的操作方法,文中有详... 目录简介基础语法常用选项范围选择示例用法-f:字段选择-d:分隔符-c:字符选择-b:字节选择--c

使用Go语言开发一个命令行文件管理工具

《使用Go语言开发一个命令行文件管理工具》这篇文章主要为大家详细介绍了如何使用Go语言开发一款命令行文件管理工具,支持批量重命名,删除,创建,移动文件,需要的小伙伴可以了解下... 目录一、工具功能一览二、核心代码解析1. 主程序结构2. 批量重命名3. 批量删除4. 创建文件/目录5. 批量移动三、如何安