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] [--current] [--color[=<when>] | --no-color] [--sparse] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
10 N_("git show-branch (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]"),
14 static int showbranch_use_color = -1;
16 static int default_num;
17 static int default_alloc;
18 static const char **default_arg;
20 #define UNINTERESTING 01
23 #define MAX_REVS (FLAG_BITS - REV_SHIFT) /* should not exceed bits_per_int - REV_SHIFT */
25 #define DEFAULT_REFLOG 4
27 static const char *get_color_code(int idx)
29 if (want_color(showbranch_use_color))
30 return column_colors_ansi[idx % column_colors_ansi_max];
34 static const char *get_color_reset_code(void)
36 if (want_color(showbranch_use_color))
37 return GIT_COLOR_RESET;
41 static struct commit *interesting(struct commit_list *list)
44 struct commit *commit = list->item;
46 if (commit->object.flags & UNINTERESTING)
53 static struct commit *pop_one_commit(struct commit_list **list_p)
55 struct commit *commit;
56 struct commit_list *list;
65 const char *head_name; /* which head's ancestor? */
66 int generation; /* how many parents away from head_name */
69 /* Name the commit as nth generation ancestor of head_name;
70 * we count only the first-parent relationship for naming purposes.
72 static void name_commit(struct commit *commit, const char *head_name, int nth)
74 struct commit_name *name;
76 commit->util = xmalloc(sizeof(struct commit_name));
78 name->head_name = head_name;
79 name->generation = nth;
82 /* Parent is the first parent of the commit. We may name it
83 * as (n+1)th generation ancestor of the same head_name as
84 * commit is nth generation ancestor of, if that generation
85 * number is better than the name it already has.
87 static void name_parent(struct commit *commit, struct commit *parent)
89 struct commit_name *commit_name = commit->util;
90 struct commit_name *parent_name = parent->util;
94 commit_name->generation + 1 < parent_name->generation)
95 name_commit(parent, commit_name->head_name,
96 commit_name->generation + 1);
99 static int name_first_parent_chain(struct commit *c)
108 p = c->parents->item;
120 static void name_commits(struct commit_list *list,
125 struct commit_list *cl;
129 /* First give names to the given heads */
130 for (cl = list; cl; cl = cl->next) {
134 for (i = 0; i < num_rev; i++) {
136 name_commit(c, ref_name[i], 0);
142 /* Then commits on the first parent ancestry chain */
145 for (cl = list; cl; cl = cl->next) {
146 i += name_first_parent_chain(cl->item);
150 /* Finally, any unnamed commits */
153 for (cl = list; cl; cl = cl->next) {
154 struct commit_list *parents;
155 struct commit_name *n;
161 parents = c->parents;
164 struct commit *p = parents->item;
165 struct strbuf newname = STRBUF_INIT;
166 parents = parents->next;
170 switch (n->generation) {
172 strbuf_addstr(&newname, n->head_name);
175 strbuf_addf(&newname, "%s^", n->head_name);
178 strbuf_addf(&newname, "%s~%d",
179 n->head_name, n->generation);
183 strbuf_addch(&newname, '^');
185 strbuf_addf(&newname, "^%d", nth);
186 name_commit(p, strbuf_detach(&newname, NULL), 0);
188 name_first_parent_chain(p);
194 static int mark_seen(struct commit *commit, struct commit_list **seen_p)
196 if (!commit->object.flags) {
197 commit_list_insert(commit, seen_p);
203 static void join_revs(struct commit_list **list_p,
204 struct commit_list **seen_p,
205 int num_rev, int extra)
207 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
208 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
211 struct commit_list *parents;
212 int still_interesting = !!interesting(*list_p);
213 struct commit *commit = pop_one_commit(list_p);
214 int flags = commit->object.flags & all_mask;
216 if (!still_interesting && extra <= 0)
219 mark_seen(commit, seen_p);
220 if ((flags & all_revs) == all_revs)
221 flags |= UNINTERESTING;
222 parents = commit->parents;
225 struct commit *p = parents->item;
226 int this_flag = p->object.flags;
227 parents = parents->next;
228 if ((this_flag & flags) == flags)
230 if (!p->object.parsed)
232 if (mark_seen(p, seen_p) && !still_interesting)
234 p->object.flags |= flags;
235 commit_list_insert_by_date(p, list_p);
240 * Postprocess to complete well-poisoning.
242 * At this point we have all the commits we have seen in
243 * seen_p list. Mark anything that can be reached from
244 * uninteresting commits not interesting.
248 struct commit_list *s;
249 for (s = *seen_p; s; s = s->next) {
250 struct commit *c = s->item;
251 struct commit_list *parents;
253 if (((c->object.flags & all_revs) != all_revs) &&
254 !(c->object.flags & UNINTERESTING))
257 /* The current commit is either a merge base or
258 * already uninteresting one. Mark its parents
259 * as uninteresting commits _only_ if they are
260 * already parsed. No reason to find new ones
263 parents = c->parents;
265 struct commit *p = parents->item;
266 parents = parents->next;
267 if (!(p->object.flags & UNINTERESTING)) {
268 p->object.flags |= UNINTERESTING;
278 static void show_one_commit(struct commit *commit, int no_name)
280 struct strbuf pretty = STRBUF_INIT;
281 const char *pretty_str = "(unavailable)";
282 struct commit_name *name = commit->util;
284 if (commit->object.parsed) {
285 pp_commit_easy(CMIT_FMT_ONELINE, commit, &pretty);
286 pretty_str = pretty.buf;
288 if (starts_with(pretty_str, "[PATCH] "))
292 if (name && name->head_name) {
293 printf("[%s", name->head_name);
294 if (name->generation) {
295 if (name->generation == 1)
298 printf("~%d", name->generation);
304 find_unique_abbrev(commit->object.sha1,
308 strbuf_release(&pretty);
311 static char *ref_name[MAX_REVS + 1];
312 static int ref_name_cnt;
314 static const char *find_digit_prefix(const char *s, int *v)
321 '0' <= (ch = *p) && ch <= '9';
323 ver = ver * 10 + ch - '0';
329 static int version_cmp(const char *a, const char *b)
334 a = find_digit_prefix(a, &va);
335 b = find_digit_prefix(b, &vb);
342 if ('0' <= ca && ca <= '9')
344 if ('0' <= cb && cb <= '9')
358 static int compare_ref_name(const void *a_, const void *b_)
360 const char * const*a = a_, * const*b = b_;
361 return version_cmp(*a, *b);
364 static void sort_ref_range(int bottom, int top)
366 qsort(ref_name + bottom, top - bottom, sizeof(ref_name[0]),
370 static int append_ref(const char *refname, const unsigned char *sha1,
373 struct commit *commit = lookup_commit_reference_gently(sha1, 1);
380 /* Avoid adding the same thing twice */
381 for (i = 0; i < ref_name_cnt; i++)
382 if (!strcmp(refname, ref_name[i]))
385 if (MAX_REVS <= ref_name_cnt) {
386 warning("ignoring %s; cannot handle more than %d refs",
390 ref_name[ref_name_cnt++] = xstrdup(refname);
391 ref_name[ref_name_cnt] = NULL;
395 static int append_head_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
397 unsigned char tmp[20];
399 if (!starts_with(refname, "refs/heads/"))
401 /* If both heads/foo and tags/foo exists, get_sha1 would
404 if (get_sha1(refname + ofs, tmp) || hashcmp(tmp, sha1))
406 return append_ref(refname + ofs, sha1, 0);
409 static int append_remote_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
411 unsigned char tmp[20];
413 if (!starts_with(refname, "refs/remotes/"))
415 /* If both heads/foo and tags/foo exists, get_sha1 would
418 if (get_sha1(refname + ofs, tmp) || hashcmp(tmp, sha1))
420 return append_ref(refname + ofs, sha1, 0);
423 static int append_tag_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
425 if (!starts_with(refname, "refs/tags/"))
427 return append_ref(refname + 5, sha1, 0);
430 static const char *match_ref_pattern = NULL;
431 static int match_ref_slash = 0;
432 static int count_slash(const char *s)
441 static int append_matching_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
443 /* we want to allow pattern hold/<asterisk> to show all
444 * branches under refs/heads/hold/, and v0.99.9? to show
445 * refs/tags/v0.99.9a and friends.
448 int slash = count_slash(refname);
449 for (tail = refname; *tail && match_ref_slash < slash; )
454 if (fnmatch(match_ref_pattern, tail, 0))
456 if (starts_with(refname, "refs/heads/"))
457 return append_head_ref(refname, sha1, flag, cb_data);
458 if (starts_with(refname, "refs/tags/"))
459 return append_tag_ref(refname, sha1, flag, cb_data);
460 return append_ref(refname, sha1, 0);
463 static void snarf_refs(int head, int remotes)
466 int orig_cnt = ref_name_cnt;
467 for_each_ref(append_head_ref, NULL);
468 sort_ref_range(orig_cnt, ref_name_cnt);
471 int orig_cnt = ref_name_cnt;
472 for_each_ref(append_remote_ref, NULL);
473 sort_ref_range(orig_cnt, ref_name_cnt);
477 static int rev_is_head(char *head, int headlen, char *name,
478 unsigned char *head_sha1, unsigned char *sha1)
481 (head_sha1 && sha1 && hashcmp(head_sha1, sha1)))
483 if (starts_with(head, "refs/heads/"))
485 if (starts_with(name, "refs/heads/"))
487 else if (starts_with(name, "heads/"))
489 return !strcmp(head, name);
492 static int show_merge_base(struct commit_list *seen, int num_rev)
494 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
495 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
499 struct commit *commit = pop_one_commit(&seen);
500 int flags = commit->object.flags & all_mask;
501 if (!(flags & UNINTERESTING) &&
502 ((flags & all_revs) == all_revs)) {
503 puts(sha1_to_hex(commit->object.sha1));
505 commit->object.flags |= UNINTERESTING;
511 static int show_independent(struct commit **rev,
514 unsigned int *rev_mask)
518 for (i = 0; i < num_rev; i++) {
519 struct commit *commit = rev[i];
520 unsigned int flag = rev_mask[i];
522 if (commit->object.flags == flag)
523 puts(sha1_to_hex(commit->object.sha1));
524 commit->object.flags |= UNINTERESTING;
529 static void append_one_rev(const char *av)
531 unsigned char revkey[20];
532 if (!get_sha1(av, revkey)) {
533 append_ref(av, revkey, 0);
536 if (strchr(av, '*') || strchr(av, '?') || strchr(av, '[')) {
537 /* glob style match */
538 int saved_matches = ref_name_cnt;
539 match_ref_pattern = av;
540 match_ref_slash = count_slash(av);
541 for_each_ref(append_matching_ref, NULL);
542 if (saved_matches == ref_name_cnt &&
543 ref_name_cnt < MAX_REVS)
544 error("no matching refs with %s", av);
545 if (saved_matches + 1 < ref_name_cnt)
546 sort_ref_range(saved_matches, ref_name_cnt);
549 die("bad sha1 reference %s", av);
552 static int git_show_branch_config(const char *var, const char *value, void *cb)
554 if (!strcmp(var, "showbranch.default")) {
556 return config_error_nonbool(var);
558 * default_arg is now passed to parse_options(), so we need to
559 * mimic the real argv a bit better.
563 default_arg = xcalloc(default_alloc, sizeof(*default_arg));
564 default_arg[default_num++] = "show-branch";
565 } else if (default_alloc <= default_num + 1) {
566 default_alloc = default_alloc * 3 / 2 + 20;
567 default_arg = xrealloc(default_arg, sizeof *default_arg * default_alloc);
569 default_arg[default_num++] = xstrdup(value);
570 default_arg[default_num] = NULL;
574 if (!strcmp(var, "color.showbranch")) {
575 showbranch_use_color = git_config_colorbool(var, value);
579 return git_color_default_config(var, value, cb);
582 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)
584 /* If the commit is tip of the named branches, do not
586 * Otherwise, if it is a merge that is reachable from only one
587 * tip, it is not that interesting.
590 for (i = 0; i < n; i++)
591 if (rev[i] == commit)
593 flag = commit->object.flags;
594 for (i = count = 0; i < n; i++) {
595 if (flag & (1u << (i + REV_SHIFT)))
603 static int reflog = 0;
605 static int parse_reflog_param(const struct option *opt, const char *arg,
609 const char **base = (const char **)opt->value;
612 reflog = strtoul(arg, &ep, 10);
616 return error("unrecognized reflog param '%s'", arg);
620 reflog = DEFAULT_REFLOG;
624 int cmd_show_branch(int ac, const char **av, const char *prefix)
626 struct commit *rev[MAX_REVS], *commit;
627 char *reflog_msg[MAX_REVS];
628 struct commit_list *list = NULL, *seen = NULL;
629 unsigned int rev_mask[MAX_REVS];
630 int num_rev, i, extra = 0;
631 int all_heads = 0, all_remotes = 0;
632 int all_mask, all_revs;
633 enum rev_sort_order sort_order = REV_SORT_IN_GRAPH_ORDER;
637 unsigned char head_sha1[20];
642 int shown_merge_point = 0;
643 int with_current_branch = 0;
647 const char *reflog_base = NULL;
648 struct option builtin_show_branch_options[] = {
649 OPT_BOOL('a', "all", &all_heads,
650 N_("show remote-tracking and local branches")),
651 OPT_BOOL('r', "remotes", &all_remotes,
652 N_("show remote-tracking branches")),
653 OPT__COLOR(&showbranch_use_color,
654 N_("color '*!+-' corresponding to the branch")),
655 { OPTION_INTEGER, 0, "more", &extra, N_("n"),
656 N_("show <n> more commits after the common ancestor"),
657 PARSE_OPT_OPTARG, NULL, (intptr_t)1 },
658 OPT_SET_INT(0, "list", &extra, N_("synonym to more=-1"), -1),
659 OPT_BOOL(0, "no-name", &no_name, N_("suppress naming strings")),
660 OPT_BOOL(0, "current", &with_current_branch,
661 N_("include the current branch")),
662 OPT_BOOL(0, "sha1-name", &sha1_name,
663 N_("name commits with their object names")),
664 OPT_BOOL(0, "merge-base", &merge_base,
665 N_("show possible merge bases")),
666 OPT_BOOL(0, "independent", &independent,
667 N_("show refs unreachable from any other ref")),
668 OPT_SET_INT(0, "topo-order", &sort_order,
669 N_("show commits in topological order"),
670 REV_SORT_IN_GRAPH_ORDER),
671 OPT_BOOL(0, "topics", &topics,
672 N_("show only commits not on the first branch")),
673 OPT_SET_INT(0, "sparse", &dense,
674 N_("show merges reachable from only one tip"), 0),
675 OPT_SET_INT(0, "date-order", &sort_order,
676 N_("topologically sort, maintaining date order "
678 REV_SORT_BY_COMMIT_DATE),
679 { OPTION_CALLBACK, 'g', "reflog", &reflog_base, N_("<n>[,<base>]"),
680 N_("show <n> most recent ref-log entries starting at "
682 PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
683 parse_reflog_param },
687 git_config(git_show_branch_config, NULL);
689 /* If nothing is specified, try the default first */
690 if (ac == 1 && default_num) {
695 ac = parse_options(ac, av, prefix, builtin_show_branch_options,
696 show_branch_usage, PARSE_OPT_STOP_AT_NON_OPTION);
700 if (extra || reflog) {
701 /* "listing" mode is incompatible with
702 * independent nor merge-base modes.
704 if (independent || merge_base)
705 usage_with_options(show_branch_usage,
706 builtin_show_branch_options);
707 if (reflog && ((0 < extra) || all_heads || all_remotes))
709 * Asking for --more in reflog mode does not
710 * make sense. --list is Ok.
712 * Also --all and --remotes do not make sense either.
714 die("--reflog is incompatible with --all, --remotes, "
715 "--independent or --merge-base");
718 /* If nothing is specified, show all branches by default */
719 if (ac + all_heads + all_remotes == 0)
723 unsigned char sha1[20];
729 static const char *fake_av[2];
731 fake_av[0] = resolve_refdup("HEAD", sha1, 1, NULL);
737 die("--reflog option needs one branch name");
739 if (MAX_REVS < reflog)
740 die("Only %d entries can be shown at one time.",
742 if (!dwim_ref(*av, strlen(*av), sha1, &ref))
743 die("No such ref %s", *av);
745 /* Has the base been specified? */
748 base = strtoul(reflog_base, &ep, 10);
750 /* Ah, that is a date spec... */
752 at = approxidate(reflog_base);
753 read_ref_at(ref, at, -1, sha1, NULL,
758 for (i = 0; i < reflog; i++) {
761 unsigned long timestamp;
764 if (read_ref_at(ref, 0, base+i, sha1, &logmsg,
765 ×tamp, &tz, NULL)) {
769 msg = strchr(logmsg, '\t');
774 m = xmalloc(strlen(msg) + 200);
775 sprintf(m, "(%s) %s",
776 show_date(timestamp, tz, 1),
780 sprintf(nth_desc, "%s@{%d}", *av, base+i);
781 append_ref(nth_desc, sha1, 1);
784 else if (all_heads + all_remotes)
785 snarf_refs(all_heads, all_remotes);
793 head_p = resolve_ref_unsafe("HEAD", head_sha1, 1, NULL);
795 head_len = strlen(head_p);
796 memcpy(head, head_p, head_len + 1);
803 if (with_current_branch && head_p) {
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,
816 int offset = starts_with(head, "refs/heads/") ? 11 : 0;
817 append_one_rev(head + offset);
822 fprintf(stderr, "No revs to be shown.\n");
826 for (num_rev = 0; ref_name[num_rev]; num_rev++) {
827 unsigned char revkey[20];
828 unsigned int flag = 1u << (num_rev + REV_SHIFT);
830 if (MAX_REVS <= num_rev)
831 die("cannot handle more than %d revs.", MAX_REVS);
832 if (get_sha1(ref_name[num_rev], revkey))
833 die("'%s' is not a valid ref.", ref_name[num_rev]);
834 commit = lookup_commit_reference(revkey);
836 die("cannot find commit %s (%s)",
837 ref_name[num_rev], revkey);
838 parse_commit(commit);
839 mark_seen(commit, &seen);
841 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
842 * and so on. REV_SHIFT bits from bit 0 are used for
843 * internal bookkeeping.
845 commit->object.flags |= flag;
846 if (commit->object.flags == flag)
847 commit_list_insert_by_date(commit, &list);
848 rev[num_rev] = commit;
850 for (i = 0; i < num_rev; i++)
851 rev_mask[i] = rev[i]->object.flags;
854 join_revs(&list, &seen, num_rev, extra);
856 commit_list_sort_by_date(&seen);
859 return show_merge_base(seen, num_rev);
862 return show_independent(rev, num_rev, ref_name, rev_mask);
864 /* Show list; --more=-1 means list-only */
865 if (1 < num_rev || extra < 0) {
866 for (i = 0; i < num_rev; i++) {
868 int is_head = rev_is_head(head,
872 rev[i]->object.sha1);
875 is_head ? '*' : ' ', ref_name[i]);
877 for (j = 0; j < i; j++)
879 printf("%s%c%s [%s] ",
882 get_color_reset_code(), ref_name[i]);
886 /* header lines never need name */
887 show_one_commit(rev[i], 1);
896 for (i = 0; i < num_rev; i++)
904 /* Sort topologically */
905 sort_in_topological_order(&seen, sort_order);
907 /* Give names to commits */
908 if (!sha1_name && !no_name)
909 name_commits(seen, rev, ref_name, num_rev);
911 all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
912 all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
915 struct commit *commit = pop_one_commit(&seen);
916 int this_flag = commit->object.flags;
917 int is_merge_point = ((this_flag & all_revs) == all_revs);
919 shown_merge_point |= is_merge_point;
922 int is_merge = !!(commit->parents &&
923 commit->parents->next);
926 (this_flag & (1u << REV_SHIFT)))
928 if (dense && is_merge &&
929 omit_in_dense(commit, rev, num_rev))
931 for (i = 0; i < num_rev; i++) {
933 if (!(this_flag & (1u << (i + REV_SHIFT))))
937 else if (i == head_at)
943 mark, get_color_reset_code());
947 show_one_commit(commit, no_name);
949 if (shown_merge_point && --extra < 0)