NeoMutt  2023-05-17-16-g61469c
Teaching an old dog new tricks
DOXYGEN
hash.h
Go to the documentation of this file.
1
24#ifndef MUTT_MUTT_HASH_H
25#define MUTT_MUTT_HASH_H
26
27#include <stdbool.h>
28#include <stdint.h>
29#include <stdlib.h>
30
35{
36 const char *strkey;
37 unsigned int intkey;
38};
39
44{
45 int type;
46 union HashKey key;
47 void *data;
48 struct HashElem *next;
49};
50
62typedef void (*hash_hdata_free_t)(int type, void *obj, intptr_t data);
63
75typedef size_t (*hash_gen_hash_t)(union HashKey key, size_t num_elems);
76
90typedef int (*hash_cmp_key_t)(union HashKey a, union HashKey b);
91
98{
99 size_t num_elems;
100 bool strdup_keys : 1;
101 bool allow_dups : 1;
102 struct HashElem **table;
105 intptr_t hdata;
107};
108
109typedef uint8_t HashFlags;
110#define MUTT_HASH_NO_FLAGS 0
111#define MUTT_HASH_STRCASECMP (1 << 0)
112#define MUTT_HASH_STRDUP_KEYS (1 << 1)
113#define MUTT_HASH_ALLOW_DUPS (1 << 2)
114
115void mutt_hash_delete (struct HashTable *table, const char *strkey, const void *data);
116struct HashElem * mutt_hash_find_bucket (const struct HashTable *table, const char *strkey);
117void * mutt_hash_find (const struct HashTable *table, const char *strkey);
118struct HashElem * mutt_hash_find_elem (const struct HashTable *table, const char *strkey);
119void mutt_hash_free (struct HashTable **ptr);
120struct HashElem * mutt_hash_insert (struct HashTable *table, const char *strkey, void *data);
121void mutt_hash_int_delete (struct HashTable *table, unsigned int intkey, const void *data);
122void * mutt_hash_int_find (const struct HashTable *table, unsigned int intkey);
123struct HashElem * mutt_hash_int_insert (struct HashTable *table, unsigned int intkey, void *data);
124struct HashTable *mutt_hash_int_new (size_t num_elems, HashFlags flags);
125struct HashTable *mutt_hash_new (size_t num_elems, HashFlags flags);
126void mutt_hash_set_destructor(struct HashTable *table, hash_hdata_free_t fn, intptr_t fn_data);
127struct HashElem * mutt_hash_typed_insert (struct HashTable *table, const char *strkey, int type, void *data);
128
133{
134 size_t index;
135 struct HashElem *last;
136};
137
138struct HashElem *mutt_hash_walk(const struct HashTable *table, struct HashWalkState *state);
139
140#endif /* MUTT_MUTT_HASH_H */
uint8_t HashFlags
Flags for mutt_hash_new(), e.g. MUTT_HASH_STRCASECMP.
Definition: hash.h:109
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
void mutt_hash_delete(struct HashTable *table, const char *strkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:427
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
int(* hash_cmp_key_t)(union HashKey a, union HashKey b)
Definition: hash.h:90
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 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_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
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
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_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:75
void(* hash_hdata_free_t)(int type, void *obj, intptr_t data)
Definition: hash.h:62
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
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
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:98
hash_gen_hash_t gen_hash
Function to generate hash id from the key.
Definition: hash.h:103
struct HashElem ** table
Array of Hash keys.
Definition: hash.h:102
hash_cmp_key_t cmp_key
Function to compare two Hash keys.
Definition: hash.h:104
bool allow_dups
if set, duplicate keys are allowed
Definition: hash.h:101
size_t num_elems
Number of buckets in the Hash Table.
Definition: hash.h:99
bool strdup_keys
if set, the key->strkey is strdup()'d
Definition: hash.h:100
intptr_t hdata
Data to pass to the hdata_free() function.
Definition: hash.h:105
hash_hdata_free_t hdata_free
Function to free a Hash element.
Definition: hash.h:106
Cursor to iterate through a Hash Table.
Definition: hash.h:133
size_t index
Current position in table.
Definition: hash.h:134
struct HashElem * last
Current element in linked list.
Definition: hash.h:135
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