Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 1 | #ifndef COMMIT_SLAB_H |
| 2 | #define COMMIT_SLAB_H |
| 3 | |
Nguyễn Thái Ngọc Duy | a9f1f1f | 2018-05-19 07:28:17 +0200 | [diff] [blame] | 4 | #include "commit-slab-decl.h" |
| 5 | #include "commit-slab-impl.h" |
| 6 | |
Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 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 | * |
Ville Skyttä | 2e3a16b | 2016-08-09 11:53:38 +0300 | [diff] [blame] | 14 | * define_commit_slab(indegree, int); |
Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 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 |
Junio C Hamano | 862e730 | 2015-05-14 15:25:52 -0700 | [diff] [blame] | 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 | * until a call to indegree_at() was made for the commit. |
Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 28 | * |
| 29 | * - void init_indegree(struct indegree *); |
| 30 | * void init_indegree_with_stride(struct indegree *, int); |
| 31 | * |
| 32 | * Initializes the indegree slab that associates an array of integers |
| 33 | * to each commit. 'stride' specifies how big each array is. The slab |
Thomas Rast | dcbbc8f | 2013-11-25 20:02:00 +0100 | [diff] [blame] | 34 | * that is initialized by the variant without "_with_stride" associates |
Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 35 | * each commit with an array of one integer. |
Thomas Rast | dcbbc8f | 2013-11-25 20:02:00 +0100 | [diff] [blame] | 36 | * |
| 37 | * - void clear_indegree(struct indegree *); |
| 38 | * |
| 39 | * Empties the slab. The slab can be reused with the same stride |
| 40 | * without calling init_indegree() again or can be reconfigured to a |
| 41 | * different stride by calling init_indegree_with_stride(). |
| 42 | * |
| 43 | * Call this function before the slab falls out of scope to avoid |
| 44 | * leaking memory. |
Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 45 | */ |
| 46 | |
Nguyễn Thái Ngọc Duy | a9f1f1f | 2018-05-19 07:28:17 +0200 | [diff] [blame] | 47 | #define define_commit_slab(slabname, elemtype) \ |
| 48 | declare_commit_slab(slabname, elemtype); \ |
Nguyễn Thái Ngọc Duy | 878f0bb | 2018-05-19 07:28:18 +0200 | [diff] [blame] | 49 | implement_static_commit_slab(slabname, elemtype) |
Jeff King | 80cdaba | 2014-06-10 17:42:51 -0400 | [diff] [blame] | 50 | |
Junio C Hamano | a84b794 | 2013-04-13 11:56:41 -0700 | [diff] [blame] | 51 | #endif /* COMMIT_SLAB_H */ |