summaryrefslogtreecommitdiffstats
path: root/src/tools/qgcache.h
blob: 19b625f7043e18fd1f1c88cec37dd996d8d12115 (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
/****************************************************************************
**
** Definition of TQGCache and TQGCacheIterator classes
**
** Created : 950208
**
** Copyright (C) 1992-2008 Trolltech ASA.  All rights reserved.
**
** 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 retquirements 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.
**
**********************************************************************/

#ifndef TQGCACHE_H
#define TQGCACHE_H

#ifndef QT_H
#include "qptrcollection.h"
#include "qglist.h"
#include "qgdict.h"
#endif // QT_H


class TQCList;					// internal classes
class TQCListIt;
class TQCDict;


class Q_EXPORT TQGCache : public TQPtrCollection	// generic LRU cache
{
friend class TQGCacheIterator;
protected:
    enum KeyType { StringKey, AsciiKey, IntKey, PtrKey };
      // identical to TQGDict's, but PtrKey is not used at the moment

    TQGCache( int maxCost, uint size, KeyType kt, bool caseSensitive,
	     bool copyKeys );
    TQGCache( const TQGCache & );			// not allowed, calls fatal()
   ~TQGCache();
    TQGCache &operator=( const TQGCache & );	// not allowed, calls fatal()

    uint    count()	const;
    uint    size()	const;
    int	    maxCost()	const	{ return mCost; }
    int	    totalCost() const	{ return tCost; }
    void    setMaxCost( int maxCost );
    void    clear();

    bool    insert_string( const TQString &key, TQPtrCollection::Item,
			   int cost, int priority );
    bool    insert_other( const char *key, TQPtrCollection::Item,
			  int cost, int priority );
    bool    remove_string( const TQString &key );
    bool    remove_other( const char *key );
    TQPtrCollection::Item take_string( const TQString &key );
    TQPtrCollection::Item take_other( const char *key );

    TQPtrCollection::Item find_string( const TQString &key, bool ref=TRUE ) const;
    TQPtrCollection::Item find_other( const char *key, bool ref=TRUE ) const;

    void    statistics() const;

private:
    bool    makeRoomFor( int cost, int priority = -1 );
    KeyType keytype;
    TQCList *lruList;
    TQCDict *dict;
    int	    mCost;
    int	    tCost;
    bool    copyk;
};


class Q_EXPORT TQGCacheIterator			// generic cache iterator
{
protected:
    TQGCacheIterator( const TQGCache & );
    TQGCacheIterator( const TQGCacheIterator & );
   ~TQGCacheIterator();
    TQGCacheIterator &operator=( const TQGCacheIterator & );

    uint	      count()   const;
    bool	      atFirst() const;
    bool	      atLast()  const;
    TQPtrCollection::Item toFirst();
    TQPtrCollection::Item toLast();

    TQPtrCollection::Item get() const;
    TQString	      getKeyString() const;
    const char       *getKeyAscii()  const;
    long	      getKeyInt()    const;

    TQPtrCollection::Item operator()();
    TQPtrCollection::Item operator++();
    TQPtrCollection::Item operator+=( uint );
    TQPtrCollection::Item operator--();
    TQPtrCollection::Item operator-=( uint );

protected:
    TQCListIt *it;				// iterator on cache list
};


#endif // TQGCACHE_H