blob: 064fd7143aad33424714de671f08238bdd463190 [file] [log] [blame]
Johannes Schindelina97a7462009-10-09 12:21:57 +02001#ifndef NOTES_H
2#define NOTES_H
3
Jeff King304cc112011-03-29 16:56:53 -04004#include "string-list.h"
5
Elijah Newrenef3ca952018-08-15 10:54:05 -07006struct object_id;
7struct strbuf;
8
Johan Herland709f79b2010-02-13 22:28:12 +01009/*
Johan Herland73f464b2010-02-13 22:28:19 +010010 * Function type for combining two notes annotating the same object.
11 *
12 * When adding a new note annotating the same object as an existing note, it is
13 * up to the caller to decide how to combine the two notes. The decision is
14 * made by passing in a function of the following form. The function accepts
Patryk Obarab7d591d2018-01-28 01:13:17 +010015 * two object_ids -- of the existing note and the new note, respectively. The
Johan Herland73f464b2010-02-13 22:28:19 +010016 * function then combines the notes in whatever way it sees fit, and writes the
Patryk Obarab7d591d2018-01-28 01:13:17 +010017 * resulting oid into the first argument (cur_oid). A non-zero return
Johan Herland73f464b2010-02-13 22:28:19 +010018 * value indicates failure.
19 *
Patryk Obarab7d591d2018-01-28 01:13:17 +010020 * The two given object_ids shall both be non-NULL and different from each
21 * other. Either of them (but not both) may be == null_oid, which indicates an
22 * empty/non-existent note. If the resulting oid (cur_oid) is == null_oid,
Johan Herlande2656c82010-11-09 22:49:41 +010023 * the note will be removed from the notes tree.
Johan Herland73f464b2010-02-13 22:28:19 +010024 *
25 * The default combine_notes function (you get this when passing NULL) is
26 * combine_notes_concatenate(), which appends the contents of the new note to
27 * the contents of the existing note.
28 */
Patryk Obarab7d591d2018-01-28 01:13:17 +010029typedef int (*combine_notes_fn)(struct object_id *cur_oid,
30 const struct object_id *new_oid);
Johan Herland73f464b2010-02-13 22:28:19 +010031
32/* Common notes combinators */
Patryk Obarab7d591d2018-01-28 01:13:17 +010033int combine_notes_concatenate(struct object_id *cur_oid,
34 const struct object_id *new_oid);
35int combine_notes_overwrite(struct object_id *cur_oid,
36 const struct object_id *new_oid);
37int combine_notes_ignore(struct object_id *cur_oid,
38 const struct object_id *new_oid);
39int combine_notes_cat_sort_uniq(struct object_id *cur_oid,
40 const struct object_id *new_oid);
Johan Herland73f464b2010-02-13 22:28:19 +010041
42/*
Johan Herlandcd305392010-02-13 22:28:18 +010043 * Notes tree object
44 *
45 * Encapsulates the internal notes tree structure associated with a notes ref.
46 * Whenever a struct notes_tree pointer is required below, you may pass NULL in
47 * order to use the default/internal notes tree. E.g. you only need to pass a
48 * non-NULL value if you need to refer to several different notes trees
49 * simultaneously.
50 */
51extern struct notes_tree {
52 struct int_node *root;
Johan Herland851c2b32010-02-13 22:28:23 +010053 struct non_note *first_non_note, *prev_non_note;
Johan Herlandcd305392010-02-13 22:28:18 +010054 char *ref;
Mike Hommeyee76f922015-10-08 11:54:43 +090055 char *update_ref;
Ramsay Jones4e0d7a82010-06-23 20:40:19 +010056 combine_notes_fn combine_notes;
Johan Herlandcd305392010-02-13 22:28:18 +010057 int initialized;
Thomas Rast7f710ea2010-03-12 18:04:36 +010058 int dirty;
Johan Herlandcd305392010-02-13 22:28:18 +010059} default_notes_tree;
60
61/*
Johan Herland4a9cf1c2010-11-09 22:49:39 +010062 * Return the default notes ref.
63 *
64 * The default notes ref is the notes ref that is used when notes_ref == NULL
65 * is passed to init_notes().
66 *
67 * This the first of the following to be defined:
68 * 1. The '--ref' option to 'git notes', if given
69 * 2. The $GIT_NOTES_REF environment variable, if set
70 * 3. The value of the core.notesRef config variable, if set
71 * 4. GIT_NOTES_DEFAULT_REF (i.e. "refs/notes/commits")
72 */
73const char *default_notes_ref(void);
74
75/*
Johan Herland709f79b2010-02-13 22:28:12 +010076 * Flags controlling behaviour of notes tree initialization
77 *
78 * Default behaviour is to initialize the notes tree from the tree object
79 * specified by the given (or default) notes ref.
80 */
81#define NOTES_INIT_EMPTY 1
82
83/*
Mike Hommeyee76f922015-10-08 11:54:43 +090084 * By default, the notes tree is only readable, and the notes ref can be
85 * any treeish. The notes tree can however be made writable with this flag,
86 * in which case only strict ref names can be used.
87 */
88#define NOTES_INIT_WRITABLE 2
89
90/*
Johan Herlandcd305392010-02-13 22:28:18 +010091 * Initialize the given notes_tree with the notes tree structure at the given
Johan Herland709f79b2010-02-13 22:28:12 +010092 * ref. If given ref is NULL, the value of the $GIT_NOTES_REF environment
93 * variable is used, and if that is missing, the default notes ref is used
94 * ("refs/notes/commits").
95 *
Ondřej Bílka98e023d2013-07-29 10:18:21 +020096 * If you need to re-initialize a notes_tree structure (e.g. when switching from
Johan Herlandcd305392010-02-13 22:28:18 +010097 * one notes ref to another), you must first de-initialize the notes_tree
98 * structure by calling free_notes(struct notes_tree *).
99 *
100 * If you pass t == NULL, the default internal notes_tree will be initialized.
101 *
Johan Herland73f464b2010-02-13 22:28:19 +0100102 * The combine_notes function that is passed becomes the default combine_notes
103 * function for the given notes_tree. If NULL is passed, the default
104 * combine_notes function is combine_notes_concatenate().
105 *
Johan Herlandcd305392010-02-13 22:28:18 +0100106 * Precondition: The notes_tree structure is zeroed (this can be achieved with
107 * memset(t, 0, sizeof(struct notes_tree)))
Johan Herland709f79b2010-02-13 22:28:12 +0100108 */
Johan Herland73f464b2010-02-13 22:28:19 +0100109void init_notes(struct notes_tree *t, const char *notes_ref,
110 combine_notes_fn combine_notes, int flags);
Johan Herland709f79b2010-02-13 22:28:12 +0100111
Johan Herland61a7cca2010-02-13 22:28:17 +0100112/*
Johan Herlandcd305392010-02-13 22:28:18 +0100113 * Add the given note object to the given notes_tree structure
Johan Herland61a7cca2010-02-13 22:28:17 +0100114 *
Johan Herlande2656c82010-11-09 22:49:41 +0100115 * If there already exists a note for the given object_sha1, the given
116 * combine_notes function is invoked to break the tie. If not given (i.e.
117 * combine_notes == NULL), the default combine_notes function for the given
118 * notes_tree is used.
119 *
120 * Passing note_sha1 == null_sha1 indicates the addition of an
121 * empty/non-existent note. This is a (potentially expensive) no-op unless
122 * there already exists a note for the given object_sha1, AND combining that
123 * note with the empty note (using the given combine_notes function) results
124 * in a new/changed note.
125 *
Johan Herland180619a2010-11-15 00:52:26 +0100126 * Returns zero on success; non-zero means combine_notes failed.
127 *
Johan Herlandcd305392010-02-13 22:28:18 +0100128 * IMPORTANT: The changes made by add_note() to the given notes_tree structure
Johan Herland61a7cca2010-02-13 22:28:17 +0100129 * are not persistent until a subsequent call to write_notes_tree() returns
130 * zero.
131 */
brian m. carlson5ee8a952017-05-30 10:30:43 -0700132int add_note(struct notes_tree *t, const struct object_id *object_oid,
133 const struct object_id *note_oid, combine_notes_fn combine_notes);
Johan Herland2626b532010-02-13 22:28:13 +0100134
Johan Herland61a7cca2010-02-13 22:28:17 +0100135/*
Johan Herlandcd305392010-02-13 22:28:18 +0100136 * Remove the given note object from the given notes_tree structure
Johan Herland61a7cca2010-02-13 22:28:17 +0100137 *
Johan Herlandcd305392010-02-13 22:28:18 +0100138 * IMPORTANT: The changes made by remove_note() to the given notes_tree
Johan Herland61a7cca2010-02-13 22:28:17 +0100139 * structure are not persistent until a subsequent call to write_notes_tree()
140 * returns zero.
Johan Herland1ee1e432010-08-31 17:56:50 +0200141 *
142 * Return 0 if a note was removed; 1 if there was no note to remove.
Johan Herland61a7cca2010-02-13 22:28:17 +0100143 */
Johan Herland1ee1e432010-08-31 17:56:50 +0200144int remove_note(struct notes_tree *t, const unsigned char *object_sha1);
Johan Herland1ec666b2010-02-13 22:28:14 +0100145
Johan Herland9b391f22010-02-13 22:28:15 +0100146/*
147 * Get the note object SHA1 containing the note data for the given object
148 *
149 * Return NULL if the given object has no notes.
150 */
brian m. carlson9ef72232017-05-30 10:30:40 -0700151const struct object_id *get_note(struct notes_tree *t,
brian m. carlson5ee8a952017-05-30 10:30:43 -0700152 const struct object_id *object_oid);
Johan Herland9b391f22010-02-13 22:28:15 +0100153
Johan Herland73f77b92010-02-13 22:28:16 +0100154/*
Thomas Rast160baa02010-03-12 18:04:31 +0100155 * Copy a note from one object to another in the given notes_tree.
156 *
Johan Herland180619a2010-11-15 00:52:26 +0100157 * Returns 1 if the to_obj already has a note and 'force' is false. Otherwise,
158 * returns non-zero if 'force' is true, but the given combine_notes function
159 * failed to combine from_obj's note with to_obj's existing note.
160 * Returns zero on success.
Johan Herland55d06072010-11-09 22:49:38 +0100161 *
162 * IMPORTANT: The changes made by copy_note() to the given notes_tree structure
163 * are not persistent until a subsequent call to write_notes_tree() returns
164 * zero.
Thomas Rast160baa02010-03-12 18:04:31 +0100165 */
166int copy_note(struct notes_tree *t,
brian m. carlson5ee8a952017-05-30 10:30:43 -0700167 const struct object_id *from_obj, const struct object_id *to_obj,
Johan Herland180619a2010-11-15 00:52:26 +0100168 int force, combine_notes_fn combine_notes);
Thomas Rast160baa02010-03-12 18:04:31 +0100169
170/*
Johan Herland73f77b92010-02-13 22:28:16 +0100171 * Flags controlling behaviour of for_each_note()
172 *
173 * Default behaviour of for_each_note() is to traverse every single note object
Johan Herlandcd305392010-02-13 22:28:18 +0100174 * in the given notes tree, unpacking subtree entries along the way.
Johan Herland73f77b92010-02-13 22:28:16 +0100175 * The following flags can be used to alter the default behaviour:
176 *
177 * - DONT_UNPACK_SUBTREES causes for_each_note() NOT to unpack and recurse into
178 * subtree entries while traversing the notes tree. This causes notes within
179 * those subtrees NOT to be passed to the callback. Use this flag if you
180 * don't want to traverse _all_ notes, but only want to traverse the parts
181 * of the notes tree that have already been unpacked (this includes at least
182 * all notes that have been added/changed).
183 *
184 * - YIELD_SUBTREES causes any subtree entries that are encountered to be
185 * passed to the callback, before recursing into them. Subtree entries are
186 * not note objects, but represent intermediate directories in the notes
187 * tree. When passed to the callback, subtree entries will have a trailing
188 * slash in their path, which the callback may use to differentiate between
189 * note entries and subtree entries. Note that already-unpacked subtree
190 * entries are not part of the notes tree, and will therefore not be yielded.
191 * If this flag is used together with DONT_UNPACK_SUBTREES, for_each_note()
192 * will yield the subtree entry, but not recurse into it.
193 */
194#define FOR_EACH_NOTE_DONT_UNPACK_SUBTREES 1
195#define FOR_EACH_NOTE_YIELD_SUBTREES 2
196
197/*
Johan Herlandcd305392010-02-13 22:28:18 +0100198 * Invoke the specified callback function for each note in the given notes_tree
Johan Herland73f77b92010-02-13 22:28:16 +0100199 *
200 * If the callback returns nonzero, the note walk is aborted, and the return
201 * value from the callback is returned from for_each_note(). Hence, a zero
202 * return value from for_each_note() indicates that all notes were walked
203 * successfully.
204 *
205 * IMPORTANT: The callback function is NOT allowed to change the notes tree.
206 * In other words, the following functions can NOT be invoked (on the current
207 * notes tree) from within the callback:
208 * - add_note()
209 * - remove_note()
Johan Herland55d06072010-11-09 22:49:38 +0100210 * - copy_note()
Johan Herland73f77b92010-02-13 22:28:16 +0100211 * - free_notes()
212 */
brian m. carlson490bc832017-05-30 10:30:39 -0700213typedef int each_note_fn(const struct object_id *object_oid,
214 const struct object_id *note_oid, char *note_path,
Johan Herland73f77b92010-02-13 22:28:16 +0100215 void *cb_data);
Johan Herlandcd305392010-02-13 22:28:18 +0100216int for_each_note(struct notes_tree *t, int flags, each_note_fn fn,
217 void *cb_data);
Johan Herland73f77b92010-02-13 22:28:16 +0100218
Johan Herland61a7cca2010-02-13 22:28:17 +0100219/*
Johan Herlandcd305392010-02-13 22:28:18 +0100220 * Write the given notes_tree structure to the object database
Johan Herland61a7cca2010-02-13 22:28:17 +0100221 *
Johan Herlandcd305392010-02-13 22:28:18 +0100222 * Creates a new tree object encapsulating the current state of the given
Patryk Obarabbca96d2018-01-28 01:13:18 +0100223 * notes_tree, and stores its object id into the 'result' argument.
Johan Herland61a7cca2010-02-13 22:28:17 +0100224 *
225 * Returns zero on success, non-zero on failure.
226 *
Johan Herlandcd305392010-02-13 22:28:18 +0100227 * IMPORTANT: Changes made to the given notes_tree are not persistent until
228 * this function has returned zero. Please also remember to create a
229 * corresponding commit object, and update the appropriate notes ref.
Johan Herland61a7cca2010-02-13 22:28:17 +0100230 */
Patryk Obarabbca96d2018-01-28 01:13:18 +0100231int write_notes_tree(struct notes_tree *t, struct object_id *result);
Johan Herland61a7cca2010-02-13 22:28:17 +0100232
Michael J Grubera9f2adf2010-05-14 23:42:07 +0200233/* Flags controlling the operation of prune */
234#define NOTES_PRUNE_VERBOSE 1
235#define NOTES_PRUNE_DRYRUN 2
Johan Herland61a7cca2010-02-13 22:28:17 +0100236/*
Johan Herland00fbe632010-02-13 22:28:27 +0100237 * Remove all notes annotating non-existing objects from the given notes tree
238 *
239 * All notes in the given notes_tree that are associated with objects that no
240 * longer exist in the database, are removed from the notes tree.
241 *
242 * IMPORTANT: The changes made by prune_notes() to the given notes_tree
243 * structure are not persistent until a subsequent call to write_notes_tree()
244 * returns zero.
245 */
Michael J Grubera9f2adf2010-05-14 23:42:07 +0200246void prune_notes(struct notes_tree *t, int flags);
Johan Herland00fbe632010-02-13 22:28:27 +0100247
248/*
Johan Herlandcd305392010-02-13 22:28:18 +0100249 * Free (and de-initialize) the given notes_tree structure
Johan Herland61a7cca2010-02-13 22:28:17 +0100250 *
Johan Herlandcd305392010-02-13 22:28:18 +0100251 * IMPORTANT: Changes made to the given notes_tree since the last, successful
Johan Herland61a7cca2010-02-13 22:28:17 +0100252 * call to write_notes_tree() will be lost.
253 */
Johan Herlandcd305392010-02-13 22:28:18 +0100254void free_notes(struct notes_tree *t);
Johan Herland27d57562009-10-09 12:22:06 +0200255
Thomas Rast894a9d32010-03-12 18:04:26 +0100256struct string_list;
257
258struct display_notes_opt {
Kristoffer Haugsbakkaeee1402023-06-05 12:05:23 +0200259 /*
260 * Less than `0` is "unset", which means that the default notes
261 * are shown iff no other notes are given. Otherwise,
262 * treat it like a boolean.
263 */
Jeff King3a03cf62011-03-29 16:57:27 -0400264 int use_default_notes;
Kristoffer Haugsbakkaeee1402023-06-05 12:05:23 +0200265
266 /*
267 * A list of globs (in the same style as notes.displayRef) where
268 * notes should be loaded from.
269 */
Jeff King304cc112011-03-29 16:56:53 -0400270 struct string_list extra_notes_refs;
Thomas Rast894a9d32010-03-12 18:04:26 +0100271};
272
273/*
Denton Liue6e230e2019-12-09 05:10:41 -0800274 * Initialize a display_notes_opt to its default value.
275 */
276void init_display_notes(struct display_notes_opt *opt);
277
278/*
Denton Liu1d729752019-12-11 16:49:50 -0800279 * This family of functions enables or disables the display of notes. In
280 * particular, 'enable_default_display_notes' will display the default notes,
Denton Liue0f90952019-12-18 10:17:43 -0800281 * 'enable_ref_display_notes' will display the notes ref 'ref' and
Denton Liu1d729752019-12-11 16:49:50 -0800282 * 'disable_display_notes' will disable notes, including those added by previous
283 * invocations of the 'enable_*_display_notes' functions.
Denton Liu452538c2019-12-09 05:10:44 -0800284 *
Denton Liue0f90952019-12-18 10:17:43 -0800285 * 'show_notes' is a pointer to a boolean which will be set to 1 if notes are
Denton Liu1d729752019-12-11 16:49:50 -0800286 * displayed, else 0. It must not be NULL.
Denton Liu452538c2019-12-09 05:10:44 -0800287 */
Denton Liu1d729752019-12-11 16:49:50 -0800288void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes);
289void enable_ref_display_notes(struct display_notes_opt *opt, int *show_notes,
290 const char *ref);
291void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
Denton Liu452538c2019-12-09 05:10:44 -0800292
293/*
Thomas Rast894a9d32010-03-12 18:04:26 +0100294 * Load the notes machinery for displaying several notes trees.
295 *
Kristoffer Haugsbakkaeee1402023-06-05 12:05:23 +0200296 * 'opt' may be NULL.
Thomas Rast894a9d32010-03-12 18:04:26 +0100297 */
Denton Liu1e6ed542019-12-09 05:10:39 -0800298void load_display_notes(struct display_notes_opt *opt);
Thomas Rast894a9d32010-03-12 18:04:26 +0100299
300/*
301 * Append notes for the given 'object_sha1' from all trees set up by
Junio C Hamano17066be2019-12-25 11:21:58 -0800302 * load_display_notes() to 'sb'.
Thomas Rast894a9d32010-03-12 18:04:26 +0100303 *
Chris Mayod4907722019-05-04 19:45:07 +0100304 * If 'raw' is false the note will be indented by 4 places and
305 * a 'Notes (refname):' header added.
Thomas Rast894a9d32010-03-12 18:04:26 +0100306 *
Denton Liu1e6ed542019-12-09 05:10:39 -0800307 * You *must* call load_display_notes() before using this function.
Thomas Rast894a9d32010-03-12 18:04:26 +0100308 */
brian m. carlsonfb61e4d2017-05-30 10:30:41 -0700309void format_display_notes(const struct object_id *object_oid,
Junio C Hamano76141e22012-10-17 21:41:54 -0700310 struct strbuf *sb, const char *output_encoding, int raw);
Thomas Rast894a9d32010-03-12 18:04:26 +0100311
312/*
313 * Load the notes tree from each ref listed in 'refs'. The output is
314 * an array of notes_tree*, terminated by a NULL.
315 */
Mike Hommeyee76f922015-10-08 11:54:43 +0900316struct notes_tree **load_notes_trees(struct string_list *refs, int flags);
Thomas Rast894a9d32010-03-12 18:04:26 +0100317
318/*
319 * Add all refs that match 'glob' to the 'list'.
320 */
321void string_list_add_refs_by_glob(struct string_list *list, const char *glob);
322
323/*
324 * Add all refs from a colon-separated glob list 'globs' to the end of
325 * 'list'. Empty components are ignored. This helper is used to
326 * parse GIT_NOTES_DISPLAY_REF style environment variables.
327 */
328void string_list_add_refs_from_colon_sep(struct string_list *list,
329 const char *globs);
330
Jeff King03bb5782011-03-29 16:55:32 -0400331/* Expand inplace a note ref like "foo" or "notes/foo" into "refs/notes/foo" */
332void expand_notes_ref(struct strbuf *sb);
333
Jacob Kellerb3715b72015-12-29 14:40:28 -0800334/*
335 * Similar to expand_notes_ref, but will check whether the ref can be located
336 * via get_sha1 first, and only falls back to expand_notes_ref in the case
337 * where get_sha1 fails.
338 */
339void expand_loose_notes_ref(struct strbuf *sb);
340
Johannes Schindelina97a7462009-10-09 12:21:57 +0200341#endif