8 #include "parse-options.h"
10 #include "commit-slab.h"
12 static const char* show_branch_usage[] = {
13 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
14 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
15 " [--more=<n> | --list | --independent | --merge-base]\n"
16 " [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
17 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
21 static int showbranch_use_color = -1;
23 static struct strvec default_args = STRVEC_INIT;
26 * TODO: convert this use of commit->object.flags to commit-slab
27 * instead to store a pointer to ref name directly. Then use the same
28 * UNINTERESTING definition from revision.h here.
30 #define UNINTERESTING 01
33 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
35 #define DEFAULT_REFLOG 4
37 static const char *get_color_code(int idx)
39 if (want_color(showbranch_use_color))
40 return column_colors_ansi[idx % column_colors_ansi_max];
44 static const char *get_color_reset_code(void)
46 if (want_color(showbranch_use_color))
47 return GIT_COLOR_RESET;
51 static struct commit *interesting(struct commit_list *list)
54 struct commit *commit = list->item;
56 if (commit->object.flags & UNINTERESTING)
64 const char *head_name; /* which head's ancestor? */
65 int generation; /* how many parents away from head_name */
68 define_commit_slab(commit_name_slab, struct commit_name *);
69 static struct commit_name_slab name_slab;
71 static struct commit_name *commit_to_name(struct commit *commit)
73 return *commit_name_slab_at(&name_slab, commit);
77 /* Name the commit as nth generation ancestor of head_name;
78 * we count only the first-parent relationship for naming purposes.
80 static void name_commit(struct commit *commit, const char *head_name, int nth)
82 struct commit_name *name;
84 name = *commit_name_slab_at(&name_slab, commit);
86 name = xmalloc(sizeof(*name));
87 *commit_name_slab_at(&name_slab, commit) = name;
89 name->head_name = head_name;
90 name->generation = nth;
93 /* Parent is the first parent of the commit. We may name it
94 * as (n+1)th generation ancestor of the same head_name as
95 * commit is nth generation ancestor of, if that generation
96 * number is better than the name it already has.
98 static void name_parent(struct commit *commit, struct commit *parent)
100 struct commit_name *commit_name = commit_to_name(commit);
101 struct commit_name *parent_name = commit_to_name(parent);
105 commit_name->generation + 1 < parent_name->generation)
106 name_commit(parent, commit_name->head_name,
107 commit_name->generation + 1);
110 static int name_first_parent_chain(struct commit *c)
115 if (!commit_to_name(c))
119 p = c->parents->item;
120 if (!commit_to_name(p)) {
131 static void name_commits(struct commit_list *list,
136 struct commit_list *cl;
140 /* First give names to the given heads */
141 for (cl = list; cl; cl = cl->next) {
143 if (commit_to_name(c))
145 for (i = 0; i < num_rev; i++) {
147 name_commit(c, ref_name[i], 0);
153 /* Then commits on the first parent ancestry chain */
156 for (cl = list; cl; cl = cl->next) {
157 i += name_first_parent_chain(cl->item);
161 /* Finally, any unnamed commits */
164 for (cl = list; cl; cl = cl->next) {
165 struct commit_list *parents;
166 struct commit_name *n;
169 if (!commit_to_name(c))
171 n = commit_to_name(c);
172 parents = c->parents;
175 struct commit *p = parents->item;
176 struct strbuf newname = STRBUF_INIT;
177 parents = parents->next;
179 if (commit_to_name(p))
181 switch (n->generation) {
183 strbuf_addstr(&newname, n->head_name);
186 strbuf_addf(&newname, "%s^", n->head_name);
189 strbuf_addf(&newname, "%s~%d",
190 n->head_name, n->generation);
194 strbuf_addch(&newname, '^');
196 strbuf_addf(&newname, "^%d", nth);
197 name_commit(p, strbuf_detach(&newname, NULL), 0);
199 name_first_parent_chain(p);
205 static int mark_seen(struct commit *commit, struct commit_list **seen_p)
207 if (!commit->object.flags) {
208 commit_list_insert(commit, seen_p);
214 static void join_revs(struct commit_list **list_p,
215 struct commit_list **seen_p,
216 int num_rev, int extra)
218 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
219 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
222 struct commit_list *parents;
223 int still_interesting = !!interesting(*list_p);
224 struct commit *commit = pop_commit(list_p);
225 int flags = commit->object.flags & all_mask;
227 if (!still_interesting && extra <= 0)
230 mark_seen(commit, seen_p);
231 if ((flags & all_revs) == all_revs)
232 flags |= UNINTERESTING;
233 parents = commit->parents;
236 struct commit *p = parents->item;
237 int this_flag = p->object.flags;
238 parents = parents->next;
239 if ((this_flag & flags) == flags)
242 if (mark_seen(p, seen_p) && !still_interesting)
244 p->object.flags |= flags;
245 commit_list_insert_by_date(p, list_p);
250 * Postprocess to complete well-poisoning.
252 * At this point we have all the commits we have seen in
253 * seen_p list. Mark anything that can be reached from
254 * uninteresting commits not interesting.
258 struct commit_list *s;
259 for (s = *seen_p; s; s = s->next) {
260 struct commit *c = s->item;
261 struct commit_list *parents;
263 if (((c->object.flags & all_revs) != all_revs) &&
264 !(c->object.flags & UNINTERESTING))
267 /* The current commit is either a merge base or
268 * already uninteresting one. Mark its parents
269 * as uninteresting commits _only_ if they are
270 * already parsed. No reason to find new ones
273 parents = c->parents;
275 struct commit *p = parents->item;
276 parents = parents->next;
277 if (!(p->object.flags & UNINTERESTING)) {
278 p->object.flags |= UNINTERESTING;
288 static void show_one_commit(struct commit *commit, int no_name)
290 struct strbuf pretty = STRBUF_INIT;
291 const char *pretty_str = "(unavailable)";
292 struct commit_name *name = commit_to_name(commit);
294 if (commit->object.parsed) {
295 pp_commit_easy(CMIT_FMT_ONELINE, commit, &pretty);
296 pretty_str = pretty.buf;
298 skip_prefix(pretty_str, "[PATCH] ", &pretty_str);
301 if (name && name->head_name) {
302 printf("[%s", name->head_name);
303 if (name->generation) {
304 if (name->generation == 1)
307 printf("~%d", name->generation);
313 find_unique_abbrev(&commit->object.oid,
317 strbuf_release(&pretty);
320 static char *ref_name[MAX_REVS + 1];
321 static int ref_name_cnt;
323 static const char *find_digit_prefix(const char *s, int *v)
330 '0' <= (ch = *p) && ch <= '9';
332 ver = ver * 10 + ch - '0';
338 static int version_cmp(const char *a, const char *b)
343 a = find_digit_prefix(a, &va);
344 b = find_digit_prefix(b, &vb);
351 if ('0' <= ca && ca <= '9')
353 if ('0' <= cb && cb <= '9')
367 static int compare_ref_name(const void *a_, const void *b_)
369 const char * const*a = a_, * const*b = b_;
370 return version_cmp(*a, *b);
373 static void sort_ref_range(int bottom, int top)
375 QSORT(ref_name + bottom, top - bottom, compare_ref_name);
378 static int append_ref(const char *refname, const struct object_id *oid,
381 struct commit *commit = lookup_commit_reference_gently(the_repository,
389 /* Avoid adding the same thing twice */
390 for (i = 0; i < ref_name_cnt; i++)
391 if (!strcmp(refname, ref_name[i]))
394 if (MAX_REVS <= ref_name_cnt) {
395 warning(Q_("ignoring %s; cannot handle more than %d ref",
396 "ignoring %s; cannot handle more than %d refs",
397 MAX_REVS), refname, MAX_REVS);
400 ref_name[ref_name_cnt++] = xstrdup(refname);
401 ref_name[ref_name_cnt] = NULL;
405 static int append_head_ref(const char *refname, const struct object_id *oid,
406 int flag, void *cb_data)
408 struct object_id tmp;
410 if (!starts_with(refname, "refs/heads/"))
412 /* If both heads/foo and tags/foo exists, get_sha1 would
415 if (get_oid(refname + ofs, &tmp) || !oideq(&tmp, oid))
417 return append_ref(refname + ofs, oid, 0);
420 static int append_remote_ref(const char *refname, const struct object_id *oid,
421 int flag, void *cb_data)
423 struct object_id tmp;
425 if (!starts_with(refname, "refs/remotes/"))
427 /* If both heads/foo and tags/foo exists, get_sha1 would
430 if (get_oid(refname + ofs, &tmp) || !oideq(&tmp, oid))
432 return append_ref(refname + ofs, oid, 0);
435 static int append_tag_ref(const char *refname, const struct object_id *oid,
436 int flag, void *cb_data)
438 if (!starts_with(refname, "refs/tags/"))
440 return append_ref(refname + 5, oid, 0);
443 static const char *match_ref_pattern = NULL;
444 static int match_ref_slash = 0;
446 static int append_matching_ref(const char *refname, const struct object_id *oid,
447 int flag, void *cb_data)
449 /* we want to allow pattern hold/<asterisk> to show all
450 * branches under refs/heads/hold/, and v0.99.9? to show
451 * refs/tags/v0.99.9a and friends.
454 int slash = count_slashes(refname);
455 for (tail = refname; *tail && match_ref_slash < slash; )
460 if (wildmatch(match_ref_pattern, tail, 0))
462 if (starts_with(refname, "refs/heads/"))
463 return append_head_ref(refname, oid, flag, cb_data);
464 if (starts_with(refname, "refs/tags/"))
465 return append_tag_ref(refname, oid, flag, cb_data);
466 return append_ref(refname, oid, 0);
469 static void snarf_refs(int head, int remotes)
472 int orig_cnt = ref_name_cnt;
474 for_each_ref(append_head_ref, NULL);
475 sort_ref_range(orig_cnt, ref_name_cnt);
478 int orig_cnt = ref_name_cnt;
480 for_each_ref(append_remote_ref, NULL);
481 sort_ref_range(orig_cnt, ref_name_cnt);
485 static int rev_is_head(const char *head, const char *name,
486 unsigned char *head_sha1, unsigned char *sha1)
488 if (!head || (head_sha1 && sha1 && !hasheq(head_sha1, sha1)))
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(_("--reflog is incompatible with --all, --remotes, "
712 "--independent or --merge-base"));
715 /* If nothing is specified, show all branches by default */
716 if (ac <= topics && all_heads + all_remotes == 0)
720 struct object_id oid;
723 unsigned int flags = 0;
726 static const char *fake_av[2];
728 fake_av[0] = resolve_refdup("HEAD",
729 RESOLVE_REF_READING, &oid,
735 die(_("no branches given, and HEAD is not valid"));
738 die(_("--reflog option needs one branch name"));
740 if (MAX_REVS < reflog)
741 die(Q_("only %d entry can be shown at one time.",
742 "only %d entries can be shown at one time.",
743 MAX_REVS), MAX_REVS);
744 if (!dwim_ref(*av, strlen(*av), &oid, &ref))
745 die(_("no such ref %s"), *av);
747 /* Has the base been specified? */
750 base = strtoul(reflog_base, &ep, 10);
752 /* Ah, that is a date spec... */
754 at = approxidate(reflog_base);
755 read_ref_at(get_main_ref_store(the_repository),
756 ref, flags, at, -1, &oid, NULL,
761 for (i = 0; i < reflog; i++) {
765 timestamp_t timestamp;
768 if (read_ref_at(get_main_ref_store(the_repository),
769 ref, flags, 0, base + i, &oid, &logmsg,
770 ×tamp, &tz, NULL)) {
774 msg = strchr(logmsg, '\t');
779 reflog_msg[i] = xstrfmt("(%s) %s",
780 show_date(timestamp, tz,
781 DATE_MODE(RELATIVE)),
785 nth_desc = xstrfmt("%s@{%d}", *av, base+i);
786 append_ref(nth_desc, &oid, 1);
796 if (all_heads + all_remotes)
797 snarf_refs(all_heads, all_remotes);
800 head = resolve_refdup("HEAD", RESOLVE_REF_READING,
803 if (with_current_branch && head) {
805 for (i = 0; !has_head && i < ref_name_cnt; i++) {
806 /* We are only interested in adding the branch
809 if (rev_is_head(head,
811 head_oid.hash, NULL))
815 const char *name = head;
816 skip_prefix(name, "refs/heads/", &name);
817 append_one_rev(name);
822 fprintf(stderr, "No revs to be shown.\n");
826 for (num_rev = 0; ref_name[num_rev]; num_rev++) {
827 struct object_id revkey;
828 unsigned int flag = 1u << (num_rev + REV_SHIFT);
830 if (MAX_REVS <= num_rev)
831 die(Q_("cannot handle more than %d rev.",
832 "cannot handle more than %d revs.",
833 MAX_REVS), MAX_REVS);
834 if (get_oid(ref_name[num_rev], &revkey))
835 die(_("'%s' is not a valid ref."), ref_name[num_rev]);
836 commit = lookup_commit_reference(the_repository, &revkey);
838 die(_("cannot find commit %s (%s)"),
839 ref_name[num_rev], oid_to_hex(&revkey));
840 parse_commit(commit);
841 mark_seen(commit, &seen);
843 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
844 * and so on. REV_SHIFT bits from bit 0 are used for
845 * internal bookkeeping.
847 commit->object.flags |= flag;
848 if (commit->object.flags == flag)
849 commit_list_insert_by_date(commit, &list);
850 rev[num_rev] = commit;
852 for (i = 0; i < num_rev; i++)
853 rev_mask[i] = rev[i]->object.flags;
856 join_revs(&list, &seen, num_rev, extra);
858 commit_list_sort_by_date(&seen);
861 return show_merge_base(seen, num_rev);
864 return show_independent(rev, num_rev, rev_mask);
866 /* Show list; --more=-1 means list-only */
867 if (1 < num_rev || extra < 0) {
868 for (i = 0; i < num_rev; i++) {
870 int is_head = rev_is_head(head,
873 rev[i]->object.oid.hash);
876 is_head ? '*' : ' ', ref_name[i]);
878 for (j = 0; j < i; j++)
880 printf("%s%c%s [%s] ",
883 get_color_reset_code(), ref_name[i]);
887 /* header lines never need name */
888 show_one_commit(rev[i], 1);
897 for (i = 0; i < num_rev; i++)
905 /* Sort topologically */
906 sort_in_topological_order(&seen, sort_order);
908 /* Give names to commits */
909 if (!sha1_name && !no_name)
910 name_commits(seen, rev, ref_name, num_rev);
912 all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
913 all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
916 struct commit *commit = pop_commit(&seen);
917 int this_flag = commit->object.flags;
918 int is_merge_point = ((this_flag & all_revs) == all_revs);
920 shown_merge_point |= is_merge_point;
923 int is_merge = !!(commit->parents &&
924 commit->parents->next);
927 (this_flag & (1u << REV_SHIFT)))
929 if (dense && is_merge &&
930 omit_in_dense(commit, rev, num_rev))
932 for (i = 0; i < num_rev; i++) {
934 if (!(this_flag & (1u << (i + REV_SHIFT))))
938 else if (i == head_at)
944 mark, get_color_reset_code());
948 show_one_commit(commit, no_name);
950 if (shown_merge_point && --extra < 0)