2014-10-13 18:16:28 +00:00
|
|
|
#ifndef TRAILER_H
|
|
|
|
#define TRAILER_H
|
|
|
|
|
2017-08-01 09:03:31 +00:00
|
|
|
#include "list.h"
|
2020-09-27 08:40:01 +00:00
|
|
|
#include "strbuf.h"
|
2018-08-15 17:54:05 +00:00
|
|
|
|
2017-07-24 08:22:43 +00:00
|
|
|
enum trailer_where {
|
2017-08-01 09:03:32 +00:00
|
|
|
WHERE_DEFAULT,
|
2017-07-24 08:22:43 +00:00
|
|
|
WHERE_END,
|
|
|
|
WHERE_AFTER,
|
|
|
|
WHERE_BEFORE,
|
|
|
|
WHERE_START
|
|
|
|
};
|
|
|
|
enum trailer_if_exists {
|
2017-08-01 09:03:32 +00:00
|
|
|
EXISTS_DEFAULT,
|
2017-07-24 08:22:43 +00:00
|
|
|
EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
|
|
|
|
EXISTS_ADD_IF_DIFFERENT,
|
|
|
|
EXISTS_ADD,
|
|
|
|
EXISTS_REPLACE,
|
|
|
|
EXISTS_DO_NOTHING
|
|
|
|
};
|
|
|
|
enum trailer_if_missing {
|
2017-08-01 09:03:32 +00:00
|
|
|
MISSING_DEFAULT,
|
2017-07-24 08:22:43 +00: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-02 17:29:19 +00:00
|
|
|
struct trailer_info {
|
|
|
|
/*
|
|
|
|
* True if there is a blank line before the location pointed to by
|
2023-10-20 19:01:35 +00:00
|
|
|
* trailer_block_start.
|
2016-11-02 17:29:19 +00:00
|
|
|
*/
|
|
|
|
int blank_line_before_trailer;
|
|
|
|
|
|
|
|
/*
|
2023-10-20 19:01:35 +00:00
|
|
|
* Offsets to the trailer block start and end positions in the input
|
|
|
|
* string. If no trailer block is found, these are both set to the
|
|
|
|
* "true" end of the input (find_end_of_log_message()).
|
2016-11-02 17:29:19 +00:00
|
|
|
*/
|
2023-10-20 19:01:35 +00:00
|
|
|
size_t trailer_block_start, trailer_block_end;
|
2016-11-02 17:29:19 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Array of trailers found.
|
|
|
|
*/
|
|
|
|
char **trailers;
|
|
|
|
size_t trailer_nr;
|
|
|
|
};
|
|
|
|
|
2017-08-01 09:03:31 +00: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 09:03:32 +00:00
|
|
|
|
|
|
|
enum trailer_where where;
|
|
|
|
enum trailer_if_exists if_exists;
|
|
|
|
enum trailer_if_missing if_missing;
|
2017-08-01 09:03:31 +00:00
|
|
|
};
|
|
|
|
|
2017-08-10 18:03:58 +00:00
|
|
|
struct process_trailer_options {
|
|
|
|
int in_place;
|
|
|
|
int trim_empty;
|
2017-08-15 10:23:21 +00:00
|
|
|
int only_trailers;
|
2017-08-15 10:23:25 +00:00
|
|
|
int only_input;
|
2017-08-15 10:23:29 +00:00
|
|
|
int unfold;
|
2018-08-23 00:49:56 +00:00
|
|
|
int no_divider;
|
2020-12-09 15:52:07 +00:00
|
|
|
int key_only;
|
2019-01-28 21:33:35 +00:00
|
|
|
int value_only;
|
2019-01-28 21:33:37 +00:00
|
|
|
const struct strbuf *separator;
|
2020-12-09 15:52:08 +00:00
|
|
|
const struct strbuf *key_value_separator;
|
2019-01-28 21:33:34 +00:00
|
|
|
int (*filter)(const struct strbuf *, void *);
|
|
|
|
void *filter_data;
|
2017-08-10 18:03:58 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#define PROCESS_TRAILER_OPTIONS_INIT {0}
|
|
|
|
|
2024-03-01 00:14:41 +00:00
|
|
|
void parse_trailers_from_config(struct list_head *config_head);
|
|
|
|
|
|
|
|
void parse_trailers_from_command_line_args(struct list_head *arg_head,
|
|
|
|
struct list_head *new_trailer_head);
|
|
|
|
|
|
|
|
void process_trailers_lists(struct list_head *head,
|
|
|
|
struct list_head *arg_head);
|
|
|
|
|
|
|
|
void parse_trailers(const struct process_trailer_options *,
|
|
|
|
struct trailer_info *,
|
|
|
|
const char *str,
|
|
|
|
struct list_head *head);
|
2014-10-13 18:16:28 +00:00
|
|
|
|
2024-03-01 00:14:43 +00:00
|
|
|
void trailer_info_get(const struct process_trailer_options *,
|
|
|
|
const char *str,
|
|
|
|
struct trailer_info *);
|
2016-11-02 17:29:19 +00:00
|
|
|
|
|
|
|
void trailer_info_release(struct trailer_info *info);
|
|
|
|
|
2024-03-01 00:14:41 +00:00
|
|
|
void trailer_config_init(void);
|
2024-03-15 06:55:05 +00:00
|
|
|
void format_trailers(const struct process_trailer_options *,
|
2024-03-01 00:14:44 +00:00
|
|
|
struct list_head *trailers,
|
|
|
|
struct strbuf *out);
|
2024-03-01 00:14:41 +00:00
|
|
|
void free_trailers(struct list_head *);
|
|
|
|
|
2017-08-15 10:23:56 +00:00
|
|
|
/*
|
2024-03-15 06:55:05 +00:00
|
|
|
* Convenience function to format the trailers from the commit msg "msg" into
|
|
|
|
* the strbuf "out". Reuses format_trailers() internally.
|
2017-08-15 10:23:56 +00:00
|
|
|
*/
|
2024-03-15 06:55:05 +00:00
|
|
|
void format_trailers_from_commit(const struct process_trailer_options *,
|
trailer: reorder format_trailers_from_commit() parameters
Currently there are two functions for formatting trailers in
<trailer.h>:
void format_trailers(const struct process_trailer_options *,
struct list_head *trailers, FILE *outfile);
void format_trailers_from_commit(struct strbuf *out, const char *msg,
const struct process_trailer_options *opts);
and although they are similar enough (even taking the same
process_trailer_options struct pointer) they are used quite differently.
One might intuitively think that format_trailers_from_commit() builds on
top of format_trailers(), but this is not the case. Instead
format_trailers_from_commit() calls format_trailer_info() and
format_trailers() is never called in that codepath.
This is a preparatory refactor to help us deprecate format_trailers() in
favor of format_trailer_info() (at which point we can rename the latter
to the former). When the deprecation is complete, both
format_trailers_from_commit(), and the interpret-trailers builtin will
be able to call into the same helper function (instead of
format_trailers() and format_trailer_info(), respectively). Unifying the
formatters is desirable because it simplifies the API.
Reorder parameters for format_trailers_from_commit() to prefer
const struct process_trailer_options *opts
as the first parameter, because these options are intimately tied to
formatting trailers. And take
struct strbuf *out
last, because it's an "out parameter" (something that the caller wants
to use as the output of this function).
Similarly, reorder parameters for format_trailer_info(), because later
on we will unify the two together.
Signed-off-by: Linus Arver <linusa@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-03-01 00:14:42 +00:00
|
|
|
const char *msg,
|
|
|
|
struct strbuf *out);
|
2017-08-15 10:23:56 +00:00
|
|
|
|
2020-09-27 08:40:01 +00:00
|
|
|
/*
|
|
|
|
* An interface for iterating over the trailers found in a particular commit
|
|
|
|
* message. Use like:
|
|
|
|
*
|
|
|
|
* struct trailer_iterator iter;
|
|
|
|
* trailer_iterator_init(&iter, msg);
|
|
|
|
* while (trailer_iterator_advance(&iter))
|
|
|
|
* ... do something with iter.key and iter.val ...
|
|
|
|
* trailer_iterator_release(&iter);
|
|
|
|
*/
|
|
|
|
struct trailer_iterator {
|
|
|
|
struct strbuf key;
|
|
|
|
struct strbuf val;
|
|
|
|
|
|
|
|
/* private */
|
2023-09-09 06:16:12 +00:00
|
|
|
struct {
|
|
|
|
struct trailer_info info;
|
|
|
|
size_t cur;
|
|
|
|
} internal;
|
2020-09-27 08:40:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Initialize "iter" in preparation for walking over the trailers in the commit
|
|
|
|
* message "msg". The "msg" pointer must remain valid until the iterator is
|
|
|
|
* released.
|
|
|
|
*
|
|
|
|
* After initializing, note that key/val will not yet point to any trailer.
|
|
|
|
* Call advance() to parse the first one (if any).
|
|
|
|
*/
|
|
|
|
void trailer_iterator_init(struct trailer_iterator *iter, const char *msg);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Advance to the next trailer of the iterator. Returns 0 if there is no such
|
|
|
|
* trailer, and 1 otherwise. The key and value of the trailer can be
|
|
|
|
* fetched from the iter->key and iter->value fields (which are valid
|
|
|
|
* only until the next advance).
|
|
|
|
*/
|
|
|
|
int trailer_iterator_advance(struct trailer_iterator *iter);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Release all resources associated with the trailer iteration.
|
|
|
|
*/
|
|
|
|
void trailer_iterator_release(struct trailer_iterator *iter);
|
|
|
|
|
2014-10-13 18:16:28 +00:00
|
|
|
#endif /* TRAILER_H */
|