clang-tools  8.0.0
QueryParser.h
Go to the documentation of this file.
1 //===--- QueryParser.h - clang-query ----------------------------*- C++ -*-===//
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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_QUERY_QUERY_PARSER_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_QUERY_QUERY_PARSER_H
12 
13 #include "Query.h"
14 #include "QuerySession.h"
15 #include "llvm/LineEditor/LineEditor.h"
16 #include <cstddef>
17 
18 namespace clang {
19 namespace query {
20 
21 class QuerySession;
22 
23 class QueryParser {
24 public:
25  /// Parse \a Line as a query.
26  ///
27  /// \return A QueryRef representing the query, which may be an InvalidQuery.
28  static QueryRef parse(StringRef Line, const QuerySession &QS);
29 
30  /// Compute a list of completions for \a Line assuming a cursor at
31  /// \param Pos characters past the start of \a Line, ordered from most
32  /// likely to least likely.
33  ///
34  /// \return A vector of completions for \a Line.
35  static std::vector<llvm::LineEditor::Completion>
36  complete(StringRef Line, size_t Pos, const QuerySession &QS);
37 
38 private:
39  QueryParser(StringRef Line, const QuerySession &QS)
40  : Line(Line), CompletionPos(nullptr), QS(QS) {}
41 
42  StringRef lexWord();
43 
44  template <typename T> struct LexOrCompleteWord;
45 
46  QueryRef parseSetBool(bool QuerySession::*Var);
47  template <typename QueryType> QueryRef parseSetOutputKind();
48  QueryRef completeMatcherExpression();
49 
50  QueryRef endQuery(QueryRef Q);
51 
52  /// \brief Parse [\p Begin,\p End).
53  ///
54  /// \return A reference to the parsed query object, which may be an
55  /// \c InvalidQuery if a parse error occurs.
56  QueryRef doParse();
57 
58  StringRef Line;
59 
60  const char *CompletionPos;
61  std::vector<llvm::LineEditor::Completion> Completions;
62 
63  const QuerySession &QS;
64 };
65 
66 } // namespace query
67 } // namespace clang
68 
69 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_QUERY_QUERY_PARSER_H
static QueryRef parse(StringRef Line, const QuerySession &QS)
Parse Line as a query.
Represents the state for a particular clang-query session.
Definition: QuerySession.h:24
static std::vector< llvm::LineEditor::Completion > complete(StringRef Line, size_t Pos, const QuerySession &QS)
Compute a list of completions for Line assuming a cursor at.
llvm::IntrusiveRefCntPtr< Query > QueryRef
Definition: Query.h:51
Position Pos
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//