Document git-blame triple -C option
[git] / builtin-branch.c
1 /*
2  * Builtin "git branch"
3  *
4  * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5  * Based on git-branch.sh by Junio C Hamano.
6  */
7
8 #include "cache.h"
9 #include "color.h"
10 #include "refs.h"
11 #include "commit.h"
12 #include "builtin.h"
13 #include "remote.h"
14 #include "parse-options.h"
15 #include "branch.h"
16 #include "diff.h"
17 #include "revision.h"
18
19 static const char * const builtin_branch_usage[] = {
20         "git branch [options] [-r | -a] [--merged | --no-merged]",
21         "git branch [options] [-l] [-f] <branchname> [<start-point>]",
22         "git branch [options] [-r] (-d | -D) <branchname>",
23         "git branch [options] (-m | -M) [<oldbranch>] <newbranch>",
24         NULL
25 };
26
27 #define REF_LOCAL_BRANCH    0x01
28 #define REF_REMOTE_BRANCH   0x02
29
30 static const char *head;
31 static unsigned char head_sha1[20];
32
33 static int branch_use_color = -1;
34 static char branch_colors[][COLOR_MAXLEN] = {
35         GIT_COLOR_RESET,
36         GIT_COLOR_NORMAL,       /* PLAIN */
37         GIT_COLOR_RED,          /* REMOTE */
38         GIT_COLOR_NORMAL,       /* LOCAL */
39         GIT_COLOR_GREEN,        /* CURRENT */
40 };
41 enum color_branch {
42         BRANCH_COLOR_RESET = 0,
43         BRANCH_COLOR_PLAIN = 1,
44         BRANCH_COLOR_REMOTE = 2,
45         BRANCH_COLOR_LOCAL = 3,
46         BRANCH_COLOR_CURRENT = 4,
47 };
48
49 static enum merge_filter {
50         NO_FILTER = 0,
51         SHOW_NOT_MERGED,
52         SHOW_MERGED,
53 } merge_filter;
54 static unsigned char merge_filter_ref[20];
55
56 static int parse_branch_color_slot(const char *var, int ofs)
57 {
58         if (!strcasecmp(var+ofs, "plain"))
59                 return BRANCH_COLOR_PLAIN;
60         if (!strcasecmp(var+ofs, "reset"))
61                 return BRANCH_COLOR_RESET;
62         if (!strcasecmp(var+ofs, "remote"))
63                 return BRANCH_COLOR_REMOTE;
64         if (!strcasecmp(var+ofs, "local"))
65                 return BRANCH_COLOR_LOCAL;
66         if (!strcasecmp(var+ofs, "current"))
67                 return BRANCH_COLOR_CURRENT;
68         return -1;
69 }
70
71 static int git_branch_config(const char *var, const char *value, void *cb)
72 {
73         if (!strcmp(var, "color.branch")) {
74                 branch_use_color = git_config_colorbool(var, value, -1);
75                 return 0;
76         }
77         if (!prefixcmp(var, "color.branch.")) {
78                 int slot = parse_branch_color_slot(var, 13);
79                 if (slot < 0)
80                         return 0;
81                 if (!value)
82                         return config_error_nonbool(var);
83                 color_parse(value, var, branch_colors[slot]);
84                 return 0;
85         }
86         return git_color_default_config(var, value, cb);
87 }
88
89 static const char *branch_get_color(enum color_branch ix)
90 {
91         if (branch_use_color > 0)
92                 return branch_colors[ix];
93         return "";
94 }
95
96 static int delete_branches(int argc, const char **argv, int force, int kinds)
97 {
98         struct commit *rev, *head_rev = head_rev;
99         unsigned char sha1[20];
100         char *name = NULL;
101         const char *fmt, *remote;
102         int i;
103         int ret = 0;
104         struct strbuf bname = STRBUF_INIT;
105
106         switch (kinds) {
107         case REF_REMOTE_BRANCH:
108                 fmt = "refs/remotes/%s";
109                 remote = "remote ";
110                 force = 1;
111                 break;
112         case REF_LOCAL_BRANCH:
113                 fmt = "refs/heads/%s";
114                 remote = "";
115                 break;
116         default:
117                 die("cannot use -a with -d");
118         }
119
120         if (!force) {
121                 head_rev = lookup_commit_reference(head_sha1);
122                 if (!head_rev)
123                         die("Couldn't look up commit object for HEAD");
124         }
125         for (i = 0; i < argc; i++, strbuf_release(&bname)) {
126                 strbuf_branchname(&bname, argv[i]);
127                 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
128                         error("Cannot delete the branch '%s' "
129                               "which you are currently on.", bname.buf);
130                         ret = 1;
131                         continue;
132                 }
133
134                 free(name);
135
136                 name = xstrdup(mkpath(fmt, bname.buf));
137                 if (!resolve_ref(name, sha1, 1, NULL)) {
138                         error("%sbranch '%s' not found.",
139                                         remote, bname.buf);
140                         ret = 1;
141                         continue;
142                 }
143
144                 rev = lookup_commit_reference(sha1);
145                 if (!rev) {
146                         error("Couldn't look up commit object for '%s'", name);
147                         ret = 1;
148                         continue;
149                 }
150
151                 /* This checks whether the merge bases of branch and
152                  * HEAD contains branch -- which means that the HEAD
153                  * contains everything in both.
154                  */
155
156                 if (!force &&
157                     !in_merge_bases(rev, &head_rev, 1)) {
158                         error("The branch '%s' is not an ancestor of "
159                               "your current HEAD.\n"
160                               "If you are sure you want to delete it, "
161                               "run 'git branch -D %s'.", bname.buf, bname.buf);
162                         ret = 1;
163                         continue;
164                 }
165
166                 if (delete_ref(name, sha1, 0)) {
167                         error("Error deleting %sbranch '%s'", remote,
168                               bname.buf);
169                         ret = 1;
170                 } else {
171                         struct strbuf buf = STRBUF_INIT;
172                         printf("Deleted %sbranch %s (was %s).\n", remote,
173                                bname.buf,
174                                find_unique_abbrev(sha1, DEFAULT_ABBREV));
175                         strbuf_addf(&buf, "branch.%s", bname.buf);
176                         if (git_config_rename_section(buf.buf, NULL) < 0)
177                                 warning("Update of config-file failed");
178                         strbuf_release(&buf);
179                 }
180         }
181
182         free(name);
183
184         return(ret);
185 }
186
187 struct ref_item {
188         char *name;
189         char *dest;
190         unsigned int kind, len;
191         struct commit *commit;
192 };
193
194 struct ref_list {
195         struct rev_info revs;
196         int index, alloc, maxwidth, verbose, abbrev;
197         struct ref_item *list;
198         struct commit_list *with_commit;
199         int kinds;
200 };
201
202 static char *resolve_symref(const char *src, const char *prefix)
203 {
204         unsigned char sha1[20];
205         int flag;
206         const char *dst, *cp;
207
208         dst = resolve_ref(src, sha1, 0, &flag);
209         if (!(dst && (flag & REF_ISSYMREF)))
210                 return NULL;
211         if (prefix && (cp = skip_prefix(dst, prefix)))
212                 dst = cp;
213         return xstrdup(dst);
214 }
215
216 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
217 {
218         struct ref_list *ref_list = (struct ref_list*)(cb_data);
219         struct ref_item *newitem;
220         struct commit *commit;
221         int kind, i;
222         const char *prefix, *orig_refname = refname;
223
224         static struct {
225                 int kind;
226                 const char *prefix;
227                 int pfxlen;
228         } ref_kind[] = {
229                 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
230                 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
231         };
232
233         /* Detect kind */
234         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
235                 prefix = ref_kind[i].prefix;
236                 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
237                         continue;
238                 kind = ref_kind[i].kind;
239                 refname += ref_kind[i].pfxlen;
240                 break;
241         }
242         if (ARRAY_SIZE(ref_kind) <= i)
243                 return 0;
244
245         /* Don't add types the caller doesn't want */
246         if ((kind & ref_list->kinds) == 0)
247                 return 0;
248
249         commit = NULL;
250         if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
251                 commit = lookup_commit_reference_gently(sha1, 1);
252                 if (!commit)
253                         return error("branch '%s' does not point at a commit", refname);
254
255                 /* Filter with with_commit if specified */
256                 if (!is_descendant_of(commit, ref_list->with_commit))
257                         return 0;
258
259                 if (merge_filter != NO_FILTER)
260                         add_pending_object(&ref_list->revs,
261                                            (struct object *)commit, refname);
262         }
263
264         /* Resize buffer */
265         if (ref_list->index >= ref_list->alloc) {
266                 ref_list->alloc = alloc_nr(ref_list->alloc);
267                 ref_list->list = xrealloc(ref_list->list,
268                                 ref_list->alloc * sizeof(struct ref_item));
269         }
270
271         /* Record the new item */
272         newitem = &(ref_list->list[ref_list->index++]);
273         newitem->name = xstrdup(refname);
274         newitem->kind = kind;
275         newitem->commit = commit;
276         newitem->len = strlen(refname);
277         newitem->dest = resolve_symref(orig_refname, prefix);
278         /* adjust for "remotes/" */
279         if (newitem->kind == REF_REMOTE_BRANCH &&
280             ref_list->kinds != REF_REMOTE_BRANCH)
281                 newitem->len += 8;
282         if (newitem->len > ref_list->maxwidth)
283                 ref_list->maxwidth = newitem->len;
284
285         return 0;
286 }
287
288 static void free_ref_list(struct ref_list *ref_list)
289 {
290         int i;
291
292         for (i = 0; i < ref_list->index; i++) {
293                 free(ref_list->list[i].name);
294                 free(ref_list->list[i].dest);
295         }
296         free(ref_list->list);
297 }
298
299 static int ref_cmp(const void *r1, const void *r2)
300 {
301         struct ref_item *c1 = (struct ref_item *)(r1);
302         struct ref_item *c2 = (struct ref_item *)(r2);
303
304         if (c1->kind != c2->kind)
305                 return c1->kind - c2->kind;
306         return strcmp(c1->name, c2->name);
307 }
308
309 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
310                 int show_upstream_ref)
311 {
312         int ours, theirs;
313         struct branch *branch = branch_get(branch_name);
314
315         if (!stat_tracking_info(branch, &ours, &theirs)) {
316                 if (branch && branch->merge && branch->merge[0]->dst &&
317                     show_upstream_ref)
318                         strbuf_addf(stat, "[%s] ",
319                             shorten_unambiguous_ref(branch->merge[0]->dst, 0));
320                 return;
321         }
322
323         strbuf_addch(stat, '[');
324         if (show_upstream_ref)
325                 strbuf_addf(stat, "%s: ",
326                         shorten_unambiguous_ref(branch->merge[0]->dst, 0));
327         if (!ours)
328                 strbuf_addf(stat, "behind %d] ", theirs);
329         else if (!theirs)
330                 strbuf_addf(stat, "ahead %d] ", ours);
331         else
332                 strbuf_addf(stat, "ahead %d, behind %d] ", ours, theirs);
333 }
334
335 static int matches_merge_filter(struct commit *commit)
336 {
337         int is_merged;
338
339         if (merge_filter == NO_FILTER)
340                 return 1;
341
342         is_merged = !!(commit->object.flags & UNINTERESTING);
343         return (is_merged == (merge_filter == SHOW_MERGED));
344 }
345
346 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
347                            int abbrev, int current, char *prefix)
348 {
349         char c;
350         int color;
351         struct commit *commit = item->commit;
352         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
353
354         if (!matches_merge_filter(commit))
355                 return;
356
357         switch (item->kind) {
358         case REF_LOCAL_BRANCH:
359                 color = BRANCH_COLOR_LOCAL;
360                 break;
361         case REF_REMOTE_BRANCH:
362                 color = BRANCH_COLOR_REMOTE;
363                 break;
364         default:
365                 color = BRANCH_COLOR_PLAIN;
366                 break;
367         }
368
369         c = ' ';
370         if (current) {
371                 c = '*';
372                 color = BRANCH_COLOR_CURRENT;
373         }
374
375         strbuf_addf(&name, "%s%s", prefix, item->name);
376         if (verbose)
377                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
378                             maxwidth, name.buf,
379                             branch_get_color(BRANCH_COLOR_RESET));
380         else
381                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
382                             name.buf, branch_get_color(BRANCH_COLOR_RESET));
383
384         if (item->dest)
385                 strbuf_addf(&out, " -> %s", item->dest);
386         else if (verbose) {
387                 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
388                 const char *sub = " **** invalid ref ****";
389
390                 commit = item->commit;
391                 if (commit && !parse_commit(commit)) {
392                         struct pretty_print_context ctx = {0};
393                         pretty_print_commit(CMIT_FMT_ONELINE, commit,
394                                             &subject, &ctx);
395                         sub = subject.buf;
396                 }
397
398                 if (item->kind == REF_LOCAL_BRANCH)
399                         fill_tracking_info(&stat, item->name, verbose > 1);
400
401                 strbuf_addf(&out, " %s %s%s",
402                         find_unique_abbrev(item->commit->object.sha1, abbrev),
403                         stat.buf, sub);
404                 strbuf_release(&stat);
405                 strbuf_release(&subject);
406         }
407         printf("%s\n", out.buf);
408         strbuf_release(&name);
409         strbuf_release(&out);
410 }
411
412 static int calc_maxwidth(struct ref_list *refs)
413 {
414         int i, w = 0;
415         for (i = 0; i < refs->index; i++) {
416                 if (!matches_merge_filter(refs->list[i].commit))
417                         continue;
418                 if (refs->list[i].len > w)
419                         w = refs->list[i].len;
420         }
421         return w;
422 }
423
424
425 static void show_detached(struct ref_list *ref_list)
426 {
427         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
428
429         if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
430                 struct ref_item item;
431                 item.name = xstrdup("(no branch)");
432                 item.len = strlen(item.name);
433                 item.kind = REF_LOCAL_BRANCH;
434                 item.dest = NULL;
435                 item.commit = head_commit;
436                 if (item.len > ref_list->maxwidth)
437                         ref_list->maxwidth = item.len;
438                 print_ref_item(&item, ref_list->maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
439                 free(item.name);
440         }
441 }
442
443 static void print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
444 {
445         int i;
446         struct ref_list ref_list;
447
448         memset(&ref_list, 0, sizeof(ref_list));
449         ref_list.kinds = kinds;
450         ref_list.verbose = verbose;
451         ref_list.abbrev = abbrev;
452         ref_list.with_commit = with_commit;
453         if (merge_filter != NO_FILTER)
454                 init_revisions(&ref_list.revs, NULL);
455         for_each_rawref(append_ref, &ref_list);
456         if (merge_filter != NO_FILTER) {
457                 struct commit *filter;
458                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
459                 filter->object.flags |= UNINTERESTING;
460                 add_pending_object(&ref_list.revs,
461                                    (struct object *) filter, "");
462                 ref_list.revs.limited = 1;
463                 prepare_revision_walk(&ref_list.revs);
464                 if (verbose)
465                         ref_list.maxwidth = calc_maxwidth(&ref_list);
466         }
467
468         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
469
470         detached = (detached && (kinds & REF_LOCAL_BRANCH));
471         if (detached)
472                 show_detached(&ref_list);
473
474         for (i = 0; i < ref_list.index; i++) {
475                 int current = !detached &&
476                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
477                         !strcmp(ref_list.list[i].name, head);
478                 char *prefix = (kinds != REF_REMOTE_BRANCH &&
479                                 ref_list.list[i].kind == REF_REMOTE_BRANCH)
480                                 ? "remotes/" : "";
481                 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
482                                abbrev, current, prefix);
483         }
484
485         free_ref_list(&ref_list);
486 }
487
488 static void rename_branch(const char *oldname, const char *newname, int force)
489 {
490         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
491         unsigned char sha1[20];
492         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
493         int recovery = 0;
494
495         if (!oldname)
496                 die("cannot rename the current branch while not on any.");
497
498         if (strbuf_check_branch_ref(&oldref, oldname)) {
499                 /*
500                  * Bad name --- this could be an attempt to rename a
501                  * ref that we used to allow to be created by accident.
502                  */
503                 if (resolve_ref(oldref.buf, sha1, 1, NULL))
504                         recovery = 1;
505                 else
506                         die("Invalid branch name: '%s'", oldname);
507         }
508
509         if (strbuf_check_branch_ref(&newref, newname))
510                 die("Invalid branch name: '%s'", newname);
511
512         if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
513                 die("A branch named '%s' already exists.", newref.buf + 11);
514
515         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
516                  oldref.buf, newref.buf);
517
518         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
519                 die("Branch rename failed");
520         strbuf_release(&logmsg);
521
522         if (recovery)
523                 warning("Renamed a misnamed branch '%s' away", oldref.buf + 11);
524
525         /* no need to pass logmsg here as HEAD didn't really move */
526         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
527                 die("Branch renamed to %s, but HEAD is not updated!", newname);
528
529         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
530         strbuf_release(&oldref);
531         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
532         strbuf_release(&newref);
533         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
534                 die("Branch is renamed, but update of config-file failed");
535         strbuf_release(&oldsection);
536         strbuf_release(&newsection);
537 }
538
539 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
540 {
541         merge_filter = ((opt->long_name[0] == 'n')
542                         ? SHOW_NOT_MERGED
543                         : SHOW_MERGED);
544         if (unset)
545                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
546         if (!arg)
547                 arg = "HEAD";
548         if (get_sha1(arg, merge_filter_ref))
549                 die("malformed object name %s", arg);
550         return 0;
551 }
552
553 int cmd_branch(int argc, const char **argv, const char *prefix)
554 {
555         int delete = 0, rename = 0, force_create = 0;
556         int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
557         int reflog = 0;
558         enum branch_track track;
559         int kinds = REF_LOCAL_BRANCH;
560         struct commit_list *with_commit = NULL;
561
562         struct option options[] = {
563                 OPT_GROUP("Generic options"),
564                 OPT__VERBOSE(&verbose),
565                 OPT_SET_INT('t', "track",  &track, "set up tracking mode (see git-pull(1))",
566                         BRANCH_TRACK_EXPLICIT),
567                 OPT_BOOLEAN( 0 , "color",  &branch_use_color, "use colored output"),
568                 OPT_SET_INT('r', NULL,     &kinds, "act on remote-tracking branches",
569                         REF_REMOTE_BRANCH),
570                 {
571                         OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
572                         "print only branches that contain the commit",
573                         PARSE_OPT_LASTARG_DEFAULT,
574                         parse_opt_with_commit, (intptr_t)"HEAD",
575                 },
576                 {
577                         OPTION_CALLBACK, 0, "with", &with_commit, "commit",
578                         "print only branches that contain the commit",
579                         PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
580                         parse_opt_with_commit, (intptr_t) "HEAD",
581                 },
582                 OPT__ABBREV(&abbrev),
583
584                 OPT_GROUP("Specific git-branch actions:"),
585                 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
586                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
587                 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
588                 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
589                 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
590                 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
591                 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
592                 OPT_BOOLEAN('f', "force", &force_create, "force creation (when already exists)"),
593                 {
594                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
595                         "commit", "print only not merged branches",
596                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
597                         opt_parse_merge_filter, (intptr_t) "HEAD",
598                 },
599                 {
600                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
601                         "commit", "print only merged branches",
602                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
603                         opt_parse_merge_filter, (intptr_t) "HEAD",
604                 },
605                 OPT_END(),
606         };
607
608         git_config(git_branch_config, NULL);
609
610         if (branch_use_color == -1)
611                 branch_use_color = git_use_color_default;
612
613         track = git_branch_track;
614
615         head = resolve_ref("HEAD", head_sha1, 0, NULL);
616         if (!head)
617                 die("Failed to resolve HEAD as a valid ref.");
618         head = xstrdup(head);
619         if (!strcmp(head, "HEAD")) {
620                 detached = 1;
621         } else {
622                 if (prefixcmp(head, "refs/heads/"))
623                         die("HEAD not found below refs/heads!");
624                 head += 11;
625         }
626         hashcpy(merge_filter_ref, head_sha1);
627
628         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
629                              0);
630         if (!!delete + !!rename + !!force_create > 1)
631                 usage_with_options(builtin_branch_usage, options);
632
633         if (delete)
634                 return delete_branches(argc, argv, delete > 1, kinds);
635         else if (argc == 0)
636                 print_ref_list(kinds, detached, verbose, abbrev, with_commit);
637         else if (rename && (argc == 1))
638                 rename_branch(head, argv[0], rename > 1);
639         else if (rename && (argc == 2))
640                 rename_branch(argv[0], argv[1], rename > 1);
641         else if (argc <= 2) {
642                 if (kinds != REF_LOCAL_BRANCH)
643                         die("-a and -r options to 'git branch' do not make sense with a branch name");
644                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
645                               force_create, reflog, track);
646         } else
647                 usage_with_options(builtin_branch_usage, options);
648
649         return 0;
650 }