1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxHashMap class
4 // Author: Mattia Barbon
8 // Copyright: (c) Mattia Barbon
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_HASHMAP_H_
13 #define _WX_HASHMAP_H_
15 #include "wx/string.h"
17 #if (defined(HAVE_EXT_HASH_MAP) || defined(HAVE_HASH_MAP)) \
18 && (defined(HAVE_GNU_CXX_HASH_MAP) || defined(HAVE_STD_HASH_MAP))
19 #define HAVE_STL_HASH_MAP
22 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
24 #if defined(HAVE_EXT_HASH_MAP)
25 #include <ext/hash_map>
26 #elif defined(HAVE_HASH_MAP)
30 #if defined(HAVE_GNU_CXX_HASH_MAP)
31 #define WX_HASH_MAP_NAMESPACE __gnu_cxx
32 #elif defined(HAVE_STD_HASH_MAP)
33 #define WX_HASH_MAP_NAMESPACE std
36 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
37 typedef WX_HASH_MAP_NAMESPACE::hash_map< KEY_T, VALUE_T, HASH_T, KEY_EQ_T > CLASSNAME;
39 #else // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
43 typedef int ptrdiff_t;
45 #include <stddef.h> // for ptrdiff_t
49 struct WXDLLIMPEXP_BASE _wxHashTable_NodeBase
51 _wxHashTable_NodeBase() : m_nxt(0) {}
53 _wxHashTable_NodeBase
* m_nxt
;
56 // DECLARE_NO_COPY_CLASS(_wxHashTable_NodeBase)
57 // without rewriting the macros, which require a public copy constructor.
61 class WXDLLIMPEXP_BASE _wxHashTableBase2
64 typedef void (*NodeDtor
)(_wxHashTable_NodeBase
*);
65 typedef unsigned long (*BucketFromNode
)(_wxHashTableBase2
*,_wxHashTable_NodeBase
*);
66 typedef _wxHashTable_NodeBase
* (*ProcessNode
)(_wxHashTable_NodeBase
*);
68 static _wxHashTable_NodeBase
* DummyProcessNode(_wxHashTable_NodeBase
* node
);
69 static void DeleteNodes( size_t buckets
, _wxHashTable_NodeBase
** table
,
71 static _wxHashTable_NodeBase
* GetFirstNode( size_t buckets
,
72 _wxHashTable_NodeBase
** table
)
74 for( size_t i
= 0; i
< buckets
; ++i
)
80 // as static const unsigned prime_count = 31 but works with all compilers
81 enum { prime_count
= 31 };
82 static const unsigned long ms_primes
[prime_count
];
84 // returns the first prime in ms_primes greater than n
85 static unsigned long GetNextPrime( unsigned long n
);
87 // returns the first prime in ms_primes smaller than n
88 // ( or ms_primes[0] if n is very small )
89 static unsigned long GetPreviousPrime( unsigned long n
);
91 static void CopyHashTable( _wxHashTable_NodeBase
** srcTable
,
92 size_t srcBuckets
, _wxHashTableBase2
* dst
,
93 _wxHashTable_NodeBase
** dstTable
,
94 BucketFromNode func
, ProcessNode proc
);
96 static void** AllocTable( size_t sz
)
98 return (void **)calloc(sz
, sizeof(void*));
100 static void FreeTable(void *table
)
106 #define _WX_DECLARE_HASHTABLE( VALUE_T, KEY_T, HASH_T, KEY_EX_T, KEY_EQ_T, CLASSNAME, CLASSEXP, SHOULD_GROW, SHOULD_SHRINK ) \
107 CLASSEXP CLASSNAME : protected _wxHashTableBase2 \
110 typedef KEY_T key_type; \
111 typedef VALUE_T value_type; \
112 typedef HASH_T hasher; \
113 typedef KEY_EQ_T key_equal; \
115 typedef size_t size_type; \
116 typedef ptrdiff_t difference_type; \
117 typedef value_type* pointer; \
118 typedef const value_type* const_pointer; \
119 typedef value_type& reference; \
120 typedef const value_type& const_reference; \
121 /* should these be protected? */ \
122 typedef const KEY_T const_key_type; \
123 typedef const VALUE_T const_mapped_type; \
126 typedef KEY_EX_T key_extractor; \
127 typedef CLASSNAME Self; \
130 size_t m_tableBuckets; \
133 key_equal m_equals; \
134 key_extractor m_getKey; \
136 struct Node:public _wxHashTable_NodeBase \
139 Node( const value_type& value ) \
140 : m_value( value ) {} \
141 Node* m_next() { return (Node*)this->m_nxt; } \
143 value_type m_value; \
147 friend CLASSEXP Iterator; \
149 static void DeleteNode( _wxHashTable_NodeBase* node ) \
151 delete (Node*)node; \
155 /* forward iterator */ \
163 Iterator() : m_node(0), m_ht(0) {} \
164 Iterator( Node* node, const Self* ht ) \
165 : m_node(node), m_ht((Self*)ht) {} \
166 bool operator ==( const Iterator& it ) const \
167 { return m_node == it.m_node; } \
168 bool operator !=( const Iterator& it ) const \
169 { return m_node != it.m_node; } \
171 Node* GetNextNode() \
173 size_type bucket = GetBucketForNode(m_ht,m_node); \
174 for( size_type i = bucket + 1; i < m_ht->m_tableBuckets; ++i ) \
176 if( m_ht->m_table[i] ) \
177 return m_ht->m_table[i]; \
184 Node* next = m_node->m_next(); \
185 m_node = next ? next : GetNextNode(); \
190 CLASSEXP iterator : public Iterator \
193 iterator() : Iterator() {} \
194 iterator( Node* node, Self* ht ) : Iterator( node, ht ) {} \
195 iterator& operator++() { PlusPlus(); return *this; } \
196 iterator operator++(int) { iterator it=*this;PlusPlus();return it; } \
197 reference operator *() const { return m_node->m_value; } \
198 pointer operator ->() const { return &(m_node->m_value); } \
201 CLASSEXP const_iterator : public Iterator \
204 const_iterator() : Iterator() {} \
205 const_iterator( Node* node, const Self* ht ) \
206 : Iterator( node, (Self*)ht ) {} \
207 const_iterator& operator++() { PlusPlus();return *this; } \
208 const_iterator operator++(int) { const_iterator it=*this;PlusPlus();return it; } \
209 const_reference operator *() const { return m_node->m_value; } \
210 const_pointer operator ->() const { return &(m_node->m_value); } \
213 CLASSNAME( size_type sz = 10, const hasher& hfun = hasher(), \
214 const key_equal& k_eq = key_equal(), \
215 const key_extractor& k_ex = key_extractor() ) \
216 : m_tableBuckets( GetNextPrime( (unsigned long) sz ) ), \
222 m_table = (Node**)AllocTable( m_tableBuckets ); \
225 CLASSNAME( const Self& ht ) \
227 m_tableBuckets( 0 ), \
228 m_items( ht.m_items ), \
229 m_hasher( ht.m_hasher ), \
230 m_equals( ht.m_equals ), \
231 m_getKey( ht.m_getKey ) \
236 const Self& operator=( const Self& ht ) \
239 m_hasher = ht.m_hasher; \
240 m_equals = ht.m_equals; \
241 m_getKey = ht.m_getKey; \
242 m_items = ht.m_items; \
251 FreeTable(m_table); \
254 hasher hash_funct() { return m_hasher; } \
255 key_equal key_eq() { return m_equals; } \
257 /* removes all elements from the hash table, but does not */ \
258 /* shrink it ( perhaps it should ) */ \
261 DeleteNodes( m_tableBuckets, (_wxHashTable_NodeBase**)m_table, \
266 size_type size() const { return m_items; } \
267 size_type max_size() const { return size_type(-1); } \
268 bool empty() const { return size() == 0; } \
270 const_iterator end() const { return const_iterator( 0, this ); } \
271 iterator end() { return iterator( 0, this ); } \
272 const_iterator begin() const \
273 { return const_iterator( (Node*)GetFirstNode( m_tableBuckets, (_wxHashTable_NodeBase**)m_table ), this ); }; \
275 { return iterator( (Node*)GetFirstNode( m_tableBuckets, (_wxHashTable_NodeBase**)m_table ), this ); }; \
277 size_type erase( const const_key_type& key ) \
279 Node** node = GetNodePtr( key ); \
285 Node* temp = (*node)->m_next(); \
288 if( SHOULD_SHRINK( m_tableBuckets, m_items ) ) \
289 ResizeTable( GetPreviousPrime( (unsigned long) m_tableBuckets ) - 1 ); \
294 static size_type GetBucketForNode( Self* ht, Node* node ) \
296 return ht->m_hasher( ht->m_getKey( node->m_value ) ) \
297 % ht->m_tableBuckets; \
299 static Node* CopyNode( Node* node ) { return new Node( *node ); } \
301 Node* GetOrCreateNode( const value_type& value, bool& created ) \
303 const const_key_type& key = m_getKey( value ); \
304 size_t bucket = m_hasher( key ) % m_tableBuckets; \
305 Node* node = m_table[bucket]; \
309 if( m_equals( m_getKey( node->m_value ), key ) ) \
314 node = node->m_next(); \
317 return CreateNode( value, bucket); \
319 Node * CreateNode( const value_type& value, size_t bucket ) \
321 Node* node = new Node( value ); \
322 node->m_nxt = m_table[bucket]; \
323 m_table[bucket] = node; \
325 /* must be after the node is inserted */ \
327 if( SHOULD_GROW( m_tableBuckets, m_items ) ) \
328 ResizeTable( m_tableBuckets ); \
332 void CreateNode( const value_type& value ) \
334 CreateNode(value, m_hasher( m_getKey(value) ) % m_tableBuckets ); \
337 /* returns NULL if not found */ \
338 Node** GetNodePtr( const const_key_type& key ) const \
340 unsigned long hash = wx_static_cast(unsigned long, m_hasher( key )); \
341 Node** node = &m_table[hash % m_tableBuckets]; \
345 if( m_equals( m_getKey( (*node)->m_value ), key ) ) \
347 node = (Node**)&(*node)->m_nxt; \
353 /* returns NULL if not found */ \
354 /* expressing it in terms of GetNodePtr is 5-8% slower :-( */ \
355 Node* GetNode( const const_key_type& key ) const \
357 unsigned long hash = wx_static_cast(unsigned long, m_hasher( key )); \
358 Node* node = m_table[hash % m_tableBuckets]; \
362 if( m_equals( m_getKey( node->m_value ), key ) ) \
364 node = node->m_next(); \
370 void ResizeTable( size_t newSize ) \
372 newSize = GetNextPrime( (unsigned long)newSize ); \
373 Node** srcTable = m_table; \
374 size_t srcBuckets = m_tableBuckets; \
375 m_table = (Node**)AllocTable( newSize ); \
376 m_tableBuckets = newSize; \
378 CopyHashTable( (_wxHashTable_NodeBase**)srcTable, srcBuckets, \
379 this, (_wxHashTable_NodeBase**)m_table, \
380 (BucketFromNode)GetBucketForNode,\
381 (ProcessNode)&DummyProcessNode ); \
382 FreeTable(srcTable); \
385 /* this must be called _after_ m_table has been cleaned */ \
386 void HashCopy( const Self& ht ) \
388 ResizeTable( ht.size() ); \
389 CopyHashTable( (_wxHashTable_NodeBase**)ht.m_table, ht.m_tableBuckets,\
390 (_wxHashTableBase2*)this, \
391 (_wxHashTable_NodeBase**)m_table, \
392 (BucketFromNode)GetBucketForNode, \
393 (ProcessNode)CopyNode ); \
397 // defines an STL-like pair class CLASSNAME storing two fields: first of type
398 // KEY_T and second of type VALUE_T
399 #define _WX_DECLARE_PAIR( KEY_T, VALUE_T, CLASSNAME, CLASSEXP ) \
404 typedef VALUE_T t2; \
405 typedef const KEY_T const_t1; \
406 typedef const VALUE_T const_t2; \
408 CLASSNAME( const const_t1& f, const const_t2& s ):first(t1(f)),second(t2(s)) {} \
414 // defines the class CLASSNAME returning the key part (of type KEY_T) from a
415 // pair of type PAIR_T
416 #define _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, PAIR_T, CLASSNAME, CLASSEXP ) \
419 typedef KEY_T key_type; \
420 typedef PAIR_T pair_type; \
421 typedef const key_type const_key_type; \
422 typedef const pair_type const_pair_type; \
423 typedef const_key_type& const_key_reference; \
424 typedef const_pair_type& const_pair_reference; \
427 const_key_reference operator()( const_pair_reference pair ) const { return pair.first; }\
429 /* the dummy assignment operator is needed to suppress compiler */ \
430 /* warnings from hash table class' operator=(): gcc complains about */ \
431 /* "statement with no effect" without it */ \
432 CLASSNAME& operator=(const CLASSNAME&) { return *this; } \
435 // grow/shrink predicates
436 inline bool never_grow( size_t, size_t ) { return false; }
437 inline bool never_shrink( size_t, size_t ) { return false; }
438 inline bool grow_lf70( size_t buckets
, size_t items
)
440 return float(items
)/float(buckets
) >= 0.85;
443 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
445 // ----------------------------------------------------------------------------
446 // hashing and comparison functors
447 // ----------------------------------------------------------------------------
449 // NB: implementation detail: all of these classes must have dummy assignment
450 // operators to suppress warnings about "statement with no effect" from gcc
451 // in the hash table class assignment operator (where they're assigned)
453 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
456 class WXDLLIMPEXP_BASE wxIntegerHash
458 WX_HASH_MAP_NAMESPACE::hash
<long> longHash
;
459 WX_HASH_MAP_NAMESPACE::hash
<unsigned long> ulongHash
;
460 WX_HASH_MAP_NAMESPACE::hash
<int> intHash
;
461 WX_HASH_MAP_NAMESPACE::hash
<unsigned int> uintHash
;
462 WX_HASH_MAP_NAMESPACE::hash
<short> shortHash
;
463 WX_HASH_MAP_NAMESPACE::hash
<unsigned short> ushortHash
;
466 size_t operator()( long x
) const { return longHash( x
); }
467 size_t operator()( unsigned long x
) const { return ulongHash( x
); }
468 size_t operator()( int x
) const { return intHash( x
); }
469 size_t operator()( unsigned int x
) const { return uintHash( x
); }
470 size_t operator()( short x
) const { return shortHash( x
); }
471 size_t operator()( unsigned short x
) const { return ushortHash( x
); }
473 wxIntegerHash
& operator=(const wxIntegerHash
&) { return *this; }
476 #else // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
479 class WXDLLIMPEXP_BASE wxIntegerHash
483 unsigned long operator()( long x
) const { return (unsigned long)x
; }
484 unsigned long operator()( unsigned long x
) const { return x
; }
485 unsigned long operator()( int x
) const { return (unsigned long)x
; }
486 unsigned long operator()( unsigned int x
) const { return x
; }
487 unsigned long operator()( short x
) const { return (unsigned long)x
; }
488 unsigned long operator()( unsigned short x
) const { return x
; }
490 wxIntegerHash
& operator=(const wxIntegerHash
&) { return *this; }
493 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
495 class WXDLLIMPEXP_BASE wxIntegerEqual
499 bool operator()( long a
, long b
) const { return a
== b
; }
500 bool operator()( unsigned long a
, unsigned long b
) const { return a
== b
; }
501 bool operator()( int a
, int b
) const { return a
== b
; }
502 bool operator()( unsigned int a
, unsigned int b
) const { return a
== b
; }
503 bool operator()( short a
, short b
) const { return a
== b
; }
504 bool operator()( unsigned short a
, unsigned short b
) const { return a
== b
; }
506 wxIntegerEqual
& operator=(const wxIntegerEqual
&) { return *this; }
510 class WXDLLIMPEXP_BASE wxPointerHash
515 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
516 size_t operator()( const void* k
) const { return (size_t)k
; }
518 wxUIntPtr
operator()( const void* k
) const { return wxPtrToUInt(k
); }
521 wxPointerHash
& operator=(const wxPointerHash
&) { return *this; }
524 class WXDLLIMPEXP_BASE wxPointerEqual
528 bool operator()( const void* a
, const void* b
) const { return a
== b
; }
530 wxPointerEqual
& operator=(const wxPointerEqual
&) { return *this; }
533 // wxString, char*, wxChar*
534 class WXDLLIMPEXP_BASE wxStringHash
538 unsigned long operator()( const wxString
& x
) const
539 { return wxCharStringHash( x
.c_str() ); }
540 unsigned long operator()( const wxChar
* x
) const
541 { return wxCharStringHash( x
); }
542 static unsigned long wxCharStringHash( const wxChar
* );
544 unsigned long operator()( const char* x
) const
545 { return charStringHash( x
); }
546 static unsigned long charStringHash( const char* );
547 #endif // wxUSE_UNICODE
549 wxStringHash
& operator=(const wxStringHash
&) { return *this; }
552 class WXDLLIMPEXP_BASE wxStringEqual
556 bool operator()( const wxString
& a
, const wxString
& b
) const
558 bool operator()( const wxChar
* a
, const wxChar
* b
) const
559 { return wxStrcmp( a
, b
) == 0; }
561 bool operator()( const char* a
, const char* b
) const
562 { return strcmp( a
, b
) == 0; }
563 #endif // wxUSE_UNICODE
565 wxStringEqual
& operator=(const wxStringEqual
&) { return *this; }
568 #if !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
570 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
571 _WX_DECLARE_PAIR( KEY_T, VALUE_T, CLASSNAME##_wxImplementation_Pair, CLASSEXP ) \
572 _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_Pair, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
573 _WX_DECLARE_HASHTABLE( CLASSNAME##_wxImplementation_Pair, KEY_T, HASH_T, CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \
574 CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
577 typedef VALUE_T mapped_type; \
578 _WX_DECLARE_PAIR( iterator, bool, Insert_Result, CLASSEXP ) \
580 wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(), \
581 key_equal eq = key_equal() ) \
582 : CLASSNAME##_wxImplementation_HashTable( hint, hf, eq, \
583 CLASSNAME##_wxImplementation_KeyEx() ) {} \
585 mapped_type& operator[]( const const_key_type& key ) \
588 return GetOrCreateNode( \
589 CLASSNAME##_wxImplementation_Pair( key, mapped_type() ), \
590 created)->m_value.second; \
593 const_iterator find( const const_key_type& key ) const \
595 return const_iterator( GetNode( key ), this ); \
598 iterator find( const const_key_type& key ) \
600 return iterator( GetNode( key ), this ); \
603 Insert_Result insert( const value_type& v ) \
606 Node *node = GetOrCreateNode( \
607 CLASSNAME##_wxImplementation_Pair( v.first, v.second ), \
610 node->m_value.second = v.second; \
611 return Insert_Result(iterator(node, this), created); \
614 size_type erase( const key_type& k ) \
615 { return CLASSNAME##_wxImplementation_HashTable::erase( k ); } \
616 void erase( const iterator& it ) { erase( it->first ); } \
617 void erase( const const_iterator& it ) { erase( it->first ); } \
619 /* count() == 0 | 1 */ \
620 size_type count( const const_key_type& key ) \
621 { return GetNode( key ) ? 1 : 0; } \
624 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
626 // these macros are to be used in the user code
627 #define WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \
628 _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, class )
630 #define WX_DECLARE_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
631 _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \
634 #define WX_DECLARE_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
635 _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \
638 // and these do exactly the same thing but should be used inside the
640 #define WX_DECLARE_HASH_MAP_WITH_DECL( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL) \
641 _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL )
643 #define WX_DECLARE_EXPORTED_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \
644 WX_DECLARE_HASH_MAP_WITH_DECL( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, \
645 CLASSNAME, class WXDLLEXPORT )
647 #define WX_DECLARE_STRING_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, DECL ) \
648 _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \
651 #define WX_DECLARE_EXPORTED_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
652 WX_DECLARE_STRING_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, \
655 #define WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, DECL ) \
656 _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \
659 #define WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
660 WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, \
663 // delete all hash elements
665 // NB: the class declaration of the hash elements must be visible from the
666 // place where you use this macro, otherwise the proper destructor may not
667 // be called (a decent compiler should give a warning about it, but don't
669 #define WX_CLEAR_HASH_MAP(type, hashmap) \
671 type::iterator it, en; \
672 for( it = (hashmap).begin(), en = (hashmap).end(); it != en; ++it ) \
677 //---------------------------------------------------------------------------
678 // Declarations of common hashmap classes
680 WX_DECLARE_HASH_MAP_WITH_DECL( long, long, wxIntegerHash
, wxIntegerEqual
,
681 wxLongToLongHashMap
, class WXDLLIMPEXP_BASE
);
684 #endif // _WX_HASHMAP_H_