Make SaveFile and LoadFile virtual so they can be overridden

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

diff --git a/include/wx/hashmap.h b/include/wx/hashmap.h
index ee6c1420325936b813d9c7000a717bde0a164568..47d583b840b84de620cb42ef911f38d0dee8c393 100644 (file)
--- a/include/wx/hashmap.h
+++ b/include/wx/hashmap.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

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


@@ -12,11 +12,8 @@
 #ifndef _WX_HASHMAP_H_
 #define _WX_HASHMAP_H_
 
 #ifndef _WX_HASHMAP_H_
 #define _WX_HASHMAP_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "hashmap.h"
-#endif
-

 #include "wx/string.h"
 #include "wx/string.h"

+#include "wx/wxcrt.h"

 
 #if (defined(HAVE_EXT_HASH_MAP) || defined(HAVE_HASH_MAP)) \
     && (defined(HAVE_GNU_CXX_HASH_MAP) || defined(HAVE_STD_HASH_MAP))
 
 #if (defined(HAVE_EXT_HASH_MAP) || defined(HAVE_HASH_MAP)) \
     && (defined(HAVE_GNU_CXX_HASH_MAP) || defined(HAVE_STD_HASH_MAP))


@@ -38,14 +35,15 @@
 #endif
 
 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
 #endif
 
 #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;
+    typedef WX_HASH_MAP_NAMESPACE::hash_map< KEY_T, VALUE_T, HASH_T, KEY_EQ_T > CLASSNAME

 
 #else // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 
 
 #else // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 

-#include <stddef.h>             // for ptrdiff_t

 
 #ifdef __WXWINCE__
 typedef int ptrdiff_t;
 
 #ifdef __WXWINCE__
 typedef int ptrdiff_t;

+#else
+#include <stddef.h>             // for ptrdiff_t

 #endif
 
 // private
 #endif
 
 // private


@@ -100,6 +98,10 @@ protected:
     {
         return (void **)calloc(sz, sizeof(void*));
     }
     {
         return (void **)calloc(sz, sizeof(void*));
     }

+    static void FreeTable(void *table)
+    {
+        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, CLASSNAME, CLASSEXP, SHOULD_GROW, SHOULD_SHRINK ) \


@@ -142,8 +144,6 @@ public: \
         value_type m_value; \
     }; \
  \
         value_type m_value; \
     }; \
  \

-    struct Iterator; \
-    friend struct Iterator; \

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


@@ -153,8 +153,9 @@ public: \
     /*                  */ \
     /* forward iterator */ \
     /*                  */ \
     /*                  */ \
     /* forward iterator */ \
     /*                  */ \

-    struct Iterator \
+    CLASSEXP Iterator \

     { \
     { \

+    public: \

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


@@ -183,10 +184,12 @@ public: \
             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() : Iterator() {} \
         iterator( Node* node, Self* ht ) : Iterator( node, ht ) {} \
         iterator& operator++() { PlusPlus(); return *this; } \


@@ -195,9 +198,11 @@ public: \
         pointer operator ->() const { return &(m_node->m_value); } \
     }; \
  \
         pointer operator ->() const { return &(m_node->m_value); } \
     }; \
  \

-    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 ) \
             : Iterator( node, (Self*)ht ) {} \
         const_iterator& operator++() { PlusPlus();return *this; } \
         const_iterator( Node* node, const Self* ht ) \
             : Iterator( node, (Self*)ht ) {} \
         const_iterator& operator++() { PlusPlus();return *this; } \


@@ -244,7 +249,7 @@ public: \
     { \
         clear(); \
  \
     { \
         clear(); \
  \

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

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


@@ -266,9 +271,9 @@ public: \
     const_iterator end() const { return const_iterator( 0, this ); } \
     iterator end() { return iterator( 0, this ); } \
     const_iterator begin() const \
     const_iterator end() const { return const_iterator( 0, this ); } \
     iterator end() { return iterator( 0, this ); } \
     const_iterator begin() const \

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

     iterator begin() \
     iterator begin() \

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

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


@@ -294,7 +299,7 @@ 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; \


@@ -303,10 +308,14 @@ protected: \
         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->m_next(); \
         } \

-       return CreateNode( value  , bucket); \
+        created = true; \
+        return CreateNode( value, bucket); \

     }\
     Node * CreateNode( const value_type& value, size_t bucket ) \
     {\
     }\
     Node * CreateNode( const value_type& value, size_t bucket ) \
     {\


@@ -329,25 +338,26 @@ protected: \
     /* returns NULL if not found */ \
     Node** GetNodePtr( const const_key_type& key ) const \
     { \
     /* returns NULL if not found */ \
     Node** 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; \
+        Node** 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; \

+            /* Tell the compiler to not do any strict-aliasing assumptions with a void cast? Can we make such a runtime guarantee? */ \

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

-        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 = m_table[bucket]; \

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


@@ -371,7 +381,7 @@ protected: \
                        this, (_wxHashTable_NodeBase**)m_table, \
                        (BucketFromNode)GetBucketForNode,\
                        (ProcessNode)&DummyProcessNode ); \
                        this, (_wxHashTable_NodeBase**)m_table, \
                        (BucketFromNode)GetBucketForNode,\
                        (ProcessNode)&DummyProcessNode ); \

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

     } \
  \
     /* this must be called _after_ m_table has been cleaned */ \
     } \
  \
     /* this must be called _after_ m_table has been cleaned */ \


@@ -425,8 +435,8 @@ 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 )
 {
     return float(items)/float(buckets) >= 0.85;
 inline bool grow_lf70( size_t buckets, size_t items )
 {
     return float(items)/float(buckets) >= 0.85;


@@ -453,6 +463,23 @@ class WXDLLIMPEXP_BASE wxIntegerHash
     WX_HASH_MAP_NAMESPACE::hash<unsigned int> uintHash;
     WX_HASH_MAP_NAMESPACE::hash<short> shortHash;
     WX_HASH_MAP_NAMESPACE::hash<unsigned short> ushortHash;
     WX_HASH_MAP_NAMESPACE::hash<unsigned int> uintHash;
     WX_HASH_MAP_NAMESPACE::hash<short> shortHash;
     WX_HASH_MAP_NAMESPACE::hash<unsigned short> ushortHash;

+
+#if defined wxLongLong_t && !defined wxLongLongIsLong
+    // 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
+

 public:
     wxIntegerHash() { }
     size_t operator()( long x ) const { return longHash( x ); }
 public:
     wxIntegerHash() { }
     size_t operator()( long x ) const { return longHash( x ); }


@@ -461,6 +488,10 @@ public:
     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 ); }
     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 ); }

+#if defined wxLongLong_t && !defined wxLongLongIsLong
+    size_t operator()( wxLongLong_t x ) const { return longlongHash(x); }
+    size_t operator()( wxULongLong_t x ) const { return longlongHash(x); }
+#endif

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


@@ -478,6 +509,10 @@ 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; }

+#if defined wxLongLong_t && !defined wxLongLongIsLong
+    wxULongLong_t operator()( wxLongLong_t x ) const { return wx_static_cast(wxULongLong_t, x); }
+    wxULongLong_t operator()( wxULongLong_t x ) const { return x; }
+#endif

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


@@ -494,6 +529,10 @@ 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; }

+#if defined wxLongLong_t && !defined wxLongLongIsLong
+    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

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


@@ -504,12 +543,10 @@ 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

 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
     size_t operator()( const void* k ) const { return (size_t)k; }
 #else
 #if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
     size_t operator()( const void* k ) const { return (size_t)k; }
 #else

-    unsigned long operator()( const void* k ) const { return (unsigned long)wxPtrToULong(k); }
+    wxUIntPtr operator()( const void* k ) const { return wxPtrToUInt(k); }

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


@@ -524,21 +561,29 @@ public:
     wxPointerEqual& operator=(const wxPointerEqual&) { return *this; }
 };
 
     wxPointerEqual& operator=(const wxPointerEqual&) { return *this; }
 };
 

-// wxString, char*, wxChar*
+// wxString, char*, wchar_t*

 class WXDLLIMPEXP_BASE wxStringHash
 {
 public:
     wxStringHash() {}
     unsigned long operator()( const wxString& x ) const
 class WXDLLIMPEXP_BASE wxStringHash
 {
 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; }
 };


@@ -569,6 +614,7 @@ CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
 { \
 public: \
     typedef VALUE_T mapped_type; \
 { \
 public: \
     typedef VALUE_T mapped_type; \

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

  \
     wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(),        \
                           key_equal eq = key_equal() )                       \
  \
     wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(),        \
                           key_equal eq = key_equal() )                       \


@@ -577,7 +623,10 @@ public: \
  \
     mapped_type& operator[]( const const_key_type& key ) \
     { \
  \
     mapped_type& operator[]( const const_key_type& key ) \
     { \

-        return GetOrCreateNode( CLASSNAME##_wxImplementation_Pair( key, mapped_type() ) )->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 \


@@ -590,7 +639,16 @@ 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); \
+        if ( !created ) \
+            node->m_value.second = v.second; \
+        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 ); } \


@@ -599,7 +657,10 @@ public: \
  \
     /* 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; } \
+    { \
+        /* explicit cast needed to suppress CodeWarrior warnings */ \
+        return (size_type)(GetNode( key ) ? 1 : 0); \
+    } \

 }
 
 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)
 }
 
 #endif // !wxUSE_STL || !defined(HAVE_STL_HASH_MAP)


@@ -663,4 +724,3 @@ WX_DECLARE_HASH_MAP_WITH_DECL( long, long, wxIntegerHash, wxIntegerEqual,
 
 
 #endif // _WX_HASHMAP_H_
 
 
 #endif // _WX_HASHMAP_H_

-