Logo Search packages:      
Sourcecode: icu version File versions  Download package

UHashTok Union Reference

#include <uhash.h>

List of all members.

Detailed Description

UHashtable stores key-value pairs and does moderately fast lookup based on keys. It provides a good tradeoff between access time and storage space. As elements are added to it, it grows to accomodate them. By default, the table never shrinks, even if all elements are removed from it.

Keys and values are stored as void* pointers. These void* pointers may be actual pointers to strings, objects, or any other structure in memory, or they may simply be integral values cast to void*. UHashtable doesn't care and manipulates them via user-supplied functions. These functions hash keys, compare keys, delete keys, and delete values. Some function pointers are optional (may be NULL); others must be supplied. Several prebuilt functions exist to handle common key types.

UHashtable ownership of keys and values is flexible, and controlled by whether or not the key deleter and value deleter functions are set. If a void* key is actually a pointer to a deletable object, then UHashtable can be made to delete that object by setting the key deleter function pointer to a non-NULL value. If this is done, then keys passed to uhash_put() are owned by the hashtable and will be deleted by it at some point, either as keys are replaced, or when uhash_close() is finally called. The same is true of values and the value deleter function pointer. Keys passed to methods other than uhash_put() are never owned by the hashtable.

NULL values are not allowed. uhash_get() returns NULL to indicate a key that is not in the table, and having a NULL value in the table would generate an ambiguous result. If a key and a NULL value is passed to uhash_put(), this has the effect of doing a uhash_remove() on that key. This keeps uhash_get(), uhash_count(), and uhash_nextElement() consistent with one another.

To see everything in a hashtable, use uhash_nextElement() to iterate through its contents. Each call to this function returns a UHashElement pointer. A hash element contains a key, value, and hashcode. During iteration an element may be deleted by calling uhash_removeElement(); iteration may safely continue thereafter. The uhash_remove() function may also be safely called in mid-iteration. However, if uhash_put() is called during iteration then the iteration will be out of sync. Under no circumstances should the UHashElement returned by uhash_nextElement be modified directly.

By default, the hashtable grows when necessary, but never shrinks, even if all items are removed. For most applications this is optimal. However, in a highly dynamic usage where memory is at a premium, the table can be set to both grow and shrink by calling uhash_setResizePolicy() with the policy U_GROW_AND_SHRINK. In a situation where memory is critical and the client wants a table that does not grow at all, the constant U_FIXED can be used. A key or value within the hashtable. It may be either a 32-bit integral value or an opaque void* pointer. The void* pointer may be smaller than 32 bits (e.g. 24 bits) or may be larger (e.g. 64 bits). The hashing and comparison functions take a pointer to a UHashTok, but the deleter receives the void* pointer within it.

Because a UHashTok is the size of a native pointer or a 32-bit integer, we pass it around by value.

Definition at line 88 of file uhash.h.

Public Attributes

int32_t integer
void * pointer

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

Generated by  Doxygen 1.6.0   Back to index