trailer.h 2.47 KB
Newer Older
1 2 3
#ifndef TRAILER_H
#define TRAILER_H

4 5
#include "list.h"

6 7
struct strbuf;

8
enum trailer_where {
9
	WHERE_DEFAULT,
10 11 12 13 14 15
	WHERE_END,
	WHERE_AFTER,
	WHERE_BEFORE,
	WHERE_START
};
enum trailer_if_exists {
16
	EXISTS_DEFAULT,
17 18 19 20 21 22 23
	EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
	EXISTS_ADD_IF_DIFFERENT,
	EXISTS_ADD,
	EXISTS_REPLACE,
	EXISTS_DO_NOTHING
};
enum trailer_if_missing {
24
	MISSING_DEFAULT,
25 26 27 28 29 30 31 32
	MISSING_ADD,
	MISSING_DO_NOTHING
};

int trailer_set_where(enum trailer_where *item, const char *value);
int trailer_set_if_exists(enum trailer_if_exists *item, const char *value);
int trailer_set_if_missing(enum trailer_if_missing *item, const char *value);

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
struct trailer_info {
	/*
	 * True if there is a blank line before the location pointed to by
	 * trailer_start.
	 */
	int blank_line_before_trailer;

	/*
	 * Pointers to the start and end of the trailer block found. If there
	 * is no trailer block found, these 2 pointers point to the end of the
	 * input string.
	 */
	const char *trailer_start, *trailer_end;

	/*
	 * Array of trailers found.
	 */
	char **trailers;
	size_t trailer_nr;
};

54 55 56 57 58 59 60 61
/*
 * A list that represents newly-added trailers, such as those provided
 * with the --trailer command line option of git-interpret-trailers.
 */
struct new_trailer_item {
	struct list_head list;

	const char *text;
62 63 64 65

	enum trailer_where where;
	enum trailer_if_exists if_exists;
	enum trailer_if_missing if_missing;
66 67
};

68 69 70
struct process_trailer_options {
	int in_place;
	int trim_empty;
71
	int only_trailers;
72
	int only_input;
73
	int unfold;
74
	int no_divider;
75
	int value_only;
76
	const struct strbuf *separator;
77 78
	int (*filter)(const struct strbuf *, void *);
	void *filter_data;
79 80 81 82 83 84
};

#define PROCESS_TRAILER_OPTIONS_INIT {0}

void process_trailers(const char *file,
		      const struct process_trailer_options *opts,
85
		      struct list_head *new_trailer_head);
86

87 88
void trailer_info_get(struct trailer_info *info, const char *str,
		      const struct process_trailer_options *opts);
89 90 91

void trailer_info_release(struct trailer_info *info);

92 93 94 95 96 97 98 99 100 101 102 103 104 105
/*
 * Format the trailers from the commit msg "msg" into the strbuf "out".
 * Note two caveats about "opts":
 *
 *   - this is primarily a helper for pretty.c, and not
 *     all of the flags are supported.
 *
 *   - this differs from process_trailers slightly in that we always format
 *     only the trailer block itself, even if the "only_trailers" option is not
 *     set.
 */
void format_trailers_from_commit(struct strbuf *out, const char *msg,
				 const struct process_trailer_options *opts);

106
#endif /* TRAILER_H */