The third batch
[git.git] / oidmap.h
blob72430b611ebf710b4c3ba0160af91104258db138
1 #ifndef OIDMAP_H
2 #define OIDMAP_H
4 #include "cache.h"
5 #include "hashmap.h"
7 /*
8 * struct oidmap_entry is a structure representing an entry in the hash table,
9 * which must be used as first member of user data structures.
11 * Users should set the oid field. oidmap_put() will populate the
12 * internal_entry field.
14 struct oidmap_entry {
15 /* For internal use only */
16 struct hashmap_entry internal_entry;
18 struct object_id oid;
21 struct oidmap {
22 struct hashmap map;
25 #define OIDMAP_INIT { { NULL } }
28 * Initializes an oidmap structure.
30 * `map` is the oidmap to initialize.
32 * If the total number of entries is known in advance, the `initial_size`
33 * parameter may be used to preallocate a sufficiently large table and thus
34 * prevent expensive resizing. If 0, the table is dynamically resized.
36 extern void oidmap_init(struct oidmap *map, size_t initial_size);
39 * Frees an oidmap structure and allocated memory.
41 * If `free_entries` is true, each oidmap_entry in the map is freed as well
42 * using stdlibs free().
44 extern void oidmap_free(struct oidmap *map, int free_entries);
47 * Returns the oidmap entry for the specified oid, or NULL if not found.
49 extern void *oidmap_get(const struct oidmap *map,
50 const struct object_id *key);
53 * Adds or replaces an oidmap entry.
55 * ((struct oidmap_entry *) entry)->internal_entry will be populated by this
56 * function.
58 * Returns the replaced entry, or NULL if not found (i.e. the entry was added).
60 extern void *oidmap_put(struct oidmap *map, void *entry);
63 * Removes an oidmap entry matching the specified oid.
65 * Returns the removed entry, or NULL if not found.
67 extern void *oidmap_remove(struct oidmap *map, const struct object_id *key);
70 struct oidmap_iter {
71 struct hashmap_iter h_iter;
74 static inline void oidmap_iter_init(struct oidmap *map, struct oidmap_iter *iter)
76 hashmap_iter_init(&map->map, &iter->h_iter);
79 static inline void *oidmap_iter_next(struct oidmap_iter *iter)
81 return hashmap_iter_next(&iter->h_iter);
84 static inline void *oidmap_iter_first(struct oidmap *map,
85 struct oidmap_iter *iter)
87 oidmap_iter_init(map, iter);
88 return oidmap_iter_next(iter);
91 #endif