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         char *dest;
 185         unsigned int kind, len;
 186         struct commit *commit;
 187 };
 188
 189 struct ref_list {
 190         struct rev_info revs;
 191         int index, alloc, maxwidth;
 192         struct ref_item *list;
 193         struct commit_list *with_commit;
 194         int kinds;
 195 };
 196
 197 static char *resolve_symref(const char *src, const char *prefix)
 198 {
 199         unsigned char sha1[20];
 200         int flag;
 201         const char *dst, *cp;
 202
 203         dst = resolve_ref(src, sha1, 0, &flag);
 204         if (!(dst && (flag & REF_ISSYMREF)))
 205                 return NULL;
 206         if (prefix && (cp = skip_prefix(dst, prefix)))
 207                 dst = cp;
 208         return xstrdup(dst);
 209 }
 210
 211 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
 212 {
 213         struct ref_list *ref_list = (struct ref_list*)(cb_data);
 214         struct ref_item *newitem;
 215         struct commit *commit;
 216         int kind, i;
 217         const char *prefix, *orig_refname = refname;
 218
 219         static struct {
 220                 int kind;
 221                 const char *prefix;
 222                 int pfxlen;
 223         } ref_kind[] = {
 224                 { REF_LOCAL_BRANCH, "refs/heads/", 11 },
 225                 { REF_REMOTE_BRANCH, "refs/remotes/", 13 },
 226         };
 227
 228         /* Detect kind */
 229         for (i = 0; i < ARRAY_SIZE(ref_kind); i++) {
 230                 prefix = ref_kind[i].prefix;
 231                 if (strncmp(refname, prefix, ref_kind[i].pfxlen))
 232                         continue;
 233                 kind = ref_kind[i].kind;
 234                 refname += ref_kind[i].pfxlen;
 235                 break;
 236         }
 237         if (ARRAY_SIZE(ref_kind) <= i)
 238                 return 0;
 239
 240         commit = lookup_commit_reference_gently(sha1, 1);
 241         if (!commit)
 242                 return error("branch '%s' does not point at a commit", refname);
 243
 244         /* Filter with with_commit if specified */
 245         if (!is_descendant_of(commit, ref_list->with_commit))
 246                 return 0;
 247
 248         /* Don't add types the caller doesn't want */
 249         if ((kind & ref_list->kinds) == 0)
 250                 return 0;
 251
 252         if (merge_filter != NO_FILTER)
 253                 add_pending_object(&ref_list->revs,
 254                                    (struct object *)commit, refname);
 255
 256         /* Resize buffer */
 257         if (ref_list->index >= ref_list->alloc) {
 258                 ref_list->alloc = alloc_nr(ref_list->alloc);
 259                 ref_list->list = xrealloc(ref_list->list,
 260                                 ref_list->alloc * sizeof(struct ref_item));
 261         }
 262
 263         /* Record the new item */
 264         newitem = &(ref_list->list[ref_list->index++]);
 265         newitem->name = xstrdup(refname);
 266         newitem->kind = kind;
 267         newitem->commit = commit;
 268         newitem->len = strlen(refname);
 269         newitem->dest = resolve_symref(orig_refname, prefix);
 270         /* adjust for "remotes/" */
 271         if (newitem->kind == REF_REMOTE_BRANCH &&
 272             ref_list->kinds != REF_REMOTE_BRANCH)
 273                 newitem->len += 8;
 274         if (newitem->len > ref_list->maxwidth)
 275                 ref_list->maxwidth = newitem->len;
 276
 277         return 0;
 278 }
 279
 280 static void free_ref_list(struct ref_list *ref_list)
 281 {
 282         int i;
 283
 284         for (i = 0; i < ref_list->index; i++) {
 285                 free(ref_list->list[i].name);
 286                 free(ref_list->list[i].dest);
 287         }
 288         free(ref_list->list);
 289 }
 290
 291 static int ref_cmp(const void *r1, const void *r2)
 292 {
 293         struct ref_item *c1 = (struct ref_item *)(r1);
 294         struct ref_item *c2 = (struct ref_item *)(r2);
 295
 296         if (c1->kind != c2->kind)
 297                 return c1->kind - c2->kind;
 298         return strcmp(c1->name, c2->name);
 299 }
 300
 301 static void fill_tracking_info(struct strbuf *stat, const char *branch_name)
 302 {
 303         int ours, theirs;
 304         struct branch *branch = branch_get(branch_name);
 305
 306         if (!stat_tracking_info(branch, &ours, &theirs) || (!ours && !theirs))
 307                 return;
 308         if (!ours)
 309                 strbuf_addf(stat, "[behind %d] ", theirs);
 310         else if (!theirs)
 311                 strbuf_addf(stat, "[ahead %d] ", ours);
 312         else
 313                 strbuf_addf(stat, "[ahead %d, behind %d] ", ours, theirs);
 314 }
 315
 316 static int matches_merge_filter(struct commit *commit)
 317 {
 318         int is_merged;
 319
 320         if (merge_filter == NO_FILTER)
 321                 return 1;
 322
 323         is_merged = !!(commit->object.flags & UNINTERESTING);
 324         return (is_merged == (merge_filter == SHOW_MERGED));
 325 }
 326
 327 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
 328                            int abbrev, int current, char *prefix)
 329 {
 330         char c;
 331         int color;
 332         struct commit *commit = item->commit;
 333         struct strbuf out = STRBUF_INIT, name = STRBUF_INIT;
 334
 335         if (!matches_merge_filter(commit))
 336                 return;
 337
 338         switch (item->kind) {
 339         case REF_LOCAL_BRANCH:
 340                 color = COLOR_BRANCH_LOCAL;
 341                 break;
 342         case REF_REMOTE_BRANCH:
 343                 color = COLOR_BRANCH_REMOTE;
 344                 break;
 345         default:
 346                 color = COLOR_BRANCH_PLAIN;
 347                 break;
 348         }
 349
 350         c = ' ';
 351         if (current) {
 352                 c = '*';
 353                 color = COLOR_BRANCH_CURRENT;
 354         }
 355
 356         strbuf_addf(&name, "%s%s", prefix, item->name);
 357         if (verbose)
 358                 strbuf_addf(&out, "%c %s%-*s%s", c, branch_get_color(color),
 359                             maxwidth, name.buf,
 360                             branch_get_color(COLOR_BRANCH_RESET));
 361         else
 362                 strbuf_addf(&out, "%c %s%s%s", c, branch_get_color(color),
 363                             name.buf, branch_get_color(COLOR_BRANCH_RESET));
 364
 365         if (item->dest)
 366                 strbuf_addf(&out, " -> %s", item->dest);
 367         else if (verbose) {
 368                 struct strbuf subject = STRBUF_INIT, stat = STRBUF_INIT;
 369                 const char *sub = " **** invalid ref ****";
 370
 371                 commit = item->commit;
 372                 if (commit && !parse_commit(commit)) {
 373                         pretty_print_commit(CMIT_FMT_ONELINE, commit,
 374                                             &subject, 0, NULL, NULL, 0, 0);
 375                         sub = subject.buf;
 376                 }
 377
 378                 if (item->kind == REF_LOCAL_BRANCH)
 379                         fill_tracking_info(&stat, item->name);
 380
 381                 strbuf_addf(&out, " %s %s%s",
 382                         find_unique_abbrev(item->commit->object.sha1, abbrev),
 383                         stat.buf, sub);
 384                 strbuf_release(&stat);
 385                 strbuf_release(&subject);
 386         }
 387         printf("%s\n", out.buf);
 388         strbuf_release(&name);
 389         strbuf_release(&out);
 390 }
 391
 392 static int calc_maxwidth(struct ref_list *refs)
 393 {
 394         int i, w = 0;
 395         for (i = 0; i < refs->index; i++) {
 396                 if (!matches_merge_filter(refs->list[i].commit))
 397                         continue;
 398                 if (refs->list[i].len > w)
 399                         w = refs->list[i].len;
 400         }
 401         return w;
 402 }
 403
 404 static void print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
 405 {
 406         int i;
 407         struct ref_list ref_list;
 408         struct commit *head_commit = lookup_commit_reference_gently(head_sha1, 1);
 409
 410         memset(&ref_list, 0, sizeof(ref_list));
 411         ref_list.kinds = kinds;
 412         ref_list.with_commit = with_commit;
 413         if (merge_filter != NO_FILTER)
 414                 init_revisions(&ref_list.revs, NULL);
 415         for_each_ref(append_ref, &ref_list);
 416         if (merge_filter != NO_FILTER) {
 417                 struct commit *filter;
 418                 filter = lookup_commit_reference_gently(merge_filter_ref, 0);
 419                 filter->object.flags |= UNINTERESTING;
 420                 add_pending_object(&ref_list.revs,
 421                                    (struct object *) filter, "");
 422                 ref_list.revs.limited = 1;
 423                 prepare_revision_walk(&ref_list.revs);
 424                 if (verbose)
 425                         ref_list.maxwidth = calc_maxwidth(&ref_list);
 426         }
 427
 428         qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
 429
 430         detached = (detached && (kinds & REF_LOCAL_BRANCH));
 431         if (detached && head_commit &&
 432             is_descendant_of(head_commit, with_commit)) {
 433                 struct ref_item item;
 434                 item.name = xstrdup("(no branch)");
 435                 item.kind = REF_LOCAL_BRANCH;
 436                 item.commit = head_commit;
 437                 if (strlen(item.name) > ref_list.maxwidth)
 438                         ref_list.maxwidth = strlen(item.name);
 439                 print_ref_item(&item, ref_list.maxwidth, verbose, abbrev, 1, "");
 440                 free(item.name);
 441         }
 442
 443         for (i = 0; i < ref_list.index; i++) {
 444                 int current = !detached &&
 445                         (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
 446                         !strcmp(ref_list.list[i].name, head);
 447                 char *prefix = (kinds != REF_REMOTE_BRANCH &&
 448                                 ref_list.list[i].kind == REF_REMOTE_BRANCH)
 449                                 ? "remotes/" : "";
 450                 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
 451                                abbrev, current, prefix);
 452         }
 453
 454         free_ref_list(&ref_list);
 455 }
 456
 457 static void rename_branch(const char *oldname, const char *newname, int force)
 458 {
 459         struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
 460         unsigned char sha1[20];
 461         struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
 462
 463         if (!oldname)
 464                 die("cannot rename the current branch while not on any.");
 465
 466         strbuf_addf(&oldref, "refs/heads/%s", oldname);
 467
 468         if (check_ref_format(oldref.buf))
 469                 die("Invalid branch name: %s", oldref.buf);
 470
 471         strbuf_addf(&newref, "refs/heads/%s", newname);
 472
 473         if (check_ref_format(newref.buf))
 474                 die("Invalid branch name: %s", newref.buf);
 475
 476         if (resolve_ref(newref.buf, sha1, 1, NULL) && !force)
 477                 die("A branch named '%s' already exists.", newname);
 478
 479         strbuf_addf(&logmsg, "Branch: renamed %s to %s",
 480                  oldref.buf, newref.buf);
 481
 482         if (rename_ref(oldref.buf, newref.buf, logmsg.buf))
 483                 die("Branch rename failed");
 484         strbuf_release(&logmsg);
 485
 486         /* no need to pass logmsg here as HEAD didn't really move */
 487         if (!strcmp(oldname, head) && create_symref("HEAD", newref.buf, NULL))
 488                 die("Branch renamed to %s, but HEAD is not updated!", newname);
 489
 490         strbuf_addf(&oldsection, "branch.%s", oldref.buf + 11);
 491         strbuf_release(&oldref);
 492         strbuf_addf(&newsection, "branch.%s", newref.buf + 11);
 493         strbuf_release(&newref);
 494         if (git_config_rename_section(oldsection.buf, newsection.buf) < 0)
 495                 die("Branch is renamed, but update of config-file failed");
 496         strbuf_release(&oldsection);
 497         strbuf_release(&newsection);
 498 }
 499
 500 static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
 501 {
 502         merge_filter = ((opt->long_name[0] == 'n')
 503                         ? SHOW_NOT_MERGED
 504                         : SHOW_MERGED);
 505         if (unset)
 506                 merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
 507         if (!arg)
 508                 arg = "HEAD";
 509         if (get_sha1(arg, merge_filter_ref))
 510                 die("malformed object name %s", arg);
 511         return 0;
 512 }
 513
 514 int cmd_branch(int argc, const char **argv, const char *prefix)
 515 {
 516         int delete = 0, rename = 0, force_create = 0;
 517         int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
 518         int reflog = 0;
 519         enum branch_track track;
 520         int kinds = REF_LOCAL_BRANCH;
 521         struct commit_list *with_commit = NULL;
 522
 523         struct option options[] = {
 524                 OPT_GROUP("Generic options"),
 525                 OPT__VERBOSE(&verbose),
 526                 OPT_SET_INT( 0 , "track",  &track, "set up tracking mode (see git-pull(1))",
 527                         BRANCH_TRACK_EXPLICIT),
 528                 OPT_BOOLEAN( 0 , "color",  &branch_use_color, "use colored output"),
 529                 OPT_SET_INT('r', NULL,     &kinds, "act on remote-tracking branches",
 530                         REF_REMOTE_BRANCH),
 531                 {
 532                         OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
 533                         "print only branches that contain the commit",
 534                         PARSE_OPT_LASTARG_DEFAULT,
 535                         parse_opt_with_commit, (intptr_t)"HEAD",
 536                 },
 537                 {
 538                         OPTION_CALLBACK, 0, "with", &with_commit, "commit",
 539                         "print only branches that contain the commit",
 540                         PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
 541                         parse_opt_with_commit, (intptr_t) "HEAD",
 542                 },
 543                 OPT__ABBREV(&abbrev),
 544
 545                 OPT_GROUP("Specific git-branch actions:"),
 546                 OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
 547                         REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
 548                 OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
 549                 OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
 550                 OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
 551                 OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
 552                 OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
 553                 OPT_BOOLEAN('f', NULL, &force_create, "force creation (when already exists)"),
 554                 {
 555                         OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
 556                         "commit", "print only not merged branches",
 557                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 558                         opt_parse_merge_filter, (intptr_t) "HEAD",
 559                 },
 560                 {
 561                         OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
 562                         "commit", "print only merged branches",
 563                         PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 564                         opt_parse_merge_filter, (intptr_t) "HEAD",
 565                 },
 566                 OPT_END(),
 567         };
 568
 569         git_config(git_branch_config, NULL);
 570
 571         if (branch_use_color == -1)
 572                 branch_use_color = git_use_color_default;
 573
 574         track = git_branch_track;
 575
 576         head = resolve_ref("HEAD", head_sha1, 0, NULL);
 577         if (!head)
 578                 die("Failed to resolve HEAD as a valid ref.");
 579         head = xstrdup(head);
 580         if (!strcmp(head, "HEAD")) {
 581                 detached = 1;
 582         } else {
 583                 if (prefixcmp(head, "refs/heads/"))
 584                         die("HEAD not found below refs/heads!");
 585                 head += 11;
 586         }
 587         hashcpy(merge_filter_ref, head_sha1);
 588
 589         argc = parse_options(argc, argv, options, builtin_branch_usage, 0);
 590         if (!!delete + !!rename + !!force_create > 1)
 591                 usage_with_options(builtin_branch_usage, options);
 592
 593         if (delete)
 594                 return delete_branches(argc, argv, delete > 1, kinds);
 595         else if (argc == 0)
 596                 print_ref_list(kinds, detached, verbose, abbrev, with_commit);
 597         else if (rename && (argc == 1))
 598                 rename_branch(head, argv[0], rename > 1);
 599         else if (rename && (argc == 2))
 600                 rename_branch(argv[0], argv[1], rename > 1);
 601         else if (argc <= 2)
 602                 create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
 603                               force_create, reflog, track);
 604         else
 605                 usage_with_options(builtin_branch_usage, options);
 606
 607         return 0;
 608 }