include/wx/hashmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        hashmap.h
   3 // Purpose:     wxHashMap class
   4 // Author:      Mattia Barbon
   5 // Modified by:
   6 // Created:     29/01/2002
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Mattia Barbon
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HASHMAP_H_
  13 #define _WX_HASHMAP_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "hashmap.h"
  17 #endif
  18
  19 #include "wx/string.h"
  20
  21 #if (defined(HAVE_EXT_HASH_MAP) || defined(HAVE_HASH_MAP)) \
  22     && (defined(HAVE_GNU_CXX_HASH_MAP) || defined(HAVE_STD_HASH_MAP))
  23     #define HAVE_STL_HASH_MAP
  24 #endif
  25
  26 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
  27
  28 #if defined(HAVE_EXT_HASH_MAP)
  29     #include <ext/hash_map>
  30 #elif defined(HAVE_HASH_MAP)
  31     #include <hash_map>
  32 #endif
  33
  34 #if defined(HAVE_GNU_CXX_HASH_MAP)
  35     #define WX_HASH_MAP_NAMESPACE __gnu_cxx
  36 #elif defined(HAVE_STD_HASH_MAP)
  37     #define WX_HASH_MAP_NAMESPACE std
  38 #endif
  39
  40 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
  41     typedef WX_HASH_MAP_NAMESPACE::hash_map< KEY_T, VALUE_T, HASH_T, KEY_EQ_T > CLASSNAME;
  42
  43 #else // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
  44
  45
  46 #ifdef __WXWINCE__
  47 typedef int ptrdiff_t;
  48 #else
  49 #include <stddef.h>             // for ptrdiff_t
  50 #endif
  51
  52 // private
  53 struct WXDLLIMPEXP_BASE _wxHashTable_NodeBase
  54 {
  55     _wxHashTable_NodeBase() : m_nxt(0) {}
  56
  57     _wxHashTable_NodeBase* m_nxt;
  58
  59 // Cannot do this:
  60 //  DECLARE_NO_COPY_CLASS(_wxHashTable_NodeBase)
  61 // without rewriting the macros, which require a public copy constructor.
  62 };
  63
  64 // private
  65 class WXDLLIMPEXP_BASE _wxHashTableBase2
  66 {
  67 public:
  68     typedef void (*NodeDtor)(_wxHashTable_NodeBase*);
  69     typedef unsigned long (*BucketFromNode)(_wxHashTableBase2*,_wxHashTable_NodeBase*);
  70     typedef _wxHashTable_NodeBase* (*ProcessNode)(_wxHashTable_NodeBase*);
  71 protected:
  72     static _wxHashTable_NodeBase* DummyProcessNode(_wxHashTable_NodeBase* node);
  73     static void DeleteNodes( size_t buckets, _wxHashTable_NodeBase** table,
  74                              NodeDtor dtor );
  75     static _wxHashTable_NodeBase* GetFirstNode( size_t buckets,
  76                                                 _wxHashTable_NodeBase** table )
  77     {
  78         for( size_t i = 0; i < buckets; ++i )
  79             if( table[i] )
  80                 return table[i];
  81         return 0;
  82     }
  83
  84     // as static const unsigned prime_count = 31 but works with all compilers
  85     enum { prime_count = 31 };
  86     static const unsigned long ms_primes[prime_count];
  87
  88     // returns the first prime in ms_primes greater than n
  89     static unsigned long GetNextPrime( unsigned long n );
  90
  91     // returns the first prime in ms_primes smaller than n
  92     // ( or ms_primes[0] if n is very small )
  93     static unsigned long GetPreviousPrime( unsigned long n );
  94
  95     static void CopyHashTable( _wxHashTable_NodeBase** srcTable,
  96                                size_t srcBuckets, _wxHashTableBase2* dst,
  97                                _wxHashTable_NodeBase** dstTable,
  98                                BucketFromNode func, ProcessNode proc );
  99
 100     static void** AllocTable( size_t sz )
 101     {
 102         return (void **)calloc(sz, sizeof(void*));
 103     }
 104 };
 105
 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 \
 108 { \
 109 public: \
 110     typedef KEY_T key_type; \
 111     typedef VALUE_T value_type; \
 112     typedef HASH_T hasher; \
 113     typedef KEY_EQ_T key_equal; \
 114  \
 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; \
 124 public: \
 125     struct Node; \
 126     typedef KEY_EX_T key_extractor; \
 127     typedef CLASSNAME Self; \
 128 protected: \
 129     Node** m_table; \
 130     size_t m_tableBuckets; \
 131     size_t m_items; \
 132     hasher m_hasher; \
 133     key_equal m_equals; \
 134     key_extractor m_getKey; \
 135 public: \
 136     struct Node:public _wxHashTable_NodeBase \
 137     { \
 138     public: \
 139         Node( const value_type& value ) \
 140             : m_value( value ) {} \
 141         Node* m_next() { return (Node*)this->m_nxt; } \
 142  \
 143         value_type m_value; \
 144     }; \
 145  \
 146     CLASSEXP Iterator; \
 147     friend CLASSEXP Iterator; \
 148 protected: \
 149     static void DeleteNode( _wxHashTable_NodeBase* node ) \
 150     { \
 151         delete (Node*)node; \
 152     } \
 153 public: \
 154     /*                  */ \
 155     /* forward iterator */ \
 156     /*                  */ \
 157     CLASSEXP Iterator \
 158     { \
 159     public: \
 160         Node* m_node; \
 161         Self* m_ht; \
 162  \
 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; } \
 170     protected: \
 171         Node* GetNextNode() \
 172         { \
 173             size_type bucket = GetBucketForNode(m_ht,m_node); \
 174             for( size_type i = bucket + 1; i < m_ht->m_tableBuckets; ++i ) \
 175             { \
 176                 if( m_ht->m_table[i] ) \
 177                     return m_ht->m_table[i]; \
 178             } \
 179             return 0; \
 180         } \
 181  \
 182         void PlusPlus() \
 183         { \
 184             Node* next = m_node->m_next(); \
 185             m_node = next ? next : GetNextNode(); \
 186         } \
 187     }; \
 188  \
 189 public: \
 190     CLASSEXP iterator : public Iterator \
 191     { \
 192     public: \
 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); } \
 199     }; \
 200  \
 201     CLASSEXP const_iterator : public Iterator \
 202     { \
 203     public: \
 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); } \
 211     }; \
 212  \
 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 ) ), \
 217           m_items( 0 ), \
 218           m_hasher( hfun ), \
 219           m_equals( k_eq ), \
 220           m_getKey( k_ex ) \
 221     { \
 222         m_table = (Node**)AllocTable( m_tableBuckets ); \
 223     } \
 224  \
 225     CLASSNAME( const Self& ht ) \
 226         : m_table( 0 ), \
 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 ) \
 232     { \
 233         HashCopy( ht ); \
 234     } \
 235  \
 236     const Self& operator=( const Self& ht ) \
 237     { \
 238          clear(); \
 239          m_hasher = ht.m_hasher; \
 240          m_equals = ht.m_equals; \
 241          m_getKey = ht.m_getKey; \
 242          m_items = ht.m_items; \
 243          HashCopy( ht ); \
 244          return *this; \
 245     } \
 246  \
 247     ~CLASSNAME() \
 248     { \
 249         clear(); \
 250  \
 251         free(m_table); \
 252     } \
 253  \
 254     hasher hash_funct() { return m_hasher; } \
 255     key_equal key_eq() { return m_equals; } \
 256  \
 257     /* removes all elements from the hash table, but does not */ \
 258     /* shrink it ( perhaps it should ) */ \
 259     void clear() \
 260     { \
 261         DeleteNodes( m_tableBuckets, (_wxHashTable_NodeBase**)m_table, \
 262                      DeleteNode ); \
 263         m_items = 0; \
 264     } \
 265  \
 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; } \
 269  \
 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 ); }; \
 274     iterator begin() \
 275         { return iterator( (Node*)GetFirstNode( m_tableBuckets, (_wxHashTable_NodeBase**)m_table ), this ); }; \
 276  \
 277     size_type erase( const const_key_type& key ) \
 278     { \
 279         Node** node = GetNodePtr( key ); \
 280  \
 281         if( !node ) \
 282             return 0; \
 283  \
 284         --m_items; \
 285         Node* temp = (*node)->m_next(); \
 286         delete *node; \
 287         (*node) = temp; \
 288         if( SHOULD_SHRINK( m_tableBuckets, m_items ) ) \
 289             ResizeTable( GetPreviousPrime( (unsigned long) m_tableBuckets ) - 1 ); \
 290         return 1; \
 291     } \
 292  \
 293 protected: \
 294     static size_type GetBucketForNode( Self* ht, Node* node ) \
 295     { \
 296         return ht->m_hasher( ht->m_getKey( node->m_value ) ) \
 297             % ht->m_tableBuckets; \
 298     } \
 299     static Node* CopyNode( Node* node ) { return new Node( *node ); } \
 300  \
 301     Node* GetOrCreateNode( const value_type& value, bool& created ) \
 302     { \
 303         const const_key_type& key = m_getKey( value ); \
 304         size_t bucket = m_hasher( key ) % m_tableBuckets; \
 305         Node* node = m_table[bucket]; \
 306  \
 307         while( node ) \
 308         { \
 309             if( m_equals( m_getKey( node->m_value ), key ) ) \
 310             { \
 311                 created = false; \
 312                 return node; \
 313             } \
 314             node = node->m_next(); \
 315         } \
 316         created = true; \
 317         return CreateNode( value, bucket); \
 318     }\
 319     Node * CreateNode( const value_type& value, size_t bucket ) \
 320     {\
 321         Node* node = new Node( value ); \
 322         node->m_nxt = m_table[bucket]; \
 323         m_table[bucket] = node; \
 324  \
 325         /* must be after the node is inserted */ \
 326         ++m_items; \
 327         if( SHOULD_GROW( m_tableBuckets, m_items ) ) \
 328             ResizeTable( m_tableBuckets ); \
 329  \
 330         return node; \
 331     } \
 332     void CreateNode( const value_type& value ) \
 333     {\
 334         CreateNode(value, m_hasher( m_getKey(value) ) % m_tableBuckets ); \
 335     }\
 336  \
 337     /* returns NULL if not found */ \
 338     Node** GetNodePtr( const const_key_type& key ) const \
 339     { \
 340         unsigned long hash = m_hasher( key ); \
 341         Node** node = &m_table[hash % m_tableBuckets]; \
 342  \
 343         while( *node ) \
 344         { \
 345             if( m_equals( m_getKey( (*node)->m_value ), key ) ) \
 346                 return node; \
 347             node = (Node**)&(*node)->m_nxt; \
 348         } \
 349  \
 350         return 0; \
 351     } \
 352  \
 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 \
 356     { \
 357         unsigned long hash = m_hasher( key ); \
 358         Node* node = m_table[hash % m_tableBuckets]; \
 359  \
 360         while( node ) \
 361         { \
 362             if( m_equals( m_getKey( node->m_value ), key ) ) \
 363                 return node; \
 364             node = node->m_next(); \
 365         } \
 366  \
 367         return 0; \
 368     } \
 369  \
 370     void ResizeTable( size_t newSize ) \
 371     { \
 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; \
 377  \
 378         CopyHashTable( (_wxHashTable_NodeBase**)srcTable, srcBuckets, \
 379                        this, (_wxHashTable_NodeBase**)m_table, \
 380                        (BucketFromNode)GetBucketForNode,\
 381                        (ProcessNode)&DummyProcessNode ); \
 382         free(srcTable); \
 383     } \
 384  \
 385     /* this must be called _after_ m_table has been cleaned */ \
 386     void HashCopy( const Self& ht ) \
 387     { \
 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 ); \
 394     } \
 395 };
 396
 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 ) \
 400 CLASSEXP CLASSNAME \
 401 { \
 402 public: \
 403     typedef KEY_T t1; \
 404     typedef VALUE_T t2; \
 405     typedef const KEY_T const_t1; \
 406     typedef const VALUE_T const_t2; \
 407  \
 408     CLASSNAME( const const_t1& f, const const_t2& s ):first(t1(f)),second(t2(s)) {} \
 409  \
 410     t1 first; \
 411     t2 second; \
 412 };
 413
 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 ) \
 417 CLASSEXP CLASSNAME \
 418 { \
 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; \
 425 public: \
 426     CLASSNAME() { } \
 427     const_key_reference operator()( const_pair_reference pair ) const { return pair.first; }\
 428     \
 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; } \
 433 };
 434
 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 )
 439 {
 440     return float(items)/float(buckets) >= 0.85;
 441 }
 442
 443 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 444
 445 // ----------------------------------------------------------------------------
 446 // hashing and comparison functors
 447 // ----------------------------------------------------------------------------
 448
 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)
 452
 453 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
 454
 455 // integer types
 456 class WXDLLIMPEXP_BASE wxIntegerHash
 457 {
 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;
 464 public:
 465     wxIntegerHash() { }
 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 ); }
 472
 473     wxIntegerHash& operator=(const wxIntegerHash&) { return *this; }
 474 };
 475
 476 #else // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 477
 478 // integer types
 479 class WXDLLIMPEXP_BASE wxIntegerHash
 480 {
 481 public:
 482     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; }
 489
 490     wxIntegerHash& operator=(const wxIntegerHash&) { return *this; }
 491 };
 492
 493 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 494
 495 class WXDLLIMPEXP_BASE wxIntegerEqual
 496 {
 497 public:
 498     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; }
 505
 506     wxIntegerEqual& operator=(const wxIntegerEqual&) { return *this; }
 507 };
 508
 509 // pointers
 510 class WXDLLIMPEXP_BASE wxPointerHash
 511 {
 512 public:
 513     wxPointerHash() { }
 514
 515     // TODO: this might not work well on architectures with 64 bit pointers but
 516     //       32 bit longs, we should use % ULONG_MAX there
 517 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
 518     size_t operator()( const void* k ) const { return (size_t)k; }
 519 #else
 520     unsigned long operator()( const void* k ) const { return (unsigned long)wxPtrToULong(k); }
 521 #endif
 522
 523     wxPointerHash& operator=(const wxPointerHash&) { return *this; }
 524 };
 525
 526 class WXDLLIMPEXP_BASE wxPointerEqual
 527 {
 528 public:
 529     wxPointerEqual() { }
 530     bool operator()( const void* a, const void* b ) const { return a == b; }
 531
 532     wxPointerEqual& operator=(const wxPointerEqual&) { return *this; }
 533 };
 534
 535 // wxString, char*, wxChar*
 536 class WXDLLIMPEXP_BASE wxStringHash
 537 {
 538 public:
 539     wxStringHash() {}
 540     unsigned long operator()( const wxString& x ) const
 541         { return wxCharStringHash( x.c_str() ); }
 542     unsigned long operator()( const wxChar* x ) const
 543         { return wxCharStringHash( x ); }
 544     static unsigned long wxCharStringHash( const wxChar* );
 545 #if wxUSE_UNICODE
 546     unsigned long operator()( const char* x ) const
 547         { return charStringHash( x ); }
 548     static unsigned long charStringHash( const char* );
 549 #endif // wxUSE_UNICODE
 550
 551     wxStringHash& operator=(const wxStringHash&) { return *this; }
 552 };
 553
 554 class WXDLLIMPEXP_BASE wxStringEqual
 555 {
 556 public:
 557     wxStringEqual() {}
 558     bool operator()( const wxString& a, const wxString& b ) const
 559         { return a == b; }
 560     bool operator()( const wxChar* a, const wxChar* b ) const
 561         { return wxStrcmp( a, b ) == 0; }
 562 #if wxUSE_UNICODE
 563     bool operator()( const char* a, const char* b ) const
 564         { return strcmp( a, b ) == 0; }
 565 #endif // wxUSE_UNICODE
 566
 567     wxStringEqual& operator=(const wxStringEqual&) { return *this; }
 568 };
 569
 570 #if !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 571
 572 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
 573 _WX_DECLARE_PAIR( KEY_T, VALUE_T, CLASSNAME##_wxImplementation_Pair, CLASSEXP ) \
 574 _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_Pair, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
 575 _WX_DECLARE_HASHTABLE( CLASSNAME##_wxImplementation_Pair, KEY_T, HASH_T, CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \
 576 CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
 577 { \
 578 public: \
 579     typedef VALUE_T mapped_type; \
 580     _WX_DECLARE_PAIR( iterator, bool, Insert_Result, CLASSEXP ) \
 581  \
 582     wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(),        \
 583                           key_equal eq = key_equal() )                       \
 584         : CLASSNAME##_wxImplementation_HashTable( hint, hf, eq,              \
 585                                    CLASSNAME##_wxImplementation_KeyEx() ) {} \
 586  \
 587     mapped_type& operator[]( const const_key_type& key ) \
 588     { \
 589         bool created; \
 590         return GetOrCreateNode( \
 591                 CLASSNAME##_wxImplementation_Pair( key, mapped_type() ), \
 592                 created)->m_value.second; \
 593     } \
 594  \
 595     const_iterator find( const const_key_type& key ) const \
 596     { \
 597         return const_iterator( GetNode( key ), this ); \
 598     } \
 599  \
 600     iterator find( const const_key_type& key ) \
 601     { \
 602         return iterator( GetNode( key ), this ); \
 603     } \
 604  \
 605     Insert_Result insert( const value_type& v ) \
 606     { \
 607         bool created; \
 608         Node *node = GetOrCreateNode( \
 609                 CLASSNAME##_wxImplementation_Pair( v.first, v.second ), \
 610                 created); \
 611         if ( !created ) \
 612             node->m_value.second = v.second; \
 613         return Insert_Result(iterator(node, this), created); \
 614     } \
 615  \
 616     size_type erase( const key_type& k ) \
 617         { return CLASSNAME##_wxImplementation_HashTable::erase( k ); } \
 618     void erase( const iterator& it ) { erase( it->first ); } \
 619     void erase( const const_iterator& it ) { erase( it->first ); } \
 620  \
 621     /* count() == 0 | 1 */ \
 622     size_type count( const const_key_type& key ) \
 623         { return GetNode( key ) ? 1 : 0; } \
 624 }
 625
 626 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 627
 628 // these macros are to be used in the user code
 629 #define WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \
 630     _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, class )
 631
 632 #define WX_DECLARE_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
 633     _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \
 634                           CLASSNAME, class )
 635
 636 #define WX_DECLARE_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
 637     _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \
 638                           CLASSNAME, class )
 639
 640 // and these do exactly the same thing but should be used inside the
 641 // library
 642 #define WX_DECLARE_HASH_MAP_WITH_DECL( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL) \
 643     _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL )
 644
 645 #define WX_DECLARE_EXPORTED_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \
 646     WX_DECLARE_HASH_MAP_WITH_DECL( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, \
 647                                    CLASSNAME, class WXDLLEXPORT )
 648
 649 #define WX_DECLARE_STRING_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, DECL ) \
 650     _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \
 651                           CLASSNAME, DECL )
 652
 653 #define WX_DECLARE_EXPORTED_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
 654     WX_DECLARE_STRING_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, \
 655                                           class WXDLLEXPORT )
 656
 657 #define WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, DECL ) \
 658     _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \
 659                           CLASSNAME, DECL )
 660
 661 #define WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
 662     WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, \
 663                                            class WXDLLEXPORT )
 664
 665 // delete all hash elements
 666 //
 667 // NB: the class declaration of the hash elements must be visible from the
 668 //     place where you use this macro, otherwise the proper destructor may not
 669 //     be called (a decent compiler should give a warning about it, but don't
 670 //     count on it)!
 671 #define WX_CLEAR_HASH_MAP(type, hashmap)                                     \
 672     {                                                                        \
 673         type::iterator it, en;                                               \
 674         for( it = (hashmap).begin(), en = (hashmap).end(); it != en; ++it )  \
 675             delete it->second;                                               \
 676         (hashmap).clear();                                                   \
 677     }
 678
 679 //---------------------------------------------------------------------------
 680 // Declarations of common hashmap classes
 681
 682 WX_DECLARE_HASH_MAP_WITH_DECL( long, long, wxIntegerHash, wxIntegerEqual,
 683                                wxLongToLongHashMap, class WXDLLIMPEXP_BASE );
 684
 685
 686 #endif // _WX_HASHMAP_H_
 687