9 #include "parse-options.h"
11 #include "commit-slab.h"
14 static const char* show_branch_usage
[] = {
15 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
16 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
17 " [--more=<n> | --list | --independent | --merge-base]\n"
18 " [--no-name | --sha1-name] [--topics]\n"
19 " [(<rev> | <glob>)...]"),
20 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
24 static int showbranch_use_color
= -1;
26 static struct strvec default_args
= STRVEC_INIT
;
29 * TODO: convert this use of commit->object.flags to commit-slab
30 * instead to store a pointer to ref name directly. Then use the same
31 * UNINTERESTING definition from revision.h here.
33 #define UNINTERESTING 01
36 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
38 #define DEFAULT_REFLOG 4
40 static const char *get_color_code(int idx
)
42 if (want_color(showbranch_use_color
))
43 return column_colors_ansi
[idx
% column_colors_ansi_max
];
47 static const char *get_color_reset_code(void)
49 if (want_color(showbranch_use_color
))
50 return GIT_COLOR_RESET
;
54 static struct commit
*interesting(struct commit_list
*list
)
57 struct commit
*commit
= list
->item
;
59 if (commit
->object
.flags
& UNINTERESTING
)
67 const char *head_name
; /* which head's ancestor? */
68 int generation
; /* how many parents away from head_name */
71 define_commit_slab(commit_name_slab
, struct commit_name
*);
72 static struct commit_name_slab name_slab
;
74 static struct commit_name
*commit_to_name(struct commit
*commit
)
76 return *commit_name_slab_at(&name_slab
, commit
);
80 /* Name the commit as nth generation ancestor of head_name;
81 * we count only the first-parent relationship for naming purposes.
83 static void name_commit(struct commit
*commit
, const char *head_name
, int nth
)
85 struct commit_name
*name
;
87 name
= *commit_name_slab_at(&name_slab
, commit
);
89 name
= xmalloc(sizeof(*name
));
90 *commit_name_slab_at(&name_slab
, commit
) = name
;
92 name
->head_name
= head_name
;
93 name
->generation
= nth
;
96 /* Parent is the first parent of the commit. We may name it
97 * as (n+1)th generation ancestor of the same head_name as
98 * commit is nth generation ancestor of, if that generation
99 * number is better than the name it already has.
101 static void name_parent(struct commit
*commit
, struct commit
*parent
)
103 struct commit_name
*commit_name
= commit_to_name(commit
);
104 struct commit_name
*parent_name
= commit_to_name(parent
);
108 commit_name
->generation
+ 1 < parent_name
->generation
)
109 name_commit(parent
, commit_name
->head_name
,
110 commit_name
->generation
+ 1);
113 static int name_first_parent_chain(struct commit
*c
)
118 if (!commit_to_name(c
))
122 p
= c
->parents
->item
;
123 if (!commit_to_name(p
)) {
134 static void name_commits(struct commit_list
*list
,
139 struct commit_list
*cl
;
143 /* First give names to the given heads */
144 for (cl
= list
; cl
; cl
= cl
->next
) {
146 if (commit_to_name(c
))
148 for (i
= 0; i
< num_rev
; i
++) {
150 name_commit(c
, ref_name
[i
], 0);
156 /* Then commits on the first parent ancestry chain */
159 for (cl
= list
; cl
; cl
= cl
->next
) {
160 i
+= name_first_parent_chain(cl
->item
);
164 /* Finally, any unnamed commits */
167 for (cl
= list
; cl
; cl
= cl
->next
) {
168 struct commit_list
*parents
;
169 struct commit_name
*n
;
172 if (!commit_to_name(c
))
174 n
= commit_to_name(c
);
175 parents
= c
->parents
;
178 struct commit
*p
= parents
->item
;
179 struct strbuf newname
= STRBUF_INIT
;
180 parents
= parents
->next
;
182 if (commit_to_name(p
))
184 switch (n
->generation
) {
186 strbuf_addstr(&newname
, n
->head_name
);
189 strbuf_addf(&newname
, "%s^", n
->head_name
);
192 strbuf_addf(&newname
, "%s~%d",
193 n
->head_name
, n
->generation
);
197 strbuf_addch(&newname
, '^');
199 strbuf_addf(&newname
, "^%d", nth
);
200 name_commit(p
, strbuf_detach(&newname
, NULL
), 0);
202 name_first_parent_chain(p
);
208 static int mark_seen(struct commit
*commit
, struct commit_list
**seen_p
)
210 if (!commit
->object
.flags
) {
211 commit_list_insert(commit
, seen_p
);
217 static void join_revs(struct commit_list
**list_p
,
218 struct commit_list
**seen_p
,
219 int num_rev
, int extra
)
221 int all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
222 int all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
225 struct commit_list
*parents
;
226 int still_interesting
= !!interesting(*list_p
);
227 struct commit
*commit
= pop_commit(list_p
);
228 int flags
= commit
->object
.flags
& all_mask
;
230 if (!still_interesting
&& extra
<= 0)
233 mark_seen(commit
, seen_p
);
234 if ((flags
& all_revs
) == all_revs
)
235 flags
|= UNINTERESTING
;
236 parents
= commit
->parents
;
239 struct commit
*p
= parents
->item
;
240 int this_flag
= p
->object
.flags
;
241 parents
= parents
->next
;
242 if ((this_flag
& flags
) == flags
)
245 if (mark_seen(p
, seen_p
) && !still_interesting
)
247 p
->object
.flags
|= flags
;
248 commit_list_insert_by_date(p
, list_p
);
253 * Postprocess to complete well-poisoning.
255 * At this point we have all the commits we have seen in
256 * seen_p list. Mark anything that can be reached from
257 * uninteresting commits not interesting.
261 struct commit_list
*s
;
262 for (s
= *seen_p
; s
; s
= s
->next
) {
263 struct commit
*c
= s
->item
;
264 struct commit_list
*parents
;
266 if (((c
->object
.flags
& all_revs
) != all_revs
) &&
267 !(c
->object
.flags
& UNINTERESTING
))
270 /* The current commit is either a merge base or
271 * already uninteresting one. Mark its parents
272 * as uninteresting commits _only_ if they are
273 * already parsed. No reason to find new ones
276 parents
= c
->parents
;
278 struct commit
*p
= parents
->item
;
279 parents
= parents
->next
;
280 if (!(p
->object
.flags
& UNINTERESTING
)) {
281 p
->object
.flags
|= UNINTERESTING
;
291 static void show_one_commit(struct commit
*commit
, int no_name
)
293 struct strbuf pretty
= STRBUF_INIT
;
294 const char *pretty_str
= "(unavailable)";
295 struct commit_name
*name
= commit_to_name(commit
);
297 if (commit
->object
.parsed
) {
298 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &pretty
);
299 pretty_str
= pretty
.buf
;
301 skip_prefix(pretty_str
, "[PATCH] ", &pretty_str
);
304 if (name
&& name
->head_name
) {
305 printf("[%s", name
->head_name
);
306 if (name
->generation
) {
307 if (name
->generation
== 1)
310 printf("~%d", name
->generation
);
316 find_unique_abbrev(&commit
->object
.oid
,
320 strbuf_release(&pretty
);
323 static char *ref_name
[MAX_REVS
+ 1];
324 static int ref_name_cnt
;
326 static const char *find_digit_prefix(const char *s
, int *v
)
333 '0' <= (ch
= *p
) && ch
<= '9';
335 ver
= ver
* 10 + ch
- '0';
341 static int version_cmp(const char *a
, const char *b
)
346 a
= find_digit_prefix(a
, &va
);
347 b
= find_digit_prefix(b
, &vb
);
354 if ('0' <= ca
&& ca
<= '9')
356 if ('0' <= cb
&& cb
<= '9')
370 static int compare_ref_name(const void *a_
, const void *b_
)
372 const char * const*a
= a_
, * const*b
= b_
;
373 return version_cmp(*a
, *b
);
376 static void sort_ref_range(int bottom
, int top
)
378 QSORT(ref_name
+ bottom
, top
- bottom
, compare_ref_name
);
381 static int append_ref(const char *refname
, const struct object_id
*oid
,
384 struct commit
*commit
= lookup_commit_reference_gently(the_repository
,
392 /* Avoid adding the same thing twice */
393 for (i
= 0; i
< ref_name_cnt
; i
++)
394 if (!strcmp(refname
, ref_name
[i
]))
397 if (MAX_REVS
<= ref_name_cnt
) {
398 warning(Q_("ignoring %s; cannot handle more than %d ref",
399 "ignoring %s; cannot handle more than %d refs",
400 MAX_REVS
), refname
, MAX_REVS
);
403 ref_name
[ref_name_cnt
++] = xstrdup(refname
);
404 ref_name
[ref_name_cnt
] = NULL
;
408 static int append_head_ref(const char *refname
, const struct object_id
*oid
,
409 int flag UNUSED
, void *cb_data UNUSED
)
411 struct object_id tmp
;
413 if (!starts_with(refname
, "refs/heads/"))
415 /* If both heads/foo and tags/foo exists, get_sha1 would
418 if (get_oid(refname
+ ofs
, &tmp
) || !oideq(&tmp
, oid
))
420 return append_ref(refname
+ ofs
, oid
, 0);
423 static int append_remote_ref(const char *refname
, const struct object_id
*oid
,
424 int flag UNUSED
, void *cb_data UNUSED
)
426 struct object_id tmp
;
428 if (!starts_with(refname
, "refs/remotes/"))
430 /* If both heads/foo and tags/foo exists, get_sha1 would
433 if (get_oid(refname
+ ofs
, &tmp
) || !oideq(&tmp
, oid
))
435 return append_ref(refname
+ ofs
, oid
, 0);
438 static int append_tag_ref(const char *refname
, const struct object_id
*oid
,
439 int flag UNUSED
, void *cb_data UNUSED
)
441 if (!starts_with(refname
, "refs/tags/"))
443 return append_ref(refname
+ 5, oid
, 0);
446 static const char *match_ref_pattern
= NULL
;
447 static int match_ref_slash
= 0;
449 static int append_matching_ref(const char *refname
, const struct object_id
*oid
,
450 int flag
, void *cb_data
)
452 /* we want to allow pattern hold/<asterisk> to show all
453 * branches under refs/heads/hold/, and v0.99.9? to show
454 * refs/tags/v0.99.9a and friends.
457 int slash
= count_slashes(refname
);
458 for (tail
= refname
; *tail
&& match_ref_slash
< slash
; )
463 if (wildmatch(match_ref_pattern
, tail
, 0))
465 if (starts_with(refname
, "refs/heads/"))
466 return append_head_ref(refname
, oid
, flag
, cb_data
);
467 if (starts_with(refname
, "refs/tags/"))
468 return append_tag_ref(refname
, oid
, flag
, cb_data
);
469 return append_ref(refname
, oid
, 0);
472 static void snarf_refs(int head
, int remotes
)
475 int orig_cnt
= ref_name_cnt
;
477 for_each_ref(append_head_ref
, NULL
);
478 sort_ref_range(orig_cnt
, ref_name_cnt
);
481 int orig_cnt
= ref_name_cnt
;
483 for_each_ref(append_remote_ref
, NULL
);
484 sort_ref_range(orig_cnt
, ref_name_cnt
);
488 static int rev_is_head(const char *head
, const char *name
)
492 skip_prefix(head
, "refs/heads/", &head
);
493 if (!skip_prefix(name
, "refs/heads/", &name
))
494 skip_prefix(name
, "heads/", &name
);
495 return !strcmp(head
, name
);
498 static int show_merge_base(struct commit_list
*seen
, int num_rev
)
500 int all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
501 int all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
505 struct commit
*commit
= pop_commit(&seen
);
506 int flags
= commit
->object
.flags
& all_mask
;
507 if (!(flags
& UNINTERESTING
) &&
508 ((flags
& all_revs
) == all_revs
)) {
509 puts(oid_to_hex(&commit
->object
.oid
));
511 commit
->object
.flags
|= UNINTERESTING
;
517 static int show_independent(struct commit
**rev
,
519 unsigned int *rev_mask
)
523 for (i
= 0; i
< num_rev
; i
++) {
524 struct commit
*commit
= rev
[i
];
525 unsigned int flag
= rev_mask
[i
];
527 if (commit
->object
.flags
== flag
)
528 puts(oid_to_hex(&commit
->object
.oid
));
529 commit
->object
.flags
|= UNINTERESTING
;
534 static void append_one_rev(const char *av
)
536 struct object_id revkey
;
537 if (!get_oid(av
, &revkey
)) {
538 append_ref(av
, &revkey
, 0);
541 if (strpbrk(av
, "*?[")) {
542 /* glob style match */
543 int saved_matches
= ref_name_cnt
;
545 match_ref_pattern
= av
;
546 match_ref_slash
= count_slashes(av
);
547 for_each_ref(append_matching_ref
, NULL
);
548 if (saved_matches
== ref_name_cnt
&&
549 ref_name_cnt
< MAX_REVS
)
550 error(_("no matching refs with %s"), av
);
551 sort_ref_range(saved_matches
, ref_name_cnt
);
554 die("bad sha1 reference %s", av
);
557 static int git_show_branch_config(const char *var
, const char *value
, void *cb
)
559 if (!strcmp(var
, "showbranch.default")) {
561 return config_error_nonbool(var
);
563 * default_arg is now passed to parse_options(), so we need to
564 * mimic the real argv a bit better.
566 if (!default_args
.nr
)
567 strvec_push(&default_args
, "show-branch");
568 strvec_push(&default_args
, value
);
572 if (!strcmp(var
, "color.showbranch")) {
573 showbranch_use_color
= git_config_colorbool(var
, value
);
577 return git_color_default_config(var
, value
, cb
);
580 static int omit_in_dense(struct commit
*commit
, struct commit
**rev
, int n
)
582 /* If the commit is tip of the named branches, do not
584 * Otherwise, if it is a merge that is reachable from only one
585 * tip, it is not that interesting.
588 for (i
= 0; i
< n
; i
++)
589 if (rev
[i
] == commit
)
591 flag
= commit
->object
.flags
;
592 for (i
= count
= 0; i
< n
; i
++) {
593 if (flag
& (1u << (i
+ REV_SHIFT
)))
601 static int reflog
= 0;
603 static int parse_reflog_param(const struct option
*opt
, const char *arg
,
607 const char **base
= (const char **)opt
->value
;
608 BUG_ON_OPT_NEG(unset
);
611 reflog
= strtoul(arg
, &ep
, 10);
615 return error("unrecognized reflog param '%s'", arg
);
619 reflog
= DEFAULT_REFLOG
;
623 int cmd_show_branch(int ac
, const char **av
, const char *prefix
)
625 struct commit
*rev
[MAX_REVS
], *commit
;
626 char *reflog_msg
[MAX_REVS
];
627 struct commit_list
*list
= NULL
, *seen
= NULL
;
628 unsigned int rev_mask
[MAX_REVS
];
629 int num_rev
, i
, extra
= 0;
630 int all_heads
= 0, all_remotes
= 0;
631 int all_mask
, all_revs
;
632 enum rev_sort_order sort_order
= REV_SORT_IN_GRAPH_ORDER
;
634 struct object_id head_oid
;
639 int shown_merge_point
= 0;
640 int with_current_branch
= 0;
644 const char *reflog_base
= NULL
;
645 struct option builtin_show_branch_options
[] = {
646 OPT_BOOL('a', "all", &all_heads
,
647 N_("show remote-tracking and local branches")),
648 OPT_BOOL('r', "remotes", &all_remotes
,
649 N_("show remote-tracking branches")),
650 OPT__COLOR(&showbranch_use_color
,
651 N_("color '*!+-' corresponding to the branch")),
652 { OPTION_INTEGER
, 0, "more", &extra
, N_("n"),
653 N_("show <n> more commits after the common ancestor"),
654 PARSE_OPT_OPTARG
, NULL
, (intptr_t)1 },
655 OPT_SET_INT(0, "list", &extra
, N_("synonym to more=-1"), -1),
656 OPT_BOOL(0, "no-name", &no_name
, N_("suppress naming strings")),
657 OPT_BOOL(0, "current", &with_current_branch
,
658 N_("include the current branch")),
659 OPT_BOOL(0, "sha1-name", &sha1_name
,
660 N_("name commits with their object names")),
661 OPT_BOOL(0, "merge-base", &merge_base
,
662 N_("show possible merge bases")),
663 OPT_BOOL(0, "independent", &independent
,
664 N_("show refs unreachable from any other ref")),
665 OPT_SET_INT(0, "topo-order", &sort_order
,
666 N_("show commits in topological order"),
667 REV_SORT_IN_GRAPH_ORDER
),
668 OPT_BOOL(0, "topics", &topics
,
669 N_("show only commits not on the first branch")),
670 OPT_SET_INT(0, "sparse", &dense
,
671 N_("show merges reachable from only one tip"), 0),
672 OPT_SET_INT(0, "date-order", &sort_order
,
673 N_("topologically sort, maintaining date order "
675 REV_SORT_BY_COMMIT_DATE
),
676 OPT_CALLBACK_F('g', "reflog", &reflog_base
, N_("<n>[,<base>]"),
677 N_("show <n> most recent ref-log entries starting at "
679 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
684 init_commit_name_slab(&name_slab
);
686 git_config(git_show_branch_config
, NULL
);
688 /* If nothing is specified, try the default first */
689 if (ac
== 1 && default_args
.nr
) {
690 ac
= default_args
.nr
;
694 ac
= parse_options(ac
, av
, prefix
, builtin_show_branch_options
,
695 show_branch_usage
, PARSE_OPT_STOP_AT_NON_OPTION
);
699 if (extra
|| reflog
) {
700 /* "listing" mode is incompatible with
701 * independent nor merge-base modes.
703 if (independent
|| merge_base
)
704 usage_with_options(show_branch_usage
,
705 builtin_show_branch_options
);
706 if (reflog
&& ((0 < extra
) || all_heads
|| all_remotes
))
708 * Asking for --more in reflog mode does not
709 * make sense. --list is Ok.
711 * Also --all and --remotes do not make sense either.
713 die(_("options '%s' and '%s' cannot be used together"), "--reflog",
714 "--all/--remotes/--independent/--merge-base");
717 if (with_current_branch
&& reflog
)
718 die(_("options '%s' and '%s' cannot be used together"),
719 "--reflog", "--current");
721 /* If nothing is specified, show all branches by default */
722 if (ac
<= topics
&& all_heads
+ all_remotes
== 0)
726 struct object_id oid
;
729 unsigned int flags
= 0;
732 static const char *fake_av
[2];
734 fake_av
[0] = resolve_refdup("HEAD",
735 RESOLVE_REF_READING
, &oid
,
741 die(_("no branches given, and HEAD is not valid"));
744 die(_("--reflog option needs one branch name"));
746 if (MAX_REVS
< reflog
)
747 die(Q_("only %d entry can be shown at one time.",
748 "only %d entries can be shown at one time.",
749 MAX_REVS
), MAX_REVS
);
750 if (!dwim_ref(*av
, strlen(*av
), &oid
, &ref
, 0))
751 die(_("no such ref %s"), *av
);
753 /* Has the base been specified? */
756 base
= strtoul(reflog_base
, &ep
, 10);
758 /* Ah, that is a date spec... */
760 at
= approxidate(reflog_base
);
761 read_ref_at(get_main_ref_store(the_repository
),
762 ref
, flags
, at
, -1, &oid
, NULL
,
767 for (i
= 0; i
< reflog
; i
++) {
772 timestamp_t timestamp
;
775 if (read_ref_at(get_main_ref_store(the_repository
),
776 ref
, flags
, 0, base
+ i
, &oid
, &logmsg
,
777 ×tamp
, &tz
, NULL
)) {
782 end
= strchr(logmsg
, '\n');
786 msg
= (*logmsg
== '\0') ? "(none)" : logmsg
;
787 reflog_msg
[i
] = xstrfmt("(%s) %s",
788 show_date(timestamp
, tz
,
789 DATE_MODE(RELATIVE
)),
793 nth_desc
= xstrfmt("%s@{%d}", *av
, base
+i
);
794 append_ref(nth_desc
, &oid
, 1);
804 if (all_heads
+ all_remotes
)
805 snarf_refs(all_heads
, all_remotes
);
808 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
,
811 if (with_current_branch
&& head
) {
813 for (i
= 0; !has_head
&& i
< ref_name_cnt
; i
++) {
814 /* We are only interested in adding the branch
817 if (rev_is_head(head
, ref_name
[i
]))
821 const char *name
= head
;
822 skip_prefix(name
, "refs/heads/", &name
);
823 append_one_rev(name
);
828 fprintf(stderr
, "No revs to be shown.\n");
832 for (num_rev
= 0; ref_name
[num_rev
]; num_rev
++) {
833 struct object_id revkey
;
834 unsigned int flag
= 1u << (num_rev
+ REV_SHIFT
);
836 if (MAX_REVS
<= num_rev
)
837 die(Q_("cannot handle more than %d rev.",
838 "cannot handle more than %d revs.",
839 MAX_REVS
), MAX_REVS
);
840 if (get_oid(ref_name
[num_rev
], &revkey
))
841 die(_("'%s' is not a valid ref."), ref_name
[num_rev
]);
842 commit
= lookup_commit_reference(the_repository
, &revkey
);
844 die(_("cannot find commit %s (%s)"),
845 ref_name
[num_rev
], oid_to_hex(&revkey
));
846 parse_commit(commit
);
847 mark_seen(commit
, &seen
);
849 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
850 * and so on. REV_SHIFT bits from bit 0 are used for
851 * internal bookkeeping.
853 commit
->object
.flags
|= flag
;
854 if (commit
->object
.flags
== flag
)
855 commit_list_insert_by_date(commit
, &list
);
856 rev
[num_rev
] = commit
;
858 for (i
= 0; i
< num_rev
; i
++)
859 rev_mask
[i
] = rev
[i
]->object
.flags
;
862 join_revs(&list
, &seen
, num_rev
, extra
);
864 commit_list_sort_by_date(&seen
);
867 return show_merge_base(seen
, num_rev
);
870 return show_independent(rev
, num_rev
, rev_mask
);
872 /* Show list; --more=-1 means list-only */
873 if (1 < num_rev
|| extra
< 0) {
874 for (i
= 0; i
< num_rev
; i
++) {
876 int is_head
= rev_is_head(head
, ref_name
[i
]) &&
877 oideq(&head_oid
, &rev
[i
]->object
.oid
);
880 is_head
? '*' : ' ', ref_name
[i
]);
882 for (j
= 0; j
< i
; j
++)
884 printf("%s%c%s [%s] ",
887 get_color_reset_code(), ref_name
[i
]);
891 /* header lines never need name */
892 show_one_commit(rev
[i
], 1);
901 for (i
= 0; i
< num_rev
; i
++)
909 /* Sort topologically */
910 sort_in_topological_order(&seen
, sort_order
);
912 /* Give names to commits */
913 if (!sha1_name
&& !no_name
)
914 name_commits(seen
, rev
, ref_name
, num_rev
);
916 all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
917 all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
920 struct commit
*commit
= pop_commit(&seen
);
921 int this_flag
= commit
->object
.flags
;
922 int is_merge_point
= ((this_flag
& all_revs
) == all_revs
);
924 shown_merge_point
|= is_merge_point
;
927 int is_merge
= !!(commit
->parents
&&
928 commit
->parents
->next
);
931 (this_flag
& (1u << REV_SHIFT
)))
933 if (dense
&& is_merge
&&
934 omit_in_dense(commit
, rev
, num_rev
))
936 for (i
= 0; i
< num_rev
; i
++) {
938 if (!(this_flag
& (1u << (i
+ REV_SHIFT
))))
942 else if (i
== head_at
)
951 mark
, get_color_reset_code());
955 show_one_commit(commit
, no_name
);
957 if (shown_merge_point
&& --extra
< 0)