2009-10-09 12:21:57 +02:00
|
|
|
#ifndef NOTES_H
|
|
|
|
#define NOTES_H
|
|
|
|
|
2010-02-13 22:28:18 +01:00
|
|
|
/*
|
|
|
|
* Notes tree object
|
|
|
|
*
|
|
|
|
* Encapsulates the internal notes tree structure associated with a notes ref.
|
|
|
|
* Whenever a struct notes_tree pointer is required below, you may pass NULL in
|
|
|
|
* order to use the default/internal notes tree. E.g. you only need to pass a
|
|
|
|
* non-NULL value if you need to refer to several different notes trees
|
|
|
|
* simultaneously.
|
|
|
|
*/
|
|
|
|
extern struct notes_tree {
|
|
|
|
struct int_node *root;
|
|
|
|
char *ref;
|
|
|
|
int initialized;
|
|
|
|
} default_notes_tree;
|
|
|
|
|
2010-02-13 22:28:12 +01:00
|
|
|
/*
|
|
|
|
* Flags controlling behaviour of notes tree initialization
|
|
|
|
*
|
|
|
|
* Default behaviour is to initialize the notes tree from the tree object
|
|
|
|
* specified by the given (or default) notes ref.
|
|
|
|
*/
|
|
|
|
#define NOTES_INIT_EMPTY 1
|
|
|
|
|
|
|
|
/*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Initialize the given notes_tree with the notes tree structure at the given
|
2010-02-13 22:28:12 +01:00
|
|
|
* ref. If given ref is NULL, the value of the $GIT_NOTES_REF environment
|
|
|
|
* variable is used, and if that is missing, the default notes ref is used
|
|
|
|
* ("refs/notes/commits").
|
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* If you need to re-intialize a notes_tree structure (e.g. when switching from
|
|
|
|
* one notes ref to another), you must first de-initialize the notes_tree
|
|
|
|
* structure by calling free_notes(struct notes_tree *).
|
|
|
|
*
|
|
|
|
* If you pass t == NULL, the default internal notes_tree will be initialized.
|
|
|
|
*
|
|
|
|
* Precondition: The notes_tree structure is zeroed (this can be achieved with
|
|
|
|
* memset(t, 0, sizeof(struct notes_tree)))
|
2010-02-13 22:28:12 +01:00
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
void init_notes(struct notes_tree *t, const char *notes_ref, int flags);
|
2010-02-13 22:28:12 +01:00
|
|
|
|
2010-02-13 22:28:17 +01:00
|
|
|
/*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Add the given note object to the given notes_tree structure
|
2010-02-13 22:28:17 +01:00
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* IMPORTANT: The changes made by add_note() to the given notes_tree structure
|
2010-02-13 22:28:17 +01:00
|
|
|
* are not persistent until a subsequent call to write_notes_tree() returns
|
|
|
|
* zero.
|
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
void add_note(struct notes_tree *t, const unsigned char *object_sha1,
|
2010-02-13 22:28:13 +01:00
|
|
|
const unsigned char *note_sha1);
|
|
|
|
|
2010-02-13 22:28:17 +01:00
|
|
|
/*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Remove the given note object from the given notes_tree structure
|
2010-02-13 22:28:17 +01:00
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* IMPORTANT: The changes made by remove_note() to the given notes_tree
|
2010-02-13 22:28:17 +01:00
|
|
|
* structure are not persistent until a subsequent call to write_notes_tree()
|
|
|
|
* returns zero.
|
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
void remove_note(struct notes_tree *t, const unsigned char *object_sha1);
|
2010-02-13 22:28:14 +01:00
|
|
|
|
2010-02-13 22:28:15 +01:00
|
|
|
/*
|
|
|
|
* Get the note object SHA1 containing the note data for the given object
|
|
|
|
*
|
|
|
|
* Return NULL if the given object has no notes.
|
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
const unsigned char *get_note(struct notes_tree *t,
|
|
|
|
const unsigned char *object_sha1);
|
2010-02-13 22:28:15 +01:00
|
|
|
|
2010-02-13 22:28:16 +01:00
|
|
|
/*
|
|
|
|
* Flags controlling behaviour of for_each_note()
|
|
|
|
*
|
|
|
|
* Default behaviour of for_each_note() is to traverse every single note object
|
2010-02-13 22:28:18 +01:00
|
|
|
* in the given notes tree, unpacking subtree entries along the way.
|
2010-02-13 22:28:16 +01:00
|
|
|
* The following flags can be used to alter the default behaviour:
|
|
|
|
*
|
|
|
|
* - DONT_UNPACK_SUBTREES causes for_each_note() NOT to unpack and recurse into
|
|
|
|
* subtree entries while traversing the notes tree. This causes notes within
|
|
|
|
* those subtrees NOT to be passed to the callback. Use this flag if you
|
|
|
|
* don't want to traverse _all_ notes, but only want to traverse the parts
|
|
|
|
* of the notes tree that have already been unpacked (this includes at least
|
|
|
|
* all notes that have been added/changed).
|
|
|
|
*
|
|
|
|
* - YIELD_SUBTREES causes any subtree entries that are encountered to be
|
|
|
|
* passed to the callback, before recursing into them. Subtree entries are
|
|
|
|
* not note objects, but represent intermediate directories in the notes
|
|
|
|
* tree. When passed to the callback, subtree entries will have a trailing
|
|
|
|
* slash in their path, which the callback may use to differentiate between
|
|
|
|
* note entries and subtree entries. Note that already-unpacked subtree
|
|
|
|
* entries are not part of the notes tree, and will therefore not be yielded.
|
|
|
|
* If this flag is used together with DONT_UNPACK_SUBTREES, for_each_note()
|
|
|
|
* will yield the subtree entry, but not recurse into it.
|
|
|
|
*/
|
|
|
|
#define FOR_EACH_NOTE_DONT_UNPACK_SUBTREES 1
|
|
|
|
#define FOR_EACH_NOTE_YIELD_SUBTREES 2
|
|
|
|
|
|
|
|
/*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Invoke the specified callback function for each note in the given notes_tree
|
2010-02-13 22:28:16 +01:00
|
|
|
*
|
|
|
|
* If the callback returns nonzero, the note walk is aborted, and the return
|
|
|
|
* value from the callback is returned from for_each_note(). Hence, a zero
|
|
|
|
* return value from for_each_note() indicates that all notes were walked
|
|
|
|
* successfully.
|
|
|
|
*
|
|
|
|
* IMPORTANT: The callback function is NOT allowed to change the notes tree.
|
|
|
|
* In other words, the following functions can NOT be invoked (on the current
|
|
|
|
* notes tree) from within the callback:
|
|
|
|
* - add_note()
|
|
|
|
* - remove_note()
|
|
|
|
* - free_notes()
|
|
|
|
*/
|
|
|
|
typedef int each_note_fn(const unsigned char *object_sha1,
|
|
|
|
const unsigned char *note_sha1, char *note_path,
|
|
|
|
void *cb_data);
|
2010-02-13 22:28:18 +01:00
|
|
|
int for_each_note(struct notes_tree *t, int flags, each_note_fn fn,
|
|
|
|
void *cb_data);
|
2010-02-13 22:28:16 +01:00
|
|
|
|
2010-02-13 22:28:17 +01:00
|
|
|
/*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Write the given notes_tree structure to the object database
|
2010-02-13 22:28:17 +01:00
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Creates a new tree object encapsulating the current state of the given
|
|
|
|
* notes_tree, and stores its SHA1 into the 'result' argument.
|
2010-02-13 22:28:17 +01:00
|
|
|
*
|
|
|
|
* Returns zero on success, non-zero on failure.
|
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* IMPORTANT: Changes made to the given notes_tree are not persistent until
|
|
|
|
* this function has returned zero. Please also remember to create a
|
|
|
|
* corresponding commit object, and update the appropriate notes ref.
|
2010-02-13 22:28:17 +01:00
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
int write_notes_tree(struct notes_tree *t, unsigned char *result);
|
2010-02-13 22:28:17 +01:00
|
|
|
|
|
|
|
/*
|
2010-02-13 22:28:18 +01:00
|
|
|
* Free (and de-initialize) the given notes_tree structure
|
2010-02-13 22:28:17 +01:00
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* IMPORTANT: Changes made to the given notes_tree since the last, successful
|
2010-02-13 22:28:17 +01:00
|
|
|
* call to write_notes_tree() will be lost.
|
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
void free_notes(struct notes_tree *t);
|
2009-10-09 12:22:06 +02:00
|
|
|
|
2010-02-13 22:28:10 +01:00
|
|
|
/* Flags controlling how notes are formatted */
|
2009-10-09 12:22:04 +02:00
|
|
|
#define NOTES_SHOW_HEADER 1
|
|
|
|
#define NOTES_INDENT 2
|
|
|
|
|
2010-02-13 22:28:10 +01:00
|
|
|
/*
|
|
|
|
* Fill the given strbuf with the notes associated with the given object.
|
|
|
|
*
|
2010-02-13 22:28:18 +01:00
|
|
|
* If the given notes_tree structure is not initialized, it will be auto-
|
2010-02-13 22:28:10 +01:00
|
|
|
* initialized to the default value (see documentation for init_notes() above).
|
2010-02-13 22:28:18 +01:00
|
|
|
* If the given notes_tree is NULL, the internal/default notes_tree will be
|
|
|
|
* used instead.
|
2010-02-13 22:28:10 +01:00
|
|
|
*
|
|
|
|
* 'flags' is a bitwise combination of the above formatting flags.
|
|
|
|
*/
|
2010-02-13 22:28:18 +01:00
|
|
|
void format_note(struct notes_tree *t, const unsigned char *object_sha1,
|
|
|
|
struct strbuf *sb, const char *output_encoding, int flags);
|
2009-10-09 12:21:57 +02:00
|
|
|
|
|
|
|
#endif
|