1 //===--- StmtIterator.h - Iterators for 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 StmtIterator and ConstStmtIterator classes.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_AST_STMT_ITR_H
15 #define LLVM_CLANG_AST_STMT_ITR_H
17 #include "llvm/Support/DataTypes.h"
27 class VariableArrayType;
29 class StmtIteratorBase {
31 enum { DeclMode = 0x1, SizeOfTypeVAMode = 0x2, DeclGroupMode = 0x3,
35 union { Decl *decl; Decl **DGI; };
40 return (RawVAPtr & Flags) == DeclMode;
43 bool inDeclGroup() const {
44 return (RawVAPtr & Flags) == DeclGroupMode;
47 bool inSizeOfTypeVA() const {
48 return (RawVAPtr & Flags) == SizeOfTypeVAMode;
52 return (RawVAPtr & Flags) == 0;
55 const VariableArrayType *getVAPtr() const {
56 return reinterpret_cast<const VariableArrayType*>(RawVAPtr & ~Flags);
59 void setVAPtr(const VariableArrayType *P) {
60 assert (inDecl() || inDeclGroup() || inSizeOfTypeVA());
61 RawVAPtr = reinterpret_cast<uintptr_t>(P) | (RawVAPtr & Flags);
64 void NextDecl(bool ImmediateAdvance = true);
65 bool HandleDecl(Decl* D);
68 Stmt*& GetDeclExpr() const;
70 StmtIteratorBase(Stmt **s) : stmt(s), decl(0), RawVAPtr(0) {}
71 StmtIteratorBase(Decl *d, Stmt **s);
72 StmtIteratorBase(const VariableArrayType *t);
73 StmtIteratorBase(Decl **dgi, Decl **dge);
74 StmtIteratorBase() : stmt(0), decl(0), RawVAPtr(0) {}
78 template <typename DERIVED, typename REFERENCE>
79 class StmtIteratorImpl : public StmtIteratorBase,
80 public std::iterator<std::forward_iterator_tag,
82 REFERENCE, REFERENCE> {
84 StmtIteratorImpl(const StmtIteratorBase& RHS) : StmtIteratorBase(RHS) {}
87 StmtIteratorImpl(Stmt **s) : StmtIteratorBase(s) {}
88 StmtIteratorImpl(Decl **dgi, Decl **dge) : StmtIteratorBase(dgi, dge) {}
89 StmtIteratorImpl(Decl *d, Stmt **s) : StmtIteratorBase(d, s) {}
90 StmtIteratorImpl(const VariableArrayType *t) : StmtIteratorBase(t) {}
92 DERIVED& operator++() {
100 return static_cast<DERIVED&>(*this);
103 DERIVED operator++(int) {
104 DERIVED tmp = static_cast<DERIVED&>(*this);
109 bool operator==(const DERIVED& RHS) const {
110 return stmt == RHS.stmt && decl == RHS.decl && RawVAPtr == RHS.RawVAPtr;
113 bool operator!=(const DERIVED& RHS) const {
114 return stmt != RHS.stmt || decl != RHS.decl || RawVAPtr != RHS.RawVAPtr;
117 REFERENCE operator*() const {
118 return (REFERENCE) (inStmt() ? *stmt : GetDeclExpr());
121 REFERENCE operator->() const { return operator*(); }
124 struct StmtIterator : public StmtIteratorImpl<StmtIterator,Stmt*&> {
125 explicit StmtIterator() : StmtIteratorImpl<StmtIterator,Stmt*&>() {}
127 StmtIterator(Stmt** S) : StmtIteratorImpl<StmtIterator,Stmt*&>(S) {}
129 StmtIterator(Decl** dgi, Decl** dge)
130 : StmtIteratorImpl<StmtIterator,Stmt*&>(dgi, dge) {}
132 StmtIterator(const VariableArrayType *t)
133 : StmtIteratorImpl<StmtIterator,Stmt*&>(t) {}
135 StmtIterator(Decl* D, Stmt **s = 0)
136 : StmtIteratorImpl<StmtIterator,Stmt*&>(D, s) {}
139 struct ConstStmtIterator : public StmtIteratorImpl<ConstStmtIterator,
141 explicit ConstStmtIterator() :
142 StmtIteratorImpl<ConstStmtIterator,const Stmt*>() {}
144 ConstStmtIterator(const StmtIterator& RHS) :
145 StmtIteratorImpl<ConstStmtIterator,const Stmt*>(RHS) {}
148 /// A range of statement iterators.
150 /// This class provides some extra functionality beyond std::pair
151 /// in order to allow the following idiom:
152 /// for (StmtRange range = stmt->children(); range; ++range)
153 struct StmtRange : std::pair<StmtIterator,StmtIterator> {
155 StmtRange(const StmtIterator &begin, const StmtIterator &end)
156 : std::pair<StmtIterator,StmtIterator>(begin, end) {}
158 bool empty() const { return first == second; }
159 operator bool() const { return !empty(); }
161 Stmt *operator->() const { return first.operator->(); }
162 Stmt *&operator*() const { return first.operator*(); }
164 StmtRange &operator++() {
165 assert(!empty() && "incrementing on empty range");
170 StmtRange operator++(int) {
171 assert(!empty() && "incrementing on empty range");
172 StmtRange copy = *this;
177 friend const StmtIterator &begin(const StmtRange &range) {
180 friend const StmtIterator &end(const StmtRange &range) {
185 /// A range of const statement iterators.
187 /// This class provides some extra functionality beyond std::pair
188 /// in order to allow the following idiom:
189 /// for (ConstStmtRange range = stmt->children(); range; ++range)
190 struct ConstStmtRange : std::pair<ConstStmtIterator,ConstStmtIterator> {
192 ConstStmtRange(const ConstStmtIterator &begin,
193 const ConstStmtIterator &end)
194 : std::pair<ConstStmtIterator,ConstStmtIterator>(begin, end) {}
195 ConstStmtRange(const StmtRange &range)
196 : std::pair<ConstStmtIterator,ConstStmtIterator>(range.first, range.second)
198 ConstStmtRange(const StmtIterator &begin, const StmtIterator &end)
199 : std::pair<ConstStmtIterator,ConstStmtIterator>(begin, end) {}
201 bool empty() const { return first == second; }
202 operator bool() const { return !empty(); }
204 const Stmt *operator->() const { return first.operator->(); }
205 const Stmt *operator*() const { return first.operator*(); }
207 ConstStmtRange &operator++() {
208 assert(!empty() && "incrementing on empty range");
213 ConstStmtRange operator++(int) {
214 assert(!empty() && "incrementing on empty range");
215 ConstStmtRange copy = *this;
220 friend const ConstStmtIterator &begin(const ConstStmtRange &range) {
223 friend const ConstStmtIterator &end(const ConstStmtRange &range) {
228 } // end namespace clang