前言

上一篇文章LLVM编译流程中，我们弄清楚了LLVM将源码转变成mach-o文件的编译过程，今天我带大家自定义一个Clang插件，自动检测属性的Copy属性修饰符。

一、准备工作

在自定义Clang插件之前，我们必须搭建一下环境，需要下载LLVM项目源码和CMake工程配置插件。

1.1 搭建LLVM的环境

首先，我们先下载LLVM项目的相关源码，下载地址，这里我们只需下载6个安装包，clang、clang-tools-extra、compiler-rt、libcxx、libcxxabi、llvm，目前都是11.0.0版本，如下图👇

然后，创建文件夹，解压上述安装包，配置环境 （我们在桌面上创建文件夹为例。）

• 在桌面创建文件夹（暂且命名为PluginExample）👇

• 解压安装包至PluginExample，移除后缀描述及版本号信息👇

• 移动指定文件夹

1. 将clang-tools-extra移到clang/tools/中
2. 将clang文件夹移到llvm/tools/中

3. 将compiler-rt、libcxx、libcxxabi都移到llvm/projects/中

1.2 安装cmake

• 通过以下指令，查看brew列表，检查是否安装过cmake，如果有cmake，就跳过此步骤

brew list

• 如果没有，就使用brew安装，指令👇

brew install cmake

注意：如果报权限错误，可sudo chown -R admin/usr/local/share放开权限

1.3 使用cmake搭建Xcode工程

• 在llvm同级目录创建xcode_build文件夹，进入xcode_build文件夹，运行cmake命令👇，将llvm源码编译成Xcode项目

cd xcode_build
cmake -G Xcode ../llvm
// 或者： cmake -G Xcode CMAKE_BUILD_TYPE="Release" ../llvm
// 或者： cmake -G Xcode CMAKE_BUILD_TYPE="debug" ../llvm

注意：一定要保证xcode_build 和 llvm 是同一层级的目录。如果报llvm中找不到CMakeLists.txt，就说明你的路径没有配置正确。

指令执行完成后，就生成了Xcode项目👇

• 打开该工程，手动配置schema👇

  
  
  image.png

点击+号👇

点击红框处👇

依次输入clang 和 clangtooling，然后点击OK👇

然后Close👇

最后编译clang 和 clangtooling，注意：此处可能需要1小时，cpu温度会很高😂，注意降温！
至此，LLVM的环境搭建完成！

二、自定义插件

现在我们开始本篇的重点，自定义插件，实现自动校验属性的copy修饰符功能。

1. 我们在llvm/tools/clang/tools/文件夹中，创建XFPlugin文件夹，并新增两个文件CMakeLists.txt 和XFPlugin.cpp

2. 在CMakeLists.txt 中添加内容：add_llvm_library( HTPlugin MODULE BUILDTREE_ONLY HTPlugin.cpp)

3. 在llvm/tools/clang/tools/文件夹的CMakeLists.txt文件尾部，加上add_clang_subdirectory(XFPlugin)

4.编写插件代码👇

#include <iostream>
#include "clang/AST/AST.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/ASTConsumer.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Frontend/FrontendPluginRegistry.h"

using namespace clang;
using namespace std;
using namespace llvm;
using namespace clang::ast_matchers;
//命名空间，和插件同名
namespace XFPlugin {

//第三步：扫描完毕的回调函数
//4、自定义回调类，继承自MatchCallback
class XFMatchCallback: public MatchFinder::MatchCallback {
    
private:
    //CI传递路径：XFASTAction类中的CreateASTConsumer方法参数 - XFConsumer的构造函数 - XFMatchCallback的私有属性，通过构造函数从XFASTConsumer构造函数中获取
    CompilerInstance &CI;
    
    //判断是否是用户源文件
    bool isUserSourceCode(const string filename) {
        //文件名不为空
        if (filename.empty()) return  false;
        //非xcode中的源码都认为是用户的
        if (filename.find("/Applications/Xcode.app/") == 0) return false;
        return  true;
    }

    //判断是否应该用copy修饰
    bool isShouldUseCopy(const string typeStr) {
        //判断类型是否是NSString | NSArray | NSDictionary
        if (typeStr.find("NSString") != string::npos ||
            typeStr.find("NSArray") != string::npos ||
            typeStr.find("NSDictionary") != string::npos/*...*/)
        {
            return true;
        }
        
        return false;
    }
    
public:
    XFMatchCallback(CompilerInstance &CI) :CI(CI) {}
    
    //重写run方法
    void run(const MatchFinder::MatchResult &Result) {
        //通过result获取到相关节点 -- 根据节点标记获取（标记需要与XFASTConsumer构造方法中一致）
        const ObjCPropertyDecl *propertyDecl = Result.Nodes.getNodeAs<ObjCPropertyDecl>("objcPropertyDecl");
        //判断节点有值，并且是用户文件
        if (propertyDecl && isUserSourceCode(CI.getSourceManager().getFilename(propertyDecl->getSourceRange().getBegin()).str()) ) {
            //15、获取节点的描述信息
            ObjCPropertyAttribute::Kind attrKind = propertyDecl->getPropertyAttributes();
            //获取节点的类型，并转成字符串
            string typeStr = propertyDecl->getType().getAsString();
//            cout<<"---------拿到了："<<typeStr<<"---------"<<endl;
            
            //判断应该使用copy，但是没有使用copy
            if (propertyDecl->getTypeSourceInfo() && isShouldUseCopy(typeStr) && !(attrKind & ObjCPropertyAttribute::kind_copy)) {
                //使用CI发警告信息
                //通过CI获取诊断引擎
                DiagnosticsEngine &diag = CI.getDiagnostics();
                //通过诊断引擎 report报告 错误，即抛出异常
                /*
                错误位置：getBeginLoc 节点开始位置
                错误：getCustomDiagID（等级，提示）
                 */
                diag.Report(propertyDecl->getBeginLoc(), diag.getCustomDiagID(DiagnosticsEngine::Warning, "%0 - 这个地方推荐使用copy!!"))<< typeStr;
            }
        }
    }
};


//第二步：扫描配置完毕
//3、自定义XFASTConsumer，继承自ASTConsumer，用于监听AST节点的信息 -- 过滤器
class XFASTConsumer: public ASTConsumer {
private:
    //AST节点的查找过滤器
    MatchFinder matcher;
    //定义回调类对象
    XFMatchCallback callback;
    
public:
    //构造方法中创建matcherFinder对象
    XFASTConsumer(CompilerInstance &CI) : callback(CI) {
        //添加一个MatchFinder，每个objcPropertyDecl节点绑定一个objcPropertyDecl标识（去匹配objcPropertyDecl节点）
        //回调callback，其实是在XFMatchCallback里面重写run方法（真正回调的是回调run方法）
        matcher.addMatcher(objcPropertyDecl().bind("objcPropertyDecl"), &callback);
    }
    
    //实现两个回调方法 HandleTopLevelDecl 和 HandleTranslationUnit
    //解析完一个顶级的声明，就回调一次(顶级节点，相当于一个全局变量、函数声明)
    bool HandleTopLevelDecl(DeclGroupRef D){
//        cout<<"正在解析..."<<endl;
        return  true;
    }
    
    //整个文件都解析完成的回调
    void HandleTranslationUnit(ASTContext &context) {
//        cout<<"文件解析完毕!"<<endl;
        //将文件解析完毕后的上下文context（即AST语法树） 给 matcher
        matcher.matchAST(context);
    }
};

//2、继承PluginASTAction，实现我们自定义的Action，即自定义AST语法树行为
class XFASTAction: public PluginASTAction {
    
public:
    //重载ParseArgs 和 CreateASTConsumer方法
    bool ParseArgs(const CompilerInstance &ci, const std::vector<std::string> &args) {
        return true;
    }
    
    //返回ASTConsumer类型对象，其中ASTConsumer是一个抽象类，即基类
    /*
     解析给定的插件命令行参数。
     - param CI 编译器实例，用于报告诊断。
     - return 如果解析成功，则为true；否则，插件将被销毁，并且不执行任何操作。该插件负责使用CompilerInstance的Diagnostic对象报告错误。
     */
    unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, StringRef iFile) {
        //返回自定义的XFASTConsumer,即ASTConsumer的子类对象
        /*
         CI用于：
         - 判断文件是否使用户的
         - 抛出警告
         */
        return unique_ptr<XFASTConsumer> (new XFASTConsumer(CI));
    }
    
};

}

//第一步：注册插件，并自定义AST语法树Action类
//1、注册插件
static FrontendPluginRegistry::Add<XFPlugin::XFASTAction> XF("XFPlugin", "This is XFPlugin");

5. 我们回到xcode_build文件夹，清空之前的工程，重新cmake -G Xcode ../llvm编译生成新的工程。打开工程，可以发现我们自己的插件👇

6. 最后依次编译clang clangTooling XFPlugin。

三、使用插件

上面我们基本上完成了插件的开发流程，接下来就进入到插件的集成和使用了。

3.1 校验插件

在使用插件之前，我们可以通过终端指令👇，校验插件的有效性。

//命令格式
自己编译的clang文件路径 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.2.sdk/ -Xclang -load -Xclang 插件(.dyld)路径 -Xclang -add-plugin -Xclang 插件名 -c 源码路径
//例子
/Users/XXX/Desktop/build_xcode/Debug/bin/clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.2.sdk/ -Xclang -load -Xclang /Users/XXXX/Desktop/build_xcode/Debug/lib/CJLPlugin.dylib -Xclang -add-plugin -Xclang CJLPlugin -c /Users/XXXX/Desktop/XXX/XXXX/测试demo/testClang/testClang/ViewController.m

其中，测试的ViewController.m代码如下👇

@interface ViewController ()

@property (nonatomic, strong) NSString *name;
@property (nonatomic, strong) NSArray *arr;

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
}

在终端中输入指令，回车👇

3.2 Xcode示例项目中集成插件

1. Demo工程添加自定义插件 Build Settings ->Other C Flags 添加：

-Xclang -load -Xclang /Users/xxx/llvm/build/Debug/lib/XFPlugin.dylib -Xclang -add-plugin -Xclang XFPlugin
注意：/Users/xxx/llvm/build/Debug/lib/XFPlugin.dylib是自己的XFPlugin.dylib的绝对路径

2. Command + B编译，报错👇
   

需要再配置几项👇

添加两个CC 和 CXX👇

• CC对应的是自己编译的clang的绝对路径
• CXX对应的是自己编译的clang++的绝对路径

接着，在Build Settings栏目中搜索index👇

将Enable Index-Wihle-Building Functionality改为NO。再次run项目👇

至此，插件的集成和使用完毕！

总结

本篇文章大致介绍了llvm的环境搭建和自定义clang插件以及集成流程，相信大家都能基本掌握clang插件的开发流程。