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 raw_ostream &syntax::operator<<(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::ParenExpression:
22     return OS << "ParenExpression";
23   case NodeKind::IntegerLiteralExpression:
24     return OS << "IntegerLiteralExpression";
25   case NodeKind::CharacterLiteralExpression:
26     return OS << "CharacterLiteralExpression";
27   case NodeKind::FloatingLiteralExpression:
28     return OS << "FloatingLiteralExpression";
29   case NodeKind::StringLiteralExpression:
30     return OS << "StringLiteralExpression";
31   case NodeKind::BoolLiteralExpression:
32     return OS << "BoolLiteralExpression";
33   case NodeKind::CxxNullPtrExpression:
34     return OS << "CxxNullPtrExpression";
35   case NodeKind::IntegerUserDefinedLiteralExpression:
36     return OS << "IntegerUserDefinedLiteralExpression";
37   case NodeKind::FloatUserDefinedLiteralExpression:
38     return OS << "FloatUserDefinedLiteralExpression";
39   case NodeKind::CharUserDefinedLiteralExpression:
40     return OS << "CharUserDefinedLiteralExpression";
41   case NodeKind::StringUserDefinedLiteralExpression:
42     return OS << "StringUserDefinedLiteralExpression";
43   case NodeKind::PrefixUnaryOperatorExpression:
44     return OS << "PrefixUnaryOperatorExpression";
45   case NodeKind::PostfixUnaryOperatorExpression:
46     return OS << "PostfixUnaryOperatorExpression";
47   case NodeKind::BinaryOperatorExpression:
48     return OS << "BinaryOperatorExpression";
49   case NodeKind::UnqualifiedId:
50     return OS << "UnqualifiedId";
51   case NodeKind::IdExpression:
52     return OS << "IdExpression";
53   case NodeKind::UnknownStatement:
54     return OS << "UnknownStatement";
55   case NodeKind::DeclarationStatement:
56     return OS << "DeclarationStatement";
57   case NodeKind::EmptyStatement:
58     return OS << "EmptyStatement";
59   case NodeKind::SwitchStatement:
60     return OS << "SwitchStatement";
61   case NodeKind::CaseStatement:
62     return OS << "CaseStatement";
63   case NodeKind::DefaultStatement:
64     return OS << "DefaultStatement";
65   case NodeKind::IfStatement:
66     return OS << "IfStatement";
67   case NodeKind::ForStatement:
68     return OS << "ForStatement";
69   case NodeKind::WhileStatement:
70     return OS << "WhileStatement";
71   case NodeKind::ContinueStatement:
72     return OS << "ContinueStatement";
73   case NodeKind::BreakStatement:
74     return OS << "BreakStatement";
75   case NodeKind::ReturnStatement:
76     return OS << "ReturnStatement";
77   case NodeKind::RangeBasedForStatement:
78     return OS << "RangeBasedForStatement";
79   case NodeKind::ExpressionStatement:
80     return OS << "ExpressionStatement";
81   case NodeKind::CompoundStatement:
82     return OS << "CompoundStatement";
83   case NodeKind::UnknownDeclaration:
84     return OS << "UnknownDeclaration";
85   case NodeKind::EmptyDeclaration:
86     return OS << "EmptyDeclaration";
87   case NodeKind::StaticAssertDeclaration:
88     return OS << "StaticAssertDeclaration";
89   case NodeKind::LinkageSpecificationDeclaration:
90     return OS << "LinkageSpecificationDeclaration";
91   case NodeKind::SimpleDeclaration:
92     return OS << "SimpleDeclaration";
93   case NodeKind::TemplateDeclaration:
94     return OS << "TemplateDeclaration";
95   case NodeKind::ExplicitTemplateInstantiation:
96     return OS << "ExplicitTemplateInstantiation";
97   case NodeKind::NamespaceDefinition:
98     return OS << "NamespaceDefinition";
99   case NodeKind::NamespaceAliasDefinition:
100     return OS << "NamespaceAliasDefinition";
101   case NodeKind::UsingNamespaceDirective:
102     return OS << "UsingNamespaceDirective";
103   case NodeKind::UsingDeclaration:
104     return OS << "UsingDeclaration";
105   case NodeKind::TypeAliasDeclaration:
106     return OS << "TypeAliasDeclaration";
107   case NodeKind::SimpleDeclarator:
108     return OS << "SimpleDeclarator";
109   case NodeKind::ParenDeclarator:
110     return OS << "ParenDeclarator";
111   case NodeKind::ArraySubscript:
112     return OS << "ArraySubscript";
113   case NodeKind::TrailingReturnType:
114     return OS << "TrailingReturnType";
115   case NodeKind::ParametersAndQualifiers:
116     return OS << "ParametersAndQualifiers";
117   case NodeKind::MemberPointer:
118     return OS << "MemberPointer";
119   case NodeKind::GlobalNameSpecifier:
120     return OS << "GlobalNameSpecifier";
121   case NodeKind::DecltypeNameSpecifier:
122     return OS << "DecltypeNameSpecifier";
123   case NodeKind::IdentifierNameSpecifier:
124     return OS << "IdentifierNameSpecifier";
125   case NodeKind::SimpleTemplateNameSpecifier:
126     return OS << "SimpleTemplateNameSpecifier";
127   case NodeKind::NestedNameSpecifier:
128     return OS << "NestedNameSpecifier";
129   }
130   llvm_unreachable("unknown node kind");
131 }
132 
133 raw_ostream &syntax::operator<<(raw_ostream &OS, NodeRole R) {
134   switch (R) {
135   case syntax::NodeRole::Detached:
136     return OS << "Detached";
137   case syntax::NodeRole::Unknown:
138     return OS << "Unknown";
139   case syntax::NodeRole::OpenParen:
140     return OS << "OpenParen";
141   case syntax::NodeRole::CloseParen:
142     return OS << "CloseParen";
143   case syntax::NodeRole::IntroducerKeyword:
144     return OS << "IntroducerKeyword";
145   case syntax::NodeRole::LiteralToken:
146     return OS << "LiteralToken";
147   case syntax::NodeRole::ArrowToken:
148     return OS << "ArrowToken";
149   case syntax::NodeRole::ExternKeyword:
150     return OS << "ExternKeyword";
151   case syntax::NodeRole::TemplateKeyword:
152     return OS << "TemplateKeyword";
153   case syntax::NodeRole::BodyStatement:
154     return OS << "BodyStatement";
155   case syntax::NodeRole::List_element:
156     return OS << "List_element";
157   case syntax::NodeRole::List_delimiter:
158     return OS << "List_delimiter";
159   case syntax::NodeRole::CaseStatement_value:
160     return OS << "CaseStatement_value";
161   case syntax::NodeRole::IfStatement_thenStatement:
162     return OS << "IfStatement_thenStatement";
163   case syntax::NodeRole::IfStatement_elseKeyword:
164     return OS << "IfStatement_elseKeyword";
165   case syntax::NodeRole::IfStatement_elseStatement:
166     return OS << "IfStatement_elseStatement";
167   case syntax::NodeRole::OperatorExpression_operatorToken:
168     return OS << "OperatorExpression_operatorToken";
169   case syntax::NodeRole::UnaryOperatorExpression_operand:
170     return OS << "UnaryOperatorExpression_operand";
171   case syntax::NodeRole::BinaryOperatorExpression_leftHandSide:
172     return OS << "BinaryOperatorExpression_leftHandSide";
173   case syntax::NodeRole::BinaryOperatorExpression_rightHandSide:
174     return OS << "BinaryOperatorExpression_rightHandSide";
175   case syntax::NodeRole::ReturnStatement_value:
176     return OS << "ReturnStatement_value";
177   case syntax::NodeRole::ExpressionStatement_expression:
178     return OS << "ExpressionStatement_expression";
179   case syntax::NodeRole::CompoundStatement_statement:
180     return OS << "CompoundStatement_statement";
181   case syntax::NodeRole::StaticAssertDeclaration_condition:
182     return OS << "StaticAssertDeclaration_condition";
183   case syntax::NodeRole::StaticAssertDeclaration_message:
184     return OS << "StaticAssertDeclaration_message";
185   case syntax::NodeRole::SimpleDeclaration_declarator:
186     return OS << "SimpleDeclaration_declarator";
187   case syntax::NodeRole::TemplateDeclaration_declaration:
188     return OS << "TemplateDeclaration_declaration";
189   case syntax::NodeRole::ExplicitTemplateInstantiation_declaration:
190     return OS << "ExplicitTemplateInstantiation_declaration";
191   case syntax::NodeRole::ArraySubscript_sizeExpression:
192     return OS << "ArraySubscript_sizeExpression";
193   case syntax::NodeRole::TrailingReturnType_declarator:
194     return OS << "TrailingReturnType_declarator";
195   case syntax::NodeRole::ParametersAndQualifiers_parameter:
196     return OS << "ParametersAndQualifiers_parameter";
197   case syntax::NodeRole::ParametersAndQualifiers_trailingReturn:
198     return OS << "ParametersAndQualifiers_trailingReturn";
199   case syntax::NodeRole::IdExpression_id:
200     return OS << "IdExpression_id";
201   case syntax::NodeRole::IdExpression_qualifier:
202     return OS << "IdExpression_qualifier";
203   case syntax::NodeRole::ParenExpression_subExpression:
204     return OS << "ParenExpression_subExpression";
205   }
206   llvm_unreachable("invalid role");
207 }
208 
209 // We could have an interator in list to not pay memory costs of temporary
210 // vector
211 std::vector<syntax::NameSpecifier *> syntax::NestedNameSpecifier::specifiers() {
212   auto specifiersAsNodes = getElementsAsNodes();
213   std::vector<syntax::NameSpecifier *> Children;
214   for (const auto &element : specifiersAsNodes) {
215     Children.push_back(llvm::cast<syntax::NameSpecifier>(element));
216   }
217   return Children;
218 }
219 
220 std::vector<syntax::List::ElementAndDelimiter<syntax::NameSpecifier>>
221 syntax::NestedNameSpecifier::specifiersAndDoubleColons() {
222   auto specifiersAsNodesAndDoubleColons = getElementsAsNodesAndDelimiters();
223   std::vector<syntax::List::ElementAndDelimiter<syntax::NameSpecifier>>
224       Children;
225   for (const auto &specifierAndDoubleColon : specifiersAsNodesAndDoubleColons) {
226     Children.push_back(
227         {llvm::cast<syntax::NameSpecifier>(specifierAndDoubleColon.element),
228          specifierAndDoubleColon.delimiter});
229   }
230   return Children;
231 }
232 
233 syntax::NestedNameSpecifier *syntax::IdExpression::qualifier() {
234   return cast_or_null<syntax::NestedNameSpecifier>(
235       findChild(syntax::NodeRole::IdExpression_qualifier));
236 }
237 
238 syntax::Leaf *syntax::IdExpression::templateKeyword() {
239   return llvm::cast_or_null<syntax::Leaf>(
240       findChild(syntax::NodeRole::TemplateKeyword));
241 }
242 
243 syntax::UnqualifiedId *syntax::IdExpression::unqualifiedId() {
244   return cast_or_null<syntax::UnqualifiedId>(
245       findChild(syntax::NodeRole::IdExpression_id));
246 }
247 
248 syntax::Leaf *syntax::ParenExpression::openParen() {
249   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::OpenParen));
250 }
251 
252 syntax::Expression *syntax::ParenExpression::subExpression() {
253   return cast_or_null<syntax::Expression>(
254       findChild(syntax::NodeRole::ParenExpression_subExpression));
255 }
256 
257 syntax::Leaf *syntax::ParenExpression::closeParen() {
258   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::CloseParen));
259 }
260 
261 syntax::Leaf *syntax::LiteralExpression::literalToken() {
262   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::LiteralToken));
263 }
264 
265 syntax::Expression *syntax::BinaryOperatorExpression::lhs() {
266   return cast_or_null<syntax::Expression>(
267       findChild(syntax::NodeRole::BinaryOperatorExpression_leftHandSide));
268 }
269 
270 syntax::Leaf *syntax::UnaryOperatorExpression::operatorToken() {
271   return cast_or_null<syntax::Leaf>(
272       findChild(syntax::NodeRole::OperatorExpression_operatorToken));
273 }
274 
275 syntax::Expression *syntax::UnaryOperatorExpression::operand() {
276   return cast_or_null<syntax::Expression>(
277       findChild(syntax::NodeRole::UnaryOperatorExpression_operand));
278 }
279 
280 syntax::Leaf *syntax::BinaryOperatorExpression::operatorToken() {
281   return cast_or_null<syntax::Leaf>(
282       findChild(syntax::NodeRole::OperatorExpression_operatorToken));
283 }
284 
285 syntax::Expression *syntax::BinaryOperatorExpression::rhs() {
286   return cast_or_null<syntax::Expression>(
287       findChild(syntax::NodeRole::BinaryOperatorExpression_rightHandSide));
288 }
289 
290 syntax::Leaf *syntax::SwitchStatement::switchKeyword() {
291   return cast_or_null<syntax::Leaf>(
292       findChild(syntax::NodeRole::IntroducerKeyword));
293 }
294 
295 syntax::Statement *syntax::SwitchStatement::body() {
296   return cast_or_null<syntax::Statement>(
297       findChild(syntax::NodeRole::BodyStatement));
298 }
299 
300 syntax::Leaf *syntax::CaseStatement::caseKeyword() {
301   return cast_or_null<syntax::Leaf>(
302       findChild(syntax::NodeRole::IntroducerKeyword));
303 }
304 
305 syntax::Expression *syntax::CaseStatement::value() {
306   return cast_or_null<syntax::Expression>(
307       findChild(syntax::NodeRole::CaseStatement_value));
308 }
309 
310 syntax::Statement *syntax::CaseStatement::body() {
311   return cast_or_null<syntax::Statement>(
312       findChild(syntax::NodeRole::BodyStatement));
313 }
314 
315 syntax::Leaf *syntax::DefaultStatement::defaultKeyword() {
316   return cast_or_null<syntax::Leaf>(
317       findChild(syntax::NodeRole::IntroducerKeyword));
318 }
319 
320 syntax::Statement *syntax::DefaultStatement::body() {
321   return cast_or_null<syntax::Statement>(
322       findChild(syntax::NodeRole::BodyStatement));
323 }
324 
325 syntax::Leaf *syntax::IfStatement::ifKeyword() {
326   return cast_or_null<syntax::Leaf>(
327       findChild(syntax::NodeRole::IntroducerKeyword));
328 }
329 
330 syntax::Statement *syntax::IfStatement::thenStatement() {
331   return cast_or_null<syntax::Statement>(
332       findChild(syntax::NodeRole::IfStatement_thenStatement));
333 }
334 
335 syntax::Leaf *syntax::IfStatement::elseKeyword() {
336   return cast_or_null<syntax::Leaf>(
337       findChild(syntax::NodeRole::IfStatement_elseKeyword));
338 }
339 
340 syntax::Statement *syntax::IfStatement::elseStatement() {
341   return cast_or_null<syntax::Statement>(
342       findChild(syntax::NodeRole::IfStatement_elseStatement));
343 }
344 
345 syntax::Leaf *syntax::ForStatement::forKeyword() {
346   return cast_or_null<syntax::Leaf>(
347       findChild(syntax::NodeRole::IntroducerKeyword));
348 }
349 
350 syntax::Statement *syntax::ForStatement::body() {
351   return cast_or_null<syntax::Statement>(
352       findChild(syntax::NodeRole::BodyStatement));
353 }
354 
355 syntax::Leaf *syntax::WhileStatement::whileKeyword() {
356   return cast_or_null<syntax::Leaf>(
357       findChild(syntax::NodeRole::IntroducerKeyword));
358 }
359 
360 syntax::Statement *syntax::WhileStatement::body() {
361   return cast_or_null<syntax::Statement>(
362       findChild(syntax::NodeRole::BodyStatement));
363 }
364 
365 syntax::Leaf *syntax::ContinueStatement::continueKeyword() {
366   return cast_or_null<syntax::Leaf>(
367       findChild(syntax::NodeRole::IntroducerKeyword));
368 }
369 
370 syntax::Leaf *syntax::BreakStatement::breakKeyword() {
371   return cast_or_null<syntax::Leaf>(
372       findChild(syntax::NodeRole::IntroducerKeyword));
373 }
374 
375 syntax::Leaf *syntax::ReturnStatement::returnKeyword() {
376   return cast_or_null<syntax::Leaf>(
377       findChild(syntax::NodeRole::IntroducerKeyword));
378 }
379 
380 syntax::Expression *syntax::ReturnStatement::value() {
381   return cast_or_null<syntax::Expression>(
382       findChild(syntax::NodeRole::ReturnStatement_value));
383 }
384 
385 syntax::Leaf *syntax::RangeBasedForStatement::forKeyword() {
386   return cast_or_null<syntax::Leaf>(
387       findChild(syntax::NodeRole::IntroducerKeyword));
388 }
389 
390 syntax::Statement *syntax::RangeBasedForStatement::body() {
391   return cast_or_null<syntax::Statement>(
392       findChild(syntax::NodeRole::BodyStatement));
393 }
394 
395 syntax::Expression *syntax::ExpressionStatement::expression() {
396   return cast_or_null<syntax::Expression>(
397       findChild(syntax::NodeRole::ExpressionStatement_expression));
398 }
399 
400 syntax::Leaf *syntax::CompoundStatement::lbrace() {
401   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::OpenParen));
402 }
403 
404 std::vector<syntax::Statement *> syntax::CompoundStatement::statements() {
405   std::vector<syntax::Statement *> Children;
406   for (auto *C = firstChild(); C; C = C->nextSibling()) {
407     assert(C->role() == syntax::NodeRole::CompoundStatement_statement);
408     Children.push_back(cast<syntax::Statement>(C));
409   }
410   return Children;
411 }
412 
413 syntax::Leaf *syntax::CompoundStatement::rbrace() {
414   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::CloseParen));
415 }
416 
417 syntax::Expression *syntax::StaticAssertDeclaration::condition() {
418   return cast_or_null<syntax::Expression>(
419       findChild(syntax::NodeRole::StaticAssertDeclaration_condition));
420 }
421 
422 syntax::Expression *syntax::StaticAssertDeclaration::message() {
423   return cast_or_null<syntax::Expression>(
424       findChild(syntax::NodeRole::StaticAssertDeclaration_message));
425 }
426 
427 std::vector<syntax::SimpleDeclarator *>
428 syntax::SimpleDeclaration::declarators() {
429   std::vector<syntax::SimpleDeclarator *> Children;
430   for (auto *C = firstChild(); C; C = C->nextSibling()) {
431     if (C->role() == syntax::NodeRole::SimpleDeclaration_declarator)
432       Children.push_back(cast<syntax::SimpleDeclarator>(C));
433   }
434   return Children;
435 }
436 
437 syntax::Leaf *syntax::TemplateDeclaration::templateKeyword() {
438   return cast_or_null<syntax::Leaf>(
439       findChild(syntax::NodeRole::IntroducerKeyword));
440 }
441 
442 syntax::Declaration *syntax::TemplateDeclaration::declaration() {
443   return cast_or_null<syntax::Declaration>(
444       findChild(syntax::NodeRole::TemplateDeclaration_declaration));
445 }
446 
447 syntax::Leaf *syntax::ExplicitTemplateInstantiation::templateKeyword() {
448   return cast_or_null<syntax::Leaf>(
449       findChild(syntax::NodeRole::IntroducerKeyword));
450 }
451 
452 syntax::Leaf *syntax::ExplicitTemplateInstantiation::externKeyword() {
453   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::ExternKeyword));
454 }
455 
456 syntax::Declaration *syntax::ExplicitTemplateInstantiation::declaration() {
457   return cast_or_null<syntax::Declaration>(
458       findChild(syntax::NodeRole::ExplicitTemplateInstantiation_declaration));
459 }
460 
461 syntax::Leaf *syntax::ParenDeclarator::lparen() {
462   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::OpenParen));
463 }
464 
465 syntax::Leaf *syntax::ParenDeclarator::rparen() {
466   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::CloseParen));
467 }
468 
469 syntax::Leaf *syntax::ArraySubscript::lbracket() {
470   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::OpenParen));
471 }
472 
473 syntax::Expression *syntax::ArraySubscript::sizeExpression() {
474   return cast_or_null<syntax::Expression>(
475       findChild(syntax::NodeRole::ArraySubscript_sizeExpression));
476 }
477 
478 syntax::Leaf *syntax::ArraySubscript::rbracket() {
479   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::CloseParen));
480 }
481 
482 syntax::Leaf *syntax::TrailingReturnType::arrowToken() {
483   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::ArrowToken));
484 }
485 
486 syntax::SimpleDeclarator *syntax::TrailingReturnType::declarator() {
487   return cast_or_null<syntax::SimpleDeclarator>(
488       findChild(syntax::NodeRole::TrailingReturnType_declarator));
489 }
490 
491 syntax::Leaf *syntax::ParametersAndQualifiers::lparen() {
492   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::OpenParen));
493 }
494 
495 std::vector<syntax::SimpleDeclaration *>
496 syntax::ParametersAndQualifiers::parameters() {
497   std::vector<syntax::SimpleDeclaration *> Children;
498   for (auto *C = firstChild(); C; C = C->nextSibling()) {
499     if (C->role() == syntax::NodeRole::ParametersAndQualifiers_parameter)
500       Children.push_back(cast<syntax::SimpleDeclaration>(C));
501   }
502   return Children;
503 }
504 
505 syntax::Leaf *syntax::ParametersAndQualifiers::rparen() {
506   return cast_or_null<syntax::Leaf>(findChild(syntax::NodeRole::CloseParen));
507 }
508 
509 syntax::TrailingReturnType *syntax::ParametersAndQualifiers::trailingReturn() {
510   return cast_or_null<syntax::TrailingReturnType>(
511       findChild(syntax::NodeRole::ParametersAndQualifiers_trailingReturn));
512 }
513