1 //===-- CPlusPlusNameParser.h -----------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef liblldb_CPlusPlusNameParser_h_
10 #define liblldb_CPlusPlusNameParser_h_
13 #include "clang/Lex/Lexer.h"
14 #include "llvm/ADT/Optional.h"
15 #include "llvm/ADT/SmallVector.h"
16 #include "llvm/ADT/StringRef.h"
18 #include "lldb/Utility/ConstString.h"
19 #include "lldb/lldb-private.h"
21 namespace lldb_private {
23 // Helps to validate and obtain various parts of C++ definitions.
24 class CPlusPlusNameParser {
26 CPlusPlusNameParser(llvm::StringRef text) : m_text(text) { ExtractTokens(); }
29 llvm::StringRef basename;
30 llvm::StringRef context;
33 struct ParsedFunction {
35 llvm::StringRef arguments;
36 llvm::StringRef qualifiers;
39 // Treats given text as a function definition and parses it.
40 // Function definition might or might not have a return type and this should
41 // change parsing result.
43 // main(int, chat const*)
45 // std::vector<int>::push_back(int)
46 // int& map<int, pair<short, int>>::operator[](short) const
47 // int (*get_function(const chat *))()
48 llvm::Optional<ParsedFunction> ParseAsFunctionDefinition();
50 // Treats given text as a potentially nested name of C++ entity (function,
51 // class, field) and parses it.
55 // std::vector<int>::push_back
56 // map<int, pair<short, int>>::operator[]
57 // func<C>(int, C&)::nested_class::method
58 llvm::Optional<ParsedName> ParseAsFullName();
61 // A C++ definition to parse.
62 llvm::StringRef m_text;
63 // Tokens extracted from m_text.
64 llvm::SmallVector<clang::Token, 30> m_tokens;
65 // Index of the next token to look at from m_tokens.
66 size_t m_next_token_index = 0;
68 // Range of tokens saved in m_next_token_index.
70 size_t begin_index = 0;
74 Range(size_t begin, size_t end) : begin_index(begin), end_index(end) {
78 size_t size() const { return end_index - begin_index; }
80 bool empty() const { return size() == 0; }
83 struct ParsedNameRanges {
88 // Bookmark automatically restores parsing position (m_next_token_index)
89 // when destructed unless it's manually removed with Remove().
92 Bookmark(size_t &position)
93 : m_position(position), m_position_value(position) {}
94 Bookmark(const Bookmark &) = delete;
95 Bookmark(Bookmark &&b)
96 : m_position(b.m_position), m_position_value(b.m_position_value),
97 m_restore(b.m_restore) {
100 Bookmark &operator=(Bookmark &&) = delete;
101 Bookmark &operator=(const Bookmark &) = delete;
103 void Remove() { m_restore = false; }
104 size_t GetSavedPosition() { return m_position_value; }
107 m_position = m_position_value;
113 size_t m_position_value;
114 bool m_restore = true;
117 bool HasMoreTokens();
120 bool ConsumeToken(clang::tok::TokenKind kind);
121 template <typename... Ts> bool ConsumeToken(Ts... kinds);
122 Bookmark SetBookmark();
123 size_t GetCurrentPosition();
124 clang::Token &Peek();
125 bool ConsumeBrackets(clang::tok::TokenKind left, clang::tok::TokenKind right);
127 llvm::Optional<ParsedFunction> ParseFunctionImpl(bool expect_return_type);
129 // Parses functions returning function pointers 'string (*f(int x))(float y)'
130 llvm::Optional<ParsedFunction> ParseFuncPtr(bool expect_return_type);
132 // Consumes function arguments enclosed within '(' ... ')'
133 bool ConsumeArguments();
135 // Consumes template arguments enclosed within '<' ... '>'
136 bool ConsumeTemplateArgs();
138 // Consumes '(anonymous namespace)'
139 bool ConsumeAnonymousNamespace();
141 // Consumes '{lambda ...}'
142 bool ConsumeLambda();
144 // Consumes operator declaration like 'operator *' or 'operator delete []'
145 bool ConsumeOperator();
147 // Skips 'const' and 'volatile'
148 void SkipTypeQualifiers();
150 // Skips 'const', 'volatile', '&', '&&' in the end of the function.
151 void SkipFunctionQualifiers();
153 // Consumes built-in types like 'int' or 'unsigned long long int'
154 bool ConsumeBuiltinType();
156 // Consumes types defined via decltype keyword.
157 bool ConsumeDecltype();
159 // Skips 'const' and 'volatile'
160 void SkipPtrsAndRefs();
162 // Consumes things like 'const * const &'
163 bool ConsumePtrsAndRefs();
165 // Consumes full type name like 'Namespace::Class<int>::Method()::InnerClass'
166 bool ConsumeTypename();
168 llvm::Optional<ParsedNameRanges> ParseFullNameImpl();
169 llvm::StringRef GetTextForRange(const Range &range);
171 // Populate m_tokens by calling clang lexer on m_text.
172 void ExtractTokens();
175 } // namespace lldb_private
177 #endif // liblldb_CPlusPlusNameParser_h_