src/qt3support/tools/q3gvector.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the Qt3Support module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef Q3GVECTOR_H
  43 #define Q3GVECTOR_H
  44
  45 #include <Qt3Support/q3ptrcollection.h>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 QT_MODULE(Qt3SupportLight)
  52
  53 class Q_COMPAT_EXPORT Q3GVector : public Q3PtrCollection        // generic vector
  54 {
  55 friend class Q3GList;                           // needed by Q3GList::toVector
  56 public:
  57 #ifndef QT_NO_DATASTREAM
  58     QDataStream &read( QDataStream & );         // read vector from stream
  59     QDataStream &write( QDataStream & ) const;  // write vector to stream
  60 #endif
  61     virtual int compareItems( Item, Item );
  62
  63 protected:
  64     Q3GVector();                                        // create empty vector
  65     Q3GVector( uint size );                     // create vector with nullptrs
  66     Q3GVector( const Q3GVector &v );            // make copy of other vector
  67    ~Q3GVector();
  68
  69     Q3GVector &operator=( const Q3GVector &v ); // assign from other vector
  70     bool operator==( const Q3GVector &v ) const;
  71
  72     Item         *data()    const       { return vec; }
  73     uint  size()    const       { return len; }
  74     uint  count()   const       { return numItems; }
  75
  76     bool  insert( uint index, Item );           // insert item at index
  77     bool  remove( uint index );                 // remove item
  78     Item          take( uint index );                   // take out item
  79
  80     void  clear();                              // clear vector
  81     bool  resize( uint newsize );               // resize vector
  82
  83     bool  fill( Item, int flen );               // resize and fill vector
  84
  85     void  sort();                               // sort vector
  86     int   bsearch( Item ) const;                        // binary search (when sorted)
  87
  88     int   findRef( Item, uint index ) const;    // find exact item in vector
  89     int   find( Item, uint index ) const;       // find equal item in vector
  90     uint  containsRef( Item ) const;            // get number of exact matches
  91     uint  contains( Item ) const;               // get number of equal matches
  92
  93     Item          at( uint index ) const                // return indexed item
  94     {
  95 #if defined(QT_CHECK_RANGE)
  96         if ( index >= len )
  97             warningIndexRange( index );
  98 #endif
  99         return vec[index];
 100     }
 101
 102     bool insertExpand( uint index, Item );      // insert, expand if necessary
 103
 104     void toList( Q3GList * ) const;             // put items in list
 105
 106 #ifndef QT_NO_DATASTREAM
 107     virtual QDataStream &read( QDataStream &, Item & );
 108     virtual QDataStream &write( QDataStream &, Item ) const;
 109 #endif
 110 private:
 111     Item         *vec;
 112     uint  len;
 113     uint  numItems;
 114
 115     static void warningIndexRange( uint );
 116 };
 117
 118
 119 /*****************************************************************************
 120   Q3GVector stream functions
 121  *****************************************************************************/
 122
 123 #ifndef QT_NO_DATASTREAM
 124 Q_COMPAT_EXPORT QDataStream &operator>>( QDataStream &, Q3GVector & );
 125 Q_COMPAT_EXPORT QDataStream &operator<<( QDataStream &, const Q3GVector & );
 126 #endif
 127
 128 QT_END_NAMESPACE
 129
 130 QT_END_HEADER
 131
 132 #endif // Q3GVECTOR_H