summaryrefslogtreecommitdiffstats
path: root/tqtinterface/qt4/src/tools/tqgcache.cpp
blob: 4e16ad7c4a726a4e8110ecf652a6d9ce2d1b337f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
/****************************************************************************
**
** Implementation of TQGCache and TQGCacheIterator classes
**
** Created : 950208
**
** Copyright (C) 2010 Timothy Pearson and (C) 1992-2008 Trolltech ASA.
**
** This file is part of the tools module of the TQt GUI Toolkit.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.TQPL
** included in the packaging of this file.  Licensees holding valid TQt
** Commercial licenses may use this file in accordance with the TQt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#include "tqgcache.h"
#include "tqptrlist.h"
#include "tqdict.h"
#include "tqstring.h"

/*!
  \class TQGCache tqgcache.h
  \reentrant
  \ingroup shared
  \ingroup collection
  \brief The TQGCache class is an internal class for implementing TQCache
  template classes.

  \internal

  TQGCache is a strictly internal class that acts as a base class for the
  \link collection.html collection classes\endlink TQCache and TQIntCache.
*/


/*****************************************************************************
  TQGCacheItem class (internal cache item)
 *****************************************************************************/

struct TQCacheItem
{
    TQCacheItem( void *k, TQPtrCollection::Item d, int c, short p )
	: priority(p), skipPriority(p), cost(c), key(k), data(d), node(0) {}
    short	priority;
    short	skipPriority;
    int		cost;
    void       *key;
    TQPtrCollection::Item data;
    TQLNode     *node;
};


/*****************************************************************************
  TQCList class (internal list of cache items)
 *****************************************************************************/

class TQCList : private TQPtrList<TQCacheItem>
{
friend class TQGCacheIterator;
friend class TQCListIt;
public:
    TQCList()	{}
   ~TQCList();

    void	insert( TQCacheItem * );		// insert according to priority
    void	insert( int, TQCacheItem * );
    void	take( TQCacheItem * );
    void	reference( TQCacheItem * );

    void	setAutoDelete( bool del ) { TQPtrCollection::setAutoDelete(del); }

    bool	removeFirst()	{ return TQPtrList<TQCacheItem>::removeFirst(); }
    bool	removeLast()	{ return TQPtrList<TQCacheItem>::removeLast(); }

    TQCacheItem *first()		{ return TQPtrList<TQCacheItem>::first(); }
    TQCacheItem *last()		{ return TQPtrList<TQCacheItem>::last(); }
    TQCacheItem *prev()		{ return TQPtrList<TQCacheItem>::prev(); }
    TQCacheItem *next()		{ return TQPtrList<TQCacheItem>::next(); }

#if defined(TQT_DEBUG)
    int		inserts;			// variables for statistics
    int		insertCosts;
    int		insertMisses;
    int		finds;
    int		hits;
    int		hitCosts;
    int		dumps;
    int		dumpCosts;
#endif
};


TQCList::~TQCList()
{
#if defined(TQT_DEBUG)
    TQ_ASSERT( count() == 0 );
#endif
}


void TQCList::insert( TQCacheItem *ci )
{
    TQCacheItem *item = first();
    while( item && item->skipPriority > ci->priority ) {
	item->skipPriority--;
	item = next();
    }
    if ( item )
	TQPtrList<TQCacheItem>::insert( at(), ci );
    else
	append( ci );
#if defined(TQT_DEBUG)
    TQ_ASSERT( ci->node == 0 );
#endif
    ci->node = currentNode();
}

inline void TQCList::insert( int i, TQCacheItem *ci )
{
    TQPtrList<TQCacheItem>::insert( i, ci );
#if defined(TQT_DEBUG)
    TQ_ASSERT( ci->node == 0 );
#endif
    ci->node = currentNode();
}


void TQCList::take( TQCacheItem *ci )
{
    if ( ci ) {
#if defined(TQT_DEBUG)
	TQ_ASSERT( ci->node != 0 );
#endif
	takeNode( ci->node );
	ci->node = 0;
    }
}


inline void TQCList::reference( TQCacheItem *ci )
{
#if defined(TQT_DEBUG)
    TQ_ASSERT( ci != 0 && ci->node != 0 );
#endif
    ci->skipPriority = ci->priority;
    relinkNode( ci->node );			// relink as first item
}


class TQCListIt: public TQPtrListIterator<TQCacheItem>
{
public:
    TQCListIt( const TQCList *p ): TQPtrListIterator<TQCacheItem>( *p ) {}
    TQCListIt( const TQCListIt *p ): TQPtrListIterator<TQCacheItem>( *p ) {}
};


/*****************************************************************************
  TQCDict class (internal dictionary of cache items)
 *****************************************************************************/

//
// Since we need to decide if the dictionary should use an int or const
// char * key (the "bool trivial" argument in the constructor below)
// we cannot use the macro/template dict, but inherit directly from TQGDict.
//

class TQCDict : public TQGDict
{
public:
    TQCDict( uint size, uint kt, bool caseSensitive, bool copyKeys )
	: TQGDict( size, (KeyType)kt, caseSensitive, copyKeys ) {}
    ~TQCDict();

    void clear() { TQGDict::clear(); }

    TQCacheItem *find_string(const TQString &key) const
	{ return (TQCacheItem*)((TQCDict*)this)->look_string(key, 0, 0); }
    TQCacheItem *find_ascii(const char *key) const
	{ return (TQCacheItem*)((TQCDict*)this)->look_ascii(key, 0, 0); }
    TQCacheItem *find_int(long key) const
	{ return (TQCacheItem*)((TQCDict*)this)->look_int(key, 0, 0); }

    TQCacheItem *take_string(const TQString &key)
	{ return (TQCacheItem*)TQGDict::take_string(key); }
    TQCacheItem *take_ascii(const char *key)
	{ return (TQCacheItem*)TQGDict::take_ascii(key); }
    TQCacheItem *take_int(long key)
	{ return (TQCacheItem*)TQGDict::take_int(key); }

    bool  insert_string( const TQString &key, const TQCacheItem *ci )
	{ return TQGDict::look_string(key,(Item)ci,1)!=0;}
    bool  insert_ascii( const char *key, const TQCacheItem *ci )
	{ return TQGDict::look_ascii(key,(Item)ci,1)!=0;}
    bool  insert_int( long key, const TQCacheItem *ci )
	{ return TQGDict::look_int(key,(Item)ci,1)!=0;}

    bool  remove_string( TQCacheItem *item )
	{ return TQGDict::remove_string(*((TQString*)(item->key)),item); }
    bool  remove_ascii( TQCacheItem *item )
	{ return TQGDict::remove_ascii((const char *)item->key,item); }
    bool  remove_int( TQCacheItem *item )
	{ return TQGDict::remove_int((long)item->key,item);}

    void  statistics()			{ TQGDict::statistics(); }

private:
    void deleteItem( void *item )
	{ if ( del_item ) { TQCacheItem *d = (TQCacheItem*)item; delete d; } }
};

inline TQCDict::~TQCDict()
{
    clear();
}

/*****************************************************************************
  TQGDict member functions
 *****************************************************************************/

/*!
  Constructs a cache.
  The maximum cost of the cache is given by \a maxCost and the size by \a
  size. The key type is \a kt which may be \c StringKey, \c AsciiKey,
  \c IntKey or \c PtrKey. The case-sensitivity of lookups is set with
  \a caseSensitive. Keys are copied if \a copyKeys is TRUE.
*/

TQGCache::TQGCache( int maxCost, uint size, KeyType kt, bool caseSensitive,
		  bool copyKeys )
{
    keytype = kt;
    lruList = new TQCList;
    TQ_CHECK_PTR( lruList );
    lruList->setAutoDelete( TRUE );
    copyk   = ((keytype == AsciiKey) && copyKeys);
    dict    = new TQCDict( size, kt, caseSensitive, FALSE );
    TQ_CHECK_PTR( dict );
    mCost   = maxCost;
    tCost   = 0;
#if defined(TQT_DEBUG)
    lruList->inserts	  = 0;
    lruList->insertCosts  = 0;
    lruList->insertMisses = 0;
    lruList->finds	  = 0;
    lruList->hits	  = 0;
    lruList->hitCosts	  = 0;
    lruList->dumps	  = 0;
    lruList->dumpCosts	  = 0;
#endif
}

/*!
  Cannot copy a cache.
*/

TQGCache::TQGCache( const TQGCache & )
    : TQPtrCollection()
{
#if defined(TQT_CHECK_NULL)
    qFatal( "TQGCache::TQGCache(TQGCache &): Cannot copy a cache" );
#endif
}

/*!
  Removes all items from the cache and destroys it.
*/

TQGCache::~TQGCache()
{
    clear();
    delete dict;
    delete lruList;
}

/*!
  Cannot assign a cache.
*/

TQGCache &TQGCache::operator=( const TQGCache & )
{
#if defined(TQT_CHECK_NULL)
    qFatal( "TQGCache::operator=: Cannot copy a cache" );
#endif
    return *this;
}


/*!
  Returns the number of items in the cache.
*/

uint TQGCache::count() const
{
    return dict->count();
}

/*!
  Returns the size of the hash array.
*/

uint TQGCache::size() const
{
    return dict->size();
}

/*!
  \fn int TQGCache::maxCost() const

  Returns the maximum cache cost.
*/

/*!
  \fn int TQGCache::totalCost() const

  Returns the total cache cost.
*/

/*!
  Sets the maximum cache cost to \a maxCost.
*/

void TQGCache::setMaxCost( int maxCost )
{
    if ( maxCost < tCost ) {
	if ( !makeRoomFor(tCost - maxCost) )	// remove excess cost
	    return;
    }
    mCost = maxCost;
}


/*!
    Inserts an item with data \a data into the cache using key \a key.
    The item has cost \a cost and priority \a priority.

  \warning If this function returns FALSE, you must delete \a data
  yourself.  Additionally, be very careful about using \a data after
  calling this function, as any other insertions into the cache, from
  anywhere in the application, or within TQt itself, could cause the
  data to be discarded from the cache, and the pointer to become
  invalid.
*/

bool TQGCache::insert_string( const TQString &key, TQPtrCollection::Item data,
			     int cost, int priority)
{
    if ( tCost + cost > mCost ) {
	if ( !makeRoomFor(tCost + cost - mCost, priority) ) {
#if defined(TQT_DEBUG)
	    lruList->insertMisses++;
#endif
	    return FALSE;
	}
    }
#if defined(TQT_DEBUG)
    TQ_ASSERT( keytype == StringKey );
    lruList->inserts++;
    lruList->insertCosts += cost;
#endif
    if ( priority < -32768 )
	priority = -32768;
    else if ( priority > 32767 )
	priority = 32677;
    TQCacheItem *ci = new TQCacheItem( new TQString(key), newItem(data),
				     cost, (short)priority );
    TQ_CHECK_PTR( ci );
    lruList->insert( 0, ci );
    dict->insert_string( key, ci );
    tCost += cost;
    return TRUE;
}

bool TQGCache::insert_other( const char *key, TQPtrCollection::Item data,
			    int cost, int priority)
{
    if ( tCost + cost > mCost ) {
	if ( !makeRoomFor(tCost + cost - mCost, priority) ) {
#if defined(TQT_DEBUG)
	    lruList->insertMisses++;
#endif
	    return FALSE;
	}
    }
#if defined(TQT_DEBUG)
    TQ_ASSERT( keytype != StringKey );
    lruList->inserts++;
    lruList->insertCosts += cost;
#endif
    if ( keytype == AsciiKey && copyk )
	key = qstrdup( key );
    if ( priority < -32768 )
	priority = -32768;
    else if ( priority > 32767 )
	priority = 32677;
    TQCacheItem *ci = new TQCacheItem( (void*)key, newItem(data), cost,
				     (short)priority );
    TQ_CHECK_PTR( ci );
    lruList->insert( 0, ci );
    if ( keytype == AsciiKey )
	dict->insert_ascii( key, ci );
    else
	dict->insert_int( (long)key, ci );
    tCost += cost;
    return TRUE;
}


/*!
  Removes the item with key \a key from the cache. Returns TRUE if the
  item was removed; otherwise returns FALSE.
*/

bool TQGCache::remove_string( const TQString &key )
{
    Item d = take_string( key );
    if ( d )
	deleteItem( d );
    return d != 0;
}

bool TQGCache::remove_other( const char *key )
{
    Item d = take_other( key );
    if ( d )
	deleteItem( d );
    return d != 0;
}


/*!
  Takes the item with key \a key out of the cache. The item is not
  deleted. If no item has this \a key 0 is returned.
*/

TQPtrCollection::Item TQGCache::take_string( const TQString &key )
{
    TQCacheItem *ci = dict->take_string( key );	// take from dict
    Item d;
    if ( ci ) {
	d = ci->data;
	tCost -= ci->cost;
	lruList->take( ci );			// take from list
	delete (TQString*)ci->key;
	delete ci;
    } else {
	d = 0;
    }
    return d;
}

/*!
  Takes the item with key \a key out of the cache. The item is not
  deleted. If no item has this \a key 0 is returned.
*/

TQPtrCollection::Item TQGCache::take_other( const char *key )
{
    TQCacheItem *ci;
    if ( keytype == AsciiKey )
	ci = dict->take_ascii( key );
    else
	ci = dict->take_int( (long)key );
    Item d;
    if ( ci ) {
	d = ci->data;
	tCost -= ci->cost;
	lruList->take( ci );			// take from list
	if ( copyk )
	    delete [] (char *)ci->key;
	delete ci;
    } else {
	d = 0;
    }
    return d;
}


/*!
  Clears the cache.
*/

void TQGCache::clear()
{
    TQCacheItem *ci;
    while ( (ci = lruList->first()) ) {
	switch ( keytype ) {
	    case StringKey:
		dict->remove_string( ci );
		delete (TQString*)ci->key;
		break;
	    case AsciiKey:
		dict->remove_ascii( ci );
		if ( copyk )
		    delete [] (char*)ci->key;
		break;
	    case IntKey:
		dict->remove_int( ci );
		break;
	    case PtrKey:			// unused
		break;
	}
	deleteItem( ci->data );			// delete data
	lruList->removeFirst();			// remove from list
    }
    tCost = 0;
}


/*!
  Finds an item for \a key in the cache and adds a reference if \a ref is TRUE.
*/

TQPtrCollection::Item TQGCache::find_string( const TQString &key, bool ref ) const
{
    TQCacheItem *ci = dict->find_string( key );
#if defined(TQT_DEBUG)
    lruList->finds++;
#endif
    if ( ci ) {
#if defined(TQT_DEBUG)
	lruList->hits++;
	lruList->hitCosts += ci->cost;
#endif
	if ( ref )
	    lruList->reference( ci );
	return ci->data;
    }
    return 0;
}


/*!
  Finds an item for \a key in the cache and adds a reference if \a ref is TRUE.
*/

TQPtrCollection::Item TQGCache::find_other( const char *key, bool ref ) const
{
    TQCacheItem *ci = keytype == AsciiKey ? dict->find_ascii(key)
					 : dict->find_int((long)key);
#if defined(TQT_DEBUG)
    lruList->finds++;
#endif
    if ( ci ) {
#if defined(TQT_DEBUG)
	lruList->hits++;
	lruList->hitCosts += ci->cost;
#endif
	if ( ref )
	    lruList->reference( ci );
	return ci->data;
    }
    return 0;
}


/*!
  Allocates cache space for one or more items.
*/

bool TQGCache::makeRoomFor( int cost, int priority )
{
    if ( cost > mCost )				// cannot make room for more
	return FALSE;				//   than maximum cost
    if ( priority == -1 )
	priority = 32767;
    register TQCacheItem *ci = lruList->last();
    int cntCost = 0;
    int dumps	= 0;				// number of items to dump
    while ( cntCost < cost && ci && ci->skipPriority <= priority ) {
	cntCost += ci->cost;
	ci	 = lruList->prev();
	dumps++;
    }
    if ( cntCost < cost )			// can enough cost be dumped?
	return FALSE;				// no
#if defined(TQT_DEBUG)
    TQ_ASSERT( dumps > 0 );
#endif
    while ( dumps-- ) {
	ci = lruList->last();
#if defined(TQT_DEBUG)
	lruList->dumps++;
	lruList->dumpCosts += ci->cost;
#endif
	switch ( keytype ) {
	    case StringKey:
		dict->remove_string( ci );
		delete (TQString*)ci->key;
		break;
	    case AsciiKey:
		dict->remove_ascii( ci );
		if ( copyk )
		    delete [] (char *)ci->key;
		break;
	    case IntKey:
		dict->remove_int( ci );
		break;
	    case PtrKey:			// unused
		break;
	}
	deleteItem( ci->data );			// delete data
	lruList->removeLast();			// remove from list
    }
    tCost -= cntCost;
    return TRUE;
}


/*!
  Outputs debug statistics.
*/

void TQGCache::statistics() const
{
#if defined(TQT_DEBUG)
    TQString line;
    line.fill( '*', 80 );
    qDebug( line.ascii() );
    qDebug( "CACHE STATISTICS:" );
    qDebug( "cache contains %d item%s, with a total cost of %d",
	   count(), count() != 1 ? "s" : "", tCost );
    qDebug( "maximum cost is %d, cache is %d%% full.",
	   mCost, (200*tCost + mCost) / (mCost*2) );
    qDebug( "find() has been called %d time%s",
	   lruList->finds, lruList->finds != 1 ? "s" : "" );
    qDebug( "%d of these were hits, items found had a total cost of %d.",
	   lruList->hits,lruList->hitCosts );
    qDebug( "%d item%s %s been inserted with a total cost of %d.",
	   lruList->inserts,lruList->inserts != 1 ? "s" : "",
	   lruList->inserts != 1 ? "have" : "has", lruList->insertCosts );
    qDebug( "%d item%s %s too large or had too low priority to be inserted.",
	   lruList->insertMisses, lruList->insertMisses != 1 ? "s" : "",
	   lruList->insertMisses != 1 ? "were" : "was" );
    qDebug( "%d item%s %s been thrown away with a total cost of %d.",
	   lruList->dumps, lruList->dumps != 1 ? "s" : "",
	   lruList->dumps != 1 ? "have" : "has", lruList->dumpCosts );
    qDebug( "Statistics from internal dictionary class:" );
    dict->statistics();
    qDebug( line.ascii() );
#endif
}


/*****************************************************************************
  TQGCacheIterator member functions
 *****************************************************************************/

/*!
  \class TQGCacheIterator tqgcache.h
  \reentrant
  \ingroup shared
  \ingroup collection
  \brief The TQGCacheIterator class is an internal class for implementing TQCacheIterator and
  TQIntCacheIterator.

  \internal

  TQGCacheIterator is a strictly internal class that does the heavy work for
  TQCacheIterator and TQIntCacheIterator.
*/

/*!
  Constructs an iterator that operates on the cache \a c.
*/

TQGCacheIterator::TQGCacheIterator( const TQGCache &c )
{
    it = new TQCListIt( c.lruList );
#if defined(TQT_DEBUG)
    TQ_ASSERT( it != 0 );
#endif
}

/*!
  Constructs an iterator that operates on the same cache as \a ci.
*/

TQGCacheIterator::TQGCacheIterator( const TQGCacheIterator &ci )
{
    it = new TQCListIt( ci.it );
#if defined(TQT_DEBUG)
    TQ_ASSERT( it != 0 );
#endif
}

/*!
  Destroys the iterator.
*/

TQGCacheIterator::~TQGCacheIterator()
{
    delete it;
}

/*!
  Assigns the iterator \a ci to this cache iterator.
*/

TQGCacheIterator &TQGCacheIterator::operator=( const TQGCacheIterator &ci )
{
    *it = *ci.it;
    return *this;
}

/*!
  Returns the number of items in the cache.
*/

uint TQGCacheIterator::count() const
{
    return it->count();
}

/*!
  Returns TRUE if the iterator points to the first item.
*/

bool  TQGCacheIterator::atFirst() const
{
    return it->atFirst();
}

/*!
  Returns TRUE if the iterator points to the last item.
*/

bool TQGCacheIterator::atLast() const
{
    return it->atLast();
}

/*!
  Sets the list iterator to point to the first item in the cache.
*/

TQPtrCollection::Item TQGCacheIterator::toFirst()
{
    TQCacheItem *item = it->toFirst();
    return item ? item->data : 0;
}

/*!
  Sets the list iterator to point to the last item in the cache.
*/

TQPtrCollection::Item TQGCacheIterator::toLast()
{
    TQCacheItem *item = it->toLast();
    return item ? item->data : 0;
}

/*!
  Returns the current item.
*/

TQPtrCollection::Item TQGCacheIterator::get() const
{
    TQCacheItem *item = it->current();
    return item ? item->data : 0;
}

/*!
  Returns the key of the current item.
*/

TQString TQGCacheIterator::getKeyString() const
{
    TQCacheItem *item = it->current();
    return item ? *((TQString*)item->key) : TQString::null;
}

/*!
  Returns the key of the current item, as a \0-terminated C string.
*/

const char *TQGCacheIterator::getKeyAscii() const
{
    TQCacheItem *item = it->current();
    return item ? (const char *)item->key : 0;
}

/*!
  Returns the key of the current item, as a long.
*/

long TQGCacheIterator::getKeyInt() const
{
    TQCacheItem *item = it->current();
    return item ? (long)item->key : 0;
}

/*!
  Moves to the next item (postfix).
*/

TQPtrCollection::Item TQGCacheIterator::operator()()
{
    TQCacheItem *item = it->operator()();
    return item ? item->data : 0;
}

/*!
  Moves to the next item (prefix).
*/

TQPtrCollection::Item TQGCacheIterator::operator++()
{
    TQCacheItem *item = it->operator++();
    return item ? item->data : 0;
}

/*!
  Moves \a jump positions forward.
*/

TQPtrCollection::Item TQGCacheIterator::operator+=( uint jump )
{
    TQCacheItem *item = it->operator+=(jump);
    return item ? item->data : 0;
}

/*!
  Moves to the previous item (prefix).
*/

TQPtrCollection::Item TQGCacheIterator::operator--()
{
    TQCacheItem *item = it->operator--();
    return item ? item->data : 0;
}

/*!
  Moves \a jump positions backward.
*/

TQPtrCollection::Item TQGCacheIterator::operator-=( uint jump )
{
    TQCacheItem *item = it->operator-=(jump);
    return item ? item->data : 0;
}