/****************************************************************************

** 

**

** Definition of QGDict and QGDictIterator classes

**

** Created : 920529

**

** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.

**

** This file is part of the tools module of the Qt GUI Toolkit.

**

** This file may be distributed under the terms of the Q Public License

** as defined by Trolltech AS of Norway and appearing in the file

** LICENSE.QPL included in the packaging of this file.

**

** This file may be distributed and/or modified under the terms of the

** GNU General Public License version 2 as published by the Free Software

** Foundation and appearing in the file LICENSE.GPL included in the

** packaging of this file.

**

** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition

** licenses may use this file in accordance with the Qt Commercial License

** Agreement provided with the Software.

**

** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE

** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

**

** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for

**   information about Qt Commercial License Agreements.

** See http://www.trolltech.com/qpl/ for QPL licensing information.

** See http://www.trolltech.com/gpl/ for GPL licensing information.

**

** Contact info@trolltech.com if any conditions of this licensing are

** not clear to you.

**

**********************************************************************/

#ifndef QGDICT_H

#define QGDICT_H

#ifndef QT_H

#include "qcollection.h"

#include "qstring.h"

#endif // QT_H

class QGDictIterator;

class QGDItList;

class QBaseBucket				// internal dict node

{

public:

    QCollection::Item	 getData()			{ return data; }

    QCollection::Item	 setData( QCollection::Item d ) { return data = d; }

    QBaseBucket		*getNext()			{ return next; }

    void		 setNext( QBaseBucket *n)	{ next = n; }

protected:

    QBaseBucket( QCollection::Item d, QBaseBucket *n ) : data(d), next(n) {}

    QCollection::Item	 data;

    QBaseBucket		*next;

};

class QStringBucket : public QBaseBucket

{

public:

    QStringBucket( const QString &k, QCollection::Item d, QBaseBucket *n )

	: QBaseBucket(d,n), key(k)		{}

    const QString  &getKey() const		{ return key; }

private:

    QString	    key;

};

class QAsciiBucket : public QBaseBucket

{

public:

    QAsciiBucket( const char *k, QCollection::Item d, QBaseBucket *n )

	: QBaseBucket(d,n), key(k) {}

    const char *getKey() const { return key; }

private:

    const char *key;

};

class QIntBucket : public QBaseBucket

{

public:

    QIntBucket( long k, QCollection::Item d, QBaseBucket *n )

	: QBaseBucket(d,n), key(k) {}

    long  getKey() const { return key; }

private:

    long  key;

};

class QPtrBucket : public QBaseBucket

{

public:

    QPtrBucket( void *k, QCollection::Item d, QBaseBucket *n )

	: QBaseBucket(d,n), key(k) {}

    void *getKey() const { return key; }

private:

    void *key;

};

class Q_EXPORT QGDict : public QCollection	// generic dictionary class

{

public:

    uint	count() const	{ return numItems; }

    uint	size()	const	{ return vlen; }

    QCollection::Item look_string( const QString& key, QCollection::Item,

				   int );

    QCollection::Item look_ascii( const char *key, QCollection::Item, int );

    QCollection::Item look_int( long key, QCollection::Item, int );

    QCollection::Item look_ptr( void *key, QCollection::Item, int );

#ifndef QT_NO_DATASTREAM

    QDataStream &read( QDataStream & );

    QDataStream &write( QDataStream & ) const;

#endif

protected:

    enum KeyType { StringKey, AsciiKey, IntKey, PtrKey };

    QGDict( uint len, KeyType kt, bool cs, bool ck );

    QGDict( const QGDict & );

   ~QGDict();

    QGDict     &operator=( const QGDict & );

    bool	remove_string( const QString &key, QCollection::Item item=0 );

    bool	remove_ascii( const char *key, QCollection::Item item=0 );

    bool	remove_int( long key, QCollection::Item item=0 );

    bool	remove_ptr( void *key, QCollection::Item item=0 );

    QCollection::Item take_string( const QString &key );

    QCollection::Item take_ascii( const char *key );

    QCollection::Item take_int( long key );

    QCollection::Item take_ptr( void *key );

    void	clear();

    void	resize( uint );

    int		hashKeyString( const QString & );

    int		hashKeyAscii( const char * );

    void	statistics() const;

#ifndef QT_NO_DATASTREAM

    virtual QDataStream &read( QDataStream &, QCollection::Item & );

    virtual QDataStream &write( QDataStream &, QCollection::Item ) const;

#endif

private:

    QBaseBucket **vec;

    uint	vlen;

    uint	numItems;

    uint	keytype	: 2;

    uint	cases	: 1;

    uint	copyk	: 1;

    QGDItList  *iterators;

    void	   unlink_common( int, QBaseBucket *, QBaseBucket * );

    QStringBucket *unlink_string( const QString &,

				  QCollection::Item item = 0 );

    QAsciiBucket  *unlink_ascii( const char *, QCollection::Item item = 0 );

    QIntBucket    *unlink_int( long, QCollection::Item item = 0 );

    QPtrBucket    *unlink_ptr( void *, QCollection::Item item = 0 );

    void	init( uint, KeyType, bool, bool );

    friend class QGDictIterator;

};

class Q_EXPORT QGDictIterator			// generic dictionary iterator

{

friend class QGDict;

public:

    QGDictIterator( const QGDict & );

    QGDictIterator( const QGDictIterator & );

    QGDictIterator &operator=( const QGDictIterator & );

   ~QGDictIterator();

    QCollection::Item toFirst();

    QCollection::Item get()	     const;

    QString	      getKeyString() const;

    const char	     *getKeyAscii()  const;

    long	      getKeyInt()    const;

    void	     *getKeyPtr()    const;

    QCollection::Item operator()();

    QCollection::Item operator++();

    QCollection::Item operator+=(uint);

protected:

    QGDict	     *dict;

private:

    QBaseBucket      *curNode;

    uint	      curIndex;

};

inline QCollection::Item QGDictIterator::get() const

{

    return curNode ? curNode->getData() : 0;

}

inline QString QGDictIterator::getKeyString() const

{

    return curNode ? ((QStringBucket*)curNode)->getKey() : QString::null;

}

inline const char *QGDictIterator::getKeyAscii() const

{

    return curNode ? ((QAsciiBucket*)curNode)->getKey() : 0;

}

inline long QGDictIterator::getKeyInt() const

{

    return curNode ? ((QIntBucket*)curNode)->getKey() : 0;

}

inline void *QGDictIterator::getKeyPtr() const

{

    return curNode ? ((QPtrBucket*)curNode)->getKey() : 0;

}

#endif // QGDICT_H