X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FADT%2Filist.h;h=b95e3e04e81f0ecf4bcaebf0cffed1ccada75942;hb=e1b469170bb3ab259fd488fb95c29efe802cdd6a;hp=9700b60f2401f4b126621fe703a4afe239d24b2b;hpb=9ff0f0ea39ea71d33887584d10c88dda2038285b;p=oota-llvm.git diff --git a/include/llvm/ADT/ilist.h b/include/llvm/ADT/ilist.h index 9700b60f240..b95e3e04e81 100644 --- a/include/llvm/ADT/ilist.h +++ b/include/llvm/ADT/ilist.h @@ -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,17 +40,17 @@ #include "llvm/ADT/iterator.h" #include -#include namespace llvm { template class iplist; template class ilist_iterator; -// Template traits for intrusive list. By specializing this template class, you -// can change what next/prev fields are used to store the links... +/// ilist_nextprev_traits - A fragment for template traits for intrusive list +/// that provides default next/prev implementations for common operations. +/// template -struct ilist_traits { +struct ilist_nextprev_traits { static NodeTy *getPrev(NodeTy *N) { return N->getPrev(); } static NodeTy *getNext(NodeTy *N) { return N->getNext(); } static const NodeTy *getPrev(const NodeTy *N) { return N->getPrev(); } @@ -58,39 +58,115 @@ struct ilist_traits { static void setPrev(NodeTy *N, NodeTy *Prev) { N->setPrev(Prev); } static void setNext(NodeTy *N, NodeTy *Next) { N->setNext(Next); } +}; - static NodeTy *createNode(const NodeTy &V) { return new NodeTy(V); } +template +struct ilist_traits; +/// ilist_sentinel_traits - A fragment for template traits for intrusive list +/// that provides default sentinel implementations for common operations. +/// +/// ilist_sentinel_traits implements a lazy dynamic sentinel allocation +/// strategy. The sentinel is stored in the prev field of ilist's Head. +/// +template +struct ilist_sentinel_traits { + /// createSentinel - create the dynamic sentinel static NodeTy *createSentinel() { return new NodeTy(); } + + /// destroySentinel - deallocate the dynamic sentinel static void destroySentinel(NodeTy *N) { delete N; } - void addNodeToList(NodeTy *NTy) {} - void removeNodeFromList(NodeTy *NTy) {} - void transferNodesFromList(iplist &L2, - ilist_iterator first, - ilist_iterator last) {} + /// provideInitialHead - when constructing an ilist, provide a starting + /// value for its Head + /// @return null node to indicate that it needs to be allocated later + static NodeTy *provideInitialHead() { return 0; } + + /// ensureHead - make sure that Head is either already + /// initialized or assigned a fresh sentinel + /// @return the sentinel + static NodeTy *ensureHead(NodeTy *&Head) { + if (!Head) { + Head = ilist_traits::createSentinel(); + ilist_traits::noteHead(Head, Head); + ilist_traits::setNext(Head, 0); + return Head; + } + return ilist_traits::getPrev(Head); + } + + /// noteHead - stash the sentinel into its default location + static void noteHead(NodeTy *NewHead, NodeTy *Sentinel) { + ilist_traits::setPrev(NewHead, Sentinel); + } +}; + +/// ilist_node_traits - A fragment for template traits for intrusive list +/// that provides default node related operations. +/// +template +struct ilist_node_traits { + static NodeTy *createNode(const NodeTy &V) { return new NodeTy(V); } + static void deleteNode(NodeTy *V) { delete V; } + + void addNodeToList(NodeTy *) {} + void removeNodeFromList(NodeTy *) {} + void transferNodesFromList(ilist_node_traits & /*SrcTraits*/, + ilist_iterator /*first*/, + ilist_iterator /*last*/) {} +}; + +/// ilist_default_traits - Default template traits for intrusive list. +/// By inheriting from this, you can easily use default implementations +/// for all common operations. +/// +template +struct ilist_default_traits : ilist_nextprev_traits, + ilist_sentinel_traits, + ilist_node_traits { }; +// Template traits for intrusive list. By specializing this template class, you +// can change what next/prev fields are used to store the links... +template +struct ilist_traits : ilist_default_traits {}; + // Const traits are the same as nonconst traits... template struct ilist_traits : public ilist_traits {}; - //===----------------------------------------------------------------------===// // ilist_iterator - Iterator for intrusive list. // template class ilist_iterator : public bidirectional_iterator { + +public: typedef ilist_traits Traits; typedef bidirectional_iterator super; -public: - 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; + + // 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 void operator<(T) const; + template void operator<=(T) const; + template void operator>(T) const; + template void operator>=(T) const; + template void operator-(T) const; public: ilist_iterator(pointer NP) : NodePtr(NP) {} @@ -121,8 +197,7 @@ public: assert(Traits::getNext(NodePtr) != 0 && "Dereferencing end()!"); return *NodePtr; } - pointer operator->() { return &operator*(); } - const pointer operator->() const { return &operator*(); } + pointer operator->() const { return &operator*(); } // Comparison operators bool operator==(const ilist_iterator &RHS) const { @@ -135,7 +210,7 @@ public: // Increment and decrement operators... ilist_iterator &operator--() { // predecrement - Back up NodePtr = Traits::getPrev(NodePtr); - assert(Traits::getNext(NodePtr) && "--'d off the beginning of an ilist!"); + assert(NodePtr && "--'d off the beginning of an ilist!"); return *this; } ilist_iterator &operator++() { // preincrement - Advance @@ -197,14 +272,14 @@ template struct simplify_type; template struct simplify_type > { typedef NodeTy* SimpleType; - + static SimpleType getSimplifiedValue(const ilist_iterator &Node) { return &*Node; } }; template struct simplify_type > { typedef NodeTy* SimpleType; - + static SimpleType getSimplifiedValue(const ilist_iterator &Node) { return &*Node; } @@ -222,16 +297,16 @@ template struct simplify_type > { /// 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 > class iplist : public Traits { @@ -241,17 +316,14 @@ 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->ensureHead(Head); } + const NodeTy *getTail() const { return this->ensureHead(Head); } + void setTail(NodeTy *N) const { this->noteHead(Head, N); } + + /// CreateLazySentinel - This method verifies whether the sentinel for the /// list has been created and lazily makes it if not. - void CreateLazySentinal() const { - if (Head != 0) return; - Head = Traits::createSentinel(); - setNext(Head, 0); - setTail(Head); + void CreateLazySentinel() const { + this->Traits::ensureHead(Head); } static bool op_less(NodeTy &L, NodeTy &R) { return L < R; } @@ -275,7 +347,7 @@ public: typedef std::reverse_iterator const_reverse_iterator; typedef std::reverse_iterator reverse_iterator; - iplist() : Head(0) {} + iplist() : Head(this->Traits::provideInitialHead()) {} ~iplist() { if (!Head) return; clear(); @@ -284,19 +356,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()); } @@ -322,54 +394,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; } @@ -380,7 +460,7 @@ public: // erase - remove a node from the controlled sequence... and delete it. iterator erase(iterator where) { - delete remove(where); + this->deleteNode(remove(where)); return where; } @@ -401,32 +481,32 @@ private: L2.setTail(0); // Remove [first, last) from its old position. - NodeTy *First = &*first, *Prev = getPrev(First); - NodeTy *Next = last.getNodePtrUnchecked(), *Last = getPrev(Next); + NodeTy *First = &*first, *Prev = this->getPrev(First); + NodeTy *Next = last.getNodePtrUnchecked(), *Last = this->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(); - NodeTy *PosPrev = getPrev(PosNext); + NodeTy *PosPrev = this->getPrev(PosNext); // 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); + this->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); } @@ -439,15 +519,8 @@ public: // size_type size() const { - if (Head == 0) return 0; // Don't require construction of sentinal if empty. -#if __GNUC__ == 2 - // GCC 2.95 has a broken std::distance - size_type Result = 0; - std::distance(begin(), end(), Result); - return Result; -#else + if (Head == 0) return 0; // Don't require construction of sentinel if empty. return std::distance(begin(), end()); -#endif } iterator erase(iterator first, iterator last) { @@ -557,7 +630,7 @@ struct ilist : public iplist { } explicit ilist(size_type count) { insert(this->begin(), count, NodeTy()); - } + } ilist(size_type count, const NodeTy &val) { insert(this->begin(), count, val); } @@ -565,14 +638,10 @@ struct ilist : public iplist { insert(this->begin(), first, last); } - - // Forwarding functions: A workaround for GCC 2.95 which does not correctly - // support 'using' declarations to bring a hidden member into scope. - // - iterator insert(iterator a, NodeTy *b){ return iplist::insert(a, b); } - void push_front(NodeTy *a) { iplist::push_front(a); } - void push_back(NodeTy *a) { iplist::push_back(a); } - + // bring hidden functions into scope + using iplist::insert; + using iplist::push_front; + using iplist::push_back; // Main implementation here - Insert for a node passed by value... iterator insert(iterator where, const NodeTy &val) {