1 //===--- Stmt.h - Classes for representing statements -----------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the Stmt interface and subclasses.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_CLANG_AST_STMT_H
15 #define LLVM_CLANG_AST_STMT_H
16
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"
27 #include <string>
28
29 namespace llvm {
30 class FoldingSetNodeID;
31 }
32
33 namespace clang {
34 class ASTContext;
35 class Attr;
36 class CapturedDecl;
37 class Decl;
38 class Expr;
39 class IdentifierInfo;
40 class LabelDecl;
41 class ParmVarDecl;
42 class PrinterHelper;
43 struct PrintingPolicy;
44 class QualType;
45 class RecordDecl;
46 class SourceManager;
47 class StringLiteral;
48 class SwitchStmt;
49 class Token;
50 class VarDecl;
51
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 //===--------------------------------------------------------------------===//
57
58 class Stmt;
59 class Expr;
60
61 class ExprIterator {
62 Stmt** I;
63 public:
ExprIterator(Stmt ** i)64 ExprIterator(Stmt** i) : I(i) {}
ExprIterator()65 ExprIterator() : I(0) {}
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; }
78 };
79
80 class ConstExprIterator {
81 const Stmt * const *I;
82 public:
ConstExprIterator(const Stmt * const * i)83 ConstExprIterator(const Stmt * const *i) : I(i) {}
ConstExprIterator()84 ConstExprIterator() : I(0) {}
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; }
96 };
97
98 //===----------------------------------------------------------------------===//
99 // AST classes for statements.
100 //===----------------------------------------------------------------------===//
101
102 /// Stmt - This represents one statement.
103 ///
104 class Stmt {
105 public:
106 enum StmtClass {
107 NoStmtClass = 0,
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"
115 };
116
117 // Make vanilla 'new' and 'delete' illegal for Stmts.
118 protected:
new(size_t bytes)119 void* operator new(size_t bytes) throw() {
120 llvm_unreachable("Stmts cannot be allocated with regular 'new'.");
121 }
delete(void * data)122 void operator delete(void* data) throw() {
123 llvm_unreachable("Stmts cannot be released with regular 'delete'.");
124 }
125
126 class StmtBitfields {
127 friend class Stmt;
128
129 /// \brief The statement class.
130 unsigned sClass : 8;
131 };
132 enum { NumStmtBits = 8 };
133
134 class CompoundStmtBitfields {
135 friend class CompoundStmt;
136 unsigned : NumStmtBits;
137
138 unsigned NumStmts : 32 - NumStmtBits;
139 };
140
141 class ExprBitfields {
142 friend class Expr;
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;
164
165 unsigned ValueKind : 2;
166 unsigned ObjectKind : 2;
167 unsigned TypeDependent : 1;
168 unsigned ValueDependent : 1;
169 unsigned InstantiationDependent : 1;
170 unsigned ContainsUnexpandedParameterPack : 1;
171 };
172 enum { NumExprBits = 16 };
173
174 class CharacterLiteralBitfields {
175 friend class CharacterLiteral;
176 unsigned : NumExprBits;
177
178 unsigned Kind : 2;
179 };
180
181 enum APFloatSemantics {
182 IEEEhalf,
183 IEEEsingle,
184 IEEEdouble,
185 x87DoubleExtended,
186 IEEEquad,
187 PPCDoubleDouble
188 };
189
190 class FloatingLiteralBitfields {
191 friend class FloatingLiteral;
192 unsigned : NumExprBits;
193
194 unsigned Semantics : 3; // Provides semantics for APFloat construction
195 unsigned IsExact : 1;
196 };
197
198 class UnaryExprOrTypeTraitExprBitfields {
199 friend class UnaryExprOrTypeTraitExpr;
200 unsigned : NumExprBits;
201
202 unsigned Kind : 2;
203 unsigned IsType : 1; // true if operand is a type, false if an expression.
204 };
205
206 class DeclRefExprBitfields {
207 friend class DeclRefExpr;
208 friend class ASTStmtReader; // deserialization
209 unsigned : NumExprBits;
210
211 unsigned HasQualifier : 1;
212 unsigned HasTemplateKWAndArgsInfo : 1;
213 unsigned HasFoundDecl : 1;
214 unsigned HadMultipleCandidates : 1;
215 unsigned RefersToEnclosingLocal : 1;
216 };
217
218 class CastExprBitfields {
219 friend class CastExpr;
220 unsigned : NumExprBits;
221
222 unsigned Kind : 6;
223 unsigned BasePathSize : 32 - 6 - NumExprBits;
224 };
225
226 class CallExprBitfields {
227 friend class CallExpr;
228 unsigned : NumExprBits;
229
230 unsigned NumPreArgs : 1;
231 };
232
233 class ExprWithCleanupsBitfields {
234 friend class ExprWithCleanups;
235 friend class ASTStmtReader; // deserialization
236
237 unsigned : NumExprBits;
238
239 unsigned NumObjects : 32 - NumExprBits;
240 };
241
242 class PseudoObjectExprBitfields {
243 friend class PseudoObjectExpr;
244 friend class ASTStmtReader; // deserialization
245
246 unsigned : NumExprBits;
247
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;
252 };
253
254 class ObjCIndirectCopyRestoreExprBitfields {
255 friend class ObjCIndirectCopyRestoreExpr;
256 unsigned : NumExprBits;
257
258 unsigned ShouldCopy : 1;
259 };
260
261 class InitListExprBitfields {
262 friend class InitListExpr;
263
264 unsigned : NumExprBits;
265
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;
269 };
270
271 class TypeTraitExprBitfields {
272 friend class TypeTraitExpr;
273 friend class ASTStmtReader;
274 friend class ASTStmtWriter;
275
276 unsigned : NumExprBits;
277
278 /// \brief The kind of type trait, which is a value of a TypeTrait enumerator.
279 unsigned Kind : 8;
280
281 /// \brief If this expression is not value-dependent, this indicates whether
282 /// the trait evaluated true or false.
283 unsigned Value : 1;
284
285 /// \brief The number of arguments to this type trait.
286 unsigned NumArgs : 32 - 8 - 1 - NumExprBits;
287 };
288
289 union {
290 // FIXME: this is wasteful on 64-bit platforms.
291 void *Aligner;
292
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;
307 };
308
309 friend class ASTStmtReader;
310 friend class ASTStmtWriter;
311
312 public:
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);
317
318 void* operator new(size_t bytes, const ASTContext* C,
319 unsigned alignment = 8) {
320 return operator new(bytes, *C, alignment);
321 }
322
new(size_t bytes,void * mem)323 void* operator new(size_t bytes, void* mem) throw() {
324 return mem;
325 }
326
delete(void *,const ASTContext &,unsigned)327 void operator delete(void*, const ASTContext&, unsigned) throw() { }
delete(void *,const ASTContext *,unsigned)328 void operator delete(void*, const ASTContext*, unsigned) throw() { }
delete(void *,size_t)329 void operator delete(void*, size_t) throw() { }
delete(void *,void *)330 void operator delete(void*, void*) throw() { }
331
332 public:
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 { };
337
338 private:
339 /// \brief Whether statistic collection is enabled.
340 static bool StatisticsEnabled;
341
342 protected:
343 /// \brief Construct an empty statement.
Stmt(StmtClass SC,EmptyShell)344 explicit Stmt(StmtClass SC, EmptyShell) {
345 StmtBits.sClass = SC;
346 if (StatisticsEnabled) Stmt::addStmtClass(SC);
347 }
348
349 public:
Stmt(StmtClass SC)350 Stmt(StmtClass SC) {
351 StmtBits.sClass = SC;
352 if (StatisticsEnabled) Stmt::addStmtClass(SC);
353 }
354
getStmtClass()355 StmtClass getStmtClass() const {
356 return static_cast<StmtClass>(StmtBits.sClass);
357 }
358 const char *getStmtClassName() const;
359
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;
366
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();
371
372 /// \brief Dumps the specified AST fragment and all subtrees to
373 /// \c llvm::errs().
374 LLVM_ATTRIBUTE_USED void dump() const;
375 LLVM_ATTRIBUTE_USED void dump(SourceManager &SM) const;
376 void dump(raw_ostream &OS, SourceManager &SM) const;
377
378 /// dumpColor - same as dump(), but forces color highlighting.
379 LLVM_ATTRIBUTE_USED void dumpColor() const;
380
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;
387
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;
391
392 /// Skip past any implicit AST nodes which might surround this
393 /// statement, such as ExprWithCleanups or ImplicitCastExpr nodes.
394 Stmt *IgnoreImplicit();
395
396 const Stmt *stripLabelLikeStatements() const;
stripLabelLikeStatements()397 Stmt *stripLabelLikeStatements() {
398 return const_cast<Stmt*>(
399 const_cast<const Stmt*>(this)->stripLabelLikeStatements());
400 }
401
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;
407
408 typedef StmtRange child_range;
409 typedef ConstStmtRange const_child_range;
410
411 child_range children();
children()412 const_child_range children() const {
413 return const_cast<Stmt*>(this)->children();
414 }
415
child_begin()416 child_iterator child_begin() { return children().first; }
child_end()417 child_iterator child_end() { return children().second; }
418
child_begin()419 const_child_iterator child_begin() const { return children().first; }
child_end()420 const_child_iterator child_end() const { return children().second; }
421
422 /// \brief Produce a unique representation of the given statement.
423 ///
424 /// \param ID once the profiling operation is complete, will contain
425 /// the unique representation of the given statement.
426 ///
427 /// \param Context the AST context in which the statement resides
428 ///
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;
436 };
437
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.
442 ///
443 class DeclStmt : public Stmt {
444 DeclGroupRef DG;
445 SourceLocation StartLoc, EndLoc;
446
447 public:
DeclStmt(DeclGroupRef dg,SourceLocation startLoc,SourceLocation endLoc)448 DeclStmt(DeclGroupRef dg, SourceLocation startLoc,
449 SourceLocation endLoc) : Stmt(DeclStmtClass), DG(dg),
450 StartLoc(startLoc), EndLoc(endLoc) {}
451
452 /// \brief Build an empty declaration statement.
DeclStmt(EmptyShell Empty)453 explicit DeclStmt(EmptyShell Empty) : Stmt(DeclStmtClass, Empty) { }
454
455 /// isSingleDecl - This method returns true if this DeclStmt refers
456 /// to a single Decl.
isSingleDecl()457 bool isSingleDecl() const {
458 return DG.isSingleDecl();
459 }
460
getSingleDecl()461 const Decl *getSingleDecl() const { return DG.getSingleDecl(); }
getSingleDecl()462 Decl *getSingleDecl() { return DG.getSingleDecl(); }
463
getDeclGroup()464 const DeclGroupRef getDeclGroup() const { return DG; }
getDeclGroup()465 DeclGroupRef getDeclGroup() { return DG; }
setDeclGroup(DeclGroupRef DGR)466 void setDeclGroup(DeclGroupRef DGR) { DG = DGR; }
467
getStartLoc()468 SourceLocation getStartLoc() const { return StartLoc; }
setStartLoc(SourceLocation L)469 void setStartLoc(SourceLocation L) { StartLoc = L; }
getEndLoc()470 SourceLocation getEndLoc() const { return EndLoc; }
setEndLoc(SourceLocation L)471 void setEndLoc(SourceLocation L) { EndLoc = L; }
472
getLocStart()473 SourceLocation getLocStart() const LLVM_READONLY { return StartLoc; }
getLocEnd()474 SourceLocation getLocEnd() const LLVM_READONLY { return EndLoc; }
475
classof(const Stmt * T)476 static bool classof(const Stmt *T) {
477 return T->getStmtClass() == DeclStmtClass;
478 }
479
480 // Iterators over subexpressions.
children()481 child_range children() {
482 return child_range(child_iterator(DG.begin(), DG.end()),
483 child_iterator(DG.end(), DG.end()));
484 }
485
486 typedef DeclGroupRef::iterator decl_iterator;
487 typedef DeclGroupRef::const_iterator const_decl_iterator;
488
decl_begin()489 decl_iterator decl_begin() { return DG.begin(); }
decl_end()490 decl_iterator decl_end() { return DG.end(); }
decl_begin()491 const_decl_iterator decl_begin() const { return DG.begin(); }
decl_end()492 const_decl_iterator decl_end() const { return DG.end(); }
493
494 typedef std::reverse_iterator<decl_iterator> reverse_decl_iterator;
decl_rbegin()495 reverse_decl_iterator decl_rbegin() {
496 return reverse_decl_iterator(decl_end());
497 }
decl_rend()498 reverse_decl_iterator decl_rend() {
499 return reverse_decl_iterator(decl_begin());
500 }
501 };
502
503 /// NullStmt - This is the null statement ";": C99 6.8.3p3.
504 ///
505 class NullStmt : public Stmt {
506 SourceLocation SemiLoc;
507
508 /// \brief True if the null statement was preceded by an empty macro, e.g:
509 /// @code
510 /// #define CALL(x)
511 /// CALL(0);
512 /// @endcode
513 bool HasLeadingEmptyMacro;
514 public:
515 NullStmt(SourceLocation L, bool hasLeadingEmptyMacro = false)
Stmt(NullStmtClass)516 : Stmt(NullStmtClass), SemiLoc(L),
517 HasLeadingEmptyMacro(hasLeadingEmptyMacro) {}
518
519 /// \brief Build an empty null statement.
NullStmt(EmptyShell Empty)520 explicit NullStmt(EmptyShell Empty) : Stmt(NullStmtClass, Empty),
521 HasLeadingEmptyMacro(false) { }
522
getSemiLoc()523 SourceLocation getSemiLoc() const { return SemiLoc; }
setSemiLoc(SourceLocation L)524 void setSemiLoc(SourceLocation L) { SemiLoc = L; }
525
hasLeadingEmptyMacro()526 bool hasLeadingEmptyMacro() const { return HasLeadingEmptyMacro; }
527
getLocStart()528 SourceLocation getLocStart() const LLVM_READONLY { return SemiLoc; }
getLocEnd()529 SourceLocation getLocEnd() const LLVM_READONLY { return SemiLoc; }
530
classof(const Stmt * T)531 static bool classof(const Stmt *T) {
532 return T->getStmtClass() == NullStmtClass;
533 }
534
children()535 child_range children() { return child_range(); }
536
537 friend class ASTStmtReader;
538 friend class ASTStmtWriter;
539 };
540
541 /// CompoundStmt - This represents a group of statements like { stmt stmt }.
542 ///
543 class CompoundStmt : public Stmt {
544 Stmt** Body;
545 SourceLocation LBracLoc, RBracLoc;
546 public:
547 CompoundStmt(const ASTContext &C, ArrayRef<Stmt*> Stmts,
548 SourceLocation LB, SourceLocation RB);
549
550 // \brief Build an empty compound statement with a location.
CompoundStmt(SourceLocation Loc)551 explicit CompoundStmt(SourceLocation Loc)
552 : Stmt(CompoundStmtClass), Body(0), LBracLoc(Loc), RBracLoc(Loc) {
553 CompoundStmtBits.NumStmts = 0;
554 }
555
556 // \brief Build an empty compound statement.
CompoundStmt(EmptyShell Empty)557 explicit CompoundStmt(EmptyShell Empty)
558 : Stmt(CompoundStmtClass, Empty), Body(0) {
559 CompoundStmtBits.NumStmts = 0;
560 }
561
562 void setStmts(const ASTContext &C, Stmt **Stmts, unsigned NumStmts);
563
body_empty()564 bool body_empty() const { return CompoundStmtBits.NumStmts == 0; }
size()565 unsigned size() const { return CompoundStmtBits.NumStmts; }
566
567 typedef Stmt** body_iterator;
body_begin()568 body_iterator body_begin() { return Body; }
body_end()569 body_iterator body_end() { return Body + size(); }
body_back()570 Stmt *body_back() { return !body_empty() ? Body[size()-1] : 0; }
571
setLastStmt(Stmt * S)572 void setLastStmt(Stmt *S) {
573 assert(!body_empty() && "setLastStmt");
574 Body[size()-1] = S;
575 }
576
577 typedef Stmt* const * const_body_iterator;
body_begin()578 const_body_iterator body_begin() const { return Body; }
body_end()579 const_body_iterator body_end() const { return Body + size(); }
body_back()580 const Stmt *body_back() const { return !body_empty() ? Body[size()-1] : 0; }
581
582 typedef std::reverse_iterator<body_iterator> reverse_body_iterator;
body_rbegin()583 reverse_body_iterator body_rbegin() {
584 return reverse_body_iterator(body_end());
585 }
body_rend()586 reverse_body_iterator body_rend() {
587 return reverse_body_iterator(body_begin());
588 }
589
590 typedef std::reverse_iterator<const_body_iterator>
591 const_reverse_body_iterator;
592
body_rbegin()593 const_reverse_body_iterator body_rbegin() const {
594 return const_reverse_body_iterator(body_end());
595 }
596
body_rend()597 const_reverse_body_iterator body_rend() const {
598 return const_reverse_body_iterator(body_begin());
599 }
600
getLocStart()601 SourceLocation getLocStart() const LLVM_READONLY { return LBracLoc; }
getLocEnd()602 SourceLocation getLocEnd() const LLVM_READONLY { return RBracLoc; }
603
getLBracLoc()604 SourceLocation getLBracLoc() const { return LBracLoc; }
setLBracLoc(SourceLocation L)605 void setLBracLoc(SourceLocation L) { LBracLoc = L; }
getRBracLoc()606 SourceLocation getRBracLoc() const { return RBracLoc; }
setRBracLoc(SourceLocation L)607 void setRBracLoc(SourceLocation L) { RBracLoc = L; }
608
classof(const Stmt * T)609 static bool classof(const Stmt *T) {
610 return T->getStmtClass() == CompoundStmtClass;
611 }
612
613 // Iterators
children()614 child_range children() {
615 return child_range(&Body[0], &Body[0]+CompoundStmtBits.NumStmts);
616 }
617
children()618 const_child_range children() const {
619 return child_range(&Body[0], &Body[0]+CompoundStmtBits.NumStmts);
620 }
621 };
622
623 // SwitchCase is the base class for CaseStmt and DefaultStmt,
624 class SwitchCase : public Stmt {
625 protected:
626 // A pointer to the following CaseStmt or DefaultStmt class,
627 // used by SwitchStmt.
628 SwitchCase *NextSwitchCase;
629 SourceLocation KeywordLoc;
630 SourceLocation ColonLoc;
631
SwitchCase(StmtClass SC,SourceLocation KWLoc,SourceLocation ColonLoc)632 SwitchCase(StmtClass SC, SourceLocation KWLoc, SourceLocation ColonLoc)
633 : Stmt(SC), NextSwitchCase(0), KeywordLoc(KWLoc), ColonLoc(ColonLoc) {}
634
SwitchCase(StmtClass SC,EmptyShell)635 SwitchCase(StmtClass SC, EmptyShell)
636 : Stmt(SC), NextSwitchCase(0) {}
637
638 public:
getNextSwitchCase()639 const SwitchCase *getNextSwitchCase() const { return NextSwitchCase; }
640
getNextSwitchCase()641 SwitchCase *getNextSwitchCase() { return NextSwitchCase; }
642
setNextSwitchCase(SwitchCase * SC)643 void setNextSwitchCase(SwitchCase *SC) { NextSwitchCase = SC; }
644
getKeywordLoc()645 SourceLocation getKeywordLoc() const { return KeywordLoc; }
setKeywordLoc(SourceLocation L)646 void setKeywordLoc(SourceLocation L) { KeywordLoc = L; }
getColonLoc()647 SourceLocation getColonLoc() const { return ColonLoc; }
setColonLoc(SourceLocation L)648 void setColonLoc(SourceLocation L) { ColonLoc = L; }
649
650 Stmt *getSubStmt();
getSubStmt()651 const Stmt *getSubStmt() const {
652 return const_cast<SwitchCase*>(this)->getSubStmt();
653 }
654
getLocStart()655 SourceLocation getLocStart() const LLVM_READONLY { return KeywordLoc; }
656 SourceLocation getLocEnd() const LLVM_READONLY;
657
classof(const Stmt * T)658 static bool classof(const Stmt *T) {
659 return T->getStmtClass() == CaseStmtClass ||
660 T->getStmtClass() == DefaultStmtClass;
661 }
662 };
663
664 class CaseStmt : public SwitchCase {
665 enum { LHS, RHS, SUBSTMT, END_EXPR };
666 Stmt* SubExprs[END_EXPR]; // The expression for the RHS is Non-null for
667 // GNU "case 1 ... 4" extension
668 SourceLocation EllipsisLoc;
669 public:
CaseStmt(Expr * lhs,Expr * rhs,SourceLocation caseLoc,SourceLocation ellipsisLoc,SourceLocation colonLoc)670 CaseStmt(Expr *lhs, Expr *rhs, SourceLocation caseLoc,
671 SourceLocation ellipsisLoc, SourceLocation colonLoc)
672 : SwitchCase(CaseStmtClass, caseLoc, colonLoc) {
673 SubExprs[SUBSTMT] = 0;
674 SubExprs[LHS] = reinterpret_cast<Stmt*>(lhs);
675 SubExprs[RHS] = reinterpret_cast<Stmt*>(rhs);
676 EllipsisLoc = ellipsisLoc;
677 }
678
679 /// \brief Build an empty switch case statement.
CaseStmt(EmptyShell Empty)680 explicit CaseStmt(EmptyShell Empty) : SwitchCase(CaseStmtClass, Empty) { }
681
getCaseLoc()682 SourceLocation getCaseLoc() const { return KeywordLoc; }
setCaseLoc(SourceLocation L)683 void setCaseLoc(SourceLocation L) { KeywordLoc = L; }
getEllipsisLoc()684 SourceLocation getEllipsisLoc() const { return EllipsisLoc; }
setEllipsisLoc(SourceLocation L)685 void setEllipsisLoc(SourceLocation L) { EllipsisLoc = L; }
getColonLoc()686 SourceLocation getColonLoc() const { return ColonLoc; }
setColonLoc(SourceLocation L)687 void setColonLoc(SourceLocation L) { ColonLoc = L; }
688
getLHS()689 Expr *getLHS() { return reinterpret_cast<Expr*>(SubExprs[LHS]); }
getRHS()690 Expr *getRHS() { return reinterpret_cast<Expr*>(SubExprs[RHS]); }
getSubStmt()691 Stmt *getSubStmt() { return SubExprs[SUBSTMT]; }
692
getLHS()693 const Expr *getLHS() const {
694 return reinterpret_cast<const Expr*>(SubExprs[LHS]);
695 }
getRHS()696 const Expr *getRHS() const {
697 return reinterpret_cast<const Expr*>(SubExprs[RHS]);
698 }
getSubStmt()699 const Stmt *getSubStmt() const { return SubExprs[SUBSTMT]; }
700
setSubStmt(Stmt * S)701 void setSubStmt(Stmt *S) { SubExprs[SUBSTMT] = S; }
setLHS(Expr * Val)702 void setLHS(Expr *Val) { SubExprs[LHS] = reinterpret_cast<Stmt*>(Val); }
setRHS(Expr * Val)703 void setRHS(Expr *Val) { SubExprs[RHS] = reinterpret_cast<Stmt*>(Val); }
704
getLocStart()705 SourceLocation getLocStart() const LLVM_READONLY { return KeywordLoc; }
getLocEnd()706 SourceLocation getLocEnd() const LLVM_READONLY {
707 // Handle deeply nested case statements with iteration instead of recursion.
708 const CaseStmt *CS = this;
709 while (const CaseStmt *CS2 = dyn_cast<CaseStmt>(CS->getSubStmt()))
710 CS = CS2;
711
712 return CS->getSubStmt()->getLocEnd();
713 }
714
classof(const Stmt * T)715 static bool classof(const Stmt *T) {
716 return T->getStmtClass() == CaseStmtClass;
717 }
718
719 // Iterators
children()720 child_range children() {
721 return child_range(&SubExprs[0], &SubExprs[END_EXPR]);
722 }
723 };
724
725 class DefaultStmt : public SwitchCase {
726 Stmt* SubStmt;
727 public:
DefaultStmt(SourceLocation DL,SourceLocation CL,Stmt * substmt)728 DefaultStmt(SourceLocation DL, SourceLocation CL, Stmt *substmt) :
729 SwitchCase(DefaultStmtClass, DL, CL), SubStmt(substmt) {}
730
731 /// \brief Build an empty default statement.
DefaultStmt(EmptyShell Empty)732 explicit DefaultStmt(EmptyShell Empty)
733 : SwitchCase(DefaultStmtClass, Empty) { }
734
getSubStmt()735 Stmt *getSubStmt() { return SubStmt; }
getSubStmt()736 const Stmt *getSubStmt() const { return SubStmt; }
setSubStmt(Stmt * S)737 void setSubStmt(Stmt *S) { SubStmt = S; }
738
getDefaultLoc()739 SourceLocation getDefaultLoc() const { return KeywordLoc; }
setDefaultLoc(SourceLocation L)740 void setDefaultLoc(SourceLocation L) { KeywordLoc = L; }
getColonLoc()741 SourceLocation getColonLoc() const { return ColonLoc; }
setColonLoc(SourceLocation L)742 void setColonLoc(SourceLocation L) { ColonLoc = L; }
743
getLocStart()744 SourceLocation getLocStart() const LLVM_READONLY { return KeywordLoc; }
getLocEnd()745 SourceLocation getLocEnd() const LLVM_READONLY { return SubStmt->getLocEnd();}
746
classof(const Stmt * T)747 static bool classof(const Stmt *T) {
748 return T->getStmtClass() == DefaultStmtClass;
749 }
750
751 // Iterators
children()752 child_range children() { return child_range(&SubStmt, &SubStmt+1); }
753 };
754
getLocEnd()755 inline SourceLocation SwitchCase::getLocEnd() const {
756 if (const CaseStmt *CS = dyn_cast<CaseStmt>(this))
757 return CS->getLocEnd();
758 return cast<DefaultStmt>(this)->getLocEnd();
759 }
760
761 /// LabelStmt - Represents a label, which has a substatement. For example:
762 /// foo: return;
763 ///
764 class LabelStmt : public Stmt {
765 LabelDecl *TheDecl;
766 Stmt *SubStmt;
767 SourceLocation IdentLoc;
768 public:
LabelStmt(SourceLocation IL,LabelDecl * D,Stmt * substmt)769 LabelStmt(SourceLocation IL, LabelDecl *D, Stmt *substmt)
770 : Stmt(LabelStmtClass), TheDecl(D), SubStmt(substmt), IdentLoc(IL) {
771 }
772
773 // \brief Build an empty label statement.
LabelStmt(EmptyShell Empty)774 explicit LabelStmt(EmptyShell Empty) : Stmt(LabelStmtClass, Empty) { }
775
getIdentLoc()776 SourceLocation getIdentLoc() const { return IdentLoc; }
getDecl()777 LabelDecl *getDecl() const { return TheDecl; }
setDecl(LabelDecl * D)778 void setDecl(LabelDecl *D) { TheDecl = D; }
779 const char *getName() const;
getSubStmt()780 Stmt *getSubStmt() { return SubStmt; }
getSubStmt()781 const Stmt *getSubStmt() const { return SubStmt; }
setIdentLoc(SourceLocation L)782 void setIdentLoc(SourceLocation L) { IdentLoc = L; }
setSubStmt(Stmt * SS)783 void setSubStmt(Stmt *SS) { SubStmt = SS; }
784
getLocStart()785 SourceLocation getLocStart() const LLVM_READONLY { return IdentLoc; }
getLocEnd()786 SourceLocation getLocEnd() const LLVM_READONLY { return SubStmt->getLocEnd();}
787
children()788 child_range children() { return child_range(&SubStmt, &SubStmt+1); }
789
classof(const Stmt * T)790 static bool classof(const Stmt *T) {
791 return T->getStmtClass() == LabelStmtClass;
792 }
793 };
794
795
796 /// \brief Represents an attribute applied to a statement.
797 ///
798 /// Represents an attribute applied to a statement. For example:
799 /// [[omp::for(...)]] for (...) { ... }
800 ///
801 class AttributedStmt : public Stmt {
802 Stmt *SubStmt;
803 SourceLocation AttrLoc;
804 unsigned NumAttrs;
805 const Attr *Attrs[1];
806
807 friend class ASTStmtReader;
808
AttributedStmt(SourceLocation Loc,ArrayRef<const Attr * > Attrs,Stmt * SubStmt)809 AttributedStmt(SourceLocation Loc, ArrayRef<const Attr*> Attrs, Stmt *SubStmt)
810 : Stmt(AttributedStmtClass), SubStmt(SubStmt), AttrLoc(Loc),
811 NumAttrs(Attrs.size()) {
812 memcpy(this->Attrs, Attrs.data(), Attrs.size() * sizeof(Attr*));
813 }
814
AttributedStmt(EmptyShell Empty,unsigned NumAttrs)815 explicit AttributedStmt(EmptyShell Empty, unsigned NumAttrs)
816 : Stmt(AttributedStmtClass, Empty), NumAttrs(NumAttrs) {
817 memset(Attrs, 0, NumAttrs * sizeof(Attr*));
818 }
819
820 public:
821 static AttributedStmt *Create(const ASTContext &C, SourceLocation Loc,
822 ArrayRef<const Attr*> Attrs, Stmt *SubStmt);
823 // \brief Build an empty attributed statement.
824 static AttributedStmt *CreateEmpty(const ASTContext &C, unsigned NumAttrs);
825
getAttrLoc()826 SourceLocation getAttrLoc() const { return AttrLoc; }
getAttrs()827 ArrayRef<const Attr*> getAttrs() const {
828 return ArrayRef<const Attr*>(Attrs, NumAttrs);
829 }
getSubStmt()830 Stmt *getSubStmt() { return SubStmt; }
getSubStmt()831 const Stmt *getSubStmt() const { return SubStmt; }
832
getLocStart()833 SourceLocation getLocStart() const LLVM_READONLY { return AttrLoc; }
getLocEnd()834 SourceLocation getLocEnd() const LLVM_READONLY { return SubStmt->getLocEnd();}
835
children()836 child_range children() { return child_range(&SubStmt, &SubStmt + 1); }
837
classof(const Stmt * T)838 static bool classof(const Stmt *T) {
839 return T->getStmtClass() == AttributedStmtClass;
840 }
841 };
842
843
844 /// IfStmt - This represents an if/then/else.
845 ///
846 class IfStmt : public Stmt {
847 enum { VAR, COND, THEN, ELSE, END_EXPR };
848 Stmt* SubExprs[END_EXPR];
849
850 SourceLocation IfLoc;
851 SourceLocation ElseLoc;
852
853 public:
854 IfStmt(const ASTContext &C, SourceLocation IL, VarDecl *var, Expr *cond,
855 Stmt *then, SourceLocation EL = SourceLocation(), Stmt *elsev = 0);
856
857 /// \brief Build an empty if/then/else statement
IfStmt(EmptyShell Empty)858 explicit IfStmt(EmptyShell Empty) : Stmt(IfStmtClass, Empty) { }
859
860 /// \brief Retrieve the variable declared in this "if" statement, if any.
861 ///
862 /// In the following example, "x" is the condition variable.
863 /// \code
864 /// if (int x = foo()) {
865 /// printf("x is %d", x);
866 /// }
867 /// \endcode
868 VarDecl *getConditionVariable() const;
869 void setConditionVariable(const ASTContext &C, VarDecl *V);
870
871 /// If this IfStmt has a condition variable, return the faux DeclStmt
872 /// associated with the creation of that condition variable.
getConditionVariableDeclStmt()873 const DeclStmt *getConditionVariableDeclStmt() const {
874 return reinterpret_cast<DeclStmt*>(SubExprs[VAR]);
875 }
876
getCond()877 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
setCond(Expr * E)878 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt *>(E); }
getThen()879 const Stmt *getThen() const { return SubExprs[THEN]; }
setThen(Stmt * S)880 void setThen(Stmt *S) { SubExprs[THEN] = S; }
getElse()881 const Stmt *getElse() const { return SubExprs[ELSE]; }
setElse(Stmt * S)882 void setElse(Stmt *S) { SubExprs[ELSE] = S; }
883
getCond()884 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
getThen()885 Stmt *getThen() { return SubExprs[THEN]; }
getElse()886 Stmt *getElse() { return SubExprs[ELSE]; }
887
getIfLoc()888 SourceLocation getIfLoc() const { return IfLoc; }
setIfLoc(SourceLocation L)889 void setIfLoc(SourceLocation L) { IfLoc = L; }
getElseLoc()890 SourceLocation getElseLoc() const { return ElseLoc; }
setElseLoc(SourceLocation L)891 void setElseLoc(SourceLocation L) { ElseLoc = L; }
892
getLocStart()893 SourceLocation getLocStart() const LLVM_READONLY { return IfLoc; }
getLocEnd()894 SourceLocation getLocEnd() const LLVM_READONLY {
895 if (SubExprs[ELSE])
896 return SubExprs[ELSE]->getLocEnd();
897 else
898 return SubExprs[THEN]->getLocEnd();
899 }
900
901 // Iterators over subexpressions. The iterators will include iterating
902 // over the initialization expression referenced by the condition variable.
children()903 child_range children() {
904 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
905 }
906
classof(const Stmt * T)907 static bool classof(const Stmt *T) {
908 return T->getStmtClass() == IfStmtClass;
909 }
910 };
911
912 /// SwitchStmt - This represents a 'switch' stmt.
913 ///
914 class SwitchStmt : public Stmt {
915 enum { VAR, COND, BODY, END_EXPR };
916 Stmt* SubExprs[END_EXPR];
917 // This points to a linked list of case and default statements.
918 SwitchCase *FirstCase;
919 SourceLocation SwitchLoc;
920
921 /// If the SwitchStmt is a switch on an enum value, this records whether
922 /// all the enum values were covered by CaseStmts. This value is meant to
923 /// be a hint for possible clients.
924 unsigned AllEnumCasesCovered : 1;
925
926 public:
927 SwitchStmt(const ASTContext &C, VarDecl *Var, Expr *cond);
928
929 /// \brief Build a empty switch statement.
SwitchStmt(EmptyShell Empty)930 explicit SwitchStmt(EmptyShell Empty) : Stmt(SwitchStmtClass, Empty) { }
931
932 /// \brief Retrieve the variable declared in this "switch" statement, if any.
933 ///
934 /// In the following example, "x" is the condition variable.
935 /// \code
936 /// switch (int x = foo()) {
937 /// case 0: break;
938 /// // ...
939 /// }
940 /// \endcode
941 VarDecl *getConditionVariable() const;
942 void setConditionVariable(const ASTContext &C, VarDecl *V);
943
944 /// If this SwitchStmt has a condition variable, return the faux DeclStmt
945 /// associated with the creation of that condition variable.
getConditionVariableDeclStmt()946 const DeclStmt *getConditionVariableDeclStmt() const {
947 return reinterpret_cast<DeclStmt*>(SubExprs[VAR]);
948 }
949
getCond()950 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
getBody()951 const Stmt *getBody() const { return SubExprs[BODY]; }
getSwitchCaseList()952 const SwitchCase *getSwitchCaseList() const { return FirstCase; }
953
getCond()954 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]);}
setCond(Expr * E)955 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt *>(E); }
getBody()956 Stmt *getBody() { return SubExprs[BODY]; }
setBody(Stmt * S)957 void setBody(Stmt *S) { SubExprs[BODY] = S; }
getSwitchCaseList()958 SwitchCase *getSwitchCaseList() { return FirstCase; }
959
960 /// \brief Set the case list for this switch statement.
setSwitchCaseList(SwitchCase * SC)961 void setSwitchCaseList(SwitchCase *SC) { FirstCase = SC; }
962
getSwitchLoc()963 SourceLocation getSwitchLoc() const { return SwitchLoc; }
setSwitchLoc(SourceLocation L)964 void setSwitchLoc(SourceLocation L) { SwitchLoc = L; }
965
setBody(Stmt * S,SourceLocation SL)966 void setBody(Stmt *S, SourceLocation SL) {
967 SubExprs[BODY] = S;
968 SwitchLoc = SL;
969 }
addSwitchCase(SwitchCase * SC)970 void addSwitchCase(SwitchCase *SC) {
971 assert(!SC->getNextSwitchCase()
972 && "case/default already added to a switch");
973 SC->setNextSwitchCase(FirstCase);
974 FirstCase = SC;
975 }
976
977 /// Set a flag in the SwitchStmt indicating that if the 'switch (X)' is a
978 /// switch over an enum value then all cases have been explicitly covered.
setAllEnumCasesCovered()979 void setAllEnumCasesCovered() {
980 AllEnumCasesCovered = 1;
981 }
982
983 /// Returns true if the SwitchStmt is a switch of an enum value and all cases
984 /// have been explicitly covered.
isAllEnumCasesCovered()985 bool isAllEnumCasesCovered() const {
986 return (bool) AllEnumCasesCovered;
987 }
988
getLocStart()989 SourceLocation getLocStart() const LLVM_READONLY { return SwitchLoc; }
getLocEnd()990 SourceLocation getLocEnd() const LLVM_READONLY {
991 return SubExprs[BODY]->getLocEnd();
992 }
993
994 // Iterators
children()995 child_range children() {
996 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
997 }
998
classof(const Stmt * T)999 static bool classof(const Stmt *T) {
1000 return T->getStmtClass() == SwitchStmtClass;
1001 }
1002 };
1003
1004
1005 /// WhileStmt - This represents a 'while' stmt.
1006 ///
1007 class WhileStmt : public Stmt {
1008 enum { VAR, COND, BODY, END_EXPR };
1009 Stmt* SubExprs[END_EXPR];
1010 SourceLocation WhileLoc;
1011 public:
1012 WhileStmt(const ASTContext &C, VarDecl *Var, Expr *cond, Stmt *body,
1013 SourceLocation WL);
1014
1015 /// \brief Build an empty while statement.
WhileStmt(EmptyShell Empty)1016 explicit WhileStmt(EmptyShell Empty) : Stmt(WhileStmtClass, Empty) { }
1017
1018 /// \brief Retrieve the variable declared in this "while" statement, if any.
1019 ///
1020 /// In the following example, "x" is the condition variable.
1021 /// \code
1022 /// while (int x = random()) {
1023 /// // ...
1024 /// }
1025 /// \endcode
1026 VarDecl *getConditionVariable() const;
1027 void setConditionVariable(const ASTContext &C, VarDecl *V);
1028
1029 /// If this WhileStmt has a condition variable, return the faux DeclStmt
1030 /// associated with the creation of that condition variable.
getConditionVariableDeclStmt()1031 const DeclStmt *getConditionVariableDeclStmt() const {
1032 return reinterpret_cast<DeclStmt*>(SubExprs[VAR]);
1033 }
1034
getCond()1035 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
getCond()1036 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
setCond(Expr * E)1037 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt*>(E); }
getBody()1038 Stmt *getBody() { return SubExprs[BODY]; }
getBody()1039 const Stmt *getBody() const { return SubExprs[BODY]; }
setBody(Stmt * S)1040 void setBody(Stmt *S) { SubExprs[BODY] = S; }
1041
getWhileLoc()1042 SourceLocation getWhileLoc() const { return WhileLoc; }
setWhileLoc(SourceLocation L)1043 void setWhileLoc(SourceLocation L) { WhileLoc = L; }
1044
getLocStart()1045 SourceLocation getLocStart() const LLVM_READONLY { return WhileLoc; }
getLocEnd()1046 SourceLocation getLocEnd() const LLVM_READONLY {
1047 return SubExprs[BODY]->getLocEnd();
1048 }
1049
classof(const Stmt * T)1050 static bool classof(const Stmt *T) {
1051 return T->getStmtClass() == WhileStmtClass;
1052 }
1053
1054 // Iterators
children()1055 child_range children() {
1056 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1057 }
1058 };
1059
1060 /// DoStmt - This represents a 'do/while' stmt.
1061 ///
1062 class DoStmt : public Stmt {
1063 enum { BODY, COND, END_EXPR };
1064 Stmt* SubExprs[END_EXPR];
1065 SourceLocation DoLoc;
1066 SourceLocation WhileLoc;
1067 SourceLocation RParenLoc; // Location of final ')' in do stmt condition.
1068
1069 public:
DoStmt(Stmt * body,Expr * cond,SourceLocation DL,SourceLocation WL,SourceLocation RP)1070 DoStmt(Stmt *body, Expr *cond, SourceLocation DL, SourceLocation WL,
1071 SourceLocation RP)
1072 : Stmt(DoStmtClass), DoLoc(DL), WhileLoc(WL), RParenLoc(RP) {
1073 SubExprs[COND] = reinterpret_cast<Stmt*>(cond);
1074 SubExprs[BODY] = body;
1075 }
1076
1077 /// \brief Build an empty do-while statement.
DoStmt(EmptyShell Empty)1078 explicit DoStmt(EmptyShell Empty) : Stmt(DoStmtClass, Empty) { }
1079
getCond()1080 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
getCond()1081 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
setCond(Expr * E)1082 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt*>(E); }
getBody()1083 Stmt *getBody() { return SubExprs[BODY]; }
getBody()1084 const Stmt *getBody() const { return SubExprs[BODY]; }
setBody(Stmt * S)1085 void setBody(Stmt *S) { SubExprs[BODY] = S; }
1086
getDoLoc()1087 SourceLocation getDoLoc() const { return DoLoc; }
setDoLoc(SourceLocation L)1088 void setDoLoc(SourceLocation L) { DoLoc = L; }
getWhileLoc()1089 SourceLocation getWhileLoc() const { return WhileLoc; }
setWhileLoc(SourceLocation L)1090 void setWhileLoc(SourceLocation L) { WhileLoc = L; }
1091
getRParenLoc()1092 SourceLocation getRParenLoc() const { return RParenLoc; }
setRParenLoc(SourceLocation L)1093 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
1094
getLocStart()1095 SourceLocation getLocStart() const LLVM_READONLY { return DoLoc; }
getLocEnd()1096 SourceLocation getLocEnd() const LLVM_READONLY { return RParenLoc; }
1097
classof(const Stmt * T)1098 static bool classof(const Stmt *T) {
1099 return T->getStmtClass() == DoStmtClass;
1100 }
1101
1102 // Iterators
children()1103 child_range children() {
1104 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1105 }
1106 };
1107
1108
1109 /// ForStmt - This represents a 'for (init;cond;inc)' stmt. Note that any of
1110 /// the init/cond/inc parts of the ForStmt will be null if they were not
1111 /// specified in the source.
1112 ///
1113 class ForStmt : public Stmt {
1114 enum { INIT, CONDVAR, COND, INC, BODY, END_EXPR };
1115 Stmt* SubExprs[END_EXPR]; // SubExprs[INIT] is an expression or declstmt.
1116 SourceLocation ForLoc;
1117 SourceLocation LParenLoc, RParenLoc;
1118
1119 public:
1120 ForStmt(const ASTContext &C, Stmt *Init, Expr *Cond, VarDecl *condVar,
1121 Expr *Inc, Stmt *Body, SourceLocation FL, SourceLocation LP,
1122 SourceLocation RP);
1123
1124 /// \brief Build an empty for statement.
ForStmt(EmptyShell Empty)1125 explicit ForStmt(EmptyShell Empty) : Stmt(ForStmtClass, Empty) { }
1126
getInit()1127 Stmt *getInit() { return SubExprs[INIT]; }
1128
1129 /// \brief Retrieve the variable declared in this "for" statement, if any.
1130 ///
1131 /// In the following example, "y" is the condition variable.
1132 /// \code
1133 /// for (int x = random(); int y = mangle(x); ++x) {
1134 /// // ...
1135 /// }
1136 /// \endcode
1137 VarDecl *getConditionVariable() const;
1138 void setConditionVariable(const ASTContext &C, VarDecl *V);
1139
1140 /// If this ForStmt has a condition variable, return the faux DeclStmt
1141 /// associated with the creation of that condition variable.
getConditionVariableDeclStmt()1142 const DeclStmt *getConditionVariableDeclStmt() const {
1143 return reinterpret_cast<DeclStmt*>(SubExprs[CONDVAR]);
1144 }
1145
getCond()1146 Expr *getCond() { return reinterpret_cast<Expr*>(SubExprs[COND]); }
getInc()1147 Expr *getInc() { return reinterpret_cast<Expr*>(SubExprs[INC]); }
getBody()1148 Stmt *getBody() { return SubExprs[BODY]; }
1149
getInit()1150 const Stmt *getInit() const { return SubExprs[INIT]; }
getCond()1151 const Expr *getCond() const { return reinterpret_cast<Expr*>(SubExprs[COND]);}
getInc()1152 const Expr *getInc() const { return reinterpret_cast<Expr*>(SubExprs[INC]); }
getBody()1153 const Stmt *getBody() const { return SubExprs[BODY]; }
1154
setInit(Stmt * S)1155 void setInit(Stmt *S) { SubExprs[INIT] = S; }
setCond(Expr * E)1156 void setCond(Expr *E) { SubExprs[COND] = reinterpret_cast<Stmt*>(E); }
setInc(Expr * E)1157 void setInc(Expr *E) { SubExprs[INC] = reinterpret_cast<Stmt*>(E); }
setBody(Stmt * S)1158 void setBody(Stmt *S) { SubExprs[BODY] = S; }
1159
getForLoc()1160 SourceLocation getForLoc() const { return ForLoc; }
setForLoc(SourceLocation L)1161 void setForLoc(SourceLocation L) { ForLoc = L; }
getLParenLoc()1162 SourceLocation getLParenLoc() const { return LParenLoc; }
setLParenLoc(SourceLocation L)1163 void setLParenLoc(SourceLocation L) { LParenLoc = L; }
getRParenLoc()1164 SourceLocation getRParenLoc() const { return RParenLoc; }
setRParenLoc(SourceLocation L)1165 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
1166
getLocStart()1167 SourceLocation getLocStart() const LLVM_READONLY { return ForLoc; }
getLocEnd()1168 SourceLocation getLocEnd() const LLVM_READONLY {
1169 return SubExprs[BODY]->getLocEnd();
1170 }
1171
classof(const Stmt * T)1172 static bool classof(const Stmt *T) {
1173 return T->getStmtClass() == ForStmtClass;
1174 }
1175
1176 // Iterators
children()1177 child_range children() {
1178 return child_range(&SubExprs[0], &SubExprs[0]+END_EXPR);
1179 }
1180 };
1181
1182 /// GotoStmt - This represents a direct goto.
1183 ///
1184 class GotoStmt : public Stmt {
1185 LabelDecl *Label;
1186 SourceLocation GotoLoc;
1187 SourceLocation LabelLoc;
1188 public:
GotoStmt(LabelDecl * label,SourceLocation GL,SourceLocation LL)1189 GotoStmt(LabelDecl *label, SourceLocation GL, SourceLocation LL)
1190 : Stmt(GotoStmtClass), Label(label), GotoLoc(GL), LabelLoc(LL) {}
1191
1192 /// \brief Build an empty goto statement.
GotoStmt(EmptyShell Empty)1193 explicit GotoStmt(EmptyShell Empty) : Stmt(GotoStmtClass, Empty) { }
1194
getLabel()1195 LabelDecl *getLabel() const { return Label; }
setLabel(LabelDecl * D)1196 void setLabel(LabelDecl *D) { Label = D; }
1197
getGotoLoc()1198 SourceLocation getGotoLoc() const { return GotoLoc; }
setGotoLoc(SourceLocation L)1199 void setGotoLoc(SourceLocation L) { GotoLoc = L; }
getLabelLoc()1200 SourceLocation getLabelLoc() const { return LabelLoc; }
setLabelLoc(SourceLocation L)1201 void setLabelLoc(SourceLocation L) { LabelLoc = L; }
1202
getLocStart()1203 SourceLocation getLocStart() const LLVM_READONLY { return GotoLoc; }
getLocEnd()1204 SourceLocation getLocEnd() const LLVM_READONLY { return LabelLoc; }
1205
classof(const Stmt * T)1206 static bool classof(const Stmt *T) {
1207 return T->getStmtClass() == GotoStmtClass;
1208 }
1209
1210 // Iterators
children()1211 child_range children() { return child_range(); }
1212 };
1213
1214 /// IndirectGotoStmt - This represents an indirect goto.
1215 ///
1216 class IndirectGotoStmt : public Stmt {
1217 SourceLocation GotoLoc;
1218 SourceLocation StarLoc;
1219 Stmt *Target;
1220 public:
IndirectGotoStmt(SourceLocation gotoLoc,SourceLocation starLoc,Expr * target)1221 IndirectGotoStmt(SourceLocation gotoLoc, SourceLocation starLoc,
1222 Expr *target)
1223 : Stmt(IndirectGotoStmtClass), GotoLoc(gotoLoc), StarLoc(starLoc),
1224 Target((Stmt*)target) {}
1225
1226 /// \brief Build an empty indirect goto statement.
IndirectGotoStmt(EmptyShell Empty)1227 explicit IndirectGotoStmt(EmptyShell Empty)
1228 : Stmt(IndirectGotoStmtClass, Empty) { }
1229
setGotoLoc(SourceLocation L)1230 void setGotoLoc(SourceLocation L) { GotoLoc = L; }
getGotoLoc()1231 SourceLocation getGotoLoc() const { return GotoLoc; }
setStarLoc(SourceLocation L)1232 void setStarLoc(SourceLocation L) { StarLoc = L; }
getStarLoc()1233 SourceLocation getStarLoc() const { return StarLoc; }
1234
getTarget()1235 Expr *getTarget() { return reinterpret_cast<Expr*>(Target); }
getTarget()1236 const Expr *getTarget() const {return reinterpret_cast<const Expr*>(Target);}
setTarget(Expr * E)1237 void setTarget(Expr *E) { Target = reinterpret_cast<Stmt*>(E); }
1238
1239 /// getConstantTarget - Returns the fixed target of this indirect
1240 /// goto, if one exists.
1241 LabelDecl *getConstantTarget();
getConstantTarget()1242 const LabelDecl *getConstantTarget() const {
1243 return const_cast<IndirectGotoStmt*>(this)->getConstantTarget();
1244 }
1245
getLocStart()1246 SourceLocation getLocStart() const LLVM_READONLY { return GotoLoc; }
getLocEnd()1247 SourceLocation getLocEnd() const LLVM_READONLY { return Target->getLocEnd(); }
1248
classof(const Stmt * T)1249 static bool classof(const Stmt *T) {
1250 return T->getStmtClass() == IndirectGotoStmtClass;
1251 }
1252
1253 // Iterators
children()1254 child_range children() { return child_range(&Target, &Target+1); }
1255 };
1256
1257
1258 /// ContinueStmt - This represents a continue.
1259 ///
1260 class ContinueStmt : public Stmt {
1261 SourceLocation ContinueLoc;
1262 public:
ContinueStmt(SourceLocation CL)1263 ContinueStmt(SourceLocation CL) : Stmt(ContinueStmtClass), ContinueLoc(CL) {}
1264
1265 /// \brief Build an empty continue statement.
ContinueStmt(EmptyShell Empty)1266 explicit ContinueStmt(EmptyShell Empty) : Stmt(ContinueStmtClass, Empty) { }
1267
getContinueLoc()1268 SourceLocation getContinueLoc() const { return ContinueLoc; }
setContinueLoc(SourceLocation L)1269 void setContinueLoc(SourceLocation L) { ContinueLoc = L; }
1270
getLocStart()1271 SourceLocation getLocStart() const LLVM_READONLY { return ContinueLoc; }
getLocEnd()1272 SourceLocation getLocEnd() const LLVM_READONLY { return ContinueLoc; }
1273
classof(const Stmt * T)1274 static bool classof(const Stmt *T) {
1275 return T->getStmtClass() == ContinueStmtClass;
1276 }
1277
1278 // Iterators
children()1279 child_range children() { return child_range(); }
1280 };
1281
1282 /// BreakStmt - This represents a break.
1283 ///
1284 class BreakStmt : public Stmt {
1285 SourceLocation BreakLoc;
1286 public:
BreakStmt(SourceLocation BL)1287 BreakStmt(SourceLocation BL) : Stmt(BreakStmtClass), BreakLoc(BL) {}
1288
1289 /// \brief Build an empty break statement.
BreakStmt(EmptyShell Empty)1290 explicit BreakStmt(EmptyShell Empty) : Stmt(BreakStmtClass, Empty) { }
1291
getBreakLoc()1292 SourceLocation getBreakLoc() const { return BreakLoc; }
setBreakLoc(SourceLocation L)1293 void setBreakLoc(SourceLocation L) { BreakLoc = L; }
1294
getLocStart()1295 SourceLocation getLocStart() const LLVM_READONLY { return BreakLoc; }
getLocEnd()1296 SourceLocation getLocEnd() const LLVM_READONLY { return BreakLoc; }
1297
classof(const Stmt * T)1298 static bool classof(const Stmt *T) {
1299 return T->getStmtClass() == BreakStmtClass;
1300 }
1301
1302 // Iterators
children()1303 child_range children() { return child_range(); }
1304 };
1305
1306
1307 /// ReturnStmt - This represents a return, optionally of an expression:
1308 /// return;
1309 /// return 4;
1310 ///
1311 /// Note that GCC allows return with no argument in a function declared to
1312 /// return a value, and it allows returning a value in functions declared to
1313 /// return void. We explicitly model this in the AST, which means you can't
1314 /// depend on the return type of the function and the presence of an argument.
1315 ///
1316 class ReturnStmt : public Stmt {
1317 Stmt *RetExpr;
1318 SourceLocation RetLoc;
1319 const VarDecl *NRVOCandidate;
1320
1321 public:
ReturnStmt(SourceLocation RL)1322 ReturnStmt(SourceLocation RL)
1323 : Stmt(ReturnStmtClass), RetExpr(0), RetLoc(RL), NRVOCandidate(0) { }
1324
ReturnStmt(SourceLocation RL,Expr * E,const VarDecl * NRVOCandidate)1325 ReturnStmt(SourceLocation RL, Expr *E, const VarDecl *NRVOCandidate)
1326 : Stmt(ReturnStmtClass), RetExpr((Stmt*) E), RetLoc(RL),
1327 NRVOCandidate(NRVOCandidate) {}
1328
1329 /// \brief Build an empty return expression.
ReturnStmt(EmptyShell Empty)1330 explicit ReturnStmt(EmptyShell Empty) : Stmt(ReturnStmtClass, Empty) { }
1331
1332 const Expr *getRetValue() const;
1333 Expr *getRetValue();
setRetValue(Expr * E)1334 void setRetValue(Expr *E) { RetExpr = reinterpret_cast<Stmt*>(E); }
1335
getReturnLoc()1336 SourceLocation getReturnLoc() const { return RetLoc; }
setReturnLoc(SourceLocation L)1337 void setReturnLoc(SourceLocation L) { RetLoc = L; }
1338
1339 /// \brief Retrieve the variable that might be used for the named return
1340 /// value optimization.
1341 ///
1342 /// The optimization itself can only be performed if the variable is
1343 /// also marked as an NRVO object.
getNRVOCandidate()1344 const VarDecl *getNRVOCandidate() const { return NRVOCandidate; }
setNRVOCandidate(const VarDecl * Var)1345 void setNRVOCandidate(const VarDecl *Var) { NRVOCandidate = Var; }
1346
getLocStart()1347 SourceLocation getLocStart() const LLVM_READONLY { return RetLoc; }
getLocEnd()1348 SourceLocation getLocEnd() const LLVM_READONLY {
1349 return RetExpr ? RetExpr->getLocEnd() : RetLoc;
1350 }
1351
classof(const Stmt * T)1352 static bool classof(const Stmt *T) {
1353 return T->getStmtClass() == ReturnStmtClass;
1354 }
1355
1356 // Iterators
children()1357 child_range children() {
1358 if (RetExpr) return child_range(&RetExpr, &RetExpr+1);
1359 return child_range();
1360 }
1361 };
1362
1363 /// AsmStmt is the base class for GCCAsmStmt and MSAsmStmt.
1364 ///
1365 class AsmStmt : public Stmt {
1366 protected:
1367 SourceLocation AsmLoc;
1368 /// \brief True if the assembly statement does not have any input or output
1369 /// operands.
1370 bool IsSimple;
1371
1372 /// \brief If true, treat this inline assembly as having side effects.
1373 /// This assembly statement should not be optimized, deleted or moved.
1374 bool IsVolatile;
1375
1376 unsigned NumOutputs;
1377 unsigned NumInputs;
1378 unsigned NumClobbers;
1379
1380 Stmt **Exprs;
1381
AsmStmt(StmtClass SC,SourceLocation asmloc,bool issimple,bool isvolatile,unsigned numoutputs,unsigned numinputs,unsigned numclobbers)1382 AsmStmt(StmtClass SC, SourceLocation asmloc, bool issimple, bool isvolatile,
1383 unsigned numoutputs, unsigned numinputs, unsigned numclobbers) :
1384 Stmt (SC), AsmLoc(asmloc), IsSimple(issimple), IsVolatile(isvolatile),
1385 NumOutputs(numoutputs), NumInputs(numinputs), NumClobbers(numclobbers) { }
1386
1387 friend class ASTStmtReader;
1388
1389 public:
1390 /// \brief Build an empty inline-assembly statement.
AsmStmt(StmtClass SC,EmptyShell Empty)1391 explicit AsmStmt(StmtClass SC, EmptyShell Empty) :
1392 Stmt(SC, Empty), Exprs(0) { }
1393
getAsmLoc()1394 SourceLocation getAsmLoc() const { return AsmLoc; }
setAsmLoc(SourceLocation L)1395 void setAsmLoc(SourceLocation L) { AsmLoc = L; }
1396
isSimple()1397 bool isSimple() const { return IsSimple; }
setSimple(bool V)1398 void setSimple(bool V) { IsSimple = V; }
1399
isVolatile()1400 bool isVolatile() const { return IsVolatile; }
setVolatile(bool V)1401 void setVolatile(bool V) { IsVolatile = V; }
1402
getLocStart()1403 SourceLocation getLocStart() const LLVM_READONLY { return SourceLocation(); }
getLocEnd()1404 SourceLocation getLocEnd() const LLVM_READONLY { return SourceLocation(); }
1405
1406 //===--- Asm String Analysis ---===//
1407
1408 /// Assemble final IR asm string.
1409 std::string generateAsmString(const ASTContext &C) const;
1410
1411 //===--- Output operands ---===//
1412
getNumOutputs()1413 unsigned getNumOutputs() const { return NumOutputs; }
1414
1415 /// getOutputConstraint - Return the constraint string for the specified
1416 /// output operand. All output constraints are known to be non-empty (either
1417 /// '=' or '+').
1418 StringRef getOutputConstraint(unsigned i) const;
1419
1420 /// isOutputPlusConstraint - Return true if the specified output constraint
1421 /// is a "+" constraint (which is both an input and an output) or false if it
1422 /// is an "=" constraint (just an output).
isOutputPlusConstraint(unsigned i)1423 bool isOutputPlusConstraint(unsigned i) const {
1424 return getOutputConstraint(i)[0] == '+';
1425 }
1426
1427 const Expr *getOutputExpr(unsigned i) const;
1428
1429 /// getNumPlusOperands - Return the number of output operands that have a "+"
1430 /// constraint.
1431 unsigned getNumPlusOperands() const;
1432
1433 //===--- Input operands ---===//
1434
getNumInputs()1435 unsigned getNumInputs() const { return NumInputs; }
1436
1437 /// getInputConstraint - Return the specified input constraint. Unlike output
1438 /// constraints, these can be empty.
1439 StringRef getInputConstraint(unsigned i) const;
1440
1441 const Expr *getInputExpr(unsigned i) const;
1442
1443 //===--- Other ---===//
1444
getNumClobbers()1445 unsigned getNumClobbers() const { return NumClobbers; }
1446 StringRef getClobber(unsigned i) const;
1447
classof(const Stmt * T)1448 static bool classof(const Stmt *T) {
1449 return T->getStmtClass() == GCCAsmStmtClass ||
1450 T->getStmtClass() == MSAsmStmtClass;
1451 }
1452
1453 // Input expr iterators.
1454
1455 typedef ExprIterator inputs_iterator;
1456 typedef ConstExprIterator const_inputs_iterator;
1457
begin_inputs()1458 inputs_iterator begin_inputs() {
1459 return &Exprs[0] + NumOutputs;
1460 }
1461
end_inputs()1462 inputs_iterator end_inputs() {
1463 return &Exprs[0] + NumOutputs + NumInputs;
1464 }
1465
begin_inputs()1466 const_inputs_iterator begin_inputs() const {
1467 return &Exprs[0] + NumOutputs;
1468 }
1469
end_inputs()1470 const_inputs_iterator end_inputs() const {
1471 return &Exprs[0] + NumOutputs + NumInputs;
1472 }
1473
1474 // Output expr iterators.
1475
1476 typedef ExprIterator outputs_iterator;
1477 typedef ConstExprIterator const_outputs_iterator;
1478
begin_outputs()1479 outputs_iterator begin_outputs() {
1480 return &Exprs[0];
1481 }
end_outputs()1482 outputs_iterator end_outputs() {
1483 return &Exprs[0] + NumOutputs;
1484 }
1485
begin_outputs()1486 const_outputs_iterator begin_outputs() const {
1487 return &Exprs[0];
1488 }
end_outputs()1489 const_outputs_iterator end_outputs() const {
1490 return &Exprs[0] + NumOutputs;
1491 }
1492
children()1493 child_range children() {
1494 return child_range(&Exprs[0], &Exprs[0] + NumOutputs + NumInputs);
1495 }
1496 };
1497
1498 /// This represents a GCC inline-assembly statement extension.
1499 ///
1500 class GCCAsmStmt : public AsmStmt {
1501 SourceLocation RParenLoc;
1502 StringLiteral *AsmStr;
1503
1504 // FIXME: If we wanted to, we could allocate all of these in one big array.
1505 StringLiteral **Constraints;
1506 StringLiteral **Clobbers;
1507 IdentifierInfo **Names;
1508
1509 friend class ASTStmtReader;
1510
1511 public:
1512 GCCAsmStmt(const ASTContext &C, SourceLocation asmloc, bool issimple,
1513 bool isvolatile, unsigned numoutputs, unsigned numinputs,
1514 IdentifierInfo **names, StringLiteral **constraints, Expr **exprs,
1515 StringLiteral *asmstr, unsigned numclobbers,
1516 StringLiteral **clobbers, SourceLocation rparenloc);
1517
1518 /// \brief Build an empty inline-assembly statement.
GCCAsmStmt(EmptyShell Empty)1519 explicit GCCAsmStmt(EmptyShell Empty) : AsmStmt(GCCAsmStmtClass, Empty),
1520 Constraints(0), Clobbers(0), Names(0) { }
1521
getRParenLoc()1522 SourceLocation getRParenLoc() const { return RParenLoc; }
setRParenLoc(SourceLocation L)1523 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
1524
1525 //===--- Asm String Analysis ---===//
1526
getAsmString()1527 const StringLiteral *getAsmString() const { return AsmStr; }
getAsmString()1528 StringLiteral *getAsmString() { return AsmStr; }
setAsmString(StringLiteral * E)1529 void setAsmString(StringLiteral *E) { AsmStr = E; }
1530
1531 /// AsmStringPiece - this is part of a decomposed asm string specification
1532 /// (for use with the AnalyzeAsmString function below). An asm string is
1533 /// considered to be a concatenation of these parts.
1534 class AsmStringPiece {
1535 public:
1536 enum Kind {
1537 String, // String in .ll asm string form, "$" -> "$$" and "%%" -> "%".
1538 Operand // Operand reference, with optional modifier %c4.
1539 };
1540 private:
1541 Kind MyKind;
1542 std::string Str;
1543 unsigned OperandNo;
1544 public:
AsmStringPiece(const std::string & S)1545 AsmStringPiece(const std::string &S) : MyKind(String), Str(S) {}
AsmStringPiece(unsigned OpNo,char Modifier)1546 AsmStringPiece(unsigned OpNo, char Modifier)
1547 : MyKind(Operand), Str(), OperandNo(OpNo) {
1548 Str += Modifier;
1549 }
1550
isString()1551 bool isString() const { return MyKind == String; }
isOperand()1552 bool isOperand() const { return MyKind == Operand; }
1553
getString()1554 const std::string &getString() const {
1555 assert(isString());
1556 return Str;
1557 }
1558
getOperandNo()1559 unsigned getOperandNo() const {
1560 assert(isOperand());
1561 return OperandNo;
1562 }
1563
1564 /// getModifier - Get the modifier for this operand, if present. This
1565 /// returns '\0' if there was no modifier.
getModifier()1566 char getModifier() const {
1567 assert(isOperand());
1568 return Str[0];
1569 }
1570 };
1571
1572 /// AnalyzeAsmString - Analyze the asm string of the current asm, decomposing
1573 /// it into pieces. If the asm string is erroneous, emit errors and return
1574 /// true, otherwise return false. This handles canonicalization and
1575 /// translation of strings from GCC syntax to LLVM IR syntax, and handles
1576 //// flattening of named references like %[foo] to Operand AsmStringPiece's.
1577 unsigned AnalyzeAsmString(SmallVectorImpl<AsmStringPiece> &Pieces,
1578 const ASTContext &C, unsigned &DiagOffs) const;
1579
1580 /// Assemble final IR asm string.
1581 std::string generateAsmString(const ASTContext &C) const;
1582
1583 //===--- Output operands ---===//
1584
getOutputIdentifier(unsigned i)1585 IdentifierInfo *getOutputIdentifier(unsigned i) const {
1586 return Names[i];
1587 }
1588
getOutputName(unsigned i)1589 StringRef getOutputName(unsigned i) const {
1590 if (IdentifierInfo *II = getOutputIdentifier(i))
1591 return II->getName();
1592
1593 return StringRef();
1594 }
1595
1596 StringRef getOutputConstraint(unsigned i) const;
1597
getOutputConstraintLiteral(unsigned i)1598 const StringLiteral *getOutputConstraintLiteral(unsigned i) const {
1599 return Constraints[i];
1600 }
getOutputConstraintLiteral(unsigned i)1601 StringLiteral *getOutputConstraintLiteral(unsigned i) {
1602 return Constraints[i];
1603 }
1604
1605 Expr *getOutputExpr(unsigned i);
1606
getOutputExpr(unsigned i)1607 const Expr *getOutputExpr(unsigned i) const {
1608 return const_cast<GCCAsmStmt*>(this)->getOutputExpr(i);
1609 }
1610
1611 //===--- Input operands ---===//
1612
getInputIdentifier(unsigned i)1613 IdentifierInfo *getInputIdentifier(unsigned i) const {
1614 return Names[i + NumOutputs];
1615 }
1616
getInputName(unsigned i)1617 StringRef getInputName(unsigned i) const {
1618 if (IdentifierInfo *II = getInputIdentifier(i))
1619 return II->getName();
1620
1621 return StringRef();
1622 }
1623
1624 StringRef getInputConstraint(unsigned i) const;
1625
getInputConstraintLiteral(unsigned i)1626 const StringLiteral *getInputConstraintLiteral(unsigned i) const {
1627 return Constraints[i + NumOutputs];
1628 }
getInputConstraintLiteral(unsigned i)1629 StringLiteral *getInputConstraintLiteral(unsigned i) {
1630 return Constraints[i + NumOutputs];
1631 }
1632
1633 Expr *getInputExpr(unsigned i);
1634 void setInputExpr(unsigned i, Expr *E);
1635
getInputExpr(unsigned i)1636 const Expr *getInputExpr(unsigned i) const {
1637 return const_cast<GCCAsmStmt*>(this)->getInputExpr(i);
1638 }
1639
1640 private:
1641 void setOutputsAndInputsAndClobbers(const ASTContext &C,
1642 IdentifierInfo **Names,
1643 StringLiteral **Constraints,
1644 Stmt **Exprs,
1645 unsigned NumOutputs,
1646 unsigned NumInputs,
1647 StringLiteral **Clobbers,
1648 unsigned NumClobbers);
1649 public:
1650
1651 //===--- Other ---===//
1652
1653 /// getNamedOperand - Given a symbolic operand reference like %[foo],
1654 /// translate this into a numeric value needed to reference the same operand.
1655 /// This returns -1 if the operand name is invalid.
1656 int getNamedOperand(StringRef SymbolicName) const;
1657
1658 StringRef getClobber(unsigned i) const;
getClobberStringLiteral(unsigned i)1659 StringLiteral *getClobberStringLiteral(unsigned i) { return Clobbers[i]; }
getClobberStringLiteral(unsigned i)1660 const StringLiteral *getClobberStringLiteral(unsigned i) const {
1661 return Clobbers[i];
1662 }
1663
getLocStart()1664 SourceLocation getLocStart() const LLVM_READONLY { return AsmLoc; }
getLocEnd()1665 SourceLocation getLocEnd() const LLVM_READONLY { return RParenLoc; }
1666
classof(const Stmt * T)1667 static bool classof(const Stmt *T) {
1668 return T->getStmtClass() == GCCAsmStmtClass;
1669 }
1670 };
1671
1672 /// This represents a Microsoft inline-assembly statement extension.
1673 ///
1674 class MSAsmStmt : public AsmStmt {
1675 SourceLocation LBraceLoc, EndLoc;
1676 StringRef AsmStr;
1677
1678 unsigned NumAsmToks;
1679
1680 Token *AsmToks;
1681 StringRef *Constraints;
1682 StringRef *Clobbers;
1683
1684 friend class ASTStmtReader;
1685
1686 public:
1687 MSAsmStmt(const ASTContext &C, SourceLocation asmloc,
1688 SourceLocation lbraceloc, bool issimple, bool isvolatile,
1689 ArrayRef<Token> asmtoks, unsigned numoutputs, unsigned numinputs,
1690 ArrayRef<StringRef> constraints,
1691 ArrayRef<Expr*> exprs, StringRef asmstr,
1692 ArrayRef<StringRef> clobbers, SourceLocation endloc);
1693
1694 /// \brief Build an empty MS-style inline-assembly statement.
MSAsmStmt(EmptyShell Empty)1695 explicit MSAsmStmt(EmptyShell Empty) : AsmStmt(MSAsmStmtClass, Empty),
1696 NumAsmToks(0), AsmToks(0), Constraints(0), Clobbers(0) { }
1697
getLBraceLoc()1698 SourceLocation getLBraceLoc() const { return LBraceLoc; }
setLBraceLoc(SourceLocation L)1699 void setLBraceLoc(SourceLocation L) { LBraceLoc = L; }
getEndLoc()1700 SourceLocation getEndLoc() const { return EndLoc; }
setEndLoc(SourceLocation L)1701 void setEndLoc(SourceLocation L) { EndLoc = L; }
1702
hasBraces()1703 bool hasBraces() const { return LBraceLoc.isValid(); }
1704
getNumAsmToks()1705 unsigned getNumAsmToks() { return NumAsmToks; }
getAsmToks()1706 Token *getAsmToks() { return AsmToks; }
1707
1708 //===--- Asm String Analysis ---===//
getAsmString()1709 StringRef getAsmString() const { return AsmStr; }
1710
1711 /// Assemble final IR asm string.
1712 std::string generateAsmString(const ASTContext &C) const;
1713
1714 //===--- Output operands ---===//
1715
getOutputConstraint(unsigned i)1716 StringRef getOutputConstraint(unsigned i) const {
1717 assert(i < NumOutputs);
1718 return Constraints[i];
1719 }
1720
1721 Expr *getOutputExpr(unsigned i);
1722
getOutputExpr(unsigned i)1723 const Expr *getOutputExpr(unsigned i) const {
1724 return const_cast<MSAsmStmt*>(this)->getOutputExpr(i);
1725 }
1726
1727 //===--- Input operands ---===//
1728
getInputConstraint(unsigned i)1729 StringRef getInputConstraint(unsigned i) const {
1730 assert(i < NumInputs);
1731 return Constraints[i + NumOutputs];
1732 }
1733
1734 Expr *getInputExpr(unsigned i);
1735 void setInputExpr(unsigned i, Expr *E);
1736
getInputExpr(unsigned i)1737 const Expr *getInputExpr(unsigned i) const {
1738 return const_cast<MSAsmStmt*>(this)->getInputExpr(i);
1739 }
1740
1741 //===--- Other ---===//
1742
getAllConstraints()1743 ArrayRef<StringRef> getAllConstraints() const {
1744 return ArrayRef<StringRef>(Constraints, NumInputs + NumOutputs);
1745 }
getClobbers()1746 ArrayRef<StringRef> getClobbers() const {
1747 return ArrayRef<StringRef>(Clobbers, NumClobbers);
1748 }
getAllExprs()1749 ArrayRef<Expr*> getAllExprs() const {
1750 return ArrayRef<Expr*>(reinterpret_cast<Expr**>(Exprs),
1751 NumInputs + NumOutputs);
1752 }
1753
getClobber(unsigned i)1754 StringRef getClobber(unsigned i) const { return getClobbers()[i]; }
1755
1756 private:
1757 void initialize(const ASTContext &C, StringRef AsmString,
1758 ArrayRef<Token> AsmToks, ArrayRef<StringRef> Constraints,
1759 ArrayRef<Expr*> Exprs, ArrayRef<StringRef> Clobbers);
1760 public:
1761
getLocStart()1762 SourceLocation getLocStart() const LLVM_READONLY { return AsmLoc; }
getLocEnd()1763 SourceLocation getLocEnd() const LLVM_READONLY { return EndLoc; }
1764
classof(const Stmt * T)1765 static bool classof(const Stmt *T) {
1766 return T->getStmtClass() == MSAsmStmtClass;
1767 }
1768
children()1769 child_range children() {
1770 return child_range(&Exprs[0], &Exprs[0]);
1771 }
1772 };
1773
1774 class SEHExceptStmt : public Stmt {
1775 SourceLocation Loc;
1776 Stmt *Children[2];
1777
1778 enum { FILTER_EXPR, BLOCK };
1779
1780 SEHExceptStmt(SourceLocation Loc,
1781 Expr *FilterExpr,
1782 Stmt *Block);
1783
1784 friend class ASTReader;
1785 friend class ASTStmtReader;
SEHExceptStmt(EmptyShell E)1786 explicit SEHExceptStmt(EmptyShell E) : Stmt(SEHExceptStmtClass, E) { }
1787
1788 public:
1789 static SEHExceptStmt* Create(const ASTContext &C,
1790 SourceLocation ExceptLoc,
1791 Expr *FilterExpr,
1792 Stmt *Block);
1793
getLocStart()1794 SourceLocation getLocStart() const LLVM_READONLY { return getExceptLoc(); }
getLocEnd()1795 SourceLocation getLocEnd() const LLVM_READONLY { return getEndLoc(); }
1796
getExceptLoc()1797 SourceLocation getExceptLoc() const { return Loc; }
getEndLoc()1798 SourceLocation getEndLoc() const { return getBlock()->getLocEnd(); }
1799
getFilterExpr()1800 Expr *getFilterExpr() const {
1801 return reinterpret_cast<Expr*>(Children[FILTER_EXPR]);
1802 }
1803
getBlock()1804 CompoundStmt *getBlock() const {
1805 return cast<CompoundStmt>(Children[BLOCK]);
1806 }
1807
children()1808 child_range children() {
1809 return child_range(Children,Children+2);
1810 }
1811
classof(const Stmt * T)1812 static bool classof(const Stmt *T) {
1813 return T->getStmtClass() == SEHExceptStmtClass;
1814 }
1815
1816 };
1817
1818 class SEHFinallyStmt : public Stmt {
1819 SourceLocation Loc;
1820 Stmt *Block;
1821
1822 SEHFinallyStmt(SourceLocation Loc,
1823 Stmt *Block);
1824
1825 friend class ASTReader;
1826 friend class ASTStmtReader;
SEHFinallyStmt(EmptyShell E)1827 explicit SEHFinallyStmt(EmptyShell E) : Stmt(SEHFinallyStmtClass, E) { }
1828
1829 public:
1830 static SEHFinallyStmt* Create(const ASTContext &C,
1831 SourceLocation FinallyLoc,
1832 Stmt *Block);
1833
getLocStart()1834 SourceLocation getLocStart() const LLVM_READONLY { return getFinallyLoc(); }
getLocEnd()1835 SourceLocation getLocEnd() const LLVM_READONLY { return getEndLoc(); }
1836
getFinallyLoc()1837 SourceLocation getFinallyLoc() const { return Loc; }
getEndLoc()1838 SourceLocation getEndLoc() const { return Block->getLocEnd(); }
1839
getBlock()1840 CompoundStmt *getBlock() const { return cast<CompoundStmt>(Block); }
1841
children()1842 child_range children() {
1843 return child_range(&Block,&Block+1);
1844 }
1845
classof(const Stmt * T)1846 static bool classof(const Stmt *T) {
1847 return T->getStmtClass() == SEHFinallyStmtClass;
1848 }
1849
1850 };
1851
1852 class SEHTryStmt : public Stmt {
1853 bool IsCXXTry;
1854 SourceLocation TryLoc;
1855 Stmt *Children[2];
1856
1857 enum { TRY = 0, HANDLER = 1 };
1858
1859 SEHTryStmt(bool isCXXTry, // true if 'try' otherwise '__try'
1860 SourceLocation TryLoc,
1861 Stmt *TryBlock,
1862 Stmt *Handler);
1863
1864 friend class ASTReader;
1865 friend class ASTStmtReader;
SEHTryStmt(EmptyShell E)1866 explicit SEHTryStmt(EmptyShell E) : Stmt(SEHTryStmtClass, E) { }
1867
1868 public:
1869 static SEHTryStmt* Create(const ASTContext &C, bool isCXXTry,
1870 SourceLocation TryLoc, Stmt *TryBlock,
1871 Stmt *Handler);
1872
getLocStart()1873 SourceLocation getLocStart() const LLVM_READONLY { return getTryLoc(); }
getLocEnd()1874 SourceLocation getLocEnd() const LLVM_READONLY { return getEndLoc(); }
1875
getTryLoc()1876 SourceLocation getTryLoc() const { return TryLoc; }
getEndLoc()1877 SourceLocation getEndLoc() const { return Children[HANDLER]->getLocEnd(); }
1878
getIsCXXTry()1879 bool getIsCXXTry() const { return IsCXXTry; }
1880
getTryBlock()1881 CompoundStmt* getTryBlock() const {
1882 return cast<CompoundStmt>(Children[TRY]);
1883 }
1884
getHandler()1885 Stmt *getHandler() const { return Children[HANDLER]; }
1886
1887 /// Returns 0 if not defined
1888 SEHExceptStmt *getExceptHandler() const;
1889 SEHFinallyStmt *getFinallyHandler() const;
1890
children()1891 child_range children() {
1892 return child_range(Children,Children+2);
1893 }
1894
classof(const Stmt * T)1895 static bool classof(const Stmt *T) {
1896 return T->getStmtClass() == SEHTryStmtClass;
1897 }
1898 };
1899
1900 /// \brief This captures a statement into a function. For example, the following
1901 /// pragma annotated compound statement can be represented as a CapturedStmt,
1902 /// and this compound statement is the body of an anonymous outlined function.
1903 /// @code
1904 /// #pragma omp parallel
1905 /// {
1906 /// compute();
1907 /// }
1908 /// @endcode
1909 class CapturedStmt : public Stmt {
1910 public:
1911 /// \brief The different capture forms: by 'this' or by reference, etc.
1912 enum VariableCaptureKind {
1913 VCK_This,
1914 VCK_ByRef
1915 };
1916
1917 /// \brief Describes the capture of either a variable or 'this'.
1918 class Capture {
1919 llvm::PointerIntPair<VarDecl *, 1, VariableCaptureKind> VarAndKind;
1920 SourceLocation Loc;
1921
1922 public:
1923 /// \brief Create a new capture.
1924 ///
1925 /// \param Loc The source location associated with this capture.
1926 ///
1927 /// \param Kind The kind of capture (this, ByRef, ...).
1928 ///
1929 /// \param Var The variable being captured, or null if capturing this.
1930 ///
1931 Capture(SourceLocation Loc, VariableCaptureKind Kind, VarDecl *Var = 0)
VarAndKind(Var,Kind)1932 : VarAndKind(Var, Kind), Loc(Loc) {
1933 switch (Kind) {
1934 case VCK_This:
1935 assert(Var == 0 && "'this' capture cannot have a variable!");
1936 break;
1937 case VCK_ByRef:
1938 assert(Var && "capturing by reference must have a variable!");
1939 break;
1940 }
1941 }
1942
1943 /// \brief Determine the kind of capture.
getCaptureKind()1944 VariableCaptureKind getCaptureKind() const { return VarAndKind.getInt(); }
1945
1946 /// \brief Retrieve the source location at which the variable or 'this' was
1947 /// first used.
getLocation()1948 SourceLocation getLocation() const { return Loc; }
1949
1950 /// \brief Determine whether this capture handles the C++ 'this' pointer.
capturesThis()1951 bool capturesThis() const { return getCaptureKind() == VCK_This; }
1952
1953 /// \brief Determine whether this capture handles a variable.
capturesVariable()1954 bool capturesVariable() const { return getCaptureKind() != VCK_This; }
1955
1956 /// \brief Retrieve the declaration of the variable being captured.
1957 ///
1958 /// This operation is only valid if this capture does not capture 'this'.
getCapturedVar()1959 VarDecl *getCapturedVar() const {
1960 assert(!capturesThis() && "No variable available for 'this' capture");
1961 return VarAndKind.getPointer();
1962 }
1963 friend class ASTStmtReader;
1964 };
1965
1966 private:
1967 /// \brief The number of variable captured, including 'this'.
1968 unsigned NumCaptures;
1969
1970 /// \brief The pointer part is the implicit the outlined function and the
1971 /// int part is the captured region kind, 'CR_Default' etc.
1972 llvm::PointerIntPair<CapturedDecl *, 1, CapturedRegionKind> CapDeclAndKind;
1973
1974 /// \brief The record for captured variables, a RecordDecl or CXXRecordDecl.
1975 RecordDecl *TheRecordDecl;
1976
1977 /// \brief Construct a captured statement.
1978 CapturedStmt(Stmt *S, CapturedRegionKind Kind, ArrayRef<Capture> Captures,
1979 ArrayRef<Expr *> CaptureInits, CapturedDecl *CD, RecordDecl *RD);
1980
1981 /// \brief Construct an empty captured statement.
1982 CapturedStmt(EmptyShell Empty, unsigned NumCaptures);
1983
getStoredStmts()1984 Stmt **getStoredStmts() const {
1985 return reinterpret_cast<Stmt **>(const_cast<CapturedStmt *>(this) + 1);
1986 }
1987
1988 Capture *getStoredCaptures() const;
1989
setCapturedStmt(Stmt * S)1990 void setCapturedStmt(Stmt *S) { getStoredStmts()[NumCaptures] = S; }
1991
1992 public:
1993 static CapturedStmt *Create(const ASTContext &Context, Stmt *S,
1994 CapturedRegionKind Kind,
1995 ArrayRef<Capture> Captures,
1996 ArrayRef<Expr *> CaptureInits,
1997 CapturedDecl *CD, RecordDecl *RD);
1998
1999 static CapturedStmt *CreateDeserialized(const ASTContext &Context,
2000 unsigned NumCaptures);
2001
2002 /// \brief Retrieve the statement being captured.
getCapturedStmt()2003 Stmt *getCapturedStmt() { return getStoredStmts()[NumCaptures]; }
getCapturedStmt()2004 const Stmt *getCapturedStmt() const {
2005 return const_cast<CapturedStmt *>(this)->getCapturedStmt();
2006 }
2007
2008 /// \brief Retrieve the outlined function declaration.
getCapturedDecl()2009 CapturedDecl *getCapturedDecl() { return CapDeclAndKind.getPointer(); }
getCapturedDecl()2010 const CapturedDecl *getCapturedDecl() const {
2011 return const_cast<CapturedStmt *>(this)->getCapturedDecl();
2012 }
2013
2014 /// \brief Set the outlined function declaration.
setCapturedDecl(CapturedDecl * D)2015 void setCapturedDecl(CapturedDecl *D) {
2016 assert(D && "null CapturedDecl");
2017 CapDeclAndKind.setPointer(D);
2018 }
2019
2020 /// \brief Retrieve the captured region kind.
getCapturedRegionKind()2021 CapturedRegionKind getCapturedRegionKind() const {
2022 return CapDeclAndKind.getInt();
2023 }
2024
2025 /// \brief Set the captured region kind.
setCapturedRegionKind(CapturedRegionKind Kind)2026 void setCapturedRegionKind(CapturedRegionKind Kind) {
2027 CapDeclAndKind.setInt(Kind);
2028 }
2029
2030 /// \brief Retrieve the record declaration for captured variables.
getCapturedRecordDecl()2031 const RecordDecl *getCapturedRecordDecl() const { return TheRecordDecl; }
2032
2033 /// \brief Set the record declaration for captured variables.
setCapturedRecordDecl(RecordDecl * D)2034 void setCapturedRecordDecl(RecordDecl *D) {
2035 assert(D && "null RecordDecl");
2036 TheRecordDecl = D;
2037 }
2038
2039 /// \brief True if this variable has been captured.
2040 bool capturesVariable(const VarDecl *Var) const;
2041
2042 /// \brief An iterator that walks over the captures.
2043 typedef Capture *capture_iterator;
2044 typedef const Capture *const_capture_iterator;
2045
2046 /// \brief Retrieve an iterator pointing to the first capture.
capture_begin()2047 capture_iterator capture_begin() { return getStoredCaptures(); }
capture_begin()2048 const_capture_iterator capture_begin() const { return getStoredCaptures(); }
2049
2050 /// \brief Retrieve an iterator pointing past the end of the sequence of
2051 /// captures.
capture_end()2052 capture_iterator capture_end() const {
2053 return getStoredCaptures() + NumCaptures;
2054 }
2055
2056 /// \brief Retrieve the number of captures, including 'this'.
capture_size()2057 unsigned capture_size() const { return NumCaptures; }
2058
2059 /// \brief Iterator that walks over the capture initialization arguments.
2060 typedef Expr **capture_init_iterator;
2061
2062 /// \brief Retrieve the first initialization argument.
capture_init_begin()2063 capture_init_iterator capture_init_begin() const {
2064 return reinterpret_cast<Expr **>(getStoredStmts());
2065 }
2066
2067 /// \brief Retrieve the iterator pointing one past the last initialization
2068 /// argument.
capture_init_end()2069 capture_init_iterator capture_init_end() const {
2070 return capture_init_begin() + NumCaptures;
2071 }
2072
getLocStart()2073 SourceLocation getLocStart() const LLVM_READONLY {
2074 return getCapturedStmt()->getLocStart();
2075 }
getLocEnd()2076 SourceLocation getLocEnd() const LLVM_READONLY {
2077 return getCapturedStmt()->getLocEnd();
2078 }
getSourceRange()2079 SourceRange getSourceRange() const LLVM_READONLY {
2080 return getCapturedStmt()->getSourceRange();
2081 }
2082
classof(const Stmt * T)2083 static bool classof(const Stmt *T) {
2084 return T->getStmtClass() == CapturedStmtClass;
2085 }
2086
2087 child_range children();
2088
2089 friend class ASTStmtReader;
2090 };
2091
2092 } // end namespace clang
2093
2094 #endif
2095