Fixed lint errors:
[oota-llvm.git] / include / llvm / ADT / ilist.h
index f5f2f25a68ea9f513fd1158ac60807808fd2e289..6bfc10009d16b8a15a7b6247c87d4b39de44bcd6 100644 (file)
@@ -1,10 +1,10 @@
 //==-- llvm/ADT/ilist.h - Intrusive Linked List Template ---------*- C++ -*-==//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
 // This file defines classes to implement an intrusive doubly linked list class
@@ -40,7 +40,6 @@
 
 #include "llvm/ADT/iterator.h"
 #include <cassert>
-#include <cstdlib>
 
 namespace llvm {
 
@@ -102,20 +101,32 @@ struct ilist_traits<const Ty> : public ilist_traits<Ty> {};
 template<typename NodeTy>
 class ilist_iterator
   : public bidirectional_iterator<NodeTy, ptrdiff_t> {
-    
+
 public:
   typedef ilist_traits<NodeTy> Traits;
   typedef bidirectional_iterator<NodeTy, ptrdiff_t> super;
 
-  typedef size_t size_type;
+  typedef typename super::value_type value_type;
+  typedef typename super::difference_type difference_type;
   typedef typename super::pointer pointer;
   typedef typename super::reference reference;
 private:
   pointer NodePtr;
 
-  // operator[] is not defined. Compile error instead of having a runtime bug.
-  void operator[](unsigned) {}
-  void operator[](unsigned) const {}
+  // ilist_iterator is not a random-access iterator, but it has an
+  // implicit conversion to pointer-type, which is. Declare (but
+  // don't define) these functions as private to help catch
+  // accidental misuse.
+  void operator[](difference_type) const;
+  void operator+(difference_type) const;
+  void operator-(difference_type) const;
+  void operator+=(difference_type) const;
+  void operator-=(difference_type) const;
+  template<class T> void operator<(T) const;
+  template<class T> void operator<=(T) const;
+  template<class T> void operator>(T) const;
+  template<class T> void operator>=(T) const;
+  template<class T> void operator-(T) const;
 public:
 
   ilist_iterator(pointer NP) : NodePtr(NP) {}
@@ -221,14 +232,14 @@ template<typename From> struct simplify_type;
 
 template<typename NodeTy> struct simplify_type<ilist_iterator<NodeTy> > {
   typedef NodeTy* SimpleType;
-  
+
   static SimpleType getSimplifiedValue(const ilist_iterator<NodeTy> &Node) {
     return &*Node;
   }
 };
 template<typename NodeTy> struct simplify_type<const ilist_iterator<NodeTy> > {
   typedef NodeTy* SimpleType;
-  
+
   static SimpleType getSimplifiedValue(const ilist_iterator<NodeTy> &Node) {
     return &*Node;
   }
@@ -246,16 +257,16 @@ template<typename NodeTy> struct simplify_type<const ilist_iterator<NodeTy> > {
 /// 1. The list may be completely unconstructed.  In this case, the head
 ///    pointer is null.  When in this form, any query for an iterator (e.g.
 ///    begin() or end()) causes the list to transparently change to state #2.
-/// 2. The list may be empty, but contain a sentinal for the end iterator. This
-///    sentinal is created by the Traits::createSentinel method and is a link
+/// 2. The list may be empty, but contain a sentinel for the end iterator. This
+///    sentinel is created by the Traits::createSentinel method and is a link
 ///    in the list.  When the list is empty, the pointer in the iplist points
-///    to the sentinal.  Once the sentinal is constructed, it
+///    to the sentinel.  Once the sentinel is constructed, it
 ///    is not destroyed until the list is.
 /// 3. The list may contain actual objects in it, which are stored as a doubly
 ///    linked list of nodes.  One invariant of the list is that the predecessor
 ///    of the first node in the list always points to the last node in the list,
-///    and the successor pointer for the sentinal (which always stays at the
-///    end of the list) is always null.  
+///    and the successor pointer for the sentinel (which always stays at the
+///    end of the list) is always null.
 ///
 template<typename NodeTy, typename Traits=ilist_traits<NodeTy> >
 class iplist : public Traits {
@@ -265,16 +276,16 @@ class iplist : public Traits {
   // circularly linked list where we snip the 'next' link from the sentinel node
   // back to the first node in the list (to preserve assertions about going off
   // the end of the list).
-  NodeTy *getTail() { return getPrev(Head); }
-  const NodeTy *getTail() const { return getPrev(Head); }
-  void setTail(NodeTy *N) const { setPrev(Head, N); }
-  
-  /// CreateLazySentinal - This method verifies whether the sentinal for the
+  NodeTy *getTail() { return this->getPrev(Head); }
+  const NodeTy *getTail() const { return this->getPrev(Head); }
+  void setTail(NodeTy *N) const { this->setPrev(Head, N); }
+
+  /// CreateLazySentinel - This method verifies whether the sentinel for the
   /// list has been created and lazily makes it if not.
-  void CreateLazySentinal() const {
+  void CreateLazySentinel() const {
     if (Head != 0) return;
     Head = Traits::createSentinel();
-    setNext(Head, 0);
+    this->setNext(Head, 0);
     setTail(Head);
   }
 
@@ -308,19 +319,19 @@ public:
 
   // Iterator creation methods.
   iterator begin() {
-    CreateLazySentinal(); 
-    return iterator(Head); 
+    CreateLazySentinel();
+    return iterator(Head);
   }
   const_iterator begin() const {
-    CreateLazySentinal();
+    CreateLazySentinel();
     return const_iterator(Head);
   }
   iterator end() {
-    CreateLazySentinal();
+    CreateLazySentinel();
     return iterator(getTail());
   }
   const_iterator end() const {
-    CreateLazySentinal();
+    CreateLazySentinel();
     return const_iterator(getTail());
   }
 
@@ -346,54 +357,62 @@ public:
   }
   reference back() {
     assert(!empty() && "Called back() on empty list!");
-    return *getPrev(getTail());
+    return *this->getPrev(getTail());
   }
   const_reference back() const {
     assert(!empty() && "Called back() on empty list!");
-    return *getPrev(getTail());
+    return *this->getPrev(getTail());
   }
 
   void swap(iplist &RHS) {
-    abort();     // Swap does not use list traits callback correctly yet!
+    assert(0 && "Swap does not use list traits callback correctly yet!");
     std::swap(Head, RHS.Head);
   }
 
   iterator insert(iterator where, NodeTy *New) {
-    NodeTy *CurNode = where.getNodePtrUnchecked(), *PrevNode = getPrev(CurNode);
-    setNext(New, CurNode);
-    setPrev(New, PrevNode);
+    NodeTy *CurNode = where.getNodePtrUnchecked();
+    NodeTy *PrevNode = this->getPrev(CurNode);
+    this->setNext(New, CurNode);
+    this->setPrev(New, PrevNode);
 
     if (CurNode != Head)  // Is PrevNode off the beginning of the list?
-      setNext(PrevNode, New);
+      this->setNext(PrevNode, New);
     else
       Head = New;
-    setPrev(CurNode, New);
+    this->setPrev(CurNode, New);
 
-    addNodeToList(New);  // Notify traits that we added a node...
+    this->addNodeToList(New);  // Notify traits that we added a node...
     return New;
   }
 
+  iterator insertAfter(iterator where, NodeTy *New) {
+    if (empty()) 
+      return insert(begin(), New);
+    else
+      return insert(++where, New);
+  }
+
   NodeTy *remove(iterator &IT) {
     assert(IT != end() && "Cannot remove end of list!");
     NodeTy *Node = &*IT;
-    NodeTy *NextNode = getNext(Node);
-    NodeTy *PrevNode = getPrev(Node);
+    NodeTy *NextNode = this->getNext(Node);
+    NodeTy *PrevNode = this->getPrev(Node);
 
     if (Node != Head)  // Is PrevNode off the beginning of the list?
-      setNext(PrevNode, NextNode);
+      this->setNext(PrevNode, NextNode);
     else
       Head = NextNode;
-    setPrev(NextNode, PrevNode);
+    this->setPrev(NextNode, PrevNode);
     IT = NextNode;
-    removeNodeFromList(Node);  // Notify traits that we removed a node...
-    
+    this->removeNodeFromList(Node);  // Notify traits that we removed a node...
+
     // Set the next/prev pointers of the current node to null.  This isn't
     // strictly required, but this catches errors where a node is removed from
     // an ilist (and potentially deleted) with iterators still pointing at it.
     // When those iterators are incremented or decremented, they will assert on
     // the null next/prev pointer instead of "usually working".
-    setNext(Node, 0);
-    setPrev(Node, 0);
+    this->setNext(Node, 0);
+    this->setPrev(Node, 0);
     return Node;
   }
 
@@ -404,7 +423,7 @@ public:
 
   // erase - remove a node from the controlled sequence... and delete it.
   iterator erase(iterator where) {
-    deleteNode(remove(where));
+    this->deleteNode(remove(where));
     return where;
   }
 
@@ -428,10 +447,10 @@ private:
       NodeTy *First = &*first, *Prev = getPrev(First);
       NodeTy *Next = last.getNodePtrUnchecked(), *Last = getPrev(Next);
       if (Prev)
-        setNext(Prev, Next);
+        this->setNext(Prev, Next);
       else
         L2.Head = Next;
-      setPrev(Next, Prev);
+      this->setPrev(Next, Prev);
 
       // Splice [first, last) into its new position.
       NodeTy *PosNext = position.getNodePtrUnchecked();
@@ -439,18 +458,18 @@ private:
 
       // Fix head of list...
       if (PosPrev)
-        setNext(PosPrev, First);
+        this->setNext(PosPrev, First);
       else
         Head = First;
-      setPrev(First, PosPrev);
+      this->setPrev(First, PosPrev);
 
       // Fix end of list...
-      setNext(Last, PosNext);
-      setPrev(PosNext, Last);
+      this->setNext(Last, PosNext);
+      this->setPrev(PosNext, Last);
 
       transferNodesFromList(L2, First, PosNext);
 
-      // Now that everything is set, restore the pointers to the list sentinals.
+      // Now that everything is set, restore the pointers to the list sentinels.
       L2.setTail(L2Sentinel);
       setTail(ThisSentinel);
     }
@@ -463,7 +482,7 @@ public:
   //
 
   size_type size() const {
-    if (Head == 0) return 0; // Don't require construction of sentinal if empty.
+    if (Head == 0) return 0; // Don't require construction of sentinel if empty.
 #if __GNUC__ == 2
     // GCC 2.95 has a broken std::distance
     size_type Result = 0;
@@ -581,7 +600,7 @@ struct ilist : public iplist<NodeTy> {
   }
   explicit ilist(size_type count) {
     insert(this->begin(), count, NodeTy());
-  } 
+  }
   ilist(size_type count, const NodeTy &val) {
     insert(this->begin(), count, val);
   }
@@ -596,7 +615,7 @@ struct ilist : public iplist<NodeTy> {
   iterator insert(iterator a, NodeTy *b){ return iplist<NodeTy>::insert(a, b); }
   void push_front(NodeTy *a) { iplist<NodeTy>::push_front(a); }
   void push_back(NodeTy *a)  { iplist<NodeTy>::push_back(a); }
-  
+
 
   // Main implementation here - Insert for a node passed by value...
   iterator insert(iterator where, const NodeTy &val) {