include/llvm/ADT/ilist

   1 //===-- llvm/ADT/ilist - Intrusive Linked List Template ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines classes to implement an intrusive doubly linked list class
  11 // (ie 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 // provides 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<>::createEndMarker()).  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
  39 #define LLVM_ADT_ILIST
  40
  41 #include "llvm/ADT/iterator"
  42 #include <cassert>
  43
  44 namespace llvm {
  45
  46 template<typename NodeTy, typename Traits> class iplist;
  47 template<typename NodeTy> class ilist_iterator;
  48
  49 // Template traits for intrusive list.  By specializing this template class, you
  50 // can change what next/prev fields are used to store the links...
  51 template<typename NodeTy>
  52 struct ilist_traits {
  53   static NodeTy *getPrev(NodeTy *N) { return N->getPrev(); }
  54   static NodeTy *getNext(NodeTy *N) { return N->getNext(); }
  55   static const NodeTy *getPrev(const NodeTy *N) { return N->getPrev(); }
  56   static const NodeTy *getNext(const NodeTy *N) { return N->getNext(); }
  57
  58   static void setPrev(NodeTy *N, NodeTy *Prev) { N->setPrev(Prev); }
  59   static void setNext(NodeTy *N, NodeTy *Next) { N->setNext(Next); }
  60
  61   static NodeTy *createNode(const NodeTy &V) { return new NodeTy(V); }
  62
  63   static NodeTy *createSentinel() { return new NodeTy(); }
  64   static void destroySentinel(NodeTy *N) { delete N; }
  65
  66   void addNodeToList(NodeTy *NTy) {}
  67   void removeNodeFromList(NodeTy *NTy) {}
  68   void transferNodesFromList(iplist<NodeTy, ilist_traits> &L2,
  69                              ilist_iterator<NodeTy> first,
  70                              ilist_iterator<NodeTy> last) {}
  71 };
  72
  73 // Const traits are the same as nonconst traits...
  74 template<typename Ty>
  75 struct ilist_traits<const Ty> : public ilist_traits<Ty> {};
  76
  77
  78 //===----------------------------------------------------------------------===//
  79 // ilist_iterator<Node> - Iterator for intrusive list.
  80 //
  81 template<typename NodeTy>
  82 class ilist_iterator
  83   : public bidirectional_iterator<NodeTy, ptrdiff_t> {
  84   typedef ilist_traits<NodeTy> Traits;
  85   typedef bidirectional_iterator<NodeTy, ptrdiff_t> super;
  86
  87 public:
  88   typedef size_t size_type;
  89   typedef typename super::pointer pointer;
  90   typedef typename super::reference reference;
  91 private:
  92   pointer NodePtr;
  93 public:
  94
  95   ilist_iterator(pointer NP) : NodePtr(NP) {}
  96   ilist_iterator(reference NR) : NodePtr(&NR) {}
  97   ilist_iterator() : NodePtr(0) {}
  98
  99   // This is templated so that we can allow constructing a const iterator from
 100   // a nonconst iterator...
 101   template<class node_ty>
 102   ilist_iterator(const ilist_iterator<node_ty> &RHS)
 103     : NodePtr(RHS.getNodePtrUnchecked()) {}
 104
 105   // This is templated so that we can allow assigning to a const iterator from
 106   // a nonconst iterator...
 107   template<class node_ty>
 108   const ilist_iterator &operator=(const ilist_iterator<node_ty> &RHS) {
 109     NodePtr = RHS.getNodePtrUnchecked();
 110     return *this;
 111   }
 112
 113   // Accessors...
 114   operator pointer() const {
 115     assert(Traits::getNext(NodePtr) != 0 && "Dereferencing end()!");
 116     return NodePtr;
 117   }
 118
 119   reference operator*() const {
 120     assert(Traits::getNext(NodePtr) != 0 && "Dereferencing end()!");
 121     return *NodePtr;
 122   }
 123   pointer operator->() { return &operator*(); }
 124   const pointer operator->() const { return &operator*(); }
 125
 126   // Comparison operators
 127   bool operator==(const ilist_iterator &RHS) const {
 128     return NodePtr == RHS.NodePtr;
 129   }
 130   bool operator!=(const ilist_iterator &RHS) const {
 131     return NodePtr != RHS.NodePtr;
 132   }
 133
 134   // Increment and decrement operators...
 135   ilist_iterator &operator--() {      // predecrement - Back up
 136     NodePtr = Traits::getPrev(NodePtr);
 137     assert(NodePtr && "--'d off the beginning of an ilist!");
 138     return *this;
 139   }
 140   ilist_iterator &operator++() {      // preincrement - Advance
 141     NodePtr = Traits::getNext(NodePtr);
 142     assert(NodePtr && "++'d off the end of an ilist!");
 143     return *this;
 144   }
 145   ilist_iterator operator--(int) {    // postdecrement operators...
 146     ilist_iterator tmp = *this;
 147     --*this;
 148     return tmp;
 149   }
 150   ilist_iterator operator++(int) {    // postincrement operators...
 151     ilist_iterator tmp = *this;
 152     ++*this;
 153     return tmp;
 154   }
 155
 156   // Internal interface, do not use...
 157   pointer getNodePtrUnchecked() const { return NodePtr; }
 158 };
 159
 160 // do not implement. this is to catch errors when people try to use
 161 // them as random access iterators
 162 template<typename T>
 163 void operator-(int, ilist_iterator<T>);
 164 template<typename T>
 165 void operator-(ilist_iterator<T>,int);
 166
 167 template<typename T>
 168 void operator+(int, ilist_iterator<T>);
 169 template<typename T>
 170 void operator+(ilist_iterator<T>,int);
 171
 172 // operator!=/operator== - Allow mixed comparisons without dereferencing
 173 // the iterator, which could very likely be pointing to end().
 174 template<typename T>
 175 bool operator!=(const T* LHS, const ilist_iterator<const T> &RHS) {
 176   return LHS != RHS.getNodePtrUnchecked();
 177 }
 178 template<typename T>
 179 bool operator==(const T* LHS, const ilist_iterator<const T> &RHS) {
 180   return LHS == RHS.getNodePtrUnchecked();
 181 }
 182 template<typename T>
 183 bool operator!=(T* LHS, const ilist_iterator<T> &RHS) {
 184   return LHS != RHS.getNodePtrUnchecked();
 185 }
 186 template<typename T>
 187 bool operator==(T* LHS, const ilist_iterator<T> &RHS) {
 188   return LHS == RHS.getNodePtrUnchecked();
 189 }
 190
 191
 192 // Allow ilist_iterators to convert into pointers to a node automatically when
 193 // used by the dyn_cast, cast, isa mechanisms...
 194
 195 template<typename From> struct simplify_type;
 196
 197 template<typename NodeTy> struct simplify_type<ilist_iterator<NodeTy> > {
 198   typedef NodeTy* SimpleType;
 199
 200   static SimpleType getSimplifiedValue(const ilist_iterator<NodeTy> &Node) {
 201     return &*Node;
 202   }
 203 };
 204 template<typename NodeTy> struct simplify_type<const ilist_iterator<NodeTy> > {
 205   typedef NodeTy* SimpleType;
 206
 207   static SimpleType getSimplifiedValue(const ilist_iterator<NodeTy> &Node) {
 208     return &*Node;
 209   }
 210 };
 211
 212
 213 //===----------------------------------------------------------------------===//
 214 //
 215 // iplist - The subset of list functionality that can safely be used on nodes of
 216 // polymorphic types, ie a heterogeneus list with a common base class that holds
 217 // the next/prev pointers...
 218 //
 219 template<typename NodeTy, typename Traits=ilist_traits<NodeTy> >
 220 class iplist : public Traits {
 221   NodeTy *Head, *Tail;
 222
 223   static bool op_less(NodeTy &L, NodeTy &R) { return L < R; }
 224   static bool op_equal(NodeTy &L, NodeTy &R) { return L == R; }
 225 public:
 226   typedef NodeTy *pointer;
 227   typedef const NodeTy *const_pointer;
 228   typedef NodeTy &reference;
 229   typedef const NodeTy &const_reference;
 230   typedef NodeTy value_type;
 231   typedef ilist_iterator<NodeTy> iterator;
 232   typedef ilist_iterator<const NodeTy> const_iterator;
 233   typedef size_t size_type;
 234   typedef ptrdiff_t difference_type;
 235   typedef std::reverse_iterator<const_iterator>  const_reverse_iterator;
 236   typedef std::reverse_iterator<iterator>  reverse_iterator;
 237
 238   iplist() : Head(Traits::createSentinel()), Tail(Head) {
 239     setNext(Head, 0);
 240     setPrev(Head, 0);
 241   }
 242   ~iplist() { clear(); Traits::destroySentinel(Tail); }
 243
 244   // Iterator creation methods.
 245   iterator begin()             { return iterator(Head); }
 246   const_iterator begin() const { return const_iterator(Head); }
 247   iterator end()               { return iterator(Tail); }
 248   const_iterator end() const   { return const_iterator(Tail); }
 249
 250   // reverse iterator creation methods.
 251   reverse_iterator rbegin()            { return reverse_iterator(end()); }
 252   const_reverse_iterator rbegin() const{ return const_reverse_iterator(end()); }
 253   reverse_iterator rend()              { return reverse_iterator(begin()); }
 254   const_reverse_iterator rend() const  {return const_reverse_iterator(begin());}
 255
 256
 257   // Miscellaneous inspection routines.
 258   size_type max_size() const { return size_type(-1); }
 259   bool empty() const { return Head == Tail; }
 260
 261   // Front and back accessor functions...
 262   reference front() {
 263     assert(!empty() && "Called front() on empty list!");
 264     return *Head;
 265   }
 266   const_reference front() const {
 267     assert(!empty() && "Called front() on empty list!");
 268     return *Head;
 269   }
 270   reference back() {
 271     assert(!empty() && "Called back() on empty list!");
 272     return *getPrev(Tail);
 273   }
 274   const_reference back() const {
 275     assert(!empty() && "Called back() on empty list!");
 276     return *getPrev(Tail);
 277   }
 278
 279   void swap(iplist &RHS) {
 280     abort();     // Swap does not use list traits callback correctly yet!
 281     std::swap(Head, RHS.Head);
 282     std::swap(Tail, RHS.Tail);
 283   }
 284
 285   iterator insert(iterator where, NodeTy *New) {
 286     NodeTy *CurNode = where.getNodePtrUnchecked(), *PrevNode = getPrev(CurNode);
 287     setNext(New, CurNode);
 288     setPrev(New, PrevNode);
 289
 290     if (PrevNode)
 291       setNext(PrevNode, New);
 292     else
 293       Head = New;
 294     setPrev(CurNode, New);
 295
 296     addNodeToList(New);  // Notify traits that we added a node...
 297     return New;
 298   }
 299
 300   NodeTy *remove(iterator &IT) {
 301     assert(IT != end() && "Cannot remove end of list!");
 302     NodeTy *Node = &*IT;
 303     NodeTy *NextNode = getNext(Node);
 304     NodeTy *PrevNode = getPrev(Node);
 305
 306     if (PrevNode)
 307       setNext(PrevNode, NextNode);
 308     else
 309       Head = NextNode;
 310     setPrev(NextNode, PrevNode);
 311     IT = NextNode;
 312     removeNodeFromList(Node);  // Notify traits that we removed a node...
 313     return Node;
 314   }
 315
 316   NodeTy *remove(const iterator &IT) {
 317     iterator MutIt = IT;
 318     return remove(MutIt);
 319   }
 320
 321   // erase - remove a node from the controlled sequence... and delete it.
 322   iterator erase(iterator where) {
 323     delete remove(where);
 324     return where;
 325   }
 326
 327
 328 private:
 329   // transfer - The heart of the splice function.  Move linked list nodes from
 330   // [first, last) into position.
 331   //
 332   void transfer(iterator position, iplist &L2, iterator first, iterator last) {
 333     assert(first != last && "Should be checked by callers");
 334     if (position != last) {
 335       // Remove [first, last) from its old position.
 336       NodeTy *First = &*first, *Prev = getPrev(First);
 337       NodeTy *Next = last.getNodePtrUnchecked(), *Last = getPrev(Next);
 338       if (Prev)
 339         setNext(Prev, Next);
 340       else
 341         L2.Head = Next;
 342       setPrev(Next, Prev);
 343
 344       // Splice [first, last) into its new position.
 345       NodeTy *PosNext = position.getNodePtrUnchecked();
 346       NodeTy *PosPrev = getPrev(PosNext);
 347
 348       // Fix head of list...
 349       if (PosPrev)
 350         setNext(PosPrev, First);
 351       else
 352         Head = First;
 353       setPrev(First, PosPrev);
 354
 355       // Fix end of list...
 356       setNext(Last, PosNext);
 357       setPrev(PosNext, Last);
 358
 359       transferNodesFromList(L2, First, PosNext);
 360     }
 361   }
 362
 363 public:
 364
 365   //===----------------------------------------------------------------------===
 366   // Functionality derived from other functions defined above...
 367   //
 368
 369   size_type size() const {
 370 #if __GNUC__ == 2
 371     // GCC 2.95 has a broken std::distance
 372     size_type Result = 0;
 373     std::distance(begin(), end(), Result);
 374     return Result;
 375 #else
 376     return std::distance(begin(), end());
 377 #endif
 378   }
 379
 380   iterator erase(iterator first, iterator last) {
 381     while (first != last)
 382       first = erase(first);
 383     return last;
 384   }
 385
 386   void clear() { erase(begin(), end()); }
 387
 388   // Front and back inserters...
 389   void push_front(NodeTy *val) { insert(begin(), val); }
 390   void push_back(NodeTy *val) { insert(end(), val); }
 391   void pop_front() {
 392     assert(!empty() && "pop_front() on empty list!");
 393     erase(begin());
 394   }
 395   void pop_back() {
 396     assert(!empty() && "pop_back() on empty list!");
 397     iterator t = end(); erase(--t);
 398   }
 399
 400   // Special forms of insert...
 401   template<class InIt> void insert(iterator where, InIt first, InIt last) {
 402     for (; first != last; ++first) insert(where, *first);
 403   }
 404
 405   // Splice members - defined in terms of transfer...
 406   void splice(iterator where, iplist &L2) {
 407     if (!L2.empty())
 408       transfer(where, L2, L2.begin(), L2.end());
 409   }
 410   void splice(iterator where, iplist &L2, iterator first) {
 411     iterator last = first; ++last;
 412     if (where == first || where == last) return; // No change
 413     transfer(where, L2, first, last);
 414   }
 415   void splice(iterator where, iplist &L2, iterator first, iterator last) {
 416     if (first != last) transfer(where, L2, first, last);
 417   }
 418
 419
 420
 421   //===----------------------------------------------------------------------===
 422   // High-Level Functionality that shouldn't really be here, but is part of list
 423   //
 424
 425   // These two functions are actually called remove/remove_if in list<>, but
 426   // they actually do the job of erase, rename them accordingly.
 427   //
 428   void erase(const NodeTy &val) {
 429     for (iterator I = begin(), E = end(); I != E; ) {
 430       iterator next = I; ++next;
 431       if (*I == val) erase(I);
 432       I = next;
 433     }
 434   }
 435   template<class Pr1> void erase_if(Pr1 pred) {
 436     for (iterator I = begin(), E = end(); I != E; ) {
 437       iterator next = I; ++next;
 438       if (pred(*I)) erase(I);
 439       I = next;
 440     }
 441   }
 442
 443   template<class Pr2> void unique(Pr2 pred) {
 444     if (empty()) return;
 445     for (iterator I = begin(), E = end(), Next = begin(); ++Next != E;) {
 446       if (pred(*I))
 447         erase(Next);
 448       else
 449         I = Next;
 450       Next = I;
 451     }
 452   }
 453   void unique() { unique(op_equal); }
 454
 455   template<class Pr3> void merge(iplist &right, Pr3 pred) {
 456     iterator first1 = begin(), last1 = end();
 457     iterator first2 = right.begin(), last2 = right.end();
 458     while (first1 != last1 && first2 != last2)
 459       if (pred(*first2, *first1)) {
 460         iterator next = first2;
 461         transfer(first1, right, first2, ++next);
 462         first2 = next;
 463       } else {
 464         ++first1;
 465       }
 466     if (first2 != last2) transfer(last1, right, first2, last2);
 467   }
 468   void merge(iplist &right) { return merge(right, op_less); }
 469
 470   template<class Pr3> void sort(Pr3 pred);
 471   void sort() { sort(op_less); }
 472   void reverse();
 473 };
 474
 475
 476 template<typename NodeTy>
 477 struct ilist : public iplist<NodeTy> {
 478   typedef typename iplist<NodeTy>::size_type size_type;
 479   typedef typename iplist<NodeTy>::iterator iterator;
 480
 481   ilist() {}
 482   ilist(const ilist &right) {
 483     insert(this->begin(), right.begin(), right.end());
 484   }
 485   explicit ilist(size_type count) {
 486     insert(this->begin(), count, NodeTy());
 487   }
 488   ilist(size_type count, const NodeTy &val) {
 489     insert(this->begin(), count, val);
 490   }
 491   template<class InIt> ilist(InIt first, InIt last) {
 492     insert(this->begin(), first, last);
 493   }
 494
 495
 496   // Forwarding functions: A workaround for GCC 2.95 which does not correctly
 497   // support 'using' declarations to bring a hidden member into scope.
 498   //
 499   iterator insert(iterator a, NodeTy *b){ return iplist<NodeTy>::insert(a, b); }
 500   void push_front(NodeTy *a) { iplist<NodeTy>::push_front(a); }
 501   void push_back(NodeTy *a)  { iplist<NodeTy>::push_back(a); }
 502
 503
 504   // Main implementation here - Insert for a node passed by value...
 505   iterator insert(iterator where, const NodeTy &val) {
 506     return insert(where, createNode(val));
 507   }
 508
 509
 510   // Front and back inserters...
 511   void push_front(const NodeTy &val) { insert(this->begin(), val); }
 512   void push_back(const NodeTy &val) { insert(this->end(), val); }
 513
 514   // Special forms of insert...
 515   template<class InIt> void insert(iterator where, InIt first, InIt last) {
 516     for (; first != last; ++first) insert(where, *first);
 517   }
 518   void insert(iterator where, size_type count, const NodeTy &val) {
 519     for (; count != 0; --count) insert(where, val);
 520   }
 521
 522   // Assign special forms...
 523   void assign(size_type count, const NodeTy &val) {
 524     iterator I = this->begin();
 525     for (; I != this->end() && count != 0; ++I, --count)
 526       *I = val;
 527     if (count != 0)
 528       insert(this->end(), val, val);
 529     else
 530       erase(I, this->end());
 531   }
 532   template<class InIt> void assign(InIt first1, InIt last1) {
 533     iterator first2 = this->begin(), last2 = this->end();
 534     for ( ; first1 != last1 && first2 != last2; ++first1, ++first2)
 535       *first1 = *first2;
 536     if (first2 == last2)
 537       erase(first1, last1);
 538     else
 539       insert(last1, first2, last2);
 540   }
 541
 542
 543   // Resize members...
 544   void resize(size_type newsize, NodeTy val) {
 545     iterator i = this->begin();
 546     size_type len = 0;
 547     for ( ; i != this->end() && len < newsize; ++i, ++len) /* empty*/ ;
 548
 549     if (len == newsize)
 550       erase(i, this->end());
 551     else                                          // i == end()
 552       insert(this->end(), newsize - len, val);
 553   }
 554   void resize(size_type newsize) { resize(newsize, NodeTy()); }
 555 };
 556
 557 } // End llvm namespace
 558
 559 namespace std {
 560   // Ensure that swap uses the fast list swap...
 561   template<class Ty>
 562   void swap(llvm::iplist<Ty> &Left, llvm::iplist<Ty> &Right) {
 563     Left.swap(Right);
 564   }
 565 }  // End 'std' extensions...
 566
 567 #endif