NeoMutt  2021-10-29-220-g2b1eec
Teaching an old dog new tricks
DOXYGEN
hash.h
Go to the documentation of this file.
1 
24 #ifndef MUTT_LIB_HASH_H
25 #define MUTT_LIB_HASH_H
26 
27 #include <stdbool.h>
28 #include <stdint.h>
29 #include <stdlib.h>
30 
34 union HashKey
35 {
36  const char *strkey;
37  unsigned int intkey;
38 };
39 
43 struct HashElem
44 {
45  int type;
46  union HashKey key;
47  void *data;
48  struct HashElem *next;
49 };
50 
63 typedef void (*hash_hdata_free_t)(int type, void *obj, intptr_t data);
64 
76 typedef size_t (*hash_gen_hash_t)(union HashKey key, size_t num_elems);
77 
91 typedef int (*hash_cmp_key_t)(union HashKey a, union HashKey b);
92 
96 struct HashTable
97 {
98  size_t num_elems;
99  bool strdup_keys : 1;
100  bool allow_dups : 1;
101  struct HashElem **table;
104  intptr_t hdata;
106 };
107 
108 typedef uint8_t HashFlags;
109 #define MUTT_HASH_NO_FLAGS 0
110 #define MUTT_HASH_STRCASECMP (1 << 0)
111 #define MUTT_HASH_STRDUP_KEYS (1 << 1)
112 #define MUTT_HASH_ALLOW_DUPS (1 << 2)
113 
114 void mutt_hash_delete (struct HashTable *table, const char *strkey, const void *data);
115 struct HashElem * mutt_hash_find_bucket (const struct HashTable *table, const char *strkey);
116 void * mutt_hash_find (const struct HashTable *table, const char *strkey);
117 struct HashElem * mutt_hash_find_elem (const struct HashTable *table, const char *strkey);
118 void mutt_hash_free (struct HashTable **ptr);
119 struct HashElem * mutt_hash_insert (struct HashTable *table, const char *strkey, void *data);
120 void mutt_hash_int_delete (struct HashTable *table, unsigned int intkey, const void *data);
121 void * mutt_hash_int_find (const struct HashTable *table, unsigned int intkey);
122 struct HashElem * mutt_hash_int_insert (struct HashTable *table, unsigned int intkey, void *data);
123 struct HashTable *mutt_hash_int_new (size_t num_elems, HashFlags flags);
124 struct HashTable *mutt_hash_new (size_t num_elems, HashFlags flags);
125 void mutt_hash_set_destructor(struct HashTable *table, hash_hdata_free_t fn, intptr_t fn_data);
126 struct HashElem * mutt_hash_typed_insert (struct HashTable *table, const char *strkey, int type, void *data);
127 
132 {
133  size_t index;
134  struct HashElem *last;
135 };
136 
137 struct HashElem *mutt_hash_walk(const struct HashTable *table, struct HashWalkState *state);
138 
139 #endif /* MUTT_LIB_HASH_H */
uint8_t HashFlags
Flags for mutt_hash_new(), e.g. MUTT_HASH_STRCASECMP.
Definition: hash.h:108
void mutt_hash_delete(struct HashTable *table, const char *strkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:427
struct HashElem * mutt_hash_insert(struct HashTable *table, const char *strkey, void *data)
Add a new element to the Hash Table (with string keys)
Definition: hash.c:335
struct HashElem * mutt_hash_int_insert(struct HashTable *table, unsigned int intkey, void *data)
Add a new element to the Hash Table (with integer keys)
Definition: hash.c:347
int(* hash_cmp_key_t)(union HashKey a, union HashKey b)
Definition: hash.h:91
struct HashElem * mutt_hash_find_elem(const struct HashTable *table, const char *strkey)
Find the HashElem in a Hash Table element using a key.
Definition: hash.c:377
void mutt_hash_int_delete(struct HashTable *table, unsigned int intkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:444
struct HashElem * mutt_hash_find_bucket(const struct HashTable *table, const char *strkey)
Find the HashElem in a Hash Table element using a key.
Definition: hash.c:409
struct HashElem * mutt_hash_typed_insert(struct HashTable *table, const char *strkey, int type, void *data)
Insert a string with type info into a Hash Table.
Definition: hash.c:317
void * mutt_hash_find(const struct HashTable *table, const char *strkey)
Find the HashElem data in a Hash Table element using a key.
Definition: hash.c:362
struct HashTable * mutt_hash_int_new(size_t num_elems, HashFlags flags)
Create a new Hash Table (with integer keys)
Definition: hash.c:285
struct HashElem * mutt_hash_walk(const struct HashTable *table, struct HashWalkState *state)
Iterate through all the HashElem's in a Hash Table.
Definition: hash.c:489
struct HashTable * mutt_hash_new(size_t num_elems, HashFlags flags)
Create a new Hash Table (with string keys)
Definition: hash.c:259
void mutt_hash_set_destructor(struct HashTable *table, hash_hdata_free_t fn, intptr_t fn_data)
Set the destructor for a Hash Table.
Definition: hash.c:301
size_t(* hash_gen_hash_t)(union HashKey key, size_t num_elems)
Definition: hash.h:76
void(* hash_hdata_free_t)(int type, void *obj, intptr_t data)
Definition: hash.h:63
void * mutt_hash_int_find(const struct HashTable *table, unsigned int intkey)
Find the HashElem data in a Hash Table element using a key.
Definition: hash.c:392
void mutt_hash_free(struct HashTable **ptr)
Free a hash table.
Definition: hash.c:457
The item stored in a Hash Table.
Definition: hash.h:44
struct HashElem * next
Linked List.
Definition: hash.h:48
union HashKey key
Key representing the data.
Definition: hash.h:46
int type
Type of data stored in Hash Table, e.g. DT_STRING.
Definition: hash.h:45
void * data
User-supplied data.
Definition: hash.h:47
A Hash Table.
Definition: hash.h:97
hash_gen_hash_t gen_hash
Function to generate hash id from the key.
Definition: hash.h:102
struct HashElem ** table
Array of Hash keys.
Definition: hash.h:101
hash_cmp_key_t cmp_key
Function to compare two Hash keys.
Definition: hash.h:103
bool allow_dups
if set, duplicate keys are allowed
Definition: hash.h:100
size_t num_elems
Number of elements in the Hash Table.
Definition: hash.h:98
bool strdup_keys
if set, the key->strkey is strdup()'d
Definition: hash.h:99
intptr_t hdata
Data to pass to the hdata_free() function.
Definition: hash.h:104
hash_hdata_free_t hdata_free
Function to free a Hash element.
Definition: hash.h:105
Cursor to iterate through a Hash Table.
Definition: hash.h:132
size_t index
Current position in table.
Definition: hash.h:133
struct HashElem * last
Current element in linked list.
Definition: hash.h:134
The data item stored in a HashElem.
Definition: hash.h:35
const char * strkey
String key.
Definition: hash.h:36
unsigned int intkey
Integer key.
Definition: hash.h:37