2014-10-14 02:16:28 +08:00
|
|
|
#ifndef TRAILER_H
|
|
|
|
#define TRAILER_H
|
|
|
|
|
2017-08-01 17:03:31 +08:00
|
|
|
#include "list.h"
|
|
|
|
|
2017-07-24 16:22:43 +08:00
|
|
|
enum trailer_where {
|
2017-08-01 17:03:32 +08:00
|
|
|
WHERE_DEFAULT,
|
2017-07-24 16:22:43 +08:00
|
|
|
WHERE_END,
|
|
|
|
WHERE_AFTER,
|
|
|
|
WHERE_BEFORE,
|
|
|
|
WHERE_START
|
|
|
|
};
|
|
|
|
enum trailer_if_exists {
|
2017-08-01 17:03:32 +08:00
|
|
|
EXISTS_DEFAULT,
|
2017-07-24 16:22:43 +08:00
|
|
|
EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
|
|
|
|
EXISTS_ADD_IF_DIFFERENT,
|
|
|
|
EXISTS_ADD,
|
|
|
|
EXISTS_REPLACE,
|
|
|
|
EXISTS_DO_NOTHING
|
|
|
|
};
|
|
|
|
enum trailer_if_missing {
|
2017-08-01 17:03:32 +08:00
|
|
|
MISSING_DEFAULT,
|
2017-07-24 16:22:43 +08:00
|
|
|
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);
|
|
|
|
|
2016-11-03 01:29:19 +08:00
|
|
|
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;
|
|
|
|
};
|
|
|
|
|
2017-08-01 17:03:31 +08:00
|
|
|
/*
|
|
|
|
* 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;
|
2017-08-01 17:03:32 +08:00
|
|
|
|
|
|
|
enum trailer_where where;
|
|
|
|
enum trailer_if_exists if_exists;
|
|
|
|
enum trailer_if_missing if_missing;
|
2017-08-01 17:03:31 +08:00
|
|
|
};
|
|
|
|
|
2017-08-11 02:03:58 +08:00
|
|
|
struct process_trailer_options {
|
|
|
|
int in_place;
|
|
|
|
int trim_empty;
|
2017-08-15 18:23:21 +08:00
|
|
|
int only_trailers;
|
2017-08-15 18:23:25 +08:00
|
|
|
int only_input;
|
2017-08-15 18:23:29 +08:00
|
|
|
int unfold;
|
2017-08-11 02:03:58 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
#define PROCESS_TRAILER_OPTIONS_INIT {0}
|
|
|
|
|
|
|
|
void process_trailers(const char *file,
|
|
|
|
const struct process_trailer_options *opts,
|
2017-08-01 17:03:31 +08:00
|
|
|
struct list_head *new_trailer_head);
|
2014-10-14 02:16:28 +08:00
|
|
|
|
2016-11-03 01:29:19 +08:00
|
|
|
void trailer_info_get(struct trailer_info *info, const char *str);
|
|
|
|
|
|
|
|
void trailer_info_release(struct trailer_info *info);
|
|
|
|
|
2017-08-15 18:23:56 +08:00
|
|
|
/*
|
|
|
|
* 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);
|
|
|
|
|
2014-10-14 02:16:28 +08:00
|
|
|
#endif /* TRAILER_H */
|