1 //===--- Stmt.h - Classes for representing statements -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the Stmt interface and subclasses.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_AST_STMT_H
15 #define LLVM_CLANG_AST_STMT_H
17 #include "clang/AST/DeclGroup.h"
18 #include "clang/AST/StmtIterator.h"
19 #include "clang/Basic/CapturedStmt.h"
20 #include "clang/Basic/IdentifierTable.h"
21 #include "clang/Basic/LLVM.h"
22 #include "clang/Basic/SourceLocation.h"
23 #include "llvm/ADT/ArrayRef.h"
24 #include "llvm/ADT/PointerIntPair.h"
25 #include "llvm/Support/Compiler.h"
26 #include "llvm/Support/ErrorHandling.h"
30 class FoldingSetNodeID;
43 struct PrintingPolicy;
52 //===--------------------------------------------------------------------===//
53 // ExprIterator - Iterators for iterating over Stmt* arrays that contain
54 // only Expr*. This is needed because AST nodes use Stmt* arrays to store
55 // references to children (to be compatible with StmtIterator).
56 //===--------------------------------------------------------------------===//
64 ExprIterator(Stmt** i) : I(i) {}
65 ExprIterator() : I(nullptr) {}
66 ExprIterator& operator++() { ++I; return *this; }
67 ExprIterator operator-(size_t i) { return I-i; }
68 ExprIterator operator+(size_t i) { return I+i; }
69 Expr* operator[](size_t idx);
70 // FIXME: Verify that this will correctly return a signed distance.
71 signed operator-(const ExprIterator& R) const { return I - R.I; }
72 Expr* operator*() const;
73 Expr* operator->() const;
74 bool operator==(const ExprIterator& R) const { return I == R.I; }
75 bool operator!=(const ExprIterator& R) const { return I != R.I; }
76 bool operator>(const ExprIterator& R) const { return I > R.I; }
77 bool operator>=(const ExprIterator& R) const { return I >= R.I; }
80 class ConstExprIterator {
81 const Stmt * const *I;
83 ConstExprIterator(const Stmt * const *i) : I(i) {}
84 ConstExprIterator() : I(nullptr) {}
85 ConstExprIterator& operator++() { ++I; return *this; }
86 ConstExprIterator operator+(size_t i) const { return I+i; }
87 ConstExprIterator operator-(size_t i) const { return I-i; }
88 const Expr * operator[](size_t idx) const;
89 signed operator-(const ConstExprIterator& R) const { return I - R.I; }
90 const Expr * operator*() const;
91 const Expr * operator->() const;
92 bool operator==(const ConstExprIterator& R) const { return I == R.I; }
93 bool operator!=(const ConstExprIterator& R) const { return I != R.I; }
94 bool operator>(const ConstExprIterator& R) const { return I > R.I; }
95 bool operator>=(const ConstExprIterator& R) const { return I >= R.I; }
98 //===----------------------------------------------------------------------===//
99 // AST classes for statements.
100 //===----------------------------------------------------------------------===//
102 /// Stmt - This represents one statement.
108 #define STMT(CLASS, PARENT) CLASS##Class,
109 #define STMT_RANGE(BASE, FIRST, LAST) \
110 first##BASE##Constant=FIRST##Class, last##BASE##Constant=LAST##Class,
111 #define LAST_STMT_RANGE(BASE, FIRST, LAST) \
112 first##BASE##Constant=FIRST##Class, last##BASE##Constant=LAST##Class
113 #define ABSTRACT_STMT(STMT)
114 #include "clang/AST/StmtNodes.inc"
117 // Make vanilla 'new' and 'delete' illegal for Stmts.
119 void* operator new(size_t bytes) throw() {
120 llvm_unreachable("Stmts cannot be allocated with regular 'new'.");
122 void operator delete(void* data) throw() {
123 llvm_unreachable("Stmts cannot be released with regular 'delete'.");
126 class StmtBitfields {
129 /// \brief The statement class.
132 enum { NumStmtBits = 8 };
134 class CompoundStmtBitfields {
135 friend class CompoundStmt;
136 unsigned : NumStmtBits;
138 unsigned NumStmts : 32 - NumStmtBits;
141 class ExprBitfields {
143 friend class DeclRefExpr; // computeDependence
144 friend class InitListExpr; // ctor
145 friend class DesignatedInitExpr; // ctor
146 friend class BlockDeclRefExpr; // ctor
147 friend class ASTStmtReader; // deserialization
148 friend class CXXNewExpr; // ctor
149 friend class DependentScopeDeclRefExpr; // ctor
150 friend class CXXConstructExpr; // ctor
151 friend class CallExpr; // ctor
152 friend class OffsetOfExpr; // ctor
153 friend class ObjCMessageExpr; // ctor
154 friend class ObjCArrayLiteral; // ctor
155 friend class ObjCDictionaryLiteral; // ctor
156 friend class ShuffleVectorExpr; // ctor
157 friend class ParenListExpr; // ctor
158 friend class CXXUnresolvedConstructExpr; // ctor
159 friend class CXXDependentScopeMemberExpr; // ctor
160 friend class OverloadExpr; // ctor
161 friend class PseudoObjectExpr; // ctor
162 friend class AtomicExpr; // ctor
163 unsigned : NumStmtBits;
165 unsigned ValueKind : 2;
166 unsigned ObjectKind : 2;
167 unsigned TypeDependent : 1;
168 unsigned ValueDependent : 1;
169 unsigned InstantiationDependent : 1;
170 unsigned ContainsUnexpandedParameterPack : 1;
172 enum { NumExprBits = 16 };
174 class CharacterLiteralBitfields {
175 friend class CharacterLiteral;
176 unsigned : NumExprBits;
181 enum APFloatSemantics {
190 class FloatingLiteralBitfields {
191 friend class FloatingLiteral;
192 unsigned : NumExprBits;
194 unsigned Semantics : 3; // Provides semantics for APFloat construction
195 unsigned IsExact : 1;
198 class UnaryExprOrTypeTraitExprBitfields {
199 friend class UnaryExprOrTypeTraitExpr;
200 unsigned : NumExprBits;
203 unsigned IsType : 1; // true if operand is a type, false if an expression.
206 class DeclRefExprBitfields {
207 friend class DeclRefExpr;
208 friend class ASTStmtReader; // deserialization
209 unsigned : NumExprBits;
211 unsigned HasQualifier : 1;
212 unsigned HasTemplateKWAndArgsInfo : 1;
213 unsigned HasFoundDecl : 1;
214 unsigned HadMultipleCandidates : 1;
215 unsigned RefersToEnclosingLocal : 1;
218 class CastExprBitfields {
219 friend class CastExpr;
220 unsigned : NumExprBits;
223 unsigned BasePathSize : 32 - 6 - NumExprBits;
226 class CallExprBitfields {
227 friend class CallExpr;
228 unsigned : NumExprBits;
230 unsigned NumPreArgs : 1;
233 class ExprWithCleanupsBitfields {
234 friend class ExprWithCleanups;
235 friend class ASTStmtReader; // deserialization
237 unsigned : NumExprBits;
239 unsigned NumObjects : 32 - NumExprBits;
242 class PseudoObjectExprBitfields {
243 friend class PseudoObjectExpr;
244 friend class ASTStmtReader; // deserialization
246 unsigned : NumExprBits;
248 // These don't need to be particularly wide, because they're
249 // strictly limited by the forms of expressions we permit.
250 unsigned NumSubExprs : 8;
251 unsigned ResultIndex : 32 - 8 - NumExprBits;
254 class ObjCIndirectCopyRestoreExprBitfields {
255 friend class ObjCIndirectCopyRestoreExpr;
256 unsigned : NumExprBits;
258 unsigned ShouldCopy : 1;
261 class InitListExprBitfields {
262 friend class InitListExpr;
264 unsigned : NumExprBits;
266 /// Whether this initializer list originally had a GNU array-range
267 /// designator in it. This is a temporary marker used by CodeGen.
268 unsigned HadArrayRangeDesignator : 1;
271 class TypeTraitExprBitfields {
272 friend class TypeTraitExpr;
273 friend class ASTStmtReader;
274 friend class ASTStmtWriter;
276 unsigned : NumExprBits;
278 /// \brief The kind of type trait, which is a value of a TypeTrait enumerator.
281 /// \brief If this expression is not value-dependent, this indicates whether
282 /// the trait evaluated true or false.
285 /// \brief The number of arguments to this type trait.
286 unsigned NumArgs : 32 - 8 - 1 - NumExprBits;
290 // FIXME: this is wasteful on 64-bit platforms.
293 StmtBitfields StmtBits;
294 CompoundStmtBitfields CompoundStmtBits;
295 ExprBitfields ExprBits;
296 CharacterLiteralBitfields CharacterLiteralBits;
297 FloatingLiteralBitfields FloatingLiteralBits;
298 UnaryExprOrTypeTraitExprBitfields UnaryExprOrTypeTraitExprBits;
299 DeclRefExprBitfields DeclRefExprBits;
300 CastExprBitfields CastExprBits;
301 CallExprBitfields CallExprBits;
302 ExprWithCleanupsBitfields ExprWithCleanupsBits;
303 PseudoObjectExprBitfields PseudoObjectExprBits;
304 ObjCIndirectCopyRestoreExprBitfields ObjCIndirectCopyRestoreExprBits;
305 InitListExprBitfields InitListExprBits;
306 TypeTraitExprBitfields TypeTraitExprBits;
309 friend class ASTStmtReader;
310 friend class ASTStmtWriter;
313 // Only allow allocation of Stmts using the allocator in ASTContext
314 // or by doing a placement new.
315 void* operator new(size_t bytes, const ASTContext& C,
316 unsigned alignment = 8);
318 void* operator new(size_t bytes, const ASTContext* C,
319 unsigned alignment = 8) {
320 return operator new(bytes, *C, alignment);
323 void* operator new(size_t bytes, void* mem) throw() {
327 void operator delete(void*, const ASTContext&, unsigned) throw() { }
328 void operator delete(void*, const ASTContext*, unsigned) throw() { }
329 void operator delete(void*, size_t) throw() { }
330 void operator delete(void*, void*) throw() { }
333 /// \brief A placeholder type used to construct an empty shell of a
334 /// type, that will be filled in later (e.g., by some
335 /// de-serialization).
336 struct EmptyShell { };
339 /// \brief Whether statistic collection is enabled.
340 static bool StatisticsEnabled;
343 /// \brief Construct an empty statement.
344 explicit Stmt(StmtClass SC, EmptyShell) {
345 StmtBits.sClass = SC;
346 if (StatisticsEnabled) Stmt::addStmtClass(SC);
351 StmtBits.sClass = SC;
352 if (StatisticsEnabled) Stmt::addStmtClass(SC);
355 StmtClass getStmtClass() const {
356 return static_cast<StmtClass>(StmtBits.sClass);
358 const char *getStmtClassName() const;
360 /// SourceLocation tokens are not useful in isolation - they are low level
361 /// value objects created/interpreted by SourceManager. We assume AST
362 /// clients will have a pointer to the respective SourceManager.
363 SourceRange getSourceRange() const LLVM_READONLY;
364 SourceLocation getLocStart() const LLVM_READONLY;
365 SourceLocation getLocEnd() const LLVM_READONLY;
367 // global temp stats (until we have a per-module visitor)
368 static void addStmtClass(const StmtClass s);
369 static void EnableStatistics();
370 static void PrintStats();
372 /// \brief Dumps the specified AST fragment and all subtrees to
375 void dump(SourceManager &SM) const;
376 void dump(raw_ostream &OS, SourceManager &SM) const;
378 /// dumpColor - same as dump(), but forces color highlighting.
379 void dumpColor() const;
381 /// dumpPretty/printPretty - These two methods do a "pretty print" of the AST
382 /// back to its original source language syntax.
383 void dumpPretty(const ASTContext &Context) const;
384 void printPretty(raw_ostream &OS, PrinterHelper *Helper,
385 const PrintingPolicy &Policy,
386 unsigned Indentation = 0) const;
388 /// viewAST - Visualize an AST rooted at this Stmt* using GraphViz. Only
389 /// works on systems with GraphViz (Mac OS X) or dot+gv installed.
390 void viewAST() const;
392 /// Skip past any implicit AST nodes which might surround this
393 /// statement, such as ExprWithCleanups or ImplicitCastExpr nodes.
394 Stmt *IgnoreImplicit();
396 const Stmt *stripLabelLikeStatements() const;
397 Stmt *stripLabelLikeStatements() {
398 return const_cast<Stmt*>(
399 const_cast<const Stmt*>(this)->stripLabelLikeStatements());
402 /// Child Iterators: All subclasses must implement 'children'
403 /// to permit easy iteration over the substatements/subexpessions of an
404 /// AST node. This permits easy iteration over all nodes in the AST.
405 typedef StmtIterator child_iterator;
406 typedef ConstStmtIterator const_child_iterator;
408 typedef StmtRange child_range;
409 typedef ConstStmtRange const_child_range;
411 child_range children();
412 const_child_range children() const {
413 return const_cast<Stmt*>(this)->children();
416 child_iterator child_begin() { return children().first; }
417 child_iterator child_end() { return children().second; }
419 const_child_iterator child_begin() const { return children().first; }
420 const_child_iterator child_end() const { return children().second; }
422 /// \brief Produce a unique representation of the given statement.
424 /// \param ID once the profiling operation is complete, will contain
425 /// the unique representation of the given statement.
427 /// \param Context the AST context in which the statement resides
429 /// \param Canonical whether the profile should be based on the canonical
430 /// representation of this statement (e.g., where non-type template
431 /// parameters are identified by index/level rather than their
432 /// declaration pointers) or the exact representation of the statement as
433 /// written in the source.
434 void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
435 bool Canonical) const;
438 /// DeclStmt - Adaptor class for mixing declarations with statements and
439 /// expressions. For example, CompoundStmt mixes statements, expressions
440 /// and declarations (variables, types). Another example is ForStmt, where
441 /// the first statement can be an expression or a declaration.
443 class DeclStmt : public Stmt {
445 SourceLocation StartLoc, EndLoc;
448 DeclStmt(DeclGroupRef dg, SourceLocation startLoc,
449 SourceLocation endLoc) : Stmt(DeclStmtClass), DG(dg),
450 StartLoc(startLoc), EndLoc(endLoc) {}
452 /// \brief Build an empty declaration statement.
453 explicit DeclStmt(EmptyShell Empty) : Stmt(DeclStmtClass, Empty) { }
455 /// isSingleDecl - This method returns true if this DeclStmt refers
456 /// to a single Decl.
457 bool isSingleDecl() const {
458 return DG.isSingleDecl();
461 const Decl *getSingleDecl() const { return DG.getSingleDecl(); }
462 Decl *getSingleDecl() { return DG.getSingleDecl(); }
464 const DeclGroupRef getDeclGroup() const { return DG; }
465 DeclGroupRef getDeclGroup() { return DG; }
466 void setDeclGroup(DeclGroupRef DGR) { DG = DGR; }
468 SourceLocation getStartLoc() const { return StartLoc; }
469 void setStartLoc(SourceLocation L) { StartLoc = L; }
470 SourceLocation getEndLoc() const { return EndLoc; }
471 void setEndLoc(SourceLocation L) { EndLoc = L; }
473 SourceLocation getLocStart() const LLVM_READONLY { return StartLoc; }
474 SourceLocation getLocEnd() const LLVM_READONLY { return EndLoc; }
476 static bool classof(const Stmt *T) {
477 return T->getStmtClass() == DeclStmtClass;
480 // Iterators over subexpressions.
481 child_range children() {
482 return child_range(child_iterator(DG.begin(), DG.end()),
483 child_iterator(DG.end(), DG.end()));
486 typedef DeclGroupRef::iterator decl_iterator;
487 typedef DeclGroupRef::const_iterator const_decl_iterator;
488 typedef llvm::iterator_range<decl_iterator> decl_range;
489 typedef llvm::iterator_range<const_decl_iterator> decl_const_range;
491 decl_range decls() { return decl_range(decl_begin(), decl_end()); }
492 decl_const_range decls() const {
493 return decl_const_range(decl_begin(), decl_end());
495 decl_iterator decl_begin() { return DG.begin(); }
496 decl_iterator decl_end() { return DG.end(); }
497 const_decl_iterator decl_begin() const { return DG.begin(); }
498 const_decl_iterator decl_end() const { return DG.end(); }
500 typedef std::reverse_iterator<decl_iterator> reverse_decl_iterator;
501 reverse_decl_iterator decl_rbegin() {
502 return reverse_decl_iterator(decl_end());
504 reverse_decl_iterator decl_rend() {
505 return reverse_decl_iterator(decl_begin());
509 /// NullStmt - This is the null statement ";": C99 6.8.3p3.
511 class NullStmt : public Stmt {
512 SourceLocation SemiLoc;
514 /// \brief True if the null statement was preceded by an empty macro, e.g:
519 bool HasLeadingEmptyMacro;
521 NullStmt(SourceLocation L, bool hasLeadingEmptyMacro = false)
522 : Stmt(NullStmtClass), SemiLoc(L),
523 HasLeadingEmptyMacro(hasLeadingEmptyMacro) {}
525 /// \brief Build an empty null statement.
526 explicit NullStmt(EmptyShell Empty) : Stmt(NullStmtClass, Empty),
527 HasLeadingEmptyMacro(false) { }
529 SourceLocation getSemiLoc() const { return SemiLoc; }
530 void setSemiLoc(SourceLocation L) { SemiLoc = L; }
532 bool hasLeadingEmptyMacro() const { return HasLeadingEmptyMacro; }
534 SourceLocation getLocStart() const LLVM_READONLY { return SemiLoc; }
535 SourceLocation getLocEnd() const LLVM_READONLY { return SemiLoc; }
537 static bool classof(const Stmt *T) {
538 return T->getStmtClass() == NullStmtClass;
541 child_range children() { return child_range(); }
543 friend class ASTStmtReader;
544 friend class ASTStmtWriter;
547 /// CompoundStmt - This represents a group of statements like { stmt stmt }.
549 class CompoundStmt : public Stmt {
551 SourceLocation LBracLoc, RBracLoc;
553 CompoundStmt(const ASTContext &C, ArrayRef<Stmt*> Stmts,
554 SourceLocation LB, SourceLocation RB);
556 // \brief Build an empty compound statement with a location.
557 explicit CompoundStmt(SourceLocation Loc)
558 : Stmt(CompoundStmtClass), Body(nullptr), LBracLoc(Loc), RBracLoc(Loc) {
559 CompoundStmtBits.NumStmts = 0;
562 // \brief Build an empty compound statement.
563 explicit CompoundStmt(EmptyShell Empty)
564 : Stmt(CompoundStmtClass, Empty), Body(nullptr) {
565 CompoundStmtBits.NumStmts = 0;
568 void setStmts(const ASTContext &C, Stmt **Stmts, unsigned NumStmts);
570 bool body_empty() const { return CompoundStmtBits.NumStmts == 0; }
571 unsigned size() const { return CompoundStmtBits.NumStmts; }
573 typedef Stmt** body_iterator;
574 typedef llvm::iterator_range<body_iterator> body_range;
576 body_range body() { return body_range(body_begin(), body_end()); }
577 body_iterator body_begin() { return Body; }
578 body_iterator body_end() { return Body + size(); }
579 Stmt *body_back() { return !body_empty() ? Body[size()-1] : nullptr; }
581 void setLastStmt(Stmt *S) {
582 assert(!body_empty() && "setLastStmt");
586 typedef Stmt* const * const_body_iterator;
587 typedef llvm::iterator_range<const_body_iterator> body_const_range;
589 body_const_range body() const {
590 return body_const_range(body_begin(), body_end());
592 const_body_iterator body_begin() const { return Body; }
593 const_body_iterator body_end() const { return Body + size(); }
594 const Stmt *body_back() const {
595 return !body_empty() ? Body[size() - 1] : nullptr;
598 typedef std::reverse_iterator<body_iterator> reverse_body_iterator;
599 reverse_body_iterator body_rbegin() {
600 return reverse_body_iterator(body_end());
602 reverse_body_iterator body_rend() {
603 return reverse_body_iterator(body_begin());
606 typedef std::reverse_iterator<const_body_iterator>
607 const_reverse_body_iterator;
609 const_reverse_body_iterator body_rbegin() const {
610 return const_reverse_body_iterator(body_end());
613 const_reverse_body_iterator body_rend() const {
614 return const_reverse_body_iterator(body_begin());
617 SourceLocation getLocStart() const LLVM_READONLY { return LBracLoc; }
618 SourceLocation getLocEnd() const LLVM_READONLY { return RBracLoc; }
620 SourceLocation getLBracLoc() const { return LBracLoc; }
621 void setLBracLoc(SourceLocation L) { LBracLoc = L; }
622 SourceLocation getRBracLoc() const { return RBracLoc; }
623 void setRBracLoc(SourceLocation L) { RBracLoc = L; }
625 static bool classof(const Stmt *T) {
626 return T->getStmtClass() == CompoundStmtClass;
630 child_range children() {
631 return child_range(Body, Body + CompoundStmtBits.NumStmts);
634 const_child_range children() const {
635 return child_range(Body, Body + CompoundStmtBits.NumStmts);
639 // SwitchCase is the base class for CaseStmt and DefaultStmt,
640 class SwitchCase : public Stmt {
642 // A pointer to the following CaseStmt or DefaultStmt class,
643 // used by SwitchStmt.
644 SwitchCase *NextSwitchCase;
645 SourceLocation KeywordLoc;
646 SourceLocation ColonLoc;
648 SwitchCase(StmtClass SC, SourceLocation KWLoc, SourceLocation ColonLoc)
649 : Stmt(SC), NextSwitchCase(nullptr), KeywordLoc(KWLoc), ColonLoc(ColonLoc) {
652 SwitchCase(StmtClass SC, EmptyShell)
653 : Stmt(SC), NextSwitchCase(nullptr) {}
656 const SwitchCase *getNextSwitchCase() const { return NextSwitchCase; }
658 SwitchCase *getNextSwitchCase() { return NextSwitchCase; }
660 void setNextSwitchCase(SwitchCase *SC) { NextSwitchCase = SC; }
662 SourceLocation getKeywordLoc() const { return KeywordLoc; }
663 void setKeywordLoc(SourceLocation L) { KeywordLoc = L; }
664 SourceLocation getColonLoc() const { return ColonLoc; }
665 void setColonLoc(SourceLocation L) { ColonLoc = L; }
668 const Stmt *getSubStmt() const {
669 return const_cast<SwitchCase*>(this)->getSubStmt();
672 SourceLocation getLocStart() const LLVM_READONLY { return KeywordLoc; }
673 SourceLocation getLocEnd() const LLVM_READONLY;
675 static bool classof(const Stmt *T) {
676 return T->getStmtClass() == CaseStmtClass ||
677 T->getStmtClass() == DefaultStmtClass;
681 class CaseStmt : public SwitchCase {
682 enum { LHS, RHS, SUBSTMT, END_EXPR };
683 Stmt* SubExprs[END_EXPR]; // The expression for the RHS is Non-null for
684 // GNU "case 1 ... 4" extension
685 SourceLocation EllipsisLoc;
687 CaseStmt(Expr *lhs, Expr *rhs, SourceLocation caseLoc,
688 SourceLocation ellipsisLoc, SourceLocation colonLoc)
689 : SwitchCase(CaseStmtClass, caseLoc, colonLoc) {
690 SubExprs[SUBSTMT] = nullptr;
691 SubExprs[LHS] = reinterpret_cast<Stmt*>(lhs);
692 SubExprs[RHS] = reinterpret_cast<Stmt*>(rhs);
693 EllipsisLoc = ellipsisLoc;
696 /// \brief Build an empty switch case statement.
697 explicit CaseStmt(EmptyShell Empty) : SwitchCase(CaseStmtClass, Empty) { }
699 SourceLocation getCaseLoc() const { return KeywordLoc; }
700 void setCaseLoc(SourceLocation L) { KeywordLoc = L; }
701 SourceLocation getEllipsisLoc() const { return EllipsisLoc; }
702 void setEllipsisLoc(SourceLocation L) { EllipsisLoc = L; }
703 SourceLocation getColonLoc() const { return ColonLoc; }
704 void setColonLoc(SourceLocation L) { ColonLoc = L; }
706 Expr *getLHS() { return reinterpret_cast<Expr*>(SubExprs[LHS]); }
707 Expr *getRHS() { return reinterpret_cast<Expr*>(SubExprs[RHS]); }
708 Stmt *getSubStmt() { return SubExprs[SUBSTMT]; }
710 const Expr *getLHS() const {
711 return reinterpret_cast<const Expr*>(SubExprs[LHS]);
713 const Expr *getRHS() const {
714 return reinterpret_cast<const Expr*>(SubExprs[RHS]);
716 const Stmt *getSubStmt() const { return SubExprs[SUBSTMT]; }
718 void setSubStmt(Stmt *S) { SubExprs[SUBSTMT] = S; }
719 void setLHS(Expr *Val) { SubExprs[LHS] = reinterpret_cast<Stmt*>(Val); }
720 void setRHS(Expr *Val) { SubExprs[RHS] = reinterpret_cast<Stmt*>(Val); }
722 SourceLocation getLocStart() const LLVM_READONLY { return KeywordLoc; }
723 SourceLocation getLocEnd() const LLVM_READONLY {
724 // Handle deeply nested case statements with iteration instead of recursion.
725 const CaseStmt *CS = this;
726 while (const CaseStmt *CS2 = dyn_cast<CaseStmt>(CS->getSubStmt()))
729 return CS->getSubStmt()->getLocEnd();
732 static bool classof(const Stmt *T) {
733 return T->getStmtClass() == CaseStmtClass;
737 child_range children() {
738 return child_range(&SubExprs[0], &SubExprs[END_EXPR]);
742 class DefaultStmt : public SwitchCase {
745 DefaultStmt(SourceLocation DL, SourceLocation CL, Stmt *substmt) :
746 SwitchCase(DefaultStmtClass, DL, CL), SubStmt(substmt) {}
748 /// \brief Build an empty default statement.
749 explicit DefaultStmt(EmptyShell Empty)
750 : SwitchCase(DefaultStmtClass, Empty) { }
752 Stmt *getSubStmt() { return SubStmt; }
753 const Stmt *getSubStmt() const { return SubStmt; }
754 void setSubStmt(Stmt *S) { SubStmt = S; }
756 SourceLocation getDefaultLoc() const { return KeywordLoc; }
757 void setDefaultLoc(SourceLocation L) { KeywordLoc = L; }
758 SourceLocation getColonLoc() const { return ColonLoc; }
759 void setColonLoc(SourceLocation L) { ColonLoc = L; }
761 SourceLocation getLocStart() const LLVM_READONLY { return KeywordLoc; }
762 SourceLocation getLocEnd() const LLVM_READONLY { return SubStmt->getLocEnd();}
764 static bool classof(const Stmt *T) {
765 return T->getStmtClass() == DefaultStmtClass;
769 child_range children() { return child_range(&SubStmt, &SubStmt+1); }
772 inline SourceLocation SwitchCase::getLocEnd() const {
773 if (const CaseStmt *CS = dyn_cast<CaseStmt>(this))
774 return CS->getLocEnd();
775 return cast<DefaultStmt>(this)->getLocEnd();
778 /// LabelStmt - Represents a label, which has a substatement. For example:
781 class LabelStmt : public Stmt {
784 SourceLocation IdentLoc;
786 LabelStmt(SourceLocation IL, LabelDecl *D, Stmt *substmt)
787 : Stmt(LabelStmtClass), TheDecl(D), SubStmt(substmt), IdentLoc(IL) {
790 // \brief Build an empty label statement.
791 explicit LabelStmt(EmptyShell Empty) : Stmt(LabelStmtClass, Empty) { }
793 SourceLocation getIdentLoc() const { return IdentLoc; }
794 LabelDecl *getDecl() const { return TheDecl; }
795 void setDecl(LabelDecl *D) { TheDecl = D; }
796 const char *getName() const;
797 Stmt *getSubStmt() { return SubStmt; }
798 const Stmt *getSubStmt() const { return SubStmt; }
799 void setIdentLoc(SourceLocation L) { IdentLoc = L; }
800 void setSubStmt(Stmt *SS) { SubStmt = SS; }
802 SourceLocation getLocStart() const LLVM_READONLY { return IdentLoc; }
803 SourceLocation getLocEnd() const LLVM_READONLY { return SubStmt->getLocEnd();}
805 child_range children() { return child_range(&SubStmt, &SubStmt+1); }
807 static bool classof(const Stmt *T) {
808 return T->getStmtClass() == LabelStmtClass;
813 /// \brief Represents an attribute applied to a statement.
815 /// Represents an attribute applied to a statement. For example:
816 /// [[omp::for(...)]] for (...) { ... }
818 class AttributedStmt : public Stmt {
820 SourceLocation AttrLoc;
823 friend class ASTStmtReader;
825 AttributedStmt(SourceLocation Loc, ArrayRef<const Attr*> Attrs, Stmt *SubStmt)
826 : Stmt(AttributedStmtClass), SubStmt(SubStmt), AttrLoc(Loc),
827 NumAttrs(Attrs.size()) {
828 memcpy(getAttrArrayPtr(), Attrs.data(), Attrs.size() * sizeof(Attr *));
831 explicit AttributedStmt(EmptyShell Empty, unsigned NumAttrs)
832 : Stmt(AttributedStmtClass, Empty), NumAttrs(NumAttrs) {
833 memset(getAttrArrayPtr(), 0, NumAttrs * sizeof(Attr *));
836 Attr *const *getAttrArrayPtr() const {
837 return reinterpret_cast<Attr *const *>(this + 1);
839 Attr **getAttrArrayPtr() { return reinterpret_cast<Attr **>(this + 1); }
842 static AttributedStmt *Create(const ASTContext &C, SourceLocation Loc,
843 ArrayRef<const Attr*> Attrs, Stmt *SubStmt);
844 // \brief Build an empty attributed statement.
845 static AttributedStmt *CreateEmpty(const ASTContext &C, unsigned NumAttrs);
847 SourceLocation getAttrLoc() const { return AttrLoc; }
848 ArrayRef<const Attr*> getAttrs() const {
849 return ArrayRef<const Attr*>(getAttrArrayPtr(), NumAttrs);
851 Stmt *getSubStmt() { return SubStmt; }
852 const Stmt *getSubStmt() const { return SubStmt; }
854 SourceLocation getLocStart() const LLVM_READONLY { return AttrLoc; }
855 SourceLocation getLocEnd() const LLVM_READONLY { return SubStmt->getLocEnd();}
857 child_range children() { return child_range(&SubStmt, &SubStmt + 1); }
859 static bool classof(const Stmt *T) {
860 return T->getStmtClass() == AttributedStmtClass;
865 /// IfStmt - This represents an if/then/else.
867 class IfStmt : public Stmt {
868 enum { VAR, COND, THEN, ELSE, END_EXPR };
869 Stmt* SubExprs[END_EXPR];
871 SourceLocation IfLoc;
872 SourceLocation ElseLoc;
875 IfStmt(const ASTContext &C, SourceLocation IL, VarDecl *var, Expr *cond,
876 Stmt *then, SourceLocation EL = SourceLocation(),
877 Stmt *elsev = nullptr);
879 /// \brief Build an empty if/then/else statement
880 explicit IfStmt(EmptyShell Empty) : Stmt(IfStmtClass, Empty) { }
882 /// \brief Retrieve the variable declared in this "if" statement, if any.
884 /// In the following example, "x" is the condition variable.
886 /// if (int x = foo()) {
887 /// printf("x is %d", x);
890 VarDecl *getConditionVariable() const;
891 void setConditionVariable(const ASTContext &C, VarDecl *V);
893 /// If this IfStmt has a condition variable, return the faux DeclStmt
894 /// associated with the creation of that condition variable.
895 const DeclStmt *getConditionVariableDeclStmt() const {
896 return reinterpret_cast<DeclStmt*>(SubExprs[VAR]);
899 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
900 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt *>(E); }
901 const Stmt *getThen() const { return SubExprs[THEN]; }
902 void setThen(Stmt *S) { SubExprs[THEN] = S; }
903 const Stmt *getElse() const { return SubExprs[ELSE]; }
904 void setElse(Stmt *S) { SubExprs[ELSE] = S; }
906 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
907 Stmt *getThen() { return SubExprs[THEN]; }
908 Stmt *getElse() { return SubExprs[ELSE]; }
910 SourceLocation getIfLoc() const { return IfLoc; }
911 void setIfLoc(SourceLocation L) { IfLoc = L; }
912 SourceLocation getElseLoc() const { return ElseLoc; }
913 void setElseLoc(SourceLocation L) { ElseLoc = L; }
915 SourceLocation getLocStart() const LLVM_READONLY { return IfLoc; }
916 SourceLocation getLocEnd() const LLVM_READONLY {
918 return SubExprs[ELSE]->getLocEnd();
920 return SubExprs[THEN]->getLocEnd();
923 // Iterators over subexpressions. The iterators will include iterating
924 // over the initialization expression referenced by the condition variable.
925 child_range children() {
926 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
929 static bool classof(const Stmt *T) {
930 return T->getStmtClass() == IfStmtClass;
934 /// SwitchStmt - This represents a 'switch' stmt.
936 class SwitchStmt : public Stmt {
937 enum { VAR, COND, BODY, END_EXPR };
938 Stmt* SubExprs[END_EXPR];
939 // This points to a linked list of case and default statements.
940 SwitchCase *FirstCase;
941 SourceLocation SwitchLoc;
943 /// If the SwitchStmt is a switch on an enum value, this records whether
944 /// all the enum values were covered by CaseStmts. This value is meant to
945 /// be a hint for possible clients.
946 unsigned AllEnumCasesCovered : 1;
949 SwitchStmt(const ASTContext &C, VarDecl *Var, Expr *cond);
951 /// \brief Build a empty switch statement.
952 explicit SwitchStmt(EmptyShell Empty) : Stmt(SwitchStmtClass, Empty) { }
954 /// \brief Retrieve the variable declared in this "switch" statement, if any.
956 /// In the following example, "x" is the condition variable.
958 /// switch (int x = foo()) {
963 VarDecl *getConditionVariable() const;
964 void setConditionVariable(const ASTContext &C, VarDecl *V);
966 /// If this SwitchStmt has a condition variable, return the faux DeclStmt
967 /// associated with the creation of that condition variable.
968 const DeclStmt *getConditionVariableDeclStmt() const {
969 return reinterpret_cast<DeclStmt*>(SubExprs[VAR]);
972 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
973 const Stmt *getBody() const { return SubExprs[BODY]; }
974 const SwitchCase *getSwitchCaseList() const { return FirstCase; }
976 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]);}
977 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt *>(E); }
978 Stmt *getBody() { return SubExprs[BODY]; }
979 void setBody(Stmt *S) { SubExprs[BODY] = S; }
980 SwitchCase *getSwitchCaseList() { return FirstCase; }
982 /// \brief Set the case list for this switch statement.
983 void setSwitchCaseList(SwitchCase *SC) { FirstCase = SC; }
985 SourceLocation getSwitchLoc() const { return SwitchLoc; }
986 void setSwitchLoc(SourceLocation L) { SwitchLoc = L; }
988 void setBody(Stmt *S, SourceLocation SL) {
992 void addSwitchCase(SwitchCase *SC) {
993 assert(!SC->getNextSwitchCase()
994 && "case/default already added to a switch");
995 SC->setNextSwitchCase(FirstCase);
999 /// Set a flag in the SwitchStmt indicating that if the 'switch (X)' is a
1000 /// switch over an enum value then all cases have been explicitly covered.
1001 void setAllEnumCasesCovered() {
1002 AllEnumCasesCovered = 1;
1005 /// Returns true if the SwitchStmt is a switch of an enum value and all cases
1006 /// have been explicitly covered.
1007 bool isAllEnumCasesCovered() const {
1008 return (bool) AllEnumCasesCovered;
1011 SourceLocation getLocStart() const LLVM_READONLY { return SwitchLoc; }
1012 SourceLocation getLocEnd() const LLVM_READONLY {
1013 return SubExprs[BODY]->getLocEnd();
1017 child_range children() {
1018 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1021 static bool classof(const Stmt *T) {
1022 return T->getStmtClass() == SwitchStmtClass;
1027 /// WhileStmt - This represents a 'while' stmt.
1029 class WhileStmt : public Stmt {
1030 enum { VAR, COND, BODY, END_EXPR };
1031 Stmt* SubExprs[END_EXPR];
1032 SourceLocation WhileLoc;
1034 WhileStmt(const ASTContext &C, VarDecl *Var, Expr *cond, Stmt *body,
1037 /// \brief Build an empty while statement.
1038 explicit WhileStmt(EmptyShell Empty) : Stmt(WhileStmtClass, Empty) { }
1040 /// \brief Retrieve the variable declared in this "while" statement, if any.
1042 /// In the following example, "x" is the condition variable.
1044 /// while (int x = random()) {
1048 VarDecl *getConditionVariable() const;
1049 void setConditionVariable(const ASTContext &C, VarDecl *V);
1051 /// If this WhileStmt has a condition variable, return the faux DeclStmt
1052 /// associated with the creation of that condition variable.
1053 const DeclStmt *getConditionVariableDeclStmt() const {
1054 return reinterpret_cast<DeclStmt*>(SubExprs[VAR]);
1057 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
1058 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
1059 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt*>(E); }
1060 Stmt *getBody() { return SubExprs[BODY]; }
1061 const Stmt *getBody() const { return SubExprs[BODY]; }
1062 void setBody(Stmt *S) { SubExprs[BODY] = S; }
1064 SourceLocation getWhileLoc() const { return WhileLoc; }
1065 void setWhileLoc(SourceLocation L) { WhileLoc = L; }
1067 SourceLocation getLocStart() const LLVM_READONLY { return WhileLoc; }
1068 SourceLocation getLocEnd() const LLVM_READONLY {
1069 return SubExprs[BODY]->getLocEnd();
1072 static bool classof(const Stmt *T) {
1073 return T->getStmtClass() == WhileStmtClass;
1077 child_range children() {
1078 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1082 /// DoStmt - This represents a 'do/while' stmt.
1084 class DoStmt : public Stmt {
1085 enum { BODY, COND, END_EXPR };
1086 Stmt* SubExprs[END_EXPR];
1087 SourceLocation DoLoc;
1088 SourceLocation WhileLoc;
1089 SourceLocation RParenLoc; // Location of final ')' in do stmt condition.
1092 DoStmt(Stmt *body, Expr *cond, SourceLocation DL, SourceLocation WL,
1094 : Stmt(DoStmtClass), DoLoc(DL), WhileLoc(WL), RParenLoc(RP) {
1095 SubExprs[COND] = reinterpret_cast<Stmt*>(cond);
1096 SubExprs[BODY] = body;
1099 /// \brief Build an empty do-while statement.
1100 explicit DoStmt(EmptyShell Empty) : Stmt(DoStmtClass, Empty) { }
1102 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
1103 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
1104 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt*>(E); }
1105 Stmt *getBody() { return SubExprs[BODY]; }
1106 const Stmt *getBody() const { return SubExprs[BODY]; }
1107 void setBody(Stmt *S) { SubExprs[BODY] = S; }
1109 SourceLocation getDoLoc() const { return DoLoc; }
1110 void setDoLoc(SourceLocation L) { DoLoc = L; }
1111 SourceLocation getWhileLoc() const { return WhileLoc; }
1112 void setWhileLoc(SourceLocation L) { WhileLoc = L; }
1114 SourceLocation getRParenLoc() const { return RParenLoc; }
1115 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
1117 SourceLocation getLocStart() const LLVM_READONLY { return DoLoc; }
1118 SourceLocation getLocEnd() const LLVM_READONLY { return RParenLoc; }
1120 static bool classof(const Stmt *T) {
1121 return T->getStmtClass() == DoStmtClass;
1125 child_range children() {
1126 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1131 /// ForStmt - This represents a 'for (init;cond;inc)' stmt. Note that any of
1132 /// the init/cond/inc parts of the ForStmt will be null if they were not
1133 /// specified in the source.
1135 class ForStmt : public Stmt {
1136 enum { INIT, CONDVAR, COND, INC, BODY, END_EXPR };
1137 Stmt* SubExprs[END_EXPR]; // SubExprs[INIT] is an expression or declstmt.
1138 SourceLocation ForLoc;
1139 SourceLocation LParenLoc, RParenLoc;
1142 ForStmt(const ASTContext &C, Stmt *Init, Expr *Cond, VarDecl *condVar,
1143 Expr *Inc, Stmt *Body, SourceLocation FL, SourceLocation LP,
1146 /// \brief Build an empty for statement.
1147 explicit ForStmt(EmptyShell Empty) : Stmt(ForStmtClass, Empty) { }
1149 Stmt *getInit() { return SubExprs[INIT]; }
1151 /// \brief Retrieve the variable declared in this "for" statement, if any.
1153 /// In the following example, "y" is the condition variable.
1155 /// for (int x = random(); int y = mangle(x); ++x) {
1159 VarDecl *getConditionVariable() const;
1160 void setConditionVariable(const ASTContext &C, VarDecl *V);
1162 /// If this ForStmt has a condition variable, return the faux DeclStmt
1163 /// associated with the creation of that condition variable.
1164 const DeclStmt *getConditionVariableDeclStmt() const {
1165 return reinterpret_cast<DeclStmt*>(SubExprs[CONDVAR]);
1168 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
1169 Expr *getInc() { return reinterpret_cast<Expr*>(SubExprs[INC]); }
1170 Stmt *getBody() { return SubExprs[BODY]; }
1172 const Stmt *getInit() const { return SubExprs[INIT]; }
1173 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
1174 const Expr *getInc() const { return reinterpret_cast<Expr*>(SubExprs[INC]); }
1175 const Stmt *getBody() const { return SubExprs[BODY]; }
1177 void setInit(Stmt *S) { SubExprs[INIT] = S; }
1178 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt*>(E); }
1179 void setInc(Expr *E) { SubExprs[INC] = reinterpret_cast<Stmt*>(E); }
1180 void setBody(Stmt *S) { SubExprs[BODY] = S; }
1182 SourceLocation getForLoc() const { return ForLoc; }
1183 void setForLoc(SourceLocation L) { ForLoc = L; }
1184 SourceLocation getLParenLoc() const { return LParenLoc; }
1185 void setLParenLoc(SourceLocation L) { LParenLoc = L; }
1186 SourceLocation getRParenLoc() const { return RParenLoc; }
1187 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
1189 SourceLocation getLocStart() const LLVM_READONLY { return ForLoc; }
1190 SourceLocation getLocEnd() const LLVM_READONLY {
1191 return SubExprs[BODY]->getLocEnd();
1194 static bool classof(const Stmt *T) {
1195 return T->getStmtClass() == ForStmtClass;
1199 child_range children() {
1200 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1204 /// GotoStmt - This represents a direct goto.
1206 class GotoStmt : public Stmt {
1208 SourceLocation GotoLoc;
1209 SourceLocation LabelLoc;
1211 GotoStmt(LabelDecl *label, SourceLocation GL, SourceLocation LL)
1212 : Stmt(GotoStmtClass), Label(label), GotoLoc(GL), LabelLoc(LL) {}
1214 /// \brief Build an empty goto statement.
1215 explicit GotoStmt(EmptyShell Empty) : Stmt(GotoStmtClass, Empty) { }
1217 LabelDecl *getLabel() const { return Label; }
1218 void setLabel(LabelDecl *D) { Label = D; }
1220 SourceLocation getGotoLoc() const { return GotoLoc; }
1221 void setGotoLoc(SourceLocation L) { GotoLoc = L; }
1222 SourceLocation getLabelLoc() const { return LabelLoc; }
1223 void setLabelLoc(SourceLocation L) { LabelLoc = L; }
1225 SourceLocation getLocStart() const LLVM_READONLY { return GotoLoc; }
1226 SourceLocation getLocEnd() const LLVM_READONLY { return LabelLoc; }
1228 static bool classof(const Stmt *T) {
1229 return T->getStmtClass() == GotoStmtClass;
1233 child_range children() { return child_range(); }
1236 /// IndirectGotoStmt - This represents an indirect goto.
1238 class IndirectGotoStmt : public Stmt {
1239 SourceLocation GotoLoc;
1240 SourceLocation StarLoc;
1243 IndirectGotoStmt(SourceLocation gotoLoc, SourceLocation starLoc,
1245 : Stmt(IndirectGotoStmtClass), GotoLoc(gotoLoc), StarLoc(starLoc),
1246 Target((Stmt*)target) {}
1248 /// \brief Build an empty indirect goto statement.
1249 explicit IndirectGotoStmt(EmptyShell Empty)
1250 : Stmt(IndirectGotoStmtClass, Empty) { }
1252 void setGotoLoc(SourceLocation L) { GotoLoc = L; }
1253 SourceLocation getGotoLoc() const { return GotoLoc; }
1254 void setStarLoc(SourceLocation L) { StarLoc = L; }
1255 SourceLocation getStarLoc() const { return StarLoc; }
1257 Expr *getTarget() { return reinterpret_cast<Expr*>(Target); }
1258 const Expr *getTarget() const {return reinterpret_cast<const Expr*>(Target);}
1259 void setTarget(Expr *E) { Target = reinterpret_cast<Stmt*>(E); }
1261 /// getConstantTarget - Returns the fixed target of this indirect
1262 /// goto, if one exists.
1263 LabelDecl *getConstantTarget();
1264 const LabelDecl *getConstantTarget() const {
1265 return const_cast<IndirectGotoStmt*>(this)->getConstantTarget();
1268 SourceLocation getLocStart() const LLVM_READONLY { return GotoLoc; }
1269 SourceLocation getLocEnd() const LLVM_READONLY { return Target->getLocEnd(); }
1271 static bool classof(const Stmt *T) {
1272 return T->getStmtClass() == IndirectGotoStmtClass;
1276 child_range children() { return child_range(&Target, &Target+1); }
1280 /// ContinueStmt - This represents a continue.
1282 class ContinueStmt : public Stmt {
1283 SourceLocation ContinueLoc;
1285 ContinueStmt(SourceLocation CL) : Stmt(ContinueStmtClass), ContinueLoc(CL) {}
1287 /// \brief Build an empty continue statement.
1288 explicit ContinueStmt(EmptyShell Empty) : Stmt(ContinueStmtClass, Empty) { }
1290 SourceLocation getContinueLoc() const { return ContinueLoc; }
1291 void setContinueLoc(SourceLocation L) { ContinueLoc = L; }
1293 SourceLocation getLocStart() const LLVM_READONLY { return ContinueLoc; }
1294 SourceLocation getLocEnd() const LLVM_READONLY { return ContinueLoc; }
1296 static bool classof(const Stmt *T) {
1297 return T->getStmtClass() == ContinueStmtClass;
1301 child_range children() { return child_range(); }
1304 /// BreakStmt - This represents a break.
1306 class BreakStmt : public Stmt {
1307 SourceLocation BreakLoc;
1309 BreakStmt(SourceLocation BL) : Stmt(BreakStmtClass), BreakLoc(BL) {}
1311 /// \brief Build an empty break statement.
1312 explicit BreakStmt(EmptyShell Empty) : Stmt(BreakStmtClass, Empty) { }
1314 SourceLocation getBreakLoc() const { return BreakLoc; }
1315 void setBreakLoc(SourceLocation L) { BreakLoc = L; }
1317 SourceLocation getLocStart() const LLVM_READONLY { return BreakLoc; }
1318 SourceLocation getLocEnd() const LLVM_READONLY { return BreakLoc; }
1320 static bool classof(const Stmt *T) {
1321 return T->getStmtClass() == BreakStmtClass;
1325 child_range children() { return child_range(); }
1329 /// ReturnStmt - This represents a return, optionally of an expression:
1333 /// Note that GCC allows return with no argument in a function declared to
1334 /// return a value, and it allows returning a value in functions declared to
1335 /// return void. We explicitly model this in the AST, which means you can't
1336 /// depend on the return type of the function and the presence of an argument.
1338 class ReturnStmt : public Stmt {
1340 SourceLocation RetLoc;
1341 const VarDecl *NRVOCandidate;
1344 ReturnStmt(SourceLocation RL)
1345 : Stmt(ReturnStmtClass), RetExpr(nullptr), RetLoc(RL),
1346 NRVOCandidate(nullptr) {}
1348 ReturnStmt(SourceLocation RL, Expr *E, const VarDecl *NRVOCandidate)
1349 : Stmt(ReturnStmtClass), RetExpr((Stmt*) E), RetLoc(RL),
1350 NRVOCandidate(NRVOCandidate) {}
1352 /// \brief Build an empty return expression.
1353 explicit ReturnStmt(EmptyShell Empty) : Stmt(ReturnStmtClass, Empty) { }
1355 const Expr *getRetValue() const;
1356 Expr *getRetValue();
1357 void setRetValue(Expr *E) { RetExpr = reinterpret_cast<Stmt*>(E); }
1359 SourceLocation getReturnLoc() const { return RetLoc; }
1360 void setReturnLoc(SourceLocation L) { RetLoc = L; }
1362 /// \brief Retrieve the variable that might be used for the named return
1363 /// value optimization.
1365 /// The optimization itself can only be performed if the variable is
1366 /// also marked as an NRVO object.
1367 const VarDecl *getNRVOCandidate() const { return NRVOCandidate; }
1368 void setNRVOCandidate(const VarDecl *Var) { NRVOCandidate = Var; }
1370 SourceLocation getLocStart() const LLVM_READONLY { return RetLoc; }
1371 SourceLocation getLocEnd() const LLVM_READONLY {
1372 return RetExpr ? RetExpr->getLocEnd() : RetLoc;
1375 static bool classof(const Stmt *T) {
1376 return T->getStmtClass() == ReturnStmtClass;
1380 child_range children() {
1381 if (RetExpr) return child_range(&RetExpr, &RetExpr+1);
1382 return child_range();
1386 /// AsmStmt is the base class for GCCAsmStmt and MSAsmStmt.
1388 class AsmStmt : public Stmt {
1390 SourceLocation AsmLoc;
1391 /// \brief True if the assembly statement does not have any input or output
1395 /// \brief If true, treat this inline assembly as having side effects.
1396 /// This assembly statement should not be optimized, deleted or moved.
1399 unsigned NumOutputs;
1401 unsigned NumClobbers;
1405 AsmStmt(StmtClass SC, SourceLocation asmloc, bool issimple, bool isvolatile,
1406 unsigned numoutputs, unsigned numinputs, unsigned numclobbers) :
1407 Stmt (SC), AsmLoc(asmloc), IsSimple(issimple), IsVolatile(isvolatile),
1408 NumOutputs(numoutputs), NumInputs(numinputs), NumClobbers(numclobbers) { }
1410 friend class ASTStmtReader;
1413 /// \brief Build an empty inline-assembly statement.
1414 explicit AsmStmt(StmtClass SC, EmptyShell Empty) :
1415 Stmt(SC, Empty), Exprs(nullptr) { }
1417 SourceLocation getAsmLoc() const { return AsmLoc; }
1418 void setAsmLoc(SourceLocation L) { AsmLoc = L; }
1420 bool isSimple() const { return IsSimple; }
1421 void setSimple(bool V) { IsSimple = V; }
1423 bool isVolatile() const { return IsVolatile; }
1424 void setVolatile(bool V) { IsVolatile = V; }
1426 SourceLocation getLocStart() const LLVM_READONLY { return SourceLocation(); }
1427 SourceLocation getLocEnd() const LLVM_READONLY { return SourceLocation(); }
1429 //===--- Asm String Analysis ---===//
1431 /// Assemble final IR asm string.
1432 std::string generateAsmString(const ASTContext &C) const;
1434 //===--- Output operands ---===//
1436 unsigned getNumOutputs() const { return NumOutputs; }
1438 /// getOutputConstraint - Return the constraint string for the specified
1439 /// output operand. All output constraints are known to be non-empty (either
1441 StringRef getOutputConstraint(unsigned i) const;
1443 /// isOutputPlusConstraint - Return true if the specified output constraint
1444 /// is a "+" constraint (which is both an input and an output) or false if it
1445 /// is an "=" constraint (just an output).
1446 bool isOutputPlusConstraint(unsigned i) const {
1447 return getOutputConstraint(i)[0] == '+';
1450 const Expr *getOutputExpr(unsigned i) const;
1452 /// getNumPlusOperands - Return the number of output operands that have a "+"
1454 unsigned getNumPlusOperands() const;
1456 //===--- Input operands ---===//
1458 unsigned getNumInputs() const { return NumInputs; }
1460 /// getInputConstraint - Return the specified input constraint. Unlike output
1461 /// constraints, these can be empty.
1462 StringRef getInputConstraint(unsigned i) const;
1464 const Expr *getInputExpr(unsigned i) const;
1466 //===--- Other ---===//
1468 unsigned getNumClobbers() const { return NumClobbers; }
1469 StringRef getClobber(unsigned i) const;
1471 static bool classof(const Stmt *T) {
1472 return T->getStmtClass() == GCCAsmStmtClass ||
1473 T->getStmtClass() == MSAsmStmtClass;
1476 // Input expr iterators.
1478 typedef ExprIterator inputs_iterator;
1479 typedef ConstExprIterator const_inputs_iterator;
1480 typedef llvm::iterator_range<inputs_iterator> inputs_range;
1481 typedef llvm::iterator_range<const_inputs_iterator> inputs_const_range;
1483 inputs_iterator begin_inputs() {
1484 return &Exprs[0] + NumOutputs;
1487 inputs_iterator end_inputs() {
1488 return &Exprs[0] + NumOutputs + NumInputs;
1491 inputs_range inputs() { return inputs_range(begin_inputs(), end_inputs()); }
1493 const_inputs_iterator begin_inputs() const {
1494 return &Exprs[0] + NumOutputs;
1497 const_inputs_iterator end_inputs() const {
1498 return &Exprs[0] + NumOutputs + NumInputs;
1501 inputs_const_range inputs() const {
1502 return inputs_const_range(begin_inputs(), end_inputs());
1505 // Output expr iterators.
1507 typedef ExprIterator outputs_iterator;
1508 typedef ConstExprIterator const_outputs_iterator;
1509 typedef llvm::iterator_range<outputs_iterator> outputs_range;
1510 typedef llvm::iterator_range<const_outputs_iterator> outputs_const_range;
1512 outputs_iterator begin_outputs() {
1515 outputs_iterator end_outputs() {
1516 return &Exprs[0] + NumOutputs;
1518 outputs_range outputs() {
1519 return outputs_range(begin_outputs(), end_outputs());
1522 const_outputs_iterator begin_outputs() const {
1525 const_outputs_iterator end_outputs() const {
1526 return &Exprs[0] + NumOutputs;
1528 outputs_const_range outputs() const {
1529 return outputs_const_range(begin_outputs(), end_outputs());
1532 child_range children() {
1533 return child_range(&Exprs[0], &Exprs[0] + NumOutputs + NumInputs);
1537 /// This represents a GCC inline-assembly statement extension.
1539 class GCCAsmStmt : public AsmStmt {
1540 SourceLocation RParenLoc;
1541 StringLiteral *AsmStr;
1543 // FIXME: If we wanted to, we could allocate all of these in one big array.
1544 StringLiteral **Constraints;
1545 StringLiteral **Clobbers;
1546 IdentifierInfo **Names;
1548 friend class ASTStmtReader;
1551 GCCAsmStmt(const ASTContext &C, SourceLocation asmloc, bool issimple,
1552 bool isvolatile, unsigned numoutputs, unsigned numinputs,
1553 IdentifierInfo **names, StringLiteral **constraints, Expr **exprs,
1554 StringLiteral *asmstr, unsigned numclobbers,
1555 StringLiteral **clobbers, SourceLocation rparenloc);
1557 /// \brief Build an empty inline-assembly statement.
1558 explicit GCCAsmStmt(EmptyShell Empty) : AsmStmt(GCCAsmStmtClass, Empty),
1559 Constraints(nullptr), Clobbers(nullptr), Names(nullptr) { }
1561 SourceLocation getRParenLoc() const { return RParenLoc; }
1562 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
1564 //===--- Asm String Analysis ---===//
1566 const StringLiteral *getAsmString() const { return AsmStr; }
1567 StringLiteral *getAsmString() { return AsmStr; }
1568 void setAsmString(StringLiteral *E) { AsmStr = E; }
1570 /// AsmStringPiece - this is part of a decomposed asm string specification
1571 /// (for use with the AnalyzeAsmString function below). An asm string is
1572 /// considered to be a concatenation of these parts.
1573 class AsmStringPiece {
1576 String, // String in .ll asm string form, "$" -> "$$" and "%%" -> "%".
1577 Operand // Operand reference, with optional modifier %c4.
1584 AsmStringPiece(const std::string &S) : MyKind(String), Str(S) {}
1585 AsmStringPiece(unsigned OpNo, char Modifier)
1586 : MyKind(Operand), Str(), OperandNo(OpNo) {
1590 bool isString() const { return MyKind == String; }
1591 bool isOperand() const { return MyKind == Operand; }
1593 const std::string &getString() const {
1598 unsigned getOperandNo() const {
1599 assert(isOperand());
1603 /// getModifier - Get the modifier for this operand, if present. This
1604 /// returns '\0' if there was no modifier.
1605 char getModifier() const {
1606 assert(isOperand());
1611 /// AnalyzeAsmString - Analyze the asm string of the current asm, decomposing
1612 /// it into pieces. If the asm string is erroneous, emit errors and return
1613 /// true, otherwise return false. This handles canonicalization and
1614 /// translation of strings from GCC syntax to LLVM IR syntax, and handles
1615 //// flattening of named references like %[foo] to Operand AsmStringPiece's.
1616 unsigned AnalyzeAsmString(SmallVectorImpl<AsmStringPiece> &Pieces,
1617 const ASTContext &C, unsigned &DiagOffs) const;
1619 /// Assemble final IR asm string.
1620 std::string generateAsmString(const ASTContext &C) const;
1622 //===--- Output operands ---===//
1624 IdentifierInfo *getOutputIdentifier(unsigned i) const {
1628 StringRef getOutputName(unsigned i) const {
1629 if (IdentifierInfo *II = getOutputIdentifier(i))
1630 return II->getName();
1635 StringRef getOutputConstraint(unsigned i) const;
1637 const StringLiteral *getOutputConstraintLiteral(unsigned i) const {
1638 return Constraints[i];
1640 StringLiteral *getOutputConstraintLiteral(unsigned i) {
1641 return Constraints[i];
1644 Expr *getOutputExpr(unsigned i);
1646 const Expr *getOutputExpr(unsigned i) const {
1647 return const_cast<GCCAsmStmt*>(this)->getOutputExpr(i);
1650 //===--- Input operands ---===//
1652 IdentifierInfo *getInputIdentifier(unsigned i) const {
1653 return Names[i + NumOutputs];
1656 StringRef getInputName(unsigned i) const {
1657 if (IdentifierInfo *II = getInputIdentifier(i))
1658 return II->getName();
1663 StringRef getInputConstraint(unsigned i) const;
1665 const StringLiteral *getInputConstraintLiteral(unsigned i) const {
1666 return Constraints[i + NumOutputs];
1668 StringLiteral *getInputConstraintLiteral(unsigned i) {
1669 return Constraints[i + NumOutputs];
1672 Expr *getInputExpr(unsigned i);
1673 void setInputExpr(unsigned i, Expr *E);
1675 const Expr *getInputExpr(unsigned i) const {
1676 return const_cast<GCCAsmStmt*>(this)->getInputExpr(i);
1680 void setOutputsAndInputsAndClobbers(const ASTContext &C,
1681 IdentifierInfo **Names,
1682 StringLiteral **Constraints,
1684 unsigned NumOutputs,
1686 StringLiteral **Clobbers,
1687 unsigned NumClobbers);
1690 //===--- Other ---===//
1692 /// getNamedOperand - Given a symbolic operand reference like %[foo],
1693 /// translate this into a numeric value needed to reference the same operand.
1694 /// This returns -1 if the operand name is invalid.
1695 int getNamedOperand(StringRef SymbolicName) const;
1697 StringRef getClobber(unsigned i) const;
1698 StringLiteral *getClobberStringLiteral(unsigned i) { return Clobbers[i]; }
1699 const StringLiteral *getClobberStringLiteral(unsigned i) const {
1703 SourceLocation getLocStart() const LLVM_READONLY { return AsmLoc; }
1704 SourceLocation getLocEnd() const LLVM_READONLY { return RParenLoc; }
1706 static bool classof(const Stmt *T) {
1707 return T->getStmtClass() == GCCAsmStmtClass;
1711 /// This represents a Microsoft inline-assembly statement extension.
1713 class MSAsmStmt : public AsmStmt {
1714 SourceLocation LBraceLoc, EndLoc;
1717 unsigned NumAsmToks;
1720 StringRef *Constraints;
1721 StringRef *Clobbers;
1723 friend class ASTStmtReader;
1726 MSAsmStmt(const ASTContext &C, SourceLocation asmloc,
1727 SourceLocation lbraceloc, bool issimple, bool isvolatile,
1728 ArrayRef<Token> asmtoks, unsigned numoutputs, unsigned numinputs,
1729 ArrayRef<StringRef> constraints,
1730 ArrayRef<Expr*> exprs, StringRef asmstr,
1731 ArrayRef<StringRef> clobbers, SourceLocation endloc);
1733 /// \brief Build an empty MS-style inline-assembly statement.
1734 explicit MSAsmStmt(EmptyShell Empty) : AsmStmt(MSAsmStmtClass, Empty),
1735 NumAsmToks(0), AsmToks(nullptr), Constraints(nullptr), Clobbers(nullptr) { }
1737 SourceLocation getLBraceLoc() const { return LBraceLoc; }
1738 void setLBraceLoc(SourceLocation L) { LBraceLoc = L; }
1739 SourceLocation getEndLoc() const { return EndLoc; }
1740 void setEndLoc(SourceLocation L) { EndLoc = L; }
1742 bool hasBraces() const { return LBraceLoc.isValid(); }
1744 unsigned getNumAsmToks() { return NumAsmToks; }
1745 Token *getAsmToks() { return AsmToks; }
1747 //===--- Asm String Analysis ---===//
1748 StringRef getAsmString() const { return AsmStr; }
1750 /// Assemble final IR asm string.
1751 std::string generateAsmString(const ASTContext &C) const;
1753 //===--- Output operands ---===//
1755 StringRef getOutputConstraint(unsigned i) const {
1756 assert(i < NumOutputs);
1757 return Constraints[i];
1760 Expr *getOutputExpr(unsigned i);
1762 const Expr *getOutputExpr(unsigned i) const {
1763 return const_cast<MSAsmStmt*>(this)->getOutputExpr(i);
1766 //===--- Input operands ---===//
1768 StringRef getInputConstraint(unsigned i) const {
1769 assert(i < NumInputs);
1770 return Constraints[i + NumOutputs];
1773 Expr *getInputExpr(unsigned i);
1774 void setInputExpr(unsigned i, Expr *E);
1776 const Expr *getInputExpr(unsigned i) const {
1777 return const_cast<MSAsmStmt*>(this)->getInputExpr(i);
1780 //===--- Other ---===//
1782 ArrayRef<StringRef> getAllConstraints() const {
1783 return ArrayRef<StringRef>(Constraints, NumInputs + NumOutputs);
1785 ArrayRef<StringRef> getClobbers() const {
1786 return ArrayRef<StringRef>(Clobbers, NumClobbers);
1788 ArrayRef<Expr*> getAllExprs() const {
1789 return ArrayRef<Expr*>(reinterpret_cast<Expr**>(Exprs),
1790 NumInputs + NumOutputs);
1793 StringRef getClobber(unsigned i) const { return getClobbers()[i]; }
1796 void initialize(const ASTContext &C, StringRef AsmString,
1797 ArrayRef<Token> AsmToks, ArrayRef<StringRef> Constraints,
1798 ArrayRef<Expr*> Exprs, ArrayRef<StringRef> Clobbers);
1801 SourceLocation getLocStart() const LLVM_READONLY { return AsmLoc; }
1802 SourceLocation getLocEnd() const LLVM_READONLY { return EndLoc; }
1804 static bool classof(const Stmt *T) {
1805 return T->getStmtClass() == MSAsmStmtClass;
1808 child_range children() {
1809 return child_range(&Exprs[0], &Exprs[NumInputs + NumOutputs]);
1813 class SEHExceptStmt : public Stmt {
1817 enum { FILTER_EXPR, BLOCK };
1819 SEHExceptStmt(SourceLocation Loc,
1823 friend class ASTReader;
1824 friend class ASTStmtReader;
1825 explicit SEHExceptStmt(EmptyShell E) : Stmt(SEHExceptStmtClass, E) { }
1828 static SEHExceptStmt* Create(const ASTContext &C,
1829 SourceLocation ExceptLoc,
1833 SourceLocation getLocStart() const LLVM_READONLY { return getExceptLoc(); }
1834 SourceLocation getLocEnd() const LLVM_READONLY { return getEndLoc(); }
1836 SourceLocation getExceptLoc() const { return Loc; }
1837 SourceLocation getEndLoc() const { return getBlock()->getLocEnd(); }
1839 Expr *getFilterExpr() const {
1840 return reinterpret_cast<Expr*>(Children[FILTER_EXPR]);
1843 CompoundStmt *getBlock() const {
1844 return cast<CompoundStmt>(Children[BLOCK]);
1847 child_range children() {
1848 return child_range(Children,Children+2);
1851 static bool classof(const Stmt *T) {
1852 return T->getStmtClass() == SEHExceptStmtClass;
1857 class SEHFinallyStmt : public Stmt {
1861 SEHFinallyStmt(SourceLocation Loc,
1864 friend class ASTReader;
1865 friend class ASTStmtReader;
1866 explicit SEHFinallyStmt(EmptyShell E) : Stmt(SEHFinallyStmtClass, E) { }
1869 static SEHFinallyStmt* Create(const ASTContext &C,
1870 SourceLocation FinallyLoc,
1873 SourceLocation getLocStart() const LLVM_READONLY { return getFinallyLoc(); }
1874 SourceLocation getLocEnd() const LLVM_READONLY { return getEndLoc(); }
1876 SourceLocation getFinallyLoc() const { return Loc; }
1877 SourceLocation getEndLoc() const { return Block->getLocEnd(); }
1879 CompoundStmt *getBlock() const { return cast<CompoundStmt>(Block); }
1881 child_range children() {
1882 return child_range(&Block,&Block+1);
1885 static bool classof(const Stmt *T) {
1886 return T->getStmtClass() == SEHFinallyStmtClass;
1891 class SEHTryStmt : public Stmt {
1893 SourceLocation TryLoc;
1896 int HandlerParentIndex;
1898 enum { TRY = 0, HANDLER = 1 };
1900 SEHTryStmt(bool isCXXTry, // true if 'try' otherwise '__try'
1901 SourceLocation TryLoc, Stmt *TryBlock, Stmt *Handler,
1902 int HandlerIndex, int HandlerParentIndex);
1904 friend class ASTReader;
1905 friend class ASTStmtReader;
1906 explicit SEHTryStmt(EmptyShell E) : Stmt(SEHTryStmtClass, E) { }
1909 static SEHTryStmt *Create(const ASTContext &C, bool isCXXTry,
1910 SourceLocation TryLoc, Stmt *TryBlock,
1911 Stmt *Handler, int HandlerIndex,
1912 int HandlerParentIndex);
1914 SourceLocation getLocStart() const LLVM_READONLY { return getTryLoc(); }
1915 SourceLocation getLocEnd() const LLVM_READONLY { return getEndLoc(); }
1917 SourceLocation getTryLoc() const { return TryLoc; }
1918 SourceLocation getEndLoc() const { return Children[HANDLER]->getLocEnd(); }
1920 bool getIsCXXTry() const { return IsCXXTry; }
1922 CompoundStmt* getTryBlock() const {
1923 return cast<CompoundStmt>(Children[TRY]);
1926 Stmt *getHandler() const { return Children[HANDLER]; }
1928 /// Returns 0 if not defined
1929 SEHExceptStmt *getExceptHandler() const;
1930 SEHFinallyStmt *getFinallyHandler() const;
1932 child_range children() {
1933 return child_range(Children,Children+2);
1936 static bool classof(const Stmt *T) {
1937 return T->getStmtClass() == SEHTryStmtClass;
1940 int getHandlerIndex() const { return HandlerIndex; }
1941 int getHandlerParentIndex() const { return HandlerParentIndex; }
1944 /// Represents a __leave statement.
1946 class SEHLeaveStmt : public Stmt {
1947 SourceLocation LeaveLoc;
1949 explicit SEHLeaveStmt(SourceLocation LL)
1950 : Stmt(SEHLeaveStmtClass), LeaveLoc(LL) {}
1952 /// \brief Build an empty __leave statement.
1953 explicit SEHLeaveStmt(EmptyShell Empty) : Stmt(SEHLeaveStmtClass, Empty) { }
1955 SourceLocation getLeaveLoc() const { return LeaveLoc; }
1956 void setLeaveLoc(SourceLocation L) { LeaveLoc = L; }
1958 SourceLocation getLocStart() const LLVM_READONLY { return LeaveLoc; }
1959 SourceLocation getLocEnd() const LLVM_READONLY { return LeaveLoc; }
1961 static bool classof(const Stmt *T) {
1962 return T->getStmtClass() == SEHLeaveStmtClass;
1966 child_range children() { return child_range(); }
1969 /// \brief This captures a statement into a function. For example, the following
1970 /// pragma annotated compound statement can be represented as a CapturedStmt,
1971 /// and this compound statement is the body of an anonymous outlined function.
1973 /// #pragma omp parallel
1978 class CapturedStmt : public Stmt {
1980 /// \brief The different capture forms: by 'this' or by reference, etc.
1981 enum VariableCaptureKind {
1986 /// \brief Describes the capture of either a variable or 'this'.
1988 llvm::PointerIntPair<VarDecl *, 1, VariableCaptureKind> VarAndKind;
1992 /// \brief Create a new capture.
1994 /// \param Loc The source location associated with this capture.
1996 /// \param Kind The kind of capture (this, ByRef, ...).
1998 /// \param Var The variable being captured, or null if capturing this.
2000 Capture(SourceLocation Loc, VariableCaptureKind Kind,
2001 VarDecl *Var = nullptr)
2002 : VarAndKind(Var, Kind), Loc(Loc) {
2005 assert(!Var && "'this' capture cannot have a variable!");
2008 assert(Var && "capturing by reference must have a variable!");
2013 /// \brief Determine the kind of capture.
2014 VariableCaptureKind getCaptureKind() const { return VarAndKind.getInt(); }
2016 /// \brief Retrieve the source location at which the variable or 'this' was
2018 SourceLocation getLocation() const { return Loc; }
2020 /// \brief Determine whether this capture handles the C++ 'this' pointer.
2021 bool capturesThis() const { return getCaptureKind() == VCK_This; }
2023 /// \brief Determine whether this capture handles a variable.
2024 bool capturesVariable() const { return getCaptureKind() != VCK_This; }
2026 /// \brief Retrieve the declaration of the variable being captured.
2028 /// This operation is only valid if this capture does not capture 'this'.
2029 VarDecl *getCapturedVar() const {
2030 assert(!capturesThis() && "No variable available for 'this' capture");
2031 return VarAndKind.getPointer();
2033 friend class ASTStmtReader;
2037 /// \brief The number of variable captured, including 'this'.
2038 unsigned NumCaptures;
2040 /// \brief The pointer part is the implicit the outlined function and the
2041 /// int part is the captured region kind, 'CR_Default' etc.
2042 llvm::PointerIntPair<CapturedDecl *, 1, CapturedRegionKind> CapDeclAndKind;
2044 /// \brief The record for captured variables, a RecordDecl or CXXRecordDecl.
2045 RecordDecl *TheRecordDecl;
2047 /// \brief Construct a captured statement.
2048 CapturedStmt(Stmt *S, CapturedRegionKind Kind, ArrayRef<Capture> Captures,
2049 ArrayRef<Expr *> CaptureInits, CapturedDecl *CD, RecordDecl *RD);
2051 /// \brief Construct an empty captured statement.
2052 CapturedStmt(EmptyShell Empty, unsigned NumCaptures);
2054 Stmt **getStoredStmts() const {
2055 return reinterpret_cast<Stmt **>(const_cast<CapturedStmt *>(this) + 1);
2058 Capture *getStoredCaptures() const;
2060 void setCapturedStmt(Stmt *S) { getStoredStmts()[NumCaptures] = S; }
2063 static CapturedStmt *Create(const ASTContext &Context, Stmt *S,
2064 CapturedRegionKind Kind,
2065 ArrayRef<Capture> Captures,
2066 ArrayRef<Expr *> CaptureInits,
2067 CapturedDecl *CD, RecordDecl *RD);
2069 static CapturedStmt *CreateDeserialized(const ASTContext &Context,
2070 unsigned NumCaptures);
2072 /// \brief Retrieve the statement being captured.
2073 Stmt *getCapturedStmt() { return getStoredStmts()[NumCaptures]; }
2074 const Stmt *getCapturedStmt() const {
2075 return const_cast<CapturedStmt *>(this)->getCapturedStmt();
2078 /// \brief Retrieve the outlined function declaration.
2079 CapturedDecl *getCapturedDecl() { return CapDeclAndKind.getPointer(); }
2080 const CapturedDecl *getCapturedDecl() const {
2081 return const_cast<CapturedStmt *>(this)->getCapturedDecl();
2084 /// \brief Set the outlined function declaration.
2085 void setCapturedDecl(CapturedDecl *D) {
2086 assert(D && "null CapturedDecl");
2087 CapDeclAndKind.setPointer(D);
2090 /// \brief Retrieve the captured region kind.
2091 CapturedRegionKind getCapturedRegionKind() const {
2092 return CapDeclAndKind.getInt();
2095 /// \brief Set the captured region kind.
2096 void setCapturedRegionKind(CapturedRegionKind Kind) {
2097 CapDeclAndKind.setInt(Kind);
2100 /// \brief Retrieve the record declaration for captured variables.
2101 const RecordDecl *getCapturedRecordDecl() const { return TheRecordDecl; }
2103 /// \brief Set the record declaration for captured variables.
2104 void setCapturedRecordDecl(RecordDecl *D) {
2105 assert(D && "null RecordDecl");
2109 /// \brief True if this variable has been captured.
2110 bool capturesVariable(const VarDecl *Var) const;
2112 /// \brief An iterator that walks over the captures.
2113 typedef Capture *capture_iterator;
2114 typedef const Capture *const_capture_iterator;
2115 typedef llvm::iterator_range<capture_iterator> capture_range;
2116 typedef llvm::iterator_range<const_capture_iterator> capture_const_range;
2118 capture_range captures() {
2119 return capture_range(capture_begin(), capture_end());
2121 capture_const_range captures() const {
2122 return capture_const_range(capture_begin(), capture_end());
2125 /// \brief Retrieve an iterator pointing to the first capture.
2126 capture_iterator capture_begin() { return getStoredCaptures(); }
2127 const_capture_iterator capture_begin() const { return getStoredCaptures(); }
2129 /// \brief Retrieve an iterator pointing past the end of the sequence of
2131 capture_iterator capture_end() const {
2132 return getStoredCaptures() + NumCaptures;
2135 /// \brief Retrieve the number of captures, including 'this'.
2136 unsigned capture_size() const { return NumCaptures; }
2138 /// \brief Iterator that walks over the capture initialization arguments.
2139 typedef Expr **capture_init_iterator;
2140 typedef llvm::iterator_range<capture_init_iterator> capture_init_range;
2142 capture_init_range capture_inits() const {
2143 return capture_init_range(capture_init_begin(), capture_init_end());
2146 /// \brief Retrieve the first initialization argument.
2147 capture_init_iterator capture_init_begin() const {
2148 return reinterpret_cast<Expr **>(getStoredStmts());
2151 /// \brief Retrieve the iterator pointing one past the last initialization
2153 capture_init_iterator capture_init_end() const {
2154 return capture_init_begin() + NumCaptures;
2157 SourceLocation getLocStart() const LLVM_READONLY {
2158 return getCapturedStmt()->getLocStart();
2160 SourceLocation getLocEnd() const LLVM_READONLY {
2161 return getCapturedStmt()->getLocEnd();
2163 SourceRange getSourceRange() const LLVM_READONLY {
2164 return getCapturedStmt()->getSourceRange();
2167 static bool classof(const Stmt *T) {
2168 return T->getStmtClass() == CapturedStmtClass;
2171 child_range children();
2173 friend class ASTStmtReader;
2176 } // end namespace clang