6 #include "parse-options.h"
8 static const char* show_branch_usage[] = {
9 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
10 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
11 " [--more=<n> | --list | --independent | --merge-base]\n"
12 " [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
13 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
17 static int showbranch_use_color = -1;
19 static int default_num;
20 static int default_alloc;
21 static const char **default_arg;
23 #define UNINTERESTING 01
26 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
28 #define DEFAULT_REFLOG 4
30 static const char *get_color_code(int idx)
32 if (want_color(showbranch_use_color))
33 return column_colors_ansi[idx % column_colors_ansi_max];
37 static const char *get_color_reset_code(void)
39 if (want_color(showbranch_use_color))
40 return GIT_COLOR_RESET;
44 static struct commit *interesting(struct commit_list *list)
47 struct commit *commit = list->item;
49 if (commit->object.flags & UNINTERESTING)
57 const char *head_name; /* which head's ancestor? */
58 int generation; /* how many parents away from head_name */
61 /* Name the commit as nth generation ancestor of head_name;
62 * we count only the first-parent relationship for naming purposes.
64 static void name_commit(struct commit *commit, const char *head_name, int nth)
66 struct commit_name *name;
68 commit->util = xmalloc(sizeof(struct commit_name));
70 name->head_name = head_name;
71 name->generation = nth;
74 /* Parent is the first parent of the commit. We may name it
75 * as (n+1)th generation ancestor of the same head_name as
76 * commit is nth generation ancestor of, if that generation
77 * number is better than the name it already has.
79 static void name_parent(struct commit *commit, struct commit *parent)
81 struct commit_name *commit_name = commit->util;
82 struct commit_name *parent_name = parent->util;
86 commit_name->generation + 1 < parent_name->generation)
87 name_commit(parent, commit_name->head_name,
88 commit_name->generation + 1);
91 static int name_first_parent_chain(struct commit *c)
100 p = c->parents->item;
112 static void name_commits(struct commit_list *list,
117 struct commit_list *cl;
121 /* First give names to the given heads */
122 for (cl = list; cl; cl = cl->next) {
126 for (i = 0; i < num_rev; i++) {
128 name_commit(c, ref_name[i], 0);
134 /* Then commits on the first parent ancestry chain */
137 for (cl = list; cl; cl = cl->next) {
138 i += name_first_parent_chain(cl->item);
142 /* Finally, any unnamed commits */
145 for (cl = list; cl; cl = cl->next) {
146 struct commit_list *parents;
147 struct commit_name *n;
153 parents = c->parents;
156 struct commit *p = parents->item;
157 struct strbuf newname = STRBUF_INIT;
158 parents = parents->next;
162 switch (n->generation) {
164 strbuf_addstr(&newname, n->head_name);
167 strbuf_addf(&newname, "%s^", n->head_name);
170 strbuf_addf(&newname, "%s~%d",
171 n->head_name, n->generation);
175 strbuf_addch(&newname, '^');
177 strbuf_addf(&newname, "^%d", nth);
178 name_commit(p, strbuf_detach(&newname, NULL), 0);
180 name_first_parent_chain(p);
186 static int mark_seen(struct commit *commit, struct commit_list **seen_p)
188 if (!commit->object.flags) {
189 commit_list_insert(commit, seen_p);
195 static void join_revs(struct commit_list **list_p,
196 struct commit_list **seen_p,
197 int num_rev, int extra)
199 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
200 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
203 struct commit_list *parents;
204 int still_interesting = !!interesting(*list_p);
205 struct commit *commit = pop_commit(list_p);
206 int flags = commit->object.flags & all_mask;
208 if (!still_interesting && extra <= 0)
211 mark_seen(commit, seen_p);
212 if ((flags & all_revs) == all_revs)
213 flags |= UNINTERESTING;
214 parents = commit->parents;
217 struct commit *p = parents->item;
218 int this_flag = p->object.flags;
219 parents = parents->next;
220 if ((this_flag & flags) == flags)
223 if (mark_seen(p, seen_p) && !still_interesting)
225 p->object.flags |= flags;
226 commit_list_insert_by_date(p, list_p);
231 * Postprocess to complete well-poisoning.
233 * At this point we have all the commits we have seen in
234 * seen_p list. Mark anything that can be reached from
235 * uninteresting commits not interesting.
239 struct commit_list *s;
240 for (s = *seen_p; s; s = s->next) {
241 struct commit *c = s->item;
242 struct commit_list *parents;
244 if (((c->object.flags & all_revs) != all_revs) &&
245 !(c->object.flags & UNINTERESTING))
248 /* The current commit is either a merge base or
249 * already uninteresting one. Mark its parents
250 * as uninteresting commits _only_ if they are
251 * already parsed. No reason to find new ones
254 parents = c->parents;
256 struct commit *p = parents->item;
257 parents = parents->next;
258 if (!(p->object.flags & UNINTERESTING)) {
259 p->object.flags |= UNINTERESTING;
269 static void show_one_commit(struct commit *commit, int no_name)
271 struct strbuf pretty = STRBUF_INIT;
272 const char *pretty_str = "(unavailable)";
273 struct commit_name *name = commit->util;
275 if (commit->object.parsed) {
276 pp_commit_easy(CMIT_FMT_ONELINE, commit, &pretty);
277 pretty_str = pretty.buf;
279 if (starts_with(pretty_str, "[PATCH] "))
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.sha1,
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, sizeof(ref_name[0]),
361 static int append_ref(const char *refname, const struct object_id *oid,
364 struct commit *commit = lookup_commit_reference_gently(oid->hash, 1);
371 /* Avoid adding the same thing twice */
372 for (i = 0; i < ref_name_cnt; i++)
373 if (!strcmp(refname, ref_name[i]))
376 if (MAX_REVS <= ref_name_cnt) {
377 warning("ignoring %s; cannot handle more than %d refs",
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_sha1(refname + ofs, tmp.hash) || 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_sha1(refname + ofs, tmp.hash) || 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;
426 static int count_slash(const char *s)
435 static int append_matching_ref(const char *refname, const struct object_id *oid,
436 int flag, void *cb_data)
438 /* we want to allow pattern hold/<asterisk> to show all
439 * branches under refs/heads/hold/, and v0.99.9? to show
440 * refs/tags/v0.99.9a and friends.
443 int slash = count_slash(refname);
444 for (tail = refname; *tail && match_ref_slash < slash; )
449 if (wildmatch(match_ref_pattern, tail, 0, NULL))
451 if (starts_with(refname, "refs/heads/"))
452 return append_head_ref(refname, oid, flag, cb_data);
453 if (starts_with(refname, "refs/tags/"))
454 return append_tag_ref(refname, oid, flag, cb_data);
455 return append_ref(refname, oid, 0);
458 static void snarf_refs(int head, int remotes)
461 int orig_cnt = ref_name_cnt;
463 for_each_ref(append_head_ref, NULL);
464 sort_ref_range(orig_cnt, ref_name_cnt);
467 int orig_cnt = ref_name_cnt;
469 for_each_ref(append_remote_ref, NULL);
470 sort_ref_range(orig_cnt, ref_name_cnt);
474 static int rev_is_head(char *head, int headlen, char *name,
475 unsigned char *head_sha1, unsigned char *sha1)
478 (head_sha1 && sha1 && hashcmp(head_sha1, sha1)))
480 if (starts_with(head, "refs/heads/"))
482 if (starts_with(name, "refs/heads/"))
484 else if (starts_with(name, "heads/"))
486 return !strcmp(head, name);
489 static int show_merge_base(struct commit_list *seen, int num_rev)
491 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
492 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
496 struct commit *commit = pop_commit(&seen);
497 int flags = commit->object.flags & all_mask;
498 if (!(flags & UNINTERESTING) &&
499 ((flags & all_revs) == all_revs)) {
500 puts(sha1_to_hex(commit->object.sha1));
502 commit->object.flags |= UNINTERESTING;
508 static int show_independent(struct commit **rev,
511 unsigned int *rev_mask)
515 for (i = 0; i < num_rev; i++) {
516 struct commit *commit = rev[i];
517 unsigned int flag = rev_mask[i];
519 if (commit->object.flags == flag)
520 puts(sha1_to_hex(commit->object.sha1));
521 commit->object.flags |= UNINTERESTING;
526 static void append_one_rev(const char *av)
528 struct object_id revkey;
529 if (!get_sha1(av, revkey.hash)) {
530 append_ref(av, &revkey, 0);
533 if (strchr(av, '*') || strchr(av, '?') || strchr(av, '[')) {
534 /* glob style match */
535 int saved_matches = ref_name_cnt;
537 match_ref_pattern = av;
538 match_ref_slash = count_slash(av);
539 for_each_ref(append_matching_ref, NULL);
540 if (saved_matches == ref_name_cnt &&
541 ref_name_cnt < MAX_REVS)
542 error("no matching refs with %s", av);
543 if (saved_matches + 1 < ref_name_cnt)
544 sort_ref_range(saved_matches, ref_name_cnt);
547 die("bad sha1 reference %s", av);
550 static int git_show_branch_config(const char *var, const char *value, void *cb)
552 if (!strcmp(var, "showbranch.default")) {
554 return config_error_nonbool(var);
556 * default_arg is now passed to parse_options(), so we need to
557 * mimic the real argv a bit better.
561 default_arg = xcalloc(default_alloc, sizeof(*default_arg));
562 default_arg[default_num++] = "show-branch";
563 } else if (default_alloc <= default_num + 1) {
564 default_alloc = default_alloc * 3 / 2 + 20;
565 REALLOC_ARRAY(default_arg, default_alloc);
567 default_arg[default_num++] = xstrdup(value);
568 default_arg[default_num] = NULL;
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;
610 reflog = strtoul(arg, &ep, 10);
614 return error("unrecognized reflog param '%s'", arg);
618 reflog = DEFAULT_REFLOG;
622 int cmd_show_branch(int ac, const char **av, const char *prefix)
624 struct commit *rev[MAX_REVS], *commit;
625 char *reflog_msg[MAX_REVS];
626 struct commit_list *list = NULL, *seen = NULL;
627 unsigned int rev_mask[MAX_REVS];
628 int num_rev, i, extra = 0;
629 int all_heads = 0, all_remotes = 0;
630 int all_mask, all_revs;
631 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 { OPTION_CALLBACK, 'g', "reflog", &reflog_base, N_("<n>[,<base>]"),
678 N_("show <n> most recent ref-log entries starting at "
680 PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
681 parse_reflog_param },
685 git_config(git_show_branch_config, NULL);
687 /* If nothing is specified, try the default first */
688 if (ac == 1 && default_num) {
693 ac = parse_options(ac, av, prefix, builtin_show_branch_options,
694 show_branch_usage, PARSE_OPT_STOP_AT_NON_OPTION);
698 if (extra || reflog) {
699 /* "listing" mode is incompatible with
700 * independent nor merge-base modes.
702 if (independent || merge_base)
703 usage_with_options(show_branch_usage,
704 builtin_show_branch_options);
705 if (reflog && ((0 < extra) || all_heads || all_remotes))
707 * Asking for --more in reflog mode does not
708 * make sense. --list is Ok.
710 * Also --all and --remotes do not make sense either.
712 die("--reflog is incompatible with --all, --remotes, "
713 "--independent or --merge-base");
716 /* If nothing is specified, show all branches by default */
717 if (ac <= topics && all_heads + all_remotes == 0)
721 struct object_id oid;
724 unsigned int flags = 0;
727 static const char *fake_av[2];
729 fake_av[0] = resolve_refdup("HEAD",
736 die("no branches given, and HEAD is not valid");
739 die("--reflog option needs one branch name");
741 if (MAX_REVS < reflog)
742 die("Only %d entries can be shown at one time.",
744 if (!dwim_ref(*av, strlen(*av), oid.hash, &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(ref, flags, at, -1, oid.hash, NULL,
760 for (i = 0; i < reflog; i++) {
764 unsigned long timestamp;
767 if (read_ref_at(ref, flags, 0, base+i, oid.hash, &logmsg,
768 ×tamp, &tz, NULL)) {
772 msg = strchr(logmsg, '\t');
777 reflog_msg[i] = xstrfmt("(%s) %s",
778 show_date(timestamp, tz,
779 DATE_MODE(RELATIVE)),
783 nth_desc = xstrfmt("%s@{%d}", *av, base+i);
784 append_ref(nth_desc, &oid, 1);
794 if (all_heads + all_remotes)
795 snarf_refs(all_heads, all_remotes);
798 head_p = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
799 head_oid.hash, NULL);
801 head_len = strlen(head_p);
802 memcpy(head, head_p, head_len + 1);
809 if (with_current_branch && head_p) {
811 for (i = 0; !has_head && i < ref_name_cnt; i++) {
812 /* We are only interested in adding the branch
815 if (rev_is_head(head,
818 head_oid.hash, NULL))
822 int offset = starts_with(head, "refs/heads/") ? 11 : 0;
823 append_one_rev(head + offset);
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("cannot handle more than %d revs.", MAX_REVS);
838 if (get_sha1(ref_name[num_rev], revkey.hash))
839 die("'%s' is not a valid ref.", ref_name[num_rev]);
840 commit = lookup_commit_reference(revkey.hash);
842 die("cannot find commit %s (%s)",
843 ref_name[num_rev], oid_to_hex(&revkey));
844 parse_commit(commit);
845 mark_seen(commit, &seen);
847 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
848 * and so on. REV_SHIFT bits from bit 0 are used for
849 * internal bookkeeping.
851 commit->object.flags |= flag;
852 if (commit->object.flags == flag)
853 commit_list_insert_by_date(commit, &list);
854 rev[num_rev] = commit;
856 for (i = 0; i < num_rev; i++)
857 rev_mask[i] = rev[i]->object.flags;
860 join_revs(&list, &seen, num_rev, extra);
862 commit_list_sort_by_date(&seen);
865 return show_merge_base(seen, num_rev);
868 return show_independent(rev, num_rev, ref_name, rev_mask);
870 /* Show list; --more=-1 means list-only */
871 if (1 < num_rev || extra < 0) {
872 for (i = 0; i < num_rev; i++) {
874 int is_head = rev_is_head(head,
878 rev[i]->object.sha1);
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)
949 mark, get_color_reset_code());
953 show_one_commit(commit, no_name);
955 if (shown_merge_point && --extra < 0)