src/NCollection/NCollection_List.hxx

   1 // Created on: 2002-04-17
   2 // Created by: Alexander Kartomin (akm)
   3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef NCollection_List_HeaderFile
  17 #define NCollection_List_HeaderFile
  18
  19 #include <NCollection_TListIterator.hxx>
  20 #include <NCollection_StlIterator.hxx>
  21
  22 #include <Standard_NoSuchObject.hxx>
  23
  24 /**
  25  * Purpose:      Simple list to link  items together keeping the first
  26  *               and the last one.
  27  *               Inherits BaseList, adding the data item to each node.
  28  */
  29 template <class TheItemType>
  30 class NCollection_List : public NCollection_BaseList
  31 {
  32 public:
  33   //! STL-compliant typedef for value type
  34   typedef TheItemType value_type;
  35
  36 public:
  37   typedef NCollection_TListNode<TheItemType>     ListNode;
  38   typedef NCollection_TListIterator<TheItemType> Iterator;
  39
  40   //! Shorthand for a regular iterator type.
  41   typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheItemType, false> iterator;
  42
  43   //! Shorthand for a constant iterator type.
  44   typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheItemType, true> const_iterator;
  45
  46   //! Returns an iterator pointing to the first element in the list.
  47   iterator begin() const { return Iterator (*this); }
  48
  49   //! Returns an iterator referring to the past-the-end element in the list.
  50   iterator end() const { return Iterator(); }
  51
  52   //! Returns a const iterator pointing to the first element in the list.
  53   const_iterator cbegin() const { return Iterator (*this); }
  54
  55   //! Returns a const iterator referring to the past-the-end element in the list.
  56   const_iterator cend() const { return Iterator(); }
  57
  58  public:
  59   // ---------- PUBLIC METHODS ------------
  60
  61   //! Empty constructor.
  62   NCollection_List() : NCollection_BaseList(Handle(NCollection_BaseAllocator)()) {}
  63
  64   //! Constructor
  65   explicit NCollection_List(const Handle(NCollection_BaseAllocator)& theAllocator) : NCollection_BaseList(theAllocator) {}
  66
  67   //! Copy constructor
  68   NCollection_List (const NCollection_List& theOther) :
  69     NCollection_BaseList(theOther.myAllocator)
  70   {
  71     Assign (theOther);
  72   }
  73
  74   //! Size - Number of items
  75   Standard_Integer Size (void) const
  76   { return Extent(); }
  77
  78   //! Replace this list by the items of another list (theOther parameter).
  79   //! This method does not change the internal allocator.
  80   NCollection_List& Assign (const NCollection_List& theOther)
  81   {
  82     if (this != &theOther) {
  83       Clear();
  84       appendList(theOther.PFirst());
  85     }
  86     return *this;
  87   }
  88
  89   //! Replacement operator
  90   NCollection_List& operator= (const NCollection_List& theOther)
  91   {
  92     return Assign (theOther);
  93   }
  94
  95   //! Clear this list
  96   void Clear (const Handle(NCollection_BaseAllocator)& theAllocator=0L)
  97   {
  98     PClear (ListNode::delNode);
  99     if (!theAllocator.IsNull())
 100       this->myAllocator = theAllocator;
 101   }
 102
 103   //! First item
 104   const TheItemType& First (void) const
 105   {
 106     Standard_NoSuchObject_Raise_if (IsEmpty(), "NCollection_List::First");
 107     return ((const ListNode *) PFirst())->Value();
 108   }
 109
 110   //! First item (non-const)
 111   TheItemType& First (void)
 112   {
 113     Standard_NoSuchObject_Raise_if (IsEmpty(), "NCollection_List::First");
 114     return ((ListNode *) PFirst())->ChangeValue();
 115   }
 116
 117   //! Last item
 118   const TheItemType& Last (void) const
 119   {
 120     Standard_NoSuchObject_Raise_if (IsEmpty(), "NCollection_List::Last");
 121     return ((const ListNode *) PLast())->Value();
 122   }
 123
 124   //! Last item (non-const)
 125   TheItemType& Last (void)
 126   {
 127     Standard_NoSuchObject_Raise_if (IsEmpty(), "NCollection_List::Last");
 128     return ((ListNode *) PLast())->ChangeValue();
 129   }
 130
 131   //! Append one item at the end
 132   TheItemType& Append (const TheItemType& theItem)
 133   {
 134     ListNode * pNew = new (this->myAllocator) ListNode(theItem);
 135     PAppend(pNew);
 136     return ((ListNode *) PLast())->ChangeValue();
 137   }
 138
 139   //! Append one item at the end and output iterator
 140   //!   pointing at the appended item
 141   void Append (const TheItemType& theItem, Iterator& theIter)
 142   {
 143     ListNode * pNew = new (this->myAllocator) ListNode(theItem);
 144     PAppend(pNew, theIter);
 145   }
 146
 147   //! Append another list at the end.
 148   //! After this operation, theOther list will be cleared.
 149   void Append (NCollection_List& theOther)
 150   {
 151     if (this == &theOther || theOther.Extent()<1)
 152       return;
 153     if (this->myAllocator == theOther.myAllocator)
 154     {
 155       // Then we take the list and glue it to our end -
 156       // deallocation will bring no problem
 157       PAppend(theOther);
 158     }
 159     else
 160     {
 161       // No - this list has different memory scope
 162       appendList(theOther.myFirst);
 163       theOther.Clear();
 164     }
 165   }
 166
 167   //! Prepend one item at the beginning
 168   TheItemType& Prepend (const TheItemType& theItem)
 169   {
 170     ListNode * pNew = new (this->myAllocator) ListNode(theItem);
 171     PPrepend(pNew);
 172     return ((ListNode *) PFirst())->ChangeValue();
 173   }
 174
 175   //! Prepend another list at the beginning
 176   void Prepend (NCollection_List& theOther)
 177   {
 178     if (this == &theOther || theOther.Extent()<1)
 179       return;
 180     if (this->myAllocator == theOther.myAllocator)
 181     {
 182       // Then we take the list and glue it to our head -
 183       // deallocation will bring no problem
 184       PPrepend(theOther);
 185     }
 186     else
 187     {
 188       // No - this list has different memory scope
 189       Iterator it(*this);
 190       prependList(theOther.PFirst(), it);
 191       theOther.Clear();
 192     }
 193   }
 194
 195   //! RemoveFirst item
 196   void RemoveFirst (void)
 197   { PRemoveFirst (ListNode::delNode); }
 198
 199   //! Remove item pointed by iterator theIter;
 200   //! theIter is then set to the next item
 201   void Remove (Iterator& theIter)
 202   {
 203     PRemove (theIter, ListNode::delNode);
 204   }
 205
 206   //! Remove the first occurrence of the object.
 207   template<typename TheValueType> // instantiate this method on first call only for types defining equality operator
 208   Standard_Boolean Remove (const TheValueType& theObject)
 209   {
 210     for (Iterator anIter (*this); anIter.More(); anIter.Next())
 211     {
 212       if (anIter.Value() == theObject)
 213       {
 214         Remove (anIter);
 215         return Standard_True;
 216       }
 217     }
 218     return Standard_False;
 219   }
 220
 221   //! InsertBefore
 222   TheItemType& InsertBefore (const TheItemType& theItem,
 223                              Iterator& theIter)
 224   {
 225     ListNode * pNew = new (this->myAllocator) ListNode(theItem);
 226     PInsertBefore (pNew, theIter);
 227     return pNew -> ChangeValue();
 228   }
 229
 230   //! InsertBefore
 231   void InsertBefore (NCollection_List& theOther,
 232                      Iterator& theIter)
 233   {
 234     if (this == &theOther)
 235       return;
 236
 237     if (this->myAllocator == theOther.myAllocator)
 238     {
 239       // Then we take the list and glue it to our head -
 240       // deallocation will bring no problem
 241       PInsertBefore (theOther, theIter);
 242     }
 243     else
 244     {
 245       // No - this list has different memory scope
 246       prependList(theOther.myFirst, theIter);
 247       theOther.Clear();
 248     }
 249   }
 250
 251   //! InsertAfter
 252   TheItemType& InsertAfter (const TheItemType& theItem,
 253                             Iterator& theIter)
 254   {
 255     ListNode * pNew = new (this->myAllocator) ListNode(theItem);
 256     PInsertAfter (pNew, theIter);
 257     return pNew -> ChangeValue();
 258   }
 259
 260   //! InsertAfter
 261   void InsertAfter (NCollection_List& theOther,
 262                     Iterator& theIter)
 263   {
 264     if (!theIter.More())
 265     {
 266       Append(theOther);
 267       return;
 268     }
 269     if (this->myAllocator == theOther.myAllocator)
 270     {
 271       // Then we take the list and glue it to our head -
 272       // deallocation will bring no problem
 273       PInsertAfter (theOther, theIter);
 274     }
 275     else
 276     {
 277       // No - this list has different memory scope
 278       Iterator anIter;
 279       anIter.myPrevious = theIter.myCurrent;
 280       anIter.myCurrent = theIter.myCurrent->Next();
 281       prependList(theOther.PFirst(), anIter);
 282       theOther.Clear();
 283     }
 284   }
 285
 286   //! Reverse the list
 287   void Reverse ()
 288   { PReverse(); }
 289
 290   //! Return true if object is stored in the list.
 291   template<typename TheValueType> // instantiate this method on first call only for types defining equality operator
 292   Standard_Boolean Contains (const TheValueType& theObject) const
 293   {
 294     for (Iterator anIter (*this); anIter.More(); anIter.Next())
 295     {
 296       if (anIter.Value() == theObject)
 297       {
 298         return Standard_True;
 299       }
 300     }
 301     return Standard_False;
 302   }
 303
 304   //! Destructor - clears the List
 305   virtual ~NCollection_List (void)
 306   { Clear(); }
 307
 308  private:
 309   // ----------- PRIVATE METHODS -----------
 310
 311   //! append the list headed by the given ListNode
 312   void appendList(const NCollection_ListNode * pCur) {
 313     while (pCur) {
 314       NCollection_ListNode * pNew =
 315         new (this->myAllocator) ListNode(((const ListNode *)(pCur))->Value());
 316       PAppend(pNew);
 317       pCur = pCur->Next();
 318     }
 319   }
 320
 321   //! insert the list headed by the given ListNode before the given iterator
 322   void prependList(const NCollection_ListNode * pCur, Iterator& theIter) {
 323     while (pCur) {
 324       NCollection_ListNode * pNew =
 325         new (this->myAllocator) ListNode (((const ListNode *)(pCur))->Value());
 326       PInsertBefore(pNew, theIter);
 327       pCur = pCur->Next();
 328     }
 329   }
 330 };
 331
 332 #endif