branch: refactor width computation
[git/git.git] / builtin / branch.c
CommitLineData
c31820c2
LH
1/*
2 * Builtin "git branch"
3 *
d972cce0 4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
c31820c2
LH
5 * Based on git-branch.sh by Junio C Hamano.
6 */
7
8#include "cache.h"
85023577 9#include "color.h"
c31820c2
LH
10#include "refs.h"
11#include "commit.h"
12#include "builtin.h"
6f084a56 13#include "remote.h"
a8dfd5ea 14#include "parse-options.h"
e496c003 15#include "branch.h"
68067ca1
JH
16#include "diff.h"
17#include "revision.h"
ebe31ef2
NTND
18#include "string-list.h"
19#include "column.h"
1452bd64 20#include "utf8.h"
c8183cd2 21#include "wt-status.h"
a8dfd5ea
PH
22
23static const char * const builtin_branch_usage[] = {
9c9b4f2f
AH
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>"),
a8dfd5ea
PH
28 NULL
29};
c31820c2 30
f3d985c3
JH
31#define REF_LOCAL_BRANCH 0x01
32#define REF_REMOTE_BRANCH 0x02
c31820c2
LH
33
34static const char *head;
35static unsigned char head_sha1[20];
36
6b2f2d98 37static int branch_use_color = -1;
a1158cae 38static char branch_colors[][COLOR_MAXLEN] = {
dc6ebd4c
AL
39 GIT_COLOR_RESET,
40 GIT_COLOR_NORMAL, /* PLAIN */
41 GIT_COLOR_RED, /* REMOTE */
42 GIT_COLOR_NORMAL, /* LOCAL */
43 GIT_COLOR_GREEN, /* CURRENT */
dbda21fa 44 GIT_COLOR_BLUE, /* UPSTREAM */
a1158cae
AP
45};
46enum color_branch {
74bb2dfb
AL
47 BRANCH_COLOR_RESET = 0,
48 BRANCH_COLOR_PLAIN = 1,
49 BRANCH_COLOR_REMOTE = 2,
50 BRANCH_COLOR_LOCAL = 3,
dbda21fa
FC
51 BRANCH_COLOR_CURRENT = 4,
52 BRANCH_COLOR_UPSTREAM = 5
a1158cae
AP
53};
54
049716b3
JH
55static enum merge_filter {
56 NO_FILTER = 0,
57 SHOW_NOT_MERGED,
4b05548f 58 SHOW_MERGED
049716b3
JH
59} merge_filter;
60static unsigned char merge_filter_ref[20];
e8b404c2 61
ebe31ef2
NTND
62static struct string_list output = STRING_LIST_INIT_DUP;
63static unsigned int colopts;
64
8852117a 65static int parse_branch_color_slot(const char *slot)
a1158cae 66{
8852117a 67 if (!strcasecmp(slot, "plain"))
74bb2dfb 68 return BRANCH_COLOR_PLAIN;
8852117a 69 if (!strcasecmp(slot, "reset"))
74bb2dfb 70 return BRANCH_COLOR_RESET;
8852117a 71 if (!strcasecmp(slot, "remote"))
74bb2dfb 72 return BRANCH_COLOR_REMOTE;
8852117a 73 if (!strcasecmp(slot, "local"))
74bb2dfb 74 return BRANCH_COLOR_LOCAL;
8852117a 75 if (!strcasecmp(slot, "current"))
74bb2dfb 76 return BRANCH_COLOR_CURRENT;
8852117a 77 if (!strcasecmp(slot, "upstream"))
dbda21fa 78 return BRANCH_COLOR_UPSTREAM;
8b8e8624 79 return -1;
a1158cae
AP
80}
81
ef90d6d4 82static int git_branch_config(const char *var, const char *value, void *cb)
a1158cae 83{
e3f1da98
RS
84 const char *slot_name;
85
59556548 86 if (starts_with(var, "column."))
ebe31ef2 87 return git_column_config(var, value, "branch", &colopts);
a1158cae 88 if (!strcmp(var, "color.branch")) {
e269eb79 89 branch_use_color = git_config_colorbool(var, value);
a1158cae
AP
90 return 0;
91 }
e3f1da98 92 if (skip_prefix(var, "color.branch.", &slot_name)) {
b9465768 93 int slot = parse_branch_color_slot(slot_name);
8b8e8624
JK
94 if (slot < 0)
95 return 0;
5768c98a
JH
96 if (!value)
97 return config_error_nonbool(var);
f6c5a296 98 return color_parse(value, branch_colors[slot]);
a1158cae 99 }
ef90d6d4 100 return git_color_default_config(var, value, cb);
a1158cae
AP
101}
102
52fae7de 103static const char *branch_get_color(enum color_branch ix)
a1158cae 104{
daa0c3d9 105 if (want_color(branch_use_color))
a1158cae
AP
106 return branch_colors[ix];
107 return "";
108}
109
99c419c9
JH
110static 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;
96ec7b1e 121 void *reference_name_to_free = NULL;
99c419c9
JH
122 int merged;
123
124 if (kind == REF_LOCAL_BRANCH) {
125 struct branch *branch = branch_get(name);
3a429d0a 126 const char *upstream = branch_get_upstream(branch, NULL);
99c419c9
JH
127 unsigned char sha1[20];
128
a9f9f8cc 129 if (upstream &&
96ec7b1e 130 (reference_name = reference_name_to_free =
a9f9f8cc 131 resolve_refdup(upstream, RESOLVE_REF_READING,
7695d118 132 sha1, NULL)) != NULL)
99c419c9
JH
133 reference_rev = lookup_commit_reference(sha1);
134 }
135 if (!reference_rev)
136 reference_rev = head_rev;
137
a20efee9 138 merged = in_merge_bases(rev, reference_rev);
99c419c9
JH
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) &&
a20efee9 148 in_merge_bases(rev, head_rev) != merged) {
99c419c9 149 if (merged)
49df4b02 150 warning(_("deleting branch '%s' that has been merged to\n"
6c80cd29 151 " '%s', but not yet merged to HEAD."),
99c419c9
JH
152 name, reference_name);
153 else
49df4b02
ÆAB
154 warning(_("not deleting branch '%s' that is not yet merged to\n"
155 " '%s', even though it is merged to HEAD."),
99c419c9
JH
156 name, reference_name);
157 }
96ec7b1e 158 free(reference_name_to_free);
99c419c9
JH
159 return merged;
160}
161
f5d0e162 162static int check_branch_commit(const char *branchname, const char *refname,
4eaa4bd8 163 const unsigned char *sha1, struct commit *head_rev,
f5d0e162
RS
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
22ed7927
RS
180static 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
d65ddf19
JK
189static int delete_branches(int argc, const char **argv, int force, int kinds,
190 int quiet)
c31820c2 191{
f5d0e162 192 struct commit *head_rev = NULL;
c31820c2 193 unsigned char sha1[20];
b8e9a00d 194 char *name = NULL;
c179837c 195 const char *fmt;
c31820c2 196 int i;
b8e9a00d 197 int ret = 0;
c179837c 198 int remote_branch = 0;
8415d5c7 199 struct strbuf bname = STRBUF_INIT;
c31820c2 200
f3d985c3
JH
201 switch (kinds) {
202 case REF_REMOTE_BRANCH:
203 fmt = "refs/remotes/%s";
c179837c
ÆAB
204 /* For subsequent UI messages */
205 remote_branch = 1;
206
f3d985c3
JH
207 force = 1;
208 break;
209 case REF_LOCAL_BRANCH:
210 fmt = "refs/heads/%s";
f3d985c3
JH
211 break;
212 default:
49df4b02 213 die(_("cannot use -a with -d"));
f3d985c3 214 }
c31820c2 215
67affd51
JH
216 if (!force) {
217 head_rev = lookup_commit_reference(head_sha1);
218 if (!head_rev)
49df4b02 219 die(_("Couldn't look up commit object for HEAD"));
67affd51 220 }
8415d5c7 221 for (i = 0; i < argc; i++, strbuf_release(&bname)) {
0fe700e3
RS
222 const char *target;
223 int flags = 0;
224
a552de75 225 strbuf_branchname(&bname, argv[i]);
8415d5c7 226 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, bname.buf)) {
49df4b02
ÆAB
227 error(_("Cannot delete the branch '%s' "
228 "which you are currently on."), bname.buf);
b8e9a00d
QT
229 ret = 1;
230 continue;
231 }
232
8e0f7003 233 free(name);
c31820c2 234
4e2d094d 235 name = mkpathdup(fmt, bname.buf);
18f29fc6
RS
236 target = resolve_ref_unsafe(name,
237 RESOLVE_REF_READING
d0f810f0
RS
238 | RESOLVE_REF_NO_RECURSE
239 | RESOLVE_REF_ALLOW_BAD_NAME,
62a2d525 240 sha1, &flags);
18f29fc6 241 if (!target) {
c179837c 242 error(remote_branch
ccd593cf 243 ? _("remote-tracking branch '%s' not found.")
c179837c 244 : _("branch '%s' not found."), bname.buf);
b8e9a00d
QT
245 ret = 1;
246 continue;
247 }
c31820c2 248
d0f810f0 249 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
0fe700e3 250 check_branch_commit(bname.buf, name, sha1, head_rev, kinds,
f5d0e162 251 force)) {
b8e9a00d
QT
252 ret = 1;
253 continue;
c31820c2
LH
254 }
255
1c03c4d3
MH
256 if (delete_ref(name, is_null_sha1(sha1) ? NULL : sha1,
257 REF_NODEREF)) {
c179837c 258 error(remote_branch
ccd593cf 259 ? _("Error deleting remote-tracking branch '%s'")
c179837c 260 : _("Error deleting branch '%s'"),
8415d5c7 261 bname.buf);
b8e9a00d 262 ret = 1;
13baa9fe
RS
263 continue;
264 }
265 if (!quiet) {
266 printf(remote_branch
ccd593cf 267 ? _("Deleted remote-tracking branch %s (was %s).\n")
13baa9fe
RS
268 : _("Deleted branch %s (was %s).\n"),
269 bname.buf,
d0f810f0
RS
270 (flags & REF_ISBROKEN) ? "broken"
271 : (flags & REF_ISSYMREF) ? target
13baa9fe 272 : find_unique_abbrev(sha1, DEFAULT_ABBREV));
f1eccbab 273 }
13baa9fe 274 delete_branch_config(bname.buf);
c31820c2 275 }
c31820c2 276
8e0f7003 277 free(name);
b8e9a00d
QT
278
279 return(ret);
c31820c2 280}
c31820c2 281
bfcc9214
AP
282struct ref_item {
283 char *name;
209d336a 284 char *dest;
1051e40d 285 unsigned int kind;
68067ca1 286 struct commit *commit;
8376a704 287 int ignore;
bfcc9214
AP
288};
289
290struct ref_list {
68067ca1 291 struct rev_info revs;
1051e40d 292 int index, alloc, verbose, abbrev;
bfcc9214 293 struct ref_item *list;
694a5775 294 struct commit_list *with_commit;
bfcc9214
AP
295 int kinds;
296};
297
209d336a
JS
298static char *resolve_symref(const char *src, const char *prefix)
299{
300 unsigned char sha1[20];
301 int flag;
cf4fff57 302 const char *dst;
209d336a 303
7695d118 304 dst = resolve_ref_unsafe(src, 0, sha1, &flag);
209d336a
JS
305 if (!(dst && (flag & REF_ISSYMREF)))
306 return NULL;
cf4fff57
JK
307 if (prefix)
308 skip_prefix(dst, prefix, &dst);
209d336a
JS
309 return xstrdup(dst);
310}
311
1603ade8
SM
312struct append_ref_cb {
313 struct ref_list *ref_list;
d8d33736 314 const char **pattern;
1603ade8
SM
315 int ret;
316};
317
d8d33736
MG
318static int match_patterns(const char **pattern, const char *refname)
319{
320 if (!*pattern)
321 return 1; /* no pattern always matches */
322 while (*pattern) {
eb07894f 323 if (!wildmatch(*pattern, refname, 0, NULL))
d8d33736
MG
324 return 1;
325 pattern++;
326 }
327 return 0;
328}
329
a55ce971 330static int append_ref(const char *refname, const struct object_id *oid, int flags, void *cb_data)
c31820c2 331{
1603ade8
SM
332 struct append_ref_cb *cb = (struct append_ref_cb *)(cb_data);
333 struct ref_list *ref_list = cb->ref_list;
bfcc9214 334 struct ref_item *newitem;
68067ca1 335 struct commit *commit;
209d336a
JS
336 int kind, i;
337 const char *prefix, *orig_refname = refname;
338
339 static struct {
340 int kind;
341 const char *prefix;
209d336a 342 } ref_kind[] = {
e3f1da98
RS
343 { REF_LOCAL_BRANCH, "refs/heads/" },
344 { REF_REMOTE_BRANCH, "refs/remotes/" },
209d336a 345 };
bfcc9214
AP
346
347 /* Detect kind */
209d336a
JS
348 for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
349 prefix = ref_kind[i].prefix;
e3f1da98
RS
350 if (skip_prefix(refname, prefix, &refname)) {
351 kind = ref_kind[i].kind;
352 break;
353 }
209d336a
JS
354 }
355 if (ARRAY_SIZE(ref_kind) <= i)
0f31d680 356 return 0;
bfcc9214
AP
357
358 /* Don't add types the caller doesn't want */
359 if ((kind & ref_list->kinds) == 0)
360 return 0;
361
d8d33736
MG
362 if (!match_patterns(cb->pattern, refname))
363 return 0;
364
191d1ac4
LT
365 commit = NULL;
366 if (ref_list->verbose || ref_list->with_commit || merge_filter != NO_FILTER) {
a55ce971 367 commit = lookup_commit_reference_gently(oid->hash, 1);
1603ade8 368 if (!commit) {
49df4b02 369 cb->ret = error(_("branch '%s' does not point at a commit"), refname);
0e9716e6 370 return 0;
1603ade8 371 }
68067ca1 372
191d1ac4
LT
373 /* Filter with with_commit if specified */
374 if (!is_descendant_of(commit, ref_list->with_commit))
375 return 0;
694a5775 376
191d1ac4
LT
377 if (merge_filter != NO_FILTER)
378 add_pending_object(&ref_list->revs,
379 (struct object *)commit, refname);
380 }
e8b404c2 381
fcbc0d8e 382 ALLOC_GROW(ref_list->list, ref_list->index + 1, ref_list->alloc);
c31820c2 383
bfcc9214
AP
384 /* Record the new item */
385 newitem = &(ref_list->list[ref_list->index++]);
386 newitem->name = xstrdup(refname);
387 newitem->kind = kind;
68067ca1 388 newitem->commit = commit;
209d336a 389 newitem->dest = resolve_symref(orig_refname, prefix);
8376a704 390 newitem->ignore = 0;
c31820c2
LH
391
392 return 0;
393}
394
bfcc9214
AP
395static void free_ref_list(struct ref_list *ref_list)
396{
397 int i;
398
209d336a 399 for (i = 0; i < ref_list->index; i++) {
bfcc9214 400 free(ref_list->list[i].name);
209d336a
JS
401 free(ref_list->list[i].dest);
402 }
bfcc9214
AP
403 free(ref_list->list);
404}
405
c31820c2
LH
406static int ref_cmp(const void *r1, const void *r2)
407{
bfcc9214
AP
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);
c31820c2
LH
414}
415
2d8a7f0b
JK
416static void fill_tracking_info(struct strbuf *stat, const char *branch_name,
417 int show_upstream_ref)
94fcb730
JH
418{
419 int ours, theirs;
21dfc09d 420 char *ref = NULL;
94fcb730 421 struct branch *branch = branch_get(branch_name);
979cb245 422 const char *upstream;
dbda21fa 423 struct strbuf fancy = STRBUF_INIT;
f2e08739 424 int upstream_is_gone = 0;
6b364d48 425 int added_decoration = 1;
94fcb730 426
979cb245
JK
427 if (stat_tracking_info(branch, &ours, &theirs, &upstream) < 0) {
428 if (!upstream)
429 return;
f2e08739 430 upstream_is_gone = 1;
2d8a7f0b
JK
431 }
432
dbda21fa 433 if (show_upstream_ref) {
979cb245 434 ref = shorten_unambiguous_ref(upstream, 0);
dbda21fa
FC
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
f2e08739
JX
443 if (upstream_is_gone) {
444 if (show_upstream_ref)
445 strbuf_addf(stat, _("[%s: gone]"), fancy.buf);
6b364d48
TH
446 else
447 added_decoration = 0;
f2e08739
JX
448 } else if (!ours && !theirs) {
449 if (show_upstream_ref)
450 strbuf_addf(stat, _("[%s]"), fancy.buf);
6b364d48
TH
451 else
452 added_decoration = 0;
f2e08739
JX
453 } else if (!ours) {
454 if (show_upstream_ref)
dbda21fa 455 strbuf_addf(stat, _("[%s: behind %d]"), fancy.buf, theirs);
21dfc09d
NTND
456 else
457 strbuf_addf(stat, _("[behind %d]"), theirs);
458
459 } else if (!theirs) {
f2e08739 460 if (show_upstream_ref)
dbda21fa 461 strbuf_addf(stat, _("[%s: ahead %d]"), fancy.buf, ours);
21dfc09d
NTND
462 else
463 strbuf_addf(stat, _("[ahead %d]"), ours);
464 } else {
f2e08739 465 if (show_upstream_ref)
21dfc09d 466 strbuf_addf(stat, _("[%s: ahead %d, behind %d]"),
dbda21fa 467 fancy.buf, ours, theirs);
21dfc09d
NTND
468 else
469 strbuf_addf(stat, _("[ahead %d, behind %d]"),
470 ours, theirs);
471 }
dbda21fa 472 strbuf_release(&fancy);
6b364d48
TH
473 if (added_decoration)
474 strbuf_addch(stat, ' ');
21dfc09d 475 free(ref);
94fcb730
JH
476}
477
6e0332ec
JN
478static 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;
045e3884 482 const char *sub = _(" **** invalid ref ****");
6e0332ec
JN
483 struct commit *commit = item->commit;
484
5e7d4d3e 485 if (!parse_commit(commit)) {
f67d2e82 486 pp_commit_easy(CMIT_FMT_ONELINE, commit, &subject);
6e0332ec
JN
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
af0e4ac0 500static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
1051e40d 501 int abbrev, int current, const char *remote_prefix)
75e6e213 502{
af0e4ac0
LH
503 char c;
504 int color;
209d336a 505 struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
1051e40d 506 const char *prefix = "";
68067ca1 507
8376a704 508 if (item->ignore)
7950cda7 509 return;
75e6e213 510
af0e4ac0
LH
511 switch (item->kind) {
512 case REF_LOCAL_BRANCH:
74bb2dfb 513 color = BRANCH_COLOR_LOCAL;
af0e4ac0
LH
514 break;
515 case REF_REMOTE_BRANCH:
74bb2dfb 516 color = BRANCH_COLOR_REMOTE;
1051e40d 517 prefix = remote_prefix;
af0e4ac0
LH
518 break;
519 default:
74bb2dfb 520 color = BRANCH_COLOR_PLAIN;
af0e4ac0
LH
521 break;
522 }
75e6e213 523
af0e4ac0
LH
524 c = ' ';
525 if (current) {
526 c = '*';
74bb2dfb 527 color = BRANCH_COLOR_CURRENT;
af0e4ac0 528 }
75e6e213 529
209d336a 530 strbuf_addf(&name, "%s%s", prefix, item->name);
1452bd64
NTND
531 if (verbose) {
532 int utf8_compensation = strlen(name.buf) - utf8_strwidth(name.buf);
209d336a 533 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
1452bd64 534 maxwidth + utf8_compensation, name.buf,
81474267 535 branch_get_color(BRANCH_COLOR_RESET));
1452bd64 536 } else
209d336a 537 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
81474267 538 name.buf, branch_get_color(BRANCH_COLOR_RESET));
209d336a
JS
539
540 if (item->dest)
541 strbuf_addf(&out, " -> %s", item->dest);
6e0332ec
JN
542 else if (verbose)
543 /* " f7c0c00 [ahead 58, behind 197] vcs-svn: drop obj_pool.h" */
544 add_verbose_info(&out, item, verbose, abbrev);
ebe31ef2
NTND
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 }
209d336a
JS
551 strbuf_release(&name);
552 strbuf_release(&out);
75e6e213
LH
553}
554
1051e40d 555static int calc_maxwidth(struct ref_list *refs, int remote_bonus)
b6f637d1 556{
1051e40d 557 int i, max = 0;
b6f637d1 558 for (i = 0; i < refs->index; i++) {
1051e40d
KN
559 struct ref_item *it = &refs->list[i];
560 int w;
561
562 if (it->ignore)
b6f637d1 563 continue;
1051e40d
KN
564 w = utf8_strwidth(it->name);
565 if (it->kind == REF_REMOTE_BRANCH)
566 w += remote_bonus;
567 if (w > max)
568 max = w;
b6f637d1 569 }
1051e40d 570 return max;
b6f637d1
LH
571}
572
c8183cd2
NTND
573static 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)
6deab24d 584 strbuf_addf(&desc, _("(no branch, bisect started on %s)"),
c8183cd2 585 state.branch);
4b063186
MG
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 }
c8183cd2
NTND
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}
7e9ff00b 603
1051e40d 604static void show_detached(struct ref_list *ref_list, int maxwidth)
7e9ff00b
LT
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;
c8183cd2 610 item.name = get_head_description();
7e9ff00b
LT
611 item.kind = REF_LOCAL_BRANCH;
612 item.dest = NULL;
613 item.commit = head_commit;
8376a704 614 item.ignore = 0;
1051e40d 615 print_ref_item(&item, maxwidth, ref_list->verbose, ref_list->abbrev, 1, "");
7e9ff00b
LT
616 free(item.name);
617 }
618}
619
d8d33736 620static int print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit, const char **pattern)
c31820c2
LH
621{
622 int i;
1603ade8 623 struct append_ref_cb cb;
bfcc9214 624 struct ref_list ref_list;
1051e40d
KN
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/";
c31820c2 635
bfcc9214
AP
636 memset(&ref_list, 0, sizeof(ref_list));
637 ref_list.kinds = kinds;
191d1ac4 638 ref_list.verbose = verbose;
7e9ff00b 639 ref_list.abbrev = abbrev;
694a5775 640 ref_list.with_commit = with_commit;
68067ca1
JH
641 if (merge_filter != NO_FILTER)
642 init_revisions(&ref_list.revs, NULL);
1603ade8 643 cb.ref_list = &ref_list;
d8d33736 644 cb.pattern = pattern;
1603ade8
SM
645 cb.ret = 0;
646 for_each_rawref(append_ref, &cb);
35257aa0
KN
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 */
68067ca1
JH
651 if (merge_filter != NO_FILTER) {
652 struct commit *filter;
653 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
6c41e975 654 if (!filter)
045e3884 655 die(_("object '%s' does not point to a commit"),
6c41e975
CMN
656 sha1_to_hex(merge_filter_ref));
657
68067ca1
JH
658 filter->object.flags |= UNINTERESTING;
659 add_pending_object(&ref_list.revs,
660 (struct object *) filter, "");
661 ref_list.revs.limited = 1;
81c3ce3c
SB
662
663 if (prepare_revision_walk(&ref_list.revs))
664 die(_("revision walk setup failed"));
8376a704
JK
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);
68067ca1 678 }
1051e40d
KN
679 if (verbose)
680 maxwidth = calc_maxwidth(&ref_list, strlen(remote_prefix));
c31820c2 681
bfcc9214 682 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
c31820c2 683
0016a482 684 detached = (detached && (kinds & REF_LOCAL_BRANCH));
d8d33736 685 if (detached && match_patterns(pattern, "HEAD"))
1051e40d 686 show_detached(&ref_list, maxwidth);
0016a482 687
bfcc9214 688 for (i = 0; i < ref_list.index; i++) {
0016a482
LH
689 int current = !detached &&
690 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
af0e4ac0 691 !strcmp(ref_list.list[i].name, head);
1051e40d
KN
692 print_ref_item(&ref_list.list[i], maxwidth, verbose,
693 abbrev, current, remote_prefix);
c31820c2 694 }
bfcc9214
AP
695
696 free_ref_list(&ref_list);
1603ade8 697
0e9716e6 698 if (cb.ret)
49df4b02 699 error(_("some refs could not be read"));
0e9716e6 700
1603ade8 701 return cb.ret;
c31820c2
LH
702}
703
c976d415
LH
704static void rename_branch(const char *oldname, const char *newname, int force)
705{
da3f78a2 706 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
da3f78a2 707 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
cbdffe40 708 int recovery = 0;
3f59481e 709 int clobber_head_ok;
c976d415 710
c847f537 711 if (!oldname)
49df4b02 712 die(_("cannot rename the current branch while not on any."));
c847f537 713
cbdffe40
JH
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 */
c6893323 719 if (ref_exists(oldref.buf))
cbdffe40
JH
720 recovery = 1;
721 else
49df4b02 722 die(_("Invalid branch name: '%s'"), oldname);
cbdffe40 723 }
c976d415 724
3f59481e
JN
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);
c976d415 732
da3f78a2
MV
733 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
734 oldref.buf, newref.buf);
678d0f4c 735
da3f78a2 736 if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
49df4b02 737 die(_("Branch rename failed"));
da3f78a2 738 strbuf_release(&logmsg);
c976d415 739
cbdffe40 740 if (recovery)
49df4b02 741 warning(_("Renamed a misnamed branch '%s' away"), oldref.buf + 11);
cbdffe40 742
8b5157e4 743 /* no need to pass logmsg here as HEAD didn't really move */
da3f78a2 744 if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
49df4b02 745 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
19eba151 746
da3f78a2
MV
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)
49df4b02 752 die(_("Branch is renamed, but update of config-file failed"));
da3f78a2
MV
753 strbuf_release(&oldsection);
754 strbuf_release(&newsection);
c976d415
LH
755}
756
5afcb905
KN
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 */
049716b3
JH
761static 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))
49df4b02 771 die(_("malformed object name %s"), arg);
049716b3
JH
772 return 0;
773}
774
b7200e83
JH
775static const char edit_description[] = "BRANCH_DESCRIPTION";
776
777static int edit_branch_description(const char *branch_name)
778{
b7200e83
JH
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');
eff80a9f
JH
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);
91aacda8 791 if (write_file(git_path(edit_description), 0, "%s", buf.buf)) {
b7200e83 792 strbuf_release(&buf);
82247e9b 793 return error(_("could not write branch description template: %s"),
b7200e83
JH
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);
4b5553b5 804 status = git_config_set(name.buf, buf.len ? buf.buf : NULL);
b7200e83
JH
805 strbuf_release(&name);
806 strbuf_release(&buf);
807
808 return status;
809}
810
c31820c2
LH
811int cmd_branch(int argc, const char **argv, const char *prefix)
812{
356e91f2 813 int delete = 0, rename = 0, force = 0, list = 0;
b792c067 814 int verbose = 0, abbrev = -1, detached = 0;
b7200e83 815 int reflog = 0, edit_description = 0;
b84869ef 816 int quiet = 0, unset_upstream = 0;
6183d826 817 const char *new_upstream = NULL;
9ed36cfa 818 enum branch_track track;
d11d44fa 819 int kinds = REF_LOCAL_BRANCH;
694a5775 820 struct commit_list *with_commit = NULL;
a8dfd5ea
PH
821
822 struct option options[] = {
24a85214 823 OPT_GROUP(N_("Generic options")),
39271425 824 OPT__VERBOSE(&verbose,
24a85214
NTND
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))"),
9ed36cfa 828 BRANCH_TRACK_EXPLICIT),
24a85214 829 OPT_SET_INT( 0, "set-upstream", &track, N_("change upstream info"),
4fc50066 830 BRANCH_TRACK_OVERRIDE),
6183d826 831 OPT_STRING('u', "set-upstream-to", &new_upstream, "upstream", "change the upstream info"),
d5d09d47 832 OPT_BOOL(0, "unset-upstream", &unset_upstream, "Unset the upstream info"),
24a85214
NTND
833 OPT__COLOR(&branch_use_color, N_("use colored output")),
834 OPT_SET_INT('r', "remotes", &kinds, N_("act on remote-tracking branches"),
d11d44fa 835 REF_REMOTE_BRANCH),
f266c916
KN
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")),
a8dfd5ea
PH
838 OPT__ABBREV(&abbrev),
839
24a85214
NTND
840 OPT_GROUP(N_("Specific git-branch actions:")),
841 OPT_SET_INT('a', "all", &kinds, N_("list both remote-tracking and local branches"),
d11d44fa 842 REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
24a85214
NTND
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),
d5d09d47
SB
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")),
356e91f2 851 OPT__FORCE(&force, N_("force creation, move/rename, deletion")),
049716b3
JH
852 {
853 OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
24a85214 854 N_("commit"), N_("print only not merged branches"),
049716b3
JH
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,
24a85214 860 N_("commit"), N_("print only merged branches"),
049716b3
JH
861 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
862 opt_parse_merge_filter, (intptr_t) "HEAD",
863 },
24a85214 864 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
a8dfd5ea
PH
865 OPT_END(),
866 };
c31820c2 867
1dacfbcf
NTND
868 if (argc == 2 && !strcmp(argv[1], "-h"))
869 usage_with_options(builtin_branch_usage, options);
870
ef90d6d4 871 git_config(git_branch_config, NULL);
6b2f2d98 872
9ed36cfa 873 track = git_branch_track;
c976d415 874
7695d118 875 head = resolve_refdup("HEAD", 0, head_sha1, NULL);
c31820c2 876 if (!head)
49df4b02 877 die(_("Failed to resolve HEAD as a valid ref."));
e3f1da98 878 if (!strcmp(head, "HEAD"))
0016a482 879 detached = 1;
e3f1da98
RS
880 else if (!skip_prefix(head, "refs/heads/", &head))
881 die(_("HEAD not found below refs/heads!"));
049716b3
JH
882 hashcpy(merge_filter_ref, head_sha1);
883
ebe31ef2 884
37782920
SB
885 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
886 0);
cddd127b 887
b84869ef 888 if (!delete && !rename && !edit_description && !new_upstream && !unset_upstream && argc == 0)
cddd127b
MG
889 list = 1;
890
d0403508
JK
891 if (with_commit || merge_filter != NO_FILTER)
892 list = 1;
893
356e91f2 894 if (!!delete + !!rename + !!new_upstream +
05efb7b7 895 list + unset_upstream > 1)
049716b3 896 usage_with_options(builtin_branch_usage, options);
c31820c2 897
b792c067
NK
898 if (abbrev == -1)
899 abbrev = DEFAULT_ABBREV;
ebe31ef2
NTND
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 }
b792c067 906
356e91f2
MG
907 if (force) {
908 delete *= 2;
909 rename *= 2;
910 }
911
640d0401
NTND
912 if (delete) {
913 if (!argc)
914 die(_("branch name required"));
d65ddf19 915 return delete_branches(argc, argv, delete > 1, kinds, quiet);
640d0401 916 } else if (list) {
ebe31ef2
NTND
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 }
b7200e83
JH
923 else if (edit_description) {
924 const char *branch_name;
c2d17ba3
JH
925 struct strbuf branch_ref = STRBUF_INIT;
926
75135b23
NTND
927 if (!argc) {
928 if (detached)
045e3884 929 die(_("Cannot give description to detached HEAD"));
b7200e83 930 branch_name = head;
75135b23 931 } else if (argc == 1)
b7200e83
JH
932 branch_name = argv[0];
933 else
43722c4d 934 die(_("cannot edit description of more than one branch"));
c2d17ba3
JH
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)
045e3884 941 return error(_("No commit on branch '%s' yet."),
c2d17ba3
JH
942 branch_name);
943 else
045e3884
NTND
944 return error(_("No branch named '%s'."),
945 branch_name);
c2d17ba3
JH
946 }
947 strbuf_release(&branch_ref);
948
b7200e83
JH
949 if (edit_branch_description(branch_name))
950 return 1;
a4043aea 951 } else if (rename) {
d1520c4b
JM
952 if (!argc)
953 die(_("branch name required"));
954 else if (argc == 1)
3706ed29
TRC
955 rename_branch(head, argv[0], rename > 1);
956 else if (argc == 2)
957 rename_branch(argv[0], argv[1], rename > 1);
958 else
43722c4d 959 die(_("too many branches for a rename operation"));
6183d826
CMN
960 } else if (new_upstream) {
961 struct branch *branch = branch_get(argv[0]);
962
8efb8899
NTND
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
6183d826
CMN
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);
b84869ef
CMN
982 } else if (unset_upstream) {
983 struct branch *branch = branch_get(argv[0]);
984 struct strbuf buf = STRBUF_INIT;
985
8efb8899
NTND
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
54d07f2e 996 if (!branch_has_merge_config(branch))
b84869ef 997 die(_("Branch '%s' has no upstream information"), branch->name);
b84869ef
CMN
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);
5cd75c7d 1005 } else if (argc > 0 && argc <= 2) {
b347d06b
CMN
1006 struct branch *branch = branch_get(argv[0]);
1007 int branch_existed = 0, remote_tracking = 0;
1008 struct strbuf buf = STRBUF_INIT;
1009
8efb8899
NTND
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
6e8f993a 1016 if (kinds != REF_LOCAL_BRANCH)
49df4b02 1017 die(_("-a and -r options to 'git branch' do not make sense with a branch name"));
b347d06b
CMN
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);
e496c003 1027 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
356e91f2 1028 force, reflog, 0, quiet, track);
b347d06b
CMN
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
6e8f993a 1042 } else
a8dfd5ea 1043 usage_with_options(builtin_branch_usage, options);
c31820c2
LH
1044
1045 return 0;
1046}