branch: refactor width computation
[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 #include "string-list.h"
19 #include "column.h"
20 #include "utf8.h"
21 #include "wt-status.h"
22
23 static const char * const builtin_branch_usage[] = {
24         N_("git branch [<options>] [-r | -a] [--merged | --no-merged]"),
25         N_("git branch [<options>] [-l] [-f] <branch-name> [<start-point>]"),
26         N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
27         N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
28         NULL
29 };
30
31 #define REF_LOCAL_BRANCH    0x01
32 #define REF_REMOTE_BRANCH   0x02
33
34 static const char *head;
35 static unsigned char head_sha1[20];
36
37 static int branch_use_color = -1;
38 static char branch_colors[][COLOR_MAXLEN] = {
39         GIT_COLOR_RESET,
40         GIT_COLOR_NORMAL,       /* PLAIN */
41         GIT_COLOR_RED,          /* REMOTE */
42         GIT_COLOR_NORMAL,       /* LOCAL */
43         GIT_COLOR_GREEN,        /* CURRENT */
44         GIT_COLOR_BLUE,         /* UPSTREAM */
45 };
46 enum color_branch {
47         BRANCH_COLOR_RESET = 0,
48         BRANCH_COLOR_PLAIN = 1,
49         BRANCH_COLOR_REMOTE = 2,
50         BRANCH_COLOR_LOCAL = 3,
51         BRANCH_COLOR_CURRENT = 4,
52         BRANCH_COLOR_UPSTREAM = 5
53 };
54
55 static enum merge_filter {
56         NO_FILTER = 0,
57         SHOW_NOT_MERGED,
58         SHOW_MERGED
59 } merge_filter;
60 static unsigned char merge_filter_ref[20];
61
62 static struct string_list output = STRING_LIST_INIT_DUP;
63 static unsigned int colopts;
64
65 static int parse_branch_color_slot(const char *slot)
66 {
67         if (!strcasecmp(slot, "plain"))
68                 return BRANCH_COLOR_PLAIN;
69         if (!strcasecmp(slot, "reset"))
70                 return BRANCH_COLOR_RESET;
71         if (!strcasecmp(slot, "remote"))
72                 return BRANCH_COLOR_REMOTE;
73         if (!strcasecmp(slot, "local"))
74                 return BRANCH_COLOR_LOCAL;
75         if (!strcasecmp(slot, "current"))
76                 return BRANCH_COLOR_CURRENT;
77         if (!strcasecmp(slot, "upstream"))
78                 return BRANCH_COLOR_UPSTREAM;
79         return -1;
80 }
81
82 static int git_branch_config(const char *var, const char *value, void *cb)
83 {
84         const char *slot_name;
85
86         if (starts_with(var, "column."))
87                 return git_column_config(var, value, "branch", &colopts);
88         if (!strcmp(var, "color.branch")) {
89                 branch_use_color = git_config_colorbool(var, value);
90                 return 0;
91         }
92         if (skip_prefix(var, "color.branch.", &slot_name)) {
93                 int slot = parse_branch_color_slot(slot_name);
94                 if (slot < 0)
95                         return 0;
96                 if (!value)
97                         return config_error_nonbool(var);
98                 return color_parse(value, branch_colors[slot]);
99         }
100         return git_color_default_config(var, value, cb);
101 }
102
103 static const char *branch_get_color(enum color_branch ix)
104 {
105         if (want_color(branch_use_color))
106                 return branch_colors[ix];
107         return "";
108 }
109
110 static int branch_merged(int kind, const char *name,
111                          struct commit *rev, struct commit *head_rev)
112 {
113         /*
114          * This checks whether the merge bases of branch and HEAD (or
115          * the other branch this branch builds upon) contains the
116          * branch, which means that the branch has already been merged
117          * safely to HEAD (or the other branch).
118          */
119         struct commit *reference_rev = NULL;
120         const char *reference_name = NULL;
121         void *reference_name_to_free = NULL;
122         int merged;
123
124         if (kind == REF_LOCAL_BRANCH) {
125                 struct branch *branch = branch_get(name);
126                 const char *upstream = branch_get_upstream(branch, NULL);
127                 unsigned char sha1[20];
128
129                 if (upstream &&
130                     (reference_name = reference_name_to_free =
131                      resolve_refdup(upstream, RESOLVE_REF_READING,
132                                     sha1, NULL)) != NULL)
133                         reference_rev = lookup_commit_reference(sha1);
134         }
135         if (!reference_rev)
136                 reference_rev = head_rev;
137
138         merged = in_merge_bases(rev, reference_rev);
139
140         /*
141          * After the safety valve is fully redefined to "check with
142          * upstream, if any, otherwise with HEAD", we should just
143          * return the result of the in_merge_bases() above without
144          * any of the following code, but during the transition period,
145          * a gentle reminder is in order.
146          */
147         if ((head_rev != reference_rev) &&
148             in_merge_bases(rev, head_rev) != merged) {
149                 if (merged)
150                         warning(_("deleting branch '%s' that has been merged to\n"
151                                 "         '%s', but not yet merged to HEAD."),
152                                 name, reference_name);
153                 else
154                         warning(_("not deleting branch '%s' that is not yet merged to\n"
155                                 "         '%s', even though it is merged to HEAD."),
156                                 name, reference_name);
157         }
158         free(reference_name_to_free);
159         return merged;
160 }
161
162 static int check_branch_commit(const char *branchname, const char *refname,
163                                const unsigned char *sha1, struct commit *head_rev,
164                                int kinds, int force)
165 {
166         struct commit *rev = lookup_commit_reference(sha1);
167         if (!rev) {
168                 error(_("Couldn't look up commit object for '%s'"), refname);
169                 return -1;
170         }
171         if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
172                 error(_("The branch '%s' is not fully merged.\n"
173                       "If you are sure you want to delete it, "
174                       "run 'git branch -D %s'."), branchname, branchname);
175                 return -1;
176         }
177         return 0;
178 }
179
180 static void delete_branch_config(const char *branchname)
181 {
182         struct strbuf buf = STRBUF_INIT;
183         strbuf_addf(&buf, "branch.%s", branchname);
184         if (git_config_rename_section(buf.buf, NULL) < 0)
185                 warning(_("Update of config-file failed"));
186         strbuf_release(&buf);
187 }
188
189 static int delete_branches(int argc, const char **argv, int force, int kinds,
190                            int quiet)
191 {
192         struct commit *head_rev = NULL;
193         unsigned char sha1[20];
194         char *name = NULL;
195         const char *fmt;
196         int i;
197         int ret = 0;
198         int remote_branch = 0;
199         struct strbuf bname = STRBUF_INIT;
200
201         switch (kinds) {
202         case REF_REMOTE_BRANCH:
203                 fmt = "refs/remotes/%s";
204                 /* For subsequent UI messages */
205                 remote_branch = 1;
206
207                 force = 1;
208                 break;
209         case REF_LOCAL_BRANCH:
210                 fmt = "refs/heads/%s";
211                 break;
212         default:
213                 die(_("cannot use -a with -d"));
214         }
215
216         if (!force) {
217                 head_rev = lookup_commit_reference(head_sha1);
218                 if (!head_rev)
219                         die(_("Couldn't look up commit object for HEAD"));
220         }
221         for (i = 0; i < argc; i++, strbuf_release(&bname)) {
222                 const char *target;
223                 int flags = 0;
224
225                 strbuf_branchname(&bname, argv[i]);
226                 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
227                         error(_("Cannot delete the branch '%s' "
228                               "which you are currently on."), bname.buf);
229                         ret = 1;
230                         continue;
231                 }
232
233                 free(name);
234
235                 name = mkpathdup(fmt, bname.buf);
236                 target = resolve_ref_unsafe(name,
237                                             RESOLVE_REF_READING
238                                             | RESOLVE_REF_NO_RECURSE
239                                             | RESOLVE_REF_ALLOW_BAD_NAME,
240                                             sha1, &flags);
241                 if (!target) {
242                         error(remote_branch
243                               ? _("remote-tracking branch '%s' not found.")
244                               : _("branch '%s' not found."), bname.buf);
245                         ret = 1;
246                         continue;
247                 }
248
249                 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
250                     check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
251                                         force)) {
252                         ret = 1;
253                         continue;
254                 }
255
256                 if (delete_ref(name, is_null_sha1(sha1) ? NULL : sha1,
257                                REF_NODEREF)) {
258                         error(remote_branch
259                               ? _("Error deleting remote-tracking branch '%s'")
260                               : _("Error deleting branch '%s'"),
261                               bname.buf);
262                         ret = 1;
263                         continue;
264                 }
265                 if (!quiet) {
266                         printf(remote_branch
267                                ? _("Deleted remote-tracking branch %s (was %s).\n")
268                                : _("Deleted branch %s (was %s).\n"),
269                                bname.buf,
270                                (flags & REF_ISBROKEN) ? "broken"
271                                : (flags & REF_ISSYMREF) ? target
272                                : find_unique_abbrev(sha1, DEFAULT_ABBREV));
273                 }
274                 delete_branch_config(bname.buf);
275         }
276
277         free(name);
278
279         return(ret);
280 }
281
282 struct ref_item {
283         char *name;
284         char *dest;
285         unsigned int kind;
286         struct commit *commit;
287         int ignore;
288 };
289
290 struct ref_list {
291         struct rev_info revs;
292         int index, alloc, verbose, abbrev;
293         struct ref_item *list;
294         struct commit_list *with_commit;
295         int kinds;
296 };
297
298 static char *resolve_symref(const char *src, const char *prefix)
299 {
300         unsigned char sha1[20];
301         int flag;
302         const char *dst;
303
304         dst = resolve_ref_unsafe(src, 0, sha1, &flag);
305         if (!(dst && (flag & REF_ISSYMREF)))
306                 return NULL;
307         if (prefix)
308                 skip_prefix(dst, prefix, &dst);
309         return xstrdup(dst);
310 }
311
312 struct append_ref_cb {
313         struct ref_list *ref_list;
314         const char **pattern;
315         int ret;
316 };
317
318 static int match_patterns(const char **pattern, const char *refname)
319 {
320         if (!*pattern)
321                 return 1; /* no pattern always matches */
322         while (*pattern) {
323                 if (!wildmatch(*pattern, refname, 0, NULL))
324                         return 1;
325                 pattern++;
326         }
327         return 0;
328 }
329
330 static int append_ref(const char *refname, const struct object_id *oid, int flags, void *cb_data)
331 {
332         struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
333         struct ref_list *ref_list = cb->ref_list;
334         struct ref_item *newitem;
335         struct commit *commit;
336         int kind, i;
337         const char *prefix, *orig_refname = refname;
338
339         static struct {
340                 int kind;
341                 const char *prefix;
342         } ref_kind[] = {
343                 { REF_LOCAL_BRANCH, "refs/heads/" },
344                 { REF_REMOTE_BRANCH, "refs/remotes/" },
345         };
346
347         /* Detect kind */
348         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
349                 prefix = ref_kind[i].prefix;
350                 if (skip_prefix(refname, prefix, &refname)) {
351                         kind = ref_kind[i].kind;
352                         break;
353                 }
354         }
355         if (ARRAY_SIZE(ref_kind) <= i)
356                 return 0;
357
358         /* Don't add types the caller doesn't want */
359         if ((kind & ref_list->kinds) == 0)
360                 return 0;
361
362         if (!match_patterns(cb->pattern, refname))
363                 return 0;
364
365         commit = NULL;
366         if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
367                 commit = lookup_commit_reference_gently(oid->hash, 1);
368                 if (!commit) {
369                         cb->ret = error(_("branch '%s' does not point at a commit"), refname);
370                         return 0;
371                 }
372
373                 /* Filter with with_commit if specified */
374                 if (!is_descendant_of(commit, ref_list->with_commit))
375                         return 0;
376
377                 if (merge_filter != NO_FILTER)
378                         add_pending_object(&ref_list->revs,
379                                            (struct object *)commit, refname);
380         }
381
382         ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
383
384         /* Record the new item */
385         newitem = &(ref_list->list[ref_list->index++]);
386         newitem->name = xstrdup(refname);
387         newitem->kind = kind;
388         newitem->commit = commit;
389         newitem->dest = resolve_symref(orig_refname, prefix);
390         newitem->ignore = 0;
391
392         return 0;
393 }
394
395 static void free_ref_list(struct ref_list *ref_list)
396 {
397         int i;
398
399         for (i = 0; i < ref_list->index; i++) {
400                 free(ref_list->list[i].name);
401                 free(ref_list->list[i].dest);
402         }
403         free(ref_list->list);
404 }
405
406 static int ref_cmp(const void *r1, const void *r2)
407 {
408         struct ref_item *c1 = (struct ref_item *)(r1);
409         struct ref_item *c2 = (struct ref_item *)(r2);
410
411         if (c1->kind != c2->kind)
412                 return c1->kind - c2->kind;
413         return strcmp(c1->name, c2->name);
414 }
415
416 static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
417                 int show_upstream_ref)
418 {
419         int ours, theirs;
420         char *ref = NULL;
421         struct branch *branch = branch_get(branch_name);
422         const char *upstream;
423         struct strbuf fancy = STRBUF_INIT;
424         int upstream_is_gone = 0;
425         int added_decoration = 1;
426
427         if (stat_tracking_info(branch, &ours, &theirs, &upstream) < 0) {
428                 if (!upstream)
429                         return;
430                 upstream_is_gone = 1;
431         }
432
433         if (show_upstream_ref) {
434                 ref = shorten_unambiguous_ref(upstream, 0);
435                 if (want_color(branch_use_color))
436                         strbuf_addf(&fancy, "%s%s%s",
437                                         branch_get_color(BRANCH_COLOR_UPSTREAM),
438                                         ref, branch_get_color(BRANCH_COLOR_RESET));
439                 else
440                         strbuf_addstr(&fancy, ref);
441         }
442
443         if (upstream_is_gone) {
444                 if (show_upstream_ref)
445                         strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
446                 else
447                         added_decoration = 0;
448         } else if (!ours && !theirs) {
449                 if (show_upstream_ref)
450                         strbuf_addf(stat, _("[%s]"), fancy.buf);
451                 else
452                         added_decoration = 0;
453         } else if (!ours) {
454                 if (show_upstream_ref)
455                         strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
456                 else
457                         strbuf_addf(stat, _("[behind %d]"), theirs);
458
459         } else if (!theirs) {
460                 if (show_upstream_ref)
461                         strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
462                 else
463                         strbuf_addf(stat, _("[ahead %d]"), ours);
464         } else {
465                 if (show_upstream_ref)
466                         strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
467                                     fancy.buf, ours, theirs);
468                 else
469                         strbuf_addf(stat, _("[ahead %d, behind %d]"),
470                                     ours, theirs);
471         }
472         strbuf_release(&fancy);
473         if (added_decoration)
474                 strbuf_addch(stat, ' ');
475         free(ref);
476 }
477
478 static void add_verbose_info(struct strbuf *out, struct ref_item *item,
479                              int verbose, int abbrev)
480 {
481         struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
482         const char *sub = _(" **** invalid ref ****");
483         struct commit *commit = item->commit;
484
485         if (!parse_commit(commit)) {
486                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
487                 sub = subject.buf;
488         }
489
490         if (item->kind == REF_LOCAL_BRANCH)
491                 fill_tracking_info(&stat, item->name, verbose > 1);
492
493         strbuf_addf(out, " %s %s%s",
494                 find_unique_abbrev(item->commit->object.sha1, abbrev),
495                 stat.buf, sub);
496         strbuf_release(&stat);
497         strbuf_release(&subject);
498 }
499
500 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
501                            int abbrev, int current, const char *remote_prefix)
502 {
503         char c;
504         int color;
505         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
506         const char *prefix = "";
507
508         if (item->ignore)
509                 return;
510
511         switch (item->kind) {
512         case REF_LOCAL_BRANCH:
513                 color = BRANCH_COLOR_LOCAL;
514                 break;
515         case REF_REMOTE_BRANCH:
516                 color = BRANCH_COLOR_REMOTE;
517                 prefix = remote_prefix;
518                 break;
519         default:
520                 color = BRANCH_COLOR_PLAIN;
521                 break;
522         }
523
524         c = ' ';
525         if (current) {
526                 c = '*';
527                 color = BRANCH_COLOR_CURRENT;
528         }
529
530         strbuf_addf(&name, "%s%s", prefix, item->name);
531         if (verbose) {
532                 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
533                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
534                             maxwidth + utf8_compensation, name.buf,
535                             branch_get_color(BRANCH_COLOR_RESET));
536         } else
537                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
538                             name.buf, branch_get_color(BRANCH_COLOR_RESET));
539
540         if (item->dest)
541                 strbuf_addf(&out, " -> %s", item->dest);
542         else if (verbose)
543                 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
544                 add_verbose_info(&out, item, verbose, abbrev);
545         if (column_active(colopts)) {
546                 assert(!verbose && "--column and --verbose are incompatible");
547                 string_list_append(&output, out.buf);
548         } else {
549                 printf("%s\n", out.buf);
550         }
551         strbuf_release(&name);
552         strbuf_release(&out);
553 }
554
555 static int calc_maxwidth(struct ref_list *refs, int remote_bonus)
556 {
557         int i, max = 0;
558         for (i = 0; i < refs->index; i++) {
559                 struct ref_item *it = &refs->list[i];
560                 int w;
561
562                 if (it->ignore)
563                         continue;
564                 w = utf8_strwidth(it->name);
565                 if (it->kind == REF_REMOTE_BRANCH)
566                         w += remote_bonus;
567                 if (w > max)
568                         max = w;
569         }
570         return max;
571 }
572
573 static char *get_head_description(void)
574 {
575         struct strbuf desc = STRBUF_INIT;
576         struct wt_status_state state;
577         memset(&state, 0, sizeof(state));
578         wt_status_get_state(&state, 1);
579         if (state.rebase_in_progress ||
580             state.rebase_interactive_in_progress)
581                 strbuf_addf(&desc, _("(no branch, rebasing %s)"),
582                             state.branch);
583         else if (state.bisect_in_progress)
584                 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
585                             state.branch);
586         else if (state.detached_from) {
587                 /* TRANSLATORS: make sure these match _("HEAD detached at ")
588                    and _("HEAD detached from ") in wt-status.c */
589                 if (state.detached_at)
590                         strbuf_addf(&desc, _("(HEAD detached at %s)"),
591                                 state.detached_from);
592                 else
593                         strbuf_addf(&desc, _("(HEAD detached from %s)"),
594                                 state.detached_from);
595         }
596         else
597                 strbuf_addstr(&desc, _("(no branch)"));
598         free(state.branch);
599         free(state.onto);
600         free(state.detached_from);
601         return strbuf_detach(&desc, NULL);
602 }
603
604 static void show_detached(struct ref_list *ref_list, int maxwidth)
605 {
606         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
607
608         if (head_commit && is_descendant_of(head_commit, ref_list->with_commit)) {
609                 struct ref_item item;
610                 item.name = get_head_description();
611                 item.kind = REF_LOCAL_BRANCH;
612                 item.dest = NULL;
613                 item.commit = head_commit;
614                 item.ignore = 0;
615                 print_ref_item(&item, maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
616                 free(item.name);
617         }
618 }
619
620 static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
621 {
622         int i;
623         struct append_ref_cb cb;
624         struct ref_list ref_list;
625         int maxwidth = 0;
626         const char *remote_prefix = "";
627
628         /*
629          * If we are listing more than just remote branches,
630          * then remote branches will have a "remotes/" prefix.
631          * We need to account for this in the width.
632          */
633         if (kinds != REF_REMOTE_BRANCH)
634                 remote_prefix = "remotes/";
635
636         memset(&ref_list, 0, sizeof(ref_list));
637         ref_list.kinds = kinds;
638         ref_list.verbose = verbose;
639         ref_list.abbrev = abbrev;
640         ref_list.with_commit = with_commit;
641         if (merge_filter != NO_FILTER)
642                 init_revisions(&ref_list.revs, NULL);
643         cb.ref_list = &ref_list;
644         cb.pattern = pattern;
645         cb.ret = 0;
646         for_each_rawref(append_ref, &cb);
647         /*
648          * The following implementation is currently duplicated in ref-filter. It
649          * will eventually be removed when we port branch.c to use ref-filter APIs.
650          */
651         if (merge_filter != NO_FILTER) {
652                 struct commit *filter;
653                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
654                 if (!filter)
655                         die(_("object '%s' does not point to a commit"),
656                             sha1_to_hex(merge_filter_ref));
657
658                 filter->object.flags |= UNINTERESTING;
659                 add_pending_object(&ref_list.revs,
660                                    (struct object *) filter, "");
661                 ref_list.revs.limited = 1;
662
663                 if (prepare_revision_walk(&ref_list.revs))
664                         die(_("revision walk setup failed"));
665
666                 for (i = 0; i < ref_list.index; i++) {
667                         struct ref_item *item = &ref_list.list[i];
668                         struct commit *commit = item->commit;
669                         int is_merged = !!(commit->object.flags & UNINTERESTING);
670                         item->ignore = is_merged != (merge_filter == SHOW_MERGED);
671                 }
672
673                 for (i = 0; i < ref_list.index; i++) {
674                         struct ref_item *item = &ref_list.list[i];
675                         clear_commit_marks(item->commit, ALL_REV_FLAGS);
676                 }
677                 clear_commit_marks(filter, ALL_REV_FLAGS);
678         }
679         if (verbose)
680                 maxwidth = calc_maxwidth(&ref_list, strlen(remote_prefix));
681
682         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
683
684         detached = (detached && (kinds & REF_LOCAL_BRANCH));
685         if (detached && match_patterns(pattern, "HEAD"))
686                 show_detached(&ref_list, maxwidth);
687
688         for (i = 0; i < ref_list.index; i++) {
689                 int current = !detached &&
690                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
691                         !strcmp(ref_list.list[i].name, head);
692                 print_ref_item(&ref_list.list[i], maxwidth, verbose,
693                                abbrev, current, remote_prefix);
694         }
695
696         free_ref_list(&ref_list);
697
698         if (cb.ret)
699                 error(_("some refs could not be read"));
700
701         return cb.ret;
702 }
703
704 static void rename_branch(const char *oldname, const char *newname, int force)
705 {
706         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
707         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
708         int recovery = 0;
709         int clobber_head_ok;
710
711         if (!oldname)
712                 die(_("cannot rename the current branch while not on any."));
713
714         if (strbuf_check_branch_ref(&oldref, oldname)) {
715                 /*
716                  * Bad name --- this could be an attempt to rename a
717                  * ref that we used to allow to be created by accident.
718                  */
719                 if (ref_exists(oldref.buf))
720                         recovery = 1;
721                 else
722                         die(_("Invalid branch name: '%s'"), oldname);
723         }
724
725         /*
726          * A command like "git branch -M currentbranch currentbranch" cannot
727          * cause the worktree to become inconsistent with HEAD, so allow it.
728          */
729         clobber_head_ok = !strcmp(oldname, newname);
730
731         validate_new_branchname(newname, &newref, force, clobber_head_ok);
732
733         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
734                  oldref.buf, newref.buf);
735
736         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
737                 die(_("Branch rename failed"));
738         strbuf_release(&logmsg);
739
740         if (recovery)
741                 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
742
743         /* no need to pass logmsg here as HEAD didn't really move */
744         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
745                 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
746
747         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
748         strbuf_release(&oldref);
749         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
750         strbuf_release(&newref);
751         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
752                 die(_("Branch is renamed, but update of config-file failed"));
753         strbuf_release(&oldsection);
754         strbuf_release(&newsection);
755 }
756
757 /*
758  * This function is duplicated in ref-filter. It will eventually be removed
759  * when we port branch.c to use ref-filter APIs.
760  */
761 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
762 {
763         merge_filter = ((opt->long_name[0] == 'n')
764                         ? SHOW_NOT_MERGED
765                         : SHOW_MERGED);
766         if (unset)
767                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
768         if (!arg)
769                 arg = "HEAD";
770         if (get_sha1(arg, merge_filter_ref))
771                 die(_("malformed object name %s"), arg);
772         return 0;
773 }
774
775 static const char edit_description[] = "BRANCH_DESCRIPTION";
776
777 static int edit_branch_description(const char *branch_name)
778 {
779         int status;
780         struct strbuf buf = STRBUF_INIT;
781         struct strbuf name = STRBUF_INIT;
782
783         read_branch_desc(&buf, branch_name);
784         if (!buf.len || buf.buf[buf.len-1] != '\n')
785                 strbuf_addch(&buf, '\n');
786         strbuf_commented_addf(&buf,
787                     "Please edit the description for the branch\n"
788                     "  %s\n"
789                     "Lines starting with '%c' will be stripped.\n",
790                     branch_name, comment_line_char);
791         if (write_file(git_path(edit_description), 0, "%s", buf.buf)) {
792                 strbuf_release(&buf);
793                 return error(_("could not write branch description template: %s"),
794                              strerror(errno));
795         }
796         strbuf_reset(&buf);
797         if (launch_editor(git_path(edit_description), &buf, NULL)) {
798                 strbuf_release(&buf);
799                 return -1;
800         }
801         stripspace(&buf, 1);
802
803         strbuf_addf(&name, "branch.%s.description", branch_name);
804         status = git_config_set(name.buf, buf.len ? buf.buf : NULL);
805         strbuf_release(&name);
806         strbuf_release(&buf);
807
808         return status;
809 }
810
811 int cmd_branch(int argc, const char **argv, const char *prefix)
812 {
813         int delete = 0, rename = 0, force = 0, list = 0;
814         int verbose = 0, abbrev = -1, detached = 0;
815         int reflog = 0, edit_description = 0;
816         int quiet = 0, unset_upstream = 0;
817         const char *new_upstream = NULL;
818         enum branch_track track;
819         int kinds = REF_LOCAL_BRANCH;
820         struct commit_list *with_commit = NULL;
821
822         struct option options[] = {
823                 OPT_GROUP(N_("Generic options")),
824                 OPT__VERBOSE(&verbose,
825                         N_("show hash and subject, give twice for upstream branch")),
826                 OPT__QUIET(&quiet, N_("suppress informational messages")),
827                 OPT_SET_INT('t', "track",  &track, N_("set up tracking mode (see git-pull(1))"),
828                         BRANCH_TRACK_EXPLICIT),
829                 OPT_SET_INT( 0, "set-upstream",  &track, N_("change upstream info"),
830                         BRANCH_TRACK_OVERRIDE),
831                 OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
832                 OPT_BOOL(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
833                 OPT__COLOR(&branch_use_color, N_("use colored output")),
834                 OPT_SET_INT('r', "remotes",     &kinds, N_("act on remote-tracking branches"),
835                         REF_REMOTE_BRANCH),
836                 OPT_CONTAINS(&with_commit, N_("print only branches that contain the commit")),
837                 OPT_WITH(&with_commit, N_("print only branches that contain the commit")),
838                 OPT__ABBREV(&abbrev),
839
840                 OPT_GROUP(N_("Specific git-branch actions:")),
841                 OPT_SET_INT('a', "all", &kinds, N_("list both remote-tracking and local branches"),
842                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
843                 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
844                 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
845                 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
846                 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
847                 OPT_BOOL(0, "list", &list, N_("list branch names")),
848                 OPT_BOOL('l', "create-reflog", &reflog, N_("create the branch's reflog")),
849                 OPT_BOOL(0, "edit-description", &edit_description,
850                          N_("edit the description for the branch")),
851                 OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
852                 {
853                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
854                         N_("commit"), N_("print only not merged branches"),
855                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
856                         opt_parse_merge_filter, (intptr_t) "HEAD",
857                 },
858                 {
859                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
860                         N_("commit"), N_("print only merged branches"),
861                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
862                         opt_parse_merge_filter, (intptr_t) "HEAD",
863                 },
864                 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
865                 OPT_END(),
866         };
867
868         if (argc == 2 && !strcmp(argv[1], "-h"))
869                 usage_with_options(builtin_branch_usage, options);
870
871         git_config(git_branch_config, NULL);
872
873         track = git_branch_track;
874
875         head = resolve_refdup("HEAD", 0, head_sha1, NULL);
876         if (!head)
877                 die(_("Failed to resolve HEAD as a valid ref."));
878         if (!strcmp(head, "HEAD"))
879                 detached = 1;
880         else if (!skip_prefix(head, "refs/heads/", &head))
881                 die(_("HEAD not found below refs/heads!"));
882         hashcpy(merge_filter_ref, head_sha1);
883
884
885         argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
886                              0);
887
888         if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
889                 list = 1;
890
891         if (with_commit || merge_filter != NO_FILTER)
892                 list = 1;
893
894         if (!!delete + !!rename + !!new_upstream +
895             list + unset_upstream > 1)
896                 usage_with_options(builtin_branch_usage, options);
897
898         if (abbrev == -1)
899                 abbrev = DEFAULT_ABBREV;
900         finalize_colopts(&colopts, -1);
901         if (verbose) {
902                 if (explicitly_enable_column(colopts))
903                         die(_("--column and --verbose are incompatible"));
904                 colopts = 0;
905         }
906
907         if (force) {
908                 delete *= 2;
909                 rename *= 2;
910         }
911
912         if (delete) {
913                 if (!argc)
914                         die(_("branch name required"));
915                 return delete_branches(argc, argv, delete > 1, kinds, quiet);
916         } else if (list) {
917                 int ret = print_ref_list(kinds, detached, verbose, abbrev,
918                                          with_commit, argv);
919                 print_columns(&output, colopts, NULL);
920                 string_list_clear(&output, 0);
921                 return ret;
922         }
923         else if (edit_description) {
924                 const char *branch_name;
925                 struct strbuf branch_ref = STRBUF_INIT;
926
927                 if (!argc) {
928                         if (detached)
929                                 die(_("Cannot give description to detached HEAD"));
930                         branch_name = head;
931                 } else if (argc == 1)
932                         branch_name = argv[0];
933                 else
934                         die(_("cannot edit description of more than one branch"));
935
936                 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
937                 if (!ref_exists(branch_ref.buf)) {
938                         strbuf_release(&branch_ref);
939
940                         if (!argc)
941                                 return error(_("No commit on branch '%s' yet."),
942                                              branch_name);
943                         else
944                                 return error(_("No branch named '%s'."),
945                                              branch_name);
946                 }
947                 strbuf_release(&branch_ref);
948
949                 if (edit_branch_description(branch_name))
950                         return 1;
951         } else if (rename) {
952                 if (!argc)
953                         die(_("branch name required"));
954                 else if (argc == 1)
955                         rename_branch(head, argv[0], rename > 1);
956                 else if (argc == 2)
957                         rename_branch(argv[0], argv[1], rename > 1);
958                 else
959                         die(_("too many branches for a rename operation"));
960         } else if (new_upstream) {
961                 struct branch *branch = branch_get(argv[0]);
962
963                 if (argc > 1)
964                         die(_("too many branches to set new upstream"));
965
966                 if (!branch) {
967                         if (!argc || !strcmp(argv[0], "HEAD"))
968                                 die(_("could not set upstream of HEAD to %s when "
969                                       "it does not point to any branch."),
970                                     new_upstream);
971                         die(_("no such branch '%s'"), argv[0]);
972                 }
973
974                 if (!ref_exists(branch->refname))
975                         die(_("branch '%s' does not exist"), branch->name);
976
977                 /*
978                  * create_branch takes care of setting up the tracking
979                  * info and making sure new_upstream is correct
980                  */
981                 create_branch(head, branch->name, new_upstream, 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
982         } else if (unset_upstream) {
983                 struct branch *branch = branch_get(argv[0]);
984                 struct strbuf buf = STRBUF_INIT;
985
986                 if (argc > 1)
987                         die(_("too many branches to unset upstream"));
988
989                 if (!branch) {
990                         if (!argc || !strcmp(argv[0], "HEAD"))
991                                 die(_("could not unset upstream of HEAD when "
992                                       "it does not point to any branch."));
993                         die(_("no such branch '%s'"), argv[0]);
994                 }
995
996                 if (!branch_has_merge_config(branch))
997                         die(_("Branch '%s' has no upstream information"), branch->name);
998
999                 strbuf_addf(&buf, "branch.%s.remote", branch->name);
1000                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
1001                 strbuf_reset(&buf);
1002                 strbuf_addf(&buf, "branch.%s.merge", branch->name);
1003                 git_config_set_multivar(buf.buf, NULL, NULL, 1);
1004                 strbuf_release(&buf);
1005         } else if (argc > 0 && argc <= 2) {
1006                 struct branch *branch = branch_get(argv[0]);
1007                 int branch_existed = 0, remote_tracking = 0;
1008                 struct strbuf buf = STRBUF_INIT;
1009
1010                 if (!strcmp(argv[0], "HEAD"))
1011                         die(_("it does not make sense to create 'HEAD' manually"));
1012
1013                 if (!branch)
1014                         die(_("no such branch '%s'"), argv[0]);
1015
1016                 if (kinds != REF_LOCAL_BRANCH)
1017                         die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
1018
1019                 if (track == BRANCH_TRACK_OVERRIDE)
1020                         fprintf(stderr, _("The --set-upstream flag is deprecated and will be removed. Consider using --track or --set-upstream-to\n"));
1021
1022                 strbuf_addf(&buf, "refs/remotes/%s", branch->name);
1023                 remote_tracking = ref_exists(buf.buf);
1024                 strbuf_release(&buf);
1025
1026                 branch_existed = ref_exists(branch->refname);
1027                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
1028                               force, reflog, 0, quiet, track);
1029
1030                 /*
1031                  * We only show the instructions if the user gave us
1032                  * one branch which doesn't exist locally, but is the
1033                  * name of a remote-tracking branch.
1034                  */
1035                 if (argc == 1 && track == BRANCH_TRACK_OVERRIDE &&
1036                     !branch_existed && remote_tracking) {
1037                         fprintf(stderr, _("\nIf you wanted to make '%s' track '%s', do this:\n\n"), head, branch->name);
1038                         fprintf(stderr, _("    git branch -d %s\n"), branch->name);
1039                         fprintf(stderr, _("    git branch --set-upstream-to %s\n"), branch->name);
1040                 }
1041
1042         } else
1043                 usage_with_options(builtin_branch_usage, options);
1044
1045         return 0;
1046 }