1 //===- Nodes.cpp ----------------------------------------------*- C++ -*-=====//
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 #include "clang/Tooling/Syntax/Nodes.h"
9 #include "clang/Basic/TokenKinds.h"
10 
11 using namespace clang;
12 
13 llvm::raw_ostream &syntax::operator<<(llvm::raw_ostream &OS, NodeKind K) {
14   switch (K) {
15   case NodeKind::Leaf:
16     return OS << "Leaf";
17   case NodeKind::TranslationUnit:
18     return OS << "TranslationUnit";
19   case NodeKind::UnknownExpression:
20     return OS << "UnknownExpression";
21   case NodeKind::UnknownStatement:
22     return OS << "UnknownStatement";
23   case NodeKind::DeclarationStatement:
24     return OS << "DeclarationStatement";
25   case NodeKind::EmptyStatement:
26     return OS << "EmptyStatement";
27   case NodeKind::SwitchStatement:
28     return OS << "SwitchStatement";
29   case NodeKind::CaseStatement:
30     return OS << "CaseStatement";
31   case NodeKind::DefaultStatement:
32     return OS << "DefaultStatement";
33   case NodeKind::IfStatement:
34     return OS << "IfStatement";
35   case NodeKind::ForStatement:
36     return OS << "ForStatement";
37   case NodeKind::WhileStatement:
38     return OS << "WhileStatement";
39   case NodeKind::ContinueStatement:
40     return OS << "ContinueStatement";
41   case NodeKind::BreakStatement:
42     return OS << "BreakStatement";
43   case NodeKind::ReturnStatement:
44     return OS << "ReturnStatement";
45   case NodeKind::RangeBasedForStatement:
46     return OS << "RangeBasedForStatement";
47   case NodeKind::ExpressionStatement:
48     return OS << "ExpressionStatement";
49   case NodeKind::CompoundStatement:
50     return OS << "CompoundStatement";
51   case NodeKind::UnknownDeclaration:
52     return OS << "UnknownDeclaration";
53   case NodeKind::EmptyDeclaration:
54     return OS << "EmptyDeclaration";
55   case NodeKind::StaticAssertDeclaration:
56     return OS << "StaticAssertDeclaration";
57   case NodeKind::LinkageSpecificationDeclaration:
58     return OS << "LinkageSpecificationDeclaration";
59   case NodeKind::SimpleDeclaration:
60     return OS << "SimpleDeclaration";
61   case NodeKind::TemplateDeclaration:
62     return OS << "TemplateDeclaration";
63   case NodeKind::ExplicitTemplateInstantiation:
64     return OS << "ExplicitTemplateInstantiation";
65   case NodeKind::NamespaceDefinition:
66     return OS << "NamespaceDefinition";
67   case NodeKind::NamespaceAliasDefinition:
68     return OS << "NamespaceAliasDefinition";
69   case NodeKind::UsingNamespaceDirective:
70     return OS << "UsingNamespaceDirective";
71   case NodeKind::UsingDeclaration:
72     return OS << "UsingDeclaration";
73   case NodeKind::TypeAliasDeclaration:
74     return OS << "TypeAliasDeclaration";
75   case NodeKind::SimpleDeclarator:
76     return OS << "SimpleDeclarator";
77   case NodeKind::ParenDeclarator:
78     return OS << "ParenDeclarator";
79   case NodeKind::ArraySubscript:
80     return OS << "ArraySubscript";
81   case NodeKind::TrailingReturnType:
82     return OS << "TrailingReturnType";
83   case NodeKind::ParametersAndQualifiers:
84     return OS << "ParametersAndQualifiers";
85   case NodeKind::MemberPointer:
86     return OS << "MemberPointer";
87   }
88   llvm_unreachable("unknown node kind");
89 }
90 
91 llvm::raw_ostream &syntax::operator<<(llvm::raw_ostream &OS, NodeRole R) {
92   switch (R) {
93   case syntax::NodeRole::Detached:
94     return OS << "Detached";
95   case syntax::NodeRole::Unknown:
96     return OS << "Unknown";
97   case syntax::NodeRole::OpenParen:
98     return OS << "OpenParen";
99   case syntax::NodeRole::CloseParen:
100     return OS << "CloseParen";
101   case syntax::NodeRole::IntroducerKeyword:
102     return OS << "IntroducerKeyword";
103   case syntax::NodeRole::BodyStatement:
104     return OS << "BodyStatement";
105   case syntax::NodeRole::CaseStatement_value:
106     return OS << "CaseStatement_value";
107   case syntax::NodeRole::IfStatement_thenStatement:
108     return OS << "IfStatement_thenStatement";
109   case syntax::NodeRole::IfStatement_elseKeyword:
110     return OS << "IfStatement_elseKeyword";
111   case syntax::NodeRole::IfStatement_elseStatement:
112     return OS << "IfStatement_elseStatement";
113   case syntax::NodeRole::ReturnStatement_value:
114     return OS << "ReturnStatement_value";
115   case syntax::NodeRole::ExpressionStatement_expression:
116     return OS << "ExpressionStatement_expression";
117   case syntax::NodeRole::CompoundStatement_statement:
118     return OS << "CompoundStatement_statement";
119   case syntax::NodeRole::StaticAssertDeclaration_condition:
120     return OS << "StaticAssertDeclaration_condition";
121   case syntax::NodeRole::StaticAssertDeclaration_message:
122     return OS << "StaticAssertDeclaration_message";
123   case syntax::NodeRole::SimpleDeclaration_declarator:
124     return OS << "SimpleDeclaration_declarator";
125   case syntax::NodeRole::TemplateDeclaration_declaration:
126     return OS << "TemplateDeclaration_declaration";
127   case syntax::NodeRole::ExplicitTemplateInstantiation_externKeyword:
128     return OS << "ExplicitTemplateInstantiation_externKeyword";
129   case syntax::NodeRole::ExplicitTemplateInstantiation_declaration:
130     return OS << "ExplicitTemplateInstantiation_declaration";
131   case syntax::NodeRole::ArraySubscript_sizeExpression:
132     return OS << "ArraySubscript_sizeExpression";
133   case syntax::NodeRole::TrailingReturnType_arrow:
134     return OS << "TrailingReturnType_arrow";
135   case syntax::NodeRole::TrailingReturnType_declarator:
136     return OS << "TrailingReturnType_declarator";
137   case syntax::NodeRole::ParametersAndQualifiers_parameter:
138     return OS << "ParametersAndQualifiers_parameter";
139   case syntax::NodeRole::ParametersAndQualifiers_trailingReturn:
140     return OS << "ParametersAndQualifiers_trailingReturn";
141   }
142   llvm_unreachable("invalid role");
143 }
144 
145 syntax::Leaf *syntax::SwitchStatement::switchKeyword() {
146   return llvm::cast_or_null<syntax::Leaf>(
147       findChild(syntax::NodeRole::IntroducerKeyword));
148 }
149 
150 syntax::Statement *syntax::SwitchStatement::body() {
151   return llvm::cast_or_null<syntax::Statement>(
152       findChild(syntax::NodeRole::BodyStatement));
153 }
154 
155 syntax::Leaf *syntax::CaseStatement::caseKeyword() {
156   return llvm::cast_or_null<syntax::Leaf>(
157       findChild(syntax::NodeRole::IntroducerKeyword));
158 }
159 
160 syntax::Expression *syntax::CaseStatement::value() {
161   return llvm::cast_or_null<syntax::Expression>(
162       findChild(syntax::NodeRole::CaseStatement_value));
163 }
164 
165 syntax::Statement *syntax::CaseStatement::body() {
166   return llvm::cast_or_null<syntax::Statement>(
167       findChild(syntax::NodeRole::BodyStatement));
168 }
169 
170 syntax::Leaf *syntax::DefaultStatement::defaultKeyword() {
171   return llvm::cast_or_null<syntax::Leaf>(
172       findChild(syntax::NodeRole::IntroducerKeyword));
173 }
174 
175 syntax::Statement *syntax::DefaultStatement::body() {
176   return llvm::cast_or_null<syntax::Statement>(
177       findChild(syntax::NodeRole::BodyStatement));
178 }
179 
180 syntax::Leaf *syntax::IfStatement::ifKeyword() {
181   return llvm::cast_or_null<syntax::Leaf>(
182       findChild(syntax::NodeRole::IntroducerKeyword));
183 }
184 
185 syntax::Statement *syntax::IfStatement::thenStatement() {
186   return llvm::cast_or_null<syntax::Statement>(
187       findChild(syntax::NodeRole::IfStatement_thenStatement));
188 }
189 
190 syntax::Leaf *syntax::IfStatement::elseKeyword() {
191   return llvm::cast_or_null<syntax::Leaf>(
192       findChild(syntax::NodeRole::IfStatement_elseKeyword));
193 }
194 
195 syntax::Statement *syntax::IfStatement::elseStatement() {
196   return llvm::cast_or_null<syntax::Statement>(
197       findChild(syntax::NodeRole::IfStatement_elseStatement));
198 }
199 
200 syntax::Leaf *syntax::ForStatement::forKeyword() {
201   return llvm::cast_or_null<syntax::Leaf>(
202       findChild(syntax::NodeRole::IntroducerKeyword));
203 }
204 
205 syntax::Statement *syntax::ForStatement::body() {
206   return llvm::cast_or_null<syntax::Statement>(
207       findChild(syntax::NodeRole::BodyStatement));
208 }
209 
210 syntax::Leaf *syntax::WhileStatement::whileKeyword() {
211   return llvm::cast_or_null<syntax::Leaf>(
212       findChild(syntax::NodeRole::IntroducerKeyword));
213 }
214 
215 syntax::Statement *syntax::WhileStatement::body() {
216   return llvm::cast_or_null<syntax::Statement>(
217       findChild(syntax::NodeRole::BodyStatement));
218 }
219 
220 syntax::Leaf *syntax::ContinueStatement::continueKeyword() {
221   return llvm::cast_or_null<syntax::Leaf>(
222       findChild(syntax::NodeRole::IntroducerKeyword));
223 }
224 
225 syntax::Leaf *syntax::BreakStatement::breakKeyword() {
226   return llvm::cast_or_null<syntax::Leaf>(
227       findChild(syntax::NodeRole::IntroducerKeyword));
228 }
229 
230 syntax::Leaf *syntax::ReturnStatement::returnKeyword() {
231   return llvm::cast_or_null<syntax::Leaf>(
232       findChild(syntax::NodeRole::IntroducerKeyword));
233 }
234 
235 syntax::Expression *syntax::ReturnStatement::value() {
236   return llvm::cast_or_null<syntax::Expression>(
237       findChild(syntax::NodeRole::ReturnStatement_value));
238 }
239 
240 syntax::Leaf *syntax::RangeBasedForStatement::forKeyword() {
241   return llvm::cast_or_null<syntax::Leaf>(
242       findChild(syntax::NodeRole::IntroducerKeyword));
243 }
244 
245 syntax::Statement *syntax::RangeBasedForStatement::body() {
246   return llvm::cast_or_null<syntax::Statement>(
247       findChild(syntax::NodeRole::BodyStatement));
248 }
249 
250 syntax::Expression *syntax::ExpressionStatement::expression() {
251   return llvm::cast_or_null<syntax::Expression>(
252       findChild(syntax::NodeRole::ExpressionStatement_expression));
253 }
254 
255 syntax::Leaf *syntax::CompoundStatement::lbrace() {
256   return llvm::cast_or_null<syntax::Leaf>(
257       findChild(syntax::NodeRole::OpenParen));
258 }
259 
260 std::vector<syntax::Statement *> syntax::CompoundStatement::statements() {
261   std::vector<syntax::Statement *> Children;
262   for (auto *C = firstChild(); C; C = C->nextSibling()) {
263     if (C->role() == syntax::NodeRole::CompoundStatement_statement)
264       Children.push_back(llvm::cast<syntax::Statement>(C));
265   }
266   return Children;
267 }
268 
269 syntax::Leaf *syntax::CompoundStatement::rbrace() {
270   return llvm::cast_or_null<syntax::Leaf>(
271       findChild(syntax::NodeRole::CloseParen));
272 }
273 
274 syntax::Expression *syntax::StaticAssertDeclaration::condition() {
275   return llvm::cast_or_null<syntax::Expression>(
276       findChild(syntax::NodeRole::StaticAssertDeclaration_condition));
277 }
278 
279 syntax::Expression *syntax::StaticAssertDeclaration::message() {
280   return llvm::cast_or_null<syntax::Expression>(
281       findChild(syntax::NodeRole::StaticAssertDeclaration_message));
282 }
283 
284 std::vector<syntax::SimpleDeclarator *>
285 syntax::SimpleDeclaration::declarators() {
286   std::vector<syntax::SimpleDeclarator *> Children;
287   for (auto *C = firstChild(); C; C = C->nextSibling()) {
288     if (C->role() == syntax::NodeRole::SimpleDeclaration_declarator)
289       Children.push_back(llvm::cast<syntax::SimpleDeclarator>(C));
290   }
291   return Children;
292 }
293 
294 syntax::Leaf *syntax::TemplateDeclaration::templateKeyword() {
295   return llvm::cast_or_null<syntax::Leaf>(
296       findChild(syntax::NodeRole::IntroducerKeyword));
297 }
298 
299 syntax::Declaration *syntax::TemplateDeclaration::declaration() {
300   return llvm::cast_or_null<syntax::Declaration>(
301       findChild(syntax::NodeRole::TemplateDeclaration_declaration));
302 }
303 
304 syntax::Leaf *syntax::ExplicitTemplateInstantiation::templateKeyword() {
305   return llvm::cast_or_null<syntax::Leaf>(
306       findChild(syntax::NodeRole::IntroducerKeyword));
307 }
308 
309 syntax::Leaf *syntax::ExplicitTemplateInstantiation::externKeyword() {
310   return llvm::cast_or_null<syntax::Leaf>(
311       findChild(syntax::NodeRole::ExplicitTemplateInstantiation_externKeyword));
312 }
313 
314 syntax::Declaration *syntax::ExplicitTemplateInstantiation::declaration() {
315   return llvm::cast_or_null<syntax::Declaration>(
316       findChild(syntax::NodeRole::ExplicitTemplateInstantiation_declaration));
317 }
318 
319 syntax::Leaf *syntax::ParenDeclarator::lparen() {
320   return llvm::cast_or_null<syntax::Leaf>(
321       findChild(syntax::NodeRole::OpenParen));
322 }
323 
324 syntax::Leaf *syntax::ParenDeclarator::rparen() {
325   return llvm::cast_or_null<syntax::Leaf>(
326       findChild(syntax::NodeRole::CloseParen));
327 }
328 
329 syntax::Leaf *syntax::ArraySubscript::lbracket() {
330   return llvm::cast_or_null<syntax::Leaf>(
331       findChild(syntax::NodeRole::OpenParen));
332 }
333 
334 syntax::Expression *syntax::ArraySubscript::sizeExpression() {
335   return llvm::cast_or_null<syntax::Expression>(
336       findChild(syntax::NodeRole::ArraySubscript_sizeExpression));
337 }
338 
339 syntax::Leaf *syntax::ArraySubscript::rbracket() {
340   return llvm::cast_or_null<syntax::Leaf>(
341       findChild(syntax::NodeRole::CloseParen));
342 }
343 
344 syntax::Leaf *syntax::TrailingReturnType::arrow() {
345   return llvm::cast_or_null<syntax::Leaf>(
346       findChild(syntax::NodeRole::TrailingReturnType_arrow));
347 }
348 
349 syntax::SimpleDeclarator *syntax::TrailingReturnType::declarator() {
350   return llvm::cast_or_null<syntax::SimpleDeclarator>(
351       findChild(syntax::NodeRole::TrailingReturnType_declarator));
352 }
353 
354 syntax::Leaf *syntax::ParametersAndQualifiers::lparen() {
355   return llvm::cast_or_null<syntax::Leaf>(
356       findChild(syntax::NodeRole::OpenParen));
357 }
358 
359 std::vector<syntax::SimpleDeclaration *>
360 syntax::ParametersAndQualifiers::parameters() {
361   std::vector<syntax::SimpleDeclaration *> Children;
362   for (auto *C = firstChild(); C; C = C->nextSibling()) {
363     if (C->role() == syntax::NodeRole::ParametersAndQualifiers_parameter)
364       Children.push_back(llvm::cast<syntax::SimpleDeclaration>(C));
365   }
366   return Children;
367 }
368 
369 syntax::Leaf *syntax::ParametersAndQualifiers::rparen() {
370   return llvm::cast_or_null<syntax::Leaf>(
371       findChild(syntax::NodeRole::CloseParen));
372 }
373 
374 syntax::TrailingReturnType *syntax::ParametersAndQualifiers::trailingReturn() {
375   return llvm::cast_or_null<syntax::TrailingReturnType>(
376       findChild(syntax::NodeRole::ParametersAndQualifiers_trailingReturn));
377 }
378