clang-tools  11.0.0
ClangQuery.cpp
Go to the documentation of this file.
1 //===---- ClangQuery.cpp - clang-query tool -------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This tool is for interactive exploration of the Clang AST using AST matchers.
10 // It currently allows the user to enter a matcher at an interactive prompt and
11 // view the resulting bindings as diagnostics, AST pretty prints or AST dumps.
12 // Example session:
13 //
14 // $ cat foo.c
15 // void foo(void) {}
16 // $ clang-query foo.c --
17 // clang-query> match functionDecl()
18 //
19 // Match #1:
20 //
21 // foo.c:1:1: note: "root" binds here
22 // void foo(void) {}
23 // ^~~~~~~~~~~~~~~~~
24 // 1 match.
25 //
26 //===----------------------------------------------------------------------===//
27 
28 #include "Query.h"
29 #include "QueryParser.h"
30 #include "QuerySession.h"
31 #include "clang/Frontend/ASTUnit.h"
32 #include "clang/Tooling/CommonOptionsParser.h"
33 #include "clang/Tooling/Tooling.h"
34 #include "llvm/LineEditor/LineEditor.h"
35 #include "llvm/Support/CommandLine.h"
36 #include "llvm/Support/MemoryBuffer.h"
37 #include "llvm/Support/Signals.h"
38 #include "llvm/Support/WithColor.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 static cl::opt<std::string> PreloadFile(
62  "preload",
63  cl::desc("Preload commands from file and start interactive mode"),
64  cl::value_desc("file"), cl::cat(ClangQueryCategory));
65 
66 bool runCommandsInFile(const char *ExeName, std::string const &FileName,
67  QuerySession &QS) {
68  std::ifstream Input(FileName.c_str());
69  if (!Input.is_open()) {
70  llvm::errs() << ExeName << ": cannot open " << FileName << "\n";
71  return 1;
72  }
73 
74  std::string FileContent((std::istreambuf_iterator<char>(Input)),
75  std::istreambuf_iterator<char>());
76 
77  StringRef FileContentRef(FileContent);
78  while (!FileContentRef.empty()) {
79  QueryRef Q = QueryParser::parse(FileContentRef, QS);
80  if (!Q->run(llvm::outs(), QS))
81  return true;
82  FileContentRef = Q->RemainingContent;
83  }
84  return false;
85 }
86 
87 int main(int argc, const char **argv) {
88  llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
89 
90  llvm::Expected<CommonOptionsParser> OptionsParser =
91  CommonOptionsParser::create(argc, argv, ClangQueryCategory,
92  llvm::cl::OneOrMore);
93 
94  if (!OptionsParser) {
95  llvm::WithColor::error() << llvm::toString(OptionsParser.takeError());
96  return 1;
97  }
98 
99  if (!Commands.empty() && !CommandFiles.empty()) {
100  llvm::errs() << argv[0] << ": cannot specify both -c and -f\n";
101  return 1;
102  }
103 
104  if ((!Commands.empty() || !CommandFiles.empty()) && !PreloadFile.empty()) {
105  llvm::errs() << argv[0]
106  << ": cannot specify both -c or -f with --preload\n";
107  return 1;
108  }
109 
110  ClangTool Tool(OptionsParser->getCompilations(),
111  OptionsParser->getSourcePathList());
112  std::vector<std::unique_ptr<ASTUnit>> ASTs;
113  int Status = Tool.buildASTs(ASTs);
114  int ASTStatus = 0;
115  if (Status == 1) {
116  // Building ASTs failed.
117  return 1;
118  } else if (Status == 2) {
119  ASTStatus |= 1;
120  llvm::errs() << "Failed to build AST for some of the files, "
121  << "results may be incomplete."
122  << "\n";
123  } else {
124  assert(Status == 0 && "Unexpected status returned");
125  }
126 
127  QuerySession QS(ASTs);
128 
129  if (!Commands.empty()) {
130  for (auto I = Commands.begin(), E = Commands.end(); I != E; ++I) {
131  QueryRef Q = QueryParser::parse(*I, QS);
132  if (!Q->run(llvm::outs(), QS))
133  return 1;
134  }
135  } else if (!CommandFiles.empty()) {
136  for (auto I = CommandFiles.begin(), E = CommandFiles.end(); I != E; ++I) {
137  if (runCommandsInFile(argv[0], *I, QS))
138  return 1;
139  }
140  } else {
141  if (!PreloadFile.empty()) {
142  if (runCommandsInFile(argv[0], PreloadFile, QS))
143  return 1;
144  }
145  LineEditor LE("clang-query");
146  LE.setListCompleter([&QS](StringRef Line, size_t Pos) {
147  return QueryParser::complete(Line, Pos, QS);
148  });
149  while (llvm::Optional<std::string> Line = LE.readLine()) {
150  QueryRef Q = QueryParser::parse(*Line, QS);
151  Q->run(llvm::outs(), QS);
152  llvm::outs().flush();
153  if (QS.Terminate)
154  break;
155  }
156  }
157 
158  return ASTStatus;
159 }
clang::query::QueryRef
llvm::IntrusiveRefCntPtr< Query > QueryRef
Definition: Query.h:52
llvm
Some operations such as code completion produce a set of candidates.
Definition: YAMLGenerator.cpp:28
E
const Expr * E
Definition: AvoidBindCheck.cpp:88
QueryParser.h
Query.h
clang::ast_matchers
Definition: AbseilMatcher.h:14
Line
int Line
Definition: PreprocessorTracker.cpp:513
runCommandsInFile
bool runCommandsInFile(const char *ExeName, std::string const &FileName, QuerySession &QS)
Definition: ClangQuery.cpp:66
clang::tooling
Definition: ClangTidy.h:25
clang::query::QuerySession::Terminate
bool Terminate
Definition: QuerySession.h:39
ClangQueryCategory
static cl::OptionCategory ClangQueryCategory("clang-query options")
CommonHelp
static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage)
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::pp_trace::error
static LLVM_ATTRIBUTE_NORETURN void error(Twine Message)
Definition: PPTrace.cpp:72
CommandFiles
static cl::list< std::string > CommandFiles("f", cl::desc("Read commands from file"), cl::value_desc("file"), cl::cat(ClangQueryCategory))
clang::tidy::cppcoreguidelines::toString
static llvm::StringRef toString(SpecialMemberFunctionsCheck::SpecialMemberFunctionKind K)
Definition: SpecialMemberFunctionsCheck.cpp:60
Commands
static cl::list< std::string > Commands("c", cl::desc("Specify command to run"), cl::value_desc("command"), cl::cat(ClangQueryCategory))
Pos
Position Pos
Definition: SourceCode.cpp:649
main
int main(int argc, const char **argv)
Definition: ClangQuery.cpp:87
FileName
PathRef FileName
Definition: CodeComplete.cpp:1043
PreloadFile
static cl::opt< std::string > PreloadFile("preload", cl::desc("Preload commands from file and start interactive mode"), cl::value_desc("file"), cl::cat(ClangQueryCategory))
clang::query::QuerySession
Represents the state for a particular clang-query session.
Definition: QuerySession.h:24
clang::query
Definition: Query.cpp:21
QuerySession.h