1 //===---- ClangQuery.cpp - clang-query tool -------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This tool is for interactive exploration of the Clang AST using AST matchers. 11 // It currently allows the user to enter a matcher at an interactive prompt and 12 // view the resulting bindings as diagnostics, AST pretty prints or AST dumps. 13 // Example session: 14 // 15 // $ cat foo.c 16 // void foo(void) {} 17 // $ clang-query foo.c -- 18 // clang-query> match functionDecl() 19 // 20 // Match #1: 21 // 22 // foo.c:1:1: note: "root" binds here 23 // void foo(void) {} 24 // ^~~~~~~~~~~~~~~~~ 25 // 1 match. 26 // 27 //===----------------------------------------------------------------------===// 28 29 #include "Query.h" 30 #include "QueryParser.h" 31 #include "QuerySession.h" 32 #include "clang/Frontend/ASTUnit.h" 33 #include "clang/Tooling/CommonOptionsParser.h" 34 #include "clang/Tooling/Tooling.h" 35 #include "llvm/LineEditor/LineEditor.h" 36 #include "llvm/Support/CommandLine.h" 37 #include "llvm/Support/MemoryBuffer.h" 38 #include "llvm/Support/Signals.h" 39 #include <fstream> 40 #include <string> 41 42 using namespace clang; 43 using namespace clang::ast_matchers; 44 using namespace clang::ast_matchers::dynamic; 45 using namespace clang::query; 46 using namespace clang::tooling; 47 using namespace llvm; 48 49 static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage); 50 static cl::OptionCategory ClangQueryCategory("clang-query options"); 51 52 static cl::list<std::string> Commands("c", cl::desc("Specify command to run"), 53 cl::value_desc("command"), 54 cl::cat(ClangQueryCategory)); 55 56 static cl::list<std::string> CommandFiles("f", 57 cl::desc("Read commands from file"), 58 cl::value_desc("file"), 59 cl::cat(ClangQueryCategory)); 60 61 int main(int argc, const char **argv) { 62 llvm::sys::PrintStackTraceOnErrorSignal(); 63 64 CommonOptionsParser OptionsParser(argc, argv, ClangQueryCategory); 65 66 if (!Commands.empty() && !CommandFiles.empty()) { 67 llvm::errs() << argv[0] << ": cannot specify both -c and -f\n"; 68 return 1; 69 } 70 71 ClangTool Tool(OptionsParser.getCompilations(), 72 OptionsParser.getSourcePathList()); 73 std::vector<std::unique_ptr<ASTUnit>> ASTs; 74 if (Tool.buildASTs(ASTs) != 0) 75 return 1; 76 77 QuerySession QS(ASTs); 78 79 if (!Commands.empty()) { 80 for (cl::list<std::string>::iterator I = Commands.begin(), 81 E = Commands.end(); 82 I != E; ++I) { 83 QueryRef Q = QueryParser::parse(I->c_str(), QS); 84 if (!Q->run(llvm::outs(), QS)) 85 return 1; 86 } 87 } else if (!CommandFiles.empty()) { 88 for (cl::list<std::string>::iterator I = CommandFiles.begin(), 89 E = CommandFiles.end(); 90 I != E; ++I) { 91 std::ifstream Input(I->c_str()); 92 if (!Input.is_open()) { 93 llvm::errs() << argv[0] << ": cannot open " << *I << "\n"; 94 return 1; 95 } 96 while (Input.good()) { 97 std::string Line; 98 std::getline(Input, Line); 99 100 QueryRef Q = QueryParser::parse(Line.c_str(), QS); 101 if (!Q->run(llvm::outs(), QS)) 102 return 1; 103 } 104 } 105 } else { 106 LineEditor LE("clang-query"); 107 LE.setListCompleter([&QS](StringRef Line, size_t Pos) { 108 return QueryParser::complete(Line, Pos, QS); 109 }); 110 while (llvm::Optional<std::string> Line = LE.readLine()) { 111 QueryRef Q = QueryParser::parse(*Line, QS); 112 Q->run(llvm::outs(), QS); 113 llvm::outs().flush(); 114 if (QS.Terminate) 115 break; 116 } 117 } 118 119 return 0; 120 } 121