initial commit for LibTooling tutorial files

Author: kevinaboos

Example.cpp

@@ -0,0 +1,127 @@
+#include "clang/Driver/Options.h"
+#include "clang/AST/AST.h"
+#include "clang/AST/ASTContext.h"
+#include "clang/AST/ASTConsumer.h"
+#include "clang/AST/RecursiveASTVisitor.h"
+#include "clang/Frontend/ASTConsumers.h"
+#include "clang/Frontend/FrontendActions.h"
+#include "clang/Frontend/CompilerInstance.h"
+#include "clang/Tooling/CommonOptionsParser.h"
+#include "clang/Tooling/Tooling.h"
+#include "clang/Rewrite/Core/Rewriter.h"
+
+using namespace std;
+using namespace clang;
+using namespace clang::driver;
+using namespace clang::tooling;
+using namespace llvm;
+
+Rewriter rewriter;
+int numFunctions = 0;
+
+
+class ExampleVisitor : public RecursiveASTVisitor<ExampleVisitor> {
+private:
+    ASTContext *astContext; // used for getting additional AST info
+
+public:
+    explicit ExampleVisitor(CompilerInstance *CI) 
+      : astContext(&(CI->getASTContext())) // initialize private members
+    {
+        rewriter.setSourceMgr(astContext->getSourceManager(), astContext->getLangOpts());
+    }
+
+    virtual bool VisitFunctionDecl(FunctionDecl *func) {
+        numFunctions++;
+        string funcName = func->getNameInfo().getName().getAsString();
+        if (funcName == "do_math") {
+            rewriter.ReplaceText(func->getLocation(), funcName.length(), "add5");
+            errs() << "** Rewrote function def: " << funcName << "\n";
+        }    
+        return true;
+    }
+
+    virtual bool VisitStmt(Stmt *st) {
+        if (ReturnStmt *ret = dyn_cast<ReturnStmt>(st)) {
+            rewriter.ReplaceText(ret->getRetValue()->getLocStart(), 6, "val");
+            errs() << "** Rewrote ReturnStmt\n";
+        }        
+        if (CallExpr *call = dyn_cast<CallExpr>(st)) {
+            rewriter.ReplaceText(call->getLocStart(), 7, "add5");
+            errs() << "** Rewrote function call\n";
+        }
+        return true;
+    }
+
+/*
+    virtual bool VisitReturnStmt(ReturnStmt *ret) {
+        rewriter.ReplaceText(ret->getRetValue()->getLocStart(), 6, "val");
+        errs() << "** Rewrote ReturnStmt\n";
+        return true;
+    }
+
+    virtual bool VisitCallExpr(CallExpr *call) {
+        rewriter.ReplaceText(call->getLocStart(), 7, "add5");
+        errs() << "** Rewrote function call\n";
+        return true;
+    }
+*/
+};
+
+
+
+class ExampleASTConsumer : public ASTConsumer {
+private:
+    ExampleVisitor *visitor; // doesn't have to be private
+
+public:
+    // override the constructor in order to pass CI
+    explicit ExampleASTConsumer(CompilerInstance *CI)
+        : visitor(new ExampleVisitor(CI)) // initialize the visitor
+    { }
+
+    // override this to call our ExampleVisitor on the entire source file
+    virtual void HandleTranslationUnit(ASTContext &Context) {
+        /* we can use ASTContext to get the TranslationUnitDecl, which is
+             a single Decl that collectively represents the entire source file */
+        visitor->TraverseDecl(Context.getTranslationUnitDecl());
+    }
+
+/*
+    // override this to call our ExampleVisitor on each top-level Decl
+    virtual bool HandleTopLevelDecl(DeclGroupRef DG) {
+        // a DeclGroupRef may have multiple Decls, so we iterate through each one
+        for (DeclGroupRef::iterator i = DG.begin(), e = DG.end(); i != e; i++) {
+            Decl *D = *i;    
+            visitor->TraverseDecl(D); // recursively visit each AST node in Decl "D"
+        }
+        return true;
+    }
+*/
+};
+
+
+
+class ExampleFrontendAction : public ASTFrontendAction {
+public:
+    virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI, StringRef file) {
+        return new ExampleASTConsumer(&CI); // pass CI pointer to ASTConsumer
+    }
+};
+
+
+
+int main(int argc, const char **argv) {
+    // parse the command-line args passed to your code
+    CommonOptionsParser op(argc, argv);        
+    // create a new Clang Tool instance (a LibTooling environment)
+    ClangTool Tool(op.getCompilations(), op.getSourcePathList());
+
+    // run the Clang Tool, creating a new FrontendAction (explained below)
+    int result = Tool.run(newFrontendActionFactory<ExampleFrontendAction>());
+
+    errs() << "\nFound " << numFunctions << " functions.\n\n";
+    // print out the rewritten source code ("rewriter" is a global var.)
+    rewriter.getEditBuffer(rewriter.getSourceMgr().getMainFileID()).write(errs());
+    return result;
+}

Makefile

@@ -0,0 +1,16 @@
+CLANG_LEVEL := ../..
+
+TOOLNAME = example  #the name of your tool's executable
+
+SOURCES := Example.cpp  #the Clang source files you want to compile
+
+include $(CLANG_LEVEL)/../../Makefile.config
+
+LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option
+ 
+USEDLIBS = clangFrontend.a clangSerialization.a clangDriver.a \
+           clangTooling.a clangParse.a clangSema.a \
+           clangAnalysis.a clangRewriteFrontend.a clangRewriteCore.a \
+	   clangEdit.a clangAST.a clangLex.a clangBasic.a
+
+include $(CLANG_LEVEL)/Makefile

run_example.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+LLVM_DIR=~/static_analysis/llvm/  #the location of your llvm dir
+$LLVM_DIR/Debug+Asserts/bin/example test.c -- 

test.c

@@ -0,0 +1,9 @@
+void do_math(int *x) {
+  *x += 5;
+}
+
+int main(void) {
+  int result = -1, val = 4;
+  do_math(&val);
+  return result;
+}