Merge branch 'tb/commit-graph-split-strategy'
[git] / commit-slab.h
1 #ifndef COMMIT_SLAB_H
2 #define COMMIT_SLAB_H
3
4 #include "commit-slab-decl.h"
5 #include "commit-slab-impl.h"
6
7 /*
8  * define_commit_slab(slabname, elemtype) creates boilerplate code to define
9  * a new struct (struct slabname) that is used to associate a piece of data
10  * of elemtype to commits, and a few functions to use that struct.
11  *
12  * After including this header file, using:
13  *
14  * define_commit_slab(indegree, int);
15  *
16  * will let you call the following functions:
17  *
18  * - int *indegree_at(struct indegree *, struct commit *);
19  *
20  *   This function locates the data associated with the given commit in
21  *   the indegree slab, and returns the pointer to it.  The location to
22  *   store the data is allocated as necessary.
23  *
24  * - int *indegree_peek(struct indegree *, struct commit *);
25  *
26  *   This function is similar to indegree_at(), but it will return NULL
27  *   if the location to store the data associated with the given commit
28  *   has not been allocated yet.
29  *   Note that the location to store the data might have already been
30  *   allocated even if no indegree_at() call has been made for that commit
31  *   yet; in this case this function returns a pointer to a
32  *   zero-initialized location.
33  *
34  * - void init_indegree(struct indegree *);
35  *   void init_indegree_with_stride(struct indegree *, int);
36  *
37  *   Initializes the indegree slab that associates an array of integers
38  *   to each commit. 'stride' specifies how big each array is.  The slab
39  *   that is initialized by the variant without "_with_stride" associates
40  *   each commit with an array of one integer.
41  *
42  * - void clear_indegree(struct indegree *);
43  *
44  *   Empties the slab.  The slab can be reused with the same stride
45  *   without calling init_indegree() again or can be reconfigured to a
46  *   different stride by calling init_indegree_with_stride().
47  *
48  *   Call this function before the slab falls out of scope to avoid
49  *   leaking memory.
50  */
51
52 #define define_commit_slab(slabname, elemtype) \
53         declare_commit_slab(slabname, elemtype); \
54         implement_static_commit_slab(slabname, elemtype)
55
56 #endif /* COMMIT_SLAB_H */