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