Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / hashmap.h

diff --git a/include/wx/hashmap.h b/include/wx/hashmap.h
index f2a3f6642e5d97bc18fef9fabfbf86bbe152f4f0..9a25f8e183a2b1199ccf0afcd947cfcbc8fa22b9 100644 (file)
--- a/include/wx/hashmap.h
+++ b/include/wx/hashmap.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        hashmap.cpp
+// Name:        wx/hashmap.h

 // Purpose:     wxHashMap class
 // Author:      Mattia Barbon
 // Modified by:
 // Purpose:     wxHashMap class
 // Author:      Mattia Barbon
 // Modified by:


@@ -12,22 +12,77 @@
 #ifndef _WX_HASHMAP_H_
 #define _WX_HASHMAP_H_
 
 #ifndef _WX_HASHMAP_H_
 #define _WX_HASHMAP_H_
 

-#ifdef __GNUG__
-#pragma interface "hashmap.h"
+#include "wx/string.h"
+#include "wx/wxcrt.h"
+
+// In wxUSE_STD_CONTAINERS build we prefer to use the standard hash map class
+// but it can be either in non-standard hash_map header (old g++ and some other
+// STL implementations) or in C++0x standard unordered_map which can in turn be
+// available either in std::tr1 or std namespace itself
+//
+// To summarize: if std::unordered_map is available use it, otherwise use tr1
+// and finally fall back to non-standard hash_map
+
+#if (defined(HAVE_EXT_HASH_MAP) || defined(HAVE_HASH_MAP)) \
+    && (defined(HAVE_GNU_CXX_HASH_MAP) || defined(HAVE_STD_HASH_MAP))
+    #define HAVE_STL_HASH_MAP
+#endif
+
+#if wxUSE_STD_CONTAINERS && \
+    (defined(HAVE_STD_UNORDERED_MAP) || defined(HAVE_TR1_UNORDERED_MAP))
+
+#if defined(HAVE_STD_UNORDERED_MAP)
+    #include <unordered_map>
+    #define WX_HASH_MAP_NAMESPACE std
+#elif defined(HAVE_TR1_UNORDERED_MAP)
+    #include <tr1/unordered_map>
+    #define WX_HASH_MAP_NAMESPACE std::tr1
+#endif
+
+#define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
+    typedef WX_HASH_MAP_NAMESPACE::unordered_map< KEY_T, VALUE_T, HASH_T, KEY_EQ_T > CLASSNAME
+
+#elif wxUSE_STD_CONTAINERS && defined(HAVE_STL_HASH_MAP)
+
+#if defined(HAVE_EXT_HASH_MAP)
+    #include <ext/hash_map>
+#elif defined(HAVE_HASH_MAP)
+    #include <hash_map>
+#endif
+
+#if defined(HAVE_GNU_CXX_HASH_MAP)
+    #define WX_HASH_MAP_NAMESPACE __gnu_cxx
+#elif defined(HAVE_STD_HASH_MAP)
+    #define WX_HASH_MAP_NAMESPACE std

 #endif
 
 #endif
 

-#include <wx/string.h>
+#define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
+    typedef WX_HASH_MAP_NAMESPACE::hash_map< KEY_T, VALUE_T, HASH_T, KEY_EQ_T > CLASSNAME
+
+#else // !wxUSE_STD_CONTAINERS || no std::{hash,unordered}_map class available
+
+#define wxNEEDS_WX_HASH_MAP
+
+#ifdef __WXWINCE__
+typedef int ptrdiff_t;
+#else
+#include <stddef.h>             // for ptrdiff_t
+#endif

 
 // private
 
 // private

-struct WXDLLEXPORT _wxHashTable_NodeBase
+struct WXDLLIMPEXP_BASE _wxHashTable_NodeBase

 {
 {

-    _wxHashTable_NodeBase() : m_nxt(0) {}
+    _wxHashTable_NodeBase() : m_next(NULL) {}

 
 

-    _wxHashTable_NodeBase* m_nxt;
+    _wxHashTable_NodeBase* m_next;
+
+// Cannot do this:
+//  wxDECLARE_NO_COPY_CLASS(_wxHashTable_NodeBase);
+// without rewriting the macros, which require a public copy constructor.

 };
 
 // private
 };
 
 // private

-class WXDLLEXPORT _wxHashTableBase2
+class WXDLLIMPEXP_BASE _wxHashTableBase2

 {
 public:
     typedef void (*NodeDtor)(_wxHashTable_NodeBase*);
 {
 public:
     typedef void (*NodeDtor)(_wxHashTable_NodeBase*);


@@ -43,7 +98,7 @@ protected:
         for( size_t i = 0; i < buckets; ++i )
             if( table[i] )
                 return table[i];
         for( size_t i = 0; i < buckets; ++i )
             if( table[i] )
                 return table[i];

-        return 0;
+        return NULL;

     }
 
     // as static const unsigned prime_count = 31 but works with all compilers
     }
 
     // as static const unsigned prime_count = 31 but works with all compilers


@@ -62,13 +117,19 @@ protected:
                                _wxHashTable_NodeBase** dstTable,
                                BucketFromNode func, ProcessNode proc );
 
                                _wxHashTable_NodeBase** dstTable,
                                BucketFromNode func, ProcessNode proc );
 

-    static void** AllocTable( size_t size )
+    static void** AllocTable( size_t sz )
+    {
+        return (void **)calloc(sz, sizeof(void*));
+    }
+    static void FreeTable(void *table)

     {
     {

-        return (void **)calloc(size, sizeof(void*));
+        free(table);

     }
 };
 
     }
 };
 

-#define _WX_DECLARE_HASHTABLE( VALUE_T, KEY_T, HASH_T, KEY_EX_T, KEY_EQ_T, CLASSNAME, CLASSEXP, SHOULD_GROW, SHOULD_SHRINK ) \
+#define _WX_DECLARE_HASHTABLE( VALUE_T, KEY_T, HASH_T, KEY_EX_T, KEY_EQ_T,\
+                               PTROPERATOR, CLASSNAME, CLASSEXP, \
+                               SHOULD_GROW, SHOULD_SHRINK ) \

 CLASSEXP CLASSNAME : protected _wxHashTableBase2 \
 { \
 public: \
 CLASSEXP CLASSNAME : protected _wxHashTableBase2 \
 { \
 public: \


@@ -86,47 +147,45 @@ public: \
     /* should these be protected? */ \
     typedef const KEY_T const_key_type; \
     typedef const VALUE_T const_mapped_type; \
     /* should these be protected? */ \
     typedef const KEY_T const_key_type; \
     typedef const VALUE_T const_mapped_type; \

-protected: \
-    struct Node; \
+public: \

     typedef KEY_EX_T key_extractor; \
     typedef CLASSNAME Self; \
     typedef KEY_EX_T key_extractor; \
     typedef CLASSNAME Self; \

- \
-    Node** m_table; \
+protected: \
+    _wxHashTable_NodeBase** m_table; \

     size_t m_tableBuckets; \
     size_t m_items; \
     hasher m_hasher; \
     key_equal m_equals; \
     key_extractor m_getKey; \
     size_t m_tableBuckets; \
     size_t m_items; \
     hasher m_hasher; \
     key_equal m_equals; \
     key_extractor m_getKey; \

- \
+public: \

     struct Node:public _wxHashTable_NodeBase \
     { \
     public: \
         Node( const value_type& value ) \
             : m_value( value ) {} \
     struct Node:public _wxHashTable_NodeBase \
     { \
     public: \
         Node( const value_type& value ) \
             : m_value( value ) {} \

-        Node* m_next() { return (Node*)this->m_nxt; } \
+        Node* next() { return static_cast<Node*>(m_next); } \

  \
         value_type m_value; \
     }; \
  \
  \
         value_type m_value; \
     }; \
  \

-    struct Iterator; \
-    friend struct Iterator; \
- \
+protected: \

     static void DeleteNode( _wxHashTable_NodeBase* node ) \
     { \
     static void DeleteNode( _wxHashTable_NodeBase* node ) \
     { \

-        delete (Node*)node; \
+        delete static_cast<Node*>(node); \

     } \
     } \

- \
+public: \

     /*                  */ \
     /* forward iterator */ \
     /*                  */ \
     /*                  */ \
     /* forward iterator */ \
     /*                  */ \

-    struct Iterator \
+    CLASSEXP Iterator \

     { \
     { \

+    public: \

         Node* m_node; \
         Self* m_ht; \
  \
         Node* m_node; \
         Self* m_ht; \
  \

-        Iterator() : m_node(0), m_ht(0) {} \
+        Iterator() : m_node(NULL), m_ht(NULL) {} \

         Iterator( Node* node, const Self* ht ) \
         Iterator( Node* node, const Self* ht ) \

-            : m_node(node), m_ht((Self*)ht) {} \
+            : m_node(node), m_ht(const_cast<Self*>(ht)) {} \

         bool operator ==( const Iterator& it ) const \
             { return m_node == it.m_node; } \
         bool operator !=( const Iterator& it ) const \
         bool operator ==( const Iterator& it ) const \
             { return m_node == it.m_node; } \
         bool operator !=( const Iterator& it ) const \


@@ -138,54 +197,58 @@ protected: \
             for( size_type i = bucket + 1; i < m_ht->m_tableBuckets; ++i ) \
             { \
                 if( m_ht->m_table[i] ) \
             for( size_type i = bucket + 1; i < m_ht->m_tableBuckets; ++i ) \
             { \
                 if( m_ht->m_table[i] ) \

-                    return m_ht->m_table[i]; \
+                    return static_cast<Node*>(m_ht->m_table[i]); \

             } \
             } \

-            return 0; \
+            return NULL; \

         } \
  \
         void PlusPlus() \
         { \
         } \
  \
         void PlusPlus() \
         { \

-            Node* next = m_node->m_next(); \
+            Node* next = m_node->next(); \

             m_node = next ? next : GetNextNode(); \
         } \
     }; \
             m_node = next ? next : GetNextNode(); \
         } \
     }; \

+    friend class Iterator; \

  \
 public: \
  \
 public: \

-    struct iterator:public Iterator \
+    CLASSEXP iterator : public Iterator \

     { \
     { \

+    public: \

         iterator() : Iterator() {} \
         iterator( Node* node, Self* ht ) : Iterator( node, ht ) {} \
         iterator& operator++() { PlusPlus(); return *this; } \
         iterator operator++(int) { iterator it=*this;PlusPlus();return it; } \
         reference operator *() const { return m_node->m_value; } \
         iterator() : Iterator() {} \
         iterator( Node* node, Self* ht ) : Iterator( node, ht ) {} \
         iterator& operator++() { PlusPlus(); return *this; } \
         iterator operator++(int) { iterator it=*this;PlusPlus();return it; } \
         reference operator *() const { return m_node->m_value; } \

-        pointer operator ->() const { return &(m_node->m_value); } \
+        PTROPERATOR(pointer) \

     }; \
  \
     }; \
  \

-    struct const_iterator:public Iterator \
+    CLASSEXP const_iterator : public Iterator \

     { \
     { \

+    public: \

         const_iterator() : Iterator() {} \
         const_iterator() : Iterator() {} \

+        const_iterator(iterator i) : Iterator(i) {} \

         const_iterator( Node* node, const Self* ht ) \
         const_iterator( Node* node, const Self* ht ) \

-            : Iterator( node, (Self*)ht ) {} \
+            : Iterator(node, const_cast<Self*>(ht)) {} \

         const_iterator& operator++() { PlusPlus();return *this; } \
         const_iterator operator++(int) { const_iterator it=*this;PlusPlus();return it; } \
         const_reference operator *() const { return m_node->m_value; } \
         const_iterator& operator++() { PlusPlus();return *this; } \
         const_iterator operator++(int) { const_iterator it=*this;PlusPlus();return it; } \
         const_reference operator *() const { return m_node->m_value; } \

-        const_pointer operator ->() const { return &(m_node->m_value); } \
+        PTROPERATOR(const_pointer) \

     }; \
  \
     }; \
  \

-    CLASSNAME( size_type size = 10, const hasher& hfun = hasher(), \
+    CLASSNAME( size_type sz = 10, const hasher& hfun = hasher(), \

                const key_equal& k_eq = key_equal(), \
                const key_extractor& k_ex = key_extractor() ) \
                const key_equal& k_eq = key_equal(), \
                const key_extractor& k_ex = key_extractor() ) \

-        : m_tableBuckets( GetNextPrime( size ) ), \
+        : m_tableBuckets( GetNextPrime( (unsigned long) sz ) ), \

           m_items( 0 ), \
           m_hasher( hfun ), \
           m_equals( k_eq ), \
           m_getKey( k_ex ) \
     { \
           m_items( 0 ), \
           m_hasher( hfun ), \
           m_equals( k_eq ), \
           m_getKey( k_ex ) \
     { \

-        m_table = (Node**)AllocTable( m_tableBuckets ); \
+        m_table = (_wxHashTable_NodeBase**)AllocTable(m_tableBuckets); \

     } \
  \
     CLASSNAME( const Self& ht ) \
     } \
  \
     CLASSNAME( const Self& ht ) \

-        : m_table( 0 ), \
+        : m_table(NULL), \

           m_tableBuckets( 0 ), \
           m_items( ht.m_items ), \
           m_hasher( ht.m_hasher ), \
           m_tableBuckets( 0 ), \
           m_items( ht.m_items ), \
           m_hasher( ht.m_hasher ), \


@@ -197,12 +260,15 @@ public: \
  \
     const Self& operator=( const Self& ht ) \
     { \
  \
     const Self& operator=( const Self& ht ) \
     { \

-         clear(); \
-         m_hasher = ht.m_hasher; \
-         m_equals = ht.m_equals; \
-         m_getKey = ht.m_getKey; \
-         m_items = ht.m_items; \
-         HashCopy( ht ); \
+         if (&ht != this) \
+         { \
+             clear(); \
+             m_hasher = ht.m_hasher; \
+             m_equals = ht.m_equals; \
+             m_getKey = ht.m_getKey; \
+             m_items = ht.m_items; \
+             HashCopy( ht ); \
+         } \

          return *this; \
     } \
  \
          return *this; \
     } \
  \


@@ -210,7 +276,7 @@ public: \
     { \
         clear(); \
  \
     { \
         clear(); \
  \

-        free(m_table); \
+        FreeTable(m_table); \

     } \
  \
     hasher hash_funct() { return m_hasher; } \
     } \
  \
     hasher hash_funct() { return m_hasher; } \


@@ -218,32 +284,36 @@ public: \
  \
     /* removes all elements from the hash table, but does not */ \
     /* shrink it ( perhaps it should ) */ \
  \
     /* removes all elements from the hash table, but does not */ \
     /* shrink it ( perhaps it should ) */ \

-    void clear() { DeleteNodes( m_tableBuckets, (_wxHashTable_NodeBase**)m_table, DeleteNode ); } \
+    void clear() \
+    { \
+        DeleteNodes(m_tableBuckets, m_table, DeleteNode); \
+        m_items = 0; \
+    } \

  \
     size_type size() const { return m_items; } \
     size_type max_size() const { return size_type(-1); } \
     bool empty() const { return size() == 0; } \
  \
  \
     size_type size() const { return m_items; } \
     size_type max_size() const { return size_type(-1); } \
     bool empty() const { return size() == 0; } \
  \

-    const_iterator end() const { return const_iterator( 0, this ); } \
-    iterator end() { return iterator( 0, this ); } \
+    const_iterator end() const { return const_iterator(NULL, this); } \
+    iterator end() { return iterator(NULL, this); } \

     const_iterator begin() const \
     const_iterator begin() const \

-        { return const_iterator( (Node*)GetFirstNode( m_tableBuckets, (_wxHashTable_NodeBase**)m_table ), this ); }; \
+        { return const_iterator(static_cast<Node*>(GetFirstNode(m_tableBuckets, m_table)), this); } \

     iterator begin() \
     iterator begin() \

-        { return iterator( (Node*)GetFirstNode( m_tableBuckets, (_wxHashTable_NodeBase**)m_table ), this ); }; \
+        { return iterator(static_cast<Node*>(GetFirstNode(m_tableBuckets, m_table)), this); } \

  \
     size_type erase( const const_key_type& key ) \
     { \
  \
     size_type erase( const const_key_type& key ) \
     { \

-        Node** node = GetNodePtr( key ); \
+        _wxHashTable_NodeBase** node = GetNodePtr(key); \

  \
         if( !node ) \
             return 0; \
  \
         --m_items; \
  \
         if( !node ) \
             return 0; \
  \
         --m_items; \

-        Node* temp = (*node)->m_next(); \
-        delete *node; \
+        _wxHashTable_NodeBase* temp = (*node)->m_next; \
+        delete static_cast<Node*>(*node); \

         (*node) = temp; \
         if( SHOULD_SHRINK( m_tableBuckets, m_items ) ) \
         (*node) = temp; \
         if( SHOULD_SHRINK( m_tableBuckets, m_items ) ) \

-            ResizeTable( GetPreviousPrime( m_tableBuckets ) - 1 ); \
+            ResizeTable( GetPreviousPrime( (unsigned long) m_tableBuckets ) - 1 ); \

         return 1; \
     } \
  \
         return 1; \
     } \
  \


@@ -255,21 +325,28 @@ protected: \
     } \
     static Node* CopyNode( Node* node ) { return new Node( *node ); } \
  \
     } \
     static Node* CopyNode( Node* node ) { return new Node( *node ); } \
  \

-    Node* GetOrCreateNode( const value_type& value ) \
+    Node* GetOrCreateNode( const value_type& value, bool& created ) \

     { \
         const const_key_type& key = m_getKey( value ); \
         size_t bucket = m_hasher( key ) % m_tableBuckets; \
     { \
         const const_key_type& key = m_getKey( value ); \
         size_t bucket = m_hasher( key ) % m_tableBuckets; \

-        Node* node = m_table[bucket]; \
+        Node* node = static_cast<Node*>(m_table[bucket]); \

  \
         while( node ) \
         { \
             if( m_equals( m_getKey( node->m_value ), key ) ) \
  \
         while( node ) \
         { \
             if( m_equals( m_getKey( node->m_value ), key ) ) \

+            { \
+                created = false; \

                 return node; \
                 return node; \

-            node = node->m_next(); \
+            } \
+            node = node->next(); \

         } \
         } \

- \
-        node = new Node( value ); \
-        node->m_nxt = m_table[bucket]; \
+        created = true; \
+        return CreateNode( value, bucket); \
+    }\
+    Node * CreateNode( const value_type& value, size_t bucket ) \
+    {\
+        Node* node = new Node( value ); \
+        node->m_next = m_table[bucket]; \

         m_table[bucket] = node; \
  \
         /* must be after the node is inserted */ \
         m_table[bucket] = node; \
  \
         /* must be after the node is inserted */ \


@@ -279,64 +356,68 @@ protected: \
  \
         return node; \
     } \
  \
         return node; \
     } \

+    void CreateNode( const value_type& value ) \
+    {\
+        CreateNode(value, m_hasher( m_getKey(value) ) % m_tableBuckets ); \
+    }\

  \
     /* returns NULL if not found */ \
  \
     /* returns NULL if not found */ \

-    Node** GetNodePtr( const const_key_type& key ) const \
+    _wxHashTable_NodeBase** GetNodePtr(const const_key_type& key) const \

     { \
     { \

-        unsigned long hash = m_hasher( key ); \
-        Node** node = &m_table[hash % m_tableBuckets]; \
+        size_t bucket = m_hasher( key ) % m_tableBuckets; \
+        _wxHashTable_NodeBase** node = &m_table[bucket]; \

  \
         while( *node ) \
         { \
  \
         while( *node ) \
         { \

-            if( m_equals( m_getKey( (*node)->m_value ), key ) ) \
+            if (m_equals(m_getKey(static_cast<Node*>(*node)->m_value), key)) \

                 return node; \
                 return node; \

-            node = (Node**)&(*node)->m_nxt; \
+            node = &(*node)->m_next; \

         } \
  \
         } \
  \

-        return 0; \
+        return NULL; \

     } \
  \
     /* returns NULL if not found */ \
     /* expressing it in terms of GetNodePtr is 5-8% slower :-( */ \
     Node* GetNode( const const_key_type& key ) const \
     { \
     } \
  \
     /* returns NULL if not found */ \
     /* expressing it in terms of GetNodePtr is 5-8% slower :-( */ \
     Node* GetNode( const const_key_type& key ) const \
     { \

-        unsigned long hash = m_hasher( key ); \
-        Node* node = m_table[hash % m_tableBuckets]; \
+        size_t bucket = m_hasher( key ) % m_tableBuckets; \
+        Node* node = static_cast<Node*>(m_table[bucket]); \

  \
         while( node ) \
         { \
             if( m_equals( m_getKey( node->m_value ), key ) ) \
                 return node; \
  \
         while( node ) \
         { \
             if( m_equals( m_getKey( node->m_value ), key ) ) \
                 return node; \

-            node = node->m_next(); \
+            node = node->next(); \

         } \
  \
         } \
  \

-        return 0; \
+        return NULL; \

     } \
  \
     void ResizeTable( size_t newSize ) \
     { \
     } \
  \
     void ResizeTable( size_t newSize ) \
     { \

-        newSize = GetNextPrime( newSize ); \
-        Node** srcTable = m_table; \
+        newSize = GetNextPrime( (unsigned long)newSize ); \
+        _wxHashTable_NodeBase** srcTable = m_table; \

         size_t srcBuckets = m_tableBuckets; \
         size_t srcBuckets = m_tableBuckets; \

-        m_table = (Node**)AllocTable( newSize ); \
+        m_table = (_wxHashTable_NodeBase**)AllocTable( newSize ); \

         m_tableBuckets = newSize; \
  \
         m_tableBuckets = newSize; \
  \

-        CopyHashTable( (_wxHashTable_NodeBase**)srcTable, srcBuckets, \
-                       this, (_wxHashTable_NodeBase**)m_table, \
-                       (BucketFromNode)&GetBucketForNode,\
+        CopyHashTable( srcTable, srcBuckets, \
+                       this, m_table, \
+                       (BucketFromNode)GetBucketForNode,\

                        (ProcessNode)&DummyProcessNode ); \
                        (ProcessNode)&DummyProcessNode ); \

-        free(srcTable); \
+        FreeTable(srcTable); \

     } \
  \
     /* this must be called _after_ m_table has been cleaned */ \
     void HashCopy( const Self& ht ) \
     { \
         ResizeTable( ht.size() ); \
     } \
  \
     /* this must be called _after_ m_table has been cleaned */ \
     void HashCopy( const Self& ht ) \
     { \
         ResizeTable( ht.size() ); \

-        CopyHashTable( (_wxHashTable_NodeBase**)ht.m_table, ht.m_tableBuckets,\
+        CopyHashTable( ht.m_table, ht.m_tableBuckets, \

                        (_wxHashTableBase2*)this, \
                        (_wxHashTableBase2*)this, \

-                       (_wxHashTable_NodeBase**)m_table, \
-                       (BucketFromNode)&GetBucketForNode, \
-                       (ProcessNode)&CopyNode ); \
+                       m_table, \
+                       (BucketFromNode)GetBucketForNode, \
+                       (ProcessNode)CopyNode ); \

     } \
 };
 
     } \
 };
 


@@ -346,13 +427,15 @@ protected: \
 CLASSEXP CLASSNAME \
 { \
 public: \
 CLASSEXP CLASSNAME \
 { \
 public: \

+    typedef KEY_T first_type; \
+    typedef VALUE_T second_type; \

     typedef KEY_T t1; \
     typedef VALUE_T t2; \
     typedef const KEY_T const_t1; \
     typedef const VALUE_T const_t2; \
  \
     typedef KEY_T t1; \
     typedef VALUE_T t2; \
     typedef const KEY_T const_t1; \
     typedef const VALUE_T const_t2; \
  \

-    CLASSNAME( const const_t1& f, const const_t2& s ):first(t1(f)),second(t2(s)) {} \
-    CLASSNAME( const const_t1& f ):first(t1(f)),second(t2()) {} \
+    CLASSNAME(const const_t1& f, const const_t2& s) \
+        : first(const_cast<t1&>(f)), second(const_cast<t2&>(s)) {} \

  \
     t1 first; \
     t2 second; \
  \
     t1 first; \
     t2 second; \


@@ -363,9 +446,15 @@ public: \
 #define _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, PAIR_T, CLASSNAME, CLASSEXP ) \
 CLASSEXP CLASSNAME \
 { \
 #define _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, PAIR_T, CLASSNAME, CLASSEXP ) \
 CLASSEXP CLASSNAME \
 { \

+    typedef KEY_T key_type; \
+    typedef PAIR_T pair_type; \
+    typedef const key_type const_key_type; \
+    typedef const pair_type const_pair_type; \
+    typedef const_key_type& const_key_reference; \
+    typedef const_pair_type& const_pair_reference; \

 public: \
     CLASSNAME() { } \
 public: \
     CLASSNAME() { } \

-    KEY_T operator()( PAIR_T pair ) const { return pair.first; } \
+    const_key_reference operator()( const_pair_reference pair ) const { return pair.first; }\

     \
     /* the dummy assignment operator is needed to suppress compiler */ \
     /* warnings from hash table class' operator=(): gcc complains about */ \
     \
     /* the dummy assignment operator is needed to suppress compiler */ \
     /* warnings from hash table class' operator=(): gcc complains about */ \


@@ -374,13 +463,15 @@ public: \
 };
 
 // grow/shrink predicates
 };
 
 // grow/shrink predicates

-inline bool never_grow( size_t, size_t ) { return FALSE; }
-inline bool never_shrink( size_t, size_t ) { return FALSE; }
+inline bool never_grow( size_t, size_t ) { return false; }
+inline bool never_shrink( size_t, size_t ) { return false; }

 inline bool grow_lf70( size_t buckets, size_t items )
 {
 inline bool grow_lf70( size_t buckets, size_t items )
 {

-    return float(items)/float(buckets) >= 0.85;
+    return float(items)/float(buckets) >= 0.85f;

 }
 
 }
 

+#endif // various hash map implementations
+

 // ----------------------------------------------------------------------------
 // hashing and comparison functors
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // hashing and comparison functors
 // ----------------------------------------------------------------------------


@@ -389,8 +480,54 @@ inline bool grow_lf70( size_t buckets, size_t items )
 //     operators to suppress warnings about "statement with no effect" from gcc
 //     in the hash table class assignment operator (where they're assigned)
 
 //     operators to suppress warnings about "statement with no effect" from gcc
 //     in the hash table class assignment operator (where they're assigned)
 

+#ifndef wxNEEDS_WX_HASH_MAP
+

 // integer types
 // integer types

-class WXDLLEXPORT wxIntegerHash
+class WXDLLIMPEXP_BASE wxIntegerHash
+{
+    WX_HASH_MAP_NAMESPACE::hash<long> longHash;
+    WX_HASH_MAP_NAMESPACE::hash<unsigned long> ulongHash;
+    WX_HASH_MAP_NAMESPACE::hash<int> intHash;
+    WX_HASH_MAP_NAMESPACE::hash<unsigned int> uintHash;
+    WX_HASH_MAP_NAMESPACE::hash<short> shortHash;
+    WX_HASH_MAP_NAMESPACE::hash<unsigned short> ushortHash;
+
+#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+    // hash<wxLongLong_t> ought to work but doesn't on some compilers
+    #if (!defined SIZEOF_LONG_LONG && SIZEOF_LONG == 4) \
+        || (defined SIZEOF_LONG_LONG && SIZEOF_LONG_LONG == SIZEOF_LONG * 2)
+    size_t longlongHash( wxLongLong_t x ) const
+    {
+        return longHash( wx_truncate_cast(long, x) ) ^
+               longHash( wx_truncate_cast(long, x >> (sizeof(long) * 8)) );
+    }
+    #elif defined SIZEOF_LONG_LONG && SIZEOF_LONG_LONG == SIZEOF_LONG
+    WX_HASH_MAP_NAMESPACE::hash<long> longlongHash;
+    #else
+    WX_HASH_MAP_NAMESPACE::hash<wxLongLong_t> longlongHash;
+    #endif
+#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+
+public:
+    wxIntegerHash() { }
+    size_t operator()( long x ) const { return longHash( x ); }
+    size_t operator()( unsigned long x ) const { return ulongHash( x ); }
+    size_t operator()( int x ) const { return intHash( x ); }
+    size_t operator()( unsigned int x ) const { return uintHash( x ); }
+    size_t operator()( short x ) const { return shortHash( x ); }
+    size_t operator()( unsigned short x ) const { return ushortHash( x ); }
+#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+    size_t operator()( wxLongLong_t x ) const { return longlongHash(x); }
+    size_t operator()( wxULongLong_t x ) const { return longlongHash(x); }
+#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+
+    wxIntegerHash& operator=(const wxIntegerHash&) { return *this; }
+};
+
+#else // wxNEEDS_WX_HASH_MAP
+
+// integer types
+class WXDLLIMPEXP_BASE wxIntegerHash

 {
 public:
     wxIntegerHash() { }
 {
 public:
     wxIntegerHash() { }


@@ -400,11 +537,17 @@ public:
     unsigned long operator()( unsigned int x ) const { return x; }
     unsigned long operator()( short x ) const { return (unsigned long)x; }
     unsigned long operator()( unsigned short x ) const { return x; }
     unsigned long operator()( unsigned int x ) const { return x; }
     unsigned long operator()( short x ) const { return (unsigned long)x; }
     unsigned long operator()( unsigned short x ) const { return x; }

+#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+    wxULongLong_t operator()( wxLongLong_t x ) const { return static_cast<wxULongLong_t>(x); }
+    wxULongLong_t operator()( wxULongLong_t x ) const { return x; }
+#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG

 
     wxIntegerHash& operator=(const wxIntegerHash&) { return *this; }
 };
 
 
     wxIntegerHash& operator=(const wxIntegerHash&) { return *this; }
 };
 

-class WXDLLEXPORT wxIntegerEqual
+#endif // !wxNEEDS_WX_HASH_MAP/wxNEEDS_WX_HASH_MAP
+
+class WXDLLIMPEXP_BASE wxIntegerEqual

 {
 public:
     wxIntegerEqual() { }
 {
 public:
     wxIntegerEqual() { }


@@ -414,24 +557,30 @@ public:
     bool operator()( unsigned int a, unsigned int b ) const { return a == b; }
     bool operator()( short a, short b ) const { return a == b; }
     bool operator()( unsigned short a, unsigned short b ) const { return a == b; }
     bool operator()( unsigned int a, unsigned int b ) const { return a == b; }
     bool operator()( short a, short b ) const { return a == b; }
     bool operator()( unsigned short a, unsigned short b ) const { return a == b; }

+#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+    bool operator()( wxLongLong_t a, wxLongLong_t b ) const { return a == b; }
+    bool operator()( wxULongLong_t a, wxULongLong_t b ) const { return a == b; }
+#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG

 
     wxIntegerEqual& operator=(const wxIntegerEqual&) { return *this; }
 };
 
 // pointers
 
     wxIntegerEqual& operator=(const wxIntegerEqual&) { return *this; }
 };
 
 // pointers

-class WXDLLEXPORT wxPointerHash
+class WXDLLIMPEXP_BASE wxPointerHash

 {
 public:
     wxPointerHash() { }
 
 {
 public:
     wxPointerHash() { }
 

-    // TODO: this might not work well on architectures with 64 bit pointers but
-    //       32 bit longs, we should use % ULONG_MAX there
-    unsigned long operator()( const void* k ) const { return (unsigned long)k; }
+#ifdef wxNEEDS_WX_HASH_MAP
+    wxUIntPtr operator()( const void* k ) const { return wxPtrToUInt(k); }
+#else
+    size_t operator()( const void* k ) const { return (size_t)k; }
+#endif

 
     wxPointerHash& operator=(const wxPointerHash&) { return *this; }
 };
 
 
     wxPointerHash& operator=(const wxPointerHash&) { return *this; }
 };
 

-class WXDLLEXPORT wxPointerEqual
+class WXDLLIMPEXP_BASE wxPointerEqual

 {
 public:
     wxPointerEqual() { }
 {
 public:
     wxPointerEqual() { }


@@ -440,26 +589,34 @@ public:
     wxPointerEqual& operator=(const wxPointerEqual&) { return *this; }
 };
 
     wxPointerEqual& operator=(const wxPointerEqual&) { return *this; }
 };
 

-// wxString, char*, wxChar*
-class WXDLLEXPORT wxStringHash
+// wxString, char*, wchar_t*
+class WXDLLIMPEXP_BASE wxStringHash

 {
 public:
     wxStringHash() {}
     unsigned long operator()( const wxString& x ) const
 {
 public:
     wxStringHash() {}
     unsigned long operator()( const wxString& x ) const

-        { return wxCharStringHash( x.c_str() ); }
-    unsigned long operator()( const wxChar* x ) const
-        { return wxCharStringHash( x ); }
-    static unsigned long wxCharStringHash( const wxChar* );
-#if wxUSE_UNICODE
+        { return stringHash( x.wx_str() ); }
+    unsigned long operator()( const wchar_t* x ) const
+        { return stringHash( x ); }

     unsigned long operator()( const char* x ) const
     unsigned long operator()( const char* x ) const

-        { return charStringHash( x ); }
-    static unsigned long charStringHash( const char* );
-#endif // wxUSE_UNICODE
+        { return stringHash( x ); }
+
+#if WXWIN_COMPATIBILITY_2_8
+    static unsigned long wxCharStringHash( const wxChar* x )
+        { return stringHash(x); }
+    #if wxUSE_UNICODE
+    static unsigned long charStringHash( const char* x )
+        { return stringHash(x); }
+    #endif
+#endif // WXWIN_COMPATIBILITY_2_8
+
+    static unsigned long stringHash( const wchar_t* );
+    static unsigned long stringHash( const char* );

 
     wxStringHash& operator=(const wxStringHash&) { return *this; }
 };
 
 
     wxStringHash& operator=(const wxStringHash&) { return *this; }
 };
 

-class WXDLLEXPORT wxStringEqual
+class WXDLLIMPEXP_BASE wxStringEqual

 {
 public:
     wxStringEqual() {}
 {
 public:
     wxStringEqual() {}


@@ -475,21 +632,35 @@ public:
     wxStringEqual& operator=(const wxStringEqual&) { return *this; }
 };
 
     wxStringEqual& operator=(const wxStringEqual&) { return *this; }
 };
 

+#ifdef wxNEEDS_WX_HASH_MAP
+
+#define wxPTROP_NORMAL(pointer) \
+    pointer operator ->() const { return &(m_node->m_value); }
+#define wxPTROP_NOP(pointer)
+

 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
 _WX_DECLARE_PAIR( KEY_T, VALUE_T, CLASSNAME##_wxImplementation_Pair, CLASSEXP ) \
 _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_Pair, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
 _WX_DECLARE_PAIR( KEY_T, VALUE_T, CLASSNAME##_wxImplementation_Pair, CLASSEXP ) \
 _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_Pair, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \

-_WX_DECLARE_HASHTABLE( CLASSNAME##_wxImplementation_Pair, KEY_T, HASH_T, CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \
+_WX_DECLARE_HASHTABLE( CLASSNAME##_wxImplementation_Pair, KEY_T, HASH_T, \
+    CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, wxPTROP_NORMAL, \
+    CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \

 CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
 { \
 public: \
     typedef VALUE_T mapped_type; \
 CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
 { \
 public: \
     typedef VALUE_T mapped_type; \

+    _WX_DECLARE_PAIR( iterator, bool, Insert_Result, CLASSEXP ) \

  \
  \

-    CLASSNAME( size_type hint = 100, hasher hf = hasher(), key_equal eq = key_equal() ) \
-        : CLASSNAME##_wxImplementation_HashTable( hint, hf, eq, CLASSNAME##_wxImplementation_KeyEx() ) {} \
+    wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(),        \
+                          key_equal eq = key_equal() )                       \
+        : CLASSNAME##_wxImplementation_HashTable( hint, hf, eq,              \
+                                   CLASSNAME##_wxImplementation_KeyEx() ) {} \

  \
     mapped_type& operator[]( const const_key_type& key ) \
     { \
  \
     mapped_type& operator[]( const const_key_type& key ) \
     { \

-        return GetOrCreateNode( CLASSNAME##_wxImplementation_Pair( key ) )->m_value.second; \
+        bool created; \
+        return GetOrCreateNode( \
+                CLASSNAME##_wxImplementation_Pair( key, mapped_type() ), \
+                created)->m_value.second; \

     } \
  \
     const_iterator find( const const_key_type& key ) const \
     } \
  \
     const_iterator find( const const_key_type& key ) const \


@@ -502,17 +673,27 @@ public: \
         return iterator( GetNode( key ), this ); \
     } \
  \
         return iterator( GetNode( key ), this ); \
     } \
  \

-    void insert( const value_type& v ) { (*this)[v.first] = v.second; } \
+    Insert_Result insert( const value_type& v ) \
+    { \
+        bool created; \
+        Node *node = GetOrCreateNode( \
+                CLASSNAME##_wxImplementation_Pair( v.first, v.second ), \
+                created); \
+        return Insert_Result(iterator(node, this), created); \
+    } \

  \
     size_type erase( const key_type& k ) \
         { return CLASSNAME##_wxImplementation_HashTable::erase( k ); } \
  \
     size_type erase( const key_type& k ) \
         { return CLASSNAME##_wxImplementation_HashTable::erase( k ); } \

-    void erase( const iterator& it ) { erase( it->first ); } \
-    void erase( const const_iterator& it ) { erase( it->first ); } \
+    void erase( const iterator& it ) { erase( (*it).first ); } \

  \
     /* count() == 0 | 1 */ \
     size_type count( const const_key_type& key ) \
  \
     /* count() == 0 | 1 */ \
     size_type count( const const_key_type& key ) \

-        { return GetNode( key ) ? 1 : 0; } \
-};
+    { \
+        return GetNode( key ) ? 1u : 0u; \
+    } \
+}
+
+#endif // wxNEEDS_WX_HASH_MAP

 
 // these macros are to be used in the user code
 #define WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \
 
 // these macros are to be used in the user code
 #define WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \


@@ -520,24 +701,62 @@ public: \
 
 #define WX_DECLARE_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
     _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \
 
 #define WX_DECLARE_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
     _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \

-                          CLASSNAME, class );
+                          CLASSNAME, class )

 
 #define WX_DECLARE_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
     _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \
 
 #define WX_DECLARE_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
     _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \

-                          CLASSNAME, class );
+                          CLASSNAME, class )

 
 // and these do exactly the same thing but should be used inside the
 // library
 
 // and these do exactly the same thing but should be used inside the
 // library

+#define WX_DECLARE_HASH_MAP_WITH_DECL( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL) \
+    _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL )
+

 #define WX_DECLARE_EXPORTED_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \
 #define WX_DECLARE_EXPORTED_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME) \

-    _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, class WXDLLEXPORT )
+    WX_DECLARE_HASH_MAP_WITH_DECL( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, \
+                                   CLASSNAME, class WXDLLIMPEXP_CORE )

 
 

-#define WX_DECLARE_EXPORTED_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
+#define WX_DECLARE_STRING_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, DECL ) \

     _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \
     _WX_DECLARE_HASH_MAP( wxString, VALUE_T, wxStringHash, wxStringEqual, \

-                          CLASSNAME, class WXDLLEXPORT );
+                          CLASSNAME, DECL )

 
 

-#define WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
+#define WX_DECLARE_EXPORTED_STRING_HASH_MAP( VALUE_T, CLASSNAME ) \
+    WX_DECLARE_STRING_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, \
+                                          class WXDLLIMPEXP_CORE )
+
+#define WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, DECL ) \

     _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \
     _WX_DECLARE_HASH_MAP( void*, VALUE_T, wxPointerHash, wxPointerEqual, \

-                          CLASSNAME, class WXDLLEXPORT );
+                          CLASSNAME, DECL )

 
 

-#endif // _WX_HASHMAP_H_
+#define WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP( VALUE_T, CLASSNAME ) \
+    WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL( VALUE_T, CLASSNAME, \
+                                           class WXDLLIMPEXP_CORE )
+
+// delete all hash elements
+//
+// NB: the class declaration of the hash elements must be visible from the
+//     place where you use this macro, otherwise the proper destructor may not
+//     be called (a decent compiler should give a warning about it, but don't
+//     count on it)!
+#define WX_CLEAR_HASH_MAP(type, hashmap)                                     \
+    {                                                                        \
+        type::iterator it, en;                                               \
+        for( it = (hashmap).begin(), en = (hashmap).end(); it != en; ++it )  \
+            delete it->second;                                               \
+        (hashmap).clear();                                                   \
+    }
+
+//---------------------------------------------------------------------------
+// Declarations of common hashmap classes

 
 

+WX_DECLARE_HASH_MAP_WITH_DECL( long, long, wxIntegerHash, wxIntegerEqual,
+                               wxLongToLongHashMap, class WXDLLIMPEXP_BASE );
+
+WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxString, wxStringToStringHashMap,
+                                      class WXDLLIMPEXP_BASE );
+
+WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxUIntPtr, wxStringToNumHashMap,
+                                      class WXDLLIMPEXP_BASE );
+
+
+#endif // _WX_HASHMAP_H_