Cppcheck规则编写入门指南：从正则表达式到自定义检测规则

Cppcheck规则编写入门指南：从正则表达式到自定义检测规则

【免费下载链接】cppcheck static analysis of C/C++ code 项目地址: https://gitcode.com/gh_mirrors/cpp/cppcheck

引言

Cppcheck作为一款开源的静态代码分析工具，其强大之处在于允许开发者自定义检测规则。本文将深入浅出地介绍如何为Cppcheck编写自定义规则，帮助开发者扩展其代码检查能力。

Cppcheck代码处理机制

在编写规则前，必须理解Cppcheck如何处理源代码：

1. 代码简化：Cppcheck会过滤掉代码中的风格化信息（如缩进、注释等），专注于代码逻辑结构
2. 标准化格式：所有token之间都会插入空格，例如1+f()会被处理为1 + f ( )
3. 抽象语法树：规则基于处理后的中间表示而非原始代码

这种处理方式使规则编写者可以专注于代码逻辑而非格式细节。

规则编写基础步骤

编写Cppcheck规则主要分为两个阶段：

第一步：构建正则表达式模式

Cppcheck使用PCRE（Perl兼容正则表达式）库进行模式匹配。编写规则前，建议先通过以下方法查看代码的简化形式：

cppcheck --rule=".+" yourfile.cpp

这会输出经过Cppcheck处理后的代码形式，例如原始代码：

if (p)
    free(p);

可能被简化为：

if ( p ) { free ( p ) ; }

第二步：创建XML规则文件

规则文件采用XML格式，基本结构包含：

<?xml version="1.0"?>
<rule version="1">
  <pattern>你的正则表达式</pattern>
  <message>
    <id>唯一标识符</id>
    <severity>严重级别</severity>
    <summary>错误描述</summary>
  </message>
</rule>

实战案例：检测冗余条件

让我们通过一个实际例子学习如何创建规则。我们将检测以下可能存在问题的代码模式：

if (p)
    free(p);

1. 确定简化后的代码模式

通过测试命令，我们发现上述代码被简化为：

if ( p ) { free ( p ) ; }

2. 编写正则表达式

对应的正则表达式为：

if \( p \) { free \( p \) ; }

3. 创建完整规则文件

将正则表达式嵌入XML规则文件：

<?xml version="1.0"?>
<rule version="1">
  <pattern>if \( p \) { free \( p \) ; }</pattern>
  <message>
    <id>redundantCondition</id>
    <severity>style</severity>
    <summary>Redundant condition. It is valid to free a NULL pointer.</summary>
  </message>
</rule>

4. 测试规则

保存为dealloc.rule后，使用以下命令测试：

cppcheck --rule-file=dealloc.rule yourfile.cpp

进阶技巧

1. 使用捕获组：正则表达式中的捕获组可以用于生成更精确的错误信息
2. 多模式规则：一个规则可以包含多个<pattern>元素，匹配不同但相关的代码模式
3. 严重级别选择：可根据问题严重性选择error、warning、style等不同级别

注意事项

1. 正则表达式需要精确匹配简化后的代码形式
2. 所有特殊字符（如括号）都需要转义
3. 规则文件必须使用UTF-8编码
4. 建议为每个规则提供唯一的ID，便于管理和引用

通过掌握这些基础知识，您已经可以开始为Cppcheck编写简单的自定义规则了。后续可以学习更复杂的模式匹配和规则组合技巧，以构建更强大的代码分析规则集。

【免费下载链接】cppcheck static analysis of C/C++ code 项目地址: https://gitcode.com/gh_mirrors/cpp/cppcheck