Newer
Older
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
/********************************************************************************
* *
* S t r i n g D i c t i o n a r y C l a s s *
* *
*********************************************************************************
* Copyright (C) 1998,2005 by Jeroen van der Zijp. All Rights Reserved. *
*********************************************************************************
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
*********************************************************************************
* $Id: FXDict.h 2335 2006-01-28 02:33:03Z lyle $ *
********************************************************************************/
#ifndef FXDICT_H
#define FXDICT_H
#ifndef FXOBJECT_H
#include "FXObject.h"
#endif
namespace FX {
/**
* The dictionary class maintains a fast-access hash table of entities
* indexed by a character string.
* It is typically used to map strings to pointers; however, overloading
* the createData() and deleteData() members allows any type of data to
* be indexed by strings.
*/
class FXAPI FXDict : public FXObject {
FXDECLARE(FXDict)
protected:
struct FXDictEntry {
FXchar *key; // Key string
void *data; // Data
FXint hash; // Hash value of key
bool mark; // Entry is marked
};
protected:
FXDictEntry *dict; // Dictionary
FXint total; // Dictionary size
FXint number; // Number of entries
protected:
static FXint hash(const FXchar* str);
protected:
/**
* Overload this function in a derived class to return the
* data pointer given an input pointer; the default implementation
* just returns the input pointer.
*/
virtual void *createData(const void*);
/**
* Overload this function in a derived class to delete the pointer
* previously returned by createData(); the default implementation
* does nothing.
*/
virtual void deleteData(void*);
public:
/**
* Construct an empty dictionary.
*/
FXDict();
/// Copy constructor; does bit-copy of void pointer data.
FXDict(const FXDict& orig);
/// Assignment operator
FXDict& operator=(const FXDict& orig);
/**
* Resize the table to the given size.
*/
void size(FXint m);
/**
* Return the size of the table, including the empty slots.
*/
FXint size() const { return total; }
/**
* Return the total number of entries in the table.
*/
FXint no() const { return number; }
/**
* Insert a new entry into the table given key and mark.
* If there is already an entry with that key, leave it unchanged,
* otherwise insert the new entry.
*/
void* insert(const FXchar* ky,const void* ptr,bool mrk=false);
/**
* Replace data at key, if the entry's mark is less than
* or equal to the given mark. If there was no existing entry,
* a new entry is inserted with the given mark.
*/
void* replace(const FXchar* ky,const void* ptr,bool mrk=false);
/**
* Remove data given key.
*/
void* remove(const FXchar* ky);
/**
* Find data pointer given key.
*/
void* find(const FXchar* ky) const;
/**
* Return true if slot is empty.
*/
bool empty(FXint pos) const { return dict[pos].hash<0; }
/**
* Return key at position pos.
*/
const FXchar* key(FXuint pos) const { return dict[pos].key; }
/**
* return data pointer at position pos.
*/
void* data(FXuint pos) const { return dict[pos].data; }
/**
* Return mark flag of entry at position pos.
*/
bool mark(FXuint pos) const { return dict[pos].mark; }
/**
* Return position of first filled slot, or >= total
*/
FXint first() const;
/**
* Return position of last filled slot or -1
*/
FXint last() const;
/**
* Return position of next filled slot in hash table
* or a value greater than or equal to total if no filled
* slot was found
*/
FXint next(FXint pos) const;
/**
* Return position of previous filled slot in hash table
* or a -1 if no filled slot was found
*/
FXint prev(FXint pos) const;
/// Clear all entries
void clear();
/// Destructor
virtual ~FXDict();
};
}
#endif