home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / qt3_emx.zip / include / qglist.h < prev    next >
C/C++ Source or Header  |  2001-10-11  |  8KB  |  252 lines
  1. /****************************************************************************
  2. ** $Id:  qt/qglist.h   3.0.0   edited Jun 22 12:41 $
  3. **
  4. ** Definition of QGList and QGListIterator classes
  5. **
  6. ** Created : 920624
  7. **
  8. ** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.
  9. **
  10. ** This file is part of the tools module of the Qt GUI Toolkit.
  11. **
  12. ** This file may be distributed under the terms of the Q Public License
  13. ** as defined by Trolltech AS of Norway and appearing in the file
  14. ** LICENSE.QPL included in the packaging of this file.
  15. **
  16. ** This file may be distributed and/or modified under the terms of the
  17. ** GNU General Public License version 2 as published by the Free Software
  18. ** Foundation and appearing in the file LICENSE.GPL included in the
  19. ** packaging of this file.
  20. **
  21. ** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
  22. ** licenses may use this file in accordance with the Qt Commercial License
  23. ** Agreement provided with the Software.
  24. **
  25. ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  26. ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  27. **
  28. ** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
  29. **   information about Qt Commercial License Agreements.
  30. ** See http://www.trolltech.com/qpl/ for QPL licensing information.
  31. ** See http://www.trolltech.com/gpl/ for GPL licensing information.
  32. **
  33. ** Contact info@trolltech.com if any conditions of this licensing are
  34. ** not clear to you.
  35. **
  36. **********************************************************************/
  37.  
  38. #ifndef QGLIST_H
  39. #define QGLIST_H
  40.  
  41. #ifndef QT_H
  42. #include "qptrcollection.h"
  43. #endif // QT_H
  44.  
  45. class Q_EXPORT QLNode
  46. {
  47. friend class QGList;
  48. friend class QGListIterator;
  49. public:
  50.     QPtrCollection::Item getData()    { return data; }
  51. private:
  52.     QPtrCollection::Item data;
  53.     QLNode *prev;
  54.     QLNode *next;
  55.     QLNode( QPtrCollection::Item d ) { data = d; }
  56. };
  57.  
  58. class QGListIteratorList; // internal helper class
  59.  
  60. class Q_EXPORT QGList : public QPtrCollection    // doubly linked generic list
  61. {
  62. friend class QGListIterator;
  63. friend class QGListIteratorList;
  64. friend class QGVector;                // needed by QGVector::toList
  65. public:
  66.     uint  count() const;            // return number of nodes
  67.  
  68. #ifndef QT_NO_DATASTREAM
  69.     QDataStream &read( QDataStream & );        // read list from stream
  70.     QDataStream &write( QDataStream & ) const;    // write list to stream
  71. #endif
  72. protected:
  73.     QGList();                    // create empty list
  74.     QGList( const QGList & );            // make copy of other list
  75.     virtual ~QGList();
  76.  
  77.     QGList &operator=( const QGList & );    // assign from other list
  78.     bool operator==( const QGList& ) const;
  79.  
  80.     void inSort( QPtrCollection::Item );        // add item sorted in list
  81.     void append( QPtrCollection::Item );        // add item at end of list
  82.     bool insertAt( uint index, QPtrCollection::Item ); // add item at i'th position
  83.     void relinkNode( QLNode * );        // relink as first item
  84.     bool removeNode( QLNode * );        // remove node
  85.     bool remove( QPtrCollection::Item = 0 );    // remove item (0=current)
  86.     bool removeRef( QPtrCollection::Item = 0 );    // remove item (0=current)
  87.     bool removeFirst();                // remove first item
  88.     bool removeLast();                // remove last item
  89.     bool removeAt( uint index );        // remove item at i'th position
  90.     QPtrCollection::Item takeNode( QLNode * );    // take out node
  91.     QPtrCollection::Item take();            // take out current item
  92.     QPtrCollection::Item takeAt( uint index );    // take out item at i'th pos
  93.     QPtrCollection::Item takeFirst();        // take out first item
  94.     QPtrCollection::Item takeLast();        // take out last item
  95.  
  96.     void sort();                        // sort all items;
  97.     void clear();            // remove all items
  98.  
  99.     int     findRef( QPtrCollection::Item, bool = TRUE ); // find exact item in list
  100.     int     find( QPtrCollection::Item, bool = TRUE ); // find equal item in list
  101.  
  102.     uint containsRef( QPtrCollection::Item ) const; // get number of exact matches
  103.     uint contains( QPtrCollection::Item )    const;    // get number of equal matches
  104.  
  105.     QPtrCollection::Item at( uint index );        // access item at i'th pos
  106.     int      at() const;                // get current index
  107.     QLNode *currentNode() const;        // get current node
  108.  
  109.     QPtrCollection::Item get() const;        // get current item
  110.  
  111.     QPtrCollection::Item cfirst() const;    // get ptr to first list item
  112.     QPtrCollection::Item clast()  const;    // get ptr to last list item
  113.     QPtrCollection::Item first();        // set first item in list curr
  114.     QPtrCollection::Item last();        // set last item in list curr
  115.     QPtrCollection::Item next();        // set next item in list curr
  116.     QPtrCollection::Item prev();        // set prev item in list curr
  117.  
  118.     void  toVector( QGVector * ) const;        // put items in vector
  119.  
  120.     virtual int compareItems( QPtrCollection::Item, QPtrCollection::Item );
  121.  
  122. #ifndef QT_NO_DATASTREAM
  123.     virtual QDataStream &read( QDataStream &, QPtrCollection::Item & );
  124.     virtual QDataStream &write( QDataStream &, QPtrCollection::Item ) const;
  125. #endif
  126. private:
  127.     void  prepend( QPtrCollection::Item ); // add item at start of list
  128.  
  129.     void heapSortPushDown( QPtrCollection::Item* heap, int first, int last );
  130.  
  131.     QLNode *firstNode;                // first node
  132.     QLNode *lastNode;                // last node
  133.     QLNode *curNode;                // current node
  134.     int curIndex;                // current index
  135.     uint numNodes;                // number of nodes
  136.     QGListIteratorList *iterators;             // list of iterators
  137.  
  138.     QLNode *locate( uint );            // get node at i'th pos
  139.     QLNode *unlink();                // unlink node
  140. };
  141.  
  142.  
  143. inline uint QGList::count() const
  144. {
  145.     return numNodes;
  146. }
  147.  
  148. inline bool QGList::removeFirst()
  149. {
  150.     first();
  151.     return remove();
  152. }
  153.  
  154. inline bool QGList::removeLast()
  155. {
  156.     last();
  157.     return remove();
  158. }
  159.  
  160. inline int QGList::at() const
  161. {
  162.     return curIndex;
  163. }
  164.  
  165. inline QPtrCollection::Item QGList::at( uint index )
  166. {
  167.     QLNode *n = locate( index );
  168.     return n ? n->data : 0;
  169. }
  170.  
  171. inline QLNode *QGList::currentNode() const
  172. {
  173.     return curNode;
  174. }
  175.  
  176. inline QPtrCollection::Item QGList::get() const
  177. {
  178.     return curNode ? curNode->data : 0;
  179. }
  180.  
  181. inline QPtrCollection::Item QGList::cfirst() const
  182. {
  183.     return firstNode ? firstNode->data : 0;
  184. }
  185.  
  186. inline QPtrCollection::Item QGList::clast() const
  187. {
  188.     return lastNode ? lastNode->data : 0;
  189. }
  190.  
  191.  
  192. /*****************************************************************************
  193.   QGList stream functions
  194.  *****************************************************************************/
  195.  
  196. #ifndef QT_NO_DATASTREAM
  197. Q_EXPORT QDataStream &operator>>( QDataStream &, QGList & );
  198. Q_EXPORT QDataStream &operator<<( QDataStream &, const QGList & );
  199. #endif
  200.  
  201. /*****************************************************************************
  202.   QGListIterator class
  203.  *****************************************************************************/
  204.  
  205. class Q_EXPORT QGListIterator            // QGList iterator
  206. {
  207. friend class QGList;
  208. friend class QGListIteratorList;
  209. protected:
  210.     QGListIterator( const QGList & );
  211.     QGListIterator( const QGListIterator & );
  212.     QGListIterator &operator=( const QGListIterator & );
  213.    ~QGListIterator();
  214.  
  215.     bool  atFirst() const;            // test if at first item
  216.     bool  atLast()  const;            // test if at last item
  217.     QPtrCollection::Item      toFirst();                // move to first item
  218.     QPtrCollection::Item      toLast();                // move to last item
  219.  
  220.     QPtrCollection::Item      get() const;                // get current item
  221.     QPtrCollection::Item      operator()();                // get current and move to next
  222.     QPtrCollection::Item      operator++();                // move to next item (prefix)
  223.     QPtrCollection::Item      operator+=(uint);            // move n positions forward
  224.     QPtrCollection::Item      operator--();                // move to prev item (prefix)
  225.     QPtrCollection::Item      operator-=(uint);            // move n positions backward
  226.  
  227. protected:
  228.     QGList *list;                // reference to list
  229.  
  230. private:
  231.     QLNode  *curNode;                // current node in list
  232. };
  233.  
  234.  
  235. inline bool QGListIterator::atFirst() const
  236. {
  237.     return curNode == list->firstNode;
  238. }
  239.  
  240. inline bool QGListIterator::atLast() const
  241. {
  242.     return curNode == list->lastNode;
  243. }
  244.  
  245. inline QPtrCollection::Item QGListIterator::get() const
  246. {
  247.     return curNode ? curNode->data : 0;
  248. }
  249.  
  250.  
  251. #endif    // QGLIST_H
  252.