some wxArtProv docs

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

diff --git a/include/wx/hash.h b/include/wx/hash.h
index 650ffe1eeee40916abe2049056518a3c2ec69ede..5868ef8dff56f2db8ac4d9e25f0daab0bf2c0d24 100644 (file)
--- a/include/wx/hash.h
+++ b/include/wx/hash.h
@@ -17,6 +17,7 @@
 #endif
 
 #include "wx/list.h"
+#include "wx/dynarray.h"
 
 // the default size of the hash
 #define wxHASH_SIZE_DEFAULT     (1000)
@@ -68,7 +69,74 @@ protected:
 
 private:
     // no copy ctor/assignment operator (yet)
-    DECLARE_NO_COPY_CLASS(wxHashTableBase);
+    DECLARE_NO_COPY_CLASS(wxHashTableBase)
+};
+
+// ----------------------------------------------------------------------------
+// a hash table which stores longs
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxHashTableLong : public wxObject
+{
+public:
+    wxHashTableLong(size_t size = wxHASH_SIZE_DEFAULT) { Init(size); }
+    virtual ~wxHashTableLong();
+
+    void Create(size_t size = wxHASH_SIZE_DEFAULT);
+    void Destroy();
+
+    size_t GetSize() const { return m_hashSize; }
+    size_t GetCount() const { return m_count; }
+
+    void Put(long key, long value);
+    long Get(long key) const;
+    long Delete(long key);
+
+protected:
+    void Init(size_t size);
+
+private:
+    wxArrayLong **m_values,
+                **m_keys;
+
+    // the size of array above
+    size_t m_hashSize;
+
+    // the total number of elements in the hash
+    size_t m_count;
+
+    // not implemented yet
+    DECLARE_NO_COPY_CLASS(wxHashTableLong)
+};
+
+// ----------------------------------------------------------------------------
+// wxStringHashTable: a hash table which indexes strings with longs
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxStringHashTable : public wxObject
+{
+public:
+    wxStringHashTable(size_t sizeTable = wxHASH_SIZE_DEFAULT);
+    virtual ~wxStringHashTable();
+
+    // add a string associated with this key to the table
+    void Put(long key, const wxString& value);
+
+    // get the string from the key: if not found, an empty string is returned
+    // and the wasFound is set to FALSE if not NULL
+    wxString Get(long key, bool *wasFound = NULL) const;
+
+    // clean up
+    void Destroy();
+
+private:
+    wxArrayLong **m_keys;
+    wxArrayString **m_values;
+
+    // the size of array above
+    size_t m_hashSize;
+
+    DECLARE_NO_COPY_CLASS(wxStringHashTable)
 };
 
 // ----------------------------------------------------------------------------
@@ -90,7 +158,7 @@ public:
     ~wxHashTable();
 
     // copy ctor and assignment operator
-    wxHashTable(const wxHashTable& table) { DoCopy(table); }
+    wxHashTable(const wxHashTable& table) : wxObject() { DoCopy(table); }
     wxHashTable& operator=(const wxHashTable& table)
         { Clear(); DoCopy(table); return *this; }
 
@@ -162,8 +230,8 @@ private:
 
 // defines a new type safe hash table which stores the elements of type eltype
 // in lists of class listclass
-#define WX_DECLARE_HASH(eltype, listclass, hashclass)                          \
-    class WXDLLEXPORT hashclass : public wxHashTableBase                       \
+#define _WX_DECLARE_HASH(eltype, listclass, hashclass, classexp)               \
+    classexp hashclass : public wxHashTableBase                                \
     {                                                                          \
     public:                                                                    \
         hashclass(wxKeyType keyType = wxKEY_INTEGER,                           \
@@ -206,7 +274,7 @@ private:
     protected:                                                                 \
         void DoPut(long key, long value, eltype *data)                         \
         {                                                                      \
-            size_t slot = (size_t)abs(key % m_hashSize);                       \
+            size_t slot = (size_t)abs((int)(key % (long)m_hashSize));          \
                                                                                \
             if ( !m_hashTable[slot] )                                          \
             {                                                                  \
@@ -220,5 +288,17 @@ private:
         }                                                                      \
     }
 
+// this macro is to be used in the user code
+#define WX_DECLARE_HASH(el, list, hash) \
+    _WX_DECLARE_HASH(el, list, hash, class)
+
+// and this one does exactly the same thing but should be used inside the
+// library
+#define WX_DECLARE_EXPORTED_HASH(el, list, hash)  \
+    _WX_DECLARE_HASH(el, list, hash, class WXDLLEXPORT)
+
+#define WX_DECLARE_USER_EXPORTED_HASH(el, list, hash, usergoo)  \
+    _WX_DECLARE_HASH(el, list, hash, class usergoo)
+
 #endif
     // _WX_HASH_H__