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