HelenOS/USB: doxygen-tmp/development_branch/uspace/lib/c/include/adt/hash

00001 /*
00002  * Copyright (c) 2006 Jakub Jermar
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  *
00009  * - Redistributions of source code must retain the above copyright
00010  *   notice, this list of conditions and the following disclaimer.
00011  * - Redistributions in binary form must reproduce the above copyright
00012  *   notice, this list of conditions and the following disclaimer in the
00013  *   documentation and/or other materials provided with the distribution.
00014  * - The name of the author may not be used to endorse or promote products
00015  *   derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00019  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00020  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00022  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00024  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00026  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  */
00028 
00035 #ifndef LIBC_HASH_TABLE_H_
00036 #define LIBC_HASH_TABLE_H_
00037 
00038 #include <adt/list.h>
00039 #include <unistd.h>
00040 #include <bool.h>
00041 
00042 typedef unsigned long hash_count_t;
00043 typedef unsigned long hash_index_t;
00044 
00046 typedef struct {
00055         hash_index_t (*hash)(unsigned long key[]);
00056         
00065         int (*compare)(unsigned long key[], hash_count_t keys, link_t *item);
00066         
00072         void (*remove_callback)(link_t *item);
00073 } hash_table_operations_t;
00074 
00076 typedef struct {
00077         link_t *entry;
00078         hash_count_t entries;
00079         hash_count_t max_keys;
00080         hash_table_operations_t *op;
00081 } hash_table_t;
00082 
00083 #define hash_table_get_instance(item, type, member) \
00084     list_get_instance((item), type, member)
00085 
00086 extern bool hash_table_create(hash_table_t *, hash_count_t, hash_count_t,
00087     hash_table_operations_t *);
00088 extern void hash_table_insert(hash_table_t *, unsigned long [], link_t *);
00089 extern link_t *hash_table_find(hash_table_t *, unsigned long []);
00090 extern void hash_table_remove(hash_table_t *, unsigned long [], hash_count_t);
00091 extern void hash_table_destroy(hash_table_t *);
00092 extern void hash_table_apply(hash_table_t *, void (*)(link_t *, void *),
00093     void *);
00094 
00095 #endif
00096
hash_table.h
