98239c0d36bf5c42973bf439c9789094b338a84e
[occt.git] / src / NCollection / NCollection_Sequence.hxx
1 // Created on: 2002-03-28
2 // Created by: Alexander GRIGORIEV
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_Sequence_HeaderFile
17 #define NCollection_Sequence_HeaderFile
18
19 #include <NCollection_BaseSequence.hxx>
20 #include <NCollection_StlIterator.hxx>
21
22 #include <Standard_OutOfRange.hxx>
23 #include <Standard_NoSuchObject.hxx>
24
25 /**
26  * Purpose:     Definition of a sequence of elements indexed by
27  *              an Integer in range of 1..n
28  */              
29 template <class TheItemType>
30 class NCollection_Sequence : public NCollection_BaseSequence
31 {
32 public:
33   //! STL-compliant typedef for value type
34   typedef TheItemType value_type;
35
36 public:
37   //!   Class defining sequence node - for internal use by Sequence
38   class Node : public NCollection_SeqNode
39   {
40   public:
41     //! Constructor
42     Node (const TheItemType& theItem) :
43       NCollection_SeqNode ()
44       { myValue = theItem; }
45     //! Constant value access
46     const TheItemType& Value () const { return myValue; }
47     //! Variable value access
48     TheItemType&       ChangeValue () { return myValue; }
49
50   private:
51     TheItemType    myValue;
52   }; // End of nested class Node
53
54  public:
55   //!   Implementation of the Iterator interface.
56   class Iterator : public NCollection_BaseSequence::Iterator
57   {
58   public:
59     //! Empty constructor - for later Init
60     Iterator  (void) {}
61     //! Constructor with initialisation
62     Iterator  (const NCollection_Sequence& theSeq,
63                const Standard_Boolean      isStart = Standard_True)
64       : NCollection_BaseSequence::Iterator (theSeq, isStart) {}
65     //! Check end
66     Standard_Boolean More (void) const
67     { return (myCurrent!=NULL); }
68     //! Make step
69     void Next (void)
70     {
71       if (myCurrent)
72       {
73         myPrevious = myCurrent;
74         myCurrent = myCurrent->Next();
75       }
76     }
77     //! Constant value access
78     const TheItemType& Value (void) const
79     { return ((const Node *)myCurrent)->Value(); }
80     //! Variable value access
81     TheItemType& ChangeValue (void) const
82     { return ((Node *)myCurrent)->ChangeValue(); }
83     //! Performs comparison of two iterators.
84     Standard_Boolean IsEqual (const Iterator& theOther) const
85     {
86       return myCurrent == theOther.myCurrent;
87     }
88   }; // End of nested class Iterator
89
90   //! Shorthand for a regular iterator type.
91   typedef NCollection_StlIterator<std::bidirectional_iterator_tag, Iterator, TheItemType, false> iterator;
92
93   //! Shorthand for a constant iterator type.
94   typedef NCollection_StlIterator<std::bidirectional_iterator_tag, Iterator, TheItemType, true> const_iterator;
95
96   //! Returns an iterator pointing to the first element in the sequence.
97   iterator begin() const { return Iterator (*this, true); }
98
99   //! Returns an iterator referring to the past-the-end element in the sequence.
100   iterator end() const { Iterator anIter (*this, false); anIter.Next(); return anIter; }
101   
102   //! Returns a const iterator pointing to the first element in the sequence.
103   const_iterator cbegin() const { return Iterator (*this, true); }
104
105   //! Returns a const iterator referring to the past-the-end element in the sequence.
106   const_iterator cend() const { Iterator anIter (*this, false); anIter.Next(); return anIter; }
107
108  public:
109   // ---------- PUBLIC METHODS ------------
110
111   //! Constructor
112   NCollection_Sequence(const Handle(NCollection_BaseAllocator)& theAllocator=0L) :
113     NCollection_BaseSequence(theAllocator) {}
114
115   //! Copy constructor
116   NCollection_Sequence (const NCollection_Sequence& theOther) :
117     NCollection_BaseSequence(theOther.myAllocator)
118   {
119     Assign (theOther);
120   }
121
122   //! Number of items
123   Standard_Integer Size (void) const
124   { return mySize; }
125
126   //! Number of items
127   Standard_Integer Length (void) const
128   { return mySize; }
129
130   //! Method for consistency with other collections.
131   //! @return Lower bound (inclusive) for iteration.
132   Standard_Integer Lower() const
133   {
134     return 1;
135   }
136
137   //! Method for consistency with other collections.
138   //! @return Upper bound (inclusive) for iteration.
139   Standard_Integer Upper() const
140   {
141     return mySize;
142   }
143
144   //! Empty query
145   Standard_Boolean IsEmpty (void) const
146   { return (mySize==0); }
147
148   //! Reverse sequence
149   void Reverse (void)
150   { PReverse(); }
151
152   //! Exchange two members
153   void Exchange (const Standard_Integer I,
154                  const Standard_Integer J )
155   { PExchange(I, J); }
156
157   //! Static deleter to be passed to BaseSequence
158   static void delNode (NCollection_SeqNode * theNode, 
159                        Handle(NCollection_BaseAllocator)& theAl)
160   {
161     ((Node *) theNode)->~Node();
162     theAl->Free(theNode);
163   }
164
165   //! Clear the items out, take a new allocator if non null
166   void Clear (const Handle(NCollection_BaseAllocator)& theAllocator=0L)
167   {
168     ClearSeq (delNode);
169     if (!theAllocator.IsNull())
170       this->myAllocator = theAllocator;
171   }
172   
173   //! Replace this sequence by the items of theOther
174   NCollection_Sequence& Assign (const NCollection_Sequence& theOther)
175   { 
176     if (this == &theOther) 
177       return *this;
178     Clear (theOther.myAllocator);
179     Node * pCur = (Node *) theOther.myFirstItem;
180     while (pCur) {
181       Node* pNew = new (this->myAllocator) Node (pCur->Value());
182       PAppend (pNew);
183       pCur = (Node *) pCur->Next();
184     }
185     return * this;
186   }
187
188   //! Replacement operator
189   NCollection_Sequence& operator= (const NCollection_Sequence& theOther)
190   {
191     return Assign (theOther);
192   }
193
194   //! Remove one item
195   void Remove (Iterator& thePosition)
196   { RemoveSeq (thePosition, delNode); }
197
198   //! Remove one item
199   void Remove (const Standard_Integer theIndex)
200   { RemoveSeq (theIndex, delNode); }
201
202   //! Remove range of items
203   void Remove (const Standard_Integer theFromIndex,
204                const Standard_Integer theToIndex)
205   { RemoveSeq (theFromIndex, theToIndex, delNode); }
206
207   //! Append one item
208   void Append (const TheItemType& theItem)
209   { PAppend (new (this->myAllocator) Node (theItem)); }
210
211   //! Append another sequence (making it empty)
212   void Append (NCollection_Sequence& theSeq)
213   {
214     if (myFirstItem == theSeq.myFirstItem) Assign (theSeq);
215     PAppend (theSeq);
216   }
217
218   //! Prepend one item
219   void Prepend (const TheItemType& theItem)
220   { PPrepend (new (this->myAllocator) Node (theItem)); }
221
222   //! Prepend another sequence (making it empty)
223   void Prepend (NCollection_Sequence& theSeq)
224   {
225     if (myFirstItem == theSeq.myFirstItem) Assign (theSeq);
226     PPrepend (theSeq);
227   }
228
229   //! InsertBefore theIndex theItem
230   void InsertBefore (const Standard_Integer theIndex, 
231                      const TheItemType&     theItem)
232   { InsertAfter (theIndex-1, theItem); }
233
234   //! InsertBefore theIndex another sequence
235   void InsertBefore (const Standard_Integer theIndex,
236                      NCollection_Sequence&  theSeq)
237   { InsertAfter (theIndex-1, theSeq); }
238   
239   //! InsertAfter the position of iterator
240   void InsertAfter  (Iterator&              thePosition,
241                      const TheItemType&     theItem)
242   { PInsertAfter (thePosition, new (this->myAllocator) Node (theItem)); }
243
244   //! InsertAfter theIndex theItem
245   void InsertAfter  (const Standard_Integer theIndex,
246                      NCollection_Sequence&  theSeq)
247   { PInsertAfter (theIndex, theSeq); }
248
249   //! InsertAfter theIndex another sequence
250   void InsertAfter (const Standard_Integer  theIndex, 
251                     const TheItemType&      theItem)
252   {
253     Standard_OutOfRange_Raise_if (theIndex < 0 || theIndex > mySize, "NCollection_Sequence::InsertAfter");
254     PInsertAfter (theIndex, new (this->myAllocator) Node (theItem));
255   }
256
257   //! Split in two sequences
258   void Split (const Standard_Integer theIndex, NCollection_Sequence& theSeq)
259   {
260     theSeq.Clear (this->myAllocator);
261     PSplit (theIndex, theSeq);
262   }
263
264   //! First item access
265   const TheItemType& First () const
266   {
267     Standard_NoSuchObject_Raise_if (mySize == 0, "NCollection_Sequence::First");
268     return ((const Node *) myFirstItem) -> Value();
269   }
270
271   //! First item access
272   TheItemType& ChangeFirst()
273   {
274     Standard_NoSuchObject_Raise_if (mySize == 0, "NCollection_Sequence::ChangeFirst");
275     return ((Node* )myFirstItem)->ChangeValue();
276   }
277
278   //! Last item access
279   const TheItemType& Last () const
280   {
281     Standard_NoSuchObject_Raise_if (mySize == 0, "NCollection_Sequence::Last");
282     return ((const Node *) myLastItem) -> Value();
283   }
284
285   //! Last item access
286   TheItemType& ChangeLast()
287   {
288     Standard_NoSuchObject_Raise_if (mySize == 0, "NCollection_Sequence::ChangeLast");
289     return ((Node* )myLastItem)->ChangeValue();
290   }
291
292   //! Constant item access by theIndex
293   const TheItemType& Value (const Standard_Integer theIndex) const
294   {
295     Standard_OutOfRange_Raise_if (theIndex <= 0 || theIndex > mySize, "NCollection_Sequence::Value");
296
297     NCollection_Sequence * const aLocalTHIS = (NCollection_Sequence *) this;
298     aLocalTHIS -> myCurrentItem  = Find (theIndex);
299     aLocalTHIS -> myCurrentIndex = theIndex;
300     return ((const Node *) myCurrentItem) -> Value();
301   }
302
303   //! Constant operator()
304   const TheItemType& operator() (const Standard_Integer theIndex) const
305   { return Value(theIndex); }
306
307   //! Variable item access by theIndex
308   TheItemType& ChangeValue (const Standard_Integer theIndex)
309   {
310     Standard_OutOfRange_Raise_if (theIndex <= 0 || theIndex > mySize, "NCollection_Sequence::ChangeValue");
311
312     myCurrentItem  = Find (theIndex);
313     myCurrentIndex = theIndex;
314     return ((Node *) myCurrentItem) -> ChangeValue();
315   }
316
317   //! Variable operator()
318   TheItemType& operator() (const Standard_Integer theIndex)
319   { return ChangeValue(theIndex); }
320
321   //! Set item value by theIndex
322   void SetValue (const Standard_Integer theIndex, 
323                  const TheItemType& theItem)
324   { ChangeValue (theIndex) = theItem; }
325
326   // ******** Destructor - clears the Sequence
327   ~NCollection_Sequence (void)
328   { Clear(); }
329
330  private:
331
332   // ---------- FRIEND CLASSES ------------
333   friend class Iterator;
334
335 };
336
337 #endif