/* +++Date last modified: 05-Jul-1997 */
#ifndef HASH__H
#define HASH__H

#include <stddef.h>           /* For size_t     */
#include <stdint.h>
#include "mpool.h"
#include "strarray.h"

#define HASH_TABLE_INITIALIZER {0, 0, 0, NULL, NULL}

/*
** A hash table consists of an array of these buckets.  Each bucket
** holds a copy of the key, a pointer to the data associated with the
** key, and a pointer to the next bucket that collided with this one,
** if there was one.
*/

typedef struct bucket {
    char *key;
    void *data;
    struct bucket *next;
} bucket;

/*
** This is what you actually declare an instance of to create a table.
** You then call 'construct_table' with the address of this structure,
** and a guess at the size of the table.  Note that more nodes than this
** can be inserted in the table, but performance degrades as this
** happens.  Performance should still be quite adequate until 2 or 3
** times as many nodes have been inserted as the table was created with.
*/

typedef struct hash_table {
    size_t size;
    size_t count;
    uint32_t seed;
    bucket **table;
    struct mpool *pool;
} hash_table;

/*
** This is used to construct the table.  If it doesn't succeed, it sets
** the table's size to 0, and the pointer to the table to NULL.
*/

hash_table *construct_hash_table(hash_table *table, size_t size,
                                 int use_mpool);

/*
** Inserts a pointer to 'data' in the table, with a copy of 'key' as its
** key.  Note that this makes a copy of the key, but NOT of the
** associated data.
*/

void *hash_insert(const char *key,void *data,hash_table *table);

/*
** Returns a pointer to the data associated with a key.  If the key has
** not been inserted in the table, returns NULL.
*/

void *hash_lookup(const char *key,hash_table *table);

/*
** Deletes an entry from the table.  Returns a pointer to the data that
** was associated with the key so the calling code can dispose of it
** properly.
*/
/* Warning: use this function judiciously if you are using memory pools,
 * since it will leak memory until you get rid of the entire hash table */
void *hash_del(const char *key,hash_table *table);

/*
** Goes through a hash table and calls the function passed to it
** for each node that has been inserted.  The function is passed
** a pointer to the key, a pointer to the data associated
** with it and 'rock'.
** the "sorted" version sorts the keys first and then iterates them in
** sorted order.  It's slower but consistent
*/

void hash_enumerate(hash_table *table,void (*func)(const char *,void *,void *),
                    void *rock);
void hash_enumerate_sorted(hash_table *table,void (*func)(const char *,void *,void *),
                    void *rock, strarray_cmp_fn_t *cmp);

/* gets all the keys from the hashtable */
strarray_t *hash_keys(hash_table *table);

/* counts the number of nodes in the hash table */

int hash_numrecords(hash_table *table);

/*
** Frees a hash table.  For each node that was inserted in the table,
** it calls the function whose address it was passed, with a pointer
** to the data that was in the table.  The function is expected to
** free the data.  Typical usage would be:
** free_table(&table, free);
** if the data placed in the table was dynamically allocated, or:
** free_table(&table, NULL);
** if not.  ( If the parameter passed is NULL, it knows not to call
** any function with the data. )
*/

void free_hash_table(hash_table *table, void (*func)(void *));

/*
** An iterator for a hash table. Inserting or deleting entries
** the hash table is not safe while iterating. The entries are
** iterated in arbitrary order. */
typedef struct hash_iter hash_iter;

/* Creates an iterator for the hash table. The iterator points
 * *before* the first entry, if any. */
hash_iter *hash_table_iter(hash_table *table);

/* Returns non-zero if the iterator has more entries. */
int hash_iter_has_next(hash_iter *iter);

/* Forwards the iterator to the next entry and returns its key.
** If there is no more entry, the return value is NULL. */
const char *hash_iter_next(hash_iter *iter);

/* Returns the key of the current entry. */
const char *hash_iter_key(hash_iter *iter);

/* Returns the value of the current entry.*/
void *hash_iter_val(hash_iter *iter);

/* Resets the iterator to point before the first entry. */
void hash_iter_reset(hash_iter *);

/* Frees the iterator. */
void hash_iter_free(hash_iter **iterptr);

#endif /* HASH__H */
