PSC_HashTable Class Reference

A hash table storing any data objects using string keys. More...

#include <poser/core/hashtable.h>

Public Member Functions
PSC_HashTable *	PSC_HashTable_create (uint8_t bits)
	PSC_HashTable default constructor.
void	PSC_HashTable_set (PSC_HashTable *self, const char *key, void *obj, void(*deleter)(void *))
	Set a new object for a key.
int	PSC_HashTable_delete (PSC_HashTable *self, const char *key)
	Deletes the object with the specified key.
int	PSC_HashTable_deleteAll (PSC_HashTable *self, int(*matcher)(const char *, void *, const void *), const void *arg)
	Deletes matching objects from the hashtable.
size_t	PSC_HashTable_count (const PSC_HashTable *self)
	Number of entries.
void *	PSC_HashTable_get (const PSC_HashTable *self, const char *key)
	Gets an object by key.
PSC_HashTableIterator *	PSC_HashTable_iterator (const PSC_HashTable *self)
	Creates an iterator for all entries.
void	PSC_HashTable_destroy (PSC_HashTable *self)
	PSC_HashTable destructor.

Detailed Description

A hash table storing any data objects using string keys.

Member Function Documentation

PSC_HashTable_count()

size_t PSC_HashTable_count

(

const PSC_HashTable *

self

)

Number of entries.

Parameters

self	the PSC_HashTable

Returns

the number of entries

PSC_HashTable_create()

PSC_HashTable * PSC_HashTable_create

(

uint8_t

bits

)

PSC_HashTable default constructor.

Creates a new PSC_HashTable

Parameters

bits	number of bits for the hashes (valid range [2..16])

Returns

a newly created PSC_HashTable

PSC_HashTable_delete()

int PSC_HashTable_delete	(	PSC_HashTable *	self,
		const char *	key
	)

Deletes the object with the specified key.

If the object has a deleter attached, it is also destroyed.

Parameters

self	the PSC_HashTable
key	the key

Returns

1 if an object was deleted, 0 otherwise

PSC_HashTable_deleteAll()

int PSC_HashTable_deleteAll	(	PSC_HashTable *	self,
		int(*)(const char *, void *, const void *)	matcher,
		const void *	arg
	)

Deletes matching objects from the hashtable.

Objects that have a deleter attached are also destroyed.

Parameters

self	the PSC_HashTable
matcher	function to compare each entry, given by its key and the stored object, to some specified value. Must return 1 for entries to be deleted, 0 otherwise.
arg	some value for the matcher function to compare entries against.

Returns

the number of entries deleted

PSC_HashTable_destroy()

void PSC_HashTable_destroy

(

PSC_HashTable *

self

)

PSC_HashTable destructor.

All stored objects that have a deleter attached are destroyed as well.

Parameters

self	the PSC_HashTable

PSC_HashTable_get()

void * PSC_HashTable_get	(	const PSC_HashTable *	self,
		const char *	key
	)

Gets an object by key.

Parameters

self	the PSC_HashTable
key	the key

Returns

the object stored for the give key, or NULL

PSC_HashTable_iterator()

PSC_HashTableIterator * PSC_HashTable_iterator

(

const PSC_HashTable *

self

)

Creates an iterator for all entries.

The iterator contains a snapshot of all objects currently stored, modifications to the PSC_HashTable will not be reflected in the iterator. In its initial state, the iterator points to an invalid position.

Parameters

self	the PSC_HashTable

Returns

an iterator

PSC_HashTable_set()

void PSC_HashTable_set	(	PSC_HashTable *	self,
		const char *	key,
		void *	obj,
		void(*)(void *)	deleter
	)

Set a new object for a key.

If there was already an object for the given key, it is replaced. The old object is destroyed if it has a deleter attached.

Parameters

self	the PSC_HashTable
key	the key
obj	the new object
deleter	optional function to destroy the object

---

The documentation for this class was generated from the following file:

• poser/core/hashtable.h