Add a missing .
[oota-llvm.git] / include / llvm / Use.h
index fb5eafb7122c00e5a02d57aba14a78967f1d7540..c88d41f700544007ad8dd1cbf0778c58f3efb66d 100644 (file)
@@ -1,10 +1,10 @@
 //===-- llvm/Use.h - Definition of the Use class ----------------*- C++ -*-===//
-// 
+//
 //                     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 defines the Use class.  The Use class represents the operand of an
 #ifndef LLVM_USE_H
 #define LLVM_USE_H
 
-#include "Support/ilist"
+#include "llvm/Support/Casting.h"
+#include "llvm/ADT/iterator"
 
 namespace llvm {
 
-template<typename NodeTy> struct ilist_traits;
 class Value;
 class User;
 
@@ -32,15 +32,18 @@ class User;
 // Use is here to make keeping the "use" list of a Value up-to-date really easy.
 //
 class Use {
-  Value *Val;
-  User *U;
-  Use *Prev, *Next;
-  friend class ilist_traits<Use>;
 public:
-  inline Use(Value *v, User *user);
-  inline Use(const Use &u);
+  inline void init(Value *V, User *U);
+
+  Use(Value *V, User *U) { init(V, U); }
+  Use(const Use &U) { init(U.Val, U.U); }
   inline ~Use();
 
+  /// Default ctor - This leaves the Use completely unitialized.  The only thing
+  /// that is valid to do with this use is to call the "init" method.
+  inline Use() : Val(0) {}
+
+
   operator Value*() const { return Val; }
   Value *get() const { return Val; }
   User *getUser() const { return U; }
@@ -58,28 +61,29 @@ public:
 
         Value *operator->()       { return Val; }
   const Value *operator->() const { return Val; }
-};
 
-template<>
-struct ilist_traits<Use> {
-  static Use *getPrev(Use *N) { return N->Prev; }
-  static Use *getNext(Use *N) { return N->Next; }
-  static const Use *getPrev(const Use *N) { return N->Prev; }
-  static const Use *getNext(const Use *N) { return N->Next; }
-  static void setPrev(Use *N, Use *Prev) { N->Prev = Prev; }
-  static void setNext(Use *N, Use *Next) { N->Next = Next; }
-
-  // createNode - this is used to create the end marker for the use list
-  static Use *createNode() { return new Use(0,0); }
-
-  void addNodeToList(Use *NTy) {}
-  void removeNodeFromList(Use *NTy) {}
-  void transferNodesFromList(iplist<Use, ilist_traits> &L2,
-                             ilist_iterator<Use> first,
-                             ilist_iterator<Use> last) {}
-};
+  Use *getNext() const { return Next; }
+private:
+  Use *Next, **Prev;
+  Value *Val;
+  User *U;
+
+  void addToList(Use **List) {
+    Next = *List;
+    if (Next) Next->Prev = &Next;
+    Prev = List;
+    *List = this;
+  }
+  void removeFromList() {
+    *Prev = Next;
+    if (Next) Next->Prev = Prev;
+  }
 
+  friend class Value;
+};
 
+// simplify_type - Allow clients to treat uses just like values when using
+// casting operators.
 template<> struct simplify_type<Use> {
   typedef Value* SimpleType;
   static SimpleType getSimplifiedValue(const Use &Val) {
@@ -93,66 +97,80 @@ template<> struct simplify_type<const Use> {
   }
 };
 
-struct UseListIteratorWrapper : public iplist<Use>::iterator {
-  typedef iplist<Use>::iterator Super;
-  UseListIteratorWrapper() {}
-  UseListIteratorWrapper(const Super &RHS) : Super(RHS) {}
 
-  UseListIteratorWrapper &operator=(const Super &RHS) {
-    Super::operator=(RHS);
-    return *this;
-  }
 
-  inline User *operator*() const;
-  User *operator->() const { return operator*(); }
+template<typename UserTy>  // UserTy == 'User' or 'const User'
+class value_use_iterator : public forward_iterator<UserTy*, ptrdiff_t> {
+  typedef forward_iterator<UserTy*, ptrdiff_t> super;
+  typedef value_use_iterator<UserTy> _Self;
+
+  Use *U;
+  value_use_iterator(Use *u) : U(u) {}
+  friend class Value;
+public:
+  typedef typename super::reference reference;
+  typedef typename super::pointer pointer;
 
-  UseListIteratorWrapper operator--() { return Super::operator--(); }
-  UseListIteratorWrapper operator++() { return Super::operator++(); }
+  value_use_iterator(const _Self &I) : U(I.U) {}
+  value_use_iterator() {}
 
-  UseListIteratorWrapper operator--(int) {    // postdecrement operators...
-    UseListIteratorWrapper tmp = *this;
-    --*this;
-    return tmp;
+  bool operator==(const _Self &x) const {
+    return U == x.U;
   }
-  UseListIteratorWrapper operator++(int) {    // postincrement operators...
-    UseListIteratorWrapper tmp = *this;
-    ++*this;
-    return tmp;
+  bool operator!=(const _Self &x) const {
+    return !operator==(x);
   }
-};
 
-struct UseListConstIteratorWrapper : public iplist<Use>::const_iterator {
-  typedef iplist<Use>::const_iterator Super;
-  UseListConstIteratorWrapper() {}
-  UseListConstIteratorWrapper(const Super &RHS) : Super(RHS) {}
-
-  // Allow conversion from non-const to const iterators
-  UseListConstIteratorWrapper(const UseListIteratorWrapper &RHS) : Super(RHS) {}
-  UseListConstIteratorWrapper(const iplist<Use>::iterator &RHS) : Super(RHS) {}
-
-  UseListConstIteratorWrapper &operator=(const Super &RHS) {
-    Super::operator=(RHS);
+  // Iterator traversal: forward iteration only
+  _Self &operator++() {          // Preincrement
+    assert(U && "Cannot increment end iterator!");
+    U = U->getNext();
     return *this;
   }
+  _Self operator++(int) {        // Postincrement
+    _Self tmp = *this; ++*this; return tmp;
+  }
 
-  inline const User *operator*() const;
-  const User *operator->() const { return operator*(); }
+  // Retrieve a reference to the current SCC
+  UserTy *operator*() const {
+    assert(U && "Cannot increment end iterator!");
+    return U->getUser();
+  }
 
-  UseListConstIteratorWrapper operator--() { return Super::operator--(); }
-  UseListConstIteratorWrapper operator++() { return Super::operator++(); }
+  UserTy *operator->() const { return operator*(); }
 
-  UseListConstIteratorWrapper operator--(int) {    // postdecrement operators...
-    UseListConstIteratorWrapper tmp = *this;
-    --*this;
-    return tmp;
+  Use &getUse() const { return *U; }
+  
+  /// getOperandNo - Return the operand # of this use in its User.  Defined in
+  /// User.h
+  ///
+  unsigned getOperandNo() const;
+};
+
+
+template<> struct simplify_type<value_use_iterator<User> > {
+  typedef User* SimpleType;
+  
+  static SimpleType getSimplifiedValue(const value_use_iterator<User> &Val) {
+    return *Val;
   }
-  UseListConstIteratorWrapper operator++(int) {    // postincrement operators...
-    UseListConstIteratorWrapper tmp = *this;
-    ++*this;
-    return tmp;
+};
+
+template<> struct simplify_type<const value_use_iterator<User> >
+ : public simplify_type<value_use_iterator<User> > {};
+
+template<> struct simplify_type<value_use_iterator<const User> > {
+  typedef const User* SimpleType;
+  
+  static SimpleType getSimplifiedValue(const 
+                                       value_use_iterator<const User> &Val) {
+    return *Val;
   }
 };
 
+template<> struct simplify_type<const value_use_iterator<const User> >
+  : public simplify_type<value_use_iterator<const User> > {};
+
 } // End llvm namespace
 
 #endif