QGVector Class Reference

The QGVector class is an internal class for implementing Qt collection classes. More...

#include <qgvector.h>

Inheritance diagram for QGVector:

Public Member Functions
QDataStream &	read (QDataStream &)
QDataStream &	write (QDataStream &) const
virtual int	compareItems (Item, Item)
Public Member Functions inherited from QCollection
bool	autoDelete () const
void	setAutoDelete (bool enable)

Protected Member Functions
	QGVector ()
	QGVector (uint size)
	QGVector (const QGVector &v)
	~QGVector ()
QGVector &	operator= (const QGVector &v)
Item *	data () const
uint	size () const
uint	count () const
bool	insert (uint index, Item)
bool	remove (uint index)
Item	take (uint index)
void	clear ()
bool	resize (uint newsize)
bool	fill (Item, int flen)
void	sort ()
int	bsearch (Item) const
int	findRef (Item, uint index) const
int	find (Item, uint index) const
uint	containsRef (Item) const
uint	contains (Item) const
Item	at (uint index) const
bool	insertExpand (uint index, Item)
void	toList (QGList *) const
virtual QDataStream &	read (QDataStream &, Item &)
virtual QDataStream &	write (QDataStream &, Item) const
Protected Member Functions inherited from QCollection
	QCollection ()
	QCollection (const QCollection &)
virtual	~QCollection ()
virtual Item	newItem (Item)
virtual void	deleteItem (Item)

Static Private Member Functions
static void	warningIndexRange (uint)

Private Attributes
Item *	vec
uint	len
uint	numItems

Friends
class	QGList

Additional Inherited Members
Public Types inherited from QCollection
typedef void *	Item
Protected Attributes inherited from QCollection
bool	del_item

Detailed Description

The QGVector class is an internal class for implementing Qt collection classes.

QGVector is a strictly internal class that acts as a base class for the QVector collection class.

QGVector has some virtual functions that may be reimplemented in subclasses to to customize behavior.

• compareItems() compares two collection/vector items.
• read() reads a collection/vector item from a QDataStream.
• write() writes a collection/vector item to a QDataStream.

Definition at line 46 of file qgvector.h.

Constructor & Destructor Documentation

QGVector::QGVector ( )

protected

Definition at line 154 of file qgvector.cpp.

{
    vec = 0;
    len = numItems = 0;
}

QGVector::QGVector ( uint  size )

protected

Definition at line 163 of file qgvector.cpp.

{
    len = size;
    numItems = 0;
    if ( len == 0 ) {                           // zero length
        vec = 0;
        return;
    }
    vec = NEW(Item,len);
    CHECK_PTR( vec );
    memset( (void*)vec, 0, len*sizeof(Item) );  // fill with nulls
}

QGVector::QGVector ( const QGVector &  v )

protected

Definition at line 180 of file qgvector.cpp.

    : QCollection( a )
{
    len = a.len;
    numItems = a.numItems;
    vec = NEW(Item,len);
    CHECK_PTR( vec );
    for ( uint i=0; i<len; i++ ) {
        vec[i] = a.vec[i] ? newItem( a.vec[i] ) : 0;
        CHECK_PTR( vec[i] );
    }
}

QGVector::~QGVector ( )

protected

Definition at line 197 of file qgvector.cpp.

{
    clear();
}

Member Function Documentation

Item QGVector::at ( uint  index ) const

inlineprotected

Definition at line 85 of file qgvector.h.

    {
#if defined(CHECK_RANGE)
        if ( index >= len )
            warningIndexRange( index );
#endif
        return vec[index];
    }

int QGVector::bsearch ( Item  d ) const

protected

Definition at line 439 of file qgvector.cpp.

{
    if ( !len )
        return -1;
    if ( !d ) {
#if defined(CHECK_NULL)
        qWarning( "QGVector::bsearch: Cannot search for null object" );
#endif
        return -1;
    }
    int n1 = 0;
    int n2 = len - 1;
    int mid = 0;
    bool found = FALSE;
    while ( n1 <= n2 ) {
        int  res;
        mid = (n1 + n2)/2;
        if ( vec[mid] == 0 )                    // null item greater
            res = -1;
        else
            res = ((QGVector*)this)->compareItems( d, vec[mid] );
        if ( res < 0 )
            n2 = mid - 1;
        else if ( res > 0 )
            n1 = mid + 1;
        else {                                  // found it
            found = TRUE;
            break;
        }
    }
    if ( !found )
        return -1;
    // search to first of equal items
    while ( (mid - 1 >= 0) && !((QGVector*)this)->compareItems(d, vec[mid-1]) )
        mid--;
    return mid;
}

void QGVector::clear ( )

protectedvirtual

Removes all objects from the collection. The objects will be deleted if auto-delete has been enabled.

See also

setAutoDelete()

Implements QCollection.

Reimplemented in QVector< type >, and QVector< QList< IndexWord > >.

Definition at line 313 of file qgvector.cpp.

{
    if ( vec ) {
        for ( uint i=0; i<len; i++ ) {          // delete each item
            if ( vec[i] )
                deleteItem( vec[i] );
        }
        DELETE(vec);
        vec = 0;
        len = numItems = 0;
    }
}

int QGVector::compareItems ( Item  d1, Item  d2  )

virtual

This virtual function compares two list items.

Returns:

• 0 if item1 == item2
• non-zero if item1 != item2

This function returns int rather than bool so that reimplementations can return one of three values and use it to sort by:

• 0 if item1 == item2
• > 0 (positive integer) if item1 > item2
• < 0 (negative integer) if item1 < item2

The QVector::sort() and QVector::bsearch() functions require that compareItems() is implemented as described here.

This function should not modify the vector because some const functions call compareItems().

Reimplemented in QStrIVec, and QStrVec.

Definition at line 110 of file qgvector.cpp.

{
    return d1 != d2;                            // compare pointers
}

uint QGVector::contains ( Item  d ) const

protected

Definition at line 536 of file qgvector.cpp.

{
    uint count = 0;
    for ( uint i=0; i<len; i++ ) {
        if ( vec[i] == 0 && d == 0 )            // count null items
            count++;
        if ( vec[i] && ((QGVector*)this)->compareItems( vec[i], d ) == 0 )
            count++;
    }
    return count;
}

uint QGVector::containsRef ( Item  d ) const

protected

Definition at line 522 of file qgvector.cpp.

{
    uint count = 0;
    for ( uint i=0; i<len; i++ ) {
        if ( vec[i] == d )
            count++;
    }
    return count;
}

uint QGVector::count ( ) const

inlineprotectedvirtual

Returns the number of objects in the collection.

Implements QCollection.

Reimplemented in QVector< type >, and QVector< QList< IndexWord > >.

Definition at line 66 of file qgvector.h.

{ return numItems; }

Item * QGVector::data ( ) const

inlineprotected

Definition at line 64 of file qgvector.h.

{ return vec; }

bool QGVector::fill ( Item  d, int  flen  )

protected

Definition at line 377 of file qgvector.cpp.

{
    if ( flen < 0 )
        flen = len;                             // default: use vector length
    else if ( !resize( flen ) )
        return FALSE;
    for ( uint i=0; i<(uint)flen; i++ )         // insert d at every index
        insert( i, d );
    return TRUE;
}

int QGVector::find ( Item  d, uint  index  ) const

protected

Definition at line 501 of file qgvector.cpp.

{
#if defined(CHECK_RANGE)
    if ( index >= len ) {                       // range error
        qWarning( "QGVector::find: Index %d out of range", index );
        return -1;
    }
#endif
    for ( uint i=index; i<len; i++ ) {
        if ( vec[i] == 0 && d == 0 )            // found null item
            return i;
        if ( vec[i] && ((QGVector*)this)->compareItems( vec[i], d ) == 0 )
            return i;
    }
    return -1;
}

int QGVector::findRef ( Item  d, uint  index  ) const

protected

Definition at line 482 of file qgvector.cpp.

{
#if defined(CHECK_RANGE)
    if ( index >= len ) {                       // range error
        qWarning( "QGVector::findRef: Index %d out of range", index );
        return -1;
    }
#endif
    for ( uint i=index; i<len; i++ ) {
        if ( vec[i] == d )
            return i;
    }
    return -1;
}

bool QGVector::insert ( uint  index, Item  d  )

protected

Definition at line 246 of file qgvector.cpp.

{
#if defined(CHECK_RANGE)
    if ( index >= len ) {                       // range error
        qWarning( "QGVector::insert: Index %d out of range", index );
        return FALSE;
    }
#endif
    if ( vec[index] ) {                         // remove old item
        deleteItem( vec[index] );
        numItems--;
    }
    if ( d ) {
        vec[index] = newItem( d );
        CHECK_PTR( vec[index] );
        numItems++;
        return vec[index] != 0;
    } else {
        vec[index] = 0;                         // reset item
    }
    return TRUE;
}

bool QGVector::insertExpand ( uint  index, Item  d  )

protected

Definition at line 553 of file qgvector.cpp.

{
    if ( index >= len ) {
        if ( !resize( index+1 ) )               // no memory
            return FALSE;
    }
    insert( index, d );
    return TRUE;
}

QGVector & QGVector::operator= ( const QGVector &  v )

protected

Definition at line 207 of file qgvector.cpp.

{                                               // assign from other vector
    clear();                                    // first delete old vector
    len = v.len;
    numItems = v.numItems;
    vec = NEW(Item,len);                                // create new vector
    CHECK_PTR( vec );
    for ( uint i=0; i<len; i++ ) {              // copy elements
        vec[i] = v.vec[i] ? newItem( v.vec[i] ) : 0;
        CHECK_PTR( vec[i] );
    }
    return *this;
}

QDataStream & QGVector::read

(

QDataStream &

s

)

Definition at line 606 of file qgvector.cpp.

{
    uint num;
    s >> num;                                   // read number of items
    clear();                                    // clear vector
    resize( num );
    for (uint i=0; i<num; i++) {                // read all items
        Item d;
        read( s, d );
        CHECK_PTR( d );
        if ( !d )                               // no memory
            break;
        vec[i] = d;
    }
    return s;
}

QDataStream & QGVector::read ( QDataStream &  s, Item &  d  )

protectedvirtual

Reads a collection/vector item from the stream s and returns a reference to the stream.

The default implementation sets item to 0.

See also

write()

Reimplemented in QStrVec.

Definition at line 125 of file qgvector.cpp.

{                                               // read item from stream
    d = 0;
    return s;
}

bool QGVector::remove ( uint  index )

protected

Definition at line 273 of file qgvector.cpp.

{
#if defined(CHECK_RANGE)
    if ( index >= len ) {                       // range error
        qWarning( "QGVector::remove: Index %d out of range", index );
        return FALSE;
    }
#endif
    if ( vec[index] ) {                         // valid item
        deleteItem( vec[index] );               // delete it
        vec[index] = 0;                         // reset pointer
        numItems--;
    }
    return TRUE;
}

bool QGVector::resize ( uint  newsize )

protected

Definition at line 330 of file qgvector.cpp.

{
    if ( newsize == len )                       // nothing to do
        return TRUE;
    if ( vec ) {                                // existing data
        if ( newsize < len ) {                  // shrink vector
            uint i = newsize;
            while ( i < len ) {                 // delete lost items
                if ( vec[i] ) {
                    deleteItem( vec[i] );
                    numItems--;
                }
                i++;
            }
        }
        if ( newsize == 0 ) {                   // vector becomes empty
            DELETE(vec);
            vec = 0;
            len = numItems = 0;
            return TRUE;
        }
#if defined(DONT_USE_REALLOC)
        Item *newvec = NEW(Item,newsize);               // manual realloc
        memcpy( newvec, vec, (len < newsize ? len : newsize)*sizeof(Item) );
        DELETE(vec);
        vec = newvec;
#else
        vec = (Item*)realloc( (char *)vec, newsize*sizeof(Item) );
#endif
    } else {                                    // create new vector
        vec = NEW(Item,newsize);
        len = numItems = 0;
    }
    CHECK_PTR( vec );
    if ( !vec )                                 // no memory
        return FALSE;
    if ( newsize > len )                        // init extra space added
        memset( (void*)&vec[len], 0, (newsize-len)*sizeof(Item) );
    len = newsize;
    return TRUE;
}

uint QGVector::size ( ) const

inlineprotected

Definition at line 65 of file qgvector.h.

{ return len; }

void QGVector::sort ( )

protected

Definition at line 410 of file qgvector.cpp.

{
    if ( count() == 0 )                         // no elements
        return;
    register Item *start = &vec[0];
    register Item *end  = &vec[len-1];
    Item tmp;
    while ( TRUE ) {                            // put all zero elements behind
        while ( start < end && *start != 0 )
            start++;
        while ( end > start && *end == 0 )
            end--;
        if ( start < end ) {
            tmp = *start;
            *start = *end;
            *end = tmp;
        } else {
            break;
        }
    }
    sort_vec = (QGVector*)this;
    qsort( vec, count(), sizeof(Item), cmp_vec );
    sort_vec = 0;
}

QCollection::Item QGVector::take ( uint  index )

protected

Definition at line 293 of file qgvector.cpp.

{
#if defined(CHECK_RANGE)
    if ( index >= len ) {                       // range error
        qWarning( "QGVector::take: Index %d out of range", index );
        return 0;
    }
#endif
    Item d = vec[index];                                // don't delete item
    if ( d )
        numItems--;
    vec[index] = 0;
    return d;
}

void QGVector::toList ( QGList *  list ) const

protected

Definition at line 568 of file qgvector.cpp.

{
    list->clear();
    for ( uint i=0; i<len; i++ ) {
        if ( vec[i] )
            list->append( vec[i] );
    }
}

void QGVector::warningIndexRange ( uint  i )

staticprivate

Definition at line 578 of file qgvector.cpp.

{
#if defined(CHECK_RANGE)
    qWarning( "QGVector::operator[]: Index %d out of range", i );
#else
    Q_UNUSED( i )
#endif
}

QDataStream & QGVector::write

(

QDataStream &

s

)

const

Definition at line 627 of file qgvector.cpp.

{                                               // write vector to stream
    uint num = count();
    s << num;                                   // number of items to write
    num = size();
    for (uint i=0; i<num; i++) {                // write non-null items
        if ( vec[i] )
            write( s, vec[i] );
    }
    return s;
}

QDataStream & QGVector::write ( QDataStream &  s, Item    ) const

protectedvirtual

Writes a collection/vector item to the stream s and returns a reference to the stream.

The default implementation does nothing.

See also

read()

Reimplemented in QStrVec.

Definition at line 140 of file qgvector.cpp.

{                                               // write item to stream
    return s;
}

Friends And Related Function Documentation

friend class QGList

friend

Definition at line 48 of file qgvector.h.

Member Data Documentation

uint QGVector::len

private

Definition at line 104 of file qgvector.h.

uint QGVector::numItems

private

Definition at line 105 of file qgvector.h.

Item* QGVector::vec

private

Definition at line 103 of file qgvector.h.

---

The documentation for this class was generated from the following files:

• doxygen-1.8.11/qtools/qgvector.h
• doxygen-1.8.11/qtools/qgvector.cpp