Floorp项目中的静态分析：编写AST匹配器详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00407/article/details/148486981

Floorp项目中的静态分析：编写AST匹配器详解

Floorp The most of source code of version 10 or later of Floorp Browser, the most Advanced and Fastest Firefox derivative 🦊 项目地址: https://gitcode.com/gh_mirrors/fl/Floorp

什么是AST匹配器

在Floorp项目的静态分析工具中，AST（抽象语法树）匹配器是一种强大的工具，它允许开发者通过声明式语法来查找和匹配代码中的特定模式。AST匹配器基于Clang的ASTMatcher库，为代码质量检查提供了灵活而精确的匹配能力。

匹配器的三种类型

1. 节点匹配器（Node Matchers）

节点匹配器可以理解为语法树中的"名词"，它们匹配特定类型的AST节点。例如：

functionDecl()：匹配函数声明
binaryOperator()：匹配二元操作符
varDecl()：匹配变量声明

这些匹配器构成了我们查询的基础，确定了我们要查找的"东西"的类型。

2. 限定匹配器（Narrowing Matchers）

限定匹配器相当于"形容词"，用于进一步描述和限制节点匹配器的匹配范围。它们必须与节点匹配器一起使用。常见的有：

parameterCountIs(1)：限制参数数量为1
isDefinition()：匹配定义而非声明
unless(isVariadic())：排除可变参数函数

限定匹配器通过提供额外的约束条件，帮助我们精确锁定目标代码。

3. 遍历匹配器（Traversal Matchers）

遍历匹配器也属于描述性匹配器，但它们关注的是节点在程序中的上下文关系。例如：

hasArraySize(integerLiteral(equals(10)))：匹配数组大小为10的情况
hasParent(forStmt())：匹配for循环内的节点
hasAncestor(namespaceDecl())：匹配命名空间内的节点

这类匹配器让我们能够基于代码的结构和上下文关系进行匹配。

匹配器开发的最佳实践

在Floorp项目中开发高质量的匹配器需要遵循以下步骤：

明确匹配目标：清晰定义你要匹配的代码模式
准备测试用例：
- 编写应该匹配的代码示例（多种变体）
- 编写不应该匹配但相似的代码示例
迭代开发：
- 从简单匹配开始
- 逐步添加约束条件
- 每次修改后验证匹配结果

实战示例：开发复杂匹配器

让我们通过一个实际案例来演示如何在Floorp项目中开发一个复杂的匹配器。

目标：匹配函数调用中参数为赋值表达式且右侧为整数字面量，同时函数参数有默认值的情况。

测试代码

int add1(int a, int b) { return a + b; }
int add2(int c, int d = 8) { return c + d; }

int main() {
   int x, y, z;
   add1(x, y);     // 不应匹配：无赋值
   add1(3 + 4, y); // 不应匹配：无赋值
   add1(z = x, y); // 不应匹配：赋值但非字面量
   add1(z = 2, y); // 不应匹配：赋值且为字面量，但参数无默认值
   add2(3, z = 2); // 应匹配：满足所有条件
}

开发过程

基础匹配：先匹配所有函数调用
```
callExpr()
```

添加参数匹配：匹配带参数的调用

callExpr(forEachArgumentWithParam(anything(), anything()))

限定参数类型：匹配参数为赋值操作的情况

callExpr(forEachArgumentWithParam(binaryOperator(isAssignmentOperator()), anything()))

进一步限定：匹配赋值右侧为整数字面量

callExpr(forEachArgumentWithParam(
    binaryOperator(allOf(
        isAssignmentOperator(),
        hasRHS(integerLiteral())
    )),
    anything()
))

最终限定：确保函数参数有默认值

callExpr(forEachArgumentWithParam(
    binaryOperator(allOf(
        isAssignmentOperator(),
        hasRHS(integerLiteral())
    )),
    hasDefaultArgument()
))

通过这种逐步细化的方法，我们最终得到了能够精确匹配目标代码的匹配器。