trailer: use list.h for doubly-linked list

Replace the existing handwritten implementation of a doubly-linked list
in trailer.c with the functions and macros from list.h. This
significantly simplifies the code.

Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jonathan Tan
2016-10-20 14:39:47 -07:00
committed by Junio C Hamano
parent d65fd424ad
commit 8966a39483

256
trailer.c
View File

@ -4,6 +4,7 @@
#include "commit.h" #include "commit.h"
#include "tempfile.h" #include "tempfile.h"
#include "trailer.h" #include "trailer.h"
#include "list.h"
/* /*
* Copyright (c) 2013, 2014 Christian Couder <chriscool@tuxfamily.org> * Copyright (c) 2013, 2014 Christian Couder <chriscool@tuxfamily.org>
*/ */
@ -25,19 +26,24 @@ struct conf_info {
static struct conf_info default_conf_info; static struct conf_info default_conf_info;
struct trailer_item { struct trailer_item {
struct trailer_item *previous; struct list_head list;
struct trailer_item *next;
char *token; char *token;
char *value; char *value;
struct conf_info conf; struct conf_info conf;
}; };
static struct trailer_item *first_conf_item; static LIST_HEAD(conf_head);
static char *separators = ":"; static char *separators = ":";
#define TRAILER_ARG_STRING "$ARG" #define TRAILER_ARG_STRING "$ARG"
/* Iterate over the elements of the list. */
#define list_for_each_dir(pos, head, is_reverse) \
for (pos = is_reverse ? (head)->prev : (head)->next; \
pos != (head); \
pos = is_reverse ? pos->prev : pos->next)
static int after_or_end(enum action_where where) static int after_or_end(enum action_where where)
{ {
return (where == WHERE_AFTER) || (where == WHERE_END); return (where == WHERE_AFTER) || (where == WHERE_END);
@ -120,101 +126,49 @@ static void print_tok_val(FILE *outfile, const char *tok, const char *val)
fprintf(outfile, "%s%c %s\n", tok, separators[0], val); fprintf(outfile, "%s%c %s\n", tok, separators[0], val);
} }
static void print_all(FILE *outfile, struct trailer_item *first, int trim_empty) static void print_all(FILE *outfile, struct list_head *head, int trim_empty)
{ {
struct list_head *pos;
struct trailer_item *item; struct trailer_item *item;
for (item = first; item; item = item->next) { list_for_each(pos, head) {
item = list_entry(pos, struct trailer_item, list);
if (!trim_empty || strlen(item->value) > 0) if (!trim_empty || strlen(item->value) > 0)
print_tok_val(outfile, item->token, item->value); print_tok_val(outfile, item->token, item->value);
} }
} }
static void update_last(struct trailer_item **last)
{
if (*last)
while ((*last)->next != NULL)
*last = (*last)->next;
}
static void update_first(struct trailer_item **first)
{
if (*first)
while ((*first)->previous != NULL)
*first = (*first)->previous;
}
static void add_arg_to_input_list(struct trailer_item *on_tok, static void add_arg_to_input_list(struct trailer_item *on_tok,
struct trailer_item *arg_tok, struct trailer_item *arg_tok)
struct trailer_item **first,
struct trailer_item **last)
{ {
if (after_or_end(arg_tok->conf.where)) { if (after_or_end(arg_tok->conf.where))
arg_tok->next = on_tok->next; list_add(&arg_tok->list, &on_tok->list);
on_tok->next = arg_tok; else
arg_tok->previous = on_tok; list_add_tail(&arg_tok->list, &on_tok->list);
if (arg_tok->next)
arg_tok->next->previous = arg_tok;
update_last(last);
} else {
arg_tok->previous = on_tok->previous;
on_tok->previous = arg_tok;
arg_tok->next = on_tok;
if (arg_tok->previous)
arg_tok->previous->next = arg_tok;
update_first(first);
}
} }
static int check_if_different(struct trailer_item *in_tok, static int check_if_different(struct trailer_item *in_tok,
struct trailer_item *arg_tok, struct trailer_item *arg_tok,
int check_all) int check_all,
struct list_head *head)
{ {
enum action_where where = arg_tok->conf.where; enum action_where where = arg_tok->conf.where;
struct list_head *next_head;
do { do {
if (!in_tok)
return 1;
if (same_trailer(in_tok, arg_tok)) if (same_trailer(in_tok, arg_tok))
return 0; return 0;
/* /*
* if we want to add a trailer after another one, * if we want to add a trailer after another one,
* we have to check those before this one * we have to check those before this one
*/ */
in_tok = after_or_end(where) ? in_tok->previous : in_tok->next; next_head = after_or_end(where) ? in_tok->list.prev
: in_tok->list.next;
if (next_head == head)
break;
in_tok = list_entry(next_head, struct trailer_item, list);
} while (check_all); } while (check_all);
return 1; return 1;
} }
static void remove_from_list(struct trailer_item *item,
struct trailer_item **first,
struct trailer_item **last)
{
struct trailer_item *next = item->next;
struct trailer_item *previous = item->previous;
if (next) {
item->next->previous = previous;
item->next = NULL;
} else if (last)
*last = previous;
if (previous) {
item->previous->next = next;
item->previous = NULL;
} else if (first)
*first = next;
}
static struct trailer_item *remove_first(struct trailer_item **first)
{
struct trailer_item *item = *first;
*first = item->next;
if (item->next) {
item->next->previous = NULL;
item->next = NULL;
}
return item;
}
static char *apply_command(const char *command, const char *arg) static char *apply_command(const char *command, const char *arg)
{ {
struct strbuf cmd = STRBUF_INIT; struct strbuf cmd = STRBUF_INIT;
@ -266,8 +220,7 @@ static void apply_item_command(struct trailer_item *in_tok, struct trailer_item
static void apply_arg_if_exists(struct trailer_item *in_tok, static void apply_arg_if_exists(struct trailer_item *in_tok,
struct trailer_item *arg_tok, struct trailer_item *arg_tok,
struct trailer_item *on_tok, struct trailer_item *on_tok,
struct trailer_item **in_tok_first, struct list_head *head)
struct trailer_item **in_tok_last)
{ {
switch (arg_tok->conf.if_exists) { switch (arg_tok->conf.if_exists) {
case EXISTS_DO_NOTHING: case EXISTS_DO_NOTHING:
@ -275,40 +228,34 @@ static void apply_arg_if_exists(struct trailer_item *in_tok,
break; break;
case EXISTS_REPLACE: case EXISTS_REPLACE:
apply_item_command(in_tok, arg_tok); apply_item_command(in_tok, arg_tok);
add_arg_to_input_list(on_tok, arg_tok, add_arg_to_input_list(on_tok, arg_tok);
in_tok_first, in_tok_last); list_del(&in_tok->list);
remove_from_list(in_tok, in_tok_first, in_tok_last);
free_trailer_item(in_tok); free_trailer_item(in_tok);
break; break;
case EXISTS_ADD: case EXISTS_ADD:
apply_item_command(in_tok, arg_tok); apply_item_command(in_tok, arg_tok);
add_arg_to_input_list(on_tok, arg_tok, add_arg_to_input_list(on_tok, arg_tok);
in_tok_first, in_tok_last);
break; break;
case EXISTS_ADD_IF_DIFFERENT: case EXISTS_ADD_IF_DIFFERENT:
apply_item_command(in_tok, arg_tok); apply_item_command(in_tok, arg_tok);
if (check_if_different(in_tok, arg_tok, 1)) if (check_if_different(in_tok, arg_tok, 1, head))
add_arg_to_input_list(on_tok, arg_tok, add_arg_to_input_list(on_tok, arg_tok);
in_tok_first, in_tok_last);
else else
free_trailer_item(arg_tok); free_trailer_item(arg_tok);
break; break;
case EXISTS_ADD_IF_DIFFERENT_NEIGHBOR: case EXISTS_ADD_IF_DIFFERENT_NEIGHBOR:
apply_item_command(in_tok, arg_tok); apply_item_command(in_tok, arg_tok);
if (check_if_different(on_tok, arg_tok, 0)) if (check_if_different(on_tok, arg_tok, 0, head))
add_arg_to_input_list(on_tok, arg_tok, add_arg_to_input_list(on_tok, arg_tok);
in_tok_first, in_tok_last);
else else
free_trailer_item(arg_tok); free_trailer_item(arg_tok);
break; break;
} }
} }
static void apply_arg_if_missing(struct trailer_item **in_tok_first, static void apply_arg_if_missing(struct list_head *head,
struct trailer_item **in_tok_last,
struct trailer_item *arg_tok) struct trailer_item *arg_tok)
{ {
struct trailer_item **in_tok;
enum action_where where; enum action_where where;
switch (arg_tok->conf.if_missing) { switch (arg_tok->conf.if_missing) {
@ -317,68 +264,60 @@ static void apply_arg_if_missing(struct trailer_item **in_tok_first,
break; break;
case MISSING_ADD: case MISSING_ADD:
where = arg_tok->conf.where; where = arg_tok->conf.where;
in_tok = after_or_end(where) ? in_tok_last : in_tok_first;
apply_item_command(NULL, arg_tok); apply_item_command(NULL, arg_tok);
if (*in_tok) { if (after_or_end(where))
add_arg_to_input_list(*in_tok, arg_tok, list_add_tail(&arg_tok->list, head);
in_tok_first, in_tok_last); else
} else { list_add(&arg_tok->list, head);
*in_tok_first = arg_tok;
*in_tok_last = arg_tok;
}
break;
} }
} }
static int find_same_and_apply_arg(struct trailer_item **in_tok_first, static int find_same_and_apply_arg(struct list_head *head,
struct trailer_item **in_tok_last,
struct trailer_item *arg_tok) struct trailer_item *arg_tok)
{ {
struct list_head *pos;
struct trailer_item *in_tok; struct trailer_item *in_tok;
struct trailer_item *on_tok; struct trailer_item *on_tok;
struct trailer_item *following_tok;
enum action_where where = arg_tok->conf.where; enum action_where where = arg_tok->conf.where;
int middle = (where == WHERE_AFTER) || (where == WHERE_BEFORE); int middle = (where == WHERE_AFTER) || (where == WHERE_BEFORE);
int backwards = after_or_end(where); int backwards = after_or_end(where);
struct trailer_item *start_tok = backwards ? *in_tok_last : *in_tok_first; struct trailer_item *start_tok;
for (in_tok = start_tok; in_tok; in_tok = following_tok) { if (list_empty(head))
following_tok = backwards ? in_tok->previous : in_tok->next; return 0;
start_tok = list_entry(backwards ? head->prev : head->next,
struct trailer_item,
list);
list_for_each_dir(pos, head, backwards) {
in_tok = list_entry(pos, struct trailer_item, list);
if (!same_token(in_tok, arg_tok)) if (!same_token(in_tok, arg_tok))
continue; continue;
on_tok = middle ? in_tok : start_tok; on_tok = middle ? in_tok : start_tok;
apply_arg_if_exists(in_tok, arg_tok, on_tok, apply_arg_if_exists(in_tok, arg_tok, on_tok, head);
in_tok_first, in_tok_last);
return 1; return 1;
} }
return 0; return 0;
} }
static void process_trailers_lists(struct trailer_item **in_tok_first, static void process_trailers_lists(struct list_head *head,
struct trailer_item **in_tok_last, struct list_head *arg_head)
struct trailer_item **arg_tok_first)
{ {
struct list_head *pos, *p;
struct trailer_item *arg_tok; struct trailer_item *arg_tok;
struct trailer_item *next_arg;
if (!*arg_tok_first) list_for_each_safe(pos, p, arg_head) {
return;
for (arg_tok = *arg_tok_first; arg_tok; arg_tok = next_arg) {
int applied = 0; int applied = 0;
arg_tok = list_entry(pos, struct trailer_item, list);
next_arg = arg_tok->next; list_del(pos);
remove_from_list(arg_tok, arg_tok_first, NULL);
applied = find_same_and_apply_arg(in_tok_first, applied = find_same_and_apply_arg(head, arg_tok);
in_tok_last,
arg_tok);
if (!applied) if (!applied)
apply_arg_if_missing(in_tok_first, apply_arg_if_missing(head, arg_tok);
in_tok_last,
arg_tok);
} }
} }
@ -438,13 +377,12 @@ static void duplicate_conf(struct conf_info *dst, const struct conf_info *src)
static struct trailer_item *get_conf_item(const char *name) static struct trailer_item *get_conf_item(const char *name)
{ {
struct list_head *pos;
struct trailer_item *item; struct trailer_item *item;
struct trailer_item *previous;
/* Look up item with same name */ /* Look up item with same name */
for (previous = NULL, item = first_conf_item; list_for_each(pos, &conf_head) {
item; item = list_entry(pos, struct trailer_item, list);
previous = item, item = item->next) {
if (!strcasecmp(item->conf.name, name)) if (!strcasecmp(item->conf.name, name))
return item; return item;
} }
@ -454,12 +392,7 @@ static struct trailer_item *get_conf_item(const char *name)
duplicate_conf(&item->conf, &default_conf_info); duplicate_conf(&item->conf, &default_conf_info);
item->conf.name = xstrdup(name); item->conf.name = xstrdup(name);
if (!previous) list_add_tail(&item->list, &conf_head);
first_conf_item = item;
else {
previous->next = item;
item->previous = previous;
}
return item; return item;
} }
@ -633,6 +566,7 @@ static struct trailer_item *create_trailer_item(const char *string)
struct strbuf val = STRBUF_INIT; struct strbuf val = STRBUF_INIT;
struct trailer_item *item; struct trailer_item *item;
int tok_len; int tok_len;
struct list_head *pos;
if (parse_trailer(&tok, &val, string)) if (parse_trailer(&tok, &val, string))
return NULL; return NULL;
@ -640,7 +574,8 @@ static struct trailer_item *create_trailer_item(const char *string)
tok_len = token_len_without_separator(tok.buf, tok.len); tok_len = token_len_without_separator(tok.buf, tok.len);
/* Lookup if the token matches something in the config */ /* Lookup if the token matches something in the config */
for (item = first_conf_item; item; item = item->next) { list_for_each(pos, &conf_head) {
item = list_entry(pos, struct trailer_item, list);
if (token_matches_item(tok.buf, item, tok_len)) if (token_matches_item(tok.buf, item, tok_len))
return new_trailer_item(item, return new_trailer_item(item,
strbuf_detach(&tok, NULL), strbuf_detach(&tok, NULL),
@ -652,44 +587,34 @@ static struct trailer_item *create_trailer_item(const char *string)
strbuf_detach(&val, NULL)); strbuf_detach(&val, NULL));
} }
static void add_trailer_item(struct trailer_item **first, static void add_trailer_item(struct list_head *head, struct trailer_item *new)
struct trailer_item **last,
struct trailer_item *new)
{ {
if (!new) if (!new)
return; return;
if (!*last) { list_add_tail(&new->list, head);
*first = new;
*last = new;
} else {
(*last)->next = new;
new->previous = *last;
*last = new;
}
} }
static struct trailer_item *process_command_line_args(struct string_list *trailers) static void process_command_line_args(struct list_head *arg_head,
struct string_list *trailers)
{ {
struct trailer_item *arg_tok_first = NULL;
struct trailer_item *arg_tok_last = NULL;
struct string_list_item *tr; struct string_list_item *tr;
struct trailer_item *item; struct trailer_item *item;
struct list_head *pos;
/* Add a trailer item for each configured trailer with a command */ /* Add a trailer item for each configured trailer with a command */
for (item = first_conf_item; item; item = item->next) { list_for_each(pos, &conf_head) {
item = list_entry(pos, struct trailer_item, list);
if (item->conf.command) { if (item->conf.command) {
struct trailer_item *new = new_trailer_item(item, NULL, NULL); struct trailer_item *new = new_trailer_item(item, NULL, NULL);
add_trailer_item(&arg_tok_first, &arg_tok_last, new); add_trailer_item(arg_head, new);
} }
} }
/* Add a trailer item for each trailer on the command line */ /* Add a trailer item for each trailer on the command line */
for_each_string_list_item(tr, trailers) { for_each_string_list_item(tr, trailers) {
struct trailer_item *new = create_trailer_item(tr->string); struct trailer_item *new = create_trailer_item(tr->string);
add_trailer_item(&arg_tok_first, &arg_tok_last, new); add_trailer_item(arg_head, new);
} }
return arg_tok_first;
} }
static struct strbuf **read_input_file(const char *file) static struct strbuf **read_input_file(const char *file)
@ -805,8 +730,7 @@ static void print_lines(FILE *outfile, struct strbuf **lines, int start, int end
static int process_input_file(FILE *outfile, static int process_input_file(FILE *outfile,
struct strbuf **lines, struct strbuf **lines,
struct trailer_item **in_tok_first, struct list_head *head)
struct trailer_item **in_tok_last)
{ {
int count = 0; int count = 0;
int patch_start, trailer_start, trailer_end, i; int patch_start, trailer_start, trailer_end, i;
@ -829,18 +753,19 @@ static int process_input_file(FILE *outfile,
for (i = trailer_start; i < trailer_end; i++) { for (i = trailer_start; i < trailer_end; i++) {
if (lines[i]->buf[0] != comment_line_char) { if (lines[i]->buf[0] != comment_line_char) {
struct trailer_item *new = create_trailer_item(lines[i]->buf); struct trailer_item *new = create_trailer_item(lines[i]->buf);
add_trailer_item(in_tok_first, in_tok_last, new); add_trailer_item(head, new);
} }
} }
return trailer_end; return trailer_end;
} }
static void free_all(struct trailer_item **first) static void free_all(struct list_head *head)
{ {
while (*first) { struct list_head *pos, *p;
struct trailer_item *item = remove_first(first); list_for_each_safe(pos, p, head) {
free_trailer_item(item); list_del(pos);
free_trailer_item(list_entry(pos, struct trailer_item, list));
} }
} }
@ -877,9 +802,8 @@ static FILE *create_in_place_tempfile(const char *file)
void process_trailers(const char *file, int in_place, int trim_empty, struct string_list *trailers) void process_trailers(const char *file, int in_place, int trim_empty, struct string_list *trailers)
{ {
struct trailer_item *in_tok_first = NULL; LIST_HEAD(head);
struct trailer_item *in_tok_last = NULL; LIST_HEAD(arg_head);
struct trailer_item *arg_tok_first;
struct strbuf **lines; struct strbuf **lines;
int trailer_end; int trailer_end;
FILE *outfile = stdout; FILE *outfile = stdout;
@ -894,15 +818,15 @@ void process_trailers(const char *file, int in_place, int trim_empty, struct str
outfile = create_in_place_tempfile(file); outfile = create_in_place_tempfile(file);
/* Print the lines before the trailers */ /* Print the lines before the trailers */
trailer_end = process_input_file(outfile, lines, &in_tok_first, &in_tok_last); trailer_end = process_input_file(outfile, lines, &head);
arg_tok_first = process_command_line_args(trailers); process_command_line_args(&arg_head, trailers);
process_trailers_lists(&in_tok_first, &in_tok_last, &arg_tok_first); process_trailers_lists(&head, &arg_head);
print_all(outfile, in_tok_first, trim_empty); print_all(outfile, &head, trim_empty);
free_all(&in_tok_first); free_all(&head);
/* Print the lines after the trailers as is */ /* Print the lines after the trailers as is */
print_lines(outfile, lines, trailer_end, INT_MAX); print_lines(outfile, lines, trailer_end, INT_MAX);