mercury_hash_table.h

Go to the documentation of this file.

/*

Copyright (c) 2005-2008, Simon Howard

Permission to use, copy, modify, and/or distribute this software 
for any purpose with or without fee is hereby granted, provided 
that the above copyright notice and this permission notice appear 
in all copies. 

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR 
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN      
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 

 */

#ifndef HG_HASH_TABLE_H
#define HG_HASH_TABLE_H

#include "mercury_util_config.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct hg_hash_table hg_hash_table_t;

typedef struct hg_hash_table_iter hg_hash_table_iter_t;

typedef struct hg_hash_table_entry hg_hash_table_entry_t;

typedef void *hg_hash_table_key_t;

typedef void *hg_hash_table_value_t;

struct hg_hash_table_iter {
    hg_hash_table_t *hash_table;
    hg_hash_table_entry_t *next_entry;
   unsigned int next_chain;
};

#define HG_HASH_TABLE_NULL ((void *) 0)

typedef unsigned int (*hg_hash_table_hash_func_t)(hg_hash_table_key_t value);

typedef int (*hg_hash_table_equal_func_t)(hg_hash_table_key_t value1, hg_hash_table_key_t value2);

typedef void (*hg_hash_table_key_free_func_t)(hg_hash_table_key_t value);

typedef void (*hg_hash_table_value_free_func_t)(hg_hash_table_value_t value);

HG_UTIL_EXPORT hg_hash_table_t *
hg_hash_table_new(hg_hash_table_hash_func_t hash_func,
        hg_hash_table_equal_func_t equal_func);

HG_UTIL_EXPORT void
hg_hash_table_free(hg_hash_table_t *hash_table);

HG_UTIL_EXPORT void
hg_hash_table_register_free_functions(hg_hash_table_t *hash_table,
        hg_hash_table_key_free_func_t key_free_func,
        hg_hash_table_value_free_func_t value_free_func);

HG_UTIL_EXPORT int
hg_hash_table_insert(hg_hash_table_t *hash_table,
        hg_hash_table_key_t key,
        hg_hash_table_value_t value);

HG_UTIL_EXPORT hg_hash_table_value_t
hg_hash_table_lookup(hg_hash_table_t *hash_table,
        hg_hash_table_key_t key);

HG_UTIL_EXPORT int
hg_hash_table_remove(hg_hash_table_t *hash_table, hg_hash_table_key_t key);

HG_UTIL_EXPORT unsigned int
hg_hash_table_num_entries(hg_hash_table_t *hash_table);

HG_UTIL_EXPORT void
hg_hash_table_iterate(hg_hash_table_t *hash_table, hg_hash_table_iter_t *iter);

HG_UTIL_EXPORT int
hg_hash_table_iter_has_more(hg_hash_table_iter_t *iterator);

HG_UTIL_EXPORT hg_hash_table_value_t
hg_hash_table_iter_next(hg_hash_table_iter_t *iterator);

#ifdef __cplusplus
}
#endif

#endif /* HG_HASH_TABLE_H */