Merge branch 'cb/bash-completion-ls-files-processing'
[git] / ref-filter.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "parse-options.h"
4 #include "refs.h"
5 #include "wildmatch.h"
6 #include "commit.h"
7 #include "remote.h"
8 #include "color.h"
9 #include "tag.h"
10 #include "quote.h"
11 #include "ref-filter.h"
12 #include "revision.h"
13 #include "utf8.h"
14 #include "git-compat-util.h"
15 #include "version.h"
16 #include "trailer.h"
17 #include "wt-status.h"
18 #include "commit-slab.h"
19
20 static struct ref_msg {
21         const char *gone;
22         const char *ahead;
23         const char *behind;
24         const char *ahead_behind;
25 } msgs = {
26          /* Untranslated plumbing messages: */
27         "gone",
28         "ahead %d",
29         "behind %d",
30         "ahead %d, behind %d"
31 };
32
33 void setup_ref_filter_porcelain_msg(void)
34 {
35         msgs.gone = _("gone");
36         msgs.ahead = _("ahead %d");
37         msgs.behind = _("behind %d");
38         msgs.ahead_behind = _("ahead %d, behind %d");
39 }
40
41 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
42 typedef enum { COMPARE_EQUAL, COMPARE_UNEQUAL, COMPARE_NONE } cmp_status;
43
44 struct align {
45         align_type position;
46         unsigned int width;
47 };
48
49 struct if_then_else {
50         cmp_status cmp_status;
51         const char *str;
52         unsigned int then_atom_seen : 1,
53                 else_atom_seen : 1,
54                 condition_satisfied : 1;
55 };
56
57 struct refname_atom {
58         enum { R_NORMAL, R_SHORT, R_LSTRIP, R_RSTRIP } option;
59         int lstrip, rstrip;
60 };
61
62 /*
63  * An atom is a valid field atom listed below, possibly prefixed with
64  * a "*" to denote deref_tag().
65  *
66  * We parse given format string and sort specifiers, and make a list
67  * of properties that we need to extract out of objects.  ref_array_item
68  * structure will hold an array of values extracted that can be
69  * indexed with the "atom number", which is an index into this
70  * array.
71  */
72 static struct used_atom {
73         const char *name;
74         cmp_type type;
75         union {
76                 char color[COLOR_MAXLEN];
77                 struct align align;
78                 struct {
79                         enum {
80                                 RR_REF, RR_TRACK, RR_TRACKSHORT, RR_REMOTE_NAME, RR_REMOTE_REF
81                         } option;
82                         struct refname_atom refname;
83                         unsigned int nobracket : 1, push : 1, push_remote : 1;
84                 } remote_ref;
85                 struct {
86                         enum { C_BARE, C_BODY, C_BODY_DEP, C_LINES, C_SIG, C_SUB, C_TRAILERS } option;
87                         struct process_trailer_options trailer_opts;
88                         unsigned int nlines;
89                 } contents;
90                 struct {
91                         cmp_status cmp_status;
92                         const char *str;
93                 } if_then_else;
94                 struct {
95                         enum { O_FULL, O_LENGTH, O_SHORT } option;
96                         unsigned int length;
97                 } objectname;
98                 struct refname_atom refname;
99                 char *head;
100         } u;
101 } *used_atom;
102 static int used_atom_cnt, need_tagged, need_symref;
103
104 static void color_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *color_value)
105 {
106         if (!color_value)
107                 die(_("expected format: %%(color:<color>)"));
108         if (color_parse(color_value, atom->u.color) < 0)
109                 die(_("unrecognized color: %%(color:%s)"), color_value);
110         /*
111          * We check this after we've parsed the color, which lets us complain
112          * about syntactically bogus color names even if they won't be used.
113          */
114         if (!want_color(format->use_color))
115                 color_parse("", atom->u.color);
116 }
117
118 static void refname_atom_parser_internal(struct refname_atom *atom,
119                                          const char *arg, const char *name)
120 {
121         if (!arg)
122                 atom->option = R_NORMAL;
123         else if (!strcmp(arg, "short"))
124                 atom->option = R_SHORT;
125         else if (skip_prefix(arg, "lstrip=", &arg) ||
126                  skip_prefix(arg, "strip=", &arg)) {
127                 atom->option = R_LSTRIP;
128                 if (strtol_i(arg, 10, &atom->lstrip))
129                         die(_("Integer value expected refname:lstrip=%s"), arg);
130         } else if (skip_prefix(arg, "rstrip=", &arg)) {
131                 atom->option = R_RSTRIP;
132                 if (strtol_i(arg, 10, &atom->rstrip))
133                         die(_("Integer value expected refname:rstrip=%s"), arg);
134         } else
135                 die(_("unrecognized %%(%s) argument: %s"), name, arg);
136 }
137
138 static void remote_ref_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
139 {
140         struct string_list params = STRING_LIST_INIT_DUP;
141         int i;
142
143         if (!strcmp(atom->name, "push") || starts_with(atom->name, "push:"))
144                 atom->u.remote_ref.push = 1;
145
146         if (!arg) {
147                 atom->u.remote_ref.option = RR_REF;
148                 refname_atom_parser_internal(&atom->u.remote_ref.refname,
149                                              arg, atom->name);
150                 return;
151         }
152
153         atom->u.remote_ref.nobracket = 0;
154         string_list_split(&params, arg, ',', -1);
155
156         for (i = 0; i < params.nr; i++) {
157                 const char *s = params.items[i].string;
158
159                 if (!strcmp(s, "track"))
160                         atom->u.remote_ref.option = RR_TRACK;
161                 else if (!strcmp(s, "trackshort"))
162                         atom->u.remote_ref.option = RR_TRACKSHORT;
163                 else if (!strcmp(s, "nobracket"))
164                         atom->u.remote_ref.nobracket = 1;
165                 else if (!strcmp(s, "remotename")) {
166                         atom->u.remote_ref.option = RR_REMOTE_NAME;
167                         atom->u.remote_ref.push_remote = 1;
168                 } else if (!strcmp(s, "remoteref")) {
169                         atom->u.remote_ref.option = RR_REMOTE_REF;
170                         atom->u.remote_ref.push_remote = 1;
171                 } else {
172                         atom->u.remote_ref.option = RR_REF;
173                         refname_atom_parser_internal(&atom->u.remote_ref.refname,
174                                                      arg, atom->name);
175                 }
176         }
177
178         string_list_clear(&params, 0);
179 }
180
181 static void body_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
182 {
183         if (arg)
184                 die(_("%%(body) does not take arguments"));
185         atom->u.contents.option = C_BODY_DEP;
186 }
187
188 static void subject_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
189 {
190         if (arg)
191                 die(_("%%(subject) does not take arguments"));
192         atom->u.contents.option = C_SUB;
193 }
194
195 static void trailers_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
196 {
197         struct string_list params = STRING_LIST_INIT_DUP;
198         int i;
199
200         if (arg) {
201                 string_list_split(&params, arg, ',', -1);
202                 for (i = 0; i < params.nr; i++) {
203                         const char *s = params.items[i].string;
204                         if (!strcmp(s, "unfold"))
205                                 atom->u.contents.trailer_opts.unfold = 1;
206                         else if (!strcmp(s, "only"))
207                                 atom->u.contents.trailer_opts.only_trailers = 1;
208                         else
209                                 die(_("unknown %%(trailers) argument: %s"), s);
210                 }
211         }
212         atom->u.contents.option = C_TRAILERS;
213         string_list_clear(&params, 0);
214 }
215
216 static void contents_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
217 {
218         if (!arg)
219                 atom->u.contents.option = C_BARE;
220         else if (!strcmp(arg, "body"))
221                 atom->u.contents.option = C_BODY;
222         else if (!strcmp(arg, "signature"))
223                 atom->u.contents.option = C_SIG;
224         else if (!strcmp(arg, "subject"))
225                 atom->u.contents.option = C_SUB;
226         else if (skip_prefix(arg, "trailers", &arg)) {
227                 skip_prefix(arg, ":", &arg);
228                 trailers_atom_parser(format, atom, *arg ? arg : NULL);
229         } else if (skip_prefix(arg, "lines=", &arg)) {
230                 atom->u.contents.option = C_LINES;
231                 if (strtoul_ui(arg, 10, &atom->u.contents.nlines))
232                         die(_("positive value expected contents:lines=%s"), arg);
233         } else
234                 die(_("unrecognized %%(contents) argument: %s"), arg);
235 }
236
237 static void objectname_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
238 {
239         if (!arg)
240                 atom->u.objectname.option = O_FULL;
241         else if (!strcmp(arg, "short"))
242                 atom->u.objectname.option = O_SHORT;
243         else if (skip_prefix(arg, "short=", &arg)) {
244                 atom->u.objectname.option = O_LENGTH;
245                 if (strtoul_ui(arg, 10, &atom->u.objectname.length) ||
246                     atom->u.objectname.length == 0)
247                         die(_("positive value expected objectname:short=%s"), arg);
248                 if (atom->u.objectname.length < MINIMUM_ABBREV)
249                         atom->u.objectname.length = MINIMUM_ABBREV;
250         } else
251                 die(_("unrecognized %%(objectname) argument: %s"), arg);
252 }
253
254 static void refname_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
255 {
256         refname_atom_parser_internal(&atom->u.refname, arg, atom->name);
257 }
258
259 static align_type parse_align_position(const char *s)
260 {
261         if (!strcmp(s, "right"))
262                 return ALIGN_RIGHT;
263         else if (!strcmp(s, "middle"))
264                 return ALIGN_MIDDLE;
265         else if (!strcmp(s, "left"))
266                 return ALIGN_LEFT;
267         return -1;
268 }
269
270 static void align_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
271 {
272         struct align *align = &atom->u.align;
273         struct string_list params = STRING_LIST_INIT_DUP;
274         int i;
275         unsigned int width = ~0U;
276
277         if (!arg)
278                 die(_("expected format: %%(align:<width>,<position>)"));
279
280         align->position = ALIGN_LEFT;
281
282         string_list_split(&params, arg, ',', -1);
283         for (i = 0; i < params.nr; i++) {
284                 const char *s = params.items[i].string;
285                 int position;
286
287                 if (skip_prefix(s, "position=", &s)) {
288                         position = parse_align_position(s);
289                         if (position < 0)
290                                 die(_("unrecognized position:%s"), s);
291                         align->position = position;
292                 } else if (skip_prefix(s, "width=", &s)) {
293                         if (strtoul_ui(s, 10, &width))
294                                 die(_("unrecognized width:%s"), s);
295                 } else if (!strtoul_ui(s, 10, &width))
296                         ;
297                 else if ((position = parse_align_position(s)) >= 0)
298                         align->position = position;
299                 else
300                         die(_("unrecognized %%(align) argument: %s"), s);
301         }
302
303         if (width == ~0U)
304                 die(_("positive width expected with the %%(align) atom"));
305         align->width = width;
306         string_list_clear(&params, 0);
307 }
308
309 static void if_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
310 {
311         if (!arg) {
312                 atom->u.if_then_else.cmp_status = COMPARE_NONE;
313                 return;
314         } else if (skip_prefix(arg, "equals=", &atom->u.if_then_else.str)) {
315                 atom->u.if_then_else.cmp_status = COMPARE_EQUAL;
316         } else if (skip_prefix(arg, "notequals=", &atom->u.if_then_else.str)) {
317                 atom->u.if_then_else.cmp_status = COMPARE_UNEQUAL;
318         } else {
319                 die(_("unrecognized %%(if) argument: %s"), arg);
320         }
321 }
322
323 static void head_atom_parser(const struct ref_format *format, struct used_atom *atom, const char *arg)
324 {
325         atom->u.head = resolve_refdup("HEAD", RESOLVE_REF_READING, NULL, NULL);
326 }
327
328 static struct {
329         const char *name;
330         cmp_type cmp_type;
331         void (*parser)(const struct ref_format *format, struct used_atom *atom, const char *arg);
332 } valid_atom[] = {
333         { "refname" , FIELD_STR, refname_atom_parser },
334         { "objecttype" },
335         { "objectsize", FIELD_ULONG },
336         { "objectname", FIELD_STR, objectname_atom_parser },
337         { "tree" },
338         { "parent" },
339         { "numparent", FIELD_ULONG },
340         { "object" },
341         { "type" },
342         { "tag" },
343         { "author" },
344         { "authorname" },
345         { "authoremail" },
346         { "authordate", FIELD_TIME },
347         { "committer" },
348         { "committername" },
349         { "committeremail" },
350         { "committerdate", FIELD_TIME },
351         { "tagger" },
352         { "taggername" },
353         { "taggeremail" },
354         { "taggerdate", FIELD_TIME },
355         { "creator" },
356         { "creatordate", FIELD_TIME },
357         { "subject", FIELD_STR, subject_atom_parser },
358         { "body", FIELD_STR, body_atom_parser },
359         { "trailers", FIELD_STR, trailers_atom_parser },
360         { "contents", FIELD_STR, contents_atom_parser },
361         { "upstream", FIELD_STR, remote_ref_atom_parser },
362         { "push", FIELD_STR, remote_ref_atom_parser },
363         { "symref", FIELD_STR, refname_atom_parser },
364         { "flag" },
365         { "HEAD", FIELD_STR, head_atom_parser },
366         { "color", FIELD_STR, color_atom_parser },
367         { "align", FIELD_STR, align_atom_parser },
368         { "end" },
369         { "if", FIELD_STR, if_atom_parser },
370         { "then" },
371         { "else" },
372 };
373
374 #define REF_FORMATTING_STATE_INIT  { 0, NULL }
375
376 struct ref_formatting_stack {
377         struct ref_formatting_stack *prev;
378         struct strbuf output;
379         void (*at_end)(struct ref_formatting_stack **stack);
380         void *at_end_data;
381 };
382
383 struct ref_formatting_state {
384         int quote_style;
385         struct ref_formatting_stack *stack;
386 };
387
388 struct atom_value {
389         const char *s;
390         void (*handler)(struct atom_value *atomv, struct ref_formatting_state *state);
391         uintmax_t value; /* used for sorting when not FIELD_STR */
392         struct used_atom *atom;
393 };
394
395 /*
396  * Used to parse format string and sort specifiers
397  */
398 static int parse_ref_filter_atom(const struct ref_format *format,
399                                  const char *atom, const char *ep)
400 {
401         const char *sp;
402         const char *arg;
403         int i, at, atom_len;
404
405         sp = atom;
406         if (*sp == '*' && sp < ep)
407                 sp++; /* deref */
408         if (ep <= sp)
409                 die(_("malformed field name: %.*s"), (int)(ep-atom), atom);
410
411         /* Do we have the atom already used elsewhere? */
412         for (i = 0; i < used_atom_cnt; i++) {
413                 int len = strlen(used_atom[i].name);
414                 if (len == ep - atom && !memcmp(used_atom[i].name, atom, len))
415                         return i;
416         }
417
418         /*
419          * If the atom name has a colon, strip it and everything after
420          * it off - it specifies the format for this entry, and
421          * shouldn't be used for checking against the valid_atom
422          * table.
423          */
424         arg = memchr(sp, ':', ep - sp);
425         atom_len = (arg ? arg : ep) - sp;
426
427         /* Is the atom a valid one? */
428         for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
429                 int len = strlen(valid_atom[i].name);
430                 if (len == atom_len && !memcmp(valid_atom[i].name, sp, len))
431                         break;
432         }
433
434         if (ARRAY_SIZE(valid_atom) <= i)
435                 die(_("unknown field name: %.*s"), (int)(ep-atom), atom);
436
437         /* Add it in, including the deref prefix */
438         at = used_atom_cnt;
439         used_atom_cnt++;
440         REALLOC_ARRAY(used_atom, used_atom_cnt);
441         used_atom[at].name = xmemdupz(atom, ep - atom);
442         used_atom[at].type = valid_atom[i].cmp_type;
443         if (arg) {
444                 arg = used_atom[at].name + (arg - atom) + 1;
445                 if (!*arg) {
446                         /*
447                          * Treat empty sub-arguments list as NULL (i.e.,
448                          * "%(atom:)" is equivalent to "%(atom)").
449                          */
450                         arg = NULL;
451                 }
452         }
453         memset(&used_atom[at].u, 0, sizeof(used_atom[at].u));
454         if (valid_atom[i].parser)
455                 valid_atom[i].parser(format, &used_atom[at], arg);
456         if (*atom == '*')
457                 need_tagged = 1;
458         if (!strcmp(valid_atom[i].name, "symref"))
459                 need_symref = 1;
460         return at;
461 }
462
463 static void quote_formatting(struct strbuf *s, const char *str, int quote_style)
464 {
465         switch (quote_style) {
466         case QUOTE_NONE:
467                 strbuf_addstr(s, str);
468                 break;
469         case QUOTE_SHELL:
470                 sq_quote_buf(s, str);
471                 break;
472         case QUOTE_PERL:
473                 perl_quote_buf(s, str);
474                 break;
475         case QUOTE_PYTHON:
476                 python_quote_buf(s, str);
477                 break;
478         case QUOTE_TCL:
479                 tcl_quote_buf(s, str);
480                 break;
481         }
482 }
483
484 static void append_atom(struct atom_value *v, struct ref_formatting_state *state)
485 {
486         /*
487          * Quote formatting is only done when the stack has a single
488          * element. Otherwise quote formatting is done on the
489          * element's entire output strbuf when the %(end) atom is
490          * encountered.
491          */
492         if (!state->stack->prev)
493                 quote_formatting(&state->stack->output, v->s, state->quote_style);
494         else
495                 strbuf_addstr(&state->stack->output, v->s);
496 }
497
498 static void push_stack_element(struct ref_formatting_stack **stack)
499 {
500         struct ref_formatting_stack *s = xcalloc(1, sizeof(struct ref_formatting_stack));
501
502         strbuf_init(&s->output, 0);
503         s->prev = *stack;
504         *stack = s;
505 }
506
507 static void pop_stack_element(struct ref_formatting_stack **stack)
508 {
509         struct ref_formatting_stack *current = *stack;
510         struct ref_formatting_stack *prev = current->prev;
511
512         if (prev)
513                 strbuf_addbuf(&prev->output, &current->output);
514         strbuf_release(&current->output);
515         free(current);
516         *stack = prev;
517 }
518
519 static void end_align_handler(struct ref_formatting_stack **stack)
520 {
521         struct ref_formatting_stack *cur = *stack;
522         struct align *align = (struct align *)cur->at_end_data;
523         struct strbuf s = STRBUF_INIT;
524
525         strbuf_utf8_align(&s, align->position, align->width, cur->output.buf);
526         strbuf_swap(&cur->output, &s);
527         strbuf_release(&s);
528 }
529
530 static void align_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
531 {
532         struct ref_formatting_stack *new_stack;
533
534         push_stack_element(&state->stack);
535         new_stack = state->stack;
536         new_stack->at_end = end_align_handler;
537         new_stack->at_end_data = &atomv->atom->u.align;
538 }
539
540 static void if_then_else_handler(struct ref_formatting_stack **stack)
541 {
542         struct ref_formatting_stack *cur = *stack;
543         struct ref_formatting_stack *prev = cur->prev;
544         struct if_then_else *if_then_else = (struct if_then_else *)cur->at_end_data;
545
546         if (!if_then_else->then_atom_seen)
547                 die(_("format: %%(if) atom used without a %%(then) atom"));
548
549         if (if_then_else->else_atom_seen) {
550                 /*
551                  * There is an %(else) atom: we need to drop one state from the
552                  * stack, either the %(else) branch if the condition is satisfied, or
553                  * the %(then) branch if it isn't.
554                  */
555                 if (if_then_else->condition_satisfied) {
556                         strbuf_reset(&cur->output);
557                         pop_stack_element(&cur);
558                 } else {
559                         strbuf_swap(&cur->output, &prev->output);
560                         strbuf_reset(&cur->output);
561                         pop_stack_element(&cur);
562                 }
563         } else if (!if_then_else->condition_satisfied) {
564                 /*
565                  * No %(else) atom: just drop the %(then) branch if the
566                  * condition is not satisfied.
567                  */
568                 strbuf_reset(&cur->output);
569         }
570
571         *stack = cur;
572         free(if_then_else);
573 }
574
575 static void if_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
576 {
577         struct ref_formatting_stack *new_stack;
578         struct if_then_else *if_then_else = xcalloc(sizeof(struct if_then_else), 1);
579
580         if_then_else->str = atomv->atom->u.if_then_else.str;
581         if_then_else->cmp_status = atomv->atom->u.if_then_else.cmp_status;
582
583         push_stack_element(&state->stack);
584         new_stack = state->stack;
585         new_stack->at_end = if_then_else_handler;
586         new_stack->at_end_data = if_then_else;
587 }
588
589 static int is_empty(const char *s)
590 {
591         while (*s != '\0') {
592                 if (!isspace(*s))
593                         return 0;
594                 s++;
595         }
596         return 1;
597 }
598
599 static void then_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
600 {
601         struct ref_formatting_stack *cur = state->stack;
602         struct if_then_else *if_then_else = NULL;
603
604         if (cur->at_end == if_then_else_handler)
605                 if_then_else = (struct if_then_else *)cur->at_end_data;
606         if (!if_then_else)
607                 die(_("format: %%(then) atom used without an %%(if) atom"));
608         if (if_then_else->then_atom_seen)
609                 die(_("format: %%(then) atom used more than once"));
610         if (if_then_else->else_atom_seen)
611                 die(_("format: %%(then) atom used after %%(else)"));
612         if_then_else->then_atom_seen = 1;
613         /*
614          * If the 'equals' or 'notequals' attribute is used then
615          * perform the required comparison. If not, only non-empty
616          * strings satisfy the 'if' condition.
617          */
618         if (if_then_else->cmp_status == COMPARE_EQUAL) {
619                 if (!strcmp(if_then_else->str, cur->output.buf))
620                         if_then_else->condition_satisfied = 1;
621         } else if (if_then_else->cmp_status == COMPARE_UNEQUAL) {
622                 if (strcmp(if_then_else->str, cur->output.buf))
623                         if_then_else->condition_satisfied = 1;
624         } else if (cur->output.len && !is_empty(cur->output.buf))
625                 if_then_else->condition_satisfied = 1;
626         strbuf_reset(&cur->output);
627 }
628
629 static void else_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
630 {
631         struct ref_formatting_stack *prev = state->stack;
632         struct if_then_else *if_then_else = NULL;
633
634         if (prev->at_end == if_then_else_handler)
635                 if_then_else = (struct if_then_else *)prev->at_end_data;
636         if (!if_then_else)
637                 die(_("format: %%(else) atom used without an %%(if) atom"));
638         if (!if_then_else->then_atom_seen)
639                 die(_("format: %%(else) atom used without a %%(then) atom"));
640         if (if_then_else->else_atom_seen)
641                 die(_("format: %%(else) atom used more than once"));
642         if_then_else->else_atom_seen = 1;
643         push_stack_element(&state->stack);
644         state->stack->at_end_data = prev->at_end_data;
645         state->stack->at_end = prev->at_end;
646 }
647
648 static void end_atom_handler(struct atom_value *atomv, struct ref_formatting_state *state)
649 {
650         struct ref_formatting_stack *current = state->stack;
651         struct strbuf s = STRBUF_INIT;
652
653         if (!current->at_end)
654                 die(_("format: %%(end) atom used without corresponding atom"));
655         current->at_end(&state->stack);
656
657         /*  Stack may have been popped within at_end(), hence reset the current pointer */
658         current = state->stack;
659
660         /*
661          * Perform quote formatting when the stack element is that of
662          * a supporting atom. If nested then perform quote formatting
663          * only on the topmost supporting atom.
664          */
665         if (!current->prev->prev) {
666                 quote_formatting(&s, current->output.buf, state->quote_style);
667                 strbuf_swap(&current->output, &s);
668         }
669         strbuf_release(&s);
670         pop_stack_element(&state->stack);
671 }
672
673 /*
674  * In a format string, find the next occurrence of %(atom).
675  */
676 static const char *find_next(const char *cp)
677 {
678         while (*cp) {
679                 if (*cp == '%') {
680                         /*
681                          * %( is the start of an atom;
682                          * %% is a quoted per-cent.
683                          */
684                         if (cp[1] == '(')
685                                 return cp;
686                         else if (cp[1] == '%')
687                                 cp++; /* skip over two % */
688                         /* otherwise this is a singleton, literal % */
689                 }
690                 cp++;
691         }
692         return NULL;
693 }
694
695 /*
696  * Make sure the format string is well formed, and parse out
697  * the used atoms.
698  */
699 int verify_ref_format(struct ref_format *format)
700 {
701         const char *cp, *sp;
702
703         format->need_color_reset_at_eol = 0;
704         for (cp = format->format; *cp && (sp = find_next(cp)); ) {
705                 const char *color, *ep = strchr(sp, ')');
706                 int at;
707
708                 if (!ep)
709                         return error(_("malformed format string %s"), sp);
710                 /* sp points at "%(" and ep points at the closing ")" */
711                 at = parse_ref_filter_atom(format, sp + 2, ep);
712                 cp = ep + 1;
713
714                 if (skip_prefix(used_atom[at].name, "color:", &color))
715                         format->need_color_reset_at_eol = !!strcmp(color, "reset");
716         }
717         if (format->need_color_reset_at_eol && !want_color(format->use_color))
718                 format->need_color_reset_at_eol = 0;
719         return 0;
720 }
721
722 /*
723  * Given an object name, read the object data and size, and return a
724  * "struct object".  If the object data we are returning is also borrowed
725  * by the "struct object" representation, set *eaten as well---it is a
726  * signal from parse_object_buffer to us not to free the buffer.
727  */
728 static void *get_obj(const struct object_id *oid, struct object **obj, unsigned long *sz, int *eaten)
729 {
730         enum object_type type;
731         void *buf = read_object_file(oid, &type, sz);
732
733         if (buf)
734                 *obj = parse_object_buffer(oid, type, *sz, buf, eaten);
735         else
736                 *obj = NULL;
737         return buf;
738 }
739
740 static int grab_objectname(const char *name, const struct object_id *oid,
741                            struct atom_value *v, struct used_atom *atom)
742 {
743         if (starts_with(name, "objectname")) {
744                 if (atom->u.objectname.option == O_SHORT) {
745                         v->s = xstrdup(find_unique_abbrev(oid, DEFAULT_ABBREV));
746                         return 1;
747                 } else if (atom->u.objectname.option == O_FULL) {
748                         v->s = xstrdup(oid_to_hex(oid));
749                         return 1;
750                 } else if (atom->u.objectname.option == O_LENGTH) {
751                         v->s = xstrdup(find_unique_abbrev(oid, atom->u.objectname.length));
752                         return 1;
753                 } else
754                         die("BUG: unknown %%(objectname) option");
755         }
756         return 0;
757 }
758
759 /* See grab_values */
760 static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
761 {
762         int i;
763
764         for (i = 0; i < used_atom_cnt; i++) {
765                 const char *name = used_atom[i].name;
766                 struct atom_value *v = &val[i];
767                 if (!!deref != (*name == '*'))
768                         continue;
769                 if (deref)
770                         name++;
771                 if (!strcmp(name, "objecttype"))
772                         v->s = type_name(obj->type);
773                 else if (!strcmp(name, "objectsize")) {
774                         v->value = sz;
775                         v->s = xstrfmt("%lu", sz);
776                 }
777                 else if (deref)
778                         grab_objectname(name, &obj->oid, v, &used_atom[i]);
779         }
780 }
781
782 /* See grab_values */
783 static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
784 {
785         int i;
786         struct tag *tag = (struct tag *) obj;
787
788         for (i = 0; i < used_atom_cnt; i++) {
789                 const char *name = used_atom[i].name;
790                 struct atom_value *v = &val[i];
791                 if (!!deref != (*name == '*'))
792                         continue;
793                 if (deref)
794                         name++;
795                 if (!strcmp(name, "tag"))
796                         v->s = tag->tag;
797                 else if (!strcmp(name, "type") && tag->tagged)
798                         v->s = type_name(tag->tagged->type);
799                 else if (!strcmp(name, "object") && tag->tagged)
800                         v->s = xstrdup(oid_to_hex(&tag->tagged->oid));
801         }
802 }
803
804 /* See grab_values */
805 static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
806 {
807         int i;
808         struct commit *commit = (struct commit *) obj;
809
810         for (i = 0; i < used_atom_cnt; i++) {
811                 const char *name = used_atom[i].name;
812                 struct atom_value *v = &val[i];
813                 if (!!deref != (*name == '*'))
814                         continue;
815                 if (deref)
816                         name++;
817                 if (!strcmp(name, "tree")) {
818                         v->s = xstrdup(oid_to_hex(&commit->tree->object.oid));
819                 }
820                 else if (!strcmp(name, "numparent")) {
821                         v->value = commit_list_count(commit->parents);
822                         v->s = xstrfmt("%lu", (unsigned long)v->value);
823                 }
824                 else if (!strcmp(name, "parent")) {
825                         struct commit_list *parents;
826                         struct strbuf s = STRBUF_INIT;
827                         for (parents = commit->parents; parents; parents = parents->next) {
828                                 struct commit *parent = parents->item;
829                                 if (parents != commit->parents)
830                                         strbuf_addch(&s, ' ');
831                                 strbuf_addstr(&s, oid_to_hex(&parent->object.oid));
832                         }
833                         v->s = strbuf_detach(&s, NULL);
834                 }
835         }
836 }
837
838 static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
839 {
840         const char *eol;
841         while (*buf) {
842                 if (!strncmp(buf, who, wholen) &&
843                     buf[wholen] == ' ')
844                         return buf + wholen + 1;
845                 eol = strchr(buf, '\n');
846                 if (!eol)
847                         return "";
848                 eol++;
849                 if (*eol == '\n')
850                         return ""; /* end of header */
851                 buf = eol;
852         }
853         return "";
854 }
855
856 static const char *copy_line(const char *buf)
857 {
858         const char *eol = strchrnul(buf, '\n');
859         return xmemdupz(buf, eol - buf);
860 }
861
862 static const char *copy_name(const char *buf)
863 {
864         const char *cp;
865         for (cp = buf; *cp && *cp != '\n'; cp++) {
866                 if (!strncmp(cp, " <", 2))
867                         return xmemdupz(buf, cp - buf);
868         }
869         return "";
870 }
871
872 static const char *copy_email(const char *buf)
873 {
874         const char *email = strchr(buf, '<');
875         const char *eoemail;
876         if (!email)
877                 return "";
878         eoemail = strchr(email, '>');
879         if (!eoemail)
880                 return "";
881         return xmemdupz(email, eoemail + 1 - email);
882 }
883
884 static char *copy_subject(const char *buf, unsigned long len)
885 {
886         char *r = xmemdupz(buf, len);
887         int i;
888
889         for (i = 0; i < len; i++)
890                 if (r[i] == '\n')
891                         r[i] = ' ';
892
893         return r;
894 }
895
896 static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
897 {
898         const char *eoemail = strstr(buf, "> ");
899         char *zone;
900         timestamp_t timestamp;
901         long tz;
902         struct date_mode date_mode = { DATE_NORMAL };
903         const char *formatp;
904
905         /*
906          * We got here because atomname ends in "date" or "date<something>";
907          * it's not possible that <something> is not ":<format>" because
908          * parse_ref_filter_atom() wouldn't have allowed it, so we can assume that no
909          * ":" means no format is specified, and use the default.
910          */
911         formatp = strchr(atomname, ':');
912         if (formatp != NULL) {
913                 formatp++;
914                 parse_date_format(formatp, &date_mode);
915         }
916
917         if (!eoemail)
918                 goto bad;
919         timestamp = parse_timestamp(eoemail + 2, &zone, 10);
920         if (timestamp == TIME_MAX)
921                 goto bad;
922         tz = strtol(zone, NULL, 10);
923         if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
924                 goto bad;
925         v->s = xstrdup(show_date(timestamp, tz, &date_mode));
926         v->value = timestamp;
927         return;
928  bad:
929         v->s = "";
930         v->value = 0;
931 }
932
933 /* See grab_values */
934 static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
935 {
936         int i;
937         int wholen = strlen(who);
938         const char *wholine = NULL;
939
940         for (i = 0; i < used_atom_cnt; i++) {
941                 const char *name = used_atom[i].name;
942                 struct atom_value *v = &val[i];
943                 if (!!deref != (*name == '*'))
944                         continue;
945                 if (deref)
946                         name++;
947                 if (strncmp(who, name, wholen))
948                         continue;
949                 if (name[wholen] != 0 &&
950                     strcmp(name + wholen, "name") &&
951                     strcmp(name + wholen, "email") &&
952                     !starts_with(name + wholen, "date"))
953                         continue;
954                 if (!wholine)
955                         wholine = find_wholine(who, wholen, buf, sz);
956                 if (!wholine)
957                         return; /* no point looking for it */
958                 if (name[wholen] == 0)
959                         v->s = copy_line(wholine);
960                 else if (!strcmp(name + wholen, "name"))
961                         v->s = copy_name(wholine);
962                 else if (!strcmp(name + wholen, "email"))
963                         v->s = copy_email(wholine);
964                 else if (starts_with(name + wholen, "date"))
965                         grab_date(wholine, v, name);
966         }
967
968         /*
969          * For a tag or a commit object, if "creator" or "creatordate" is
970          * requested, do something special.
971          */
972         if (strcmp(who, "tagger") && strcmp(who, "committer"))
973                 return; /* "author" for commit object is not wanted */
974         if (!wholine)
975                 wholine = find_wholine(who, wholen, buf, sz);
976         if (!wholine)
977                 return;
978         for (i = 0; i < used_atom_cnt; i++) {
979                 const char *name = used_atom[i].name;
980                 struct atom_value *v = &val[i];
981                 if (!!deref != (*name == '*'))
982                         continue;
983                 if (deref)
984                         name++;
985
986                 if (starts_with(name, "creatordate"))
987                         grab_date(wholine, v, name);
988                 else if (!strcmp(name, "creator"))
989                         v->s = copy_line(wholine);
990         }
991 }
992
993 static void find_subpos(const char *buf, unsigned long sz,
994                         const char **sub, unsigned long *sublen,
995                         const char **body, unsigned long *bodylen,
996                         unsigned long *nonsiglen,
997                         const char **sig, unsigned long *siglen)
998 {
999         const char *eol;
1000         /* skip past header until we hit empty line */
1001         while (*buf && *buf != '\n') {
1002                 eol = strchrnul(buf, '\n');
1003                 if (*eol)
1004                         eol++;
1005                 buf = eol;
1006         }
1007         /* skip any empty lines */
1008         while (*buf == '\n')
1009                 buf++;
1010
1011         /* parse signature first; we might not even have a subject line */
1012         *sig = buf + parse_signature(buf, strlen(buf));
1013         *siglen = strlen(*sig);
1014
1015         /* subject is first non-empty line */
1016         *sub = buf;
1017         /* subject goes to first empty line */
1018         while (buf < *sig && *buf && *buf != '\n') {
1019                 eol = strchrnul(buf, '\n');
1020                 if (*eol)
1021                         eol++;
1022                 buf = eol;
1023         }
1024         *sublen = buf - *sub;
1025         /* drop trailing newline, if present */
1026         if (*sublen && (*sub)[*sublen - 1] == '\n')
1027                 *sublen -= 1;
1028
1029         /* skip any empty lines */
1030         while (*buf == '\n')
1031                 buf++;
1032         *body = buf;
1033         *bodylen = strlen(buf);
1034         *nonsiglen = *sig - buf;
1035 }
1036
1037 /*
1038  * If 'lines' is greater than 0, append that many lines from the given
1039  * 'buf' of length 'size' to the given strbuf.
1040  */
1041 static void append_lines(struct strbuf *out, const char *buf, unsigned long size, int lines)
1042 {
1043         int i;
1044         const char *sp, *eol;
1045         size_t len;
1046
1047         sp = buf;
1048
1049         for (i = 0; i < lines && sp < buf + size; i++) {
1050                 if (i)
1051                         strbuf_addstr(out, "\n    ");
1052                 eol = memchr(sp, '\n', size - (sp - buf));
1053                 len = eol ? eol - sp : size - (sp - buf);
1054                 strbuf_add(out, sp, len);
1055                 if (!eol)
1056                         break;
1057                 sp = eol + 1;
1058         }
1059 }
1060
1061 /* See grab_values */
1062 static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
1063 {
1064         int i;
1065         const char *subpos = NULL, *bodypos = NULL, *sigpos = NULL;
1066         unsigned long sublen = 0, bodylen = 0, nonsiglen = 0, siglen = 0;
1067
1068         for (i = 0; i < used_atom_cnt; i++) {
1069                 struct used_atom *atom = &used_atom[i];
1070                 const char *name = atom->name;
1071                 struct atom_value *v = &val[i];
1072                 if (!!deref != (*name == '*'))
1073                         continue;
1074                 if (deref)
1075                         name++;
1076                 if (strcmp(name, "subject") &&
1077                     strcmp(name, "body") &&
1078                     !starts_with(name, "trailers") &&
1079                     !starts_with(name, "contents"))
1080                         continue;
1081                 if (!subpos)
1082                         find_subpos(buf, sz,
1083                                     &subpos, &sublen,
1084                                     &bodypos, &bodylen, &nonsiglen,
1085                                     &sigpos, &siglen);
1086
1087                 if (atom->u.contents.option == C_SUB)
1088                         v->s = copy_subject(subpos, sublen);
1089                 else if (atom->u.contents.option == C_BODY_DEP)
1090                         v->s = xmemdupz(bodypos, bodylen);
1091                 else if (atom->u.contents.option == C_BODY)
1092                         v->s = xmemdupz(bodypos, nonsiglen);
1093                 else if (atom->u.contents.option == C_SIG)
1094                         v->s = xmemdupz(sigpos, siglen);
1095                 else if (atom->u.contents.option == C_LINES) {
1096                         struct strbuf s = STRBUF_INIT;
1097                         const char *contents_end = bodylen + bodypos - siglen;
1098
1099                         /*  Size is the length of the message after removing the signature */
1100                         append_lines(&s, subpos, contents_end - subpos, atom->u.contents.nlines);
1101                         v->s = strbuf_detach(&s, NULL);
1102                 } else if (atom->u.contents.option == C_TRAILERS) {
1103                         struct strbuf s = STRBUF_INIT;
1104
1105                         /* Format the trailer info according to the trailer_opts given */
1106                         format_trailers_from_commit(&s, subpos, &atom->u.contents.trailer_opts);
1107
1108                         v->s = strbuf_detach(&s, NULL);
1109                 } else if (atom->u.contents.option == C_BARE)
1110                         v->s = xstrdup(subpos);
1111         }
1112 }
1113
1114 /*
1115  * We want to have empty print-string for field requests
1116  * that do not apply (e.g. "authordate" for a tag object)
1117  */
1118 static void fill_missing_values(struct atom_value *val)
1119 {
1120         int i;
1121         for (i = 0; i < used_atom_cnt; i++) {
1122                 struct atom_value *v = &val[i];
1123                 if (v->s == NULL)
1124                         v->s = "";
1125         }
1126 }
1127
1128 /*
1129  * val is a list of atom_value to hold returned values.  Extract
1130  * the values for atoms in used_atom array out of (obj, buf, sz).
1131  * when deref is false, (obj, buf, sz) is the object that is
1132  * pointed at by the ref itself; otherwise it is the object the
1133  * ref (which is a tag) refers to.
1134  */
1135 static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
1136 {
1137         grab_common_values(val, deref, obj, buf, sz);
1138         switch (obj->type) {
1139         case OBJ_TAG:
1140                 grab_tag_values(val, deref, obj, buf, sz);
1141                 grab_sub_body_contents(val, deref, obj, buf, sz);
1142                 grab_person("tagger", val, deref, obj, buf, sz);
1143                 break;
1144         case OBJ_COMMIT:
1145                 grab_commit_values(val, deref, obj, buf, sz);
1146                 grab_sub_body_contents(val, deref, obj, buf, sz);
1147                 grab_person("author", val, deref, obj, buf, sz);
1148                 grab_person("committer", val, deref, obj, buf, sz);
1149                 break;
1150         case OBJ_TREE:
1151                 /* grab_tree_values(val, deref, obj, buf, sz); */
1152                 break;
1153         case OBJ_BLOB:
1154                 /* grab_blob_values(val, deref, obj, buf, sz); */
1155                 break;
1156         default:
1157                 die("Eh?  Object of type %d?", obj->type);
1158         }
1159 }
1160
1161 static inline char *copy_advance(char *dst, const char *src)
1162 {
1163         while (*src)
1164                 *dst++ = *src++;
1165         return dst;
1166 }
1167
1168 static const char *lstrip_ref_components(const char *refname, int len)
1169 {
1170         long remaining = len;
1171         const char *start = refname;
1172
1173         if (len < 0) {
1174                 int i;
1175                 const char *p = refname;
1176
1177                 /* Find total no of '/' separated path-components */
1178                 for (i = 0; p[i]; p[i] == '/' ? i++ : *p++)
1179                         ;
1180                 /*
1181                  * The number of components we need to strip is now
1182                  * the total minus the components to be left (Plus one
1183                  * because we count the number of '/', but the number
1184                  * of components is one more than the no of '/').
1185                  */
1186                 remaining = i + len + 1;
1187         }
1188
1189         while (remaining > 0) {
1190                 switch (*start++) {
1191                 case '\0':
1192                         return "";
1193                 case '/':
1194                         remaining--;
1195                         break;
1196                 }
1197         }
1198
1199         return start;
1200 }
1201
1202 static const char *rstrip_ref_components(const char *refname, int len)
1203 {
1204         long remaining = len;
1205         char *start = xstrdup(refname);
1206
1207         if (len < 0) {
1208                 int i;
1209                 const char *p = refname;
1210
1211                 /* Find total no of '/' separated path-components */
1212                 for (i = 0; p[i]; p[i] == '/' ? i++ : *p++)
1213                         ;
1214                 /*
1215                  * The number of components we need to strip is now
1216                  * the total minus the components to be left (Plus one
1217                  * because we count the number of '/', but the number
1218                  * of components is one more than the no of '/').
1219                  */
1220                 remaining = i + len + 1;
1221         }
1222
1223         while (remaining-- > 0) {
1224                 char *p = strrchr(start, '/');
1225                 if (p == NULL)
1226                         return "";
1227                 else
1228                         p[0] = '\0';
1229         }
1230         return start;
1231 }
1232
1233 static const char *show_ref(struct refname_atom *atom, const char *refname)
1234 {
1235         if (atom->option == R_SHORT)
1236                 return shorten_unambiguous_ref(refname, warn_ambiguous_refs);
1237         else if (atom->option == R_LSTRIP)
1238                 return lstrip_ref_components(refname, atom->lstrip);
1239         else if (atom->option == R_RSTRIP)
1240                 return rstrip_ref_components(refname, atom->rstrip);
1241         else
1242                 return refname;
1243 }
1244
1245 static void fill_remote_ref_details(struct used_atom *atom, const char *refname,
1246                                     struct branch *branch, const char **s)
1247 {
1248         int num_ours, num_theirs;
1249         if (atom->u.remote_ref.option == RR_REF)
1250                 *s = show_ref(&atom->u.remote_ref.refname, refname);
1251         else if (atom->u.remote_ref.option == RR_TRACK) {
1252                 if (stat_tracking_info(branch, &num_ours, &num_theirs,
1253                                        NULL, AHEAD_BEHIND_FULL) < 0) {
1254                         *s = xstrdup(msgs.gone);
1255                 } else if (!num_ours && !num_theirs)
1256                         *s = "";
1257                 else if (!num_ours)
1258                         *s = xstrfmt(msgs.behind, num_theirs);
1259                 else if (!num_theirs)
1260                         *s = xstrfmt(msgs.ahead, num_ours);
1261                 else
1262                         *s = xstrfmt(msgs.ahead_behind,
1263                                      num_ours, num_theirs);
1264                 if (!atom->u.remote_ref.nobracket && *s[0]) {
1265                         const char *to_free = *s;
1266                         *s = xstrfmt("[%s]", *s);
1267                         free((void *)to_free);
1268                 }
1269         } else if (atom->u.remote_ref.option == RR_TRACKSHORT) {
1270                 if (stat_tracking_info(branch, &num_ours, &num_theirs,
1271                                        NULL, AHEAD_BEHIND_FULL) < 0)
1272                         return;
1273
1274                 if (!num_ours && !num_theirs)
1275                         *s = "=";
1276                 else if (!num_ours)
1277                         *s = "<";
1278                 else if (!num_theirs)
1279                         *s = ">";
1280                 else
1281                         *s = "<>";
1282         } else if (atom->u.remote_ref.option == RR_REMOTE_NAME) {
1283                 int explicit;
1284                 const char *remote = atom->u.remote_ref.push ?
1285                         pushremote_for_branch(branch, &explicit) :
1286                         remote_for_branch(branch, &explicit);
1287                 if (explicit)
1288                         *s = xstrdup(remote);
1289                 else
1290                         *s = "";
1291         } else if (atom->u.remote_ref.option == RR_REMOTE_REF) {
1292                 int explicit;
1293                 const char *merge;
1294
1295                 merge = remote_ref_for_branch(branch, atom->u.remote_ref.push,
1296                                               &explicit);
1297                 if (explicit)
1298                         *s = xstrdup(merge);
1299                 else
1300                         *s = "";
1301         } else
1302                 die("BUG: unhandled RR_* enum");
1303 }
1304
1305 char *get_head_description(void)
1306 {
1307         struct strbuf desc = STRBUF_INIT;
1308         struct wt_status_state state;
1309         memset(&state, 0, sizeof(state));
1310         wt_status_get_state(&state, 1);
1311         if (state.rebase_in_progress ||
1312             state.rebase_interactive_in_progress) {
1313                 if (state.branch)
1314                         strbuf_addf(&desc, _("(no branch, rebasing %s)"),
1315                                     state.branch);
1316                 else
1317                         strbuf_addf(&desc, _("(no branch, rebasing detached HEAD %s)"),
1318                                     state.detached_from);
1319         } else if (state.bisect_in_progress)
1320                 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
1321                             state.branch);
1322         else if (state.detached_from) {
1323                 if (state.detached_at)
1324                         /*
1325                          * TRANSLATORS: make sure this matches "HEAD
1326                          * detached at " in wt-status.c
1327                          */
1328                         strbuf_addf(&desc, _("(HEAD detached at %s)"),
1329                                 state.detached_from);
1330                 else
1331                         /*
1332                          * TRANSLATORS: make sure this matches "HEAD
1333                          * detached from " in wt-status.c
1334                          */
1335                         strbuf_addf(&desc, _("(HEAD detached from %s)"),
1336                                 state.detached_from);
1337         }
1338         else
1339                 strbuf_addstr(&desc, _("(no branch)"));
1340         free(state.branch);
1341         free(state.onto);
1342         free(state.detached_from);
1343         return strbuf_detach(&desc, NULL);
1344 }
1345
1346 static const char *get_symref(struct used_atom *atom, struct ref_array_item *ref)
1347 {
1348         if (!ref->symref)
1349                 return "";
1350         else
1351                 return show_ref(&atom->u.refname, ref->symref);
1352 }
1353
1354 static const char *get_refname(struct used_atom *atom, struct ref_array_item *ref)
1355 {
1356         if (ref->kind & FILTER_REFS_DETACHED_HEAD)
1357                 return get_head_description();
1358         return show_ref(&atom->u.refname, ref->refname);
1359 }
1360
1361 static void get_object(struct ref_array_item *ref, const struct object_id *oid,
1362                        int deref, struct object **obj)
1363 {
1364         int eaten;
1365         unsigned long size;
1366         void *buf = get_obj(oid, obj, &size, &eaten);
1367         if (!buf)
1368                 die(_("missing object %s for %s"),
1369                     oid_to_hex(oid), ref->refname);
1370         if (!*obj)
1371                 die(_("parse_object_buffer failed on %s for %s"),
1372                     oid_to_hex(oid), ref->refname);
1373
1374         grab_values(ref->value, deref, *obj, buf, size);
1375         if (!eaten)
1376                 free(buf);
1377 }
1378
1379 /*
1380  * Parse the object referred by ref, and grab needed value.
1381  */
1382 static void populate_value(struct ref_array_item *ref)
1383 {
1384         struct object *obj;
1385         int i;
1386         const struct object_id *tagged;
1387
1388         ref->value = xcalloc(used_atom_cnt, sizeof(struct atom_value));
1389
1390         if (need_symref && (ref->flag & REF_ISSYMREF) && !ref->symref) {
1391                 ref->symref = resolve_refdup(ref->refname, RESOLVE_REF_READING,
1392                                              NULL, NULL);
1393                 if (!ref->symref)
1394                         ref->symref = "";
1395         }
1396
1397         /* Fill in specials first */
1398         for (i = 0; i < used_atom_cnt; i++) {
1399                 struct used_atom *atom = &used_atom[i];
1400                 const char *name = used_atom[i].name;
1401                 struct atom_value *v = &ref->value[i];
1402                 int deref = 0;
1403                 const char *refname;
1404                 struct branch *branch = NULL;
1405
1406                 v->handler = append_atom;
1407                 v->atom = atom;
1408
1409                 if (*name == '*') {
1410                         deref = 1;
1411                         name++;
1412                 }
1413
1414                 if (starts_with(name, "refname"))
1415                         refname = get_refname(atom, ref);
1416                 else if (starts_with(name, "symref"))
1417                         refname = get_symref(atom, ref);
1418                 else if (starts_with(name, "upstream")) {
1419                         const char *branch_name;
1420                         /* only local branches may have an upstream */
1421                         if (!skip_prefix(ref->refname, "refs/heads/",
1422                                          &branch_name))
1423                                 continue;
1424                         branch = branch_get(branch_name);
1425
1426                         refname = branch_get_upstream(branch, NULL);
1427                         if (refname)
1428                                 fill_remote_ref_details(atom, refname, branch, &v->s);
1429                         continue;
1430                 } else if (atom->u.remote_ref.push) {
1431                         const char *branch_name;
1432                         if (!skip_prefix(ref->refname, "refs/heads/",
1433                                          &branch_name))
1434                                 continue;
1435                         branch = branch_get(branch_name);
1436
1437                         if (atom->u.remote_ref.push_remote)
1438                                 refname = NULL;
1439                         else {
1440                                 refname = branch_get_push(branch, NULL);
1441                                 if (!refname)
1442                                         continue;
1443                         }
1444                         fill_remote_ref_details(atom, refname, branch, &v->s);
1445                         continue;
1446                 } else if (starts_with(name, "color:")) {
1447                         v->s = atom->u.color;
1448                         continue;
1449                 } else if (!strcmp(name, "flag")) {
1450                         char buf[256], *cp = buf;
1451                         if (ref->flag & REF_ISSYMREF)
1452                                 cp = copy_advance(cp, ",symref");
1453                         if (ref->flag & REF_ISPACKED)
1454                                 cp = copy_advance(cp, ",packed");
1455                         if (cp == buf)
1456                                 v->s = "";
1457                         else {
1458                                 *cp = '\0';
1459                                 v->s = xstrdup(buf + 1);
1460                         }
1461                         continue;
1462                 } else if (!deref && grab_objectname(name, &ref->objectname, v, atom)) {
1463                         continue;
1464                 } else if (!strcmp(name, "HEAD")) {
1465                         if (atom->u.head && !strcmp(ref->refname, atom->u.head))
1466                                 v->s = "*";
1467                         else
1468                                 v->s = " ";
1469                         continue;
1470                 } else if (starts_with(name, "align")) {
1471                         v->handler = align_atom_handler;
1472                         continue;
1473                 } else if (!strcmp(name, "end")) {
1474                         v->handler = end_atom_handler;
1475                         continue;
1476                 } else if (starts_with(name, "if")) {
1477                         const char *s;
1478
1479                         if (skip_prefix(name, "if:", &s))
1480                                 v->s = xstrdup(s);
1481                         v->handler = if_atom_handler;
1482                         continue;
1483                 } else if (!strcmp(name, "then")) {
1484                         v->handler = then_atom_handler;
1485                         continue;
1486                 } else if (!strcmp(name, "else")) {
1487                         v->handler = else_atom_handler;
1488                         continue;
1489                 } else
1490                         continue;
1491
1492                 if (!deref)
1493                         v->s = refname;
1494                 else
1495                         v->s = xstrfmt("%s^{}", refname);
1496         }
1497
1498         for (i = 0; i < used_atom_cnt; i++) {
1499                 struct atom_value *v = &ref->value[i];
1500                 if (v->s == NULL)
1501                         break;
1502         }
1503         if (used_atom_cnt <= i)
1504                 return;
1505
1506         get_object(ref, &ref->objectname, 0, &obj);
1507
1508         /*
1509          * If there is no atom that wants to know about tagged
1510          * object, we are done.
1511          */
1512         if (!need_tagged || (obj->type != OBJ_TAG))
1513                 return;
1514
1515         /*
1516          * If it is a tag object, see if we use a value that derefs
1517          * the object, and if we do grab the object it refers to.
1518          */
1519         tagged = &((struct tag *)obj)->tagged->oid;
1520
1521         /*
1522          * NEEDSWORK: This derefs tag only once, which
1523          * is good to deal with chains of trust, but
1524          * is not consistent with what deref_tag() does
1525          * which peels the onion to the core.
1526          */
1527         get_object(ref, tagged, 1, &obj);
1528 }
1529
1530 /*
1531  * Given a ref, return the value for the atom.  This lazily gets value
1532  * out of the object by calling populate value.
1533  */
1534 static void get_ref_atom_value(struct ref_array_item *ref, int atom, struct atom_value **v)
1535 {
1536         if (!ref->value) {
1537                 populate_value(ref);
1538                 fill_missing_values(ref->value);
1539         }
1540         *v = &ref->value[atom];
1541 }
1542
1543 /*
1544  * Unknown has to be "0" here, because that's the default value for
1545  * contains_cache slab entries that have not yet been assigned.
1546  */
1547 enum contains_result {
1548         CONTAINS_UNKNOWN = 0,
1549         CONTAINS_NO,
1550         CONTAINS_YES
1551 };
1552
1553 define_commit_slab(contains_cache, enum contains_result);
1554
1555 struct ref_filter_cbdata {
1556         struct ref_array *array;
1557         struct ref_filter *filter;
1558         struct contains_cache contains_cache;
1559         struct contains_cache no_contains_cache;
1560 };
1561
1562 /*
1563  * Mimicking the real stack, this stack lives on the heap, avoiding stack
1564  * overflows.
1565  *
1566  * At each recursion step, the stack items points to the commits whose
1567  * ancestors are to be inspected.
1568  */
1569 struct contains_stack {
1570         int nr, alloc;
1571         struct contains_stack_entry {
1572                 struct commit *commit;
1573                 struct commit_list *parents;
1574         } *contains_stack;
1575 };
1576
1577 static int in_commit_list(const struct commit_list *want, struct commit *c)
1578 {
1579         for (; want; want = want->next)
1580                 if (!oidcmp(&want->item->object.oid, &c->object.oid))
1581                         return 1;
1582         return 0;
1583 }
1584
1585 /*
1586  * Test whether the candidate or one of its parents is contained in the list.
1587  * Do not recurse to find out, though, but return -1 if inconclusive.
1588  */
1589 static enum contains_result contains_test(struct commit *candidate,
1590                                           const struct commit_list *want,
1591                                           struct contains_cache *cache)
1592 {
1593         enum contains_result *cached = contains_cache_at(cache, candidate);
1594
1595         /* If we already have the answer cached, return that. */
1596         if (*cached)
1597                 return *cached;
1598
1599         /* or are we it? */
1600         if (in_commit_list(want, candidate)) {
1601                 *cached = CONTAINS_YES;
1602                 return CONTAINS_YES;
1603         }
1604
1605         /* Otherwise, we don't know; prepare to recurse */
1606         parse_commit_or_die(candidate);
1607         return CONTAINS_UNKNOWN;
1608 }
1609
1610 static void push_to_contains_stack(struct commit *candidate, struct contains_stack *contains_stack)
1611 {
1612         ALLOC_GROW(contains_stack->contains_stack, contains_stack->nr + 1, contains_stack->alloc);
1613         contains_stack->contains_stack[contains_stack->nr].commit = candidate;
1614         contains_stack->contains_stack[contains_stack->nr++].parents = candidate->parents;
1615 }
1616
1617 static enum contains_result contains_tag_algo(struct commit *candidate,
1618                                               const struct commit_list *want,
1619                                               struct contains_cache *cache)
1620 {
1621         struct contains_stack contains_stack = { 0, 0, NULL };
1622         enum contains_result result = contains_test(candidate, want, cache);
1623
1624         if (result != CONTAINS_UNKNOWN)
1625                 return result;
1626
1627         push_to_contains_stack(candidate, &contains_stack);
1628         while (contains_stack.nr) {
1629                 struct contains_stack_entry *entry = &contains_stack.contains_stack[contains_stack.nr - 1];
1630                 struct commit *commit = entry->commit;
1631                 struct commit_list *parents = entry->parents;
1632
1633                 if (!parents) {
1634                         *contains_cache_at(cache, commit) = CONTAINS_NO;
1635                         contains_stack.nr--;
1636                 }
1637                 /*
1638                  * If we just popped the stack, parents->item has been marked,
1639                  * therefore contains_test will return a meaningful yes/no.
1640                  */
1641                 else switch (contains_test(parents->item, want, cache)) {
1642                 case CONTAINS_YES:
1643                         *contains_cache_at(cache, commit) = CONTAINS_YES;
1644                         contains_stack.nr--;
1645                         break;
1646                 case CONTAINS_NO:
1647                         entry->parents = parents->next;
1648                         break;
1649                 case CONTAINS_UNKNOWN:
1650                         push_to_contains_stack(parents->item, &contains_stack);
1651                         break;
1652                 }
1653         }
1654         free(contains_stack.contains_stack);
1655         return contains_test(candidate, want, cache);
1656 }
1657
1658 static int commit_contains(struct ref_filter *filter, struct commit *commit,
1659                            struct commit_list *list, struct contains_cache *cache)
1660 {
1661         if (filter->with_commit_tag_algo)
1662                 return contains_tag_algo(commit, list, cache) == CONTAINS_YES;
1663         return is_descendant_of(commit, list);
1664 }
1665
1666 /*
1667  * Return 1 if the refname matches one of the patterns, otherwise 0.
1668  * A pattern can be a literal prefix (e.g. a refname "refs/heads/master"
1669  * matches a pattern "refs/heads/mas") or a wildcard (e.g. the same ref
1670  * matches "refs/heads/mas*", too).
1671  */
1672 static int match_pattern(const struct ref_filter *filter, const char *refname)
1673 {
1674         const char **patterns = filter->name_patterns;
1675         unsigned flags = 0;
1676
1677         if (filter->ignore_case)
1678                 flags |= WM_CASEFOLD;
1679
1680         /*
1681          * When no '--format' option is given we need to skip the prefix
1682          * for matching refs of tags and branches.
1683          */
1684         (void)(skip_prefix(refname, "refs/tags/", &refname) ||
1685                skip_prefix(refname, "refs/heads/", &refname) ||
1686                skip_prefix(refname, "refs/remotes/", &refname) ||
1687                skip_prefix(refname, "refs/", &refname));
1688
1689         for (; *patterns; patterns++) {
1690                 if (!wildmatch(*patterns, refname, flags))
1691                         return 1;
1692         }
1693         return 0;
1694 }
1695
1696 /*
1697  * Return 1 if the refname matches one of the patterns, otherwise 0.
1698  * A pattern can be path prefix (e.g. a refname "refs/heads/master"
1699  * matches a pattern "refs/heads/" but not "refs/heads/m") or a
1700  * wildcard (e.g. the same ref matches "refs/heads/m*", too).
1701  */
1702 static int match_name_as_path(const struct ref_filter *filter, const char *refname)
1703 {
1704         const char **pattern = filter->name_patterns;
1705         int namelen = strlen(refname);
1706         unsigned flags = WM_PATHNAME;
1707
1708         if (filter->ignore_case)
1709                 flags |= WM_CASEFOLD;
1710
1711         for (; *pattern; pattern++) {
1712                 const char *p = *pattern;
1713                 int plen = strlen(p);
1714
1715                 if ((plen <= namelen) &&
1716                     !strncmp(refname, p, plen) &&
1717                     (refname[plen] == '\0' ||
1718                      refname[plen] == '/' ||
1719                      p[plen-1] == '/'))
1720                         return 1;
1721                 if (!wildmatch(p, refname, WM_PATHNAME))
1722                         return 1;
1723         }
1724         return 0;
1725 }
1726
1727 /* Return 1 if the refname matches one of the patterns, otherwise 0. */
1728 static int filter_pattern_match(struct ref_filter *filter, const char *refname)
1729 {
1730         if (!*filter->name_patterns)
1731                 return 1; /* No pattern always matches */
1732         if (filter->match_as_path)
1733                 return match_name_as_path(filter, refname);
1734         return match_pattern(filter, refname);
1735 }
1736
1737 /*
1738  * Find the longest prefix of pattern we can pass to
1739  * `for_each_fullref_in()`, namely the part of pattern preceding the
1740  * first glob character. (Note that `for_each_fullref_in()` is
1741  * perfectly happy working with a prefix that doesn't end at a
1742  * pathname component boundary.)
1743  */
1744 static void find_longest_prefix(struct strbuf *out, const char *pattern)
1745 {
1746         const char *p;
1747
1748         for (p = pattern; *p && !is_glob_special(*p); p++)
1749                 ;
1750
1751         strbuf_add(out, pattern, p - pattern);
1752 }
1753
1754 /*
1755  * This is the same as for_each_fullref_in(), but it tries to iterate
1756  * only over the patterns we'll care about. Note that it _doesn't_ do a full
1757  * pattern match, so the callback still has to match each ref individually.
1758  */
1759 static int for_each_fullref_in_pattern(struct ref_filter *filter,
1760                                        each_ref_fn cb,
1761                                        void *cb_data,
1762                                        int broken)
1763 {
1764         struct strbuf prefix = STRBUF_INIT;
1765         int ret;
1766
1767         if (!filter->match_as_path) {
1768                 /*
1769                  * in this case, the patterns are applied after
1770                  * prefixes like "refs/heads/" etc. are stripped off,
1771                  * so we have to look at everything:
1772                  */
1773                 return for_each_fullref_in("", cb, cb_data, broken);
1774         }
1775
1776         if (!filter->name_patterns[0]) {
1777                 /* no patterns; we have to look at everything */
1778                 return for_each_fullref_in("", cb, cb_data, broken);
1779         }
1780
1781         if (filter->name_patterns[1]) {
1782                 /*
1783                  * multiple patterns; in theory this could still work as long
1784                  * as the patterns are disjoint. We'd just make multiple calls
1785                  * to for_each_ref(). But if they're not disjoint, we'd end up
1786                  * reporting the same ref multiple times. So let's punt on that
1787                  * for now.
1788                  */
1789                 return for_each_fullref_in("", cb, cb_data, broken);
1790         }
1791
1792         find_longest_prefix(&prefix, filter->name_patterns[0]);
1793
1794         ret = for_each_fullref_in(prefix.buf, cb, cb_data, broken);
1795         strbuf_release(&prefix);
1796         return ret;
1797 }
1798
1799 /*
1800  * Given a ref (sha1, refname), check if the ref belongs to the array
1801  * of sha1s. If the given ref is a tag, check if the given tag points
1802  * at one of the sha1s in the given sha1 array.
1803  * the given sha1_array.
1804  * NEEDSWORK:
1805  * 1. Only a single level of inderection is obtained, we might want to
1806  * change this to account for multiple levels (e.g. annotated tags
1807  * pointing to annotated tags pointing to a commit.)
1808  * 2. As the refs are cached we might know what refname peels to without
1809  * the need to parse the object via parse_object(). peel_ref() might be a
1810  * more efficient alternative to obtain the pointee.
1811  */
1812 static const struct object_id *match_points_at(struct oid_array *points_at,
1813                                                const struct object_id *oid,
1814                                                const char *refname)
1815 {
1816         const struct object_id *tagged_oid = NULL;
1817         struct object *obj;
1818
1819         if (oid_array_lookup(points_at, oid) >= 0)
1820                 return oid;
1821         obj = parse_object(oid);
1822         if (!obj)
1823                 die(_("malformed object at '%s'"), refname);
1824         if (obj->type == OBJ_TAG)
1825                 tagged_oid = &((struct tag *)obj)->tagged->oid;
1826         if (tagged_oid && oid_array_lookup(points_at, tagged_oid) >= 0)
1827                 return tagged_oid;
1828         return NULL;
1829 }
1830
1831 /*
1832  * Allocate space for a new ref_array_item and copy the name and oid to it.
1833  *
1834  * Callers can then fill in other struct members at their leisure.
1835  */
1836 static struct ref_array_item *new_ref_array_item(const char *refname,
1837                                                  const struct object_id *oid)
1838 {
1839         struct ref_array_item *ref;
1840
1841         FLEX_ALLOC_STR(ref, refname, refname);
1842         oidcpy(&ref->objectname, oid);
1843
1844         return ref;
1845 }
1846
1847 struct ref_array_item *ref_array_push(struct ref_array *array,
1848                                       const char *refname,
1849                                       const struct object_id *oid)
1850 {
1851         struct ref_array_item *ref = new_ref_array_item(refname, oid);
1852
1853         ALLOC_GROW(array->items, array->nr + 1, array->alloc);
1854         array->items[array->nr++] = ref;
1855
1856         return ref;
1857 }
1858
1859 static int ref_kind_from_refname(const char *refname)
1860 {
1861         unsigned int i;
1862
1863         static struct {
1864                 const char *prefix;
1865                 unsigned int kind;
1866         } ref_kind[] = {
1867                 { "refs/heads/" , FILTER_REFS_BRANCHES },
1868                 { "refs/remotes/" , FILTER_REFS_REMOTES },
1869                 { "refs/tags/", FILTER_REFS_TAGS}
1870         };
1871
1872         if (!strcmp(refname, "HEAD"))
1873                 return FILTER_REFS_DETACHED_HEAD;
1874
1875         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
1876                 if (starts_with(refname, ref_kind[i].prefix))
1877                         return ref_kind[i].kind;
1878         }
1879
1880         return FILTER_REFS_OTHERS;
1881 }
1882
1883 static int filter_ref_kind(struct ref_filter *filter, const char *refname)
1884 {
1885         if (filter->kind == FILTER_REFS_BRANCHES ||
1886             filter->kind == FILTER_REFS_REMOTES ||
1887             filter->kind == FILTER_REFS_TAGS)
1888                 return filter->kind;
1889         return ref_kind_from_refname(refname);
1890 }
1891
1892 /*
1893  * A call-back given to for_each_ref().  Filter refs and keep them for
1894  * later object processing.
1895  */
1896 static int ref_filter_handler(const char *refname, const struct object_id *oid, int flag, void *cb_data)
1897 {
1898         struct ref_filter_cbdata *ref_cbdata = cb_data;
1899         struct ref_filter *filter = ref_cbdata->filter;
1900         struct ref_array_item *ref;
1901         struct commit *commit = NULL;
1902         unsigned int kind;
1903
1904         if (flag & REF_BAD_NAME) {
1905                 warning(_("ignoring ref with broken name %s"), refname);
1906                 return 0;
1907         }
1908
1909         if (flag & REF_ISBROKEN) {
1910                 warning(_("ignoring broken ref %s"), refname);
1911                 return 0;
1912         }
1913
1914         /* Obtain the current ref kind from filter_ref_kind() and ignore unwanted refs. */
1915         kind = filter_ref_kind(filter, refname);
1916         if (!(kind & filter->kind))
1917                 return 0;
1918
1919         if (!filter_pattern_match(filter, refname))
1920                 return 0;
1921
1922         if (filter->points_at.nr && !match_points_at(&filter->points_at, oid, refname))
1923                 return 0;
1924
1925         /*
1926          * A merge filter is applied on refs pointing to commits. Hence
1927          * obtain the commit using the 'oid' available and discard all
1928          * non-commits early. The actual filtering is done later.
1929          */
1930         if (filter->merge_commit || filter->with_commit || filter->no_commit || filter->verbose) {
1931                 commit = lookup_commit_reference_gently(oid, 1);
1932                 if (!commit)
1933                         return 0;
1934                 /* We perform the filtering for the '--contains' option... */
1935                 if (filter->with_commit &&
1936                     !commit_contains(filter, commit, filter->with_commit, &ref_cbdata->contains_cache))
1937                         return 0;
1938                 /* ...or for the `--no-contains' option */
1939                 if (filter->no_commit &&
1940                     commit_contains(filter, commit, filter->no_commit, &ref_cbdata->no_contains_cache))
1941                         return 0;
1942         }
1943
1944         /*
1945          * We do not open the object yet; sort may only need refname
1946          * to do its job and the resulting list may yet to be pruned
1947          * by maxcount logic.
1948          */
1949         ref = ref_array_push(ref_cbdata->array, refname, oid);
1950         ref->commit = commit;
1951         ref->flag = flag;
1952         ref->kind = kind;
1953
1954         return 0;
1955 }
1956
1957 /*  Free memory allocated for a ref_array_item */
1958 static void free_array_item(struct ref_array_item *item)
1959 {
1960         free((char *)item->symref);
1961         free(item);
1962 }
1963
1964 /* Free all memory allocated for ref_array */
1965 void ref_array_clear(struct ref_array *array)
1966 {
1967         int i;
1968
1969         for (i = 0; i < array->nr; i++)
1970                 free_array_item(array->items[i]);
1971         FREE_AND_NULL(array->items);
1972         array->nr = array->alloc = 0;
1973 }
1974
1975 static void do_merge_filter(struct ref_filter_cbdata *ref_cbdata)
1976 {
1977         struct rev_info revs;
1978         int i, old_nr;
1979         struct ref_filter *filter = ref_cbdata->filter;
1980         struct ref_array *array = ref_cbdata->array;
1981         struct commit **to_clear = xcalloc(sizeof(struct commit *), array->nr);
1982
1983         init_revisions(&revs, NULL);
1984
1985         for (i = 0; i < array->nr; i++) {
1986                 struct ref_array_item *item = array->items[i];
1987                 add_pending_object(&revs, &item->commit->object, item->refname);
1988                 to_clear[i] = item->commit;
1989         }
1990
1991         filter->merge_commit->object.flags |= UNINTERESTING;
1992         add_pending_object(&revs, &filter->merge_commit->object, "");
1993
1994         revs.limited = 1;
1995         if (prepare_revision_walk(&revs))
1996                 die(_("revision walk setup failed"));
1997
1998         old_nr = array->nr;
1999         array->nr = 0;
2000
2001         for (i = 0; i < old_nr; i++) {
2002                 struct ref_array_item *item = array->items[i];
2003                 struct commit *commit = item->commit;
2004
2005                 int is_merged = !!(commit->object.flags & UNINTERESTING);
2006
2007                 if (is_merged == (filter->merge == REF_FILTER_MERGED_INCLUDE))
2008                         array->items[array->nr++] = array->items[i];
2009                 else
2010                         free_array_item(item);
2011         }
2012
2013         clear_commit_marks_many(old_nr, to_clear, ALL_REV_FLAGS);
2014         clear_commit_marks(filter->merge_commit, ALL_REV_FLAGS);
2015         free(to_clear);
2016 }
2017
2018 /*
2019  * API for filtering a set of refs. Based on the type of refs the user
2020  * has requested, we iterate through those refs and apply filters
2021  * as per the given ref_filter structure and finally store the
2022  * filtered refs in the ref_array structure.
2023  */
2024 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type)
2025 {
2026         struct ref_filter_cbdata ref_cbdata;
2027         int ret = 0;
2028         unsigned int broken = 0;
2029
2030         ref_cbdata.array = array;
2031         ref_cbdata.filter = filter;
2032
2033         if (type & FILTER_REFS_INCLUDE_BROKEN)
2034                 broken = 1;
2035         filter->kind = type & FILTER_REFS_KIND_MASK;
2036
2037         init_contains_cache(&ref_cbdata.contains_cache);
2038         init_contains_cache(&ref_cbdata.no_contains_cache);
2039
2040         /*  Simple per-ref filtering */
2041         if (!filter->kind)
2042                 die("filter_refs: invalid type");
2043         else {
2044                 /*
2045                  * For common cases where we need only branches or remotes or tags,
2046                  * we only iterate through those refs. If a mix of refs is needed,
2047                  * we iterate over all refs and filter out required refs with the help
2048                  * of filter_ref_kind().
2049                  */
2050                 if (filter->kind == FILTER_REFS_BRANCHES)
2051                         ret = for_each_fullref_in("refs/heads/", ref_filter_handler, &ref_cbdata, broken);
2052                 else if (filter->kind == FILTER_REFS_REMOTES)
2053                         ret = for_each_fullref_in("refs/remotes/", ref_filter_handler, &ref_cbdata, broken);
2054                 else if (filter->kind == FILTER_REFS_TAGS)
2055                         ret = for_each_fullref_in("refs/tags/", ref_filter_handler, &ref_cbdata, broken);
2056                 else if (filter->kind & FILTER_REFS_ALL)
2057                         ret = for_each_fullref_in_pattern(filter, ref_filter_handler, &ref_cbdata, broken);
2058                 if (!ret && (filter->kind & FILTER_REFS_DETACHED_HEAD))
2059                         head_ref(ref_filter_handler, &ref_cbdata);
2060         }
2061
2062         clear_contains_cache(&ref_cbdata.contains_cache);
2063         clear_contains_cache(&ref_cbdata.no_contains_cache);
2064
2065         /*  Filters that need revision walking */
2066         if (filter->merge_commit)
2067                 do_merge_filter(&ref_cbdata);
2068
2069         return ret;
2070 }
2071
2072 static int cmp_ref_sorting(struct ref_sorting *s, struct ref_array_item *a, struct ref_array_item *b)
2073 {
2074         struct atom_value *va, *vb;
2075         int cmp;
2076         cmp_type cmp_type = used_atom[s->atom].type;
2077         int (*cmp_fn)(const char *, const char *);
2078
2079         get_ref_atom_value(a, s->atom, &va);
2080         get_ref_atom_value(b, s->atom, &vb);
2081         cmp_fn = s->ignore_case ? strcasecmp : strcmp;
2082         if (s->version)
2083                 cmp = versioncmp(va->s, vb->s);
2084         else if (cmp_type == FIELD_STR)
2085                 cmp = cmp_fn(va->s, vb->s);
2086         else {
2087                 if (va->value < vb->value)
2088                         cmp = -1;
2089                 else if (va->value == vb->value)
2090                         cmp = cmp_fn(a->refname, b->refname);
2091                 else
2092                         cmp = 1;
2093         }
2094
2095         return (s->reverse) ? -cmp : cmp;
2096 }
2097
2098 static int compare_refs(const void *a_, const void *b_, void *ref_sorting)
2099 {
2100         struct ref_array_item *a = *((struct ref_array_item **)a_);
2101         struct ref_array_item *b = *((struct ref_array_item **)b_);
2102         struct ref_sorting *s;
2103
2104         for (s = ref_sorting; s; s = s->next) {
2105                 int cmp = cmp_ref_sorting(s, a, b);
2106                 if (cmp)
2107                         return cmp;
2108         }
2109         return 0;
2110 }
2111
2112 void ref_array_sort(struct ref_sorting *sorting, struct ref_array *array)
2113 {
2114         QSORT_S(array->items, array->nr, compare_refs, sorting);
2115 }
2116
2117 static void append_literal(const char *cp, const char *ep, struct ref_formatting_state *state)
2118 {
2119         struct strbuf *s = &state->stack->output;
2120
2121         while (*cp && (!ep || cp < ep)) {
2122                 if (*cp == '%') {
2123                         if (cp[1] == '%')
2124                                 cp++;
2125                         else {
2126                                 int ch = hex2chr(cp + 1);
2127                                 if (0 <= ch) {
2128                                         strbuf_addch(s, ch);
2129                                         cp += 3;
2130                                         continue;
2131                                 }
2132                         }
2133                 }
2134                 strbuf_addch(s, *cp);
2135                 cp++;
2136         }
2137 }
2138
2139 void format_ref_array_item(struct ref_array_item *info,
2140                            const struct ref_format *format,
2141                            struct strbuf *final_buf)
2142 {
2143         const char *cp, *sp, *ep;
2144         struct ref_formatting_state state = REF_FORMATTING_STATE_INIT;
2145
2146         state.quote_style = format->quote_style;
2147         push_stack_element(&state.stack);
2148
2149         for (cp = format->format; *cp && (sp = find_next(cp)); cp = ep + 1) {
2150                 struct atom_value *atomv;
2151
2152                 ep = strchr(sp, ')');
2153                 if (cp < sp)
2154                         append_literal(cp, sp, &state);
2155                 get_ref_atom_value(info,
2156                                    parse_ref_filter_atom(format, sp + 2, ep),
2157                                    &atomv);
2158                 atomv->handler(atomv, &state);
2159         }
2160         if (*cp) {
2161                 sp = cp + strlen(cp);
2162                 append_literal(cp, sp, &state);
2163         }
2164         if (format->need_color_reset_at_eol) {
2165                 struct atom_value resetv;
2166                 resetv.s = GIT_COLOR_RESET;
2167                 append_atom(&resetv, &state);
2168         }
2169         if (state.stack->prev)
2170                 die(_("format: %%(end) atom missing"));
2171         strbuf_addbuf(final_buf, &state.stack->output);
2172         pop_stack_element(&state.stack);
2173 }
2174
2175 void show_ref_array_item(struct ref_array_item *info,
2176                          const struct ref_format *format)
2177 {
2178         struct strbuf final_buf = STRBUF_INIT;
2179
2180         format_ref_array_item(info, format, &final_buf);
2181         fwrite(final_buf.buf, 1, final_buf.len, stdout);
2182         strbuf_release(&final_buf);
2183         putchar('\n');
2184 }
2185
2186 void pretty_print_ref(const char *name, const struct object_id *oid,
2187                       const struct ref_format *format)
2188 {
2189         struct ref_array_item *ref_item;
2190         ref_item = new_ref_array_item(name, oid);
2191         ref_item->kind = ref_kind_from_refname(name);
2192         show_ref_array_item(ref_item, format);
2193         free_array_item(ref_item);
2194 }
2195
2196 static int parse_sorting_atom(const char *atom)
2197 {
2198         /*
2199          * This parses an atom using a dummy ref_format, since we don't
2200          * actually care about the formatting details.
2201          */
2202         struct ref_format dummy = REF_FORMAT_INIT;
2203         const char *end = atom + strlen(atom);
2204         return parse_ref_filter_atom(&dummy, atom, end);
2205 }
2206
2207 /*  If no sorting option is given, use refname to sort as default */
2208 struct ref_sorting *ref_default_sorting(void)
2209 {
2210         static const char cstr_name[] = "refname";
2211
2212         struct ref_sorting *sorting = xcalloc(1, sizeof(*sorting));
2213
2214         sorting->next = NULL;
2215         sorting->atom = parse_sorting_atom(cstr_name);
2216         return sorting;
2217 }
2218
2219 void parse_ref_sorting(struct ref_sorting **sorting_tail, const char *arg)
2220 {
2221         struct ref_sorting *s;
2222
2223         s = xcalloc(1, sizeof(*s));
2224         s->next = *sorting_tail;
2225         *sorting_tail = s;
2226
2227         if (*arg == '-') {
2228                 s->reverse = 1;
2229                 arg++;
2230         }
2231         if (skip_prefix(arg, "version:", &arg) ||
2232             skip_prefix(arg, "v:", &arg))
2233                 s->version = 1;
2234         s->atom = parse_sorting_atom(arg);
2235 }
2236
2237 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset)
2238 {
2239         if (!arg) /* should --no-sort void the list ? */
2240                 return -1;
2241         parse_ref_sorting(opt->value, arg);
2242         return 0;
2243 }
2244
2245 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset)
2246 {
2247         struct ref_filter *rf = opt->value;
2248         struct object_id oid;
2249         int no_merged = starts_with(opt->long_name, "no");
2250
2251         if (rf->merge) {
2252                 if (no_merged) {
2253                         return opterror(opt, "is incompatible with --merged", 0);
2254                 } else {
2255                         return opterror(opt, "is incompatible with --no-merged", 0);
2256                 }
2257         }
2258
2259         rf->merge = no_merged
2260                 ? REF_FILTER_MERGED_OMIT
2261                 : REF_FILTER_MERGED_INCLUDE;
2262
2263         if (get_oid(arg, &oid))
2264                 die(_("malformed object name %s"), arg);
2265
2266         rf->merge_commit = lookup_commit_reference_gently(&oid, 0);
2267         if (!rf->merge_commit)
2268                 return opterror(opt, "must point to a commit", 0);
2269
2270         return 0;
2271 }