LLVM（二）——Clang插件

https://mirror.tuna.tsinghua.edu.cn/help/llvm/

git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/llvm.git

cd llvm/tools
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/clang.git

cd ../projects
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/compiler-rt.git
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/libcxx.git
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/libcxxabi.git

cd ../tools/clang/tools
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/clang-tools-extra.git

brew list

brew install cmake

mkdir build_xcode
cd build_xcode

cmake -G Xcode ../llvm

add_llvm_library( NormanPlugin MODULE BUILDTREE_ONLY
  NormanPlugin.cpp
)

#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 NormanPlugin {

    // 4，分析相关的节点
    class NormanMatchCallback: public MatchFinder::MatchCallback {
    private:
        // 4.3 编译器实例对象
        CompilerInstance &CI;

        // 4.4 判断是否是自己写的文件（值检查自己创建的文件，不检查系统的文件）
        bool isUserSourceCode(const string filename) {
            if (filename.empty()) return false;

            // 非Xcode中的源码都认为是用户源码
            if (filename.find("/Applications/Xcode.app/") == 0) return false;

            return true;
        }

        // 4.5 判断是否应该用copy修饰，这里定的是不可变的字符串、字典、数组都应使用copy
        bool isShouldUseCopy(const string typeStr) {
            if (typeStr.find("NSString") != string::npos ||
                typeStr.find("NSArray") != string::npos ||
                typeStr.find("NSDictionary") != string::npos) {
                return true;
            }

            return false;
        }

    public:

        // 4.1 构造器函数
        NormanMatchCallback(CompilerInstance &CI):CI(CI){}

        // 4.2 节点的具体分析
        void run(const MatchFinder::MatchResult &Result) {
            // 4.2.1 通过MatchResult结果获取到要研究的节点（这里研究的是属性节点）
            const ObjCPropertyDecl *propertyDecl = Result.Nodes.getNodeAs<ObjCPropertyDecl>("objcPropertyDecl");
            // 4.2.2 获取文件名称
            string filename = CI.getSourceManager().getFilename(propertyDecl->getSourceRange().getBegin()).str();

            // 4.2.3 如果节点有值，并且是用户自定义的文件（即非系统文件）
            if (propertyDecl && isUserSourceCode(filename)) {
                string typeStr = propertyDecl->getType().getAsString(); // 拿到属性的类型
                ObjCPropertyDecl::PropertyAttributeKind attrKind = propertyDecl->getPropertyAttributes(); // 拿到节点的描述信息

                // 如果应该使用copy但是却没有使用，那么就报出警告
                if (isShouldUseCopy(typeStr) && !(attrKind & ObjCPropertyDecl::OBJC_PR_copy)) {
                    cout<<typeStr<<"应该用copy修饰而没用Copy，发出警告！"<<endl;
                    DiagnosticsEngine &diag = CI.getDiagnostics(); // 诊断引擎
                    // 在编译器中发出警告信息
                    // Report函数的第一个参数是警告报出的位置，第二个参数是警告信息
                    // getCustomDiagID函数的第一个参数是警告级别，第2个参数是警告的文案信息
                    diag.Report(propertyDecl->getBeginLoc(), diag.getCustomDiagID(DiagnosticsEngine::Warning, "%0这个地方推荐用Copy"))<<typeStr;
                }
            }
        }
    };

    // 3，自定义继承自ASTConsumer的NormanConsumer
    // ASTConsumer是专门用来解析AST抽象语法树里面的节点的
    class NormanConsumer: public ASTConsumer {
    private:
        MatchFinder matcher; // MatchFinder是AST语法树各节点的过滤器（过滤你所要研究的节点）
        NormanMatchCallback callback; // 在callback里面对相关节点进行分析研究
    public:
        // 3.1 构造器方法
        NormanConsumer(CompilerInstance &CI):callback(CI) {
            // 添加一个MatchFinder去匹配objcPropertyDecl节点（因为我要研究的是属性，所以需要匹配属性节点）
            // 在NormanMatchCallback的run方法里面去研究相关的节点
            matcher.addMatcher(objcPropertyDecl().bind("objcPropertyDecl"), &callback);
        }

        // 3.2 解析完一个顶级的声明就会来到这里执行（所谓顶级，指的就是最外层）
        bool HandleTopLevelDecl(DeclGroupRef D) override {
//            cout<<"开始解析顶级节点！"<<endl;
            return true;
        }

        // 3.3 在整个文件都解析完后被调用
        void HandleTranslationUnit(ASTContext &context) override {
            cout<<"解析完毕了！"<<endl;
            matcher.matchAST(context); // 生成AST之后将其给到matcher，然后matcher就会对AST进行分析
        }
    };

    // 1，继承PluginASTAction实现我们自定义的Action
    class NormanASTAction: public PluginASTAction { // PluginASTAction用于分析抽象语法树时采取的动作
    public:
        // 1.1
        bool ParseArgs(const CompilerInstance &CI,const vector<string> &arg){
            return true;
        }

        // 1.2 绑定ASTConsumer
        unique_ptr <ASTConsumer> CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
            // 注意哦，这里的CI是编译器实例对象，文件路径的检查、编译器警告的发送都是通过它来完成
            return unique_ptr <NormanConsumer> (new NormanConsumer(CI));
        }

    };

}

// 2，注册NormanPlugin插件
static FrontendPluginRegistry::Add<NormanPlugin::NormanASTAction> X("NormanPlugin", "This is the description of the plugin");

自己编译的?????clang????文件路径 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator12.2.sdk/(自己电脑上对应SDK的路径) -Xclang -load -Xclang 插件??(.dylib)路径?? -Xclang -add-plugin -Xclang 插件名??? -c 源码路径????

/Users/liwei/LLVM/build_xcode/Debug/bin/clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk/ -Xclang -load -Xclang /Users/liwei/LLVM/build_xcode/Debug/lib/NormanPlugin.dylib -Xclang -add-plugin -Xclang NormanPlugin -c /Users/liwei/Desktop/Test/Test/ViewController.m

 -Xclang -load -Xclang Clang插件动态库路径(.dylib)????? -Xclang -add-plugin -Xclang Clang插件名称NormanPlugin