10 #include "parse-options.h"
12 #include "commit-slab.h"
15 static const char* show_branch_usage
[] = {
16 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
17 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
18 " [--more=<n> | --list | --independent | --merge-base]\n"
19 " [--no-name | --sha1-name] [--topics]\n"
20 " [(<rev> | <glob>)...]"),
21 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
25 static int showbranch_use_color
= -1;
27 static struct strvec default_args
= STRVEC_INIT
;
30 * TODO: convert this use of commit->object.flags to commit-slab
31 * instead to store a pointer to ref name directly. Then use the same
32 * UNINTERESTING definition from revision.h here.
34 #define UNINTERESTING 01
37 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
39 #define DEFAULT_REFLOG 4
41 static const char *get_color_code(int idx
)
43 if (want_color(showbranch_use_color
))
44 return column_colors_ansi
[idx
% column_colors_ansi_max
];
48 static const char *get_color_reset_code(void)
50 if (want_color(showbranch_use_color
))
51 return GIT_COLOR_RESET
;
55 static struct commit
*interesting(struct commit_list
*list
)
58 struct commit
*commit
= list
->item
;
60 if (commit
->object
.flags
& UNINTERESTING
)
68 const char *head_name
; /* which head's ancestor? */
69 int generation
; /* how many parents away from head_name */
72 define_commit_slab(commit_name_slab
, struct commit_name
*);
73 static struct commit_name_slab name_slab
;
75 static struct commit_name
*commit_to_name(struct commit
*commit
)
77 return *commit_name_slab_at(&name_slab
, commit
);
81 /* Name the commit as nth generation ancestor of head_name;
82 * we count only the first-parent relationship for naming purposes.
84 static void name_commit(struct commit
*commit
, const char *head_name
, int nth
)
86 struct commit_name
*name
;
88 name
= *commit_name_slab_at(&name_slab
, commit
);
90 name
= xmalloc(sizeof(*name
));
91 *commit_name_slab_at(&name_slab
, commit
) = name
;
93 name
->head_name
= head_name
;
94 name
->generation
= nth
;
97 /* Parent is the first parent of the commit. We may name it
98 * as (n+1)th generation ancestor of the same head_name as
99 * commit is nth generation ancestor of, if that generation
100 * number is better than the name it already has.
102 static void name_parent(struct commit
*commit
, struct commit
*parent
)
104 struct commit_name
*commit_name
= commit_to_name(commit
);
105 struct commit_name
*parent_name
= commit_to_name(parent
);
109 commit_name
->generation
+ 1 < parent_name
->generation
)
110 name_commit(parent
, commit_name
->head_name
,
111 commit_name
->generation
+ 1);
114 static int name_first_parent_chain(struct commit
*c
)
119 if (!commit_to_name(c
))
123 p
= c
->parents
->item
;
124 if (!commit_to_name(p
)) {
135 static void name_commits(struct commit_list
*list
,
140 struct commit_list
*cl
;
144 /* First give names to the given heads */
145 for (cl
= list
; cl
; cl
= cl
->next
) {
147 if (commit_to_name(c
))
149 for (i
= 0; i
< num_rev
; i
++) {
151 name_commit(c
, ref_name
[i
], 0);
157 /* Then commits on the first parent ancestry chain */
160 for (cl
= list
; cl
; cl
= cl
->next
) {
161 i
+= name_first_parent_chain(cl
->item
);
165 /* Finally, any unnamed commits */
168 for (cl
= list
; cl
; cl
= cl
->next
) {
169 struct commit_list
*parents
;
170 struct commit_name
*n
;
173 if (!commit_to_name(c
))
175 n
= commit_to_name(c
);
176 parents
= c
->parents
;
179 struct commit
*p
= parents
->item
;
180 struct strbuf newname
= STRBUF_INIT
;
181 parents
= parents
->next
;
183 if (commit_to_name(p
))
185 switch (n
->generation
) {
187 strbuf_addstr(&newname
, n
->head_name
);
190 strbuf_addf(&newname
, "%s^", n
->head_name
);
193 strbuf_addf(&newname
, "%s~%d",
194 n
->head_name
, n
->generation
);
198 strbuf_addch(&newname
, '^');
200 strbuf_addf(&newname
, "^%d", nth
);
201 name_commit(p
, strbuf_detach(&newname
, NULL
), 0);
203 name_first_parent_chain(p
);
209 static int mark_seen(struct commit
*commit
, struct commit_list
**seen_p
)
211 if (!commit
->object
.flags
) {
212 commit_list_insert(commit
, seen_p
);
218 static void join_revs(struct commit_list
**list_p
,
219 struct commit_list
**seen_p
,
220 int num_rev
, int extra
)
222 int all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
223 int all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
226 struct commit_list
*parents
;
227 int still_interesting
= !!interesting(*list_p
);
228 struct commit
*commit
= pop_commit(list_p
);
229 int flags
= commit
->object
.flags
& all_mask
;
231 if (!still_interesting
&& extra
<= 0)
234 mark_seen(commit
, seen_p
);
235 if ((flags
& all_revs
) == all_revs
)
236 flags
|= UNINTERESTING
;
237 parents
= commit
->parents
;
240 struct commit
*p
= parents
->item
;
241 int this_flag
= p
->object
.flags
;
242 parents
= parents
->next
;
243 if ((this_flag
& flags
) == flags
)
246 if (mark_seen(p
, seen_p
) && !still_interesting
)
248 p
->object
.flags
|= flags
;
249 commit_list_insert_by_date(p
, list_p
);
254 * Postprocess to complete well-poisoning.
256 * At this point we have all the commits we have seen in
257 * seen_p list. Mark anything that can be reached from
258 * uninteresting commits not interesting.
262 struct commit_list
*s
;
263 for (s
= *seen_p
; s
; s
= s
->next
) {
264 struct commit
*c
= s
->item
;
265 struct commit_list
*parents
;
267 if (((c
->object
.flags
& all_revs
) != all_revs
) &&
268 !(c
->object
.flags
& UNINTERESTING
))
271 /* The current commit is either a merge base or
272 * already uninteresting one. Mark its parents
273 * as uninteresting commits _only_ if they are
274 * already parsed. No reason to find new ones
277 parents
= c
->parents
;
279 struct commit
*p
= parents
->item
;
280 parents
= parents
->next
;
281 if (!(p
->object
.flags
& UNINTERESTING
)) {
282 p
->object
.flags
|= UNINTERESTING
;
292 static void show_one_commit(struct commit
*commit
, int no_name
)
294 struct strbuf pretty
= STRBUF_INIT
;
295 const char *pretty_str
= "(unavailable)";
296 struct commit_name
*name
= commit_to_name(commit
);
298 if (commit
->object
.parsed
) {
299 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &pretty
);
300 pretty_str
= pretty
.buf
;
302 skip_prefix(pretty_str
, "[PATCH] ", &pretty_str
);
305 if (name
&& name
->head_name
) {
306 printf("[%s", name
->head_name
);
307 if (name
->generation
) {
308 if (name
->generation
== 1)
311 printf("~%d", name
->generation
);
317 find_unique_abbrev(&commit
->object
.oid
,
321 strbuf_release(&pretty
);
324 static char *ref_name
[MAX_REVS
+ 1];
325 static int ref_name_cnt
;
327 static const char *find_digit_prefix(const char *s
, int *v
)
334 '0' <= (ch
= *p
) && ch
<= '9';
336 ver
= ver
* 10 + ch
- '0';
342 static int version_cmp(const char *a
, const char *b
)
347 a
= find_digit_prefix(a
, &va
);
348 b
= find_digit_prefix(b
, &vb
);
355 if ('0' <= ca
&& ca
<= '9')
357 if ('0' <= cb
&& cb
<= '9')
371 static int compare_ref_name(const void *a_
, const void *b_
)
373 const char * const*a
= a_
, * const*b
= b_
;
374 return version_cmp(*a
, *b
);
377 static void sort_ref_range(int bottom
, int top
)
379 QSORT(ref_name
+ bottom
, top
- bottom
, compare_ref_name
);
382 static int append_ref(const char *refname
, const struct object_id
*oid
,
385 struct commit
*commit
= lookup_commit_reference_gently(the_repository
,
393 /* Avoid adding the same thing twice */
394 for (i
= 0; i
< ref_name_cnt
; i
++)
395 if (!strcmp(refname
, ref_name
[i
]))
398 if (MAX_REVS
<= ref_name_cnt
) {
399 warning(Q_("ignoring %s; cannot handle more than %d ref",
400 "ignoring %s; cannot handle more than %d refs",
401 MAX_REVS
), refname
, MAX_REVS
);
404 ref_name
[ref_name_cnt
++] = xstrdup(refname
);
405 ref_name
[ref_name_cnt
] = NULL
;
409 static int append_head_ref(const char *refname
, const struct object_id
*oid
,
410 int flag UNUSED
, void *cb_data UNUSED
)
412 struct object_id tmp
;
414 if (!starts_with(refname
, "refs/heads/"))
416 /* If both heads/foo and tags/foo exists, get_sha1 would
419 if (get_oid(refname
+ ofs
, &tmp
) || !oideq(&tmp
, oid
))
421 return append_ref(refname
+ ofs
, oid
, 0);
424 static int append_remote_ref(const char *refname
, const struct object_id
*oid
,
425 int flag UNUSED
, void *cb_data UNUSED
)
427 struct object_id tmp
;
429 if (!starts_with(refname
, "refs/remotes/"))
431 /* If both heads/foo and tags/foo exists, get_sha1 would
434 if (get_oid(refname
+ ofs
, &tmp
) || !oideq(&tmp
, oid
))
436 return append_ref(refname
+ ofs
, oid
, 0);
439 static int append_tag_ref(const char *refname
, const struct object_id
*oid
,
440 int flag UNUSED
, void *cb_data UNUSED
)
442 if (!starts_with(refname
, "refs/tags/"))
444 return append_ref(refname
+ 5, oid
, 0);
447 static const char *match_ref_pattern
= NULL
;
448 static int match_ref_slash
= 0;
450 static int append_matching_ref(const char *refname
, const struct object_id
*oid
,
451 int flag
, void *cb_data
)
453 /* we want to allow pattern hold/<asterisk> to show all
454 * branches under refs/heads/hold/, and v0.99.9? to show
455 * refs/tags/v0.99.9a and friends.
458 int slash
= count_slashes(refname
);
459 for (tail
= refname
; *tail
&& match_ref_slash
< slash
; )
464 if (wildmatch(match_ref_pattern
, tail
, 0))
466 if (starts_with(refname
, "refs/heads/"))
467 return append_head_ref(refname
, oid
, flag
, cb_data
);
468 if (starts_with(refname
, "refs/tags/"))
469 return append_tag_ref(refname
, oid
, flag
, cb_data
);
470 return append_ref(refname
, oid
, 0);
473 static void snarf_refs(int head
, int remotes
)
476 int orig_cnt
= ref_name_cnt
;
478 for_each_ref(append_head_ref
, NULL
);
479 sort_ref_range(orig_cnt
, ref_name_cnt
);
482 int orig_cnt
= ref_name_cnt
;
484 for_each_ref(append_remote_ref
, NULL
);
485 sort_ref_range(orig_cnt
, ref_name_cnt
);
489 static int rev_is_head(const char *head
, const char *name
)
493 skip_prefix(head
, "refs/heads/", &head
);
494 if (!skip_prefix(name
, "refs/heads/", &name
))
495 skip_prefix(name
, "heads/", &name
);
496 return !strcmp(head
, name
);
499 static int show_merge_base(struct commit_list
*seen
, int num_rev
)
501 int all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
502 int all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
506 struct commit
*commit
= pop_commit(&seen
);
507 int flags
= commit
->object
.flags
& all_mask
;
508 if (!(flags
& UNINTERESTING
) &&
509 ((flags
& all_revs
) == all_revs
)) {
510 puts(oid_to_hex(&commit
->object
.oid
));
512 commit
->object
.flags
|= UNINTERESTING
;
518 static int show_independent(struct commit
**rev
,
520 unsigned int *rev_mask
)
524 for (i
= 0; i
< num_rev
; i
++) {
525 struct commit
*commit
= rev
[i
];
526 unsigned int flag
= rev_mask
[i
];
528 if (commit
->object
.flags
== flag
)
529 puts(oid_to_hex(&commit
->object
.oid
));
530 commit
->object
.flags
|= UNINTERESTING
;
535 static void append_one_rev(const char *av
)
537 struct object_id revkey
;
538 if (!get_oid(av
, &revkey
)) {
539 append_ref(av
, &revkey
, 0);
542 if (strpbrk(av
, "*?[")) {
543 /* glob style match */
544 int saved_matches
= ref_name_cnt
;
546 match_ref_pattern
= av
;
547 match_ref_slash
= count_slashes(av
);
548 for_each_ref(append_matching_ref
, NULL
);
549 if (saved_matches
== ref_name_cnt
&&
550 ref_name_cnt
< MAX_REVS
)
551 error(_("no matching refs with %s"), av
);
552 sort_ref_range(saved_matches
, ref_name_cnt
);
555 die("bad sha1 reference %s", av
);
558 static int git_show_branch_config(const char *var
, const char *value
, void *cb
)
560 if (!strcmp(var
, "showbranch.default")) {
562 return config_error_nonbool(var
);
564 * default_arg is now passed to parse_options(), so we need to
565 * mimic the real argv a bit better.
567 if (!default_args
.nr
)
568 strvec_push(&default_args
, "show-branch");
569 strvec_push(&default_args
, value
);
573 if (!strcmp(var
, "color.showbranch")) {
574 showbranch_use_color
= git_config_colorbool(var
, value
);
578 return git_color_default_config(var
, value
, cb
);
581 static int omit_in_dense(struct commit
*commit
, struct commit
**rev
, int n
)
583 /* If the commit is tip of the named branches, do not
585 * Otherwise, if it is a merge that is reachable from only one
586 * tip, it is not that interesting.
589 for (i
= 0; i
< n
; i
++)
590 if (rev
[i
] == commit
)
592 flag
= commit
->object
.flags
;
593 for (i
= count
= 0; i
< n
; i
++) {
594 if (flag
& (1u << (i
+ REV_SHIFT
)))
602 static int reflog
= 0;
604 static int parse_reflog_param(const struct option
*opt
, const char *arg
,
608 const char **base
= (const char **)opt
->value
;
609 BUG_ON_OPT_NEG(unset
);
612 reflog
= strtoul(arg
, &ep
, 10);
616 return error("unrecognized reflog param '%s'", arg
);
620 reflog
= DEFAULT_REFLOG
;
624 int cmd_show_branch(int ac
, const char **av
, const char *prefix
)
626 struct commit
*rev
[MAX_REVS
], *commit
;
627 char *reflog_msg
[MAX_REVS
];
628 struct commit_list
*list
= NULL
, *seen
= NULL
;
629 unsigned int rev_mask
[MAX_REVS
];
630 int num_rev
, i
, extra
= 0;
631 int all_heads
= 0, all_remotes
= 0;
632 int all_mask
, all_revs
;
633 enum rev_sort_order sort_order
= REV_SORT_IN_GRAPH_ORDER
;
635 struct object_id head_oid
;
640 int shown_merge_point
= 0;
641 int with_current_branch
= 0;
645 const char *reflog_base
= NULL
;
646 struct option builtin_show_branch_options
[] = {
647 OPT_BOOL('a', "all", &all_heads
,
648 N_("show remote-tracking and local branches")),
649 OPT_BOOL('r', "remotes", &all_remotes
,
650 N_("show remote-tracking branches")),
651 OPT__COLOR(&showbranch_use_color
,
652 N_("color '*!+-' corresponding to the branch")),
653 { OPTION_INTEGER
, 0, "more", &extra
, N_("n"),
654 N_("show <n> more commits after the common ancestor"),
655 PARSE_OPT_OPTARG
, NULL
, (intptr_t)1 },
656 OPT_SET_INT(0, "list", &extra
, N_("synonym to more=-1"), -1),
657 OPT_BOOL(0, "no-name", &no_name
, N_("suppress naming strings")),
658 OPT_BOOL(0, "current", &with_current_branch
,
659 N_("include the current branch")),
660 OPT_BOOL(0, "sha1-name", &sha1_name
,
661 N_("name commits with their object names")),
662 OPT_BOOL(0, "merge-base", &merge_base
,
663 N_("show possible merge bases")),
664 OPT_BOOL(0, "independent", &independent
,
665 N_("show refs unreachable from any other ref")),
666 OPT_SET_INT(0, "topo-order", &sort_order
,
667 N_("show commits in topological order"),
668 REV_SORT_IN_GRAPH_ORDER
),
669 OPT_BOOL(0, "topics", &topics
,
670 N_("show only commits not on the first branch")),
671 OPT_SET_INT(0, "sparse", &dense
,
672 N_("show merges reachable from only one tip"), 0),
673 OPT_SET_INT(0, "date-order", &sort_order
,
674 N_("topologically sort, maintaining date order "
676 REV_SORT_BY_COMMIT_DATE
),
677 OPT_CALLBACK_F('g', "reflog", &reflog_base
, N_("<n>[,<base>]"),
678 N_("show <n> most recent ref-log entries starting at "
680 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
685 init_commit_name_slab(&name_slab
);
687 git_config(git_show_branch_config
, NULL
);
689 /* If nothing is specified, try the default first */
690 if (ac
== 1 && default_args
.nr
) {
691 ac
= default_args
.nr
;
695 ac
= parse_options(ac
, av
, prefix
, builtin_show_branch_options
,
696 show_branch_usage
, PARSE_OPT_STOP_AT_NON_OPTION
);
700 if (extra
|| reflog
) {
701 /* "listing" mode is incompatible with
702 * independent nor merge-base modes.
704 if (independent
|| merge_base
)
705 usage_with_options(show_branch_usage
,
706 builtin_show_branch_options
);
707 if (reflog
&& ((0 < extra
) || all_heads
|| all_remotes
))
709 * Asking for --more in reflog mode does not
710 * make sense. --list is Ok.
712 * Also --all and --remotes do not make sense either.
714 die(_("options '%s' and '%s' cannot be used together"), "--reflog",
715 "--all/--remotes/--independent/--merge-base");
718 if (with_current_branch
&& reflog
)
719 die(_("options '%s' and '%s' cannot be used together"),
720 "--reflog", "--current");
722 /* If nothing is specified, show all branches by default */
723 if (ac
<= topics
&& all_heads
+ all_remotes
== 0)
727 struct object_id oid
;
730 unsigned int flags
= 0;
733 static const char *fake_av
[2];
735 fake_av
[0] = resolve_refdup("HEAD",
736 RESOLVE_REF_READING
, &oid
,
742 die(_("no branches given, and HEAD is not valid"));
745 die(_("--reflog option needs one branch name"));
747 if (MAX_REVS
< reflog
)
748 die(Q_("only %d entry can be shown at one time.",
749 "only %d entries can be shown at one time.",
750 MAX_REVS
), MAX_REVS
);
751 if (!dwim_ref(*av
, strlen(*av
), &oid
, &ref
, 0))
752 die(_("no such ref %s"), *av
);
754 /* Has the base been specified? */
757 base
= strtoul(reflog_base
, &ep
, 10);
759 /* Ah, that is a date spec... */
761 at
= approxidate(reflog_base
);
762 read_ref_at(get_main_ref_store(the_repository
),
763 ref
, flags
, at
, -1, &oid
, NULL
,
768 for (i
= 0; i
< reflog
; i
++) {
773 timestamp_t timestamp
;
776 if (read_ref_at(get_main_ref_store(the_repository
),
777 ref
, flags
, 0, base
+ i
, &oid
, &logmsg
,
778 ×tamp
, &tz
, NULL
)) {
783 end
= strchr(logmsg
, '\n');
787 msg
= (*logmsg
== '\0') ? "(none)" : logmsg
;
788 reflog_msg
[i
] = xstrfmt("(%s) %s",
789 show_date(timestamp
, tz
,
790 DATE_MODE(RELATIVE
)),
794 nth_desc
= xstrfmt("%s@{%d}", *av
, base
+i
);
795 append_ref(nth_desc
, &oid
, 1);
805 if (all_heads
+ all_remotes
)
806 snarf_refs(all_heads
, all_remotes
);
809 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
,
812 if (with_current_branch
&& head
) {
814 for (i
= 0; !has_head
&& i
< ref_name_cnt
; i
++) {
815 /* We are only interested in adding the branch
818 if (rev_is_head(head
, ref_name
[i
]))
822 const char *name
= head
;
823 skip_prefix(name
, "refs/heads/", &name
);
824 append_one_rev(name
);
829 fprintf(stderr
, "No revs to be shown.\n");
833 for (num_rev
= 0; ref_name
[num_rev
]; num_rev
++) {
834 struct object_id revkey
;
835 unsigned int flag
= 1u << (num_rev
+ REV_SHIFT
);
837 if (MAX_REVS
<= num_rev
)
838 die(Q_("cannot handle more than %d rev.",
839 "cannot handle more than %d revs.",
840 MAX_REVS
), MAX_REVS
);
841 if (get_oid(ref_name
[num_rev
], &revkey
))
842 die(_("'%s' is not a valid ref."), ref_name
[num_rev
]);
843 commit
= lookup_commit_reference(the_repository
, &revkey
);
845 die(_("cannot find commit %s (%s)"),
846 ref_name
[num_rev
], oid_to_hex(&revkey
));
847 parse_commit(commit
);
848 mark_seen(commit
, &seen
);
850 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
851 * and so on. REV_SHIFT bits from bit 0 are used for
852 * internal bookkeeping.
854 commit
->object
.flags
|= flag
;
855 if (commit
->object
.flags
== flag
)
856 commit_list_insert_by_date(commit
, &list
);
857 rev
[num_rev
] = commit
;
859 for (i
= 0; i
< num_rev
; i
++)
860 rev_mask
[i
] = rev
[i
]->object
.flags
;
863 join_revs(&list
, &seen
, num_rev
, extra
);
865 commit_list_sort_by_date(&seen
);
868 return show_merge_base(seen
, num_rev
);
871 return show_independent(rev
, num_rev
, rev_mask
);
873 /* Show list; --more=-1 means list-only */
874 if (1 < num_rev
|| extra
< 0) {
875 for (i
= 0; i
< num_rev
; i
++) {
877 int is_head
= rev_is_head(head
, ref_name
[i
]) &&
878 oideq(&head_oid
, &rev
[i
]->object
.oid
);
881 is_head
? '*' : ' ', ref_name
[i
]);
883 for (j
= 0; j
< i
; j
++)
885 printf("%s%c%s [%s] ",
888 get_color_reset_code(), ref_name
[i
]);
892 /* header lines never need name */
893 show_one_commit(rev
[i
], 1);
902 for (i
= 0; i
< num_rev
; i
++)
910 /* Sort topologically */
911 sort_in_topological_order(&seen
, sort_order
);
913 /* Give names to commits */
914 if (!sha1_name
&& !no_name
)
915 name_commits(seen
, rev
, ref_name
, num_rev
);
917 all_mask
= ((1u << (REV_SHIFT
+ num_rev
)) - 1);
918 all_revs
= all_mask
& ~((1u << REV_SHIFT
) - 1);
921 struct commit
*commit
= pop_commit(&seen
);
922 int this_flag
= commit
->object
.flags
;
923 int is_merge_point
= ((this_flag
& all_revs
) == all_revs
);
925 shown_merge_point
|= is_merge_point
;
928 int is_merge
= !!(commit
->parents
&&
929 commit
->parents
->next
);
932 (this_flag
& (1u << REV_SHIFT
)))
934 if (dense
&& is_merge
&&
935 omit_in_dense(commit
, rev
, num_rev
))
937 for (i
= 0; i
< num_rev
; i
++) {
939 if (!(this_flag
& (1u << (i
+ REV_SHIFT
))))
943 else if (i
== head_at
)
952 mark
, get_color_reset_code());
956 show_one_commit(commit
, no_name
);
958 if (shown_merge_point
&& --extra
< 0)