7 #include "argv-array.h"
8 #include "parse-options.h"
11 static const char* show_branch_usage[] = {
12 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
13 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
14 " [--more=<n> | --list | --independent | --merge-base]\n"
15 " [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
16 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
20 static int showbranch_use_color = -1;
22 static struct argv_array default_args = ARGV_ARRAY_INIT;
24 #define UNINTERESTING 01
27 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
29 #define DEFAULT_REFLOG 4
31 static const char *get_color_code(int idx)
33 if (want_color(showbranch_use_color))
34 return column_colors_ansi[idx % column_colors_ansi_max];
38 static const char *get_color_reset_code(void)
40 if (want_color(showbranch_use_color))
41 return GIT_COLOR_RESET;
45 static struct commit *interesting(struct commit_list *list)
48 struct commit *commit = list->item;
50 if (commit->object.flags & UNINTERESTING)
58 const char *head_name; /* which head's ancestor? */
59 int generation; /* how many parents away from head_name */
62 /* Name the commit as nth generation ancestor of head_name;
63 * we count only the first-parent relationship for naming purposes.
65 static void name_commit(struct commit *commit, const char *head_name, int nth)
67 struct commit_name *name;
69 commit->util = xmalloc(sizeof(struct commit_name));
71 name->head_name = head_name;
72 name->generation = nth;
75 /* Parent is the first parent of the commit. We may name it
76 * as (n+1)th generation ancestor of the same head_name as
77 * commit is nth generation ancestor of, if that generation
78 * number is better than the name it already has.
80 static void name_parent(struct commit *commit, struct commit *parent)
82 struct commit_name *commit_name = commit->util;
83 struct commit_name *parent_name = parent->util;
87 commit_name->generation + 1 < parent_name->generation)
88 name_commit(parent, commit_name->head_name,
89 commit_name->generation + 1);
92 static int name_first_parent_chain(struct commit *c)
101 p = c->parents->item;
113 static void name_commits(struct commit_list *list,
118 struct commit_list *cl;
122 /* First give names to the given heads */
123 for (cl = list; cl; cl = cl->next) {
127 for (i = 0; i < num_rev; i++) {
129 name_commit(c, ref_name[i], 0);
135 /* Then commits on the first parent ancestry chain */
138 for (cl = list; cl; cl = cl->next) {
139 i += name_first_parent_chain(cl->item);
143 /* Finally, any unnamed commits */
146 for (cl = list; cl; cl = cl->next) {
147 struct commit_list *parents;
148 struct commit_name *n;
154 parents = c->parents;
157 struct commit *p = parents->item;
158 struct strbuf newname = STRBUF_INIT;
159 parents = parents->next;
163 switch (n->generation) {
165 strbuf_addstr(&newname, n->head_name);
168 strbuf_addf(&newname, "%s^", n->head_name);
171 strbuf_addf(&newname, "%s~%d",
172 n->head_name, n->generation);
176 strbuf_addch(&newname, '^');
178 strbuf_addf(&newname, "^%d", nth);
179 name_commit(p, strbuf_detach(&newname, NULL), 0);
181 name_first_parent_chain(p);
187 static int mark_seen(struct commit *commit, struct commit_list **seen_p)
189 if (!commit->object.flags) {
190 commit_list_insert(commit, seen_p);
196 static void join_revs(struct commit_list **list_p,
197 struct commit_list **seen_p,
198 int num_rev, int extra)
200 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
201 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
204 struct commit_list *parents;
205 int still_interesting = !!interesting(*list_p);
206 struct commit *commit = pop_commit(list_p);
207 int flags = commit->object.flags & all_mask;
209 if (!still_interesting && extra <= 0)
212 mark_seen(commit, seen_p);
213 if ((flags & all_revs) == all_revs)
214 flags |= UNINTERESTING;
215 parents = commit->parents;
218 struct commit *p = parents->item;
219 int this_flag = p->object.flags;
220 parents = parents->next;
221 if ((this_flag & flags) == flags)
224 if (mark_seen(p, seen_p) && !still_interesting)
226 p->object.flags |= flags;
227 commit_list_insert_by_date(p, list_p);
232 * Postprocess to complete well-poisoning.
234 * At this point we have all the commits we have seen in
235 * seen_p list. Mark anything that can be reached from
236 * uninteresting commits not interesting.
240 struct commit_list *s;
241 for (s = *seen_p; s; s = s->next) {
242 struct commit *c = s->item;
243 struct commit_list *parents;
245 if (((c->object.flags & all_revs) != all_revs) &&
246 !(c->object.flags & UNINTERESTING))
249 /* The current commit is either a merge base or
250 * already uninteresting one. Mark its parents
251 * as uninteresting commits _only_ if they are
252 * already parsed. No reason to find new ones
255 parents = c->parents;
257 struct commit *p = parents->item;
258 parents = parents->next;
259 if (!(p->object.flags & UNINTERESTING)) {
260 p->object.flags |= UNINTERESTING;
270 static void show_one_commit(struct commit *commit, int no_name)
272 struct strbuf pretty = STRBUF_INIT;
273 const char *pretty_str = "(unavailable)";
274 struct commit_name *name = commit->util;
276 if (commit->object.parsed) {
277 pp_commit_easy(CMIT_FMT_ONELINE, commit, &pretty);
278 pretty_str = pretty.buf;
280 skip_prefix(pretty_str, "[PATCH] ", &pretty_str);
283 if (name && name->head_name) {
284 printf("[%s", name->head_name);
285 if (name->generation) {
286 if (name->generation == 1)
289 printf("~%d", name->generation);
295 find_unique_abbrev(commit->object.oid.hash,
299 strbuf_release(&pretty);
302 static char *ref_name[MAX_REVS + 1];
303 static int ref_name_cnt;
305 static const char *find_digit_prefix(const char *s, int *v)
312 '0' <= (ch = *p) && ch <= '9';
314 ver = ver * 10 + ch - '0';
320 static int version_cmp(const char *a, const char *b)
325 a = find_digit_prefix(a, &va);
326 b = find_digit_prefix(b, &vb);
333 if ('0' <= ca && ca <= '9')
335 if ('0' <= cb && cb <= '9')
349 static int compare_ref_name(const void *a_, const void *b_)
351 const char * const*a = a_, * const*b = b_;
352 return version_cmp(*a, *b);
355 static void sort_ref_range(int bottom, int top)
357 QSORT(ref_name + bottom, top - bottom, compare_ref_name);
360 static int append_ref(const char *refname, const struct object_id *oid,
363 struct commit *commit = lookup_commit_reference_gently(oid, 1);
370 /* Avoid adding the same thing twice */
371 for (i = 0; i < ref_name_cnt; i++)
372 if (!strcmp(refname, ref_name[i]))
375 if (MAX_REVS <= ref_name_cnt) {
376 warning(Q_("ignoring %s; cannot handle more than %d ref",
377 "ignoring %s; cannot handle more than %d refs",
378 MAX_REVS), refname, MAX_REVS);
381 ref_name[ref_name_cnt++] = xstrdup(refname);
382 ref_name[ref_name_cnt] = NULL;
386 static int append_head_ref(const char *refname, const struct object_id *oid,
387 int flag, void *cb_data)
389 struct object_id tmp;
391 if (!starts_with(refname, "refs/heads/"))
393 /* If both heads/foo and tags/foo exists, get_sha1 would
396 if (get_oid(refname + ofs, &tmp) || oidcmp(&tmp, oid))
398 return append_ref(refname + ofs, oid, 0);
401 static int append_remote_ref(const char *refname, const struct object_id *oid,
402 int flag, void *cb_data)
404 struct object_id tmp;
406 if (!starts_with(refname, "refs/remotes/"))
408 /* If both heads/foo and tags/foo exists, get_sha1 would
411 if (get_oid(refname + ofs, &tmp) || oidcmp(&tmp, oid))
413 return append_ref(refname + ofs, oid, 0);
416 static int append_tag_ref(const char *refname, const struct object_id *oid,
417 int flag, void *cb_data)
419 if (!starts_with(refname, "refs/tags/"))
421 return append_ref(refname + 5, oid, 0);
424 static const char *match_ref_pattern = NULL;
425 static int match_ref_slash = 0;
427 static int append_matching_ref(const char *refname, const struct object_id *oid,
428 int flag, void *cb_data)
430 /* we want to allow pattern hold/<asterisk> to show all
431 * branches under refs/heads/hold/, and v0.99.9? to show
432 * refs/tags/v0.99.9a and friends.
435 int slash = count_slashes(refname);
436 for (tail = refname; *tail && match_ref_slash < slash; )
441 if (wildmatch(match_ref_pattern, tail, 0))
443 if (starts_with(refname, "refs/heads/"))
444 return append_head_ref(refname, oid, flag, cb_data);
445 if (starts_with(refname, "refs/tags/"))
446 return append_tag_ref(refname, oid, flag, cb_data);
447 return append_ref(refname, oid, 0);
450 static void snarf_refs(int head, int remotes)
453 int orig_cnt = ref_name_cnt;
455 for_each_ref(append_head_ref, NULL);
456 sort_ref_range(orig_cnt, ref_name_cnt);
459 int orig_cnt = ref_name_cnt;
461 for_each_ref(append_remote_ref, NULL);
462 sort_ref_range(orig_cnt, ref_name_cnt);
466 static int rev_is_head(const char *head, const char *name,
467 unsigned char *head_sha1, unsigned char *sha1)
469 if (!head || (head_sha1 && sha1 && hashcmp(head_sha1, sha1)))
471 skip_prefix(head, "refs/heads/", &head);
472 if (!skip_prefix(name, "refs/heads/", &name))
473 skip_prefix(name, "heads/", &name);
474 return !strcmp(head, name);
477 static int show_merge_base(struct commit_list *seen, int num_rev)
479 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
480 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
484 struct commit *commit = pop_commit(&seen);
485 int flags = commit->object.flags & all_mask;
486 if (!(flags & UNINTERESTING) &&
487 ((flags & all_revs) == all_revs)) {
488 puts(oid_to_hex(&commit->object.oid));
490 commit->object.flags |= UNINTERESTING;
496 static int show_independent(struct commit **rev,
499 unsigned int *rev_mask)
503 for (i = 0; i < num_rev; i++) {
504 struct commit *commit = rev[i];
505 unsigned int flag = rev_mask[i];
507 if (commit->object.flags == flag)
508 puts(oid_to_hex(&commit->object.oid));
509 commit->object.flags |= UNINTERESTING;
514 static void append_one_rev(const char *av)
516 struct object_id revkey;
517 if (!get_oid(av, &revkey)) {
518 append_ref(av, &revkey, 0);
521 if (strchr(av, '*') || strchr(av, '?') || strchr(av, '[')) {
522 /* glob style match */
523 int saved_matches = ref_name_cnt;
525 match_ref_pattern = av;
526 match_ref_slash = count_slashes(av);
527 for_each_ref(append_matching_ref, NULL);
528 if (saved_matches == ref_name_cnt &&
529 ref_name_cnt < MAX_REVS)
530 error(_("no matching refs with %s"), av);
531 sort_ref_range(saved_matches, ref_name_cnt);
534 die("bad sha1 reference %s", av);
537 static int git_show_branch_config(const char *var, const char *value, void *cb)
539 if (!strcmp(var, "showbranch.default")) {
541 return config_error_nonbool(var);
543 * default_arg is now passed to parse_options(), so we need to
544 * mimic the real argv a bit better.
546 if (!default_args.argc)
547 argv_array_push(&default_args, "show-branch");
548 argv_array_push(&default_args, value);
552 if (!strcmp(var, "color.showbranch")) {
553 showbranch_use_color = git_config_colorbool(var, value);
557 return git_color_default_config(var, value, cb);
560 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)
562 /* If the commit is tip of the named branches, do not
564 * Otherwise, if it is a merge that is reachable from only one
565 * tip, it is not that interesting.
568 for (i = 0; i < n; i++)
569 if (rev[i] == commit)
571 flag = commit->object.flags;
572 for (i = count = 0; i < n; i++) {
573 if (flag & (1u << (i + REV_SHIFT)))
581 static int reflog = 0;
583 static int parse_reflog_param(const struct option *opt, const char *arg,
587 const char **base = (const char **)opt->value;
590 reflog = strtoul(arg, &ep, 10);
594 return error("unrecognized reflog param '%s'", arg);
598 reflog = DEFAULT_REFLOG;
602 int cmd_show_branch(int ac, const char **av, const char *prefix)
604 struct commit *rev[MAX_REVS], *commit;
605 char *reflog_msg[MAX_REVS];
606 struct commit_list *list = NULL, *seen = NULL;
607 unsigned int rev_mask[MAX_REVS];
608 int num_rev, i, extra = 0;
609 int all_heads = 0, all_remotes = 0;
610 int all_mask, all_revs;
611 enum rev_sort_order sort_order = REV_SORT_IN_GRAPH_ORDER;
613 struct object_id head_oid;
618 int shown_merge_point = 0;
619 int with_current_branch = 0;
623 const char *reflog_base = NULL;
624 struct option builtin_show_branch_options[] = {
625 OPT_BOOL('a', "all", &all_heads,
626 N_("show remote-tracking and local branches")),
627 OPT_BOOL('r', "remotes", &all_remotes,
628 N_("show remote-tracking branches")),
629 OPT__COLOR(&showbranch_use_color,
630 N_("color '*!+-' corresponding to the branch")),
631 { OPTION_INTEGER, 0, "more", &extra, N_("n"),
632 N_("show <n> more commits after the common ancestor"),
633 PARSE_OPT_OPTARG, NULL, (intptr_t)1 },
634 OPT_SET_INT(0, "list", &extra, N_("synonym to more=-1"), -1),
635 OPT_BOOL(0, "no-name", &no_name, N_("suppress naming strings")),
636 OPT_BOOL(0, "current", &with_current_branch,
637 N_("include the current branch")),
638 OPT_BOOL(0, "sha1-name", &sha1_name,
639 N_("name commits with their object names")),
640 OPT_BOOL(0, "merge-base", &merge_base,
641 N_("show possible merge bases")),
642 OPT_BOOL(0, "independent", &independent,
643 N_("show refs unreachable from any other ref")),
644 OPT_SET_INT(0, "topo-order", &sort_order,
645 N_("show commits in topological order"),
646 REV_SORT_IN_GRAPH_ORDER),
647 OPT_BOOL(0, "topics", &topics,
648 N_("show only commits not on the first branch")),
649 OPT_SET_INT(0, "sparse", &dense,
650 N_("show merges reachable from only one tip"), 0),
651 OPT_SET_INT(0, "date-order", &sort_order,
652 N_("topologically sort, maintaining date order "
654 REV_SORT_BY_COMMIT_DATE),
655 { OPTION_CALLBACK, 'g', "reflog", &reflog_base, N_("<n>[,<base>]"),
656 N_("show <n> most recent ref-log entries starting at "
658 PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
659 parse_reflog_param },
663 git_config(git_show_branch_config, NULL);
665 /* If nothing is specified, try the default first */
666 if (ac == 1 && default_args.argc) {
667 ac = default_args.argc;
668 av = default_args.argv;
671 ac = parse_options(ac, av, prefix, builtin_show_branch_options,
672 show_branch_usage, PARSE_OPT_STOP_AT_NON_OPTION);
676 if (extra || reflog) {
677 /* "listing" mode is incompatible with
678 * independent nor merge-base modes.
680 if (independent || merge_base)
681 usage_with_options(show_branch_usage,
682 builtin_show_branch_options);
683 if (reflog && ((0 < extra) || all_heads || all_remotes))
685 * Asking for --more in reflog mode does not
686 * make sense. --list is Ok.
688 * Also --all and --remotes do not make sense either.
690 die(_("--reflog is incompatible with --all, --remotes, "
691 "--independent or --merge-base"));
694 /* If nothing is specified, show all branches by default */
695 if (ac <= topics && all_heads + all_remotes == 0)
699 struct object_id oid;
702 unsigned int flags = 0;
705 static const char *fake_av[2];
707 fake_av[0] = resolve_refdup("HEAD",
714 die(_("no branches given, and HEAD is not valid"));
717 die(_("--reflog option needs one branch name"));
719 if (MAX_REVS < reflog)
720 die(Q_("only %d entry can be shown at one time.",
721 "only %d entries can be shown at one time.",
722 MAX_REVS), MAX_REVS);
723 if (!dwim_ref(*av, strlen(*av), oid.hash, &ref))
724 die(_("no such ref %s"), *av);
726 /* Has the base been specified? */
729 base = strtoul(reflog_base, &ep, 10);
731 /* Ah, that is a date spec... */
733 at = approxidate(reflog_base);
734 read_ref_at(ref, flags, at, -1, oid.hash, NULL,
739 for (i = 0; i < reflog; i++) {
743 timestamp_t timestamp;
746 if (read_ref_at(ref, flags, 0, base+i, oid.hash, &logmsg,
747 ×tamp, &tz, NULL)) {
751 msg = strchr(logmsg, '\t');
756 reflog_msg[i] = xstrfmt("(%s) %s",
757 show_date(timestamp, tz,
758 DATE_MODE(RELATIVE)),
762 nth_desc = xstrfmt("%s@{%d}", *av, base+i);
763 append_ref(nth_desc, &oid, 1);
773 if (all_heads + all_remotes)
774 snarf_refs(all_heads, all_remotes);
777 head = resolve_refdup("HEAD", RESOLVE_REF_READING,
778 head_oid.hash, NULL);
780 if (with_current_branch && head) {
782 for (i = 0; !has_head && i < ref_name_cnt; i++) {
783 /* We are only interested in adding the branch
786 if (rev_is_head(head,
788 head_oid.hash, NULL))
792 const char *name = head;
793 skip_prefix(name, "refs/heads/", &name);
794 append_one_rev(name);
799 fprintf(stderr, "No revs to be shown.\n");
803 for (num_rev = 0; ref_name[num_rev]; num_rev++) {
804 struct object_id revkey;
805 unsigned int flag = 1u << (num_rev + REV_SHIFT);
807 if (MAX_REVS <= num_rev)
808 die(Q_("cannot handle more than %d rev.",
809 "cannot handle more than %d revs.",
810 MAX_REVS), MAX_REVS);
811 if (get_oid(ref_name[num_rev], &revkey))
812 die(_("'%s' is not a valid ref."), ref_name[num_rev]);
813 commit = lookup_commit_reference(&revkey);
815 die(_("cannot find commit %s (%s)"),
816 ref_name[num_rev], oid_to_hex(&revkey));
817 parse_commit(commit);
818 mark_seen(commit, &seen);
820 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
821 * and so on. REV_SHIFT bits from bit 0 are used for
822 * internal bookkeeping.
824 commit->object.flags |= flag;
825 if (commit->object.flags == flag)
826 commit_list_insert_by_date(commit, &list);
827 rev[num_rev] = commit;
829 for (i = 0; i < num_rev; i++)
830 rev_mask[i] = rev[i]->object.flags;
833 join_revs(&list, &seen, num_rev, extra);
835 commit_list_sort_by_date(&seen);
838 return show_merge_base(seen, num_rev);
841 return show_independent(rev, num_rev, ref_name, rev_mask);
843 /* Show list; --more=-1 means list-only */
844 if (1 < num_rev || extra < 0) {
845 for (i = 0; i < num_rev; i++) {
847 int is_head = rev_is_head(head,
850 rev[i]->object.oid.hash);
853 is_head ? '*' : ' ', ref_name[i]);
855 for (j = 0; j < i; j++)
857 printf("%s%c%s [%s] ",
860 get_color_reset_code(), ref_name[i]);
864 /* header lines never need name */
865 show_one_commit(rev[i], 1);
874 for (i = 0; i < num_rev; i++)
882 /* Sort topologically */
883 sort_in_topological_order(&seen, sort_order);
885 /* Give names to commits */
886 if (!sha1_name && !no_name)
887 name_commits(seen, rev, ref_name, num_rev);
889 all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
890 all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
893 struct commit *commit = pop_commit(&seen);
894 int this_flag = commit->object.flags;
895 int is_merge_point = ((this_flag & all_revs) == all_revs);
897 shown_merge_point |= is_merge_point;
900 int is_merge = !!(commit->parents &&
901 commit->parents->next);
904 (this_flag & (1u << REV_SHIFT)))
906 if (dense && is_merge &&
907 omit_in_dense(commit, rev, num_rev))
909 for (i = 0; i < num_rev; i++) {
911 if (!(this_flag & (1u << (i + REV_SHIFT))))
915 else if (i == head_at)
921 mark, get_color_reset_code());
925 show_one_commit(commit, no_name);
927 if (shown_merge_point && --extra < 0)