C++ Clang Tooling：自定义静态分析与代码重构工具

好的，各位观众老爷，欢迎来到“C++ Clang Tooling：手搓代码神器，告别996”现场！我是今天的讲师，人称“Bug终结者”，江湖诨号“代码老中医”。 今天咱们不讲高深的理论，只聊点实在的——如何用Clang Tooling打造属于你自己的代码分析和重构工具，让你在代码的海洋里横着走！

开场白：为什么我们需要Clang Tooling？

话说，咱们程序员最痛苦的事情是什么？不是加班，不是改需求，而是对着一坨屎山代码，一脸懵逼，根本不知道这玩意儿是干嘛的！更痛苦的是，让你去改这坨代码，简直就是生无可恋。

这时候，如果你有一个趁手的工具，能帮你自动分析代码，找出潜在的Bug，自动重构代码，让代码变得清晰易懂，那简直就是救星啊！

Clang Tooling就是这么一个救星！它基于Clang编译器，可以让你深入到代码的语法树中，进行各种骚操作，实现各种强大的功能。

第一部分：Clang Tooling 入门：磨刀不误砍柴工

要想用好Clang Tooling，首先得了解它是个什么玩意儿。简单来说，Clang Tooling就是一套基于Clang编译器的工具集，它可以让你：

• 解析C++代码： 把你的代码变成一棵语法树（AST），让你对代码的结构一目了然。
• 遍历语法树： 像遍历文件目录一样，遍历代码的语法树，找到你感兴趣的节点。
• 修改语法树： 在语法树上进行各种修改，比如添加代码、删除代码、修改代码等等。
• 生成新的代码： 把修改后的语法树转换成新的C++代码。

听起来是不是很牛逼？别急，咱们一步一步来。

1.1 安装 Clang 和 LLVM

首先，你得安装Clang和LLVM。这个过程因操作系统而异，我就不细说了。一般来说，用包管理器安装是最方便的。比如，在Ubuntu上：

sudo apt-get update
sudo apt-get install clang llvm

1.2 创建一个简单的项目

咱们先创建一个简单的C++项目，用来练练手。

// main.cpp
#include <iostream>

int main() {
  int a = 10;
  int b = 20;
  int c = a + b;
  std::cout << "Result: " << c << std::endl;
  return 0;
}

1.3 创建一个 Clang Tooling 项目

接下来，创建一个Clang Tooling项目。一般来说，我们需要创建一个CMakeLists.txt文件来管理项目。

# CMakeLists.txt
cmake_minimum_required(VERSION 3.0)
project(MyTool)

find_package(LLVM REQUIRED)

include_directories(${LLVM_INCLUDE_DIRS})
link_directories(${LLVM_LIBRARY_DIRS})
add_definitions(${LLVM_DEFINITIONS})

add_executable(mytool mytool.cpp)
target_link_libraries(mytool clangTooling clangFrontend clangAST clangBasic)

1.4 编写第一个 Clang Tooling 工具

现在，咱们来编写第一个Clang Tooling工具，这个工具的功能很简单，就是打印出代码中所有的变量名。

// mytool.cpp
#include "clang/AST/ASTConsumer.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/Frontend/FrontendAction.h"
#include "clang/Tooling/Tooling.h"
#include <iostream>

using namespace clang;
using namespace clang::tooling;

// 定义一个 AST 访问器，用来遍历语法树
class MyVisitor : public RecursiveASTVisitor<MyVisitor> {
public:
  explicit MyVisitor(ASTContext *Context) : Context(Context) {}

  // 覆写 VisitDecl 函数，当遇到声明时调用
  bool VisitDecl(Decl *D) {
    if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
      // 如果是变量声明，打印变量名
      llvm::outs() << "Variable Name: " << VD->getNameAsString() << "n";
    }
    return true;
  }

private:
  ASTContext *Context;
};

// 定义一个 AST 消费者，用来创建访问器
class MyConsumer : public ASTConsumer {
public:
  explicit MyConsumer(ASTContext *Context) : Visitor(Context) {}

  // 覆写 HandleTranslationUnit 函数，当翻译单元解析完成后调用
  void HandleTranslationUnit(ASTContext &Context) override {
    Visitor.TraverseDecl(Context.getTranslationUnitDecl());
  }

private:
  MyVisitor Visitor;
};

// 定义一个前端动作，用来创建消费者
class MyAction : public ASTFrontendAction {
public:
  std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
                                                   StringRef file) override {
    return std::make_unique<MyConsumer>(&CI.getASTContext());
  }
};

int main(int argc, const char **argv) {
  // 创建一个命令行工具
  CommonOptionsParser OptionsParser(argc, argv, "My Tool");
  ClangTool Tool(OptionsParser.getCompilations(),
                  OptionsParser.getSourcePathList());

  // 运行工具
  return Tool.run(newFrontendActionFactory<MyAction>().get());
}

1.5 编译和运行工具

mkdir build
cd build
cmake ..
make
./mytool ../main.cpp --

运行结果：

Variable Name: a
Variable Name: b
Variable Name: c

恭喜你，你已经成功运行了你的第一个Clang Tooling工具！

第二部分：Clang Tooling 进阶：十八般武艺样样精通

现在，咱们已经掌握了Clang Tooling的基本用法，接下来，咱们来学习一些更高级的技巧，让你的工具更加强大。

2.1 AST 匹配器（AST Matcher）

AST 匹配器是Clang Tooling中最强大的工具之一，它可以让你根据特定的模式匹配语法树中的节点。比如，你可以用AST匹配器找到所有的if语句，或者找到所有的函数调用。

// 查找所有的 binary operator '+'
StatementMatcher BinaryOperatorMatcher = binaryOperator(hasOperatorName("+")).bind("binaryOperator");

class MyMatchCallback : public MatchFinder::MatchCallback {
public:
  virtual void run(const MatchFinder::MatchResult &Result) {
    if (const BinaryOperator *BO = Result.Nodes.getNodeAs<BinaryOperator>("binaryOperator")) {
      BO->dump();
    }
  }
};

int main(int argc, const char **argv) {
  // ...
  MatchFinder Finder;
  MyMatchCallback Callback;
  Finder.addMatcher(BinaryOperatorMatcher, &Callback);

  return Tool.run(newFrontendActionFactory(&Finder).get());
}

2.2 代码重构（Code Refactoring）

Clang Tooling不仅可以分析代码，还可以重构代码。你可以用Clang Tooling自动修改代码，比如自动添加注释、自动格式化代码、自动提取函数等等。

// 将 a + b 替换为 b + a
class MyMatchCallback : public MatchFinder::MatchCallback {
public:
  MyMatchCallback(Replacements *Replace) : Replace(Replace) {}

  virtual void run(const MatchFinder::MatchResult &Result) {
    if (const BinaryOperator *BO = Result.Nodes.getNodeAs<BinaryOperator>("binaryOperator")) {
      SourceRange Range(BO->getLHS()->getSourceRange().getBegin(), BO->getRHS()->getSourceRange().getEnd());
      std::string ReplacementText = BO->getRHS()->getSourceRange().getBegin().printToString(Result.SourceManager) + " + " + BO->getLHS()->getSourceRange().getBegin().printToString(Result.SourceManager);
      Replace->add(Replacement(Result.SourceManager, Range, ReplacementText));
    }
  }
private:
  Replacements *Replace;
};

int main(int argc, const char **argv) {
  // ...
  Replacements Replace;
  MyMatchCallback Callback(&Replace);
  Finder.addMatcher(BinaryOperatorMatcher, &Callback);

  Tool.run(newFrontendActionFactory(&Finder).get());
  FileID ID = SourceMgr.getFileID(SourceMgr.getMainFileID());
  Replace.apply(SourceMgr, ReplaceOptions());
  llvm::outs() << SourceMgr.getBufferData(ID).str();

  return 0;
}

2.3 编写自定义的检查器（Custom Checker）

Clang Static Analyzer 已经提供了很多内置的检查器，但是有时候我们需要编写自己的检查器，来检查特定的代码模式。Clang Tooling也可以用来编写自定义的检查器。

编写自定义检查器需要继承clang::ento::Checker类，并实现一些虚函数，比如checkPreStmt、checkPostStmt、checkDecl等等。

第三部分：Clang Tooling 实战：打造你的代码神器

现在，咱们已经掌握了Clang Tooling的各种技巧，接下来，咱们来做一个实际的项目，打造一个属于你的代码神器。

3.1 自动添加函数注释

很多时候，我们需要给函数添加注释，说明函数的功能、参数、返回值等等。如果手动添加注释，非常繁琐。我们可以用Clang Tooling自动添加函数注释。

需求：

• 自动给所有没有注释的函数添加注释。
• 注释内容包括函数名、参数列表、返回值类型等等。

实现思路：

• 用AST匹配器找到所有的函数声明。
• 判断函数是否已经有注释。
• 如果没有注释，则生成注释文本，并添加到函数声明之前。

代码示例：

// 查找所有函数声明
DeclarationMatcher FunctionDeclMatcher = functionDecl().bind("functionDecl");

class MyMatchCallback : public MatchFinder::MatchCallback {
public:
  MyMatchCallback(Replacements *Replace) : Replace(Replace) {}

  virtual void run(const MatchFinder::MatchResult &Result) {
    if (const FunctionDecl *FD = Result.Nodes.getNodeAs<FunctionDecl>("functionDecl")) {
      // 判断函数是否已经有注释
      if (FD->hasLeadingComment()) {
        return;
      }

      // 生成注释文本
      std::string CommentText = "/**n";
      CommentText += " * @brief " + FD->getNameAsString() + " 函数n";
      CommentText += " * @param ";
      for (auto Param : FD->parameters()) {
        CommentText += Param->getNameAsString() + " " + Param->getType().getAsString() + "n";
      }
      CommentText += " * @return " + FD->getReturnType().getAsString() + "n";
      CommentText += " */n";

      // 添加注释
      SourceRange Range(FD->getBeginLoc());
      Replace->add(Replacement(Result.SourceManager, Range, CommentText));
    }
  }

private:
  Replacements *Replace;
};

3.2 自动检查代码风格

代码风格对于代码的可读性和可维护性非常重要。我们可以用Clang Tooling自动检查代码风格，并给出警告或错误。

需求：

• 检查函数名是否符合命名规范（比如，函数名必须以小写字母开头）。
• 检查行长度是否超过限制（比如，每行最多120个字符）。
• 检查是否使用了Magic Number（比如，直接使用数字10，而不是定义一个常量）。

实现思路：

• 用AST匹配器找到所有的函数声明、变量声明、表达式等等。
• 根据代码风格规范，检查代码是否符合规范。
• 如果不符合规范，则输出警告或错误信息。

代码示例：

// 检查函数名是否符合命名规范
DeclarationMatcher FunctionDeclMatcher = functionDecl().bind("functionDecl");

class MyMatchCallback : public MatchFinder::MatchCallback {
public:
  virtual void run(const MatchFinder::MatchResult &Result) {
    if (const FunctionDecl *FD = Result.Nodes.getNodeAs<FunctionDecl>("functionDecl")) {
      std::string FunctionName = FD->getNameAsString();
      if (!std::islower(FunctionName[0])) {
        llvm::outs() << "Warning: Function name '" << FunctionName << "' should start with a lowercase lettern";
      }
    }
  }
};

第四部分：Clang Tooling 高级技巧：登峰造极

如果你想成为Clang Tooling的大师，还需要掌握一些高级技巧。

4.1 使用 LibTooling API

LibTooling API是Clang Tooling的核心API，它提供了各种强大的功能，比如解析代码、遍历语法树、修改语法树等等。掌握LibTooling API，可以让你更加灵活地使用Clang Tooling。

4.2 使用 Clang Static Analyzer

Clang Static Analyzer是一个强大的静态分析工具，它可以帮助你发现代码中的Bug、漏洞、性能问题等等。你可以把Clang Static Analyzer集成到你的Clang Tooling工具中，让你的工具更加强大。

4.3 编写自定义的 AST 节点

Clang Tooling的语法树是基于Clang编译器的，有时候我们需要扩展语法树，添加自定义的AST节点。比如，我们可以添加一个自定义的AST节点，用来表示一个自定义的语言结构。

总结：Clang Tooling，你的代码百宝箱

Clang Tooling是一个非常强大的工具，它可以让你深入到代码的语法树中，进行各种骚操作，实现各种强大的功能。只要你掌握了Clang Tooling，就可以打造属于你自己的代码分析和重构工具，让你在代码的海洋里横着走！

功能	描述
代码分析	自动查找代码中的Bug、漏洞、性能问题等等。
代码重构	自动修改代码，比如自动添加注释、自动格式化代码、自动提取函数等等。
代码风格检查	自动检查代码风格，并给出警告或错误。
自定义检查器	编写自定义的检查器，来检查特定的代码模式。
自动化代码生成	基于模板自动生成代码，比如自动生成测试代码、自动生成API接口等等。
代码文档生成	自动生成代码文档，比如自动生成API文档、自动生成代码注释文档等等。
跨平台代码转换	将代码从一个平台移植到另一个平台，比如将Windows代码移植到Linux平台。
语义分析	深入分析代码的语义，比如分析代码的依赖关系、分析代码的控制流等等。
代码安全审计	检查代码是否存在安全漏洞，比如缓冲区溢出、SQL注入、跨站脚本攻击等等。
代码质量评估	评估代码的质量，比如代码的可读性、可维护性、可测试性等等。

希望今天的讲座对大家有所帮助。记住，代码不是一天写成的，神器也不是一天炼成的。多练习，多实践，你也能成为Clang Tooling的大师！

感谢大家的观看！下次再见！