A fast pointer hash table implementation. More...

#include <KviPointerHashTable.h>

Public Member Functions
void	clear ()
	Removes all the items from the hash table. More...

void	copyFrom (KviPointerHashTable< Key, T > &t)
	Removes all items in the hash table and then makes a complete shallow copy of the data contained in t. More...

unsigned int	count () const
	Returns the number of items in this hash table. More...

T *	current ()
	Returns the data value pointer pointed by the hash table iterator. More...

KviPointerHashTableEntry< Key, T > *	currentEntry ()
	Returns the entry pointed by the hash table iterator. More...

const Key &	currentKey ()
	Returns the key pointed by the hash table iterator. More...

T *	find (const Key &hKey)
	Returns the item associated to the key. More...

KviPointerHashTableEntry< Key, T > *	findRef (const T *pRef)
	Searches for the item pointer pRef. More...

T *	first ()
	Places the hash table iterator at the first entry. More...

KviPointerHashTableEntry< Key, T > *	firstEntry ()
	Places the hash table iterator at the first entry and returns it. More...

void	insert (const Key &hKey, T *pData)
	Inserts the item pData at the position specified by the key hKey. More...

void	insert (KviPointerHashTable< Key, T > &t)
	Inserts a complete shallow copy of the data contained in t. More...

bool	isEmpty () const
	Returns true if the hash table is empty. More...

	KviPointerHashTable (unsigned int uSize=32, bool bCaseSensitive=true, bool bDeepCopyKeys=true)
	Creates an empty hash table. More...

	KviPointerHashTable (KviPointerHashTable< Key, T > &t)
	First creates an empty hash table and then inserts a copy of all the item pointers present in t. More...

T *	next ()
	Places the hash table iterator at the next entry and returns the associated data value pointer. More...

KviPointerHashTableEntry< Key, T > *	nextEntry ()
	Places the hash table iterator at the next entry and returns it. More...

T *	operator[] (const Key &hKey)
	Returns the item associated to the key hKey. More...

bool	remove (const Key &hKey)
	Removes the item pointer associated to the key hKey, if such an item exists in the hash table. More...

bool	removeRef (const T *pRef)
	Removes the first occurrence of the item pointer pRef. More...

void	replace (const Key &hKey, T *pData)
	Inserts the item pData at the position specified by the key hKey. More...

void	setAutoDelete (bool bAutoDelete)
	Enables or disabled the autodeletion feature. More...

	~KviPointerHashTable ()
	Destroys the hash table and all the items contained within. More...

Protected Attributes
bool	m_bAutoDelete

bool	m_bCaseSensitive

bool	m_bDeepCopyKeys

KviPointerList < KviPointerHashTableEntry < Key, T > > **	m_pDataArray

unsigned int	m_uCount

unsigned int	m_uIteratorIdx

unsigned int	m_uSize

Friends
class	KviPointerHashTableIterator< Key, T >

Detailed Description

template<typename Key, typename T>
class KviPointerHashTable< Key, T >

A fast pointer hash table implementation.

A very cool, very fast hash table implementation :P

To use this hash table you need to provide implementations for the following functions:

* unsigned int kvi_hash_hash(const Key & hKey, bool bCaseSensitive);
* bool kvi_hash_key_equal(const Key & hKey1, const Key & hKey2, bool
* bCaseSensitive);
* void kvi_hash_key_copy(const Key & hKeyFrom, Key & hKeyTo, bool bDeepCopy);
* void kvi_hash_key_destroy(Key & hKey, bool bIsDeepCopy);
* const Key & kvi_hash_key_default(Key *);
*

Implementations for the most likey Key data types are provided below. KviPointerHashTable will automagically work with const char, QString, KviCString and integer types as keys.

For string Key types, the hash table may or may not be case sensitive. For other Key types the case sensitive flag has no meaning and will (hopefully) be optimized out by the compiler.

For pointer based keys the hash table may or may not maintain deep copies of Key data. For example, with char * keys, if deep copying is enabled then a private copy of the string data will be maintained. With deep copying disabled only char * pointers will be kept. For types that do not have meaning of deep copy the deep copying code will (hopefully) be optimized out by the compiler.

The hashtable maintains an array of KviPointerList based buckets. The number of buckets may be specified by the application user and does NOT need to be a prime number. Yet better to have it a power of two so the memory allocation routines will feel better and are less likely to waste space.

Constructor & Destructor Documentation

template<typename Key, typename T>

KviPointerHashTable< Key, T >::KviPointerHashTable	(	unsigned int	uSize = `32`,
		bool	bCaseSensitive = `true`,
		bool	bDeepCopyKeys = `true`
	)

inline

Creates an empty hash table.

Automatic deletion is enabled.

Parameters

uSize	The number of hash buckets: does NOT necesairly need to be prime
bCaseSensitive	Are the key comparisons case sensitive ?
bDeepCopyKeys	Do we need to maintain deep copies of keys ?

Returns: KviPointerHashTable

template<typename Key, typename T>

KviPointerHashTable< Key, T >::KviPointerHashTable ( KviPointerHashTable< Key, T > & t )

inline

First creates an empty hash table and then inserts a copy of all the item pointers present in t.

The autodelete feature is automatically disabled (take care!).

Parameters

t	The data to copy

Returns: KviPointerHashTable

template<typename Key, typename T>

KviPointerHashTable< Key, T >::~KviPointerHashTable ( )

inline

Destroys the hash table and all the items contained within.

Items are deleted if autodeletion is enabled.

Member Function Documentation

template<typename Key, typename T>

void KviPointerHashTable< Key, T >::clear ( )

inline

Removes all the items from the hash table.

The items are deleted if autodeletion is enabled. Invalidates the hash table iterator.

Returns: void

Referenced by KviIsOnNotifyListManager::buildRegUserDict(), KviWatchNotifyListManager::buildRegUserDict(), KviCustomToolBarManager::clear(), KviIrcServerDataBase::clear(), KviKvsHash::clear(), KviKvsScriptAddonManager::clear(), KviTextIconManager::clear(), KviIconManager::clearCache(), KviRegisteredUserDataBase::copyFrom(), KviUserIdentityManager::copyFrom(), KviPointerHashTable< QString, KviActionCategory >::copyFrom(), KviKvsPopupManager::load(), KviKvsAliasManager::load(), KviUserIdentityManager::load(), KviTextIconManager::load(), RegisteredUserPropertiesDialog::okClicked(), KviKvsParser::parse(), KviKvsParser::parseAsExpression(), KviKvsParser::parseAsParameter(), KviPackageReader::readHeaderInternal(), KviUserListView::removeAllEntries(), KviIsOnNotifyListManager::stop(), KviWatchNotifyListManager::stop(), ClassEditorWidget::~ClassEditorWidget(), and KviPointerHashTable< QString, KviActionCategory >::~KviPointerHashTable().

template<typename Key, typename T>

void KviPointerHashTable< Key, T >::copyFrom ( KviPointerHashTable< Key, T > & t )

inline

Removes all items in the hash table and then makes a complete shallow copy of the data contained in t.

The removed items are deleted if autodeletion is enabled. The hash table iterator is invalidated. Does not change autodelete flag: make sure you don't delete the items twice :)

Parameters

t	The data to copy

Returns: void

Referenced by KviPointerHashTable< QString, KviActionCategory >::KviPointerHashTable().

template<typename Key, typename T>

unsigned int KviPointerHashTable< Key, T >::count ( ) const

inline

Returns the number of items in this hash table.

Returns: unsigned int

Referenced by KviConfigurationFile::clearKey(), RegisteredUsersDialog::exportClicked(), RegisteredUserPropertiesDialog::fillData(), OptionsWidget_textIcons::fillTable(), KviIrcServerDataBase::networkCount(), KviPackageWriter::packInternal(), perlcore_module_can_unload(), reguser_kvs_cmd_showlist(), KviConfigurationFile::save(), KviKvsHash::size(), KviUserListView::updateUsersLabel(), KviUserListView::userStats(), and DccDescriptor::~DccDescriptor().

template<typename Key, typename T>

T* KviPointerHashTable< Key, T >::current ( )

inline

Returns the data value pointer pointed by the hash table iterator.

This function must be preceded by a call to firstEntry(), first() or findRef().

Returns: T *

template<typename Key, typename T>

KviPointerHashTableEntry<Key, T>* KviPointerHashTable< Key, T >::currentEntry ( )

inline

Returns the entry pointed by the hash table iterator.

This function must be preceded by a call to firstEntry(), first() or findRef().

Returns: KviPointerHashTableEntry<Key,T> *

template<typename Key, typename T>

const Key& KviPointerHashTable< Key, T >::currentKey ( )

inline

Returns the key pointed by the hash table iterator.

This function must be preceded by a call to firstEntry(), first() or findRef().

Returns: const Key &

template<typename Key, typename T>

T* KviPointerHashTable< Key, T >::find ( const Key & hKey )

inline

Returns the item associated to the key.

Returns NULL if no such item exists in the hash table. Places the hash table iterator at the position of the item found.

Parameters

hKey	The key to find

Returns: T *

template<typename Key, typename T>

KviPointerHashTableEntry<Key, T>* KviPointerHashTable< Key, T >::findRef ( const T * pRef )

inline

Searches for the item pointer pRef.

Returns its hash table entry, if found, and NULL otherwise. The hash table iterator is placed at the item found.

Parameters

pRef	The pointer to search

Returns: KviPointerHashTableEntry<Key,T> *

Referenced by KviKvsObjectController::clearUserClasses(), and ClassEditorWidget::renameNamespace().

template<typename Key, typename T>

T* KviPointerHashTable< Key, T >::first ( )

inline

Places the hash table iterator at the first entry.

It returns the associated data value pointer.

Returns: T *

Referenced by KviTextIconManager::applyOptions(), ChannelsJoinDialog::deleteClicked(), RegisteredUsersDialog::editGroup(), RegisteredUsersDialog::fillList(), ChannelsJoinDialog::fillListView(), KviPointerHashTable< QString, KviActionCategory >::find(), KviPointerHashTable< QString, KviActionCategory >::findRef(), KviPointerHashTable< QString, KviActionCategory >::insert(), KviPointerHashTable< QString, KviActionCategory >::remove(), and KviPointerHashTable< QString, KviActionCategory >::removeRef().

template<typename Key, typename T>

KviPointerHashTableEntry<Key, T>* KviPointerHashTable< Key, T >::firstEntry ( )

inline

Places the hash table iterator at the first entry and returns it.

Returns: KviPointerHashTableEntry<Key,T> *

Referenced by KviPointerHashTable< QString, KviActionCategory >::copyFrom(), RegisteredUsersDialog::exportClicked(), KviPointerHashTable< QString, KviActionCategory >::insert(), and RegisteredUsersDialog::rightButtonPressed().

template<typename Key, typename T>

void KviPointerHashTable< Key, T >::insert	(	const Key &	hKey,
		T *	pData
	)

inline

Inserts the item pData at the position specified by the key hKey.

Replaces any previous item with the same key The replaced item is deleted if autodelete is enabled. The hash table iterator is placed at the newly inserted item.

Parameters

hKey	The key where to insert data
pData	The data to insert

Returns: void

Referenced by KviApplication::addRecentChannel(), KviKvsTimerManager::addTimer(), KviIconManager::addToCache(), DccBroker::addZeroPortTag(), KviApplication::buildRecentChannels(), config_kvs_fnc_open(), KviPointerHashTable< QString, KviActionCategory >::copyFrom(), ClassEditorWidget::createFullClass(), ClassEditorWidget::currentItemChanged(), RegisteredUsersDialog::editGroup(), RegisteredUsersDialog::fillList(), KviCustomToolBar::filterChild(), KviKvsObjectController::init(), KviPointerHashTable< QString, KviActionCategory >::insert(), KviIrcUserDataBase::insertUser(), KviUserListView::insertUserEntry(), KviKvsObjectClass::KviKvsObjectClass(), KviSoundPlayer::KviSoundPlayer(), KviKvsPopupManager::load(), KviMessageCatalogue::load(), KviKvsAliasManager::load(), KviLocale::loadCatalogue(), KviModuleManager::loadModule(), ClassEditorWidget::loadNotBuiltClasses(), PluginManager::loadPlugin(), ClassEditorWidget::newClass(), objects_kvs_fnc_classes(), ClassEditorWidget::oneTimeSetup(), options_kvs_cmd_dialog(), KviActionManager::registerAction(), KviKvsObjectController::registerClass(), RegisteredUserEntryDialog::RegisteredUserEntryDialog(), KviKvsObjectController::registerObject(), ClassEditorWidget::renameClass(), ClassEditorWidget::renameNamespace(), KviPointerHashTable< QString, KviActionCategory >::replace(), KviLocale::translate(), KviMessageCatalogue::translateToQString(), and KviLocale::translateToQString().

template<typename Key, typename T>

void KviPointerHashTable< Key, T >::insert ( KviPointerHashTable< Key, T > & t )

inline

Inserts a complete shallow copy of the data contained in t.

The hash table iterator is invalidated.

Parameters

t	The data to insert

Returns: void

template<typename Key, typename T>

bool KviPointerHashTable< Key, T >::isEmpty ( ) const

inline

Returns true if the hash table is empty.

Returns: bool

Referenced by config_module_can_unload(), KviKvsTimerManager::deleteAllTimers(), KviKvsHash::isEmpty(), options_module_can_unload(), KviKvsObject::registerPrivateImplementation(), KviPointerHashTable< QString, KviActionCategory >::remove(), KviPointerHashTable< QString, KviActionCategory >::removeRef(), KviIsOnNotifyListManager::start(), and KviModuleManager::unloadModule().

template<typename Key, typename T>

T* KviPointerHashTable< Key, T >::next ( )

inline

Places the hash table iterator at the next entry and returns the associated data value pointer.

This function must be preceded by a call to firstEntry(), first() or findRef().

Returns: T *

Referenced by KviTextIconManager::applyOptions(), ChannelsJoinDialog::deleteClicked(), RegisteredUsersDialog::editGroup(), RegisteredUsersDialog::fillList(), and ChannelsJoinDialog::fillListView().

template<typename Key, typename T>

KviPointerHashTableEntry<Key, T>* KviPointerHashTable< Key, T >::nextEntry ( )

inline

Places the hash table iterator at the next entry and returns it.

This function must be preceded by a call to firstEntry(), first() or findRef().

Returns: KviPointerHashTableEntry<Key,T> *

Referenced by KviPointerHashTable< QString, KviActionCategory >::copyFrom(), RegisteredUsersDialog::exportClicked(), KviPointerHashTable< QString, KviActionCategory >::insert(), and RegisteredUsersDialog::rightButtonPressed().

template<typename Key, typename T>

T* KviPointerHashTable< Key, T >::operator[] ( const Key & hKey )

inline

Returns the item associated to the key hKey.

Returns NULL if no such item exists in the hash table. Places the hash table iterator at the position of the item found. This is an alias to find().

Parameters

hKey	The key to find

Returns: T *

template<typename Key, typename T>

bool KviPointerHashTable< Key, T >::remove ( const Key & hKey )

inline

Removes the item pointer associated to the key hKey, if such an item exists in the hash table.

The item is deleted if autodeletion is enabled. Returns true if the item was found and removed and false if it wasn't found. Invalidates the hash table iterator.

Parameters

hKey	The key where to remove the pointer

Returns: bool

Referenced by KviActionManager::actionDestroyed(), PluginManager::checkUnload(), KviConfigurationFile::clearKey(), PopupEditorWidget::commit(), config_kvs_cmd_close(), KviKvsTimerManager::deleteTimer(), KviCustomToolBarManager::destroyDescriptor(), KviKvsDnsManager::dnsLookupTerminated(), RegisteredUserEntryDialog::editAllPropertiesClicked(), RegisteredUsersDialog::editGroup(), KviCustomToolBar::filteredChildDestroyed(), DccBroker::findZeroPortTag(), KviKvsTreeNodeSwitchList::getStandardRebindingSwitch(), KviWatchNotifyListManager::handleWatchReply(), RegisteredUserEntryDialog::okClicked(), KviUserListView::partInternal(), KviKvsObject::registerPrivateImplementation(), KviRegisteredUserDataBase::removeGroup(), KviRegisteredUserDataBase::removeUser(), KviIrcUserDataBase::removeUser(), DccBroker::removeZeroPortTag(), KviCustomToolBarManager::renameDescriptor(), KviRegisteredUser::setProperty(), texticons_kvs_cmd_set(), PluginManager::unloadAll(), KviLocale::unloadCatalogue(), KviModuleManager::unloadModule(), KviActionManager::unregisterAction(), KviKvsScriptAddonManager::unregisterAddon(), KviKvsObjectController::unregisterClass(), KviKvsObjectController::unregisterObject(), KviKvsHash::unset(), DccDescriptor::~DccDescriptor(), and OptionsDialog::~OptionsDialog().

template<typename Key, typename T>

bool KviPointerHashTable< Key, T >::removeRef ( const T * pRef )

inline

Removes the first occurrence of the item pointer pRef.

The item is deleted if autodeletion is enabled. Returns true if the pointer was found and false otherwise. Invalidates the hash table iterator.

Parameters

pRef	The pointer to remove the first occurrence

Returns: bool

Referenced by ClassEditorWidget::removeItem(), ClassEditorWidget::removeItemChildren(), ClassEditorWidget::renameClass(), and ClassEditorWidget::renameNamespace().

template<typename Key, typename T>

void KviPointerHashTable< Key, T >::replace	(	const Key &	hKey,
		T *	pData
	)

inline

Inserts the item pData at the position specified by the key hKey.

Replaces any previous item with the same key. The replaced item is deleted if autodelete is enabled. The hash table iterator is placed at the newly inserted item. This is just an alias to insert() with a different name.

Parameters