hashtable.h

Go to the documentation of this file.

/***************************************************************************
    begin........: May 2012
    copyright....: Sebastian Fedrau
    email........: sebastian.fedrau@gmail.com
 ***************************************************************************/
 
/***************************************************************************
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License v3 as published by
    the Free Software Foundation.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    General Public License v3 for more details.
 ***************************************************************************/
#ifndef HASHTABLE_H
#define HASHTABLE_H
 
#include <stddef.h>
#include <stdbool.h>
 
#include "datatypes.h"
#include "pool.h"
 
#define HASHTABLE_AUTO_RESIZE 0
 
typedef struct _HashTable
{
    EqualFunc compare_keys;
    FreeFunc free_key;
    FreeFunc free_value;
    HashFunc hash;
    size_t size;
    const size_t *sizeptr;
    bool grow;
    struct _Bucket
    {
        void *key;
        void *data;
        struct _Bucket *next;
    } **buckets;
    size_t count;
    Pool *pool;
    struct _HashTablePair
    {
        FreeFunc free_value;
        struct _Bucket *bucket;
    } pair;
} HashTable;
 
typedef struct _HashTablePair HashTablePair;
 
typedef struct
{
    const HashTable *table;
    size_t offset;
    struct _Bucket *liter;
    bool finished;
} HashTableIter;
 
typedef enum
{
    HASHTABLE_INSERT_RESULT_NEW,
    HASHTABLE_INSERT_RESULT_REPLACED,
    HASHTABLE_INSERT_RESULT_FAILED
} HashTableInsertResult;
 
HashTable *hashtable_new(size_t size, HashFunc hash_func, EqualFunc compare_keys, FreeFunc free_key, FreeFunc free_value);
 
void hashtable_init(HashTable *table, size_t size, HashFunc hash_func, EqualFunc compare_keys, FreeFunc free_key, FreeFunc free_value);
 
void hashtable_destroy(HashTable *table);
 
void hashtable_free(HashTable *table);
 
void hashtable_clear(HashTable *table);
 
HashTableInsertResult hashtable_set(HashTable *table, void *key, void *value, bool overwrite_key);
 
void hashtable_remove(HashTable *table, const void *key);
 
HashTablePair *hashtable_lookup(HashTable *table, const void *key);
 
void *hashtable_pair_get_key(const HashTablePair *pair);
 
#define hashtable_pair_key(p) p->bucket->key
 
void *hashtable_pair_get_value(const HashTablePair *pair);
 
#define hashtable_pair_value(p) p->bucket->data
 
void hashtable_pair_set_value(HashTablePair *pair, void *value);
 
bool hashtable_key_exists(const HashTable *table, const void *key);
 
size_t hashtable_count(const HashTable *table);
 
void hashtable_iter_init(const HashTable *table, HashTableIter *iter);
 
bool hashtable_iter_next(HashTableIter *iter);
 
void *hashtable_iter_get_key(const HashTableIter *iter);
 
#define hashtable_iter_key(iter) iter.liter->key
 
void *hashtable_iter_get_value(const HashTableIter *iter);
 
#define hashtable_iter_value(iter) iter.liter->data
 
#endif