hash.h

Go to the documentation of this file.

#ifndef MUTT_LIB_HASH_H
#define MUTT_LIB_HASH_H

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

union HashKey
{
  const char *strkey;  
  unsigned int intkey; 
};

struct HashElem
{
  int type;              
  union HashKey key;     
  void *data;            
  struct HashElem *next; 
};

typedef void (*hash_hdata_free_t)(int type, void *obj, intptr_t data);

typedef size_t (*hash_gen_hash_t)(union HashKey key, size_t num_elems);

typedef int (*hash_cmp_key_t)(union HashKey a, union HashKey b);

struct HashTable
{
  size_t num_elems;             
  bool strdup_keys : 1;         
  bool allow_dups  : 1;         
  struct HashElem **table;      
  hash_gen_hash_t gen_hash;     
  hash_cmp_key_t cmp_key;       
  intptr_t hdata;               
  hash_hdata_free_t hdata_free; 
};

typedef uint8_t HashFlags;             
#define MUTT_HASH_NO_FLAGS          0  
#define MUTT_HASH_STRCASECMP  (1 << 0) 
#define MUTT_HASH_STRDUP_KEYS (1 << 1) 
#define MUTT_HASH_ALLOW_DUPS  (1 << 2) 

void              mutt_hash_delete        (struct HashTable *table, const char *strkey, const void *data);
struct HashElem * mutt_hash_find_bucket   (const struct HashTable *table, const char *strkey);
void *            mutt_hash_find          (const struct HashTable *table, const char *strkey);
struct HashElem * mutt_hash_find_elem     (const struct HashTable *table, const char *strkey);
void              mutt_hash_free          (struct HashTable **ptr);
struct HashElem * mutt_hash_insert        (struct HashTable *table, const char *strkey, void *data);
void              mutt_hash_int_delete    (struct HashTable *table, unsigned int intkey, const void *data);
void *            mutt_hash_int_find      (const struct HashTable *table, unsigned int intkey);
struct HashElem * mutt_hash_int_insert    (struct HashTable *table, unsigned int intkey, void *data);
struct HashTable *mutt_hash_int_new       (size_t num_elems, HashFlags flags);
struct HashTable *mutt_hash_new           (size_t num_elems, HashFlags flags);
void              mutt_hash_set_destructor(struct HashTable *table, hash_hdata_free_t fn, intptr_t fn_data);
struct HashElem * mutt_hash_typed_insert  (struct HashTable *table, const char *strkey, int type, void *data);

struct HashWalkState
{
  size_t index;          
  struct HashElem *last; 
};

struct HashElem *mutt_hash_walk(const struct HashTable *table, struct HashWalkState *state);

#endif /* MUTT_LIB_HASH_H */