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