3 #include "parse-options.h"
11 #include "ref-filter.h"
14 #include "git-compat-util.h"
17 #include "wt-status.h"
18 #include "commit-slab.h"
20 static struct ref_msg
{
24 const char *ahead_behind
;
26 /* Untranslated plumbing messages: */
33 void setup_ref_filter_porcelain_msg(void)
35 msgs
.gone
= _("gone");
36 msgs
.ahead
= _("ahead %d");
37 msgs
.behind
= _("behind %d");
38 msgs
.ahead_behind
= _("ahead %d, behind %d");
41 typedef enum { FIELD_STR
, FIELD_ULONG
, FIELD_TIME
} cmp_type
;
42 typedef enum { COMPARE_EQUAL
, COMPARE_UNEQUAL
, COMPARE_NONE
} cmp_status
;
50 cmp_status cmp_status
;
52 unsigned int then_atom_seen
: 1,
54 condition_satisfied
: 1;
58 enum { R_NORMAL
, R_SHORT
, R_LSTRIP
, R_RSTRIP
} option
;
63 * An atom is a valid field atom listed below, possibly prefixed with
64 * a "*" to denote deref_tag().
66 * We parse given format string and sort specifiers, and make a list
67 * of properties that we need to extract out of objects. ref_array_item
68 * structure will hold an array of values extracted that can be
69 * indexed with the "atom number", which is an index into this
72 static struct used_atom
{
76 char color
[COLOR_MAXLEN
];
80 RR_REF
, RR_TRACK
, RR_TRACKSHORT
, RR_REMOTE_NAME
, RR_REMOTE_REF
82 struct refname_atom refname
;
83 unsigned int nobracket
: 1, push
: 1, push_remote
: 1;
86 enum { C_BARE
, C_BODY
, C_BODY_DEP
, C_LINES
, C_SIG
, C_SUB
, C_TRAILERS
} option
;
87 struct process_trailer_options trailer_opts
;
91 cmp_status cmp_status
;
95 enum { O_FULL
, O_LENGTH
, O_SHORT
} option
;
98 struct refname_atom refname
;
102 static int used_atom_cnt
, need_tagged
, need_symref
;
105 * Expand string, append it to strbuf *sb, then return error code ret.
106 * Allow to save few lines of code.
108 static int strbuf_addf_ret(struct strbuf
*sb
, int ret
, const char *fmt
, ...)
112 strbuf_vaddf(sb
, fmt
, ap
);
117 static void color_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *color_value
)
120 die(_("expected format: %%(color:<color>)"));
121 if (color_parse(color_value
, atom
->u
.color
) < 0)
122 die(_("unrecognized color: %%(color:%s)"), color_value
);
124 * We check this after we've parsed the color, which lets us complain
125 * about syntactically bogus color names even if they won't be used.
127 if (!want_color(format
->use_color
))
128 color_parse("", atom
->u
.color
);
131 static void refname_atom_parser_internal(struct refname_atom
*atom
,
132 const char *arg
, const char *name
)
135 atom
->option
= R_NORMAL
;
136 else if (!strcmp(arg
, "short"))
137 atom
->option
= R_SHORT
;
138 else if (skip_prefix(arg
, "lstrip=", &arg
) ||
139 skip_prefix(arg
, "strip=", &arg
)) {
140 atom
->option
= R_LSTRIP
;
141 if (strtol_i(arg
, 10, &atom
->lstrip
))
142 die(_("Integer value expected refname:lstrip=%s"), arg
);
143 } else if (skip_prefix(arg
, "rstrip=", &arg
)) {
144 atom
->option
= R_RSTRIP
;
145 if (strtol_i(arg
, 10, &atom
->rstrip
))
146 die(_("Integer value expected refname:rstrip=%s"), arg
);
148 die(_("unrecognized %%(%s) argument: %s"), name
, arg
);
151 static void remote_ref_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
153 struct string_list params
= STRING_LIST_INIT_DUP
;
156 if (!strcmp(atom
->name
, "push") || starts_with(atom
->name
, "push:"))
157 atom
->u
.remote_ref
.push
= 1;
160 atom
->u
.remote_ref
.option
= RR_REF
;
161 refname_atom_parser_internal(&atom
->u
.remote_ref
.refname
,
166 atom
->u
.remote_ref
.nobracket
= 0;
167 string_list_split(¶ms
, arg
, ',', -1);
169 for (i
= 0; i
< params
.nr
; i
++) {
170 const char *s
= params
.items
[i
].string
;
172 if (!strcmp(s
, "track"))
173 atom
->u
.remote_ref
.option
= RR_TRACK
;
174 else if (!strcmp(s
, "trackshort"))
175 atom
->u
.remote_ref
.option
= RR_TRACKSHORT
;
176 else if (!strcmp(s
, "nobracket"))
177 atom
->u
.remote_ref
.nobracket
= 1;
178 else if (!strcmp(s
, "remotename")) {
179 atom
->u
.remote_ref
.option
= RR_REMOTE_NAME
;
180 atom
->u
.remote_ref
.push_remote
= 1;
181 } else if (!strcmp(s
, "remoteref")) {
182 atom
->u
.remote_ref
.option
= RR_REMOTE_REF
;
183 atom
->u
.remote_ref
.push_remote
= 1;
185 atom
->u
.remote_ref
.option
= RR_REF
;
186 refname_atom_parser_internal(&atom
->u
.remote_ref
.refname
,
191 string_list_clear(¶ms
, 0);
194 static void body_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
197 die(_("%%(body) does not take arguments"));
198 atom
->u
.contents
.option
= C_BODY_DEP
;
201 static void subject_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
204 die(_("%%(subject) does not take arguments"));
205 atom
->u
.contents
.option
= C_SUB
;
208 static void trailers_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
210 struct string_list params
= STRING_LIST_INIT_DUP
;
214 string_list_split(¶ms
, arg
, ',', -1);
215 for (i
= 0; i
< params
.nr
; i
++) {
216 const char *s
= params
.items
[i
].string
;
217 if (!strcmp(s
, "unfold"))
218 atom
->u
.contents
.trailer_opts
.unfold
= 1;
219 else if (!strcmp(s
, "only"))
220 atom
->u
.contents
.trailer_opts
.only_trailers
= 1;
222 die(_("unknown %%(trailers) argument: %s"), s
);
225 atom
->u
.contents
.option
= C_TRAILERS
;
226 string_list_clear(¶ms
, 0);
229 static void contents_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
232 atom
->u
.contents
.option
= C_BARE
;
233 else if (!strcmp(arg
, "body"))
234 atom
->u
.contents
.option
= C_BODY
;
235 else if (!strcmp(arg
, "signature"))
236 atom
->u
.contents
.option
= C_SIG
;
237 else if (!strcmp(arg
, "subject"))
238 atom
->u
.contents
.option
= C_SUB
;
239 else if (skip_prefix(arg
, "trailers", &arg
)) {
240 skip_prefix(arg
, ":", &arg
);
241 trailers_atom_parser(format
, atom
, *arg
? arg
: NULL
);
242 } else if (skip_prefix(arg
, "lines=", &arg
)) {
243 atom
->u
.contents
.option
= C_LINES
;
244 if (strtoul_ui(arg
, 10, &atom
->u
.contents
.nlines
))
245 die(_("positive value expected contents:lines=%s"), arg
);
247 die(_("unrecognized %%(contents) argument: %s"), arg
);
250 static void objectname_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
253 atom
->u
.objectname
.option
= O_FULL
;
254 else if (!strcmp(arg
, "short"))
255 atom
->u
.objectname
.option
= O_SHORT
;
256 else if (skip_prefix(arg
, "short=", &arg
)) {
257 atom
->u
.objectname
.option
= O_LENGTH
;
258 if (strtoul_ui(arg
, 10, &atom
->u
.objectname
.length
) ||
259 atom
->u
.objectname
.length
== 0)
260 die(_("positive value expected objectname:short=%s"), arg
);
261 if (atom
->u
.objectname
.length
< MINIMUM_ABBREV
)
262 atom
->u
.objectname
.length
= MINIMUM_ABBREV
;
264 die(_("unrecognized %%(objectname) argument: %s"), arg
);
267 static void refname_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
269 refname_atom_parser_internal(&atom
->u
.refname
, arg
, atom
->name
);
272 static align_type
parse_align_position(const char *s
)
274 if (!strcmp(s
, "right"))
276 else if (!strcmp(s
, "middle"))
278 else if (!strcmp(s
, "left"))
283 static void align_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
285 struct align
*align
= &atom
->u
.align
;
286 struct string_list params
= STRING_LIST_INIT_DUP
;
288 unsigned int width
= ~0U;
291 die(_("expected format: %%(align:<width>,<position>)"));
293 align
->position
= ALIGN_LEFT
;
295 string_list_split(¶ms
, arg
, ',', -1);
296 for (i
= 0; i
< params
.nr
; i
++) {
297 const char *s
= params
.items
[i
].string
;
300 if (skip_prefix(s
, "position=", &s
)) {
301 position
= parse_align_position(s
);
303 die(_("unrecognized position:%s"), s
);
304 align
->position
= position
;
305 } else if (skip_prefix(s
, "width=", &s
)) {
306 if (strtoul_ui(s
, 10, &width
))
307 die(_("unrecognized width:%s"), s
);
308 } else if (!strtoul_ui(s
, 10, &width
))
310 else if ((position
= parse_align_position(s
)) >= 0)
311 align
->position
= position
;
313 die(_("unrecognized %%(align) argument: %s"), s
);
317 die(_("positive width expected with the %%(align) atom"));
318 align
->width
= width
;
319 string_list_clear(¶ms
, 0);
322 static void if_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
325 atom
->u
.if_then_else
.cmp_status
= COMPARE_NONE
;
327 } else if (skip_prefix(arg
, "equals=", &atom
->u
.if_then_else
.str
)) {
328 atom
->u
.if_then_else
.cmp_status
= COMPARE_EQUAL
;
329 } else if (skip_prefix(arg
, "notequals=", &atom
->u
.if_then_else
.str
)) {
330 atom
->u
.if_then_else
.cmp_status
= COMPARE_UNEQUAL
;
332 die(_("unrecognized %%(if) argument: %s"), arg
);
336 static void head_atom_parser(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
)
338 atom
->u
.head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, NULL
, NULL
);
344 void (*parser
)(const struct ref_format
*format
, struct used_atom
*atom
, const char *arg
);
346 { "refname" , FIELD_STR
, refname_atom_parser
},
348 { "objectsize", FIELD_ULONG
},
349 { "objectname", FIELD_STR
, objectname_atom_parser
},
352 { "numparent", FIELD_ULONG
},
359 { "authordate", FIELD_TIME
},
362 { "committeremail" },
363 { "committerdate", FIELD_TIME
},
367 { "taggerdate", FIELD_TIME
},
369 { "creatordate", FIELD_TIME
},
370 { "subject", FIELD_STR
, subject_atom_parser
},
371 { "body", FIELD_STR
, body_atom_parser
},
372 { "trailers", FIELD_STR
, trailers_atom_parser
},
373 { "contents", FIELD_STR
, contents_atom_parser
},
374 { "upstream", FIELD_STR
, remote_ref_atom_parser
},
375 { "push", FIELD_STR
, remote_ref_atom_parser
},
376 { "symref", FIELD_STR
, refname_atom_parser
},
378 { "HEAD", FIELD_STR
, head_atom_parser
},
379 { "color", FIELD_STR
, color_atom_parser
},
380 { "align", FIELD_STR
, align_atom_parser
},
382 { "if", FIELD_STR
, if_atom_parser
},
387 #define REF_FORMATTING_STATE_INIT { 0, NULL }
389 struct ref_formatting_stack
{
390 struct ref_formatting_stack
*prev
;
391 struct strbuf output
;
392 void (*at_end
)(struct ref_formatting_stack
**stack
);
396 struct ref_formatting_state
{
398 struct ref_formatting_stack
*stack
;
403 void (*handler
)(struct atom_value
*atomv
, struct ref_formatting_state
*state
);
404 uintmax_t value
; /* used for sorting when not FIELD_STR */
405 struct used_atom
*atom
;
409 * Used to parse format string and sort specifiers
411 static int parse_ref_filter_atom(const struct ref_format
*format
,
412 const char *atom
, const char *ep
)
419 if (*sp
== '*' && sp
< ep
)
422 die(_("malformed field name: %.*s"), (int)(ep
-atom
), atom
);
424 /* Do we have the atom already used elsewhere? */
425 for (i
= 0; i
< used_atom_cnt
; i
++) {
426 int len
= strlen(used_atom
[i
].name
);
427 if (len
== ep
- atom
&& !memcmp(used_atom
[i
].name
, atom
, len
))
432 * If the atom name has a colon, strip it and everything after
433 * it off - it specifies the format for this entry, and
434 * shouldn't be used for checking against the valid_atom
437 arg
= memchr(sp
, ':', ep
- sp
);
438 atom_len
= (arg
? arg
: ep
) - sp
;
440 /* Is the atom a valid one? */
441 for (i
= 0; i
< ARRAY_SIZE(valid_atom
); i
++) {
442 int len
= strlen(valid_atom
[i
].name
);
443 if (len
== atom_len
&& !memcmp(valid_atom
[i
].name
, sp
, len
))
447 if (ARRAY_SIZE(valid_atom
) <= i
)
448 die(_("unknown field name: %.*s"), (int)(ep
-atom
), atom
);
450 /* Add it in, including the deref prefix */
453 REALLOC_ARRAY(used_atom
, used_atom_cnt
);
454 used_atom
[at
].name
= xmemdupz(atom
, ep
- atom
);
455 used_atom
[at
].type
= valid_atom
[i
].cmp_type
;
457 arg
= used_atom
[at
].name
+ (arg
- atom
) + 1;
460 * Treat empty sub-arguments list as NULL (i.e.,
461 * "%(atom:)" is equivalent to "%(atom)").
466 memset(&used_atom
[at
].u
, 0, sizeof(used_atom
[at
].u
));
467 if (valid_atom
[i
].parser
)
468 valid_atom
[i
].parser(format
, &used_atom
[at
], arg
);
471 if (!strcmp(valid_atom
[i
].name
, "symref"))
476 static void quote_formatting(struct strbuf
*s
, const char *str
, int quote_style
)
478 switch (quote_style
) {
480 strbuf_addstr(s
, str
);
483 sq_quote_buf(s
, str
);
486 perl_quote_buf(s
, str
);
489 python_quote_buf(s
, str
);
492 tcl_quote_buf(s
, str
);
497 static void append_atom(struct atom_value
*v
, struct ref_formatting_state
*state
)
500 * Quote formatting is only done when the stack has a single
501 * element. Otherwise quote formatting is done on the
502 * element's entire output strbuf when the %(end) atom is
505 if (!state
->stack
->prev
)
506 quote_formatting(&state
->stack
->output
, v
->s
, state
->quote_style
);
508 strbuf_addstr(&state
->stack
->output
, v
->s
);
511 static void push_stack_element(struct ref_formatting_stack
**stack
)
513 struct ref_formatting_stack
*s
= xcalloc(1, sizeof(struct ref_formatting_stack
));
515 strbuf_init(&s
->output
, 0);
520 static void pop_stack_element(struct ref_formatting_stack
**stack
)
522 struct ref_formatting_stack
*current
= *stack
;
523 struct ref_formatting_stack
*prev
= current
->prev
;
526 strbuf_addbuf(&prev
->output
, ¤t
->output
);
527 strbuf_release(¤t
->output
);
532 static void end_align_handler(struct ref_formatting_stack
**stack
)
534 struct ref_formatting_stack
*cur
= *stack
;
535 struct align
*align
= (struct align
*)cur
->at_end_data
;
536 struct strbuf s
= STRBUF_INIT
;
538 strbuf_utf8_align(&s
, align
->position
, align
->width
, cur
->output
.buf
);
539 strbuf_swap(&cur
->output
, &s
);
543 static void align_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
545 struct ref_formatting_stack
*new_stack
;
547 push_stack_element(&state
->stack
);
548 new_stack
= state
->stack
;
549 new_stack
->at_end
= end_align_handler
;
550 new_stack
->at_end_data
= &atomv
->atom
->u
.align
;
553 static void if_then_else_handler(struct ref_formatting_stack
**stack
)
555 struct ref_formatting_stack
*cur
= *stack
;
556 struct ref_formatting_stack
*prev
= cur
->prev
;
557 struct if_then_else
*if_then_else
= (struct if_then_else
*)cur
->at_end_data
;
559 if (!if_then_else
->then_atom_seen
)
560 die(_("format: %%(if) atom used without a %%(then) atom"));
562 if (if_then_else
->else_atom_seen
) {
564 * There is an %(else) atom: we need to drop one state from the
565 * stack, either the %(else) branch if the condition is satisfied, or
566 * the %(then) branch if it isn't.
568 if (if_then_else
->condition_satisfied
) {
569 strbuf_reset(&cur
->output
);
570 pop_stack_element(&cur
);
572 strbuf_swap(&cur
->output
, &prev
->output
);
573 strbuf_reset(&cur
->output
);
574 pop_stack_element(&cur
);
576 } else if (!if_then_else
->condition_satisfied
) {
578 * No %(else) atom: just drop the %(then) branch if the
579 * condition is not satisfied.
581 strbuf_reset(&cur
->output
);
588 static void if_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
590 struct ref_formatting_stack
*new_stack
;
591 struct if_then_else
*if_then_else
= xcalloc(sizeof(struct if_then_else
), 1);
593 if_then_else
->str
= atomv
->atom
->u
.if_then_else
.str
;
594 if_then_else
->cmp_status
= atomv
->atom
->u
.if_then_else
.cmp_status
;
596 push_stack_element(&state
->stack
);
597 new_stack
= state
->stack
;
598 new_stack
->at_end
= if_then_else_handler
;
599 new_stack
->at_end_data
= if_then_else
;
602 static int is_empty(const char *s
)
612 static void then_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
614 struct ref_formatting_stack
*cur
= state
->stack
;
615 struct if_then_else
*if_then_else
= NULL
;
617 if (cur
->at_end
== if_then_else_handler
)
618 if_then_else
= (struct if_then_else
*)cur
->at_end_data
;
620 die(_("format: %%(then) atom used without an %%(if) atom"));
621 if (if_then_else
->then_atom_seen
)
622 die(_("format: %%(then) atom used more than once"));
623 if (if_then_else
->else_atom_seen
)
624 die(_("format: %%(then) atom used after %%(else)"));
625 if_then_else
->then_atom_seen
= 1;
627 * If the 'equals' or 'notequals' attribute is used then
628 * perform the required comparison. If not, only non-empty
629 * strings satisfy the 'if' condition.
631 if (if_then_else
->cmp_status
== COMPARE_EQUAL
) {
632 if (!strcmp(if_then_else
->str
, cur
->output
.buf
))
633 if_then_else
->condition_satisfied
= 1;
634 } else if (if_then_else
->cmp_status
== COMPARE_UNEQUAL
) {
635 if (strcmp(if_then_else
->str
, cur
->output
.buf
))
636 if_then_else
->condition_satisfied
= 1;
637 } else if (cur
->output
.len
&& !is_empty(cur
->output
.buf
))
638 if_then_else
->condition_satisfied
= 1;
639 strbuf_reset(&cur
->output
);
642 static void else_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
644 struct ref_formatting_stack
*prev
= state
->stack
;
645 struct if_then_else
*if_then_else
= NULL
;
647 if (prev
->at_end
== if_then_else_handler
)
648 if_then_else
= (struct if_then_else
*)prev
->at_end_data
;
650 die(_("format: %%(else) atom used without an %%(if) atom"));
651 if (!if_then_else
->then_atom_seen
)
652 die(_("format: %%(else) atom used without a %%(then) atom"));
653 if (if_then_else
->else_atom_seen
)
654 die(_("format: %%(else) atom used more than once"));
655 if_then_else
->else_atom_seen
= 1;
656 push_stack_element(&state
->stack
);
657 state
->stack
->at_end_data
= prev
->at_end_data
;
658 state
->stack
->at_end
= prev
->at_end
;
661 static void end_atom_handler(struct atom_value
*atomv
, struct ref_formatting_state
*state
)
663 struct ref_formatting_stack
*current
= state
->stack
;
664 struct strbuf s
= STRBUF_INIT
;
666 if (!current
->at_end
)
667 die(_("format: %%(end) atom used without corresponding atom"));
668 current
->at_end(&state
->stack
);
670 /* Stack may have been popped within at_end(), hence reset the current pointer */
671 current
= state
->stack
;
674 * Perform quote formatting when the stack element is that of
675 * a supporting atom. If nested then perform quote formatting
676 * only on the topmost supporting atom.
678 if (!current
->prev
->prev
) {
679 quote_formatting(&s
, current
->output
.buf
, state
->quote_style
);
680 strbuf_swap(¤t
->output
, &s
);
683 pop_stack_element(&state
->stack
);
687 * In a format string, find the next occurrence of %(atom).
689 static const char *find_next(const char *cp
)
694 * %( is the start of an atom;
695 * %% is a quoted per-cent.
699 else if (cp
[1] == '%')
700 cp
++; /* skip over two % */
701 /* otherwise this is a singleton, literal % */
709 * Make sure the format string is well formed, and parse out
712 int verify_ref_format(struct ref_format
*format
)
716 format
->need_color_reset_at_eol
= 0;
717 for (cp
= format
->format
; *cp
&& (sp
= find_next(cp
)); ) {
718 const char *color
, *ep
= strchr(sp
, ')');
722 return error(_("malformed format string %s"), sp
);
723 /* sp points at "%(" and ep points at the closing ")" */
724 at
= parse_ref_filter_atom(format
, sp
+ 2, ep
);
727 if (skip_prefix(used_atom
[at
].name
, "color:", &color
))
728 format
->need_color_reset_at_eol
= !!strcmp(color
, "reset");
730 if (format
->need_color_reset_at_eol
&& !want_color(format
->use_color
))
731 format
->need_color_reset_at_eol
= 0;
736 * Given an object name, read the object data and size, and return a
737 * "struct object". If the object data we are returning is also borrowed
738 * by the "struct object" representation, set *eaten as well---it is a
739 * signal from parse_object_buffer to us not to free the buffer.
741 static void *get_obj(const struct object_id
*oid
, struct object
**obj
, unsigned long *sz
, int *eaten
)
743 enum object_type type
;
744 void *buf
= read_sha1_file(oid
->hash
, &type
, sz
);
747 *obj
= parse_object_buffer(oid
, type
, *sz
, buf
, eaten
);
753 static int grab_objectname(const char *name
, const unsigned char *sha1
,
754 struct atom_value
*v
, struct used_atom
*atom
)
756 if (starts_with(name
, "objectname")) {
757 if (atom
->u
.objectname
.option
== O_SHORT
) {
758 v
->s
= xstrdup(find_unique_abbrev(sha1
, DEFAULT_ABBREV
));
760 } else if (atom
->u
.objectname
.option
== O_FULL
) {
761 v
->s
= xstrdup(sha1_to_hex(sha1
));
763 } else if (atom
->u
.objectname
.option
== O_LENGTH
) {
764 v
->s
= xstrdup(find_unique_abbrev(sha1
, atom
->u
.objectname
.length
));
767 die("BUG: unknown %%(objectname) option");
772 /* See grab_values */
773 static void grab_common_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
777 for (i
= 0; i
< used_atom_cnt
; i
++) {
778 const char *name
= used_atom
[i
].name
;
779 struct atom_value
*v
= &val
[i
];
780 if (!!deref
!= (*name
== '*'))
784 if (!strcmp(name
, "objecttype"))
785 v
->s
= type_name(obj
->type
);
786 else if (!strcmp(name
, "objectsize")) {
788 v
->s
= xstrfmt("%lu", sz
);
791 grab_objectname(name
, obj
->oid
.hash
, v
, &used_atom
[i
]);
795 /* See grab_values */
796 static void grab_tag_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
799 struct tag
*tag
= (struct tag
*) obj
;
801 for (i
= 0; i
< used_atom_cnt
; i
++) {
802 const char *name
= used_atom
[i
].name
;
803 struct atom_value
*v
= &val
[i
];
804 if (!!deref
!= (*name
== '*'))
808 if (!strcmp(name
, "tag"))
810 else if (!strcmp(name
, "type") && tag
->tagged
)
811 v
->s
= type_name(tag
->tagged
->type
);
812 else if (!strcmp(name
, "object") && tag
->tagged
)
813 v
->s
= xstrdup(oid_to_hex(&tag
->tagged
->oid
));
817 /* See grab_values */
818 static void grab_commit_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
821 struct commit
*commit
= (struct commit
*) obj
;
823 for (i
= 0; i
< used_atom_cnt
; i
++) {
824 const char *name
= used_atom
[i
].name
;
825 struct atom_value
*v
= &val
[i
];
826 if (!!deref
!= (*name
== '*'))
830 if (!strcmp(name
, "tree")) {
831 v
->s
= xstrdup(oid_to_hex(&commit
->tree
->object
.oid
));
833 else if (!strcmp(name
, "numparent")) {
834 v
->value
= commit_list_count(commit
->parents
);
835 v
->s
= xstrfmt("%lu", (unsigned long)v
->value
);
837 else if (!strcmp(name
, "parent")) {
838 struct commit_list
*parents
;
839 struct strbuf s
= STRBUF_INIT
;
840 for (parents
= commit
->parents
; parents
; parents
= parents
->next
) {
841 struct commit
*parent
= parents
->item
;
842 if (parents
!= commit
->parents
)
843 strbuf_addch(&s
, ' ');
844 strbuf_addstr(&s
, oid_to_hex(&parent
->object
.oid
));
846 v
->s
= strbuf_detach(&s
, NULL
);
851 static const char *find_wholine(const char *who
, int wholen
, const char *buf
, unsigned long sz
)
855 if (!strncmp(buf
, who
, wholen
) &&
857 return buf
+ wholen
+ 1;
858 eol
= strchr(buf
, '\n');
863 return ""; /* end of header */
869 static const char *copy_line(const char *buf
)
871 const char *eol
= strchrnul(buf
, '\n');
872 return xmemdupz(buf
, eol
- buf
);
875 static const char *copy_name(const char *buf
)
878 for (cp
= buf
; *cp
&& *cp
!= '\n'; cp
++) {
879 if (!strncmp(cp
, " <", 2))
880 return xmemdupz(buf
, cp
- buf
);
885 static const char *copy_email(const char *buf
)
887 const char *email
= strchr(buf
, '<');
891 eoemail
= strchr(email
, '>');
894 return xmemdupz(email
, eoemail
+ 1 - email
);
897 static char *copy_subject(const char *buf
, unsigned long len
)
899 char *r
= xmemdupz(buf
, len
);
902 for (i
= 0; i
< len
; i
++)
909 static void grab_date(const char *buf
, struct atom_value
*v
, const char *atomname
)
911 const char *eoemail
= strstr(buf
, "> ");
913 timestamp_t timestamp
;
915 struct date_mode date_mode
= { DATE_NORMAL
};
919 * We got here because atomname ends in "date" or "date<something>";
920 * it's not possible that <something> is not ":<format>" because
921 * parse_ref_filter_atom() wouldn't have allowed it, so we can assume that no
922 * ":" means no format is specified, and use the default.
924 formatp
= strchr(atomname
, ':');
925 if (formatp
!= NULL
) {
927 parse_date_format(formatp
, &date_mode
);
932 timestamp
= parse_timestamp(eoemail
+ 2, &zone
, 10);
933 if (timestamp
== TIME_MAX
)
935 tz
= strtol(zone
, NULL
, 10);
936 if ((tz
== LONG_MIN
|| tz
== LONG_MAX
) && errno
== ERANGE
)
938 v
->s
= xstrdup(show_date(timestamp
, tz
, &date_mode
));
939 v
->value
= timestamp
;
946 /* See grab_values */
947 static void grab_person(const char *who
, struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
950 int wholen
= strlen(who
);
951 const char *wholine
= NULL
;
953 for (i
= 0; i
< used_atom_cnt
; i
++) {
954 const char *name
= used_atom
[i
].name
;
955 struct atom_value
*v
= &val
[i
];
956 if (!!deref
!= (*name
== '*'))
960 if (strncmp(who
, name
, wholen
))
962 if (name
[wholen
] != 0 &&
963 strcmp(name
+ wholen
, "name") &&
964 strcmp(name
+ wholen
, "email") &&
965 !starts_with(name
+ wholen
, "date"))
968 wholine
= find_wholine(who
, wholen
, buf
, sz
);
970 return; /* no point looking for it */
971 if (name
[wholen
] == 0)
972 v
->s
= copy_line(wholine
);
973 else if (!strcmp(name
+ wholen
, "name"))
974 v
->s
= copy_name(wholine
);
975 else if (!strcmp(name
+ wholen
, "email"))
976 v
->s
= copy_email(wholine
);
977 else if (starts_with(name
+ wholen
, "date"))
978 grab_date(wholine
, v
, name
);
982 * For a tag or a commit object, if "creator" or "creatordate" is
983 * requested, do something special.
985 if (strcmp(who
, "tagger") && strcmp(who
, "committer"))
986 return; /* "author" for commit object is not wanted */
988 wholine
= find_wholine(who
, wholen
, buf
, sz
);
991 for (i
= 0; i
< used_atom_cnt
; i
++) {
992 const char *name
= used_atom
[i
].name
;
993 struct atom_value
*v
= &val
[i
];
994 if (!!deref
!= (*name
== '*'))
999 if (starts_with(name
, "creatordate"))
1000 grab_date(wholine
, v
, name
);
1001 else if (!strcmp(name
, "creator"))
1002 v
->s
= copy_line(wholine
);
1006 static void find_subpos(const char *buf
, unsigned long sz
,
1007 const char **sub
, unsigned long *sublen
,
1008 const char **body
, unsigned long *bodylen
,
1009 unsigned long *nonsiglen
,
1010 const char **sig
, unsigned long *siglen
)
1013 /* skip past header until we hit empty line */
1014 while (*buf
&& *buf
!= '\n') {
1015 eol
= strchrnul(buf
, '\n');
1020 /* skip any empty lines */
1021 while (*buf
== '\n')
1024 /* parse signature first; we might not even have a subject line */
1025 *sig
= buf
+ parse_signature(buf
, strlen(buf
));
1026 *siglen
= strlen(*sig
);
1028 /* subject is first non-empty line */
1030 /* subject goes to first empty line */
1031 while (buf
< *sig
&& *buf
&& *buf
!= '\n') {
1032 eol
= strchrnul(buf
, '\n');
1037 *sublen
= buf
- *sub
;
1038 /* drop trailing newline, if present */
1039 if (*sublen
&& (*sub
)[*sublen
- 1] == '\n')
1042 /* skip any empty lines */
1043 while (*buf
== '\n')
1046 *bodylen
= strlen(buf
);
1047 *nonsiglen
= *sig
- buf
;
1051 * If 'lines' is greater than 0, append that many lines from the given
1052 * 'buf' of length 'size' to the given strbuf.
1054 static void append_lines(struct strbuf
*out
, const char *buf
, unsigned long size
, int lines
)
1057 const char *sp
, *eol
;
1062 for (i
= 0; i
< lines
&& sp
< buf
+ size
; i
++) {
1064 strbuf_addstr(out
, "\n ");
1065 eol
= memchr(sp
, '\n', size
- (sp
- buf
));
1066 len
= eol
? eol
- sp
: size
- (sp
- buf
);
1067 strbuf_add(out
, sp
, len
);
1074 /* See grab_values */
1075 static void grab_sub_body_contents(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
1078 const char *subpos
= NULL
, *bodypos
= NULL
, *sigpos
= NULL
;
1079 unsigned long sublen
= 0, bodylen
= 0, nonsiglen
= 0, siglen
= 0;
1081 for (i
= 0; i
< used_atom_cnt
; i
++) {
1082 struct used_atom
*atom
= &used_atom
[i
];
1083 const char *name
= atom
->name
;
1084 struct atom_value
*v
= &val
[i
];
1085 if (!!deref
!= (*name
== '*'))
1089 if (strcmp(name
, "subject") &&
1090 strcmp(name
, "body") &&
1091 !starts_with(name
, "trailers") &&
1092 !starts_with(name
, "contents"))
1095 find_subpos(buf
, sz
,
1097 &bodypos
, &bodylen
, &nonsiglen
,
1100 if (atom
->u
.contents
.option
== C_SUB
)
1101 v
->s
= copy_subject(subpos
, sublen
);
1102 else if (atom
->u
.contents
.option
== C_BODY_DEP
)
1103 v
->s
= xmemdupz(bodypos
, bodylen
);
1104 else if (atom
->u
.contents
.option
== C_BODY
)
1105 v
->s
= xmemdupz(bodypos
, nonsiglen
);
1106 else if (atom
->u
.contents
.option
== C_SIG
)
1107 v
->s
= xmemdupz(sigpos
, siglen
);
1108 else if (atom
->u
.contents
.option
== C_LINES
) {
1109 struct strbuf s
= STRBUF_INIT
;
1110 const char *contents_end
= bodylen
+ bodypos
- siglen
;
1112 /* Size is the length of the message after removing the signature */
1113 append_lines(&s
, subpos
, contents_end
- subpos
, atom
->u
.contents
.nlines
);
1114 v
->s
= strbuf_detach(&s
, NULL
);
1115 } else if (atom
->u
.contents
.option
== C_TRAILERS
) {
1116 struct strbuf s
= STRBUF_INIT
;
1118 /* Format the trailer info according to the trailer_opts given */
1119 format_trailers_from_commit(&s
, subpos
, &atom
->u
.contents
.trailer_opts
);
1121 v
->s
= strbuf_detach(&s
, NULL
);
1122 } else if (atom
->u
.contents
.option
== C_BARE
)
1123 v
->s
= xstrdup(subpos
);
1128 * We want to have empty print-string for field requests
1129 * that do not apply (e.g. "authordate" for a tag object)
1131 static void fill_missing_values(struct atom_value
*val
)
1134 for (i
= 0; i
< used_atom_cnt
; i
++) {
1135 struct atom_value
*v
= &val
[i
];
1142 * val is a list of atom_value to hold returned values. Extract
1143 * the values for atoms in used_atom array out of (obj, buf, sz).
1144 * when deref is false, (obj, buf, sz) is the object that is
1145 * pointed at by the ref itself; otherwise it is the object the
1146 * ref (which is a tag) refers to.
1148 static void grab_values(struct atom_value
*val
, int deref
, struct object
*obj
, void *buf
, unsigned long sz
)
1150 grab_common_values(val
, deref
, obj
, buf
, sz
);
1151 switch (obj
->type
) {
1153 grab_tag_values(val
, deref
, obj
, buf
, sz
);
1154 grab_sub_body_contents(val
, deref
, obj
, buf
, sz
);
1155 grab_person("tagger", val
, deref
, obj
, buf
, sz
);
1158 grab_commit_values(val
, deref
, obj
, buf
, sz
);
1159 grab_sub_body_contents(val
, deref
, obj
, buf
, sz
);
1160 grab_person("author", val
, deref
, obj
, buf
, sz
);
1161 grab_person("committer", val
, deref
, obj
, buf
, sz
);
1164 /* grab_tree_values(val, deref, obj, buf, sz); */
1167 /* grab_blob_values(val, deref, obj, buf, sz); */
1170 die("Eh? Object of type %d?", obj
->type
);
1174 static inline char *copy_advance(char *dst
, const char *src
)
1181 static const char *lstrip_ref_components(const char *refname
, int len
)
1183 long remaining
= len
;
1184 const char *start
= refname
;
1188 const char *p
= refname
;
1190 /* Find total no of '/' separated path-components */
1191 for (i
= 0; p
[i
]; p
[i
] == '/' ? i
++ : *p
++)
1194 * The number of components we need to strip is now
1195 * the total minus the components to be left (Plus one
1196 * because we count the number of '/', but the number
1197 * of components is one more than the no of '/').
1199 remaining
= i
+ len
+ 1;
1202 while (remaining
> 0) {
1215 static const char *rstrip_ref_components(const char *refname
, int len
)
1217 long remaining
= len
;
1218 char *start
= xstrdup(refname
);
1222 const char *p
= refname
;
1224 /* Find total no of '/' separated path-components */
1225 for (i
= 0; p
[i
]; p
[i
] == '/' ? i
++ : *p
++)
1228 * The number of components we need to strip is now
1229 * the total minus the components to be left (Plus one
1230 * because we count the number of '/', but the number
1231 * of components is one more than the no of '/').
1233 remaining
= i
+ len
+ 1;
1236 while (remaining
-- > 0) {
1237 char *p
= strrchr(start
, '/');
1246 static const char *show_ref(struct refname_atom
*atom
, const char *refname
)
1248 if (atom
->option
== R_SHORT
)
1249 return shorten_unambiguous_ref(refname
, warn_ambiguous_refs
);
1250 else if (atom
->option
== R_LSTRIP
)
1251 return lstrip_ref_components(refname
, atom
->lstrip
);
1252 else if (atom
->option
== R_RSTRIP
)
1253 return rstrip_ref_components(refname
, atom
->rstrip
);
1258 static void fill_remote_ref_details(struct used_atom
*atom
, const char *refname
,
1259 struct branch
*branch
, const char **s
)
1261 int num_ours
, num_theirs
;
1262 if (atom
->u
.remote_ref
.option
== RR_REF
)
1263 *s
= show_ref(&atom
->u
.remote_ref
.refname
, refname
);
1264 else if (atom
->u
.remote_ref
.option
== RR_TRACK
) {
1265 if (stat_tracking_info(branch
, &num_ours
, &num_theirs
,
1266 NULL
, AHEAD_BEHIND_FULL
) < 0) {
1267 *s
= xstrdup(msgs
.gone
);
1268 } else if (!num_ours
&& !num_theirs
)
1271 *s
= xstrfmt(msgs
.behind
, num_theirs
);
1272 else if (!num_theirs
)
1273 *s
= xstrfmt(msgs
.ahead
, num_ours
);
1275 *s
= xstrfmt(msgs
.ahead_behind
,
1276 num_ours
, num_theirs
);
1277 if (!atom
->u
.remote_ref
.nobracket
&& *s
[0]) {
1278 const char *to_free
= *s
;
1279 *s
= xstrfmt("[%s]", *s
);
1280 free((void *)to_free
);
1282 } else if (atom
->u
.remote_ref
.option
== RR_TRACKSHORT
) {
1283 if (stat_tracking_info(branch
, &num_ours
, &num_theirs
,
1284 NULL
, AHEAD_BEHIND_FULL
) < 0)
1287 if (!num_ours
&& !num_theirs
)
1291 else if (!num_theirs
)
1295 } else if (atom
->u
.remote_ref
.option
== RR_REMOTE_NAME
) {
1297 const char *remote
= atom
->u
.remote_ref
.push
?
1298 pushremote_for_branch(branch
, &explicit) :
1299 remote_for_branch(branch
, &explicit);
1301 *s
= xstrdup(remote
);
1304 } else if (atom
->u
.remote_ref
.option
== RR_REMOTE_REF
) {
1308 merge
= remote_ref_for_branch(branch
, atom
->u
.remote_ref
.push
,
1311 *s
= xstrdup(merge
);
1315 die("BUG: unhandled RR_* enum");
1318 char *get_head_description(void)
1320 struct strbuf desc
= STRBUF_INIT
;
1321 struct wt_status_state state
;
1322 memset(&state
, 0, sizeof(state
));
1323 wt_status_get_state(&state
, 1);
1324 if (state
.rebase_in_progress
||
1325 state
.rebase_interactive_in_progress
)
1326 strbuf_addf(&desc
, _("(no branch, rebasing %s)"),
1328 else if (state
.bisect_in_progress
)
1329 strbuf_addf(&desc
, _("(no branch, bisect started on %s)"),
1331 else if (state
.detached_from
) {
1332 if (state
.detached_at
)
1334 * TRANSLATORS: make sure this matches "HEAD
1335 * detached at " in wt-status.c
1337 strbuf_addf(&desc
, _("(HEAD detached at %s)"),
1338 state
.detached_from
);
1341 * TRANSLATORS: make sure this matches "HEAD
1342 * detached from " in wt-status.c
1344 strbuf_addf(&desc
, _("(HEAD detached from %s)"),
1345 state
.detached_from
);
1348 strbuf_addstr(&desc
, _("(no branch)"));
1351 free(state
.detached_from
);
1352 return strbuf_detach(&desc
, NULL
);
1355 static const char *get_symref(struct used_atom
*atom
, struct ref_array_item
*ref
)
1360 return show_ref(&atom
->u
.refname
, ref
->symref
);
1363 static const char *get_refname(struct used_atom
*atom
, struct ref_array_item
*ref
)
1365 if (ref
->kind
& FILTER_REFS_DETACHED_HEAD
)
1366 return get_head_description();
1367 return show_ref(&atom
->u
.refname
, ref
->refname
);
1370 static void get_object(struct ref_array_item
*ref
, const struct object_id
*oid
,
1371 int deref
, struct object
**obj
)
1375 void *buf
= get_obj(oid
, obj
, &size
, &eaten
);
1377 die(_("missing object %s for %s"),
1378 oid_to_hex(oid
), ref
->refname
);
1380 die(_("parse_object_buffer failed on %s for %s"),
1381 oid_to_hex(oid
), ref
->refname
);
1383 grab_values(ref
->value
, deref
, *obj
, buf
, size
);
1389 * Parse the object referred by ref, and grab needed value.
1391 static void populate_value(struct ref_array_item
*ref
)
1395 const struct object_id
*tagged
;
1397 ref
->value
= xcalloc(used_atom_cnt
, sizeof(struct atom_value
));
1399 if (need_symref
&& (ref
->flag
& REF_ISSYMREF
) && !ref
->symref
) {
1400 ref
->symref
= resolve_refdup(ref
->refname
, RESOLVE_REF_READING
,
1406 /* Fill in specials first */
1407 for (i
= 0; i
< used_atom_cnt
; i
++) {
1408 struct used_atom
*atom
= &used_atom
[i
];
1409 const char *name
= used_atom
[i
].name
;
1410 struct atom_value
*v
= &ref
->value
[i
];
1412 const char *refname
;
1413 struct branch
*branch
= NULL
;
1415 v
->handler
= append_atom
;
1423 if (starts_with(name
, "refname"))
1424 refname
= get_refname(atom
, ref
);
1425 else if (starts_with(name
, "symref"))
1426 refname
= get_symref(atom
, ref
);
1427 else if (starts_with(name
, "upstream")) {
1428 const char *branch_name
;
1429 /* only local branches may have an upstream */
1430 if (!skip_prefix(ref
->refname
, "refs/heads/",
1433 branch
= branch_get(branch_name
);
1435 refname
= branch_get_upstream(branch
, NULL
);
1437 fill_remote_ref_details(atom
, refname
, branch
, &v
->s
);
1439 } else if (atom
->u
.remote_ref
.push
) {
1440 const char *branch_name
;
1441 if (!skip_prefix(ref
->refname
, "refs/heads/",
1444 branch
= branch_get(branch_name
);
1446 if (atom
->u
.remote_ref
.push_remote
)
1449 refname
= branch_get_push(branch
, NULL
);
1453 fill_remote_ref_details(atom
, refname
, branch
, &v
->s
);
1455 } else if (starts_with(name
, "color:")) {
1456 v
->s
= atom
->u
.color
;
1458 } else if (!strcmp(name
, "flag")) {
1459 char buf
[256], *cp
= buf
;
1460 if (ref
->flag
& REF_ISSYMREF
)
1461 cp
= copy_advance(cp
, ",symref");
1462 if (ref
->flag
& REF_ISPACKED
)
1463 cp
= copy_advance(cp
, ",packed");
1468 v
->s
= xstrdup(buf
+ 1);
1471 } else if (!deref
&& grab_objectname(name
, ref
->objectname
.hash
, v
, atom
)) {
1473 } else if (!strcmp(name
, "HEAD")) {
1474 if (atom
->u
.head
&& !strcmp(ref
->refname
, atom
->u
.head
))
1479 } else if (starts_with(name
, "align")) {
1480 v
->handler
= align_atom_handler
;
1482 } else if (!strcmp(name
, "end")) {
1483 v
->handler
= end_atom_handler
;
1485 } else if (starts_with(name
, "if")) {
1488 if (skip_prefix(name
, "if:", &s
))
1490 v
->handler
= if_atom_handler
;
1492 } else if (!strcmp(name
, "then")) {
1493 v
->handler
= then_atom_handler
;
1495 } else if (!strcmp(name
, "else")) {
1496 v
->handler
= else_atom_handler
;
1504 v
->s
= xstrfmt("%s^{}", refname
);
1507 for (i
= 0; i
< used_atom_cnt
; i
++) {
1508 struct atom_value
*v
= &ref
->value
[i
];
1512 if (used_atom_cnt
<= i
)
1515 get_object(ref
, &ref
->objectname
, 0, &obj
);
1518 * If there is no atom that wants to know about tagged
1519 * object, we are done.
1521 if (!need_tagged
|| (obj
->type
!= OBJ_TAG
))
1525 * If it is a tag object, see if we use a value that derefs
1526 * the object, and if we do grab the object it refers to.
1528 tagged
= &((struct tag
*)obj
)->tagged
->oid
;
1531 * NEEDSWORK: This derefs tag only once, which
1532 * is good to deal with chains of trust, but
1533 * is not consistent with what deref_tag() does
1534 * which peels the onion to the core.
1536 get_object(ref
, tagged
, 1, &obj
);
1540 * Given a ref, return the value for the atom. This lazily gets value
1541 * out of the object by calling populate value.
1543 static void get_ref_atom_value(struct ref_array_item
*ref
, int atom
, struct atom_value
**v
)
1546 populate_value(ref
);
1547 fill_missing_values(ref
->value
);
1549 *v
= &ref
->value
[atom
];
1553 * Unknown has to be "0" here, because that's the default value for
1554 * contains_cache slab entries that have not yet been assigned.
1556 enum contains_result
{
1557 CONTAINS_UNKNOWN
= 0,
1562 define_commit_slab(contains_cache
, enum contains_result
);
1564 struct ref_filter_cbdata
{
1565 struct ref_array
*array
;
1566 struct ref_filter
*filter
;
1567 struct contains_cache contains_cache
;
1568 struct contains_cache no_contains_cache
;
1572 * Mimicking the real stack, this stack lives on the heap, avoiding stack
1575 * At each recursion step, the stack items points to the commits whose
1576 * ancestors are to be inspected.
1578 struct contains_stack
{
1580 struct contains_stack_entry
{
1581 struct commit
*commit
;
1582 struct commit_list
*parents
;
1586 static int in_commit_list(const struct commit_list
*want
, struct commit
*c
)
1588 for (; want
; want
= want
->next
)
1589 if (!oidcmp(&want
->item
->object
.oid
, &c
->object
.oid
))
1595 * Test whether the candidate or one of its parents is contained in the list.
1596 * Do not recurse to find out, though, but return -1 if inconclusive.
1598 static enum contains_result
contains_test(struct commit
*candidate
,
1599 const struct commit_list
*want
,
1600 struct contains_cache
*cache
)
1602 enum contains_result
*cached
= contains_cache_at(cache
, candidate
);
1604 /* If we already have the answer cached, return that. */
1609 if (in_commit_list(want
, candidate
)) {
1610 *cached
= CONTAINS_YES
;
1611 return CONTAINS_YES
;
1614 /* Otherwise, we don't know; prepare to recurse */
1615 parse_commit_or_die(candidate
);
1616 return CONTAINS_UNKNOWN
;
1619 static void push_to_contains_stack(struct commit
*candidate
, struct contains_stack
*contains_stack
)
1621 ALLOC_GROW(contains_stack
->contains_stack
, contains_stack
->nr
+ 1, contains_stack
->alloc
);
1622 contains_stack
->contains_stack
[contains_stack
->nr
].commit
= candidate
;
1623 contains_stack
->contains_stack
[contains_stack
->nr
++].parents
= candidate
->parents
;
1626 static enum contains_result
contains_tag_algo(struct commit
*candidate
,
1627 const struct commit_list
*want
,
1628 struct contains_cache
*cache
)
1630 struct contains_stack contains_stack
= { 0, 0, NULL
};
1631 enum contains_result result
= contains_test(candidate
, want
, cache
);
1633 if (result
!= CONTAINS_UNKNOWN
)
1636 push_to_contains_stack(candidate
, &contains_stack
);
1637 while (contains_stack
.nr
) {
1638 struct contains_stack_entry
*entry
= &contains_stack
.contains_stack
[contains_stack
.nr
- 1];
1639 struct commit
*commit
= entry
->commit
;
1640 struct commit_list
*parents
= entry
->parents
;
1643 *contains_cache_at(cache
, commit
) = CONTAINS_NO
;
1644 contains_stack
.nr
--;
1647 * If we just popped the stack, parents->item has been marked,
1648 * therefore contains_test will return a meaningful yes/no.
1650 else switch (contains_test(parents
->item
, want
, cache
)) {
1652 *contains_cache_at(cache
, commit
) = CONTAINS_YES
;
1653 contains_stack
.nr
--;
1656 entry
->parents
= parents
->next
;
1658 case CONTAINS_UNKNOWN
:
1659 push_to_contains_stack(parents
->item
, &contains_stack
);
1663 free(contains_stack
.contains_stack
);
1664 return contains_test(candidate
, want
, cache
);
1667 static int commit_contains(struct ref_filter
*filter
, struct commit
*commit
,
1668 struct commit_list
*list
, struct contains_cache
*cache
)
1670 if (filter
->with_commit_tag_algo
)
1671 return contains_tag_algo(commit
, list
, cache
) == CONTAINS_YES
;
1672 return is_descendant_of(commit
, list
);
1676 * Return 1 if the refname matches one of the patterns, otherwise 0.
1677 * A pattern can be a literal prefix (e.g. a refname "refs/heads/master"
1678 * matches a pattern "refs/heads/mas") or a wildcard (e.g. the same ref
1679 * matches "refs/heads/mas*", too).
1681 static int match_pattern(const struct ref_filter
*filter
, const char *refname
)
1683 const char **patterns
= filter
->name_patterns
;
1686 if (filter
->ignore_case
)
1687 flags
|= WM_CASEFOLD
;
1690 * When no '--format' option is given we need to skip the prefix
1691 * for matching refs of tags and branches.
1693 (void)(skip_prefix(refname
, "refs/tags/", &refname
) ||
1694 skip_prefix(refname
, "refs/heads/", &refname
) ||
1695 skip_prefix(refname
, "refs/remotes/", &refname
) ||
1696 skip_prefix(refname
, "refs/", &refname
));
1698 for (; *patterns
; patterns
++) {
1699 if (!wildmatch(*patterns
, refname
, flags
))
1706 * Return 1 if the refname matches one of the patterns, otherwise 0.
1707 * A pattern can be path prefix (e.g. a refname "refs/heads/master"
1708 * matches a pattern "refs/heads/" but not "refs/heads/m") or a
1709 * wildcard (e.g. the same ref matches "refs/heads/m*", too).
1711 static int match_name_as_path(const struct ref_filter
*filter
, const char *refname
)
1713 const char **pattern
= filter
->name_patterns
;
1714 int namelen
= strlen(refname
);
1715 unsigned flags
= WM_PATHNAME
;
1717 if (filter
->ignore_case
)
1718 flags
|= WM_CASEFOLD
;
1720 for (; *pattern
; pattern
++) {
1721 const char *p
= *pattern
;
1722 int plen
= strlen(p
);
1724 if ((plen
<= namelen
) &&
1725 !strncmp(refname
, p
, plen
) &&
1726 (refname
[plen
] == '\0' ||
1727 refname
[plen
] == '/' ||
1730 if (!wildmatch(p
, refname
, WM_PATHNAME
))
1736 /* Return 1 if the refname matches one of the patterns, otherwise 0. */
1737 static int filter_pattern_match(struct ref_filter
*filter
, const char *refname
)
1739 if (!*filter
->name_patterns
)
1740 return 1; /* No pattern always matches */
1741 if (filter
->match_as_path
)
1742 return match_name_as_path(filter
, refname
);
1743 return match_pattern(filter
, refname
);
1747 * Find the longest prefix of pattern we can pass to
1748 * `for_each_fullref_in()`, namely the part of pattern preceding the
1749 * first glob character. (Note that `for_each_fullref_in()` is
1750 * perfectly happy working with a prefix that doesn't end at a
1751 * pathname component boundary.)
1753 static void find_longest_prefix(struct strbuf
*out
, const char *pattern
)
1757 for (p
= pattern
; *p
&& !is_glob_special(*p
); p
++)
1760 strbuf_add(out
, pattern
, p
- pattern
);
1764 * This is the same as for_each_fullref_in(), but it tries to iterate
1765 * only over the patterns we'll care about. Note that it _doesn't_ do a full
1766 * pattern match, so the callback still has to match each ref individually.
1768 static int for_each_fullref_in_pattern(struct ref_filter
*filter
,
1773 struct strbuf prefix
= STRBUF_INIT
;
1776 if (!filter
->match_as_path
) {
1778 * in this case, the patterns are applied after
1779 * prefixes like "refs/heads/" etc. are stripped off,
1780 * so we have to look at everything:
1782 return for_each_fullref_in("", cb
, cb_data
, broken
);
1785 if (!filter
->name_patterns
[0]) {
1786 /* no patterns; we have to look at everything */
1787 return for_each_fullref_in("", cb
, cb_data
, broken
);
1790 if (filter
->name_patterns
[1]) {
1792 * multiple patterns; in theory this could still work as long
1793 * as the patterns are disjoint. We'd just make multiple calls
1794 * to for_each_ref(). But if they're not disjoint, we'd end up
1795 * reporting the same ref multiple times. So let's punt on that
1798 return for_each_fullref_in("", cb
, cb_data
, broken
);
1801 find_longest_prefix(&prefix
, filter
->name_patterns
[0]);
1803 ret
= for_each_fullref_in(prefix
.buf
, cb
, cb_data
, broken
);
1804 strbuf_release(&prefix
);
1809 * Given a ref (sha1, refname), check if the ref belongs to the array
1810 * of sha1s. If the given ref is a tag, check if the given tag points
1811 * at one of the sha1s in the given sha1 array.
1812 * the given sha1_array.
1814 * 1. Only a single level of inderection is obtained, we might want to
1815 * change this to account for multiple levels (e.g. annotated tags
1816 * pointing to annotated tags pointing to a commit.)
1817 * 2. As the refs are cached we might know what refname peels to without
1818 * the need to parse the object via parse_object(). peel_ref() might be a
1819 * more efficient alternative to obtain the pointee.
1821 static const struct object_id
*match_points_at(struct oid_array
*points_at
,
1822 const struct object_id
*oid
,
1823 const char *refname
)
1825 const struct object_id
*tagged_oid
= NULL
;
1828 if (oid_array_lookup(points_at
, oid
) >= 0)
1830 obj
= parse_object(oid
);
1832 die(_("malformed object at '%s'"), refname
);
1833 if (obj
->type
== OBJ_TAG
)
1834 tagged_oid
= &((struct tag
*)obj
)->tagged
->oid
;
1835 if (tagged_oid
&& oid_array_lookup(points_at
, tagged_oid
) >= 0)
1840 /* Allocate space for a new ref_array_item and copy the objectname and flag to it */
1841 static struct ref_array_item
*new_ref_array_item(const char *refname
,
1842 const unsigned char *objectname
,
1845 struct ref_array_item
*ref
;
1846 FLEX_ALLOC_STR(ref
, refname
, refname
);
1847 hashcpy(ref
->objectname
.hash
, objectname
);
1853 static int ref_kind_from_refname(const char *refname
)
1861 { "refs/heads/" , FILTER_REFS_BRANCHES
},
1862 { "refs/remotes/" , FILTER_REFS_REMOTES
},
1863 { "refs/tags/", FILTER_REFS_TAGS
}
1866 if (!strcmp(refname
, "HEAD"))
1867 return FILTER_REFS_DETACHED_HEAD
;
1869 for (i
= 0; i
< ARRAY_SIZE(ref_kind
); i
++) {
1870 if (starts_with(refname
, ref_kind
[i
].prefix
))
1871 return ref_kind
[i
].kind
;
1874 return FILTER_REFS_OTHERS
;
1877 static int filter_ref_kind(struct ref_filter
*filter
, const char *refname
)
1879 if (filter
->kind
== FILTER_REFS_BRANCHES
||
1880 filter
->kind
== FILTER_REFS_REMOTES
||
1881 filter
->kind
== FILTER_REFS_TAGS
)
1882 return filter
->kind
;
1883 return ref_kind_from_refname(refname
);
1887 * A call-back given to for_each_ref(). Filter refs and keep them for
1888 * later object processing.
1890 static int ref_filter_handler(const char *refname
, const struct object_id
*oid
, int flag
, void *cb_data
)
1892 struct ref_filter_cbdata
*ref_cbdata
= cb_data
;
1893 struct ref_filter
*filter
= ref_cbdata
->filter
;
1894 struct ref_array_item
*ref
;
1895 struct commit
*commit
= NULL
;
1898 if (flag
& REF_BAD_NAME
) {
1899 warning(_("ignoring ref with broken name %s"), refname
);
1903 if (flag
& REF_ISBROKEN
) {
1904 warning(_("ignoring broken ref %s"), refname
);
1908 /* Obtain the current ref kind from filter_ref_kind() and ignore unwanted refs. */
1909 kind
= filter_ref_kind(filter
, refname
);
1910 if (!(kind
& filter
->kind
))
1913 if (!filter_pattern_match(filter
, refname
))
1916 if (filter
->points_at
.nr
&& !match_points_at(&filter
->points_at
, oid
, refname
))
1920 * A merge filter is applied on refs pointing to commits. Hence
1921 * obtain the commit using the 'oid' available and discard all
1922 * non-commits early. The actual filtering is done later.
1924 if (filter
->merge_commit
|| filter
->with_commit
|| filter
->no_commit
|| filter
->verbose
) {
1925 commit
= lookup_commit_reference_gently(oid
, 1);
1928 /* We perform the filtering for the '--contains' option... */
1929 if (filter
->with_commit
&&
1930 !commit_contains(filter
, commit
, filter
->with_commit
, &ref_cbdata
->contains_cache
))
1932 /* ...or for the `--no-contains' option */
1933 if (filter
->no_commit
&&
1934 commit_contains(filter
, commit
, filter
->no_commit
, &ref_cbdata
->no_contains_cache
))
1939 * We do not open the object yet; sort may only need refname
1940 * to do its job and the resulting list may yet to be pruned
1941 * by maxcount logic.
1943 ref
= new_ref_array_item(refname
, oid
->hash
, flag
);
1944 ref
->commit
= commit
;
1946 REALLOC_ARRAY(ref_cbdata
->array
->items
, ref_cbdata
->array
->nr
+ 1);
1947 ref_cbdata
->array
->items
[ref_cbdata
->array
->nr
++] = ref
;
1952 /* Free memory allocated for a ref_array_item */
1953 static void free_array_item(struct ref_array_item
*item
)
1955 free((char *)item
->symref
);
1959 /* Free all memory allocated for ref_array */
1960 void ref_array_clear(struct ref_array
*array
)
1964 for (i
= 0; i
< array
->nr
; i
++)
1965 free_array_item(array
->items
[i
]);
1966 FREE_AND_NULL(array
->items
);
1967 array
->nr
= array
->alloc
= 0;
1970 static void do_merge_filter(struct ref_filter_cbdata
*ref_cbdata
)
1972 struct rev_info revs
;
1974 struct ref_filter
*filter
= ref_cbdata
->filter
;
1975 struct ref_array
*array
= ref_cbdata
->array
;
1976 struct commit
**to_clear
= xcalloc(sizeof(struct commit
*), array
->nr
);
1978 init_revisions(&revs
, NULL
);
1980 for (i
= 0; i
< array
->nr
; i
++) {
1981 struct ref_array_item
*item
= array
->items
[i
];
1982 add_pending_object(&revs
, &item
->commit
->object
, item
->refname
);
1983 to_clear
[i
] = item
->commit
;
1986 filter
->merge_commit
->object
.flags
|= UNINTERESTING
;
1987 add_pending_object(&revs
, &filter
->merge_commit
->object
, "");
1990 if (prepare_revision_walk(&revs
))
1991 die(_("revision walk setup failed"));
1996 for (i
= 0; i
< old_nr
; i
++) {
1997 struct ref_array_item
*item
= array
->items
[i
];
1998 struct commit
*commit
= item
->commit
;
2000 int is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
2002 if (is_merged
== (filter
->merge
== REF_FILTER_MERGED_INCLUDE
))
2003 array
->items
[array
->nr
++] = array
->items
[i
];
2005 free_array_item(item
);
2008 clear_commit_marks_many(old_nr
, to_clear
, ALL_REV_FLAGS
);
2009 clear_commit_marks(filter
->merge_commit
, ALL_REV_FLAGS
);
2014 * API for filtering a set of refs. Based on the type of refs the user
2015 * has requested, we iterate through those refs and apply filters
2016 * as per the given ref_filter structure and finally store the
2017 * filtered refs in the ref_array structure.
2019 int filter_refs(struct ref_array
*array
, struct ref_filter
*filter
, unsigned int type
)
2021 struct ref_filter_cbdata ref_cbdata
;
2023 unsigned int broken
= 0;
2025 ref_cbdata
.array
= array
;
2026 ref_cbdata
.filter
= filter
;
2028 if (type
& FILTER_REFS_INCLUDE_BROKEN
)
2030 filter
->kind
= type
& FILTER_REFS_KIND_MASK
;
2032 init_contains_cache(&ref_cbdata
.contains_cache
);
2033 init_contains_cache(&ref_cbdata
.no_contains_cache
);
2035 /* Simple per-ref filtering */
2037 die("filter_refs: invalid type");
2040 * For common cases where we need only branches or remotes or tags,
2041 * we only iterate through those refs. If a mix of refs is needed,
2042 * we iterate over all refs and filter out required refs with the help
2043 * of filter_ref_kind().
2045 if (filter
->kind
== FILTER_REFS_BRANCHES
)
2046 ret
= for_each_fullref_in("refs/heads/", ref_filter_handler
, &ref_cbdata
, broken
);
2047 else if (filter
->kind
== FILTER_REFS_REMOTES
)
2048 ret
= for_each_fullref_in("refs/remotes/", ref_filter_handler
, &ref_cbdata
, broken
);
2049 else if (filter
->kind
== FILTER_REFS_TAGS
)
2050 ret
= for_each_fullref_in("refs/tags/", ref_filter_handler
, &ref_cbdata
, broken
);
2051 else if (filter
->kind
& FILTER_REFS_ALL
)
2052 ret
= for_each_fullref_in_pattern(filter
, ref_filter_handler
, &ref_cbdata
, broken
);
2053 if (!ret
&& (filter
->kind
& FILTER_REFS_DETACHED_HEAD
))
2054 head_ref(ref_filter_handler
, &ref_cbdata
);
2057 clear_contains_cache(&ref_cbdata
.contains_cache
);
2058 clear_contains_cache(&ref_cbdata
.no_contains_cache
);
2060 /* Filters that need revision walking */
2061 if (filter
->merge_commit
)
2062 do_merge_filter(&ref_cbdata
);
2067 static int cmp_ref_sorting(struct ref_sorting
*s
, struct ref_array_item
*a
, struct ref_array_item
*b
)
2069 struct atom_value
*va
, *vb
;
2071 cmp_type cmp_type
= used_atom
[s
->atom
].type
;
2072 int (*cmp_fn
)(const char *, const char *);
2074 get_ref_atom_value(a
, s
->atom
, &va
);
2075 get_ref_atom_value(b
, s
->atom
, &vb
);
2076 cmp_fn
= s
->ignore_case
? strcasecmp
: strcmp
;
2078 cmp
= versioncmp(va
->s
, vb
->s
);
2079 else if (cmp_type
== FIELD_STR
)
2080 cmp
= cmp_fn(va
->s
, vb
->s
);
2082 if (va
->value
< vb
->value
)
2084 else if (va
->value
== vb
->value
)
2085 cmp
= cmp_fn(a
->refname
, b
->refname
);
2090 return (s
->reverse
) ? -cmp
: cmp
;
2093 static int compare_refs(const void *a_
, const void *b_
, void *ref_sorting
)
2095 struct ref_array_item
*a
= *((struct ref_array_item
**)a_
);
2096 struct ref_array_item
*b
= *((struct ref_array_item
**)b_
);
2097 struct ref_sorting
*s
;
2099 for (s
= ref_sorting
; s
; s
= s
->next
) {
2100 int cmp
= cmp_ref_sorting(s
, a
, b
);
2107 void ref_array_sort(struct ref_sorting
*sorting
, struct ref_array
*array
)
2109 QSORT_S(array
->items
, array
->nr
, compare_refs
, sorting
);
2112 static void append_literal(const char *cp
, const char *ep
, struct ref_formatting_state
*state
)
2114 struct strbuf
*s
= &state
->stack
->output
;
2116 while (*cp
&& (!ep
|| cp
< ep
)) {
2121 int ch
= hex2chr(cp
+ 1);
2123 strbuf_addch(s
, ch
);
2129 strbuf_addch(s
, *cp
);
2134 int format_ref_array_item(struct ref_array_item
*info
,
2135 const struct ref_format
*format
,
2136 struct strbuf
*final_buf
,
2137 struct strbuf
*error_buf
)
2139 const char *cp
, *sp
, *ep
;
2140 struct ref_formatting_state state
= REF_FORMATTING_STATE_INIT
;
2142 state
.quote_style
= format
->quote_style
;
2143 push_stack_element(&state
.stack
);
2145 for (cp
= format
->format
; *cp
&& (sp
= find_next(cp
)); cp
= ep
+ 1) {
2146 struct atom_value
*atomv
;
2148 ep
= strchr(sp
, ')');
2150 append_literal(cp
, sp
, &state
);
2151 get_ref_atom_value(info
,
2152 parse_ref_filter_atom(format
, sp
+ 2, ep
),
2154 atomv
->handler(atomv
, &state
);
2157 sp
= cp
+ strlen(cp
);
2158 append_literal(cp
, sp
, &state
);
2160 if (format
->need_color_reset_at_eol
) {
2161 struct atom_value resetv
;
2162 resetv
.s
= GIT_COLOR_RESET
;
2163 append_atom(&resetv
, &state
);
2165 if (state
.stack
->prev
) {
2166 pop_stack_element(&state
.stack
);
2167 return strbuf_addf_ret(error_buf
, -1, _("format: %%(end) atom missing"));
2169 strbuf_addbuf(final_buf
, &state
.stack
->output
);
2170 pop_stack_element(&state
.stack
);
2174 void show_ref_array_item(struct ref_array_item
*info
,
2175 const struct ref_format
*format
)
2177 struct strbuf final_buf
= STRBUF_INIT
;
2178 struct strbuf error_buf
= STRBUF_INIT
;
2180 if (format_ref_array_item(info
, format
, &final_buf
, &error_buf
))
2181 die("%s", error_buf
.buf
);
2182 fwrite(final_buf
.buf
, 1, final_buf
.len
, stdout
);
2183 strbuf_release(&error_buf
);
2184 strbuf_release(&final_buf
);
2188 void pretty_print_ref(const char *name
, const unsigned char *sha1
,
2189 const struct ref_format
*format
)
2191 struct ref_array_item
*ref_item
;
2192 ref_item
= new_ref_array_item(name
, sha1
, 0);
2193 ref_item
->kind
= ref_kind_from_refname(name
);
2194 show_ref_array_item(ref_item
, format
);
2195 free_array_item(ref_item
);
2198 static int parse_sorting_atom(const char *atom
)
2201 * This parses an atom using a dummy ref_format, since we don't
2202 * actually care about the formatting details.
2204 struct ref_format dummy
= REF_FORMAT_INIT
;
2205 const char *end
= atom
+ strlen(atom
);
2206 return parse_ref_filter_atom(&dummy
, atom
, end
);
2209 /* If no sorting option is given, use refname to sort as default */
2210 struct ref_sorting
*ref_default_sorting(void)
2212 static const char cstr_name
[] = "refname";
2214 struct ref_sorting
*sorting
= xcalloc(1, sizeof(*sorting
));
2216 sorting
->next
= NULL
;
2217 sorting
->atom
= parse_sorting_atom(cstr_name
);
2221 void parse_ref_sorting(struct ref_sorting
**sorting_tail
, const char *arg
)
2223 struct ref_sorting
*s
;
2225 s
= xcalloc(1, sizeof(*s
));
2226 s
->next
= *sorting_tail
;
2233 if (skip_prefix(arg
, "version:", &arg
) ||
2234 skip_prefix(arg
, "v:", &arg
))
2236 s
->atom
= parse_sorting_atom(arg
);
2239 int parse_opt_ref_sorting(const struct option
*opt
, const char *arg
, int unset
)
2241 if (!arg
) /* should --no-sort void the list ? */
2243 parse_ref_sorting(opt
->value
, arg
);
2247 int parse_opt_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
2249 struct ref_filter
*rf
= opt
->value
;
2250 struct object_id oid
;
2251 int no_merged
= starts_with(opt
->long_name
, "no");
2255 return opterror(opt
, "is incompatible with --merged", 0);
2257 return opterror(opt
, "is incompatible with --no-merged", 0);
2261 rf
->merge
= no_merged
2262 ? REF_FILTER_MERGED_OMIT
2263 : REF_FILTER_MERGED_INCLUDE
;
2265 if (get_oid(arg
, &oid
))
2266 die(_("malformed object name %s"), arg
);
2268 rf
->merge_commit
= lookup_commit_reference_gently(&oid
, 0);
2269 if (!rf
->merge_commit
)
2270 return opterror(opt
, "must point to a commit", 0);