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