clang-tools  11.0.0
QueryParser.cpp
Go to the documentation of this file.
1 //===---- QueryParser.cpp - clang-query command parser --------------------===//
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 #include "QueryParser.h"
10 #include "Query.h"
11 #include "QuerySession.h"
12 #include "clang/ASTMatchers/Dynamic/Parser.h"
13 #include "clang/Basic/CharInfo.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/ADT/StringSwitch.h"
16 #include <set>
17 
18 using namespace llvm;
19 using namespace clang::ast_matchers::dynamic;
20 
21 namespace clang {
22 namespace query {
23 
24 // Lex any amount of whitespace followed by a "word" (any sequence of
25 // non-whitespace characters) from the start of region [Begin,End). If no word
26 // is found before End, return StringRef(). Begin is adjusted to exclude the
27 // lexed region.
28 StringRef QueryParser::lexWord() {
29  Line = Line.drop_while([](char c) {
30  // Don't trim newlines.
31  return StringRef(" \t\v\f\r").contains(c);
32  });
33 
34  if (Line.empty())
35  // Even though the Line is empty, it contains a pointer and
36  // a (zero) length. The pointer is used in the LexOrCompleteWord
37  // code completion.
38  return Line;
39 
40  StringRef Word;
41  if (Line.front() == '#')
42  Word = Line.substr(0, 1);
43  else
44  Word = Line.take_until(isWhitespace);
45 
46  Line = Line.drop_front(Word.size());
47  return Word;
48 }
49 
50 // This is the StringSwitch-alike used by lexOrCompleteWord below. See that
51 // function for details.
52 template <typename T> struct QueryParser::LexOrCompleteWord {
53  StringRef Word;
54  StringSwitch<T> Switch;
55 
57  // Set to the completion point offset in Word, or StringRef::npos if
58  // completion point not in Word.
60 
61  // Lexes a word and stores it in Word. Returns a LexOrCompleteWord<T> object
62  // that can be used like a llvm::StringSwitch<T>, but adds cases as possible
63  // completions if the lexed word contains the completion point.
64  LexOrCompleteWord(QueryParser *P, StringRef &OutWord)
65  : Word(P->lexWord()), Switch(Word), P(P),
66  WordCompletionPos(StringRef::npos) {
67  OutWord = Word;
68  if (P->CompletionPos && P->CompletionPos <= Word.data() + Word.size()) {
69  if (P->CompletionPos < Word.data())
70  WordCompletionPos = 0;
71  else
72  WordCompletionPos = P->CompletionPos - Word.data();
73  }
74  }
75 
76  LexOrCompleteWord &Case(llvm::StringLiteral CaseStr, const T &Value,
77  bool IsCompletion = true) {
78 
79  if (WordCompletionPos == StringRef::npos)
80  Switch.Case(CaseStr, Value);
81  else if (CaseStr.size() != 0 && IsCompletion && WordCompletionPos <= CaseStr.size() &&
82  CaseStr.substr(0, WordCompletionPos) ==
83  Word.substr(0, WordCompletionPos))
84  P->Completions.push_back(LineEditor::Completion(
85  (CaseStr.substr(WordCompletionPos) + " ").str(),
86  std::string(CaseStr)));
87  return *this;
88  }
89 
90  T Default(T Value) { return Switch.Default(Value); }
91 };
92 
93 QueryRef QueryParser::parseSetBool(bool QuerySession::*Var) {
94  StringRef ValStr;
95  unsigned Value = LexOrCompleteWord<unsigned>(this, ValStr)
96  .Case("false", 0)
97  .Case("true", 1)
98  .Default(~0u);
99  if (Value == ~0u) {
100  return new InvalidQuery("expected 'true' or 'false', got '" + ValStr + "'");
101  }
102  return new SetQuery<bool>(Var, Value);
103 }
104 
105 template <typename QueryType> QueryRef QueryParser::parseSetOutputKind() {
106  StringRef ValStr;
107  unsigned OutKind = LexOrCompleteWord<unsigned>(this, ValStr)
108  .Case("diag", OK_Diag)
109  .Case("print", OK_Print)
110  .Case("detailed-ast", OK_DetailedAST)
111  .Case("dump", OK_DetailedAST)
112  .Default(~0u);
113  if (OutKind == ~0u) {
114  return new InvalidQuery(
115  "expected 'diag', 'print', 'detailed-ast' or 'dump', got '" + ValStr +
116  "'");
117  }
118 
119  switch (OutKind) {
120  case OK_DetailedAST:
121  return new QueryType(&QuerySession::DetailedASTOutput);
122  case OK_Diag:
123  return new QueryType(&QuerySession::DiagOutput);
124  case OK_Print:
125  return new QueryType(&QuerySession::PrintOutput);
126  }
127 
128  llvm_unreachable("Invalid output kind");
129 }
130 
131 QueryRef QueryParser::parseSetTraversalKind(
132  ast_type_traits::TraversalKind QuerySession::*Var) {
133  StringRef ValStr;
134  unsigned Value =
135  LexOrCompleteWord<unsigned>(this, ValStr)
136  .Case("AsIs", ast_type_traits::TK_AsIs)
137  .Case("IgnoreImplicitCastsAndParentheses",
138  ast_type_traits::TK_IgnoreImplicitCastsAndParentheses)
139  .Case("IgnoreUnlessSpelledInSource",
140  ast_type_traits::TK_IgnoreUnlessSpelledInSource)
141  .Default(~0u);
142  if (Value == ~0u) {
143  return new InvalidQuery("expected traversal kind, got '" + ValStr + "'");
144  }
145  return new SetQuery<ast_type_traits::TraversalKind>(
146  Var, static_cast<ast_type_traits::TraversalKind>(Value));
147 }
148 
149 QueryRef QueryParser::endQuery(QueryRef Q) {
150  StringRef Extra = Line;
151  StringRef ExtraTrimmed = Extra.drop_while(
152  [](char c) { return StringRef(" \t\v\f\r").contains(c); });
153 
154  if ((!ExtraTrimmed.empty() && ExtraTrimmed[0] == '\n') ||
155  (ExtraTrimmed.size() >= 2 && ExtraTrimmed[0] == '\r' &&
156  ExtraTrimmed[1] == '\n'))
157  Q->RemainingContent = Extra;
158  else {
159  StringRef TrailingWord = lexWord();
160  if (!TrailingWord.empty() && TrailingWord.front() == '#') {
161  Line = Line.drop_until([](char c) { return c == '\n'; });
162  Line = Line.drop_while([](char c) { return c == '\n'; });
163  return endQuery(Q);
164  }
165  if (!TrailingWord.empty()) {
166  return new InvalidQuery("unexpected extra input: '" + Extra + "'");
167  }
168  }
169  return Q;
170 }
171 
172 namespace {
173 
175  PQK_Invalid,
176  PQK_Comment,
177  PQK_NoOp,
178  PQK_Help,
179  PQK_Let,
180  PQK_Match,
181  PQK_Set,
182  PQK_Unlet,
183  PQK_Quit,
184  PQK_Enable,
185  PQK_Disable
186 };
187 
189  PQV_Invalid,
190  PQV_Output,
191  PQV_BindRoot,
192  PQV_PrintMatcher,
193  PQV_Traversal
194 };
195 
196 QueryRef makeInvalidQueryFromDiagnostics(const Diagnostics &Diag) {
197  std::string ErrStr;
198  llvm::raw_string_ostream OS(ErrStr);
199  Diag.printToStreamFull(OS);
200  return new InvalidQuery(OS.str());
201 }
202 
203 } // namespace
204 
205 QueryRef QueryParser::completeMatcherExpression() {
206  std::vector<MatcherCompletion> Comps = Parser::completeExpression(
207  Line, CompletionPos - Line.begin(), nullptr, &QS.NamedValues);
208  for (auto I = Comps.begin(), E = Comps.end(); I != E; ++I) {
209  Completions.push_back(LineEditor::Completion(I->TypedText, I->MatcherDecl));
210  }
211  return QueryRef();
212 }
213 
214 QueryRef QueryParser::doParse() {
215  StringRef CommandStr;
216  ParsedQueryKind QKind = LexOrCompleteWord<ParsedQueryKind>(this, CommandStr)
217  .Case("", PQK_NoOp)
218  .Case("#", PQK_Comment, /*IsCompletion=*/false)
219  .Case("help", PQK_Help)
220  .Case("l", PQK_Let, /*IsCompletion=*/false)
221  .Case("let", PQK_Let)
222  .Case("m", PQK_Match, /*IsCompletion=*/false)
223  .Case("match", PQK_Match)
224  .Case("q", PQK_Quit, /*IsCompletion=*/false)
225  .Case("quit", PQK_Quit)
226  .Case("set", PQK_Set)
227  .Case("enable", PQK_Enable)
228  .Case("disable", PQK_Disable)
229  .Case("unlet", PQK_Unlet)
230  .Default(PQK_Invalid);
231 
232  switch (QKind) {
233  case PQK_Comment:
234  case PQK_NoOp:
235  Line = Line.drop_until([](char c) { return c == '\n'; });
236  Line = Line.drop_while([](char c) { return c == '\n'; });
237  if (Line.empty())
238  return new NoOpQuery;
239  return doParse();
240 
241  case PQK_Help:
242  return endQuery(new HelpQuery);
243 
244  case PQK_Quit:
245  return endQuery(new QuitQuery);
246 
247  case PQK_Let: {
248  StringRef Name = lexWord();
249 
250  if (Name.empty())
251  return new InvalidQuery("expected variable name");
252 
253  if (CompletionPos)
254  return completeMatcherExpression();
255 
256  Diagnostics Diag;
257  ast_matchers::dynamic::VariantValue Value;
258  if (!Parser::parseExpression(Line, nullptr, &QS.NamedValues, &Value,
259  &Diag)) {
260  return makeInvalidQueryFromDiagnostics(Diag);
261  }
262 
263  auto *Q = new LetQuery(Name, Value);
264  Q->RemainingContent = Line;
265  return Q;
266  }
267 
268  case PQK_Match: {
269  if (CompletionPos)
270  return completeMatcherExpression();
271 
272  Diagnostics Diag;
273  auto MatcherSource = Line.ltrim();
274  auto OrigMatcherSource = MatcherSource;
275  Optional<DynTypedMatcher> Matcher = Parser::parseMatcherExpression(
276  MatcherSource, nullptr, &QS.NamedValues, &Diag);
277  if (!Matcher) {
278  return makeInvalidQueryFromDiagnostics(Diag);
279  }
280  auto ActualSource = OrigMatcherSource.slice(0, OrigMatcherSource.size() -
281  MatcherSource.size());
282  auto *Q = new MatchQuery(ActualSource, *Matcher);
283  Q->RemainingContent = MatcherSource;
284  return Q;
285  }
286 
287  case PQK_Set: {
288  StringRef VarStr;
289  ParsedQueryVariable Var =
290  LexOrCompleteWord<ParsedQueryVariable>(this, VarStr)
291  .Case("output", PQV_Output)
292  .Case("bind-root", PQV_BindRoot)
293  .Case("print-matcher", PQV_PrintMatcher)
294  .Case("traversal", PQV_Traversal)
295  .Default(PQV_Invalid);
296  if (VarStr.empty())
297  return new InvalidQuery("expected variable name");
298  if (Var == PQV_Invalid)
299  return new InvalidQuery("unknown variable: '" + VarStr + "'");
300 
301  QueryRef Q;
302  switch (Var) {
303  case PQV_Output:
304  Q = parseSetOutputKind<SetExclusiveOutputQuery>();
305  break;
306  case PQV_BindRoot:
307  Q = parseSetBool(&QuerySession::BindRoot);
308  break;
309  case PQV_PrintMatcher:
310  Q = parseSetBool(&QuerySession::PrintMatcher);
311  break;
312  case PQV_Traversal:
313  Q = parseSetTraversalKind(&QuerySession::TK);
314  break;
315  case PQV_Invalid:
316  llvm_unreachable("Invalid query kind");
317  }
318 
319  return endQuery(Q);
320  }
321  case PQK_Enable:
322  case PQK_Disable: {
323  StringRef VarStr;
324  ParsedQueryVariable Var =
325  LexOrCompleteWord<ParsedQueryVariable>(this, VarStr)
326  .Case("output", PQV_Output)
327  .Default(PQV_Invalid);
328  if (VarStr.empty())
329  return new InvalidQuery("expected variable name");
330  if (Var == PQV_Invalid)
331  return new InvalidQuery("unknown variable: '" + VarStr + "'");
332 
333  QueryRef Q;
334 
335  if (QKind == PQK_Enable)
336  Q = parseSetOutputKind<EnableOutputQuery>();
337  else if (QKind == PQK_Disable)
338  Q = parseSetOutputKind<DisableOutputQuery>();
339  else
340  llvm_unreachable("Invalid query kind");
341  return endQuery(Q);
342  }
343 
344  case PQK_Unlet: {
345  StringRef Name = lexWord();
346 
347  if (Name.empty())
348  return new InvalidQuery("expected variable name");
349 
350  return endQuery(new LetQuery(Name, VariantValue()));
351  }
352 
353  case PQK_Invalid:
354  return new InvalidQuery("unknown command: " + CommandStr);
355  }
356 
357  llvm_unreachable("Invalid query kind");
358 }
359 
360 QueryRef QueryParser::parse(StringRef Line, const QuerySession &QS) {
361  return QueryParser(Line, QS).doParse();
362 }
363 
364 std::vector<LineEditor::Completion>
365 QueryParser::complete(StringRef Line, size_t Pos, const QuerySession &QS) {
366  QueryParser P(Line, QS);
367  P.CompletionPos = Line.data() + Pos;
368 
369  P.doParse();
370  return P.Completions;
371 }
372 
373 } // namespace query
374 } // namespace clang
clang::query::QueryRef
llvm::IntrusiveRefCntPtr< Query > QueryRef
Definition: Query.h:52
clang::query::QueryParser::LexOrCompleteWord::Case
LexOrCompleteWord & Case(llvm::StringLiteral CaseStr, const T &Value, bool IsCompletion=true)
Definition: QueryParser.cpp:76
llvm
Some operations such as code completion produce a set of candidates.
Definition: YAMLGenerator.cpp:28
clang::query::QueryParser
Definition: QueryParser.h:22
E
const Expr * E
Definition: AvoidBindCheck.cpp:88
clang::query::InvalidQuery
Any query which resulted in a parse error. The error message is in ErrStr.
Definition: Query.h:55
clang::query::OK_DetailedAST
Definition: Query.h:21
QueryParser.h
clang::query::QueryParser::LexOrCompleteWord::P
QueryParser * P
Definition: QueryParser.cpp:56
clang::query::OK_Diag
Definition: Query.h:21
clang::query::QueryParser::LexOrCompleteWord::Word
StringRef Word
Definition: QueryParser.cpp:53
Query.h
clang::query::QueryParser::LexOrCompleteWord
Definition: QueryParser.cpp:52
Line
int Line
Definition: PreprocessorTracker.cpp:513
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::query::@28::ParsedQueryKind
ParsedQueryKind
Definition: QueryParser.cpp:174
Word
std::string Word
Definition: FuzzyMatchTests.cpp:40
clang::query::QueryParser::LexOrCompleteWord::LexOrCompleteWord
LexOrCompleteWord(QueryParser *P, StringRef &OutWord)
Definition: QueryParser.cpp:64
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
OS
llvm::raw_string_ostream OS
Definition: TraceTests.cpp:162
clang::query::QueryParser::LexOrCompleteWord::Default
T Default(T Value)
Definition: QueryParser.cpp:90
Pos
Position Pos
Definition: SourceCode.cpp:649
clang::query::@28::ParsedQueryVariable
ParsedQueryVariable
Definition: QueryParser.cpp:188
clang::query::QueryParser::LexOrCompleteWord::WordCompletionPos
size_t WordCompletionPos
Definition: QueryParser.cpp:59
clang::query::QueryParser::LexOrCompleteWord::Switch
StringSwitch< T > Switch
Definition: QueryParser.cpp:54
clang::query::QuerySession
Represents the state for a particular clang-query session.
Definition: QuerySession.h:24
clang::query::OK_Print
Definition: Query.h:21
QuerySession.h