Add some out-of-line virtual dtors so that the class has a "home", preventing
[oota-llvm.git] / include / llvm / ADT / PostOrderIterator.h
index 178125405ed8469d63834c269a3c905b2522fa2f..16f086577417c372f0a8be021463ebeebe14d321 100644 (file)
@@ -1,26 +1,53 @@
-//===-- Support/PostOrderIterator.h - Generic PostOrder iterator -*- C++ -*--=//
+//===- llvm/ADT/PostOrderIterator.h - PostOrder iterator --------*- C++ -*-===//
 //
-// This file builds on the Support/GraphTraits.h file to build a generic graph
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file builds on the ADT/GraphTraits.h file to build a generic graph
 // post order iterator.  This should work over any graph type that has a
 // GraphTraits specialization.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SUPPORT_POSTORDERITERATOR_H
-#define SUPPORT_POSTORDERITERATOR_H
+#ifndef LLVM_ADT_POSTORDERITERATOR_H
+#define LLVM_ADT_POSTORDERITERATOR_H
 
-#include "Support/GraphTraits.h"
-#include "Support/iterator"
+#include "llvm/ADT/GraphTraits.h"
+#include "llvm/ADT/iterator"
 #include <stack>
 #include <set>
-
-template<class GraphT, class GT = GraphTraits<GraphT> >
-class po_iterator : public forward_iterator<typename GT::NodeType, ptrdiff_t> {
+#include <vector>
+
+namespace llvm {
+
+template<class SetType, bool External>   // Non-external set 
+class po_iterator_storage { 
+public: 
+  SetType Visited; 
+}; 
+
+template<class SetType> 
+class po_iterator_storage<SetType, true> { 
+public: 
+  po_iterator_storage(SetType &VSet) : Visited(VSet) {} 
+  po_iterator_storage(const po_iterator_storage &S) : Visited(S.Visited) {} 
+  SetType &Visited; 
+}; 
+
+template<class GraphT, 
+        class SetType = std::set<typename GraphTraits<GraphT>::NodeType*>, 
+        bool ExtStorage = false, 
+        class GT = GraphTraits<GraphT> > 
+class po_iterator : public forward_iterator<typename GT::NodeType, ptrdiff_t>, 
+                    public po_iterator_storage<SetType, ExtStorage> { 
   typedef forward_iterator<typename GT::NodeType, ptrdiff_t> super;
   typedef typename GT::NodeType          NodeType;
   typedef typename GT::ChildIteratorType ChildItTy;
-
-  std::set<NodeType *> Visited;    // All of the blocks visited so far...
+  
   // VisitStack - Used to maintain the ordering.  Top = current block
   // First element is basic block pointer, second is the 'next child' to visit
   std::stack<std::pair<NodeType *, ChildItTy> > VisitStack;
@@ -28,33 +55,51 @@ class po_iterator : public forward_iterator<typename GT::NodeType, ptrdiff_t> {
   void traverseChild() {
     while (VisitStack.top().second != GT::child_end(VisitStack.top().first)) {
       NodeType *BB = *VisitStack.top().second++;
-      if (!Visited.count(BB)) {  // If the block is not visited...
-       Visited.insert(BB);
-       VisitStack.push(make_pair(BB, GT::child_begin(BB)));
+      if (!this->Visited.count(BB)) {  // If the block is not visited...
+        this->Visited.insert(BB);
+        VisitStack.push(std::make_pair(BB, GT::child_begin(BB)));
       }
     }
   }
 
   inline po_iterator(NodeType *BB) {
-    Visited.insert(BB);
-    VisitStack.push(make_pair(BB, GT::child_begin(BB)));
+    this->Visited.insert(BB);
+    VisitStack.push(std::make_pair(BB, GT::child_begin(BB)));
     traverseChild();
   }
-  inline po_iterator() { /* End is when stack is empty */ }
+  inline po_iterator() {} // End is when stack is empty. 
+     
+  inline po_iterator(NodeType *BB, SetType &S) : 
+    po_iterator_storage<SetType, ExtStorage>(&S) { 
+    if(!S.count(BB)) { 
+      this->Visited.insert(BB); 
+      VisitStack.push(std::make_pair(BB, GT::child_begin(BB))); 
+      traverseChild(); 
+    } 
+  } 
+  inline po_iterator(SetType &S) : 
+      po_iterator_storage<SetType, ExtStorage>(&S) {
+  } // End is when stack is empty. 
 public:
   typedef typename super::pointer pointer;
-  typedef po_iterator<GraphT, GT> _Self;
+  typedef po_iterator<GraphT, SetType, ExtStorage, GT> _Self; 
 
   // Provide static "constructors"...
   static inline _Self begin(GraphT G) { return _Self(GT::getEntryNode(G)); }
   static inline _Self end  (GraphT G) { return _Self(); }
 
-  inline bool operator==(const _Self& x) const { 
+  static inline _Self begin(GraphT G, SetType &S) { 
+    return _Self(GT::getEntryNode(G), S); 
+  } 
+  static inline _Self end  (GraphT G, SetType &S) { return _Self(S); } 
+  
+  inline bool operator==(const _Self& x) const {
     return VisitStack == x.VisitStack;
   }
   inline bool operator!=(const _Self& x) const { return !operator==(x); }
 
-  inline pointer operator*() const { 
+  inline pointer operator*() const {
     return VisitStack.top().first;
   }
 
@@ -68,11 +113,11 @@ public:
     VisitStack.pop();
     if (!VisitStack.empty())
       traverseChild();
-    return *this; 
+    return *this;
   }
 
   inline _Self operator++(int) { // Postincrement
-    _Self tmp = *this; ++*this; return tmp; 
+    _Self tmp = *this; ++*this; return tmp;
   }
 };
 
@@ -83,10 +128,30 @@ po_iterator<T> po_begin(T G) { return po_iterator<T>::begin(G); }
 template <class T>
 po_iterator<T> po_end  (T G) { return po_iterator<T>::end(G); }
 
+// Provide global definitions of external postorder iterators... 
+template<class T, class SetType=std::set<typename GraphTraits<T>::NodeType*> > 
+struct po_ext_iterator : public po_iterator<T, SetType, true> { 
+  po_ext_iterator(const po_iterator<T, SetType, true> &V) :  
+  po_iterator<T, SetType, true>(V) {} 
+}; 
+template<class T, class SetType> 
+po_ext_iterator<T, SetType> po_ext_begin(T G, SetType &S) { 
+  return po_ext_iterator<T, SetType>::begin(G, S); 
+} 
+
+template<class T, class SetType> 
+po_ext_iterator<T, SetType> po_ext_end(T G, SetType &S) { 
+  return po_ext_iterator<T, SetType>::end(G, S); 
+} 
+
 // Provide global definitions of inverse post order iterators...
-template <class T>
-struct ipo_iterator : public po_iterator<Inverse<T> > {
-  ipo_iterator(const po_iterator<Inverse<T> > &V) :po_iterator<Inverse<T> >(V){}
+template <class T, 
+          class SetType = std::set<typename GraphTraits<T>::NoddeType*>,  
+          bool External = false> 
+struct ipo_iterator : public po_iterator<Inverse<T>, SetType, External > { 
+  ipo_iterator(const po_iterator<Inverse<T>, SetType, External> &V) : 
+     po_iterator<Inverse<T>, SetType, External> (V) {} 
 };
 
 template <class T>
@@ -99,17 +164,35 @@ ipo_iterator<T> ipo_end(T G){
   return ipo_iterator<T>::end(G);
 }
 
+//Provide global definitions of external inverse postorder iterators... 
+template <class T, class SetType = std::set<typename GraphTraits<T>::NodeType*> > 
+struct ipo_ext_iterator : public ipo_iterator<T, SetType, true> { 
+  ipo_ext_iterator(const ipo_iterator<T, SetType, true> &V) : 
+    ipo_iterator<T, SetType, true>(&V) {} 
+  ipo_ext_iterator(const po_iterator<Inverse<T>, SetType, true> &V) : 
+    ipo_iterator<T, SetType, true>(&V) {} 
+}; 
+
+template <class T, class SetType> 
+ipo_ext_iterator<T, SetType> ipo_ext_begin(T G, SetType &S) { 
+  return ipo_ext_iterator<T, SetType>::begin(G, S); 
+} 
+
+template <class T, class SetType> 
+ipo_ext_iterator<T, SetType> ipo_ext_end(T G, SetType &S) { 
+  return ipo_ext_iterator<T, SetType>::end(G, S); 
+} 
 
 //===--------------------------------------------------------------------===//
 // Reverse Post Order CFG iterator code
 //===--------------------------------------------------------------------===//
-// 
+//
 // This is used to visit basic blocks in a method in reverse post order.  This
 // class is awkward to use because I don't know a good incremental algorithm to
-// computer RPO from a graph.  Because of this, the construction of the 
+// computer RPO from a graph.  Because of this, the construction of the
 // ReversePostOrderTraversal object is expensive (it must walk the entire graph
 // with a postorder iterator to build the data structures).  The moral of this
-// story is: Don't create more ReversePostOrderTraversal classes than neccesary.
+// story is: Don't create more ReversePostOrderTraversal classes than necessary.
 //
 // This class should be used like this:
 // {
@@ -142,4 +225,6 @@ public:
   inline rpo_iterator end()   { return Blocks.rend(); }
 };
 
+} // End llvm namespace
+
 #endif