include/llvm/ADT/ilist.h

   1 //==-- llvm/ADT/ilist.h - Intrusive Linked List Template ---------*- C++ -*-==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines classes to implement an intrusive doubly linked list class
  11 // (i.e. each node of the list must contain a next and previous field for the
  12 // list.
  13 //
  14 // The ilist_traits trait class is used to gain access to the next and previous
  15 // fields of the node type that the list is instantiated with.  If it is not
  16 // specialized, the list defaults to using the getPrev(), getNext() method calls
  17 // to get the next and previous pointers.
  18 //
  19 // The ilist class itself, should be a plug in replacement for list, assuming
  20 // that the nodes contain next/prev pointers.  This list replacement does not
  21 // provide a constant time size() method, so be careful to use empty() when you
  22 // really want to know if it's empty.
  23 //
  24 // The ilist class is implemented by allocating a 'tail' node when the list is
  25 // created (using ilist_traits<>::createSentinel()).  This tail node is
  26 // absolutely required because the user must be able to compute end()-1. Because
  27 // of this, users of the direct next/prev links will see an extra link on the
  28 // end of the list, which should be ignored.
  29 //
  30 // Requirements for a user of this list:
  31 //
  32 //   1. The user must provide {g|s}et{Next|Prev} methods, or specialize
  33 //      ilist_traits to provide an alternate way of getting and setting next and
  34 //      prev links.
  35 //
  36 //===----------------------------------------------------------------------===//
  37
  38 #ifndef LLVM_ADT_ILIST_H
  39 #define LLVM_ADT_ILIST_H
  40
  41 #include "llvm/ADT/iterator.h"
  42 #include <cassert>
  43 #include <cstdlib>
  44
  45 namespace llvm {
  46
  47 template<typename NodeTy, typename Traits> class iplist;
  48 template<typename NodeTy> class ilist_iterator;
  49
  50 // Template traits for intrusive list.  By specializing this template class, you
  51 // can change what next/prev fields are used to store the links...
  52 template<typename NodeTy>
  53 struct ilist_traits {
  54   static NodeTy *getPrev(NodeTy *N) { return N->getPrev(); }
  55   static NodeTy *getNext(NodeTy *N) { return N->getNext(); }
  56   static const NodeTy *getPrev(const NodeTy *N) { return N->getPrev(); }
  57   static const NodeTy *getNext(const NodeTy *N) { return N->getNext(); }
  58
  59   static void setPrev(NodeTy *N, NodeTy *Prev) { N->setPrev(Prev); }
  60   static void setNext(NodeTy *N, NodeTy *Next) { N->setNext(Next); }
  61
  62   static NodeTy *createNode(const NodeTy &V) { return new NodeTy(V); }
  63   static void deleteNode(NodeTy *V) { delete V; }
  64
  65   static NodeTy *createSentinel() { return new NodeTy(); }
  66   static void destroySentinel(NodeTy *N) { delete N; }
  67
  68   void addNodeToList(NodeTy *NTy) {}
  69   void removeNodeFromList(NodeTy *NTy) {}
  70   void transferNodesFromList(iplist<NodeTy, ilist_traits> &L2,
  71                              ilist_iterator<NodeTy> first,
  72                              ilist_iterator<NodeTy> last) {}
  73 };
  74
  75 // Const traits are the same as nonconst traits...
  76 template<typename Ty>
  77 struct ilist_traits<const Ty> : public ilist_traits<Ty> {};
  78
  79
  80 //===----------------------------------------------------------------------===//
  81 // ilist_iterator<Node> - Iterator for intrusive list.
  82 //
  83 template<typename NodeTy>
  84 class ilist_iterator
  85   : public bidirectional_iterator<NodeTy, ptrdiff_t> {
  86
  87 public:
  88   typedef ilist_traits<NodeTy> Traits;
  89   typedef bidirectional_iterator<NodeTy, ptrdiff_t> super;
  90
  91   typedef size_t size_type;
  92   typedef typename super::pointer pointer;
  93   typedef typename super::reference reference;
  94 private:
  95   pointer NodePtr;
  96
  97   // operator[] is not defined. Compile error instead of having a runtime bug.
  98   void operator[](unsigned) {}
  99   void operator[](unsigned) const {}
 100 public:
 101
 102   ilist_iterator(pointer NP) : NodePtr(NP) {}
 103   ilist_iterator(reference NR) : NodePtr(&NR) {}
 104   ilist_iterator() : NodePtr(0) {}
 105
 106   // This is templated so that we can allow constructing a const iterator from
 107   // a nonconst iterator...
 108   template<class node_ty>
 109   ilist_iterator(const ilist_iterator<node_ty> &RHS)
 110     : NodePtr(RHS.getNodePtrUnchecked()) {}
 111
 112   // This is templated so that we can allow assigning to a const iterator from
 113   // a nonconst iterator...
 114   template<class node_ty>
 115   const ilist_iterator &operator=(const ilist_iterator<node_ty> &RHS) {
 116     NodePtr = RHS.getNodePtrUnchecked();
 117     return *this;
 118   }
 119
 120   // Accessors...
 121   operator pointer() const {
 122     assert(Traits::getNext(NodePtr) != 0 && "Dereferencing end()!");
 123     return NodePtr;
 124   }
 125
 126   reference operator*() const {
 127     assert(Traits::getNext(NodePtr) != 0 && "Dereferencing end()!");
 128     return *NodePtr;
 129   }
 130   pointer operator->() const { return &operator*(); }
 131
 132   // Comparison operators
 133   bool operator==(const ilist_iterator &RHS) const {
 134     return NodePtr == RHS.NodePtr;
 135   }
 136   bool operator!=(const ilist_iterator &RHS) const {
 137     return NodePtr != RHS.NodePtr;
 138   }
 139
 140   // Increment and decrement operators...
 141   ilist_iterator &operator--() {      // predecrement - Back up
 142     NodePtr = Traits::getPrev(NodePtr);
 143     assert(Traits::getNext(NodePtr) && "--'d off the beginning of an ilist!");
 144     return *this;
 145   }
 146   ilist_iterator &operator++() {      // preincrement - Advance
 147     NodePtr = Traits::getNext(NodePtr);
 148     assert(NodePtr && "++'d off the end of an ilist!");
 149     return *this;
 150   }
 151   ilist_iterator operator--(int) {    // postdecrement operators...
 152     ilist_iterator tmp = *this;
 153     --*this;
 154     return tmp;
 155   }
 156   ilist_iterator operator++(int) {    // postincrement operators...
 157     ilist_iterator tmp = *this;
 158     ++*this;
 159     return tmp;
 160   }
 161
 162   // Internal interface, do not use...
 163   pointer getNodePtrUnchecked() const { return NodePtr; }
 164 };
 165
 166 // do not implement. this is to catch errors when people try to use
 167 // them as random access iterators
 168 template<typename T>
 169 void operator-(int, ilist_iterator<T>);
 170 template<typename T>
 171 void operator-(ilist_iterator<T>,int);
 172
 173 template<typename T>
 174 void operator+(int, ilist_iterator<T>);
 175 template<typename T>
 176 void operator+(ilist_iterator<T>,int);
 177
 178 // operator!=/operator== - Allow mixed comparisons without dereferencing
 179 // the iterator, which could very likely be pointing to end().
 180 template<typename T>
 181 bool operator!=(const T* LHS, const ilist_iterator<const T> &RHS) {
 182   return LHS != RHS.getNodePtrUnchecked();
 183 }
 184 template<typename T>
 185 bool operator==(const T* LHS, const ilist_iterator<const T> &RHS) {
 186   return LHS == RHS.getNodePtrUnchecked();
 187 }
 188 template<typename T>
 189 bool operator!=(T* LHS, const ilist_iterator<T> &RHS) {
 190   return LHS != RHS.getNodePtrUnchecked();
 191 }
 192 template<typename T>
 193 bool operator==(T* LHS, const ilist_iterator<T> &RHS) {
 194   return LHS == RHS.getNodePtrUnchecked();
 195 }
 196
 197
 198 // Allow ilist_iterators to convert into pointers to a node automatically when
 199 // used by the dyn_cast, cast, isa mechanisms...
 200
 201 template<typename From> struct simplify_type;
 202
 203 template<typename NodeTy> struct simplify_type<ilist_iterator<NodeTy> > {
 204   typedef NodeTy* SimpleType;
 205
 206   static SimpleType getSimplifiedValue(const ilist_iterator<NodeTy> &Node) {
 207     return &*Node;
 208   }
 209 };
 210 template<typename NodeTy> struct simplify_type<const ilist_iterator<NodeTy> > {
 211   typedef NodeTy* SimpleType;
 212
 213   static SimpleType getSimplifiedValue(const ilist_iterator<NodeTy> &Node) {
 214     return &*Node;
 215   }
 216 };
 217
 218
 219 //===----------------------------------------------------------------------===//
 220 //
 221 /// iplist - The subset of list functionality that can safely be used on nodes
 222 /// of polymorphic types, i.e. a heterogenous list with a common base class that
 223 /// holds the next/prev pointers.  The only state of the list itself is a single
 224 /// pointer to the head of the list.
 225 ///
 226 /// This list can be in one of three interesting states:
 227 /// 1. The list may be completely unconstructed.  In this case, the head
 228 ///    pointer is null.  When in this form, any query for an iterator (e.g.
 229 ///    begin() or end()) causes the list to transparently change to state #2.
 230 /// 2. The list may be empty, but contain a sentinal for the end iterator. This
 231 ///    sentinal is created by the Traits::createSentinel method and is a link
 232 ///    in the list.  When the list is empty, the pointer in the iplist points
 233 ///    to the sentinal.  Once the sentinal is constructed, it
 234 ///    is not destroyed until the list is.
 235 /// 3. The list may contain actual objects in it, which are stored as a doubly
 236 ///    linked list of nodes.  One invariant of the list is that the predecessor
 237 ///    of the first node in the list always points to the last node in the list,
 238 ///    and the successor pointer for the sentinal (which always stays at the
 239 ///    end of the list) is always null.
 240 ///
 241 template<typename NodeTy, typename Traits=ilist_traits<NodeTy> >
 242 class iplist : public Traits {
 243   mutable NodeTy *Head;
 244
 245   // Use the prev node pointer of 'head' as the tail pointer.  This is really a
 246   // circularly linked list where we snip the 'next' link from the sentinel node
 247   // back to the first node in the list (to preserve assertions about going off
 248   // the end of the list).
 249   NodeTy *getTail() { return getPrev(Head); }
 250   const NodeTy *getTail() const { return getPrev(Head); }
 251   void setTail(NodeTy *N) const { setPrev(Head, N); }
 252
 253   /// CreateLazySentinal - This method verifies whether the sentinal for the
 254   /// list has been created and lazily makes it if not.
 255   void CreateLazySentinal() const {
 256     if (Head != 0) return;
 257     Head = Traits::createSentinel();
 258     setNext(Head, 0);
 259     setTail(Head);
 260   }
 261
 262   static bool op_less(NodeTy &L, NodeTy &R) { return L < R; }
 263   static bool op_equal(NodeTy &L, NodeTy &R) { return L == R; }
 264
 265   // No fundamental reason why iplist can't by copyable, but the default
 266   // copy/copy-assign won't do.
 267   iplist(const iplist &);         // do not implement
 268   void operator=(const iplist &); // do not implement
 269
 270 public:
 271   typedef NodeTy *pointer;
 272   typedef const NodeTy *const_pointer;
 273   typedef NodeTy &reference;
 274   typedef const NodeTy &const_reference;
 275   typedef NodeTy value_type;
 276   typedef ilist_iterator<NodeTy> iterator;
 277   typedef ilist_iterator<const NodeTy> const_iterator;
 278   typedef size_t size_type;
 279   typedef ptrdiff_t difference_type;
 280   typedef std::reverse_iterator<const_iterator>  const_reverse_iterator;
 281   typedef std::reverse_iterator<iterator>  reverse_iterator;
 282
 283   iplist() : Head(0) {}
 284   ~iplist() {
 285     if (!Head) return;
 286     clear();
 287     Traits::destroySentinel(getTail());
 288   }
 289
 290   // Iterator creation methods.
 291   iterator begin() {
 292     CreateLazySentinal();
 293     return iterator(Head);
 294   }
 295   const_iterator begin() const {
 296     CreateLazySentinal();
 297     return const_iterator(Head);
 298   }
 299   iterator end() {
 300     CreateLazySentinal();
 301     return iterator(getTail());
 302   }
 303   const_iterator end() const {
 304     CreateLazySentinal();
 305     return const_iterator(getTail());
 306   }
 307
 308   // reverse iterator creation methods.
 309   reverse_iterator rbegin()            { return reverse_iterator(end()); }
 310   const_reverse_iterator rbegin() const{ return const_reverse_iterator(end()); }
 311   reverse_iterator rend()              { return reverse_iterator(begin()); }
 312   const_reverse_iterator rend() const { return const_reverse_iterator(begin());}
 313
 314
 315   // Miscellaneous inspection routines.
 316   size_type max_size() const { return size_type(-1); }
 317   bool empty() const { return Head == 0 || Head == getTail(); }
 318
 319   // Front and back accessor functions...
 320   reference front() {
 321     assert(!empty() && "Called front() on empty list!");
 322     return *Head;
 323   }
 324   const_reference front() const {
 325     assert(!empty() && "Called front() on empty list!");
 326     return *Head;
 327   }
 328   reference back() {
 329     assert(!empty() && "Called back() on empty list!");
 330     return *getPrev(getTail());
 331   }
 332   const_reference back() const {
 333     assert(!empty() && "Called back() on empty list!");
 334     return *getPrev(getTail());
 335   }
 336
 337   void swap(iplist &RHS) {
 338     abort();     // Swap does not use list traits callback correctly yet!
 339     std::swap(Head, RHS.Head);
 340   }
 341
 342   iterator insert(iterator where, NodeTy *New) {
 343     NodeTy *CurNode = where.getNodePtrUnchecked(), *PrevNode = getPrev(CurNode);
 344     setNext(New, CurNode);
 345     setPrev(New, PrevNode);
 346
 347     if (CurNode != Head)  // Is PrevNode off the beginning of the list?
 348       setNext(PrevNode, New);
 349     else
 350       Head = New;
 351     setPrev(CurNode, New);
 352
 353     addNodeToList(New);  // Notify traits that we added a node...
 354     return New;
 355   }
 356
 357   NodeTy *remove(iterator &IT) {
 358     assert(IT != end() && "Cannot remove end of list!");
 359     NodeTy *Node = &*IT;
 360     NodeTy *NextNode = getNext(Node);
 361     NodeTy *PrevNode = getPrev(Node);
 362
 363     if (Node != Head)  // Is PrevNode off the beginning of the list?
 364       setNext(PrevNode, NextNode);
 365     else
 366       Head = NextNode;
 367     setPrev(NextNode, PrevNode);
 368     IT = NextNode;
 369     removeNodeFromList(Node);  // Notify traits that we removed a node...
 370
 371     // Set the next/prev pointers of the current node to null.  This isn't
 372     // strictly required, but this catches errors where a node is removed from
 373     // an ilist (and potentially deleted) with iterators still pointing at it.
 374     // When those iterators are incremented or decremented, they will assert on
 375     // the null next/prev pointer instead of "usually working".
 376     setNext(Node, 0);
 377     setPrev(Node, 0);
 378     return Node;
 379   }
 380
 381   NodeTy *remove(const iterator &IT) {
 382     iterator MutIt = IT;
 383     return remove(MutIt);
 384   }
 385
 386   // erase - remove a node from the controlled sequence... and delete it.
 387   iterator erase(iterator where) {
 388     deleteNode(remove(where));
 389     return where;
 390   }
 391
 392
 393 private:
 394   // transfer - The heart of the splice function.  Move linked list nodes from
 395   // [first, last) into position.
 396   //
 397   void transfer(iterator position, iplist &L2, iterator first, iterator last) {
 398     assert(first != last && "Should be checked by callers");
 399
 400     if (position != last) {
 401       // Note: we have to be careful about the case when we move the first node
 402       // in the list.  This node is the list sentinel node and we can't move it.
 403       NodeTy *ThisSentinel = getTail();
 404       setTail(0);
 405       NodeTy *L2Sentinel = L2.getTail();
 406       L2.setTail(0);
 407
 408       // Remove [first, last) from its old position.
 409       NodeTy *First = &*first, *Prev = getPrev(First);
 410       NodeTy *Next = last.getNodePtrUnchecked(), *Last = getPrev(Next);
 411       if (Prev)
 412         setNext(Prev, Next);
 413       else
 414         L2.Head = Next;
 415       setPrev(Next, Prev);
 416
 417       // Splice [first, last) into its new position.
 418       NodeTy *PosNext = position.getNodePtrUnchecked();
 419       NodeTy *PosPrev = getPrev(PosNext);
 420
 421       // Fix head of list...
 422       if (PosPrev)
 423         setNext(PosPrev, First);
 424       else
 425         Head = First;
 426       setPrev(First, PosPrev);
 427
 428       // Fix end of list...
 429       setNext(Last, PosNext);
 430       setPrev(PosNext, Last);
 431
 432       transferNodesFromList(L2, First, PosNext);
 433
 434       // Now that everything is set, restore the pointers to the list sentinals.
 435       L2.setTail(L2Sentinel);
 436       setTail(ThisSentinel);
 437     }
 438   }
 439
 440 public:
 441
 442   //===----------------------------------------------------------------------===
 443   // Functionality derived from other functions defined above...
 444   //
 445
 446   size_type size() const {
 447     if (Head == 0) return 0; // Don't require construction of sentinal if empty.
 448 #if __GNUC__ == 2
 449     // GCC 2.95 has a broken std::distance
 450     size_type Result = 0;
 451     std::distance(begin(), end(), Result);
 452     return Result;
 453 #else
 454     return std::distance(begin(), end());
 455 #endif
 456   }
 457
 458   iterator erase(iterator first, iterator last) {
 459     while (first != last)
 460       first = erase(first);
 461     return last;
 462   }
 463
 464   void clear() { if (Head) erase(begin(), end()); }
 465
 466   // Front and back inserters...
 467   void push_front(NodeTy *val) { insert(begin(), val); }
 468   void push_back(NodeTy *val) { insert(end(), val); }
 469   void pop_front() {
 470     assert(!empty() && "pop_front() on empty list!");
 471     erase(begin());
 472   }
 473   void pop_back() {
 474     assert(!empty() && "pop_back() on empty list!");
 475     iterator t = end(); erase(--t);
 476   }
 477
 478   // Special forms of insert...
 479   template<class InIt> void insert(iterator where, InIt first, InIt last) {
 480     for (; first != last; ++first) insert(where, *first);
 481   }
 482
 483   // Splice members - defined in terms of transfer...
 484   void splice(iterator where, iplist &L2) {
 485     if (!L2.empty())
 486       transfer(where, L2, L2.begin(), L2.end());
 487   }
 488   void splice(iterator where, iplist &L2, iterator first) {
 489     iterator last = first; ++last;
 490     if (where == first || where == last) return; // No change
 491     transfer(where, L2, first, last);
 492   }
 493   void splice(iterator where, iplist &L2, iterator first, iterator last) {
 494     if (first != last) transfer(where, L2, first, last);
 495   }
 496
 497
 498
 499   //===----------------------------------------------------------------------===
 500   // High-Level Functionality that shouldn't really be here, but is part of list
 501   //
 502
 503   // These two functions are actually called remove/remove_if in list<>, but
 504   // they actually do the job of erase, rename them accordingly.
 505   //
 506   void erase(const NodeTy &val) {
 507     for (iterator I = begin(), E = end(); I != E; ) {
 508       iterator next = I; ++next;
 509       if (*I == val) erase(I);
 510       I = next;
 511     }
 512   }
 513   template<class Pr1> void erase_if(Pr1 pred) {
 514     for (iterator I = begin(), E = end(); I != E; ) {
 515       iterator next = I; ++next;
 516       if (pred(*I)) erase(I);
 517       I = next;
 518     }
 519   }
 520
 521   template<class Pr2> void unique(Pr2 pred) {
 522     if (empty()) return;
 523     for (iterator I = begin(), E = end(), Next = begin(); ++Next != E;) {
 524       if (pred(*I))
 525         erase(Next);
 526       else
 527         I = Next;
 528       Next = I;
 529     }
 530   }
 531   void unique() { unique(op_equal); }
 532
 533   template<class Pr3> void merge(iplist &right, Pr3 pred) {
 534     iterator first1 = begin(), last1 = end();
 535     iterator first2 = right.begin(), last2 = right.end();
 536     while (first1 != last1 && first2 != last2)
 537       if (pred(*first2, *first1)) {
 538         iterator next = first2;
 539         transfer(first1, right, first2, ++next);
 540         first2 = next;
 541       } else {
 542         ++first1;
 543       }
 544     if (first2 != last2) transfer(last1, right, first2, last2);
 545   }
 546   void merge(iplist &right) { return merge(right, op_less); }
 547
 548   template<class Pr3> void sort(Pr3 pred);
 549   void sort() { sort(op_less); }
 550   void reverse();
 551 };
 552
 553
 554 template<typename NodeTy>
 555 struct ilist : public iplist<NodeTy> {
 556   typedef typename iplist<NodeTy>::size_type size_type;
 557   typedef typename iplist<NodeTy>::iterator iterator;
 558
 559   ilist() {}
 560   ilist(const ilist &right) {
 561     insert(this->begin(), right.begin(), right.end());
 562   }
 563   explicit ilist(size_type count) {
 564     insert(this->begin(), count, NodeTy());
 565   }
 566   ilist(size_type count, const NodeTy &val) {
 567     insert(this->begin(), count, val);
 568   }
 569   template<class InIt> ilist(InIt first, InIt last) {
 570     insert(this->begin(), first, last);
 571   }
 572
 573
 574   // Forwarding functions: A workaround for GCC 2.95 which does not correctly
 575   // support 'using' declarations to bring a hidden member into scope.
 576   //
 577   iterator insert(iterator a, NodeTy *b){ return iplist<NodeTy>::insert(a, b); }
 578   void push_front(NodeTy *a) { iplist<NodeTy>::push_front(a); }
 579   void push_back(NodeTy *a)  { iplist<NodeTy>::push_back(a); }
 580
 581
 582   // Main implementation here - Insert for a node passed by value...
 583   iterator insert(iterator where, const NodeTy &val) {
 584     return insert(where, createNode(val));
 585   }
 586
 587
 588   // Front and back inserters...
 589   void push_front(const NodeTy &val) { insert(this->begin(), val); }
 590   void push_back(const NodeTy &val) { insert(this->end(), val); }
 591
 592   // Special forms of insert...
 593   template<class InIt> void insert(iterator where, InIt first, InIt last) {
 594     for (; first != last; ++first) insert(where, *first);
 595   }
 596   void insert(iterator where, size_type count, const NodeTy &val) {
 597     for (; count != 0; --count) insert(where, val);
 598   }
 599
 600   // Assign special forms...
 601   void assign(size_type count, const NodeTy &val) {
 602     iterator I = this->begin();
 603     for (; I != this->end() && count != 0; ++I, --count)
 604       *I = val;
 605     if (count != 0)
 606       insert(this->end(), val, val);
 607     else
 608       erase(I, this->end());
 609   }
 610   template<class InIt> void assign(InIt first1, InIt last1) {
 611     iterator first2 = this->begin(), last2 = this->end();
 612     for ( ; first1 != last1 && first2 != last2; ++first1, ++first2)
 613       *first1 = *first2;
 614     if (first2 == last2)
 615       erase(first1, last1);
 616     else
 617       insert(last1, first2, last2);
 618   }
 619
 620
 621   // Resize members...
 622   void resize(size_type newsize, NodeTy val) {
 623     iterator i = this->begin();
 624     size_type len = 0;
 625     for ( ; i != this->end() && len < newsize; ++i, ++len) /* empty*/ ;
 626
 627     if (len == newsize)
 628       erase(i, this->end());
 629     else                                          // i == end()
 630       insert(this->end(), newsize - len, val);
 631   }
 632   void resize(size_type newsize) { resize(newsize, NodeTy()); }
 633 };
 634
 635 } // End llvm namespace
 636
 637 namespace std {
 638   // Ensure that swap uses the fast list swap...
 639   template<class Ty>
 640   void swap(llvm::iplist<Ty> &Left, llvm::iplist<Ty> &Right) {
 641     Left.swap(Right);
 642   }
 643 }  // End 'std' extensions...
 644
 645 #endif // LLVM_ADT_ILIST_H