Merge branch 'js/filter-branch-submodule'
[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         "\033[m",       /* reset */
36         "",             /* PLAIN (normal) */
37         "\033[31m",     /* REMOTE (red) */
38         "",             /* LOCAL (normal) */
39         "\033[32m",     /* CURRENT (green) */
40 };
41 enum color_branch {
42         COLOR_BRANCH_RESET = 0,
43         COLOR_BRANCH_PLAIN = 1,
44         COLOR_BRANCH_REMOTE = 2,
45         COLOR_BRANCH_LOCAL = 3,
46         COLOR_BRANCH_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 COLOR_BRANCH_PLAIN;
60         if (!strcasecmp(var+ofs, "reset"))
61                 return COLOR_BRANCH_RESET;
62         if (!strcasecmp(var+ofs, "remote"))
63                 return COLOR_BRANCH_REMOTE;
64         if (!strcasecmp(var+ofs, "local"))
65                 return COLOR_BRANCH_LOCAL;
66         if (!strcasecmp(var+ofs, "current"))
67                 return COLOR_BRANCH_CURRENT;
68         die("bad config variable '%s'", var);
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 (!value)
80                         return config_error_nonbool(var);
81                 color_parse(value, var, branch_colors[slot]);
82                 return 0;
83         }
84         return git_color_default_config(var, value, cb);
85 }
86
87 static const char *branch_get_color(enum color_branch ix)
88 {
89         if (branch_use_color > 0)
90                 return branch_colors[ix];
91         return "";
92 }
93
94 static int delete_branches(int argc, const char **argv, int force, int kinds)
95 {
96         struct commit *rev, *head_rev = head_rev;
97         unsigned char sha1[20];
98         char *name = NULL;
99         const char *fmt, *remote;
100         int i;
101         int ret = 0;
102
103         switch (kinds) {
104         case REF_REMOTE_BRANCH:
105                 fmt = "refs/remotes/%s";
106                 remote = "remote ";
107                 force = 1;
108                 break;
109         case REF_LOCAL_BRANCH:
110                 fmt = "refs/heads/%s";
111                 remote = "";
112                 break;
113         default:
114                 die("cannot use -a with -d");
115         }
116
117         if (!force) {
118                 head_rev = lookup_commit_reference(head_sha1);
119                 if (!head_rev)
120                         die("Couldn't look up commit object for HEAD");
121         }
122         for (i = 0; i < argc; i++) {
123                 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, argv[i])) {
124                         error("Cannot delete the branch '%s' "
125                                 "which you are currently on.", argv[i]);
126                         ret = 1;
127                         continue;
128                 }
129
130                 free(name);
131
132                 name = xstrdup(mkpath(fmt, argv[i]));
133                 if (!resolve_ref(name, sha1, 1, NULL)) {
134                         error("%sbranch '%s' not found.",
135                                         remote, argv[i]);
136                         ret = 1;
137                         continue;
138                 }
139
140                 rev = lookup_commit_reference(sha1);
141                 if (!rev) {
142                         error("Couldn't look up commit object for '%s'", name);
143                         ret = 1;
144                         continue;
145                 }
146
147                 /* This checks whether the merge bases of branch and
148                  * HEAD contains branch -- which means that the HEAD
149                  * contains everything in both.
150                  */
151
152                 if (!force &&
153                     !in_merge_bases(rev, &head_rev, 1)) {
154                         error("The branch '%s' is not an ancestor of "
155                                 "your current HEAD.\n"
156                                 "If you are sure you want to delete it, "
157                                 "run 'git branch -D %s'.", argv[i], argv[i]);
158                         ret = 1;
159                         continue;
160                 }
161
162                 if (delete_ref(name, sha1, 0)) {
163                         error("Error deleting %sbranch '%s'", remote,
164                                argv[i]);
165                         ret = 1;
166                 } else {
167                         struct strbuf buf = STRBUF_INIT;
168                         printf("Deleted %sbranch %s (%s).\n", remote, argv[i],
169                                 find_unique_abbrev(sha1, DEFAULT_ABBREV));
170                         strbuf_addf(&buf, "branch.%s", argv[i]);
171                         if (git_config_rename_section(buf.buf, NULL) < 0)
172                                 warning("Update of config-file failed");
173                         strbuf_release(&buf);
174                 }
175         }
176
177         free(name);
178
179         return(ret);
180 }
181
182 struct ref_item {
183         char *name;
184         unsigned int kind;
185         struct commit *commit;
186 };
187
188 struct ref_list {
189         struct rev_info revs;
190         int index, alloc, maxwidth;
191         struct ref_item *list;
192         struct commit_list *with_commit;
193         int kinds;
194 };
195
196 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
197 {
198         struct ref_list *ref_list = (struct ref_list*)(cb_data);
199         struct ref_item *newitem;
200         struct commit *commit;
201         int kind;
202         int len;
203
204         /* Detect kind */
205         if (!prefixcmp(refname, "refs/heads/")) {
206                 kind = REF_LOCAL_BRANCH;
207                 refname += 11;
208         } else if (!prefixcmp(refname, "refs/remotes/")) {
209                 kind = REF_REMOTE_BRANCH;
210                 refname += 13;
211         } else
212                 return 0;
213
214         commit = lookup_commit_reference_gently(sha1, 1);
215         if (!commit)
216                 return error("branch '%s' does not point at a commit", refname);
217
218         /* Filter with with_commit if specified */
219         if (!is_descendant_of(commit, ref_list->with_commit))
220                 return 0;
221
222         /* Don't add types the caller doesn't want */
223         if ((kind & ref_list->kinds) == 0)
224                 return 0;
225
226         if (merge_filter != NO_FILTER)
227                 add_pending_object(&ref_list->revs,
228                                    (struct object *)commit, refname);
229
230         /* Resize buffer */
231         if (ref_list->index >= ref_list->alloc) {
232                 ref_list->alloc = alloc_nr(ref_list->alloc);
233                 ref_list->list = xrealloc(ref_list->list,
234                                 ref_list->alloc * sizeof(struct ref_item));
235         }
236
237         /* Record the new item */
238         newitem = &(ref_list->list[ref_list->index++]);
239         newitem->name = xstrdup(refname);
240         newitem->kind = kind;
241         newitem->commit = commit;
242         len = strlen(newitem->name);
243         if (len > ref_list->maxwidth)
244                 ref_list->maxwidth = len;
245
246         return 0;
247 }
248
249 static void free_ref_list(struct ref_list *ref_list)
250 {
251         int i;
252
253         for (i = 0; i < ref_list->index; i++)
254                 free(ref_list->list[i].name);
255         free(ref_list->list);
256 }
257
258 static int ref_cmp(const void *r1, const void *r2)
259 {
260         struct ref_item *c1 = (struct ref_item *)(r1);
261         struct ref_item *c2 = (struct ref_item *)(r2);
262
263         if (c1->kind != c2->kind)
264                 return c1->kind - c2->kind;
265         return strcmp(c1->name, c2->name);
266 }
267
268 static void fill_tracking_info(struct strbuf *stat, const char *branch_name)
269 {
270         int ours, theirs;
271         struct branch *branch = branch_get(branch_name);
272
273         if (!stat_tracking_info(branch, &ours, &theirs) || (!ours && !theirs))
274                 return;
275         if (!ours)
276                 strbuf_addf(stat, "[behind %d] ", theirs);
277         else if (!theirs)
278                 strbuf_addf(stat, "[ahead %d] ", ours);
279         else
280                 strbuf_addf(stat, "[ahead %d, behind %d] ", ours, theirs);
281 }
282
283 static int matches_merge_filter(struct commit *commit)
284 {
285         int is_merged;
286
287         if (merge_filter == NO_FILTER)
288                 return 1;
289
290         is_merged = !!(commit->object.flags & UNINTERESTING);
291         return (is_merged == (merge_filter == SHOW_MERGED));
292 }
293
294 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
295                            int abbrev, int current)
296 {
297         char c;
298         int color;
299         struct commit *commit = item->commit;
300
301         if (!matches_merge_filter(commit))
302                 return;
303
304         switch (item->kind) {
305         case REF_LOCAL_BRANCH:
306                 color = COLOR_BRANCH_LOCAL;
307                 break;
308         case REF_REMOTE_BRANCH:
309                 color = COLOR_BRANCH_REMOTE;
310                 break;
311         default:
312                 color = COLOR_BRANCH_PLAIN;
313                 break;
314         }
315
316         c = ' ';
317         if (current) {
318                 c = '*';
319                 color = COLOR_BRANCH_CURRENT;
320         }
321
322         if (verbose) {
323                 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
324                 const char *sub = " **** invalid ref ****";
325
326                 commit = item->commit;
327                 if (commit && !parse_commit(commit)) {
328                         pretty_print_commit(CMIT_FMT_ONELINE, commit,
329                                             &subject, 0, NULL, NULL, 0, 0);
330                         sub = subject.buf;
331                 }
332
333                 if (item->kind == REF_LOCAL_BRANCH)
334                         fill_tracking_info(&stat, item->name);
335
336                 printf("%c %s%-*s%s %s %s%s\n", c, branch_get_color(color),
337                        maxwidth, item->name,
338                        branch_get_color(COLOR_BRANCH_RESET),
339                        find_unique_abbrev(item->commit->object.sha1, abbrev),
340                        stat.buf, sub);
341                 strbuf_release(&stat);
342                 strbuf_release(&subject);
343         } else {
344                 printf("%c %s%s%s\n", c, branch_get_color(color), item->name,
345                        branch_get_color(COLOR_BRANCH_RESET));
346         }
347 }
348
349 static int calc_maxwidth(struct ref_list *refs)
350 {
351         int i, l, w = 0;
352         for (i = 0; i < refs->index; i++) {
353                 if (!matches_merge_filter(refs->list[i].commit))
354                         continue;
355                 l = strlen(refs->list[i].name);
356                 if (l > w)
357                         w = l;
358         }
359         return w;
360 }
361
362 static void print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
363 {
364         int i;
365         struct ref_list ref_list;
366         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
367
368         memset(&ref_list, 0, sizeof(ref_list));
369         ref_list.kinds = kinds;
370         ref_list.with_commit = with_commit;
371         if (merge_filter != NO_FILTER)
372                 init_revisions(&ref_list.revs, NULL);
373         for_each_ref(append_ref, &ref_list);
374         if (merge_filter != NO_FILTER) {
375                 struct commit *filter;
376                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
377                 filter->object.flags |= UNINTERESTING;
378                 add_pending_object(&ref_list.revs,
379                                    (struct object *) filter, "");
380                 ref_list.revs.limited = 1;
381                 prepare_revision_walk(&ref_list.revs);
382                 if (verbose)
383                         ref_list.maxwidth = calc_maxwidth(&ref_list);
384         }
385
386         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
387
388         detached = (detached && (kinds & REF_LOCAL_BRANCH));
389         if (detached && head_commit &&
390             is_descendant_of(head_commit, with_commit)) {
391                 struct ref_item item;
392                 item.name = xstrdup("(no branch)");
393                 item.kind = REF_LOCAL_BRANCH;
394                 item.commit = head_commit;
395                 if (strlen(item.name) > ref_list.maxwidth)
396                         ref_list.maxwidth = strlen(item.name);
397                 print_ref_item(&item, ref_list.maxwidth, verbose, abbrev, 1);
398                 free(item.name);
399         }
400
401         for (i = 0; i < ref_list.index; i++) {
402                 int current = !detached &&
403                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
404                         !strcmp(ref_list.list[i].name, head);
405                 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
406                                abbrev, current);
407         }
408
409         free_ref_list(&ref_list);
410 }
411
412 static void rename_branch(const char *oldname, const char *newname, int force)
413 {
414         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
415         unsigned char sha1[20];
416         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
417
418         if (!oldname)
419                 die("cannot rename the current branch while not on any.");
420
421         strbuf_addf(&oldref, "refs/heads/%s", oldname);
422
423         if (check_ref_format(oldref.buf))
424                 die("Invalid branch name: %s", oldref.buf);
425
426         strbuf_addf(&newref, "refs/heads/%s", newname);
427
428         if (check_ref_format(newref.buf))
429                 die("Invalid branch name: %s", newref.buf);
430
431         if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
432                 die("A branch named '%s' already exists.", newname);
433
434         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
435                  oldref.buf, newref.buf);
436
437         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
438                 die("Branch rename failed");
439         strbuf_release(&logmsg);
440
441         /* no need to pass logmsg here as HEAD didn't really move */
442         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
443                 die("Branch renamed to %s, but HEAD is not updated!", newname);
444
445         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
446         strbuf_release(&oldref);
447         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
448         strbuf_release(&newref);
449         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
450                 die("Branch is renamed, but update of config-file failed");
451         strbuf_release(&oldsection);
452         strbuf_release(&newsection);
453 }
454
455 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
456 {
457         merge_filter = ((opt->long_name[0] == 'n')
458                         ? SHOW_NOT_MERGED
459                         : SHOW_MERGED);
460         if (unset)
461                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
462         if (!arg)
463                 arg = "HEAD";
464         if (get_sha1(arg, merge_filter_ref))
465                 die("malformed object name %s", arg);
466         return 0;
467 }
468
469 int cmd_branch(int argc, const char **argv, const char *prefix)
470 {
471         int delete = 0, rename = 0, force_create = 0;
472         int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
473         int reflog = 0;
474         enum branch_track track;
475         int kinds = REF_LOCAL_BRANCH;
476         struct commit_list *with_commit = NULL;
477
478         struct option options[] = {
479                 OPT_GROUP("Generic options"),
480                 OPT__VERBOSE(&verbose),
481                 OPT_SET_INT( 0 , "track",  &track, "set up tracking mode (see git-pull(1))",
482                         BRANCH_TRACK_EXPLICIT),
483                 OPT_BOOLEAN( 0 , "color",  &branch_use_color, "use colored output"),
484                 OPT_SET_INT('r', NULL,     &kinds, "act on remote-tracking branches",
485                         REF_REMOTE_BRANCH),
486                 {
487                         OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
488                         "print only branches that contain the commit",
489                         PARSE_OPT_LASTARG_DEFAULT,
490                         parse_opt_with_commit, (intptr_t)"HEAD",
491                 },
492                 {
493                         OPTION_CALLBACK, 0, "with", &with_commit, "commit",
494                         "print only branches that contain the commit",
495                         PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
496                         parse_opt_with_commit, (intptr_t) "HEAD",
497                 },
498                 OPT__ABBREV(&abbrev),
499
500                 OPT_GROUP("Specific git-branch actions:"),
501                 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
502                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
503                 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
504                 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
505                 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
506                 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
507                 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
508                 OPT_BOOLEAN('f', NULL, &force_create, "force creation (when already exists)"),
509                 {
510                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
511                         "commit", "print only not merged branches",
512                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
513                         opt_parse_merge_filter, (intptr_t) "HEAD",
514                 },
515                 {
516                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
517                         "commit", "print only merged branches",
518                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
519                         opt_parse_merge_filter, (intptr_t) "HEAD",
520                 },
521                 OPT_END(),
522         };
523
524         git_config(git_branch_config, NULL);
525
526         if (branch_use_color == -1)
527                 branch_use_color = git_use_color_default;
528
529         track = git_branch_track;
530
531         head = resolve_ref("HEAD", head_sha1, 0, NULL);
532         if (!head)
533                 die("Failed to resolve HEAD as a valid ref.");
534         head = xstrdup(head);
535         if (!strcmp(head, "HEAD")) {
536                 detached = 1;
537         } else {
538                 if (prefixcmp(head, "refs/heads/"))
539                         die("HEAD not found below refs/heads!");
540                 head += 11;
541         }
542         hashcpy(merge_filter_ref, head_sha1);
543
544         argc = parse_options(argc, argv, options, builtin_branch_usage, 0);
545         if (!!delete + !!rename + !!force_create > 1)
546                 usage_with_options(builtin_branch_usage, options);
547
548         if (delete)
549                 return delete_branches(argc, argv, delete > 1, kinds);
550         else if (argc == 0)
551                 print_ref_list(kinds, detached, verbose, abbrev, with_commit);
552         else if (rename && (argc == 1))
553                 rename_branch(head, argv[0], rename > 1);
554         else if (rename && (argc == 2))
555                 rename_branch(argv[0], argv[1], rename > 1);
556         else if (argc <= 2)
557                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
558                               force_create, reflog, track);
559         else
560                 usage_with_options(builtin_branch_usage, options);
561
562         return 0;
563 }