Qt Toolkit - qbitarray.h include file

# qbitarray.h

This is the verbatim text of the qbitarray.h include file. It is is provided only for illustration; the copyright remains with Troll Tech.

    /****************************************************************************
    ** $Id: qbitarray.h,v 2.6.2.2 1998/08/25 09:20:54 hanord Exp $
    **
    ** Definition of QBitArray class
    **
    ** Created : 940118
    **
    ** Copyright (C) 1992-1999 Troll Tech AS.  All rights reserved.
    **
    ** This file is part of Qt Free Edition, version 1.45.
    **
    ** See the file LICENSE included in the distribution for the usage
    ** and distribution terms, or http://www.troll.no/free-license.html.
    **
    ** IMPORTANT NOTE: You may NOT copy this file or any part of it into
    ** your own programs or libraries.
    **
    ** Please see http://www.troll.no/pricing.html for information about
    ** Qt Professional Edition, which is this same library but with a
    ** license which allows creation of commercial/proprietary software.
    **
    *****************************************************************************/

    #ifndef QBITARRAY_H
    #define QBITARRAY_H

    #ifndef QT_H
    #include "qstring.h"
    #endif // QT_H

    /*****************************************************************************
      QBitVal class; a context class for QBitArray::operator[]
     *****************************************************************************/

    class QBitArray;

    class Q_EXPORT QBitVal
    {
    private:
        QBitArray *array;
        uint    index;
    public:
        QBitVal( QBitArray *a, uint i ) : array(a), index(i) {}
        operator int();
        QBitVal &operator=( const QBitVal &v );
        QBitVal &operator=( int v );
    };

    /*****************************************************************************
      QBitArray class
     *****************************************************************************/

    class Q_EXPORT QBitArray : public QByteArray
    {
    public:
        QBitArray();
        QBitArray( uint size );
        QBitArray( const QBitArray &a ) : QByteArray( a ) {}

        QBitArray &operator=( const QBitArray & );

        uint    size() const;
        bool    resize( uint size );

        bool    fill( bool v, int size = -1 );

        void    detach();
        QBitArray copy() const;

        bool    testBit( uint index ) const;
        void    setBit( uint index );
        void    setBit( uint index, bool value );
        void    clearBit( uint index );
        bool    toggleBit( uint index );

        bool    at( uint index ) const;
        QBitVal operator[]( int index );

        QBitArray &operator&=( const QBitArray & );
        QBitArray &operator|=( const QBitArray & );
        QBitArray &operator^=( const QBitArray & );
        QBitArray  operator~() const;

    protected:
        struct bitarr_data : public QGArray::array_data {
            uint   nbits;
        };
        array_data *newData()                   { return new bitarr_data; }
        void        deleteData( array_data *d ) { delete (bitarr_data*)d; }
    private:
        void    pad0();
    };

    inline QBitArray &QBitArray::operator=( const QBitArray &a )
    { return (QBitArray&)assign( a ); }

    inline uint QBitArray::size() const
    { return ((bitarr_data*)sharedBlock())->nbits; }

    inline void QBitArray::setBit( uint index, bool value )
    { if ( value ) setBit(index); else clearBit(index); }

    inline bool QBitArray::at( uint index ) const
    { return testBit(index); }

    inline QBitVal QBitArray::operator[]( int index )
    { return QBitVal( (QBitArray*)this, index ); }

    /*****************************************************************************
      Misc. QBitArray operator functions
     *****************************************************************************/

    Q_EXPORT QBitArray operator&( const QBitArray &, const QBitArray & );
    Q_EXPORT QBitArray operator|( const QBitArray &, const QBitArray & );
    Q_EXPORT QBitArray operator^( const QBitArray &, const QBitArray & );

    inline QBitVal::operator int()
    {
        return array->testBit( index );
    }

    inline QBitVal &QBitVal::operator=( const QBitVal &v )
    {
        array->setBit( index, v.array->testBit(v.index) );
        return *this;
    }

    inline QBitVal &QBitVal::operator=( int v )     // ### Qt 2.0: change to bool
    {
        array->setBit( index, v );
        return *this;
    }

    /*****************************************************************************
      QBitArray stream functions
     *****************************************************************************/

    Q_EXPORT QDataStream &operator<<( QDataStream &, const QBitArray & );
    Q_EXPORT QDataStream &operator>>( QDataStream &, QBitArray & );

    #endif // QBITARRAY_H