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