8 #include "parse-options.h"
10 #include "commit-slab.h"
13 static const char* show_branch_usage
[] = {
14 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
15 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
16 " [--more=<n> | --list | --independent | --merge-base]\n"
17 " [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
18 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
22 static int showbranch_use_color
= -1;
24 static struct strvec default_args
= STRVEC_INIT
;
27 * TODO: convert this use of commit->object.flags to commit-slab
28 * instead to store a pointer to ref name directly. Then use the same
29 * UNINTERESTING definition from revision.h here.
31 #define UNINTERESTING 01
34 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
36 #define DEFAULT_REFLOG 4
38 static const char *get_color_code(int idx
)
40 if (want_color(showbranch_use_color
))
41 return column_colors_ansi
[idx
% column_colors_ansi_max
];
45 static const char *get_color_reset_code(void)
47 if (want_color(showbranch_use_color
))
48 return GIT_COLOR_RESET
;
52 static struct commit
*interesting(struct commit_list
*list
)
55 struct commit
*commit
= list
->item
;
57 if (commit
->object
.flags
& UNINTERESTING
)
65 const char *head_name
; /* which head's ancestor? */
66 int generation
; /* how many parents away from head_name */
69 define_commit_slab(commit_name_slab
, struct commit_name
*);
70 static struct commit_name_slab name_slab
;
72 static struct commit_name
*commit_to_name(struct commit
*commit
)
74 return *commit_name_slab_at(&name_slab
, commit
);
78 /* Name the commit as nth generation ancestor of head_name;
79 * we count only the first-parent relationship for naming purposes.
81 static void name_commit(struct commit
*commit
, const char *head_name
, int nth
)
83 struct commit_name
*name
;
85 name
= *commit_name_slab_at(&name_slab
, commit
);
87 name
= xmalloc(sizeof(*name
));
88 *commit_name_slab_at(&name_slab
, commit
) = name
;
90 name
->head_name
= head_name
;
91 name
->generation
= nth
;
94 /* Parent is the first parent of the commit. We may name it
95 * as (n+1)th generation ancestor of the same head_name as
96 * commit is nth generation ancestor of, if that generation
97 * number is better than the name it already has.
99 static void name_parent(struct commit
*commit
, struct commit
*parent
)
101 struct commit_name
*commit_name
= commit_to_name(commit
);
102 struct commit_name
*parent_name
= commit_to_name(parent
);
106 commit_name
->generation
+ 1 < parent_name
->generation
)
107 name_commit(parent
, commit_name
->head_name
,
108 commit_name
->generation
+ 1);
111 static int name_first_parent_chain(struct commit
*c
)
116 if (!commit_to_name(c
))
120 p
= c
->parents
->item
;
121 if (!commit_to_name(p
)) {
132 static void name_commits(struct commit_list
*list
,
137 struct commit_list
*cl
;
141 /* First give names to the given heads */
142 for (cl
= list
; cl
; cl
= cl
->next
) {
144 if (commit_to_name(c
))
146 for (i
= 0; i
< num_rev
; i
++) {
148 name_commit(c
, ref_name
[i
], 0);
154 /* Then commits on the first parent ancestry chain */
157 for (cl
= list
; cl
; cl
= cl
->next
) {
158 i
+= name_first_parent_chain(cl
->item
);
162 /* Finally, any unnamed commits */
165 for (cl
= list
; cl
; cl
= cl
->next
) {
166 struct commit_list
*parents
;
167 struct commit_name
*n
;
170 if (!commit_to_name(c
))
172 n
= commit_to_name(c
);
173 parents
= c
->parents
;
176 struct commit
*p
= parents
->item
;
177 struct strbuf newname
= STRBUF_INIT
;
178 parents
= parents
->next
;
180 if (commit_to_name(p
))
182 switch (n
->generation
) {
184 strbuf_addstr(&newname
, n
->head_name
);
187 strbuf_addf(&newname
, "%s^", n
->head_name
);
190 strbuf_addf(&newname
, "%s~%d",
191 n
->head_name
, n
->generation
);
195 strbuf_addch(&newname
, '^');
197 strbuf_addf(&newname
, "^%d", nth
);
198 name_commit(p
, strbuf_detach(&newname
, NULL
), 0);
200 name_first_parent_chain(p
);
206 static int mark_seen(struct commit
*commit
, struct commit_list
**seen_p
)
208 if (!commit
->object
.flags
) {
209 commit_list_insert(commit
, seen_p
);
215 static void join_revs(struct commit_list
**list_p
,
216 struct commit_list
**seen_p
,
217 int num_rev
, int extra
)
219 int all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
220 int all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
223 struct commit_list
*parents
;
224 int still_interesting
= !!interesting(*list_p
);
225 struct commit
*commit
= pop_commit(list_p
);
226 int flags
= commit
->object
.flags
& all_mask
;
228 if (!still_interesting
&& extra
<= 0)
231 mark_seen(commit
, seen_p
);
232 if ((flags
& all_revs
) == all_revs
)
233 flags
|= UNINTERESTING
;
234 parents
= commit
->parents
;
237 struct commit
*p
= parents
->item
;
238 int this_flag
= p
->object
.flags
;
239 parents
= parents
->next
;
240 if ((this_flag
& flags
) == flags
)
243 if (mark_seen(p
, seen_p
) && !still_interesting
)
245 p
->object
.flags
|= flags
;
246 commit_list_insert_by_date(p
, list_p
);
251 * Postprocess to complete well-poisoning.
253 * At this point we have all the commits we have seen in
254 * seen_p list. Mark anything that can be reached from
255 * uninteresting commits not interesting.
259 struct commit_list
*s
;
260 for (s
= *seen_p
; s
; s
= s
->next
) {
261 struct commit
*c
= s
->item
;
262 struct commit_list
*parents
;
264 if (((c
->object
.flags
& all_revs
) != all_revs
) &&
265 !(c
->object
.flags
& UNINTERESTING
))
268 /* The current commit is either a merge base or
269 * already uninteresting one. Mark its parents
270 * as uninteresting commits _only_ if they are
271 * already parsed. No reason to find new ones
274 parents
= c
->parents
;
276 struct commit
*p
= parents
->item
;
277 parents
= parents
->next
;
278 if (!(p
->object
.flags
& UNINTERESTING
)) {
279 p
->object
.flags
|= UNINTERESTING
;
289 static void show_one_commit(struct commit
*commit
, int no_name
)
291 struct strbuf pretty
= STRBUF_INIT
;
292 const char *pretty_str
= "(unavailable)";
293 struct commit_name
*name
= commit_to_name(commit
);
295 if (commit
->object
.parsed
) {
296 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &pretty
);
297 pretty_str
= pretty
.buf
;
299 skip_prefix(pretty_str
, "[PATCH] ", &pretty_str
);
302 if (name
&& name
->head_name
) {
303 printf("[%s", name
->head_name
);
304 if (name
->generation
) {
305 if (name
->generation
== 1)
308 printf("~%d", name
->generation
);
314 find_unique_abbrev(&commit
->object
.oid
,
318 strbuf_release(&pretty
);
321 static char *ref_name
[MAX_REVS
+ 1];
322 static int ref_name_cnt
;
324 static const char *find_digit_prefix(const char *s
, int *v
)
331 '0' <= (ch
= *p
) && ch
<= '9';
333 ver
= ver
* 10 + ch
- '0';
339 static int version_cmp(const char *a
, const char *b
)
344 a
= find_digit_prefix(a
, &va
);
345 b
= find_digit_prefix(b
, &vb
);
352 if ('0' <= ca
&& ca
<= '9')
354 if ('0' <= cb
&& cb
<= '9')
368 static int compare_ref_name(const void *a_
, const void *b_
)
370 const char * const*a
= a_
, * const*b
= b_
;
371 return version_cmp(*a
, *b
);
374 static void sort_ref_range(int bottom
, int top
)
376 QSORT(ref_name
+ bottom
, top
- bottom
, compare_ref_name
);
379 static int append_ref(const char *refname
, const struct object_id
*oid
,
382 struct commit
*commit
= lookup_commit_reference_gently(the_repository
,
390 /* Avoid adding the same thing twice */
391 for (i
= 0; i
< ref_name_cnt
; i
++)
392 if (!strcmp(refname
, ref_name
[i
]))
395 if (MAX_REVS
<= ref_name_cnt
) {
396 warning(Q_("ignoring %s; cannot handle more than %d ref",
397 "ignoring %s; cannot handle more than %d refs",
398 MAX_REVS
), refname
, MAX_REVS
);
401 ref_name
[ref_name_cnt
++] = xstrdup(refname
);
402 ref_name
[ref_name_cnt
] = NULL
;
406 static int append_head_ref(const char *refname
, const struct object_id
*oid
,
407 int flag UNUSED
, void *cb_data UNUSED
)
409 struct object_id tmp
;
411 if (!starts_with(refname
, "refs/heads/"))
413 /* If both heads/foo and tags/foo exists, get_sha1 would
416 if (get_oid(refname
+ ofs
, &tmp
) || !oideq(&tmp
, oid
))
418 return append_ref(refname
+ ofs
, oid
, 0);
421 static int append_remote_ref(const char *refname
, const struct object_id
*oid
,
422 int flag UNUSED
, void *cb_data UNUSED
)
424 struct object_id tmp
;
426 if (!starts_with(refname
, "refs/remotes/"))
428 /* If both heads/foo and tags/foo exists, get_sha1 would
431 if (get_oid(refname
+ ofs
, &tmp
) || !oideq(&tmp
, oid
))
433 return append_ref(refname
+ ofs
, oid
, 0);
436 static int append_tag_ref(const char *refname
, const struct object_id
*oid
,
437 int flag UNUSED
, void *cb_data UNUSED
)
439 if (!starts_with(refname
, "refs/tags/"))
441 return append_ref(refname
+ 5, oid
, 0);
444 static const char *match_ref_pattern
= NULL
;
445 static int match_ref_slash
= 0;
447 static int append_matching_ref(const char *refname
, const struct object_id
*oid
,
448 int flag
, void *cb_data
)
450 /* we want to allow pattern hold/<asterisk> to show all
451 * branches under refs/heads/hold/, and v0.99.9? to show
452 * refs/tags/v0.99.9a and friends.
455 int slash
= count_slashes(refname
);
456 for (tail
= refname
; *tail
&& match_ref_slash
< slash
; )
461 if (wildmatch(match_ref_pattern
, tail
, 0))
463 if (starts_with(refname
, "refs/heads/"))
464 return append_head_ref(refname
, oid
, flag
, cb_data
);
465 if (starts_with(refname
, "refs/tags/"))
466 return append_tag_ref(refname
, oid
, flag
, cb_data
);
467 return append_ref(refname
, oid
, 0);
470 static void snarf_refs(int head
, int remotes
)
473 int orig_cnt
= ref_name_cnt
;
475 for_each_ref(append_head_ref
, NULL
);
476 sort_ref_range(orig_cnt
, ref_name_cnt
);
479 int orig_cnt
= ref_name_cnt
;
481 for_each_ref(append_remote_ref
, NULL
);
482 sort_ref_range(orig_cnt
, ref_name_cnt
);
486 static int rev_is_head(const char *head
, const char *name
)
490 skip_prefix(head
, "refs/heads/", &head
);
491 if (!skip_prefix(name
, "refs/heads/", &name
))
492 skip_prefix(name
, "heads/", &name
);
493 return !strcmp(head
, name
);
496 static int show_merge_base(struct commit_list
*seen
, int num_rev
)
498 int all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
499 int all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
503 struct commit
*commit
= pop_commit(&seen
);
504 int flags
= commit
->object
.flags
& all_mask
;
505 if (!(flags
& UNINTERESTING
) &&
506 ((flags
& all_revs
) == all_revs
)) {
507 puts(oid_to_hex(&commit
->object
.oid
));
509 commit
->object
.flags
|= UNINTERESTING
;
515 static int show_independent(struct commit
**rev
,
517 unsigned int *rev_mask
)
521 for (i
= 0; i
< num_rev
; i
++) {
522 struct commit
*commit
= rev
[i
];
523 unsigned int flag
= rev_mask
[i
];
525 if (commit
->object
.flags
== flag
)
526 puts(oid_to_hex(&commit
->object
.oid
));
527 commit
->object
.flags
|= UNINTERESTING
;
532 static void append_one_rev(const char *av
)
534 struct object_id revkey
;
535 if (!get_oid(av
, &revkey
)) {
536 append_ref(av
, &revkey
, 0);
539 if (strpbrk(av
, "*?[")) {
540 /* glob style match */
541 int saved_matches
= ref_name_cnt
;
543 match_ref_pattern
= av
;
544 match_ref_slash
= count_slashes(av
);
545 for_each_ref(append_matching_ref
, NULL
);
546 if (saved_matches
== ref_name_cnt
&&
547 ref_name_cnt
< MAX_REVS
)
548 error(_("no matching refs with %s"), av
);
549 sort_ref_range(saved_matches
, ref_name_cnt
);
552 die("bad sha1 reference %s", av
);
555 static int git_show_branch_config(const char *var
, const char *value
, void *cb
)
557 if (!strcmp(var
, "showbranch.default")) {
559 return config_error_nonbool(var
);
561 * default_arg is now passed to parse_options(), so we need to
562 * mimic the real argv a bit better.
564 if (!default_args
.nr
)
565 strvec_push(&default_args
, "show-branch");
566 strvec_push(&default_args
, value
);
570 if (!strcmp(var
, "color.showbranch")) {
571 showbranch_use_color
= git_config_colorbool(var
, value
);
575 return git_color_default_config(var
, value
, cb
);
578 static int omit_in_dense(struct commit
*commit
, struct commit
**rev
, int n
)
580 /* If the commit is tip of the named branches, do not
582 * Otherwise, if it is a merge that is reachable from only one
583 * tip, it is not that interesting.
586 for (i
= 0; i
< n
; i
++)
587 if (rev
[i
] == commit
)
589 flag
= commit
->object
.flags
;
590 for (i
= count
= 0; i
< n
; i
++) {
591 if (flag
& (1u << (i
+ REV_SHIFT
)))
599 static int reflog
= 0;
601 static int parse_reflog_param(const struct option
*opt
, const char *arg
,
605 const char **base
= (const char **)opt
->value
;
606 BUG_ON_OPT_NEG(unset
);
609 reflog
= strtoul(arg
, &ep
, 10);
613 return error("unrecognized reflog param '%s'", arg
);
617 reflog
= DEFAULT_REFLOG
;
621 int cmd_show_branch(int ac
, const char **av
, const char *prefix
)
623 struct commit
*rev
[MAX_REVS
], *commit
;
624 char *reflog_msg
[MAX_REVS
];
625 struct commit_list
*list
= NULL
, *seen
= NULL
;
626 unsigned int rev_mask
[MAX_REVS
];
627 int num_rev
, i
, extra
= 0;
628 int all_heads
= 0, all_remotes
= 0;
629 int all_mask
, all_revs
;
630 enum rev_sort_order sort_order
= REV_SORT_IN_GRAPH_ORDER
;
632 struct object_id head_oid
;
637 int shown_merge_point
= 0;
638 int with_current_branch
= 0;
642 const char *reflog_base
= NULL
;
643 struct option builtin_show_branch_options
[] = {
644 OPT_BOOL('a', "all", &all_heads
,
645 N_("show remote-tracking and local branches")),
646 OPT_BOOL('r', "remotes", &all_remotes
,
647 N_("show remote-tracking branches")),
648 OPT__COLOR(&showbranch_use_color
,
649 N_("color '*!+-' corresponding to the branch")),
650 { OPTION_INTEGER
, 0, "more", &extra
, N_("n"),
651 N_("show <n> more commits after the common ancestor"),
652 PARSE_OPT_OPTARG
, NULL
, (intptr_t)1 },
653 OPT_SET_INT(0, "list", &extra
, N_("synonym to more=-1"), -1),
654 OPT_BOOL(0, "no-name", &no_name
, N_("suppress naming strings")),
655 OPT_BOOL(0, "current", &with_current_branch
,
656 N_("include the current branch")),
657 OPT_BOOL(0, "sha1-name", &sha1_name
,
658 N_("name commits with their object names")),
659 OPT_BOOL(0, "merge-base", &merge_base
,
660 N_("show possible merge bases")),
661 OPT_BOOL(0, "independent", &independent
,
662 N_("show refs unreachable from any other ref")),
663 OPT_SET_INT(0, "topo-order", &sort_order
,
664 N_("show commits in topological order"),
665 REV_SORT_IN_GRAPH_ORDER
),
666 OPT_BOOL(0, "topics", &topics
,
667 N_("show only commits not on the first branch")),
668 OPT_SET_INT(0, "sparse", &dense
,
669 N_("show merges reachable from only one tip"), 0),
670 OPT_SET_INT(0, "date-order", &sort_order
,
671 N_("topologically sort, maintaining date order "
673 REV_SORT_BY_COMMIT_DATE
),
674 OPT_CALLBACK_F('g', "reflog", &reflog_base
, N_("<n>[,<base>]"),
675 N_("show <n> most recent ref-log entries starting at "
677 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
682 init_commit_name_slab(&name_slab
);
684 git_config(git_show_branch_config
, NULL
);
686 /* If nothing is specified, try the default first */
687 if (ac
== 1 && default_args
.nr
) {
688 ac
= default_args
.nr
;
692 ac
= parse_options(ac
, av
, prefix
, builtin_show_branch_options
,
693 show_branch_usage
, PARSE_OPT_STOP_AT_NON_OPTION
);
697 if (extra
|| reflog
) {
698 /* "listing" mode is incompatible with
699 * independent nor merge-base modes.
701 if (independent
|| merge_base
)
702 usage_with_options(show_branch_usage
,
703 builtin_show_branch_options
);
704 if (reflog
&& ((0 < extra
) || all_heads
|| all_remotes
))
706 * Asking for --more in reflog mode does not
707 * make sense. --list is Ok.
709 * Also --all and --remotes do not make sense either.
711 die(_("options '%s' and '%s' cannot be used together"), "--reflog",
712 "--all/--remotes/--independent/--merge-base");
715 if (with_current_branch
&& reflog
)
716 die(_("options '%s' and '%s' cannot be used together"),
717 "--reflog", "--current");
719 /* If nothing is specified, show all branches by default */
720 if (ac
<= topics
&& all_heads
+ all_remotes
== 0)
724 struct object_id oid
;
727 unsigned int flags
= 0;
730 static const char *fake_av
[2];
732 fake_av
[0] = resolve_refdup("HEAD",
733 RESOLVE_REF_READING
, &oid
,
739 die(_("no branches given, and HEAD is not valid"));
742 die(_("--reflog option needs one branch name"));
744 if (MAX_REVS
< reflog
)
745 die(Q_("only %d entry can be shown at one time.",
746 "only %d entries can be shown at one time.",
747 MAX_REVS
), MAX_REVS
);
748 if (!dwim_ref(*av
, strlen(*av
), &oid
, &ref
, 0))
749 die(_("no such ref %s"), *av
);
751 /* Has the base been specified? */
754 base
= strtoul(reflog_base
, &ep
, 10);
756 /* Ah, that is a date spec... */
758 at
= approxidate(reflog_base
);
759 read_ref_at(get_main_ref_store(the_repository
),
760 ref
, flags
, at
, -1, &oid
, NULL
,
765 for (i
= 0; i
< reflog
; i
++) {
770 timestamp_t timestamp
;
773 if (read_ref_at(get_main_ref_store(the_repository
),
774 ref
, flags
, 0, base
+ i
, &oid
, &logmsg
,
775 ×tamp
, &tz
, NULL
)) {
780 end
= strchr(logmsg
, '\n');
784 msg
= (*logmsg
== '\0') ? "(none)" : logmsg
;
785 reflog_msg
[i
] = xstrfmt("(%s) %s",
786 show_date(timestamp
, tz
,
787 DATE_MODE(RELATIVE
)),
791 nth_desc
= xstrfmt("%s@{%d}", *av
, base
+i
);
792 append_ref(nth_desc
, &oid
, 1);
802 if (all_heads
+ all_remotes
)
803 snarf_refs(all_heads
, all_remotes
);
806 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
,
809 if (with_current_branch
&& head
) {
811 for (i
= 0; !has_head
&& i
< ref_name_cnt
; i
++) {
812 /* We are only interested in adding the branch
815 if (rev_is_head(head
, ref_name
[i
]))
819 const char *name
= head
;
820 skip_prefix(name
, "refs/heads/", &name
);
821 append_one_rev(name
);
826 fprintf(stderr
, "No revs to be shown.\n");
830 for (num_rev
= 0; ref_name
[num_rev
]; num_rev
++) {
831 struct object_id revkey
;
832 unsigned int flag
= 1u << (num_rev
+ REV_SHIFT
);
834 if (MAX_REVS
<= num_rev
)
835 die(Q_("cannot handle more than %d rev.",
836 "cannot handle more than %d revs.",
837 MAX_REVS
), MAX_REVS
);
838 if (get_oid(ref_name
[num_rev
], &revkey
))
839 die(_("'%s' is not a valid ref."), ref_name
[num_rev
]);
840 commit
= lookup_commit_reference(the_repository
, &revkey
);
842 die(_("cannot find commit %s (%s)"),
843 ref_name
[num_rev
], oid_to_hex(&revkey
));
844 parse_commit(commit
);
845 mark_seen(commit
, &seen
);
847 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
848 * and so on. REV_SHIFT bits from bit 0 are used for
849 * internal bookkeeping.
851 commit
->object
.flags
|= flag
;
852 if (commit
->object
.flags
== flag
)
853 commit_list_insert_by_date(commit
, &list
);
854 rev
[num_rev
] = commit
;
856 for (i
= 0; i
< num_rev
; i
++)
857 rev_mask
[i
] = rev
[i
]->object
.flags
;
860 join_revs(&list
, &seen
, num_rev
, extra
);
862 commit_list_sort_by_date(&seen
);
865 return show_merge_base(seen
, num_rev
);
868 return show_independent(rev
, num_rev
, rev_mask
);
870 /* Show list; --more=-1 means list-only */
871 if (1 < num_rev
|| extra
< 0) {
872 for (i
= 0; i
< num_rev
; i
++) {
874 int is_head
= rev_is_head(head
, ref_name
[i
]) &&
875 oideq(&head_oid
, &rev
[i
]->object
.oid
);
878 is_head
? '*' : ' ', ref_name
[i
]);
880 for (j
= 0; j
< i
; j
++)
882 printf("%s%c%s [%s] ",
885 get_color_reset_code(), ref_name
[i
]);
889 /* header lines never need name */
890 show_one_commit(rev
[i
], 1);
899 for (i
= 0; i
< num_rev
; i
++)
907 /* Sort topologically */
908 sort_in_topological_order(&seen
, sort_order
);
910 /* Give names to commits */
911 if (!sha1_name
&& !no_name
)
912 name_commits(seen
, rev
, ref_name
, num_rev
);
914 all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
915 all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
918 struct commit
*commit
= pop_commit(&seen
);
919 int this_flag
= commit
->object
.flags
;
920 int is_merge_point
= ((this_flag
& all_revs
) == all_revs
);
922 shown_merge_point
|= is_merge_point
;
925 int is_merge
= !!(commit
->parents
&&
926 commit
->parents
->next
);
929 (this_flag
& (1u << REV_SHIFT
)))
931 if (dense
&& is_merge
&&
932 omit_in_dense(commit
, rev
, num_rev
))
934 for (i
= 0; i
< num_rev
; i
++) {
936 if (!(this_flag
& (1u << (i
+ REV_SHIFT
))))
940 else if (i
== head_at
)
949 mark
, get_color_reset_code());
953 show_one_commit(commit
, no_name
);
955 if (shown_merge_point
&& --extra
< 0)