[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"

#if 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 WXDLLEXPORT )

// 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
bdcade0a MB	17	#if wxUSE_STL && defined(HAVE_STL_HASH_MAP)
	18
	19	#if defined(HAVE_EXT_HASH_MAP)
	20	#include <ext/hash_set>
	21	#elif defined(HAVE_HASH_MAP)
	22	#include <hash_set>
	23	#endif
	24
	25	#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
e786a78b	26	typedef WX_HASH_MAP_NAMESPACE::hash_set< KEY_T, HASH_T, KEY_EQ_T > CLASSNAME
bdcade0a MB	27
	28	#else // !wxUSE_STL \|\| !defined(HAVE_STL_HASH_MAP)
	29
8142d704 MB	30	// this is a complex way of defining an easily inlineable identity function...
	31	#define _WX_DECLARE_HASH_SET_KEY_EX( KEY_T, CLASSNAME, CLASSEXP ) \
	32	CLASSEXP CLASSNAME \
	33	{ \
	34	typedef KEY_T key_type; \
	35	typedef const key_type const_key_type; \
	36	typedef const_key_type& const_key_reference; \
	37	public: \
	38	CLASSNAME() { } \
	39	const_key_reference operator()( const_key_reference key ) const \
	40	{ return key; } \
	41	\
	42	/* the dummy assignment operator is needed to suppress compiler */ \
	43	/* warnings from hash table class' operator=(): gcc complains about */ \
	44	/* "statement with no effect" without it */ \
	45	CLASSNAME& operator=(const CLASSNAME&) { return *this; } \
	46	};
	47
	48	#define _WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP )\
	49	_WX_DECLARE_HASH_SET_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
	50	_WX_DECLARE_HASHTABLE( KEY_T, KEY_T, HASH_T, CLASSNAME##_wxImplementation_KeyEx, KEY_EQ_T, CLASSNAME##_wxImplementation_HashTable, CLASSEXP, grow_lf70, never_shrink ) \
	51	CLASSEXP CLASSNAME:public CLASSNAME##_wxImplementation_HashTable \
	52	{ \
	53	public: \
d7ab66a1 MB	54	_WX_DECLARE_PAIR( iterator, bool, Insert_Result, CLASSEXP ) \
d7ab66a1 MB	55	\
d8771ac7 MB	56	wxEXPLICIT CLASSNAME( size_type hint = 100, hasher hf = hasher(), \
d8771ac7 MB	57	key_equal eq = key_equal() ) \
8142d704 MB	58	: CLASSNAME##_wxImplementation_HashTable( hint, hf, eq, \
	59	CLASSNAME##_wxImplementation_KeyEx() ) {} \
	60	\
d7ab66a1	61	Insert_Result insert( const key_type& key ) \
8142d704	62	{ \
d7ab66a1 MB	63	bool created; \
	64	Node *node = GetOrCreateNode( key, created ); \
	65	return Insert_Result( iterator( node, this ), created ); \
8142d704 MB	66	} \
	67	\
	68	const_iterator find( const const_key_type& key ) const \
	69	{ \
	70	return const_iterator( GetNode( key ), this ); \
	71	} \
	72	\
	73	iterator find( const const_key_type& key ) \
	74	{ \
	75	return iterator( GetNode( key ), this ); \
	76	} \
	77	\
	78	size_type erase( const key_type& k ) \
	79	{ return CLASSNAME##_wxImplementation_HashTable::erase( k ); } \
	80	void erase( const iterator& it ) { erase( *it ); } \
	81	void erase( const const_iterator& it ) { erase( *it ); } \
	82	\
	83	/* count() == 0 \| 1 */ \
	84	size_type count( const const_key_type& key ) \
	85	{ return GetNode( key ) ? 1 : 0; } \
3f5c62f9	86	}
8142d704	87
bdcade0a MB	88	#endif // !wxUSE_STL \|\| !defined(HAVE_STL_HASH_MAP)
bdcade0a MB	89
8142d704 MB	90	// these macros are to be used in the user code
	91	#define WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME) \
	92	_WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, class )
	93
	94	// and these do exactly the same thing but should be used inside the
	95	// library
	96	#define WX_DECLARE_HASH_SET_WITH_DECL( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL) \
	97	_WX_DECLARE_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME, DECL )
	98
	99	#define WX_DECLARE_EXPORTED_HASH_SET( KEY_T, HASH_T, KEY_EQ_T, CLASSNAME) \
	100	WX_DECLARE_HASH_SET_WITH_DECL( KEY_T, HASH_T, KEY_EQ_T, \
	101	CLASSNAME, class WXDLLEXPORT )
	102
	103	// delete all hash elements
	104	//
	105	// NB: the class declaration of the hash elements must be visible from the
	106	// place where you use this macro, otherwise the proper destructor may not
	107	// be called (a decent compiler should give a warning about it, but don't
	108	// count on it)!
	109	#define WX_CLEAR_HASH_SET(type, hashset) \
3115bfa8 VS	110	{ \
	111	type::iterator it, en; \
	112	for( it = (hashset).begin(), en = (hashset).end(); it != en; ++it ) \
	113	delete *it; \
	114	(hashset).clear(); \
	115	}
8142d704 MB	116
8142d704 MB	117	#endif // _WX_HASHSET_H_