freshlybakedca.ke
Git fork
1#ifndef OIDSET_H
2#define OIDSET_H
3
4#include "khash.h"
5
6/**
7 * This API is similar to oid-array, in that it maintains a set of object ids
8 * in a memory-efficient way. The major differences are:
9 *
10 * 1. It uses a hash, so we can do online duplicate removal, rather than
11 * sort-and-uniq at the end. This can reduce memory footprint if you have
12 * a large list of oids with many duplicates.
13 *
14 * 2. The per-unique-oid memory footprint is slightly higher due to hash
15 * table overhead.
16 */
17
18/**
19 * A single oidset; should be zero-initialized (or use OIDSET_INIT).
20 */
21struct oidset {
22 kh_oid_set_t set;
23};
24
25#define OIDSET_INIT { { 0 } }
26
27
28/**
29 * Initialize the oidset structure `set`.
30 *
31 * If `initial_size` is bigger than 0 then preallocate to allow inserting
32 * the specified number of elements without further allocations.
33 */
34void oidset_init(struct oidset *set, size_t initial_size);
35
36/**
37 * Returns true iff `set` contains `oid`.
38 */
39int oidset_contains(const struct oidset *set, const struct object_id *oid);
40
41/**
42 * Insert the oid into the set; a copy is made, so "oid" does not need
43 * to persist after this function is called.
44 *
45 * Returns 1 if the oid was already in the set, 0 otherwise. This can be used
46 * to perform an efficient check-and-add.
47 */
48int oidset_insert(struct oidset *set, const struct object_id *oid);
49
50/**
51 * Insert all the oids that are in set 'src' into set 'dest'; a copy
52 * is made of each oid inserted into set 'dest'.
53 */
54void oidset_insert_from_set(struct oidset *dest, struct oidset *src);
55
56/**
57 * Remove the oid from the set.
58 *
59 * Returns 1 if the oid was present in the set, 0 otherwise.
60 */
61int oidset_remove(struct oidset *set, const struct object_id *oid);
62
63/**
64 * Returns the number of oids in the set.
65 */
66static inline int oidset_size(const struct oidset *set)
67{
68 return kh_size(&set->set);
69}
70
71/**
72 * Remove all entries from the oidset, freeing any resources associated with
73 * it.
74 */
75void oidset_clear(struct oidset *set);
76
77/**
78 * Add the contents of the file 'path' to an initialized oidset. Each line is
79 * an unabbreviated object name. Comments begin with '#', and trailing comments
80 * are allowed. Leading whitespace and empty or white-space only lines are
81 * ignored.
82 */
83void oidset_parse_file(struct oidset *set, const char *path,
84 const struct git_hash_algo *algop);
85
86/*
87 * Similar to the above, but with a callback which can (1) return non-zero to
88 * signal displeasure with the object and (2) replace object ID with something
89 * else (meant to be used to "peel").
90 */
91typedef int (*oidset_parse_tweak_fn)(struct object_id *, void *);
92void oidset_parse_file_carefully(struct oidset *set, const char *path,
93 const struct git_hash_algo *algop,
94 oidset_parse_tweak_fn fn, void *cbdata);
95
96struct oidset_iter {
97 kh_oid_set_t *set;
98 khiter_t iter;
99};
100
101static inline void oidset_iter_init(struct oidset *set,
102 struct oidset_iter *iter)
103{
104 iter->set = &set->set;
105 iter->iter = kh_begin(iter->set);
106}
107
108static inline struct object_id *oidset_iter_next(struct oidset_iter *iter)
109{
110 for (; iter->iter != kh_end(iter->set); iter->iter++) {
111 if (kh_exist(iter->set, iter->iter))
112 return &kh_key(iter->set, iter->iter++);
113 }
114 return NULL;
115}
116
117static inline struct object_id *oidset_iter_first(struct oidset *set,
118 struct oidset_iter *iter)
119{
120 oidset_iter_init(set, iter);
121 return oidset_iter_next(iter);
122}
123
124#endif /* OIDSET_H */