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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class Q3AsciiDict
\brief The Q3AsciiDict class is a template class that provides a dictionary based on char* keys.
\compat
Q3AsciiDict is implemented as a template class. Define a template
instance Q3AsciiDict\<X\> to create a dictionary that operates on
pointers to X (X*).
A dictionary is a collection of key-value pairs. The key is a
char* used for insertion, removal and lookup. The value is a
pointer. Dictionaries provide very fast insertion and lookup.
Q3AsciiDict cannot handle Unicode keys; use the Q3Dict template
instead, which uses QString keys. A Q3Dict has the same
performace as a Q3AsciiDict.
Example:
\snippet doc/src/snippets/code/doc_src_q3asciidict.cpp 0
In this example we use a dictionary to keep track of the line
edits we're using. We insert each line edit into the dictionary
with a unique name and then access the line edits via the
dictionary. See Q3PtrDict, Q3IntDict and Q3Dict.
See Q3Dict for full details, including the choice of dictionary
size, and how deletions are handled.
\sa Q3AsciiDictIterator, Q3Dict, Q3IntDict, Q3PtrDict
*/
/*!
\fn Q3AsciiDict::Q3AsciiDict( int size, bool caseSensitive, bool copyKeys )
Constructs a dictionary optimized for less than \a size entries.
We recommend setting \a size to a suitably large prime number (a
bit larger than the expected number of entries). This makes the
hash distribution better and will improve lookup performance.
When \a caseSensitive is TRUE (the default) Q3AsciiDict treats
"abc" and "Abc" as different keys; when it is FALSE "abc" and
"Abc" are the same. Case-insensitive comparison only considers the
26 letters in US-ASCII.
If \a copyKeys is TRUE (the default), the dictionary copies keys
using strcpy(); if it is FALSE, the dictionary just copies the
pointers.
*/
/*!
\fn Q3AsciiDict::Q3AsciiDict( const Q3AsciiDict<type> &dict )
Constructs a copy of \a dict.
Each item in \a dict is inserted into this dictionary. Only the
pointers are copied (shallow copy).
*/
/*!
\fn Q3AsciiDict::~Q3AsciiDict()
Removes all items from the dictionary and destroys it.
The items are deleted if auto-delete is enabled.
All iterators that access this dictionary will be reset.
\sa setAutoDelete()
*/
/*!
\fn Q3AsciiDict<type> &Q3AsciiDict::operator=(const Q3AsciiDict<type> &dict)
Assigns \a dict to this dictionary and returns a reference to this
dictionary.
This dictionary is first cleared and then each item in \a dict is
inserted into this dictionary. Only the pointers are copied
(shallow copy) unless newItem() has been reimplemented().
*/
/*!
\fn uint Q3AsciiDict::count() const
Returns the number of items in the dictionary.
\sa isEmpty()
*/
/*!
\fn uint Q3AsciiDict::size() const
Returns the size of the internal hash array (as specified in the
constructor).
\sa count()
*/
/*!
\fn void Q3AsciiDict::resize( uint newsize )
Changes the size of the hashtable to \a newsize. The contents of
the dictionary are preserved but all iterators on the dictionary
become invalid.
*/
/*!
\fn bool Q3AsciiDict::isEmpty() const
Returns TRUE if the dictionary is empty, i.e. count() == 0;
otherwise it returns FALSE.
\sa count()
*/
/*!
\fn void Q3AsciiDict::insert( const char *key, const type *item )
Inserts the \a key with the \a item into the dictionary.
Multiple items can have the same key, in which case only the last
item will be accessible using \l operator[]().
\a item may not be 0.
\sa replace()
*/
/*!
\fn void Q3AsciiDict::replace( const char *key, const type *item )
Replaces an item that has a key equal to \a key with \a item.
If the item does not already exist, it will be inserted.
\a item may not be 0.
Equivalent to:
\snippet doc/src/snippets/code/doc_src_q3asciidict.cpp 1
If there are two or more items with equal keys, then the most
recently inserted item will be replaced.
\sa insert()
*/
/*!
\fn bool Q3AsciiDict::remove( const char *key )
Removes the item associated with \a key from the dictionary.
Returns TRUE if successful, i.e. if the key existed in the
dictionary; otherwise returns FALSE.
If there are two or more items with equal keys, then the most
recently inserted item will be removed.
The removed item is deleted if \link
Q3PtrCollection::setAutoDelete() auto-deletion\endlink is enabled.
All dictionary iterators that refer to the removed item will be
set to point to the next item in the dictionary traversal order.
\sa take(), clear(), setAutoDelete()
*/
/*!
\fn type *Q3AsciiDict::take( const char *key )
Takes the item associated with \a key out of the dictionary
without deleting it (even if \link Q3PtrCollection::setAutoDelete()
auto-deletion\endlink is enabled).
If there are two or more items with equal keys, then the most
recently inserted item will be taken.
Returns a pointer to the item taken out, or 0 if the key does not
exist in the dictionary.
All dictionary iterators that refer to the taken item will be set
to point to the next item in the dictionary traversal order.
\sa remove(), clear(), setAutoDelete()
*/
/*!
\fn void Q3AsciiDict::clear()
Removes all items from the dictionary.
The removed items are deleted if \link
Q3PtrCollection::setAutoDelete() auto-deletion\endlink is enabled.
All dictionary iterators that operate on dictionary are reset.
\sa remove(), take(), setAutoDelete()
*/
/*!
\fn type *Q3AsciiDict::find( const char *key ) const
Returns the item associated with \a key, or 0 if the key does not
exist in the dictionary.
This function uses an internal hashing algorithm to optimize
lookup.
If there are two or more items with equal keys, then the item that
was most recently inserted will be found.
Equivalent to the [] operator.
\sa operator[]()
*/
/*!
\fn type *Q3AsciiDict::operator[]( const char *key ) const
Returns the item associated with \a key, or 0 if the key does
not exist in the dictionary.
This function uses an internal hashing algorithm to optimize
lookup.
If there are two or more items with equal keys, then the item that
was most recently inserted will be found.
Equivalent to the find() function.
\sa find()
*/
/*!
\fn void Q3AsciiDict::statistics() const
Debugging-only function that prints out the dictionary
distribution using qDebug().
*/
/*!
\fn QDataStream& Q3AsciiDict::read( QDataStream &s,
Q3PtrCollection::Item &item )
Reads a dictionary item from the stream \a s and returns a
reference to the stream.
The default implementation sets \a item to 0.
\sa write()
*/
/*!
\fn QDataStream& Q3AsciiDict::write(QDataStream &s, Q3PtrCollection::Item item) const
Writes a dictionary \a item to the stream \a s and returns a
reference to the stream.
\sa read()
*/
/*!
\class Q3AsciiDictIterator
\brief The Q3AsciiDictIterator class provides an iterator for Q3AsciiDict collections.
\compat
Q3AsciiDictIterator is implemented as a template class. Define a
template instance Q3AsciiDictIterator\<X\> to create a dictionary
iterator that operates on Q3AsciiDict\<X\> (dictionary of X*).
Example:
\snippet doc/src/snippets/code/doc_src_q3asciidict.cpp 2
In the example we insert some line edits into a dictionary, then
iterate over the dictionary printing the strings associated with
those line edits.
Note that the traversal order is arbitrary; you are not guaranteed
any particular order.
Multiple iterators may independently traverse the same dictionary.
A Q3AsciiDict knows about all the iterators that are operating on
the dictionary. When an item is removed from the dictionary,
Q3AsciiDict updates all the iterators that are referring to the
removed item to point to the next item in the (arbitrary)
traversal order.
\sa Q3AsciiDict
*/
/*!
\fn Q3AsciiDictIterator::Q3AsciiDictIterator( const Q3AsciiDict<type> &dict )
Constructs an iterator for \a dict. The current iterator item is
set to point on the first item in the \a dict.
*/
/*!
\fn Q3AsciiDictIterator::~Q3AsciiDictIterator()
Destroys the iterator.
*/
/*!
\fn uint Q3AsciiDictIterator::count() const
Returns the number of items in the dictionary this iterator
operates over.
\sa isEmpty()
*/
/*!
\fn bool Q3AsciiDictIterator::isEmpty() const
Returns TRUE if the dictionary is empty, i.e. count() == 0,
otherwise returns FALSE.
\sa count()
*/
/*!
\fn type *Q3AsciiDictIterator::toFirst()
Sets the current iterator item to point to the first item in the
dictionary and returns a pointer to the item. If the dictionary is
empty it sets the current item to 0 and returns 0.
*/
/*!
\fn Q3AsciiDictIterator::operator type *() const
Cast operator. Returns a pointer to the current iterator item.
Same as current().
*/
/*!
\fn type *Q3AsciiDictIterator::current() const
Returns a pointer to the current iterator item.
*/
/*!
\fn const char *Q3AsciiDictIterator::currentKey() const
Returns a pointer to the key for the current iterator item.
*/
/*!
\fn type *Q3AsciiDictIterator::operator()()
Makes the succeeding item current and returns the original current
item.
If the current iterator item was the last item in the dictionary
or if it was 0, 0 is returned.
*/
/*!
\fn type *Q3AsciiDictIterator::operator++()
Prefix ++ makes the succeeding item current and returns the new
current item.
If the current iterator item was the last item in the dictionary
or if it was 0, 0 is returned.
*/
/*!
\fn type *Q3AsciiDictIterator::operator+=( uint jump )
Sets the current item to the item \a jump positions after the
current item, and returns a pointer to that item.
If that item is beyond the last item or if the dictionary is
empty, it sets the current item to 0 and returns 0.
*/
|