builtin-branch.c

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