Fifth batch for 2.19 cycle
[git/git.git] / trailer.h
CommitLineData
b1d78d77
CC
1#ifndef TRAILER_H
2#define TRAILER_H
3
51166b87
PB
4#include "list.h"
5
52fc319d 6enum trailer_where {
0ea5292e 7 WHERE_DEFAULT,
52fc319d
PB
8 WHERE_END,
9 WHERE_AFTER,
10 WHERE_BEFORE,
11 WHERE_START
12};
13enum trailer_if_exists {
0ea5292e 14 EXISTS_DEFAULT,
52fc319d
PB
15 EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
16 EXISTS_ADD_IF_DIFFERENT,
17 EXISTS_ADD,
18 EXISTS_REPLACE,
19 EXISTS_DO_NOTHING
20};
21enum trailer_if_missing {
0ea5292e 22 MISSING_DEFAULT,
52fc319d
PB
23 MISSING_ADD,
24 MISSING_DO_NOTHING
25};
26
27int trailer_set_where(enum trailer_where *item, const char *value);
28int trailer_set_if_exists(enum trailer_if_exists *item, const char *value);
29int trailer_set_if_missing(enum trailer_if_missing *item, const char *value);
30
e8c352c3
JT
31struct trailer_info {
32 /*
33 * True if there is a blank line before the location pointed to by
34 * trailer_start.
35 */
36 int blank_line_before_trailer;
37
38 /*
39 * Pointers to the start and end of the trailer block found. If there
40 * is no trailer block found, these 2 pointers point to the end of the
41 * input string.
42 */
43 const char *trailer_start, *trailer_end;
44
45 /*
46 * Array of trailers found.
47 */
48 char **trailers;
49 size_t trailer_nr;
50};
51
51166b87
PB
52/*
53 * A list that represents newly-added trailers, such as those provided
54 * with the --trailer command line option of git-interpret-trailers.
55 */
56struct new_trailer_item {
57 struct list_head list;
58
59 const char *text;
0ea5292e
PB
60
61 enum trailer_where where;
62 enum trailer_if_exists if_exists;
63 enum trailer_if_missing if_missing;
51166b87
PB
64};
65
8abc8980
JK
66struct process_trailer_options {
67 int in_place;
68 int trim_empty;
56c493ed 69 int only_trailers;
fdbdb64f 70 int only_input;
00002396 71 int unfold;
8abc8980
JK
72};
73
74#define PROCESS_TRAILER_OPTIONS_INIT {0}
75
76void process_trailers(const char *file,
77 const struct process_trailer_options *opts,
51166b87 78 struct list_head *new_trailer_head);
b1d78d77 79
e8c352c3
JT
80void trailer_info_get(struct trailer_info *info, const char *str);
81
82void trailer_info_release(struct trailer_info *info);
83
a388b10f
JK
84/*
85 * Format the trailers from the commit msg "msg" into the strbuf "out".
86 * Note two caveats about "opts":
87 *
88 * - this is primarily a helper for pretty.c, and not
89 * all of the flags are supported.
90 *
91 * - this differs from process_trailers slightly in that we always format
92 * only the trailer block itself, even if the "only_trailers" option is not
93 * set.
94 */
95void format_trailers_from_commit(struct strbuf *out, const char *msg,
96 const struct process_trailer_options *opts);
97
b1d78d77 98#endif /* TRAILER_H */