1 //===- llvm/Support/InstIterator.h - Classes for inst iteration -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains definitions of two iterators for iterating over the
11 // instructions in a function. This is effectively a wrapper around a two level
12 // iterator that can probably be genericized later.
14 // Note that this iterator gets invalidated any time that basic blocks or
15 // instructions are moved around.
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_SUPPORT_INSTITERATOR_H
20 #define LLVM_SUPPORT_INSTITERATOR_H
22 #include "llvm/BasicBlock.h"
23 #include "llvm/Function.h"
27 // This class implements inst_begin() & inst_end() for
28 // inst_iterator and const_inst_iterator's.
30 template <class _BB_t, class _BB_i_t, class _BI_t, class _II_t>
33 typedef _BB_i_t BBIty;
36 _BB_t &BBs; // BasicBlocksType
37 _BB_i_t BB; // BasicBlocksType::iterator
38 _BI_t BI; // BasicBlock::iterator
40 typedef std::bidirectional_iterator_tag iterator_category;
41 typedef IIty value_type;
42 typedef unsigned difference_type;
44 typedef IIty reference;
46 // Copy constructor...
47 template<typename A, typename B, typename C, typename D>
48 InstIterator(const InstIterator<A,B,C,D> &II)
49 : BBs(II.BBs), BB(II.BB), BI(II.BI) {}
51 template<typename A, typename B, typename C, typename D>
52 InstIterator(InstIterator<A,B,C,D> &II)
53 : BBs(II.BBs), BB(II.BB), BI(II.BI) {}
55 template<class M> InstIterator(M &m)
56 : BBs(m.getBasicBlockList()), BB(BBs.begin()) { // begin ctor
57 if (BB != BBs.end()) {
63 template<class M> InstIterator(M &m, bool)
64 : BBs(m.getBasicBlockList()), BB(BBs.end()) { // end ctor
67 // Accessors to get at the underlying iterators...
68 inline BBIty &getBasicBlockIterator() { return BB; }
69 inline BIty &getInstructionIterator() { return BI; }
71 inline IIty operator*() const { return BI; }
72 inline IIty operator->() const { return operator*(); }
74 inline bool operator==(const InstIterator &y) const {
75 return BB == y.BB && (BB == BBs.end() || BI == y.BI);
77 inline bool operator!=(const InstIterator& y) const {
78 return !operator==(y);
81 InstIterator& operator++() {
86 inline InstIterator operator++(int) {
87 InstIterator tmp = *this; ++*this; return tmp;
90 InstIterator& operator--() {
91 while (BB == BBs.end() || BI == BB->begin()) {
98 inline InstIterator operator--(int) {
99 InstIterator tmp = *this; --*this; return tmp;
102 inline bool atEnd() const { return BB == BBs.end(); }
105 inline void advanceToNextBB() {
106 // The only way that the II could be broken is if it is now pointing to
107 // the end() of the current BasicBlock and there are successor BBs.
108 while (BI == BB->end()) {
110 if (BB == BBs.end()) break;
117 typedef InstIterator<iplist<BasicBlock>,
118 Function::iterator, BasicBlock::iterator,
119 Instruction*> inst_iterator;
120 typedef InstIterator<const iplist<BasicBlock>,
121 Function::const_iterator,
122 BasicBlock::const_iterator,
123 const Instruction*> const_inst_iterator;
125 inline inst_iterator inst_begin(Function *F) { return inst_iterator(*F); }
126 inline inst_iterator inst_end(Function *F) { return inst_iterator(*F, true); }
127 inline const_inst_iterator inst_begin(const Function *F) {
128 return const_inst_iterator(*F);
130 inline const_inst_iterator inst_end(const Function *F) {
131 return const_inst_iterator(*F, true);
133 inline inst_iterator inst_begin(Function &F) { return inst_iterator(F); }
134 inline inst_iterator inst_end(Function &F) { return inst_iterator(F, true); }
135 inline const_inst_iterator inst_begin(const Function &F) {
136 return const_inst_iterator(F);
138 inline const_inst_iterator inst_end(const Function &F) {
139 return const_inst_iterator(F, true);
142 } // End llvm namespace