Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2001 - 2005 Pekka Riikonen
+ Copyright (C) 2001 - 2008 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
-/****h* silcutil/SILC Hash Table Interface
+/****h* silcutil/Hash Table Interface
*
* DESCRIPTION
*
* Implementation of collision resistant hash table. This is a hash table
* that provides a reliable (what you add there stays there, and duplicate
* keys are allowed) with as fast reference to the key as possible. If
- * there are a lot of duplicate keys in the hash table the lookup gets
- * slower of course. However, this is reliable and no data is lost at any
- * point. If you know that you never have duplicate keys then this is as
- * fast as any simple hash table.
+ * there are a lot of duplicate keys in the hash table the lookup slows down.
+ * However, this is reliable and no data is lost at any point. If you know
+ * that you never have duplicate keys then this is as fast as any simple hash
+ * table.
*
* The interface provides many ways to search the hash table including
- * an extended interface where caller can specify its own hash and comparison
- * functions.
+ * an extended interface where caller can specify their own hash and comparison
+ * functions. The interface also supports SilcStack and all memory allocated
+ * by the hash table can be allocated from SilcStack.
*
* There are two ways to traverse the entire hash table if this feature
* is needed. There exists a foreach function that calls a foreach
* SilcHashTableList structure and traverse the hash table inside while()
* using the list structure. Both are equally fast.
*
- * The hash table is not thread safe. If same hash table context is used in
- * multi thread environment concurrency control must be employed.
+ * The interface also provides many utility hashing and comparison functions
+ * that caller may use with SilcHashTable.
+ *
+ * The hash table is not thread safe. If same SilcHashtable context is used
+ * in multi thread environment concurrency control must be employed.
*
***/
#ifndef SILCHASHTABLE_H
#define SILCHASHTABLE_H
-/****s* silcutil/SilcHashTableAPI/SilcHashTable
+/****s* silcutil/SilcHashTable
*
* NAME
*
***/
typedef struct SilcHashTableStruct *SilcHashTable;
-/****s* silcutil/SilcHashTableAPI/SilcHashTableList
+/****s* silcutil/SilcHashTableList
*
* NAME
*
};
/***/
-/****f* silcutil/SilcHashTableAPI/SilcHashFunction
+/****f* silcutil/SilcHashFunction
*
* SYNOPSIS
*
***/
typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context);
-/****f* silcutil/SilcHashTableAPI/SilcHashCompare
+/****f* silcutil/SilcHashCompare
*
* SYNOPSIS
*
typedef SilcBool (*SilcHashCompare)(void *key1, void *key2,
void *user_context);
-/****f* silcutil/SilcHashTableAPI/SilcHashDestructor
+/****f* silcutil/SilcHashDestructor
*
* SYNOPSIS
*
typedef void (*SilcHashDestructor)(void *key, void *context,
void *user_context);
-/****f* silcutil/SilcHashTableAPI/SilcHashForeach
+/****f* silcutil/SilcHashForeach
*
* SYNOPSIS
*
/* Simple hash table interface */
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_alloc
+/****f* silcutil/silc_hash_table_alloc
*
* SYNOPSIS
*
- * SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size,
+ * SilcHashTable silc_hash_table_alloc(SilcStack stack,
+ * SilcUInt32 table_size,
* SilcHashFunction hash,
* void *hash_user_context,
* SilcHashCompare compare,
*
* DESCRIPTION
*
- * Allocates new hash table and returns it. If the `table_size' is not
+ * Allocates new hash table and returns it. If the `stack' is non-NULL
+ * the hash table is allocated from `stack'. If the `table_size' is not
* zero then the hash table size is the size provided. If zero then the
* default size will be used. Note that if the `table_size' is provided
* it should be a prime. The `hash', `compare' and `destructor' are
* the hash function, the key comparison function and key and context
* destructor function, respectively. The `hash' is mandatory, the others
- * are optional.
+ * are optional. Returns NULL if system is out of memory.
*
***/
-SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size,
+SilcHashTable silc_hash_table_alloc(SilcStack stack,
+ SilcUInt32 table_size,
SilcHashFunction hash,
void *hash_user_context,
SilcHashCompare compare,
void *destructor_user_context,
SilcBool auto_rehash);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_free
+/****f* silcutil/silc_hash_table_free
*
* SYNOPSIS
*
* Frees the hash table. The destructor function provided in the
* silc_hash_table_alloc will be called for all keys in the hash table.
*
+ * If the SilcStack was given to silc_hash_table_alloc this call will
+ * release all memory allocated during the life time of the `ht' back
+ * to the SilcStack.
+ *
***/
void silc_hash_table_free(SilcHashTable ht);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_size
+/****f* silcutil/silc_hash_table_size
*
* SYNOPSIS
*
***/
SilcUInt32 silc_hash_table_size(SilcHashTable ht);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_count
+/****f* silcutil/silc_hash_table_count
*
* SYNOPSIS
*
***/
SilcUInt32 silc_hash_table_count(SilcHashTable ht);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_add
+/****f* silcutil/silc_hash_table_add
*
* SYNOPSIS
*
***/
SilcBool silc_hash_table_add(SilcHashTable ht, void *key, void *context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_replace
+/****f* silcutil/silc_hash_table_set
*
* SYNOPSIS
*
- * SilcBool silc_hash_table_replace(SilcHashTable ht, void *key,
- * void *context);
+ * SilcBool silc_hash_table_set(SilcHashTable ht, void *key,
+ * void *context);
*
* DESCRIPTION
*
* replaced key and context.
*
***/
-SilcBool silc_hash_table_replace(SilcHashTable ht, void *key, void *context);
+SilcBool silc_hash_table_set(SilcHashTable ht, void *key, void *context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_del
+/****f* silcutil/silc_hash_table_del
*
* SYNOPSIS
*
***/
SilcBool silc_hash_table_del(SilcHashTable ht, void *key);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_del_by_context
+/****f* silcutil/silc_hash_table_del_by_context
*
* SYNOPSIS
*
SilcBool silc_hash_table_del_by_context(SilcHashTable ht, void *key,
void *context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_find
+/****f* silcutil/silc_hash_table_find
*
* SYNOPSIS
*
SilcBool silc_hash_table_find(SilcHashTable ht, void *key,
void **ret_key, void **ret_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context
+/****f* silcutil/silc_hash_table_find_by_context
*
* SYNOPSIS
*
SilcBool silc_hash_table_find_by_context(SilcHashTable ht, void *key,
void *context, void **ret_key);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach
+/****f* silcutil/silc_hash_table_find_foreach
*
* SYNOPSIS
*
void silc_hash_table_find_foreach(SilcHashTable ht, void *key,
SilcHashForeach foreach, void *user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_foreach
+/****f* silcutil/silc_hash_table_foreach
*
* SYNOPSIS
*
void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach,
void *user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_rehash
+/****f* silcutil/silc_hash_table_rehash
*
* SYNOPSIS
*
***/
void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_list
+/****f* silcutil/silc_hash_table_list
*
* SYNOPSIS
*
***/
void silc_hash_table_list(SilcHashTable ht, SilcHashTableList *htl);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_list_reset
+/****f* silcutil/silc_hash_table_list_reset
*
* SYNOPSIS
*
***/
void silc_hash_table_list_reset(SilcHashTableList *htl);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_get
+/****f* silcutil/silc_hash_table_get
*
* SYNOPSIS
*
* DESCRIPTION
*
* Returns always the next entry in the hash table into the `key' and
- * `context' and TRUE. If this returns FALSE then there are no anymore
- * any entrys.
+ * `context' and TRUE. If this returns FALSE then there are no more
+ * entries.
+ *
+ * EXAMPLE
+ *
+ * SilcHashTableList htl;
+ * silc_hash_table_list(hash_table, &htl);
+ * while (silc_hash_table_get(&htl, (void *)&key, (void *)&context))
+ * ...
+ * silc_hash_table_list_reset(&htl);
*
***/
SilcBool silc_hash_table_get(SilcHashTableList *htl,
/* Extended hash table interface (same as above but with specific
hash and comparison functions). */
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_add_ext
+/****f* silcutil/silc_hash_table_add_ext
*
* SYNOPSIS
*
SilcHashFunction hash,
void *hash_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_replace_ext
+/****f* silcutil/silc_hash_table_set_ext
*
* SYNOPSIS
*
- * SilcBool silc_hash_table_replace_ext(SilcHashTable ht, void *key,
- * void *context,
- * SilcHashFunction hash,
- * void *hash_user_context);
+ * SilcBool silc_hash_table_set_ext(SilcHashTable ht, void *key,
+ * void *context,
+ * SilcHashFunction hash,
+ * void *hash_user_context);
*
* DESCRIPTION
*
* function. If not provided the hash table's default is used.
*
***/
-SilcBool silc_hash_table_replace_ext(SilcHashTable ht,
- void *key, void *context,
- SilcHashFunction hash,
- void *hash_user_context);
+SilcBool silc_hash_table_set_ext(SilcHashTable ht,
+ void *key, void *context,
+ SilcHashFunction hash,
+ void *hash_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_del_ext
+/****f* silcutil/silc_hash_table_del_ext
*
* SYNOPSIS
*
SilcHashDestructor destructor,
void *destructor_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_del_by_context_ext
+/****f* silcutil/silc_hash_table_del_by_context_ext
*
* SYNOPSIS
*
SilcHashDestructor destructor,
void *destructor_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_ext
+/****f* silcutil/silc_hash_table_find_ext
*
* SYNOPSIS
*
SilcHashCompare compare,
void *compare_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context_ext
+/****f* silcutil/silc_hash_table_find_by_context_ext
*
* SYNOPSIS
*
SilcHashCompare compare,
void *compare_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach_ext
+/****f* silcutil/silc_hash_table_find_foreach_ext
*
* SYNOPSIS
*
SilcHashForeach foreach,
void *foreach_user_context);
-/****f* silcutil/SilcHashTableAPI/silc_hash_table_rehash_ext
+/****f* silcutil/silc_hash_table_rehash_ext
*
* SYNOPSIS
*
SilcHashFunction hash,
void *hash_user_context);
+/* Hash functions */
+
+/****f* silcutil/silc_hash_string
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_hash_string(void *key, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Basic hash function to hash strings. May be used with the SilcHashTable.
+ * This uses Bob Jenkin's one-at-a-time (described in Wikipedia) hash
+ * function.
+ *
+ ***/
+SilcUInt32 silc_hash_string(void *key, void *user_context);
+
+/****f* silcutil/silc_hash_string_case
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_hash_string_case(void *key, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Basic hash function to hash strings. May be used with the SilcHashTable.
+ * This ignores the string's case, ie. 'Foo' and 'foo' will hash to same
+ * value. This uses Bob Jenkin's one-at-a-time (described in Wikipedia)
+ * hash function.
+ *
+ ***/
+SilcUInt32 silc_hash_string_case(void *key, void *user_context);
+
+/****f* silcutil/silc_hash_utf8_string
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Basic has function to hash UTF-8 strings. May be used with the
+ * SilcHashTable. Used with identifier strings. The key is
+ * expected to be casefolded.
+ *
+ ***/
+SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
+
+/****f* silcutil/silc_hash_uint
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_hash_uint(void *key, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Basic hash function to hash integers. May be used with the SilcHashTable.
+ * Comparison function is not needed, the SilcHashTable will automatically
+ * compare integer values.
+ *
+ ***/
+SilcUInt32 silc_hash_uint(void *key, void *user_context);
+
+/****f* silcutil/silc_hash_ptr
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_hash_ptr(void *key, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Basic hash funtion to hash pointers. May be used with the SilcHashTable.
+ * Comparison function is not needed, the SilcHashTable will automatically
+ * compare pointer values.
+ *
+ ***/
+SilcUInt32 silc_hash_ptr(void *key, void *user_context);
+
+/****f* silcutil/silc_hash_data
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_hash_data(void *key, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Hash binary data. The `user_context' is the data length. This uses Bob
+ * Jenkin's one-at-a-time (described in Wikipedia) hash function.
+ *
+ ***/
+SilcUInt32 silc_hash_data(void *key, void *user_context);
+
+/* Comparison functions */
+
+/****f* silcutil/silc_hash_string_compare
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_hash_string_compare(void *key1, void *key2,
+ * void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Compares two strings. It may be used as SilcHashTable comparison
+ * function.
+ *
+ ***/
+SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context);
+
+/****f* silcutil/silc_hash_string_case_compare
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_hash_string_case_compare(void *key1, void *key2,
+ * void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Compares two strings. This ignores the case while comparing. It may
+ * be used as SilcHashTable comparison function.
+ *
+ ***/
+SilcBool silc_hash_string_case_compare(void *key1, void *key2,
+ void *user_context);
+
+/****f* silcutil/silc_hash_utf8_compare
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_hash_utf8_compare(void *key1, void *key2,
+ * void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Compares UTF-8 strings. Casefolded and NULL terminated strings are
+ * expected. May be used as SilcHashTable comparison function.
+ *
+ ***/
+SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
+
+/****f* silcutil/silc_hash_data_compare
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_hash_data_compare(void *key1, void *key2,
+ * void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Compares binary data. May be used as SilcHashTable comparison function.
+ *
+ ***/
+SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context);
+
+/* Destructor functions */
+
+/****f* silcutil/silc_hash_destructor
+ *
+ * SYNOPSIS
+ *
+ * void silc_hash_destructor(void *key, void *context, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * A generic destructor for SilcHashTable. This will call silc_free for
+ * `key' and `context'.
+ *
+ ***/
+void silc_hash_destructor(void *key, void *context, void *user_context);
+
#endif
projects / runtime.git / blobdiff