The eleventh (aka "ort") batch
[git.git] / trailer.h
blob795d2fccfd9579500b798ac667feef2ee549f4b4
1 #ifndef TRAILER_H
2 #define TRAILER_H
4 #include "list.h"
5 #include "strbuf.h"
7 enum trailer_where {
8 WHERE_DEFAULT,
9 WHERE_END,
10 WHERE_AFTER,
11 WHERE_BEFORE,
12 WHERE_START
14 enum trailer_if_exists {
15 EXISTS_DEFAULT,
16 EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
17 EXISTS_ADD_IF_DIFFERENT,
18 EXISTS_ADD,
19 EXISTS_REPLACE,
20 EXISTS_DO_NOTHING
22 enum trailer_if_missing {
23 MISSING_DEFAULT,
24 MISSING_ADD,
25 MISSING_DO_NOTHING
28 int trailer_set_where(enum trailer_where *item, const char *value);
29 int trailer_set_if_exists(enum trailer_if_exists *item, const char *value);
30 int trailer_set_if_missing(enum trailer_if_missing *item, const char *value);
32 struct trailer_info {
34 * True if there is a blank line before the location pointed to by
35 * trailer_start.
37 int blank_line_before_trailer;
40 * Pointers to the start and end of the trailer block found. If there
41 * is no trailer block found, these 2 pointers point to the end of the
42 * input string.
44 const char *trailer_start, *trailer_end;
47 * Array of trailers found.
49 char **trailers;
50 size_t trailer_nr;
54 * A list that represents newly-added trailers, such as those provided
55 * with the --trailer command line option of git-interpret-trailers.
57 struct new_trailer_item {
58 struct list_head list;
60 const char *text;
62 enum trailer_where where;
63 enum trailer_if_exists if_exists;
64 enum trailer_if_missing if_missing;
67 struct process_trailer_options {
68 int in_place;
69 int trim_empty;
70 int only_trailers;
71 int only_input;
72 int unfold;
73 int no_divider;
74 int key_only;
75 int value_only;
76 const struct strbuf *separator;
77 const struct strbuf *key_value_separator;
78 int (*filter)(const struct strbuf *, void *);
79 void *filter_data;
82 #define PROCESS_TRAILER_OPTIONS_INIT {0}
84 void process_trailers(const char *file,
85 const struct process_trailer_options *opts,
86 struct list_head *new_trailer_head);
88 void trailer_info_get(struct trailer_info *info, const char *str,
89 const struct process_trailer_options *opts);
91 void trailer_info_release(struct trailer_info *info);
94 * Format the trailers from the commit msg "msg" into the strbuf "out".
95 * Note two caveats about "opts":
97 * - this is primarily a helper for pretty.c, and not
98 * all of the flags are supported.
100 * - this differs from process_trailers slightly in that we always format
101 * only the trailer block itself, even if the "only_trailers" option is not
102 * set.
104 void format_trailers_from_commit(struct strbuf *out, const char *msg,
105 const struct process_trailer_options *opts);
108 * An interface for iterating over the trailers found in a particular commit
109 * message. Use like:
111 * struct trailer_iterator iter;
112 * trailer_iterator_init(&iter, msg);
113 * while (trailer_iterator_advance(&iter))
114 * ... do something with iter.key and iter.val ...
115 * trailer_iterator_release(&iter);
117 struct trailer_iterator {
118 struct strbuf key;
119 struct strbuf val;
121 /* private */
122 struct trailer_info info;
123 size_t cur;
127 * Initialize "iter" in preparation for walking over the trailers in the commit
128 * message "msg". The "msg" pointer must remain valid until the iterator is
129 * released.
131 * After initializing, note that key/val will not yet point to any trailer.
132 * Call advance() to parse the first one (if any).
134 void trailer_iterator_init(struct trailer_iterator *iter, const char *msg);
137 * Advance to the next trailer of the iterator. Returns 0 if there is no such
138 * trailer, and 1 otherwise. The key and value of the trailer can be
139 * fetched from the iter->key and iter->value fields (which are valid
140 * only until the next advance).
142 int trailer_iterator_advance(struct trailer_iterator *iter);
145 * Release all resources associated with the trailer iteration.
147 void trailer_iterator_release(struct trailer_iterator *iter);
149 #endif /* TRAILER_H */