6 #include "argv-array.h"
7 #include "parse-options.h"
9 static const char* show_branch_usage[] = {
10 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
11 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
12 " [--more=<n> | --list | --independent | --merge-base]\n"
13 " [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
14 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
18 static int showbranch_use_color = -1;
20 static struct argv_array default_args = ARGV_ARRAY_INIT;
22 #define UNINTERESTING 01
25 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
27 #define DEFAULT_REFLOG 4
29 static const char *get_color_code(int idx)
31 if (want_color(showbranch_use_color))
32 return column_colors_ansi[idx % column_colors_ansi_max];
36 static const char *get_color_reset_code(void)
38 if (want_color(showbranch_use_color))
39 return GIT_COLOR_RESET;
43 static struct commit *interesting(struct commit_list *list)
46 struct commit *commit = list->item;
48 if (commit->object.flags & UNINTERESTING)
56 const char *head_name; /* which head's ancestor? */
57 int generation; /* how many parents away from head_name */
60 /* Name the commit as nth generation ancestor of head_name;
61 * we count only the first-parent relationship for naming purposes.
63 static void name_commit(struct commit *commit, const char *head_name, int nth)
65 struct commit_name *name;
67 commit->util = xmalloc(sizeof(struct commit_name));
69 name->head_name = head_name;
70 name->generation = nth;
73 /* Parent is the first parent of the commit. We may name it
74 * as (n+1)th generation ancestor of the same head_name as
75 * commit is nth generation ancestor of, if that generation
76 * number is better than the name it already has.
78 static void name_parent(struct commit *commit, struct commit *parent)
80 struct commit_name *commit_name = commit->util;
81 struct commit_name *parent_name = parent->util;
85 commit_name->generation + 1 < parent_name->generation)
86 name_commit(parent, commit_name->head_name,
87 commit_name->generation + 1);
90 static int name_first_parent_chain(struct commit *c)
111 static void name_commits(struct commit_list *list,
116 struct commit_list *cl;
120 /* First give names to the given heads */
121 for (cl = list; cl; cl = cl->next) {
125 for (i = 0; i < num_rev; i++) {
127 name_commit(c, ref_name[i], 0);
133 /* Then commits on the first parent ancestry chain */
136 for (cl = list; cl; cl = cl->next) {
137 i += name_first_parent_chain(cl->item);
141 /* Finally, any unnamed commits */
144 for (cl = list; cl; cl = cl->next) {
145 struct commit_list *parents;
146 struct commit_name *n;
152 parents = c->parents;
155 struct commit *p = parents->item;
156 struct strbuf newname = STRBUF_INIT;
157 parents = parents->next;
161 switch (n->generation) {
163 strbuf_addstr(&newname, n->head_name);
166 strbuf_addf(&newname, "%s^", n->head_name);
169 strbuf_addf(&newname, "%s~%d",
170 n->head_name, n->generation);
174 strbuf_addch(&newname, '^');
176 strbuf_addf(&newname, "^%d", nth);
177 name_commit(p, strbuf_detach(&newname, NULL), 0);
179 name_first_parent_chain(p);
185 static int mark_seen(struct commit *commit, struct commit_list **seen_p)
187 if (!commit->object.flags) {
188 commit_list_insert(commit, seen_p);
194 static void join_revs(struct commit_list **list_p,
195 struct commit_list **seen_p,
196 int num_rev, int extra)
198 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
199 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
202 struct commit_list *parents;
203 int still_interesting = !!interesting(*list_p);
204 struct commit *commit = pop_commit(list_p);
205 int flags = commit->object.flags & all_mask;
207 if (!still_interesting && extra <= 0)
210 mark_seen(commit, seen_p);
211 if ((flags & all_revs) == all_revs)
212 flags |= UNINTERESTING;
213 parents = commit->parents;
216 struct commit *p = parents->item;
217 int this_flag = p->object.flags;
218 parents = parents->next;
219 if ((this_flag & flags) == flags)
222 if (mark_seen(p, seen_p) && !still_interesting)
224 p->object.flags |= flags;
225 commit_list_insert_by_date(p, list_p);
230 * Postprocess to complete well-poisoning.
232 * At this point we have all the commits we have seen in
233 * seen_p list. Mark anything that can be reached from
234 * uninteresting commits not interesting.
238 struct commit_list *s;
239 for (s = *seen_p; s; s = s->next) {
240 struct commit *c = s->item;
241 struct commit_list *parents;
243 if (((c->object.flags & all_revs) != all_revs) &&
244 !(c->object.flags & UNINTERESTING))
247 /* The current commit is either a merge base or
248 * already uninteresting one. Mark its parents
249 * as uninteresting commits _only_ if they are
250 * already parsed. No reason to find new ones
253 parents = c->parents;
255 struct commit *p = parents->item;
256 parents = parents->next;
257 if (!(p->object.flags & UNINTERESTING)) {
258 p->object.flags |= UNINTERESTING;
268 static void show_one_commit(struct commit *commit, int no_name)
270 struct strbuf pretty = STRBUF_INIT;
271 const char *pretty_str = "(unavailable)";
272 struct commit_name *name = commit->util;
274 if (commit->object.parsed) {
275 pp_commit_easy(CMIT_FMT_ONELINE, commit, &pretty);
276 pretty_str = pretty.buf;
278 if (starts_with(pretty_str, "[PATCH] "))
282 if (name && name->head_name) {
283 printf("[%s", name->head_name);
284 if (name->generation) {
285 if (name->generation == 1)
288 printf("~%d", name->generation);
294 find_unique_abbrev(commit->object.oid.hash,
298 strbuf_release(&pretty);
301 static char *ref_name[MAX_REVS + 1];
302 static int ref_name_cnt;
304 static const char *find_digit_prefix(const char *s, int *v)
311 '0' <= (ch = *p) && ch <= '9';
313 ver = ver * 10 + ch - '0';
319 static int version_cmp(const char *a, const char *b)
324 a = find_digit_prefix(a, &va);
325 b = find_digit_prefix(b, &vb);
332 if ('0' <= ca && ca <= '9')
334 if ('0' <= cb && cb <= '9')
348 static int compare_ref_name(const void *a_, const void *b_)
350 const char * const*a = a_, * const*b = b_;
351 return version_cmp(*a, *b);
354 static void sort_ref_range(int bottom, int top)
356 qsort(ref_name + bottom, top - bottom, sizeof(ref_name[0]),
360 static int append_ref(const char *refname, const struct object_id *oid,
363 struct commit *commit = lookup_commit_reference_gently(oid->hash, 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("ignoring %s; cannot handle more than %d refs",
380 ref_name[ref_name_cnt++] = xstrdup(refname);
381 ref_name[ref_name_cnt] = NULL;
385 static int append_head_ref(const char *refname, const struct object_id *oid,
386 int flag, void *cb_data)
388 struct object_id tmp;
390 if (!starts_with(refname, "refs/heads/"))
392 /* If both heads/foo and tags/foo exists, get_sha1 would
395 if (get_sha1(refname + ofs, tmp.hash) || oidcmp(&tmp, oid))
397 return append_ref(refname + ofs, oid, 0);
400 static int append_remote_ref(const char *refname, const struct object_id *oid,
401 int flag, void *cb_data)
403 struct object_id tmp;
405 if (!starts_with(refname, "refs/remotes/"))
407 /* If both heads/foo and tags/foo exists, get_sha1 would
410 if (get_sha1(refname + ofs, tmp.hash) || oidcmp(&tmp, oid))
412 return append_ref(refname + ofs, oid, 0);
415 static int append_tag_ref(const char *refname, const struct object_id *oid,
416 int flag, void *cb_data)
418 if (!starts_with(refname, "refs/tags/"))
420 return append_ref(refname + 5, oid, 0);
423 static const char *match_ref_pattern = NULL;
424 static int match_ref_slash = 0;
425 static int count_slash(const char *s)
434 static int append_matching_ref(const char *refname, const struct object_id *oid,
435 int flag, void *cb_data)
437 /* we want to allow pattern hold/<asterisk> to show all
438 * branches under refs/heads/hold/, and v0.99.9? to show
439 * refs/tags/v0.99.9a and friends.
442 int slash = count_slash(refname);
443 for (tail = refname; *tail && match_ref_slash < slash; )
448 if (wildmatch(match_ref_pattern, tail, 0, NULL))
450 if (starts_with(refname, "refs/heads/"))
451 return append_head_ref(refname, oid, flag, cb_data);
452 if (starts_with(refname, "refs/tags/"))
453 return append_tag_ref(refname, oid, flag, cb_data);
454 return append_ref(refname, oid, 0);
457 static void snarf_refs(int head, int remotes)
460 int orig_cnt = ref_name_cnt;
462 for_each_ref(append_head_ref, NULL);
463 sort_ref_range(orig_cnt, ref_name_cnt);
466 int orig_cnt = ref_name_cnt;
468 for_each_ref(append_remote_ref, NULL);
469 sort_ref_range(orig_cnt, ref_name_cnt);
473 static int rev_is_head(char *head, char *name,
474 unsigned char *head_sha1, unsigned char *sha1)
476 if (!head || (head_sha1 && sha1 && hashcmp(head_sha1, sha1)))
478 if (starts_with(head, "refs/heads/"))
480 if (starts_with(name, "refs/heads/"))
482 else if (starts_with(name, "heads/"))
484 return !strcmp(head, name);
487 static int show_merge_base(struct commit_list *seen, int num_rev)
489 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
490 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
494 struct commit *commit = pop_commit(&seen);
495 int flags = commit->object.flags & all_mask;
496 if (!(flags & UNINTERESTING) &&
497 ((flags & all_revs) == all_revs)) {
498 puts(oid_to_hex(&commit->object.oid));
500 commit->object.flags |= UNINTERESTING;
506 static int show_independent(struct commit **rev,
509 unsigned int *rev_mask)
513 for (i = 0; i < num_rev; i++) {
514 struct commit *commit = rev[i];
515 unsigned int flag = rev_mask[i];
517 if (commit->object.flags == flag)
518 puts(oid_to_hex(&commit->object.oid));
519 commit->object.flags |= UNINTERESTING;
524 static void append_one_rev(const char *av)
526 struct object_id revkey;
527 if (!get_sha1(av, revkey.hash)) {
528 append_ref(av, &revkey, 0);
531 if (strchr(av, '*') || strchr(av, '?') || strchr(av, '[')) {
532 /* glob style match */
533 int saved_matches = ref_name_cnt;
535 match_ref_pattern = av;
536 match_ref_slash = count_slash(av);
537 for_each_ref(append_matching_ref, NULL);
538 if (saved_matches == ref_name_cnt &&
539 ref_name_cnt < MAX_REVS)
540 error("no matching refs with %s", av);
541 if (saved_matches + 1 < ref_name_cnt)
542 sort_ref_range(saved_matches, ref_name_cnt);
545 die("bad sha1 reference %s", av);
548 static int git_show_branch_config(const char *var, const char *value, void *cb)
550 if (!strcmp(var, "showbranch.default")) {
552 return config_error_nonbool(var);
554 * default_arg is now passed to parse_options(), so we need to
555 * mimic the real argv a bit better.
557 if (!default_args.argc)
558 argv_array_push(&default_args, "show-branch");
559 argv_array_push(&default_args, value);
563 if (!strcmp(var, "color.showbranch")) {
564 showbranch_use_color = git_config_colorbool(var, value);
568 return git_color_default_config(var, value, cb);
571 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)
573 /* If the commit is tip of the named branches, do not
575 * Otherwise, if it is a merge that is reachable from only one
576 * tip, it is not that interesting.
579 for (i = 0; i < n; i++)
580 if (rev[i] == commit)
582 flag = commit->object.flags;
583 for (i = count = 0; i < n; i++) {
584 if (flag & (1u << (i + REV_SHIFT)))
592 static int reflog = 0;
594 static int parse_reflog_param(const struct option *opt, const char *arg,
598 const char **base = (const char **)opt->value;
601 reflog = strtoul(arg, &ep, 10);
605 return error("unrecognized reflog param '%s'", arg);
609 reflog = DEFAULT_REFLOG;
613 int cmd_show_branch(int ac, const char **av, const char *prefix)
615 struct commit *rev[MAX_REVS], *commit;
616 char *reflog_msg[MAX_REVS];
617 struct commit_list *list = NULL, *seen = NULL;
618 unsigned int rev_mask[MAX_REVS];
619 int num_rev, i, extra = 0;
620 int all_heads = 0, all_remotes = 0;
621 int all_mask, all_revs;
622 enum rev_sort_order sort_order = REV_SORT_IN_GRAPH_ORDER;
624 struct object_id head_oid;
629 int shown_merge_point = 0;
630 int with_current_branch = 0;
634 const char *reflog_base = NULL;
635 struct option builtin_show_branch_options[] = {
636 OPT_BOOL('a', "all", &all_heads,
637 N_("show remote-tracking and local branches")),
638 OPT_BOOL('r', "remotes", &all_remotes,
639 N_("show remote-tracking branches")),
640 OPT__COLOR(&showbranch_use_color,
641 N_("color '*!+-' corresponding to the branch")),
642 { OPTION_INTEGER, 0, "more", &extra, N_("n"),
643 N_("show <n> more commits after the common ancestor"),
644 PARSE_OPT_OPTARG, NULL, (intptr_t)1 },
645 OPT_SET_INT(0, "list", &extra, N_("synonym to more=-1"), -1),
646 OPT_BOOL(0, "no-name", &no_name, N_("suppress naming strings")),
647 OPT_BOOL(0, "current", &with_current_branch,
648 N_("include the current branch")),
649 OPT_BOOL(0, "sha1-name", &sha1_name,
650 N_("name commits with their object names")),
651 OPT_BOOL(0, "merge-base", &merge_base,
652 N_("show possible merge bases")),
653 OPT_BOOL(0, "independent", &independent,
654 N_("show refs unreachable from any other ref")),
655 OPT_SET_INT(0, "topo-order", &sort_order,
656 N_("show commits in topological order"),
657 REV_SORT_IN_GRAPH_ORDER),
658 OPT_BOOL(0, "topics", &topics,
659 N_("show only commits not on the first branch")),
660 OPT_SET_INT(0, "sparse", &dense,
661 N_("show merges reachable from only one tip"), 0),
662 OPT_SET_INT(0, "date-order", &sort_order,
663 N_("topologically sort, maintaining date order "
665 REV_SORT_BY_COMMIT_DATE),
666 { OPTION_CALLBACK, 'g', "reflog", &reflog_base, N_("<n>[,<base>]"),
667 N_("show <n> most recent ref-log entries starting at "
669 PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
670 parse_reflog_param },
674 git_config(git_show_branch_config, NULL);
676 /* If nothing is specified, try the default first */
677 if (ac == 1 && default_args.argc) {
678 ac = default_args.argc;
679 av = default_args.argv;
682 ac = parse_options(ac, av, prefix, builtin_show_branch_options,
683 show_branch_usage, PARSE_OPT_STOP_AT_NON_OPTION);
687 if (extra || reflog) {
688 /* "listing" mode is incompatible with
689 * independent nor merge-base modes.
691 if (independent || merge_base)
692 usage_with_options(show_branch_usage,
693 builtin_show_branch_options);
694 if (reflog && ((0 < extra) || all_heads || all_remotes))
696 * Asking for --more in reflog mode does not
697 * make sense. --list is Ok.
699 * Also --all and --remotes do not make sense either.
701 die("--reflog is incompatible with --all, --remotes, "
702 "--independent or --merge-base");
705 /* If nothing is specified, show all branches by default */
706 if (ac <= topics && all_heads + all_remotes == 0)
710 struct object_id oid;
713 unsigned int flags = 0;
716 static const char *fake_av[2];
718 fake_av[0] = resolve_refdup("HEAD",
725 die("no branches given, and HEAD is not valid");
728 die("--reflog option needs one branch name");
730 if (MAX_REVS < reflog)
731 die("Only %d entries can be shown at one time.",
733 if (!dwim_ref(*av, strlen(*av), oid.hash, &ref))
734 die("No such ref %s", *av);
736 /* Has the base been specified? */
739 base = strtoul(reflog_base, &ep, 10);
741 /* Ah, that is a date spec... */
743 at = approxidate(reflog_base);
744 read_ref_at(ref, flags, at, -1, oid.hash, NULL,
749 for (i = 0; i < reflog; i++) {
753 unsigned long timestamp;
756 if (read_ref_at(ref, flags, 0, base+i, oid.hash, &logmsg,
757 ×tamp, &tz, NULL)) {
761 msg = strchr(logmsg, '\t');
766 reflog_msg[i] = xstrfmt("(%s) %s",
767 show_date(timestamp, tz,
768 DATE_MODE(RELATIVE)),
772 nth_desc = xstrfmt("%s@{%d}", *av, base+i);
773 append_ref(nth_desc, &oid, 1);
783 if (all_heads + all_remotes)
784 snarf_refs(all_heads, all_remotes);
787 head = resolve_refdup("HEAD", RESOLVE_REF_READING,
788 head_oid.hash, NULL);
790 if (with_current_branch && head) {
792 for (i = 0; !has_head && i < ref_name_cnt; i++) {
793 /* We are only interested in adding the branch
796 if (rev_is_head(head,
798 head_oid.hash, NULL))
802 int offset = starts_with(head, "refs/heads/") ? 11 : 0;
803 append_one_rev(head + offset);
808 fprintf(stderr, "No revs to be shown.\n");
812 for (num_rev = 0; ref_name[num_rev]; num_rev++) {
813 struct object_id revkey;
814 unsigned int flag = 1u << (num_rev + REV_SHIFT);
816 if (MAX_REVS <= num_rev)
817 die("cannot handle more than %d revs.", MAX_REVS);
818 if (get_sha1(ref_name[num_rev], revkey.hash))
819 die("'%s' is not a valid ref.", ref_name[num_rev]);
820 commit = lookup_commit_reference(revkey.hash);
822 die("cannot find commit %s (%s)",
823 ref_name[num_rev], oid_to_hex(&revkey));
824 parse_commit(commit);
825 mark_seen(commit, &seen);
827 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
828 * and so on. REV_SHIFT bits from bit 0 are used for
829 * internal bookkeeping.
831 commit->object.flags |= flag;
832 if (commit->object.flags == flag)
833 commit_list_insert_by_date(commit, &list);
834 rev[num_rev] = commit;
836 for (i = 0; i < num_rev; i++)
837 rev_mask[i] = rev[i]->object.flags;
840 join_revs(&list, &seen, num_rev, extra);
842 commit_list_sort_by_date(&seen);
845 return show_merge_base(seen, num_rev);
848 return show_independent(rev, num_rev, ref_name, rev_mask);
850 /* Show list; --more=-1 means list-only */
851 if (1 < num_rev || extra < 0) {
852 for (i = 0; i < num_rev; i++) {
854 int is_head = rev_is_head(head,
857 rev[i]->object.oid.hash);
860 is_head ? '*' : ' ', ref_name[i]);
862 for (j = 0; j < i; j++)
864 printf("%s%c%s [%s] ",
867 get_color_reset_code(), ref_name[i]);
871 /* header lines never need name */
872 show_one_commit(rev[i], 1);
881 for (i = 0; i < num_rev; i++)
889 /* Sort topologically */
890 sort_in_topological_order(&seen, sort_order);
892 /* Give names to commits */
893 if (!sha1_name && !no_name)
894 name_commits(seen, rev, ref_name, num_rev);
896 all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
897 all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
900 struct commit *commit = pop_commit(&seen);
901 int this_flag = commit->object.flags;
902 int is_merge_point = ((this_flag & all_revs) == all_revs);
904 shown_merge_point |= is_merge_point;
907 int is_merge = !!(commit->parents &&
908 commit->parents->next);
911 (this_flag & (1u << REV_SHIFT)))
913 if (dense && is_merge &&
914 omit_in_dense(commit, rev, num_rev))
916 for (i = 0; i < num_rev; i++) {
918 if (!(this_flag & (1u << (i + REV_SHIFT))))
922 else if (i == head_at)
928 mark, get_color_reset_code());
932 show_one_commit(commit, no_name);
934 if (shown_merge_point && --extra < 0)