6 #include "argv-array.h"
7 #include "parse-options.h"
10 static const char* show_branch_usage[] = {
11 N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n"
12 " [--current] [--color[=<when>] | --no-color] [--sparse]\n"
13 " [--more=<n> | --list | --independent | --merge-base]\n"
14 " [--no-name | --sha1-name] [--topics] [(<rev> | <glob>)...]"),
15 N_("git show-branch (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]"),
19 static int showbranch_use_color = -1;
21 static struct argv_array default_args = ARGV_ARRAY_INIT;
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 skip_prefix(pretty_str, "[PATCH] ", &pretty_str);
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, compare_ref_name);
359 static int append_ref(const char *refname, const struct object_id *oid,
362 struct commit *commit = lookup_commit_reference_gently(oid, 1);
369 /* Avoid adding the same thing twice */
370 for (i = 0; i < ref_name_cnt; i++)
371 if (!strcmp(refname, ref_name[i]))
374 if (MAX_REVS <= ref_name_cnt) {
375 warning(Q_("ignoring %s; cannot handle more than %d ref",
376 "ignoring %s; cannot handle more than %d refs",
377 MAX_REVS), refname, MAX_REVS);
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;
426 static int append_matching_ref(const char *refname, const struct object_id *oid,
427 int flag, void *cb_data)
429 /* we want to allow pattern hold/<asterisk> to show all
430 * branches under refs/heads/hold/, and v0.99.9? to show
431 * refs/tags/v0.99.9a and friends.
434 int slash = count_slashes(refname);
435 for (tail = refname; *tail && match_ref_slash < slash; )
440 if (wildmatch(match_ref_pattern, tail, 0, NULL))
442 if (starts_with(refname, "refs/heads/"))
443 return append_head_ref(refname, oid, flag, cb_data);
444 if (starts_with(refname, "refs/tags/"))
445 return append_tag_ref(refname, oid, flag, cb_data);
446 return append_ref(refname, oid, 0);
449 static void snarf_refs(int head, int remotes)
452 int orig_cnt = ref_name_cnt;
454 for_each_ref(append_head_ref, NULL);
455 sort_ref_range(orig_cnt, ref_name_cnt);
458 int orig_cnt = ref_name_cnt;
460 for_each_ref(append_remote_ref, NULL);
461 sort_ref_range(orig_cnt, ref_name_cnt);
465 static int rev_is_head(const char *head, const char *name,
466 unsigned char *head_sha1, unsigned char *sha1)
468 if (!head || (head_sha1 && sha1 && hashcmp(head_sha1, sha1)))
470 skip_prefix(head, "refs/heads/", &head);
471 if (!skip_prefix(name, "refs/heads/", &name))
472 skip_prefix(name, "heads/", &name);
473 return !strcmp(head, name);
476 static int show_merge_base(struct commit_list *seen, int num_rev)
478 int all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
479 int all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
483 struct commit *commit = pop_commit(&seen);
484 int flags = commit->object.flags & all_mask;
485 if (!(flags & UNINTERESTING) &&
486 ((flags & all_revs) == all_revs)) {
487 puts(oid_to_hex(&commit->object.oid));
489 commit->object.flags |= UNINTERESTING;
495 static int show_independent(struct commit **rev,
498 unsigned int *rev_mask)
502 for (i = 0; i < num_rev; i++) {
503 struct commit *commit = rev[i];
504 unsigned int flag = rev_mask[i];
506 if (commit->object.flags == flag)
507 puts(oid_to_hex(&commit->object.oid));
508 commit->object.flags |= UNINTERESTING;
513 static void append_one_rev(const char *av)
515 struct object_id revkey;
516 if (!get_sha1(av, revkey.hash)) {
517 append_ref(av, &revkey, 0);
520 if (strchr(av, '*') || strchr(av, '?') || strchr(av, '[')) {
521 /* glob style match */
522 int saved_matches = ref_name_cnt;
524 match_ref_pattern = av;
525 match_ref_slash = count_slashes(av);
526 for_each_ref(append_matching_ref, NULL);
527 if (saved_matches == ref_name_cnt &&
528 ref_name_cnt < MAX_REVS)
529 error(_("no matching refs with %s"), av);
530 sort_ref_range(saved_matches, ref_name_cnt);
533 die("bad sha1 reference %s", av);
536 static int git_show_branch_config(const char *var, const char *value, void *cb)
538 if (!strcmp(var, "showbranch.default")) {
540 return config_error_nonbool(var);
542 * default_arg is now passed to parse_options(), so we need to
543 * mimic the real argv a bit better.
545 if (!default_args.argc)
546 argv_array_push(&default_args, "show-branch");
547 argv_array_push(&default_args, value);
551 if (!strcmp(var, "color.showbranch")) {
552 showbranch_use_color = git_config_colorbool(var, value);
556 return git_color_default_config(var, value, cb);
559 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)
561 /* If the commit is tip of the named branches, do not
563 * Otherwise, if it is a merge that is reachable from only one
564 * tip, it is not that interesting.
567 for (i = 0; i < n; i++)
568 if (rev[i] == commit)
570 flag = commit->object.flags;
571 for (i = count = 0; i < n; i++) {
572 if (flag & (1u << (i + REV_SHIFT)))
580 static int reflog = 0;
582 static int parse_reflog_param(const struct option *opt, const char *arg,
586 const char **base = (const char **)opt->value;
589 reflog = strtoul(arg, &ep, 10);
593 return error("unrecognized reflog param '%s'", arg);
597 reflog = DEFAULT_REFLOG;
601 int cmd_show_branch(int ac, const char **av, const char *prefix)
603 struct commit *rev[MAX_REVS], *commit;
604 char *reflog_msg[MAX_REVS];
605 struct commit_list *list = NULL, *seen = NULL;
606 unsigned int rev_mask[MAX_REVS];
607 int num_rev, i, extra = 0;
608 int all_heads = 0, all_remotes = 0;
609 int all_mask, all_revs;
610 enum rev_sort_order sort_order = REV_SORT_IN_GRAPH_ORDER;
612 struct object_id head_oid;
617 int shown_merge_point = 0;
618 int with_current_branch = 0;
622 const char *reflog_base = NULL;
623 struct option builtin_show_branch_options[] = {
624 OPT_BOOL('a', "all", &all_heads,
625 N_("show remote-tracking and local branches")),
626 OPT_BOOL('r', "remotes", &all_remotes,
627 N_("show remote-tracking branches")),
628 OPT__COLOR(&showbranch_use_color,
629 N_("color '*!+-' corresponding to the branch")),
630 { OPTION_INTEGER, 0, "more", &extra, N_("n"),
631 N_("show <n> more commits after the common ancestor"),
632 PARSE_OPT_OPTARG, NULL, (intptr_t)1 },
633 OPT_SET_INT(0, "list", &extra, N_("synonym to more=-1"), -1),
634 OPT_BOOL(0, "no-name", &no_name, N_("suppress naming strings")),
635 OPT_BOOL(0, "current", &with_current_branch,
636 N_("include the current branch")),
637 OPT_BOOL(0, "sha1-name", &sha1_name,
638 N_("name commits with their object names")),
639 OPT_BOOL(0, "merge-base", &merge_base,
640 N_("show possible merge bases")),
641 OPT_BOOL(0, "independent", &independent,
642 N_("show refs unreachable from any other ref")),
643 OPT_SET_INT(0, "topo-order", &sort_order,
644 N_("show commits in topological order"),
645 REV_SORT_IN_GRAPH_ORDER),
646 OPT_BOOL(0, "topics", &topics,
647 N_("show only commits not on the first branch")),
648 OPT_SET_INT(0, "sparse", &dense,
649 N_("show merges reachable from only one tip"), 0),
650 OPT_SET_INT(0, "date-order", &sort_order,
651 N_("topologically sort, maintaining date order "
653 REV_SORT_BY_COMMIT_DATE),
654 { OPTION_CALLBACK, 'g', "reflog", &reflog_base, N_("<n>[,<base>]"),
655 N_("show <n> most recent ref-log entries starting at "
657 PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP,
658 parse_reflog_param },
662 git_config(git_show_branch_config, NULL);
664 /* If nothing is specified, try the default first */
665 if (ac == 1 && default_args.argc) {
666 ac = default_args.argc;
667 av = default_args.argv;
670 ac = parse_options(ac, av, prefix, builtin_show_branch_options,
671 show_branch_usage, PARSE_OPT_STOP_AT_NON_OPTION);
675 if (extra || reflog) {
676 /* "listing" mode is incompatible with
677 * independent nor merge-base modes.
679 if (independent || merge_base)
680 usage_with_options(show_branch_usage,
681 builtin_show_branch_options);
682 if (reflog && ((0 < extra) || all_heads || all_remotes))
684 * Asking for --more in reflog mode does not
685 * make sense. --list is Ok.
687 * Also --all and --remotes do not make sense either.
689 die(_("--reflog is incompatible with --all, --remotes, "
690 "--independent or --merge-base"));
693 /* If nothing is specified, show all branches by default */
694 if (ac <= topics && all_heads + all_remotes == 0)
698 struct object_id oid;
701 unsigned int flags = 0;
704 static const char *fake_av[2];
706 fake_av[0] = resolve_refdup("HEAD",
713 die(_("no branches given, and HEAD is not valid"));
716 die(_("--reflog option needs one branch name"));
718 if (MAX_REVS < reflog)
719 die(Q_("only %d entry can be shown at one time.",
720 "only %d entries can be shown at one time.",
721 MAX_REVS), MAX_REVS);
722 if (!dwim_ref(*av, strlen(*av), oid.hash, &ref))
723 die(_("no such ref %s"), *av);
725 /* Has the base been specified? */
728 base = strtoul(reflog_base, &ep, 10);
730 /* Ah, that is a date spec... */
732 at = approxidate(reflog_base);
733 read_ref_at(ref, flags, at, -1, oid.hash, NULL,
738 for (i = 0; i < reflog; i++) {
742 timestamp_t timestamp;
745 if (read_ref_at(ref, flags, 0, base+i, oid.hash, &logmsg,
746 ×tamp, &tz, NULL)) {
750 msg = strchr(logmsg, '\t');
755 reflog_msg[i] = xstrfmt("(%s) %s",
756 show_date(timestamp, tz,
757 DATE_MODE(RELATIVE)),
761 nth_desc = xstrfmt("%s@{%d}", *av, base+i);
762 append_ref(nth_desc, &oid, 1);
772 if (all_heads + all_remotes)
773 snarf_refs(all_heads, all_remotes);
776 head = resolve_refdup("HEAD", RESOLVE_REF_READING,
777 head_oid.hash, NULL);
779 if (with_current_branch && head) {
781 for (i = 0; !has_head && i < ref_name_cnt; i++) {
782 /* We are only interested in adding the branch
785 if (rev_is_head(head,
787 head_oid.hash, NULL))
791 const char *name = head;
792 skip_prefix(name, "refs/heads/", &name);
793 append_one_rev(name);
798 fprintf(stderr, "No revs to be shown.\n");
802 for (num_rev = 0; ref_name[num_rev]; num_rev++) {
803 struct object_id revkey;
804 unsigned int flag = 1u << (num_rev + REV_SHIFT);
806 if (MAX_REVS <= num_rev)
807 die(Q_("cannot handle more than %d rev.",
808 "cannot handle more than %d revs.",
809 MAX_REVS), MAX_REVS);
810 if (get_sha1(ref_name[num_rev], revkey.hash))
811 die(_("'%s' is not a valid ref."), ref_name[num_rev]);
812 commit = lookup_commit_reference(&revkey);
814 die(_("cannot find commit %s (%s)"),
815 ref_name[num_rev], oid_to_hex(&revkey));
816 parse_commit(commit);
817 mark_seen(commit, &seen);
819 /* rev#0 uses bit REV_SHIFT, rev#1 uses bit REV_SHIFT+1,
820 * and so on. REV_SHIFT bits from bit 0 are used for
821 * internal bookkeeping.
823 commit->object.flags |= flag;
824 if (commit->object.flags == flag)
825 commit_list_insert_by_date(commit, &list);
826 rev[num_rev] = commit;
828 for (i = 0; i < num_rev; i++)
829 rev_mask[i] = rev[i]->object.flags;
832 join_revs(&list, &seen, num_rev, extra);
834 commit_list_sort_by_date(&seen);
837 return show_merge_base(seen, num_rev);
840 return show_independent(rev, num_rev, ref_name, rev_mask);
842 /* Show list; --more=-1 means list-only */
843 if (1 < num_rev || extra < 0) {
844 for (i = 0; i < num_rev; i++) {
846 int is_head = rev_is_head(head,
849 rev[i]->object.oid.hash);
852 is_head ? '*' : ' ', ref_name[i]);
854 for (j = 0; j < i; j++)
856 printf("%s%c%s [%s] ",
859 get_color_reset_code(), ref_name[i]);
863 /* header lines never need name */
864 show_one_commit(rev[i], 1);
873 for (i = 0; i < num_rev; i++)
881 /* Sort topologically */
882 sort_in_topological_order(&seen, sort_order);
884 /* Give names to commits */
885 if (!sha1_name && !no_name)
886 name_commits(seen, rev, ref_name, num_rev);
888 all_mask = ((1u << (REV_SHIFT + num_rev)) - 1);
889 all_revs = all_mask & ~((1u << REV_SHIFT) - 1);
892 struct commit *commit = pop_commit(&seen);
893 int this_flag = commit->object.flags;
894 int is_merge_point = ((this_flag & all_revs) == all_revs);
896 shown_merge_point |= is_merge_point;
899 int is_merge = !!(commit->parents &&
900 commit->parents->next);
903 (this_flag & (1u << REV_SHIFT)))
905 if (dense && is_merge &&
906 omit_in_dense(commit, rev, num_rev))
908 for (i = 0; i < num_rev; i++) {
910 if (!(this_flag & (1u << (i + REV_SHIFT))))
914 else if (i == head_at)
920 mark, get_color_reset_code());
924 show_one_commit(commit, no_name);
926 if (shown_merge_point && --extra < 0)