6 #include "parse-options.h"
8 static const char* show_branch_usage[] = {
9 "git show-branch [-a|--all] [-r|--remotes] [--topo-order | --date-order] [--current] [--color | --no-color] [--sparse] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [--topics] [<rev> | <glob>]...",
10 "git show-branch (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]",
14 static int showbranch_use_color = -1;
15 static char column_colors[][COLOR_MAXLEN] = {
24 #define COLUMN_COLORS_MAX (ARRAY_SIZE(column_colors))
26 static int default_num;
27 static int default_alloc;
28 static const char **default_arg;
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 (showbranch_use_color)
40 return column_colors[idx];
44 static const char *get_color_reset_code(void)
46 if (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)
63 static struct commit *pop_one_commit(struct commit_list **list_p)
65 struct commit *commit;
66 struct commit_list *list;
75 const char *head_name; /* which head's ancestor? */
76 int generation; /* how many parents away from head_name */
79 /* Name the commit as nth generation ancestor of head_name;
80 * we count only the first-parent relationship for naming purposes.
82 static void name_commit(struct commit *commit, const char *head_name, int nth)
84 struct commit_name *name;
86 commit->util = xmalloc(sizeof(struct commit_name));
88 name->head_name = head_name;
89 name->generation = nth;
92 /* Parent is the first parent of the commit. We may name it
93 * as (n+1)th generation ancestor of the same head_name as
94 * commit is nth generation ancestor of, if that generation
95 * number is better than the name it already has.
97 static void name_parent(struct commit *commit, struct commit *parent)
99 struct commit_name *commit_name = commit->util;
100 struct commit_name *parent_name = parent->util;
104 commit_name->generation + 1 < parent_name->generation)
105 name_commit(parent, commit_name->head_name,
106 commit_name->generation + 1);
109 static int name_first_parent_chain(struct commit *c)
118 p = c->parents->item;
130 static void name_commits(struct commit_list *list,
135 struct commit_list *cl;
139 /* First give names to the given heads */
140 for (cl = list; cl; cl = cl->next) {
144 for (i = 0; i < num_rev; i++) {
146 name_commit(c, ref_name[i], 0);
152 /* Then commits on the first parent ancestry chain */
155 for (cl = list; cl; cl = cl->next) {
156 i += name_first_parent_chain(cl->item);
160 /* Finally, any unnamed commits */
163 for (cl = list; cl; cl = cl->next) {
164 struct commit_list *parents;
165 struct commit_name *n;
171 parents = c->parents;
174 struct commit *p = parents->item;
175 char newname[1000], *en;
176 parents = parents->next;
181 switch (n->generation) {
183 en += sprintf(en, "%s", n->head_name);
186 en += sprintf(en, "%s^", n->head_name);
189 en += sprintf(en, "%s~%d",
190 n->head_name, n->generation);
194 en += sprintf(en, "^");
196 en += sprintf(en, "^%d", nth);
197 name_commit(p, xstrdup(newname), 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_one_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)
241 if (!p->object.parsed)
243 if (mark_seen(p, seen_p) && !still_interesting)
245 p->object.flags |= flags;
246 insert_by_date(p, list_p);
251 * Postprocess to complete well-poisoning.
253 * At this point we have all the commits we have seen in
254 * seen_p list. Mark anything that can be reached from
255 * uninteresting commits not interesting.
259 struct commit_list *s;
260 for (s = *seen_p; s; s = s->next) {
261 struct commit *c = s->item;
262 struct commit_list *parents;
264 if (((c->object.flags & all_revs) != all_revs) &&
265 !(c->object.flags & UNINTERESTING))
268 /* The current commit is either a merge base or
269 * already uninteresting one. Mark its parents
270 * as uninteresting commits _only_ if they are
271 * already parsed. No reason to find new ones
274 parents = c->parents;
276 struct commit *p = parents->item;
277 parents = parents->next;
278 if (!(p->object.flags & UNINTERESTING)) {
279 p->object.flags |= UNINTERESTING;
289 static void show_one_commit(struct commit *commit, int no_name)
291 struct strbuf pretty = STRBUF_INIT;
292 const char *pretty_str = "(unavailable)";
293 struct commit_name *name = commit->util;
295 if (commit->object.parsed) {
296 pretty_print_commit(CMIT_FMT_ONELINE, commit,
297 &pretty, 0, NULL, NULL, 0, 0);
298 pretty_str = pretty.buf;
300 if (!prefixcmp(pretty_str, "[PATCH] "))
304 if (name && name->head_name) {
305 printf("[%s", name->head_name);
306 if (name->generation) {
307 if (name->generation == 1)
310 printf("~%d", name->generation);
316 find_unique_abbrev(commit->object.sha1, 7));
319 strbuf_release(&pretty);
322 static char *ref_name[MAX_REVS + 1];
323 static int ref_name_cnt;
325 static const char *find_digit_prefix(const char *s, int *v)
332 '0' <= (ch = *p) && ch <= '9';
334 ver = ver * 10 + ch - '0';
340 static int version_cmp(const char *a, const char *b)
345 a = find_digit_prefix(a, &va);
346 b = find_digit_prefix(b, &vb);
353 if ('0' <= ca && ca <= '9')
355 if ('0' <= cb && cb <= '9')
369 static int compare_ref_name(const void *a_, const void *b_)
371 const char * const*a = a_, * const*b = b_;
372 return version_cmp(*a, *b);
375 static void sort_ref_range(int bottom, int top)
377 qsort(ref_name + bottom, top - bottom, sizeof(ref_name[0]),
381 static int append_ref(const char *refname, const unsigned char *sha1,
384 struct commit *commit = lookup_commit_reference_gently(sha1, 1);
391 /* Avoid adding the same thing twice */
392 for (i = 0; i < ref_name_cnt; i++)
393 if (!strcmp(refname, ref_name[i]))
396 if (MAX_REVS <= ref_name_cnt) {
397 warning("ignoring %s; cannot handle more than %d refs",
401 ref_name[ref_name_cnt++] = xstrdup(refname);
402 ref_name[ref_name_cnt] = NULL;
406 static int append_head_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
408 unsigned char tmp[20];
410 if (prefixcmp(refname, "refs/heads/"))
412 /* If both heads/foo and tags/foo exists, get_sha1 would
415 if (get_sha1(refname + ofs, tmp) || hashcmp(tmp, sha1))
417 return append_ref(refname + ofs, sha1, 0);
420 static int append_remote_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
422 unsigned char tmp[20];
424 if (prefixcmp(refname, "refs/remotes/"))
426 /* If both heads/foo and tags/foo exists, get_sha1 would
429 if (get_sha1(refname + ofs, tmp) || hashcmp(tmp, sha1))
431 return append_ref(refname + ofs, sha1, 0);
434 static int append_tag_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
436 if (prefixcmp(refname, "refs/tags/"))
438 return append_ref(refname + 5, sha1, 0);
441 static const char *match_ref_pattern = NULL;
442 static int match_ref_slash = 0;
443 static int count_slash(const char *s)
452 static int append_matching_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
454 /* we want to allow pattern hold/<asterisk> to show all
455 * branches under refs/heads/hold/, and v0.99.9? to show
456 * refs/tags/v0.99.9a and friends.
459 int slash = count_slash(refname);
460 for (tail = refname; *tail && match_ref_slash < slash; )
465 if (fnmatch(match_ref_pattern, tail, 0))
467 if (!prefixcmp(refname, "refs/heads/"))
468 return append_head_ref(refname, sha1, flag, cb_data);
469 if (!prefixcmp(refname, "refs/tags/"))
470 return append_tag_ref(refname, sha1, flag, cb_data);
471 return append_ref(refname, sha1, 0);
474 static void snarf_refs(int head, int remotes)
477 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;
483 for_each_ref(append_remote_ref, NULL);
484 sort_ref_range(orig_cnt, ref_name_cnt);
488 static int rev_is_head(char *head, int headlen, char *name,
489 unsigned char *head_sha1, unsigned char *sha1)
492 (head_sha1 && sha1 && hashcmp(head_sha1, sha1)))
494 if (!prefixcmp(head, "refs/heads/"))
496 if (!prefixcmp(name, "refs/heads/"))
498 else if (!prefixcmp(name, "heads/"))
500 return !strcmp(head, name);
503 static int show_merge_base(struct commit_list *seen, int num_rev)
505 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
506 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
510 struct commit *commit = pop_one_commit(&seen);
511 int flags = commit->object.flags & all_mask;
512 if (!(flags & UNINTERESTING) &&
513 ((flags & all_revs) == all_revs)) {
514 puts(sha1_to_hex(commit->object.sha1));
516 commit->object.flags |= UNINTERESTING;
522 static int show_independent(struct commit **rev,
525 unsigned int *rev_mask)
529 for (i = 0; i < num_rev; i++) {
530 struct commit *commit = rev[i];
531 unsigned int flag = rev_mask[i];
533 if (commit->object.flags == flag)
534 puts(sha1_to_hex(commit->object.sha1));
535 commit->object.flags |= UNINTERESTING;
540 static void append_one_rev(const char *av)
542 unsigned char revkey[20];
543 if (!get_sha1(av, revkey)) {
544 append_ref(av, revkey, 0);
547 if (strchr(av, '*') || strchr(av, '?') || strchr(av, '[')) {
548 /* glob style match */
549 int saved_matches = ref_name_cnt;
550 match_ref_pattern = av;
551 match_ref_slash = count_slash(av);
552 for_each_ref(append_matching_ref, NULL);
553 if (saved_matches == ref_name_cnt &&
554 ref_name_cnt < MAX_REVS)
555 error("no matching refs with %s", av);
556 if (saved_matches + 1 < ref_name_cnt)
557 sort_ref_range(saved_matches, ref_name_cnt);
560 die("bad sha1 reference %s", av);
563 static int git_show_branch_config(const char *var, const char *value, void *cb)
565 if (!strcmp(var, "showbranch.default")) {
567 return config_error_nonbool(var);
569 * default_arg is now passed to parse_options(), so we need to
570 * mimick the real argv a bit better.
574 default_arg = xcalloc(default_alloc, sizeof(*default_arg));
575 default_arg[default_num++] = "show-branch";
576 } else if (default_alloc <= default_num + 1) {
577 default_alloc = default_alloc * 3 / 2 + 20;
578 default_arg = xrealloc(default_arg, sizeof *default_arg * default_alloc);
580 default_arg[default_num++] = xstrdup(value);
581 default_arg[default_num] = NULL;
585 if (!strcmp(var, "color.showbranch")) {
586 showbranch_use_color = git_config_colorbool(var, value, -1);
590 return git_color_default_config(var, value, cb);
593 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)
595 /* If the commit is tip of the named branches, do not
597 * Otherwise, if it is a merge that is reachable from only one
598 * tip, it is not that interesting.
601 for (i = 0; i < n; i++)
602 if (rev[i] == commit)
604 flag = commit->object.flags;
605 for (i = count = 0; i < n; i++) {
606 if (flag & (1u << (i + REV_SHIFT)))
614 static int reflog = 0;
616 static int parse_reflog_param(const struct option *opt, const char *arg,
620 const char **base = (const char **)opt->value;
623 reflog = strtoul(arg, &ep, 10);
627 return error("unrecognized reflog param '%s'", arg);
631 reflog = DEFAULT_REFLOG;
635 int cmd_show_branch(int ac, const char **av, const char *prefix)
637 struct commit *rev[MAX_REVS], *commit;
638 char *reflog_msg[MAX_REVS];
639 struct commit_list *list = NULL, *seen = NULL;
640 unsigned int rev_mask[MAX_REVS];
641 int num_rev, i, extra = 0;
642 int all_heads = 0, all_remotes = 0;
643 int all_mask, all_revs;
648 unsigned char head_sha1[20];
653 int shown_merge_point = 0;
654 int with_current_branch = 0;
658 const char *reflog_base = NULL;
659 struct option builtin_show_branch_options[] = {
660 OPT_BOOLEAN('a', "all", &all_heads,
661 "show remote-tracking and local branches"),
662 OPT_BOOLEAN('r', "remotes", &all_remotes,
663 "show remote-tracking branches"),
664 OPT_BOOLEAN(0, "color", &showbranch_use_color,
665 "color '*!+-' corresponding to the branch"),
666 { OPTION_INTEGER, 0, "more", &extra, "n",
667 "show <n> more commits after the common ancestor",
668 PARSE_OPT_OPTARG, NULL, (intptr_t)1 },
669 OPT_SET_INT(0, "list", &extra, "synonym to more=-1", -1),
670 OPT_BOOLEAN(0, "no-name", &no_name, "suppress naming strings"),
671 OPT_BOOLEAN(0, "current", &with_current_branch,
672 "include the current branch"),
673 OPT_BOOLEAN(0, "sha1-name", &sha1_name,
674 "name commits with their object names"),
675 OPT_BOOLEAN(0, "merge-base", &merge_base,
676 "show possible merge bases"),
677 OPT_BOOLEAN(0, "independent", &independent,
678 "show refs unreachable from any other ref"),
679 OPT_BOOLEAN(0, "topo-order", &lifo,
680 "show commits in topological order"),
681 OPT_BOOLEAN(0, "topics", &topics,
682 "show only commits not on the first branch"),
683 OPT_SET_INT(0, "sparse", &dense,
684 "show merges reachable from only one tip", 0),
685 OPT_SET_INT(0, "date-order", &lifo,
686 "show commits where no parent comes before its "
688 { OPTION_CALLBACK, 'g', "reflog", &reflog_base, "<n>[,<base>]",
689 "show <n> most recent ref-log entries starting at "
691 PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
692 parse_reflog_param },
696 git_config(git_show_branch_config, NULL);
698 if (showbranch_use_color == -1)
699 showbranch_use_color = git_use_color_default;
701 /* If nothing is specified, try the default first */
702 if (ac == 1 && default_num) {
707 ac = parse_options(ac, av, prefix, builtin_show_branch_options,
708 show_branch_usage, PARSE_OPT_STOP_AT_NON_OPTION);
712 if (extra || reflog) {
713 /* "listing" mode is incompatible with
714 * independent nor merge-base modes.
716 if (independent || merge_base)
717 usage_with_options(show_branch_usage,
718 builtin_show_branch_options);
719 if (reflog && ((0 < extra) || all_heads || all_remotes))
721 * Asking for --more in reflog mode does not
722 * make sense. --list is Ok.
724 * Also --all and --remotes do not make sense either.
726 die("--reflog is incompatible with --all, --remotes, "
727 "--independent or --merge-base");
730 /* If nothing is specified, show all branches by default */
731 if (ac + all_heads + all_remotes == 0)
735 unsigned char sha1[20];
741 static const char *fake_av[2];
744 refname = resolve_ref("HEAD", sha1, 1, NULL);
745 fake_av[0] = xstrdup(refname);
751 die("--reflog option needs one branch name");
753 if (MAX_REVS < reflog)
754 die("Only %d entries can be shown at one time.",
756 if (!dwim_ref(*av, strlen(*av), sha1, &ref))
757 die("No such ref %s", *av);
759 /* Has the base been specified? */
762 base = strtoul(reflog_base, &ep, 10);
764 /* Ah, that is a date spec... */
766 at = approxidate(reflog_base);
767 read_ref_at(ref, at, -1, sha1, NULL,
772 for (i = 0; i < reflog; i++) {
775 unsigned long timestamp;
778 if (read_ref_at(ref, 0, base+i, sha1, &logmsg,
779 ×tamp, &tz, NULL)) {
783 msg = strchr(logmsg, '\t');
788 m = xmalloc(strlen(msg) + 200);
789 sprintf(m, "(%s) %s",
790 show_date(timestamp, tz, 1),
794 sprintf(nth_desc, "%s@{%d}", *av, base+i);
795 append_ref(nth_desc, sha1, 1);
798 else if (all_heads + all_remotes)
799 snarf_refs(all_heads, all_remotes);
807 head_p = resolve_ref("HEAD", head_sha1, 1, NULL);
809 head_len = strlen(head_p);
810 memcpy(head, head_p, head_len + 1);
817 if (with_current_branch && head_p) {
819 for (i = 0; !has_head && i < ref_name_cnt; i++) {
820 /* We are only interested in adding the branch
823 if (rev_is_head(head,
830 int offset = !prefixcmp(head, "refs/heads/") ? 11 : 0;
831 append_one_rev(head + offset);
836 fprintf(stderr, "No revs to be shown.\n");
840 for (num_rev = 0; ref_name[num_rev]; num_rev++) {
841 unsigned char revkey[20];
842 unsigned int flag = 1u << (num_rev + REV_SHIFT);
844 if (MAX_REVS <= num_rev)
845 die("cannot handle more than %d revs.", MAX_REVS);
846 if (get_sha1(ref_name[num_rev], revkey))
847 die("'%s' is not a valid ref.", ref_name[num_rev]);
848 commit = lookup_commit_reference(revkey);
850 die("cannot find commit %s (%s)",
851 ref_name[num_rev], revkey);
852 parse_commit(commit);
853 mark_seen(commit, &seen);
855 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
856 * and so on. REV_SHIFT bits from bit 0 are used for
857 * internal bookkeeping.
859 commit->object.flags |= flag;
860 if (commit->object.flags == flag)
861 insert_by_date(commit, &list);
862 rev[num_rev] = commit;
864 for (i = 0; i < num_rev; i++)
865 rev_mask[i] = rev[i]->object.flags;
868 join_revs(&list, &seen, num_rev, extra);
873 return show_merge_base(seen, num_rev);
876 return show_independent(rev, num_rev, ref_name, rev_mask);
878 /* Show list; --more=-1 means list-only */
879 if (1 < num_rev || extra < 0) {
880 for (i = 0; i < num_rev; i++) {
882 int is_head = rev_is_head(head,
886 rev[i]->object.sha1);
889 is_head ? '*' : ' ', ref_name[i]);
891 for (j = 0; j < i; j++)
893 printf("%s%c%s [%s] ",
894 get_color_code(i % COLUMN_COLORS_MAX),
896 get_color_reset_code(), ref_name[i]);
900 /* header lines never need name */
901 show_one_commit(rev[i], 1);
910 for (i = 0; i < num_rev; i++)
918 /* Sort topologically */
919 sort_in_topological_order(&seen, lifo);
921 /* Give names to commits */
922 if (!sha1_name && !no_name)
923 name_commits(seen, rev, ref_name, num_rev);
925 all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
926 all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
929 struct commit *commit = pop_one_commit(&seen);
930 int this_flag = commit->object.flags;
931 int is_merge_point = ((this_flag & all_revs) == all_revs);
933 shown_merge_point |= is_merge_point;
936 int is_merge = !!(commit->parents &&
937 commit->parents->next);
940 (this_flag & (1u << REV_SHIFT)))
942 if (dense && is_merge &&
943 omit_in_dense(commit, rev, num_rev))
945 for (i = 0; i < num_rev; i++) {
947 if (!(this_flag & (1u << (i + REV_SHIFT))))
951 else if (i == head_at)
956 get_color_code(i % COLUMN_COLORS_MAX),
957 mark, get_color_reset_code());
961 show_one_commit(commit, no_name);
963 if (shown_merge_point && --extra < 0)