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

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/hashset.h
// Purpose:     wxHashSet class
// Author:      Mattia Barbon
// Modified by:
// Created:     11/08/2003
// RCS-ID:      $Id$
// Copyright:   (c) Mattia Barbon
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_HASHSET_H_
#define _WX_HASHSET_H_

#include "wx/hashmap.h"

// see comment in wx/hashmap.h which also applies to different standard hash
// set classes

#if wxUSE_STL && \
    (defined(HAVE_STD_UNORDERED_SET) || defined(HAVE_TR1_UNORDERED_SET))

#if defined(HAVE_STD_UNORDERED_SET)
    #include <unordered_set>
    #define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
        typedef std::unordered_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME
#elif defined(HAVE_TR1_UNORDERED_SET)
    #include <tr1/unordered_set>
    #define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
        typedef std::tr1::unordered_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME
#else
#error Update this code: unordered_set is available, but I do not know where.
#endif

#elif wxUSE_STL && defined(HAVE_STL_HASH_MAP)

#if defined(HAVE_EXT_HASH_MAP)
    #include <ext/hash_set>
#elif defined(HAVE_HASH_MAP)
    #include <hash_set>
#endif

#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
    typedef WX_HASH_MAP_NAMESPACE::hash_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME

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

// this is a complex way of defining an easily inlineable identity function...
#define _WX_DECLARE_HASH_SET_KEY_EX( KEY_T, CLASSNAME, CLASSEXP )            \
CLASSEXP CLASSNAME                                                           \
{                                                                            \
    typedef KEY_T key_type;                                                  \
    typedef const key_type const_key_type;                                   \
    typedef const_key_type& const_key_reference;                             \
public:                                                                      \
    CLASSNAME() { }                                                          \
    const_key_reference operator()( const_key_reference key ) const          \
        { return key; }                                                      \
                                                                             \
    /* the dummy assignment operator is needed to suppress compiler */       \
    /* warnings from hash table class' operator=(): gcc complains about */   \
    /* "statement with no effect" without it */                              \
    CLASSNAME& operator=(const CLASSNAME&) { return *this; }                 \
};

#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
_WX_DECLARE_HASH_SET_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
_WX_DECLARE_HASHTABLE( KEY_T, KEY_T, HASH_T, CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \
CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable             \
{                                                                            \
public:                                                                      \
    _WX_DECLARE_PAIR( iterator, bool, Insert_Result, CLASSEXP )              \
                                                                             \
    wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(),        \
                          key_equal eq = key_equal() )                       \
        : CLASSNAME##_wxImplementation_HashTable( hint, hf, eq,              \
                      CLASSNAME##_wxImplementation_KeyEx() ) {}              \
                                                                             \
    Insert_Result insert( const key_type& key )                              \
    {                                                                        \
        bool created;                                                        \
        Node *node = GetOrCreateNode( key, created );                        \
        return Insert_Result( iterator( node, this ), created );             \
    }                                                                        \
                                                                             \
    const_iterator find( const const_key_type& key ) const                   \
    {                                                                        \
        return const_iterator( GetNode( key ), this );                       \
    }                                                                        \
                                                                             \
    iterator find( const const_key_type& key )                               \
    {                                                                        \
        return iterator( GetNode( key ), this );                             \
    }                                                                        \
                                                                             \
    size_type erase( const key_type& k )                                     \
        { return CLASSNAME##_wxImplementation_HashTable::erase( k ); }       \
    void erase( const iterator& it ) { erase( *it ); }                       \
    void erase( const const_iterator& it ) { erase( *it ); }                 \
                                                                             \
    /* count() == 0 | 1 */                                                   \
    size_type count( const const_key_type& key )                             \
        { return GetNode( key ) ? 1 : 0; }                                   \
}

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

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

// and these do exactly the same thing but should be used inside the
// library
#define WX_DECLARE_HASH_SET_WITH_DECL( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL) \
    _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL )

#define WX_DECLARE_EXPORTED_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME) \
    WX_DECLARE_HASH_SET_WITH_DECL( KEY_T, HASH_T, KEY_EQ_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_SET(type, hashset)                                     \
    {                                                                        \
        type::iterator it, en;                                               \
        for( it = (hashset).begin(), en = (hashset).end(); it != en; ++it )  \
            delete *it;                                                      \
        (hashset).clear();                                                   \
    }

#endif // _WX_HASHSET_H_
Commit	Line	Data
8142d704 MB	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/hashset.h
	3	// Purpose: wxHashSet class
	4	// Author: Mattia Barbon
	5	// Modified by:
	6	// Created: 11/08/2003
	7	// RCS-ID: $Id$
	8	// Copyright: (c) Mattia Barbon
65571936	9	// Licence: wxWindows licence
8142d704 MB	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_HASHSET_H_
	13	#define _WX_HASHSET_H_
	14
	15	#include "wx/hashmap.h"
	16
f380544a VZ	17	// see comment in wx/hashmap.h which also applies to different standard hash
	18	// set classes
	19
	20	#if wxUSE_STL && \
	21	(defined(HAVE_STD_UNORDERED_SET) \|\| defined(HAVE_TR1_UNORDERED_SET))
	22
	23	#if defined(HAVE_STD_UNORDERED_SET)
	24	#include <unordered_set>
	25	#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
	26	typedef std::unordered_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME
	27	#elif defined(HAVE_TR1_UNORDERED_SET)
	28	#include <tr1/unordered_set>
	29	#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
	30	typedef std::tr1::unordered_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME
	31	#else
	32	#error Update this code: unordered_set is available, but I do not know where.
	33	#endif
	34
	35	#elif wxUSE_STL && defined(HAVE_STL_HASH_MAP)
bdcade0a MB	36
	37	#if defined(HAVE_EXT_HASH_MAP)
	38	#include <ext/hash_set>
	39	#elif defined(HAVE_HASH_MAP)
	40	#include <hash_set>
	41	#endif
	42
	43	#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
e786a78b	44	typedef WX_HASH_MAP_NAMESPACE::hash_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME
bdcade0a MB	45
	46	#else // !wxUSE_STL \|\| !defined(HAVE_STL_HASH_MAP)
	47
8142d704 MB	48	// this is a complex way of defining an easily inlineable identity function...
	49	#define _WX_DECLARE_HASH_SET_KEY_EX( KEY_T, CLASSNAME, CLASSEXP ) \
	50	CLASSEXP CLASSNAME \
	51	{ \
	52	typedef KEY_T key_type; \
	53	typedef const key_type const_key_type; \
	54	typedef const_key_type& const_key_reference; \
	55	public: \
	56	CLASSNAME() { } \
	57	const_key_reference operator()( const_key_reference key ) const \
	58	{ return key; } \
	59	\
	60	/* the dummy assignment operator is needed to suppress compiler */ \
	61	/* warnings from hash table class' operator=(): gcc complains about */ \
	62	/* "statement with no effect" without it */ \
	63	CLASSNAME& operator=(const CLASSNAME&) { return *this; } \
	64	};
	65
	66	#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
	67	_WX_DECLARE_HASH_SET_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
	68	_WX_DECLARE_HASHTABLE( KEY_T, KEY_T, HASH_T, CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \
	69	CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
	70	{ \
	71	public: \
d7ab66a1 MB	72	_WX_DECLARE_PAIR( iterator, bool, Insert_Result, CLASSEXP ) \
d7ab66a1 MB	73	\
d8771ac7 MB	74	wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(), \
d8771ac7 MB	75	key_equal eq = key_equal() ) \
8142d704 MB	76	: CLASSNAME##_wxImplementation_HashTable( hint, hf, eq, \
	77	CLASSNAME##_wxImplementation_KeyEx() ) {} \
	78	\
d7ab66a1	79	Insert_Result insert( const key_type& key ) \
8142d704	80	{ \
d7ab66a1 MB	81	bool created; \
	82	Node *node = GetOrCreateNode( key, created ); \
	83	return Insert_Result( iterator( node, this ), created ); \
8142d704 MB	84	} \
	85	\
	86	const_iterator find( const const_key_type& key ) const \
	87	{ \
	88	return const_iterator( GetNode( key ), this ); \
	89	} \
	90	\
	91	iterator find( const const_key_type& key ) \
	92	{ \
	93	return iterator( GetNode( key ), this ); \
	94	} \
	95	\
	96	size_type erase( const key_type& k ) \
	97	{ return CLASSNAME##_wxImplementation_HashTable::erase( k ); } \
	98	void erase( const iterator& it ) { erase( *it ); } \
	99	void erase( const const_iterator& it ) { erase( *it ); } \
	100	\
	101	/* count() == 0 \| 1 */ \
	102	size_type count( const const_key_type& key ) \
	103	{ return GetNode( key ) ? 1 : 0; } \
3f5c62f9	104	}
8142d704	105
bdcade0a MB	106	#endif // !wxUSE_STL \|\| !defined(HAVE_STL_HASH_MAP)
bdcade0a MB	107
8142d704 MB	108	// these macros are to be used in the user code
	109	#define WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME) \
	110	_WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, class )
	111
	112	// and these do exactly the same thing but should be used inside the
	113	// library
	114	#define WX_DECLARE_HASH_SET_WITH_DECL( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL) \
	115	_WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL )
	116
	117	#define WX_DECLARE_EXPORTED_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME) \
	118	WX_DECLARE_HASH_SET_WITH_DECL( KEY_T, HASH_T, KEY_EQ_T, \
53a2db12	119	CLASSNAME, class WXDLLIMPEXP_CORE )
8142d704 MB	120
	121	// delete all hash elements
	122	//
	123	// NB: the class declaration of the hash elements must be visible from the
	124	// place where you use this macro, otherwise the proper destructor may not
	125	// be called (a decent compiler should give a warning about it, but don't
	126	// count on it)!
	127	#define WX_CLEAR_HASH_SET(type, hashset) \
3115bfa8 VS	128	{ \
	129	type::iterator it, en; \
	130	for( it = (hashset).begin(), en = (hashset).end(); it != en; ++it ) \
	131	delete *it; \
	132	(hashset).clear(); \
	133	}
8142d704 MB	134
8142d704 MB	135	#endif // _WX_HASHSET_H_