freshlybakedca.ke
Git fork
1#ifndef NOTES_H
2#define NOTES_H
3
4#include "string-list.h"
5
6struct object_id;
7struct repository;
8struct strbuf;
9
10/*
11 * Function type for combining two notes annotating the same object.
12 *
13 * When adding a new note annotating the same object as an existing note, it is
14 * up to the caller to decide how to combine the two notes. The decision is
15 * made by passing in a function of the following form. The function accepts
16 * two object_ids -- of the existing note and the new note, respectively. The
17 * function then combines the notes in whatever way it sees fit, and writes the
18 * resulting oid into the first argument (cur_oid). A non-zero return
19 * value indicates failure.
20 *
21 * The two given object_ids shall both be non-NULL and different from each
22 * other. Either of them (but not both) may be == null_oid, which indicates an
23 * empty/non-existent note. If the resulting oid (cur_oid) is == null_oid,
24 * the note will be removed from the notes tree.
25 *
26 * The default combine_notes function (you get this when passing NULL) is
27 * combine_notes_concatenate(), which appends the contents of the new note to
28 * the contents of the existing note.
29 */
30typedef int (*combine_notes_fn)(struct object_id *cur_oid,
31 const struct object_id *new_oid);
32
33/* Common notes combinators */
34int combine_notes_concatenate(struct object_id *cur_oid,
35 const struct object_id *new_oid);
36int combine_notes_overwrite(struct object_id *cur_oid,
37 const struct object_id *new_oid);
38int combine_notes_ignore(struct object_id *cur_oid,
39 const struct object_id *new_oid);
40int combine_notes_cat_sort_uniq(struct object_id *cur_oid,
41 const struct object_id *new_oid);
42
43/*
44 * Notes tree object
45 *
46 * Encapsulates the internal notes tree structure associated with a notes ref.
47 * Whenever a struct notes_tree pointer is required below, you may pass NULL in
48 * order to use the default/internal notes tree. E.g. you only need to pass a
49 * non-NULL value if you need to refer to several different notes trees
50 * simultaneously.
51 */
52extern struct notes_tree {
53 struct int_node *root;
54 struct non_note *first_non_note, *prev_non_note;
55 char *ref;
56 char *update_ref;
57 combine_notes_fn combine_notes;
58 int initialized;
59 int dirty;
60} default_notes_tree;
61
62/*
63 * Return the default notes ref.
64 *
65 * The default notes ref is the notes ref that is used when notes_ref == NULL
66 * is passed to init_notes().
67 *
68 * This the first of the following to be defined:
69 * 1. The '--ref' option to 'git notes', if given
70 * 2. The $GIT_NOTES_REF environment variable, if set
71 * 3. The value of the core.notesRef config variable, if set
72 * 4. GIT_NOTES_DEFAULT_REF (i.e. "refs/notes/commits")
73 */
74char *default_notes_ref(struct repository *repo);
75
76/*
77 * Flags controlling behaviour of notes tree initialization
78 *
79 * Default behaviour is to initialize the notes tree from the tree object
80 * specified by the given (or default) notes ref.
81 */
82#define NOTES_INIT_EMPTY 1
83
84/*
85 * By default, the notes tree is only readable, and the notes ref can be
86 * any treeish. The notes tree can however be made writable with this flag,
87 * in which case only strict ref names can be used.
88 */
89#define NOTES_INIT_WRITABLE 2
90
91/*
92 * Initialize the given notes_tree with the notes tree structure at the given
93 * ref. If given ref is NULL, the value of the $GIT_NOTES_REF environment
94 * variable is used, and if that is missing, the default notes ref is used
95 * ("refs/notes/commits").
96 *
97 * If you need to re-initialize a notes_tree structure (e.g. when switching from
98 * one notes ref to another), you must first de-initialize the notes_tree
99 * structure by calling free_notes(struct notes_tree *).
100 *
101 * If you pass t == NULL, the default internal notes_tree will be initialized.
102 *
103 * The combine_notes function that is passed becomes the default combine_notes
104 * function for the given notes_tree. If NULL is passed, the default
105 * combine_notes function is combine_notes_concatenate().
106 *
107 * Precondition: The notes_tree structure is zeroed (this can be achieved with
108 * memset(t, 0, sizeof(struct notes_tree)))
109 */
110void init_notes(struct notes_tree *t, const char *notes_ref,
111 combine_notes_fn combine_notes, int flags);
112
113/*
114 * Add the given note object to the given notes_tree structure
115 *
116 * If there already exists a note for the given object_sha1, the given
117 * combine_notes function is invoked to break the tie. If not given (i.e.
118 * combine_notes == NULL), the default combine_notes function for the given
119 * notes_tree is used.
120 *
121 * Passing note_sha1 == null_sha1 indicates the addition of an
122 * empty/non-existent note. This is a (potentially expensive) no-op unless
123 * there already exists a note for the given object_sha1, AND combining that
124 * note with the empty note (using the given combine_notes function) results
125 * in a new/changed note.
126 *
127 * Returns zero on success; non-zero means combine_notes failed.
128 *
129 * IMPORTANT: The changes made by add_note() to the given notes_tree structure
130 * are not persistent until a subsequent call to write_notes_tree() returns
131 * zero.
132 */
133int add_note(struct notes_tree *t, const struct object_id *object_oid,
134 const struct object_id *note_oid, combine_notes_fn combine_notes);
135
136/*
137 * Remove the given note object from the given notes_tree structure
138 *
139 * IMPORTANT: The changes made by remove_note() to the given notes_tree
140 * structure are not persistent until a subsequent call to write_notes_tree()
141 * returns zero.
142 *
143 * Return 0 if a note was removed; 1 if there was no note to remove.
144 */
145int remove_note(struct notes_tree *t, const unsigned char *object_sha1);
146
147/*
148 * Get the note object SHA1 containing the note data for the given object
149 *
150 * Return NULL if the given object has no notes.
151 */
152const struct object_id *get_note(struct notes_tree *t,
153 const struct object_id *object_oid);
154
155/*
156 * Copy a note from one object to another in the given notes_tree.
157 *
158 * Returns 1 if the to_obj already has a note and 'force' is false. Otherwise,
159 * returns non-zero if 'force' is true, but the given combine_notes function
160 * failed to combine from_obj's note with to_obj's existing note.
161 * Returns zero on success.
162 *
163 * IMPORTANT: The changes made by copy_note() to the given notes_tree structure
164 * are not persistent until a subsequent call to write_notes_tree() returns
165 * zero.
166 */
167int copy_note(struct notes_tree *t,
168 const struct object_id *from_obj, const struct object_id *to_obj,
169 int force, combine_notes_fn combine_notes);
170
171/*
172 * Flags controlling behaviour of for_each_note()
173 *
174 * Default behaviour of for_each_note() is to traverse every single note object
175 * in the given notes tree, unpacking subtree entries along the way.
176 * The following flags can be used to alter the default behaviour:
177 *
178 * - DONT_UNPACK_SUBTREES causes for_each_note() NOT to unpack and recurse into
179 * subtree entries while traversing the notes tree. This causes notes within
180 * those subtrees NOT to be passed to the callback. Use this flag if you
181 * don't want to traverse _all_ notes, but only want to traverse the parts
182 * of the notes tree that have already been unpacked (this includes at least
183 * all notes that have been added/changed).
184 *
185 * - YIELD_SUBTREES causes any subtree entries that are encountered to be
186 * passed to the callback, before recursing into them. Subtree entries are
187 * not note objects, but represent intermediate directories in the notes
188 * tree. When passed to the callback, subtree entries will have a trailing
189 * slash in their path, which the callback may use to differentiate between
190 * note entries and subtree entries. Note that already-unpacked subtree
191 * entries are not part of the notes tree, and will therefore not be yielded.
192 * If this flag is used together with DONT_UNPACK_SUBTREES, for_each_note()
193 * will yield the subtree entry, but not recurse into it.
194 */
195#define FOR_EACH_NOTE_DONT_UNPACK_SUBTREES 1
196#define FOR_EACH_NOTE_YIELD_SUBTREES 2
197
198/*
199 * Invoke the specified callback function for each note in the given notes_tree
200 *
201 * If the callback returns nonzero, the note walk is aborted, and the return
202 * value from the callback is returned from for_each_note(). Hence, a zero
203 * return value from for_each_note() indicates that all notes were walked
204 * successfully.
205 *
206 * IMPORTANT: The callback function is NOT allowed to change the notes tree.
207 * In other words, the following functions can NOT be invoked (on the current
208 * notes tree) from within the callback:
209 * - add_note()
210 * - remove_note()
211 * - copy_note()
212 * - free_notes()
213 */
214typedef int each_note_fn(const struct object_id *object_oid,
215 const struct object_id *note_oid, char *note_path,
216 void *cb_data);
217int for_each_note(struct notes_tree *t, int flags, each_note_fn fn,
218 void *cb_data);
219
220/*
221 * Write the given notes_tree structure to the object database
222 *
223 * Creates a new tree object encapsulating the current state of the given
224 * notes_tree, and stores its object id into the 'result' argument.
225 *
226 * Returns zero on success, non-zero on failure.
227 *
228 * IMPORTANT: Changes made to the given notes_tree are not persistent until
229 * this function has returned zero. Please also remember to create a
230 * corresponding commit object, and update the appropriate notes ref.
231 */
232int write_notes_tree(struct notes_tree *t, struct object_id *result);
233
234/* Flags controlling the operation of prune */
235#define NOTES_PRUNE_VERBOSE 1
236#define NOTES_PRUNE_DRYRUN 2
237/*
238 * Remove all notes annotating non-existing objects from the given notes tree
239 *
240 * All notes in the given notes_tree that are associated with objects that no
241 * longer exist in the database, are removed from the notes tree.
242 *
243 * IMPORTANT: The changes made by prune_notes() to the given notes_tree
244 * structure are not persistent until a subsequent call to write_notes_tree()
245 * returns zero.
246 */
247void prune_notes(struct notes_tree *t, int flags);
248
249/*
250 * Free (and de-initialize) the given notes_tree structure
251 *
252 * IMPORTANT: Changes made to the given notes_tree since the last, successful
253 * call to write_notes_tree() will be lost.
254 */
255void free_notes(struct notes_tree *t);
256
257struct string_list;
258
259struct display_notes_opt {
260 /*
261 * Less than `0` is "unset", which means that the default notes
262 * are shown iff no other notes are given. Otherwise,
263 * treat it like a boolean.
264 */
265 int use_default_notes;
266
267 /*
268 * A list of globs (in the same style as notes.displayRef) where
269 * notes should be loaded from.
270 */
271 struct string_list extra_notes_refs;
272};
273
274/*
275 * Initialize a display_notes_opt to its default value.
276 */
277void init_display_notes(struct display_notes_opt *opt);
278
279/*
280 * Release resources acquired by the display_notes_opt.
281 */
282void release_display_notes(struct display_notes_opt *opt);
283
284/*
285 * This family of functions enables or disables the display of notes. In
286 * particular, 'enable_default_display_notes' will display the default notes,
287 * 'enable_ref_display_notes' will display the notes ref 'ref' and
288 * 'disable_display_notes' will disable notes, including those added by previous
289 * invocations of the 'enable_*_display_notes' functions.
290 *
291 * 'show_notes' is a pointer to a boolean which will be set to 1 if notes are
292 * displayed, else 0. It must not be NULL.
293 */
294void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes);
295void enable_ref_display_notes(struct display_notes_opt *opt, int *show_notes,
296 const char *ref);
297void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
298
299/*
300 * Load the notes machinery for displaying several notes trees.
301 *
302 * 'opt' may be NULL.
303 */
304void load_display_notes(struct display_notes_opt *opt);
305
306/*
307 * Append notes for the given 'object_sha1' from all trees set up by
308 * load_display_notes() to 'sb'.
309 *
310 * If 'raw' is false the note will be indented by 4 places and
311 * a 'Notes (refname):' header added.
312 *
313 * You *must* call load_display_notes() before using this function.
314 */
315void format_display_notes(const struct object_id *object_oid,
316 struct strbuf *sb, const char *output_encoding, int raw);
317
318/*
319 * Load the notes tree from each ref listed in 'refs'. The output is
320 * an array of notes_tree*, terminated by a NULL.
321 */
322struct notes_tree **load_notes_trees(struct string_list *refs, int flags);
323
324/*
325 * Add all refs that match 'glob' to the 'list'.
326 */
327void string_list_add_refs_by_glob(struct string_list *list, const char *glob);
328
329/*
330 * Add all refs from a colon-separated glob list 'globs' to the end of
331 * 'list'. Empty components are ignored. This helper is used to
332 * parse GIT_NOTES_DISPLAY_REF style environment variables.
333 */
334void string_list_add_refs_from_colon_sep(struct string_list *list,
335 const char *globs);
336
337/* Expand inplace a note ref like "foo" or "notes/foo" into "refs/notes/foo" */
338void expand_notes_ref(struct strbuf *sb);
339
340/*
341 * Similar to expand_notes_ref, but will check whether the ref can be located
342 * via get_sha1 first, and only falls back to expand_notes_ref in the case
343 * where get_sha1 fails.
344 */
345void expand_loose_notes_ref(struct strbuf *sb);
346
347#endif