Andrew's git - gitweb.git/blob

   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
  14static const char builtin_branch_usage[] =
  15  "git-branch [-r] (-d | -D) <branchname> | [--track | --no-track] [-l] [-f] <branchname> [<start-point>] | (-m | -M) [<oldbranch>] <newbranch> | [--color | --no-color] [-r | -a] [-v [--abbrev=<length> | --no-abbrev]]";
  16
  17#define REF_UNKNOWN_TYPE    0x00
  18#define REF_LOCAL_BRANCH    0x01
  19#define REF_REMOTE_BRANCH   0x02
  20#define REF_TAG             0x04
  21
  22static const char *head;
  23static unsigned char head_sha1[20];
  24
  25static int branch_track_remotes;
  26
  27static int branch_use_color;
  28static char branch_colors[][COLOR_MAXLEN] = {
  29        "\033[m",       /* reset */
  30        "",             /* PLAIN (normal) */
  31        "\033[31m",     /* REMOTE (red) */
  32        "",             /* LOCAL (normal) */
  33        "\033[32m",     /* CURRENT (green) */
  34};
  35enum color_branch {
  36        COLOR_BRANCH_RESET = 0,
  37        COLOR_BRANCH_PLAIN = 1,
  38        COLOR_BRANCH_REMOTE = 2,
  39        COLOR_BRANCH_LOCAL = 3,
  40        COLOR_BRANCH_CURRENT = 4,
  41};
  42
  43static int parse_branch_color_slot(const char *var, int ofs)
  44{
  45        if (!strcasecmp(var+ofs, "plain"))
  46                return COLOR_BRANCH_PLAIN;
  47        if (!strcasecmp(var+ofs, "reset"))
  48                return COLOR_BRANCH_RESET;
  49        if (!strcasecmp(var+ofs, "remote"))
  50                return COLOR_BRANCH_REMOTE;
  51        if (!strcasecmp(var+ofs, "local"))
  52                return COLOR_BRANCH_LOCAL;
  53        if (!strcasecmp(var+ofs, "current"))
  54                return COLOR_BRANCH_CURRENT;
  55        die("bad config variable '%s'", var);
  56}
  57
  58static int git_branch_config(const char *var, const char *value)
  59{
  60        if (!strcmp(var, "color.branch")) {
  61                branch_use_color = git_config_colorbool(var, value);
  62                return 0;
  63        }
  64        if (!prefixcmp(var, "color.branch.")) {
  65                int slot = parse_branch_color_slot(var, 13);
  66                color_parse(value, var, branch_colors[slot]);
  67                return 0;
  68        }
  69        if (!strcmp(var, "branch.autosetupmerge"))
  70                branch_track_remotes = git_config_bool(var, value);
  71
  72        return git_default_config(var, value);
  73}
  74
  75static const char *branch_get_color(enum color_branch ix)
  76{
  77        if (branch_use_color)
  78                return branch_colors[ix];
  79        return "";
  80}
  81
  82static int delete_branches(int argc, const char **argv, int force, int kinds)
  83{
  84        struct commit *rev, *head_rev = head_rev;
  85        unsigned char sha1[20];
  86        char *name = NULL;
  87        const char *fmt, *remote;
  88        char section[PATH_MAX];
  89        int i;
  90        int ret = 0;
  91
  92        switch (kinds) {
  93        case REF_REMOTE_BRANCH:
  94                fmt = "refs/remotes/%s";
  95                remote = "remote ";
  96                force = 1;
  97                break;
  98        case REF_LOCAL_BRANCH:
  99                fmt = "refs/heads/%s";
 100                remote = "";
 101                break;
 102        default:
 103                die("cannot use -a with -d");
 104        }
 105
 106        if (!force) {
 107                head_rev = lookup_commit_reference(head_sha1);
 108                if (!head_rev)
 109                        die("Couldn't look up commit object for HEAD");
 110        }
 111        for (i = 0; i < argc; i++) {
 112                if (kinds == REF_LOCAL_BRANCH && !strcmp(head, argv[i])) {
 113                        error("Cannot delete the branch '%s' "
 114                                "which you are currently on.", argv[i]);
 115                        ret = 1;
 116                        continue;
 117                }
 118
 119                if (name)
 120                        free(name);
 121
 122                name = xstrdup(mkpath(fmt, argv[i]));
 123                if (!resolve_ref(name, sha1, 1, NULL)) {
 124                        error("%sbranch '%s' not found.",
 125                                        remote, argv[i]);
 126                        ret = 1;
 127                        continue;
 128                }
 129
 130                rev = lookup_commit_reference(sha1);
 131                if (!rev) {
 132                        error("Couldn't look up commit object for '%s'", name);
 133                        ret = 1;
 134                        continue;
 135                }
 136
 137                /* This checks whether the merge bases of branch and
 138                 * HEAD contains branch -- which means that the HEAD
 139                 * contains everything in both.
 140                 */
 141
 142                if (!force &&
 143                    !in_merge_bases(rev, &head_rev, 1)) {
 144                        error("The branch '%s' is not a strict subset of "
 145                                "your current HEAD.\n"
 146                                "If you are sure you want to delete it, "
 147                                "run 'git branch -D %s'.", argv[i], argv[i]);
 148                        ret = 1;
 149                        continue;
 150                }
 151
 152                if (delete_ref(name, sha1)) {
 153                        error("Error deleting %sbranch '%s'", remote,
 154                               argv[i]);
 155                        ret = 1;
 156                } else {
 157                        printf("Deleted %sbranch %s.\n", remote, argv[i]);
 158                        snprintf(section, sizeof(section), "branch.%s",
 159                                 argv[i]);
 160                        if (git_config_rename_section(section, NULL) < 0)
 161                                warning("Update of config-file failed");
 162                }
 163        }
 164
 165        if (name)
 166                free(name);
 167
 168        return(ret);
 169}
 170
 171struct ref_item {
 172        char *name;
 173        unsigned int kind;
 174        unsigned char sha1[20];
 175};
 176
 177struct ref_list {
 178        int index, alloc, maxwidth;
 179        struct ref_item *list;
 180        int kinds;
 181};
 182
 183static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
 184{
 185        struct ref_list *ref_list = (struct ref_list*)(cb_data);
 186        struct ref_item *newitem;
 187        int kind = REF_UNKNOWN_TYPE;
 188        int len;
 189
 190        /* Detect kind */
 191        if (!prefixcmp(refname, "refs/heads/")) {
 192                kind = REF_LOCAL_BRANCH;
 193                refname += 11;
 194        } else if (!prefixcmp(refname, "refs/remotes/")) {
 195                kind = REF_REMOTE_BRANCH;
 196                refname += 13;
 197        } else if (!prefixcmp(refname, "refs/tags/")) {
 198                kind = REF_TAG;
 199                refname += 10;
 200        }
 201
 202        /* Don't add types the caller doesn't want */
 203        if ((kind & ref_list->kinds) == 0)
 204                return 0;
 205
 206        /* Resize buffer */
 207        if (ref_list->index >= ref_list->alloc) {
 208                ref_list->alloc = alloc_nr(ref_list->alloc);
 209                ref_list->list = xrealloc(ref_list->list,
 210                                ref_list->alloc * sizeof(struct ref_item));
 211        }
 212
 213        /* Record the new item */
 214        newitem = &(ref_list->list[ref_list->index++]);
 215        newitem->name = xstrdup(refname);
 216        newitem->kind = kind;
 217        hashcpy(newitem->sha1, sha1);
 218        len = strlen(newitem->name);
 219        if (len > ref_list->maxwidth)
 220                ref_list->maxwidth = len;
 221
 222        return 0;
 223}
 224
 225static void free_ref_list(struct ref_list *ref_list)
 226{
 227        int i;
 228
 229        for (i = 0; i < ref_list->index; i++)
 230                free(ref_list->list[i].name);
 231        free(ref_list->list);
 232}
 233
 234static int ref_cmp(const void *r1, const void *r2)
 235{
 236        struct ref_item *c1 = (struct ref_item *)(r1);
 237        struct ref_item *c2 = (struct ref_item *)(r2);
 238
 239        if (c1->kind != c2->kind)
 240                return c1->kind - c2->kind;
 241        return strcmp(c1->name, c2->name);
 242}
 243
 244static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
 245                           int abbrev, int current)
 246{
 247        char c;
 248        int color;
 249        struct commit *commit;
 250
 251        switch (item->kind) {
 252        case REF_LOCAL_BRANCH:
 253                color = COLOR_BRANCH_LOCAL;
 254                break;
 255        case REF_REMOTE_BRANCH:
 256                color = COLOR_BRANCH_REMOTE;
 257                break;
 258        default:
 259                color = COLOR_BRANCH_PLAIN;
 260                break;
 261        }
 262
 263        c = ' ';
 264        if (current) {
 265                c = '*';
 266                color = COLOR_BRANCH_CURRENT;
 267        }
 268
 269        if (verbose) {
 270                char *subject = NULL;
 271                unsigned long subject_len = 0;
 272                const char *sub = " **** invalid ref ****";
 273
 274                commit = lookup_commit(item->sha1);
 275                if (commit && !parse_commit(commit)) {
 276                        pretty_print_commit(CMIT_FMT_ONELINE, commit, ~0,
 277                                            &subject, &subject_len, 0,
 278                                            NULL, NULL, 0);
 279                        sub = subject;
 280                }
 281                printf("%c %s%-*s%s %s %s\n", c, branch_get_color(color),
 282                       maxwidth, item->name,
 283                       branch_get_color(COLOR_BRANCH_RESET),
 284                       find_unique_abbrev(item->sha1, abbrev), sub);
 285                if (subject)
 286                        free(subject);
 287        } else {
 288                printf("%c %s%s%s\n", c, branch_get_color(color), item->name,
 289                       branch_get_color(COLOR_BRANCH_RESET));
 290        }
 291}
 292
 293static void print_ref_list(int kinds, int detached, int verbose, int abbrev)
 294{
 295        int i;
 296        struct ref_list ref_list;
 297
 298        memset(&ref_list, 0, sizeof(ref_list));
 299        ref_list.kinds = kinds;
 300        for_each_ref(append_ref, &ref_list);
 301
 302        qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
 303
 304        detached = (detached && (kinds & REF_LOCAL_BRANCH));
 305        if (detached) {
 306                struct ref_item item;
 307                item.name = xstrdup("(no branch)");
 308                item.kind = REF_LOCAL_BRANCH;
 309                hashcpy(item.sha1, head_sha1);
 310                if (strlen(item.name) > ref_list.maxwidth)
 311                              ref_list.maxwidth = strlen(item.name);
 312                print_ref_item(&item, ref_list.maxwidth, verbose, abbrev, 1);
 313                free(item.name);
 314        }
 315
 316        for (i = 0; i < ref_list.index; i++) {
 317                int current = !detached &&
 318                        (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
 319                        !strcmp(ref_list.list[i].name, head);
 320                print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
 321                               abbrev, current);
 322        }
 323
 324        free_ref_list(&ref_list);
 325}
 326
 327static char *config_repo;
 328static char *config_remote;
 329static const char *start_ref;
 330
 331static int get_remote_branch_name(const char *value)
 332{
 333        const char *colon;
 334        const char *end;
 335
 336        if (*value == '+')
 337                value++;
 338
 339        colon = strchr(value, ':');
 340        if (!colon)
 341                return 0;
 342
 343        end = value + strlen(value);
 344
 345        /*
 346         * Try an exact match first.  I.e. handle the case where the
 347         * value is "$anything:refs/foo/bar/baz" and start_ref is exactly
 348         * "refs/foo/bar/baz". Then the name at the remote is $anything.
 349         */
 350        if (!strcmp(colon + 1, start_ref)) {
 351                /* Truncate the value before the colon. */
 352                nfasprintf(&config_repo, "%.*s", colon - value, value);
 353                return 1;
 354        }
 355
 356        /*
 357         * Is this a wildcard match?
 358         */
 359        if ((end - 2 <= value) || end[-2] != '/' || end[-1] != '*' ||
 360            (colon - 2 <= value) || colon[-2] != '/' || colon[-1] != '*')
 361                return 0;
 362
 363        /*
 364         * Value is "refs/foo/bar/<asterisk>:refs/baz/boa/<asterisk>"
 365         * and start_ref begins with "refs/baz/boa/"; the name at the
 366         * remote is refs/foo/bar/ with the remaining part of the
 367         * start_ref.  The length of the prefix on the RHS is (end -
 368         * colon - 2), including the slash immediately before the
 369         * asterisk.
 370         */
 371        if ((strlen(start_ref) < end - colon - 2) ||
 372            memcmp(start_ref, colon + 1, end - colon - 2))
 373                return 0; /* does not match prefix */
 374
 375        /* Replace the asterisk with the remote branch name.  */
 376        nfasprintf(&config_repo, "%.*s%s",
 377                   (colon - 1) - value, value,
 378                   start_ref + (end - colon - 2));
 379        return 1;
 380}
 381
 382static int get_remote_config(const char *key, const char *value)
 383{
 384        const char *var;
 385        if (prefixcmp(key, "remote."))
 386                return 0;
 387
 388        var = strrchr(key, '.');
 389        if (var == key + 6 || strcmp(var, ".fetch"))
 390                return 0;
 391        /*
 392         * Ok, we are looking at key == "remote.$foo.fetch";
 393         */
 394        if (get_remote_branch_name(value))
 395                nfasprintf(&config_remote, "%.*s", var - (key + 7), key + 7);
 396
 397        return 0;
 398}
 399
 400static void set_branch_merge(const char *name, const char *config_remote,
 401                             const char *config_repo)
 402{
 403        char key[1024];
 404        if (sizeof(key) <=
 405            snprintf(key, sizeof(key), "branch.%s.remote", name))
 406                die("what a long branch name you have!");
 407        git_config_set(key, config_remote);
 408
 409        /*
 410         * We do not have to check if we have enough space for
 411         * the 'merge' key, since it's shorter than the
 412         * previous 'remote' key, which we already checked.
 413         */
 414        snprintf(key, sizeof(key), "branch.%s.merge", name);
 415        git_config_set(key, config_repo);
 416}
 417
 418static void set_branch_defaults(const char *name, const char *real_ref)
 419{
 420        /*
 421         * name is the name of new branch under refs/heads;
 422         * real_ref is typically refs/remotes/$foo/$bar, where
 423         * $foo is the remote name (there typically are no slashes)
 424         * and $bar is the branch name we map from the remote
 425         * (it could have slashes).
 426         */
 427        start_ref = real_ref;
 428        git_config(get_remote_config);
 429        if (!config_repo && !config_remote &&
 430            !prefixcmp(real_ref, "refs/heads/")) {
 431                set_branch_merge(name, ".", real_ref);
 432                printf("Branch %s set up to track local branch %s.\n",
 433                       name, real_ref);
 434        }
 435
 436        if (config_repo && config_remote) {
 437                set_branch_merge(name, config_remote, config_repo);
 438                printf("Branch %s set up to track remote branch %s.\n",
 439                       name, real_ref);
 440        }
 441
 442        if (config_repo)
 443                free(config_repo);
 444        if (config_remote)
 445                free(config_remote);
 446}
 447
 448static void create_branch(const char *name, const char *start_name,
 449                          int force, int reflog, int track)
 450{
 451        struct ref_lock *lock;
 452        struct commit *commit;
 453        unsigned char sha1[20];
 454        char *real_ref, ref[PATH_MAX], msg[PATH_MAX + 20];
 455        int forcing = 0;
 456
 457        snprintf(ref, sizeof ref, "refs/heads/%s", name);
 458        if (check_ref_format(ref))
 459                die("'%s' is not a valid branch name.", name);
 460
 461        if (resolve_ref(ref, sha1, 1, NULL)) {
 462                if (!force)
 463                        die("A branch named '%s' already exists.", name);
 464                else if (!is_bare_repository() && !strcmp(head, name))
 465                        die("Cannot force update the current branch.");
 466                forcing = 1;
 467        }
 468
 469        real_ref = NULL;
 470        if (get_sha1(start_name, sha1))
 471                die("Not a valid object name: '%s'.", start_name);
 472
 473        switch (dwim_ref(start_name, strlen(start_name), sha1, &real_ref)) {
 474        case 0:
 475                /* Not branching from any existing branch */
 476                real_ref = NULL;
 477                break;
 478        case 1:
 479                /* Unique completion -- good */
 480                break;
 481        default:
 482                die("Ambiguous object name: '%s'.", start_name);
 483                break;
 484        }
 485
 486        if ((commit = lookup_commit_reference(sha1)) == NULL)
 487                die("Not a valid branch point: '%s'.", start_name);
 488        hashcpy(sha1, commit->object.sha1);
 489
 490        lock = lock_any_ref_for_update(ref, NULL, 0);
 491        if (!lock)
 492                die("Failed to lock ref for update: %s.", strerror(errno));
 493
 494        if (reflog)
 495                log_all_ref_updates = 1;
 496
 497        if (forcing)
 498                snprintf(msg, sizeof msg, "branch: Reset from %s",
 499                         start_name);
 500        else
 501                snprintf(msg, sizeof msg, "branch: Created from %s",
 502                         start_name);
 503
 504        /* When branching off a remote branch, set up so that git-pull
 505           automatically merges from there.  So far, this is only done for
 506           remotes registered via .git/config.  */
 507        if (real_ref && track)
 508                set_branch_defaults(name, real_ref);
 509
 510        if (write_ref_sha1(lock, sha1, msg) < 0)
 511                die("Failed to write ref: %s.", strerror(errno));
 512
 513        if (real_ref)
 514                free(real_ref);
 515}
 516
 517static void rename_branch(const char *oldname, const char *newname, int force)
 518{
 519        char oldref[PATH_MAX], newref[PATH_MAX], logmsg[PATH_MAX*2 + 100];
 520        unsigned char sha1[20];
 521        char oldsection[PATH_MAX], newsection[PATH_MAX];
 522
 523        if (!oldname)
 524                die("cannot rename the current branch while not on any.");
 525
 526        if (snprintf(oldref, sizeof(oldref), "refs/heads/%s", oldname) > sizeof(oldref))
 527                die("Old branchname too long");
 528
 529        if (check_ref_format(oldref))
 530                die("Invalid branch name: %s", oldref);
 531
 532        if (snprintf(newref, sizeof(newref), "refs/heads/%s", newname) > sizeof(newref))
 533                die("New branchname too long");
 534
 535        if (check_ref_format(newref))
 536                die("Invalid branch name: %s", newref);
 537
 538        if (resolve_ref(newref, sha1, 1, NULL) && !force)
 539                die("A branch named '%s' already exists.", newname);
 540
 541        snprintf(logmsg, sizeof(logmsg), "Branch: renamed %s to %s",
 542                 oldref, newref);
 543
 544        if (rename_ref(oldref, newref, logmsg))
 545                die("Branch rename failed");
 546
 547        /* no need to pass logmsg here as HEAD didn't really move */
 548        if (!strcmp(oldname, head) && create_symref("HEAD", newref, NULL))
 549                die("Branch renamed to %s, but HEAD is not updated!", newname);
 550
 551        snprintf(oldsection, sizeof(oldsection), "branch.%s", oldref + 11);
 552        snprintf(newsection, sizeof(newsection), "branch.%s", newref + 11);
 553        if (git_config_rename_section(oldsection, newsection) < 0)
 554                die("Branch is renamed, but update of config-file failed");
 555}
 556
 557int cmd_branch(int argc, const char **argv, const char *prefix)
 558{
 559        int delete = 0, force_delete = 0, force_create = 0;
 560        int rename = 0, force_rename = 0;
 561        int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
 562        int reflog = 0, track;
 563        int kinds = REF_LOCAL_BRANCH;
 564        int i;
 565
 566        git_config(git_branch_config);
 567        track = branch_track_remotes;
 568
 569        for (i = 1; i < argc; i++) {
 570                const char *arg = argv[i];
 571
 572                if (arg[0] != '-')
 573                        break;
 574                if (!strcmp(arg, "--")) {
 575                        i++;
 576                        break;
 577                }
 578                if (!strcmp(arg, "--track")) {
 579                        track = 1;
 580                        continue;
 581                }
 582                if (!strcmp(arg, "--no-track")) {
 583                        track = 0;
 584                        continue;
 585                }
 586                if (!strcmp(arg, "-d")) {
 587                        delete = 1;
 588                        continue;
 589                }
 590                if (!strcmp(arg, "-D")) {
 591                        delete = 1;
 592                        force_delete = 1;
 593                        continue;
 594                }
 595                if (!strcmp(arg, "-f")) {
 596                        force_create = 1;
 597                        continue;
 598                }
 599                if (!strcmp(arg, "-m")) {
 600                        rename = 1;
 601                        continue;
 602                }
 603                if (!strcmp(arg, "-M")) {
 604                        rename = 1;
 605                        force_rename = 1;
 606                        continue;
 607                }
 608                if (!strcmp(arg, "-r")) {
 609                        kinds = REF_REMOTE_BRANCH;
 610                        continue;
 611                }
 612                if (!strcmp(arg, "-a")) {
 613                        kinds = REF_REMOTE_BRANCH | REF_LOCAL_BRANCH;
 614                        continue;
 615                }
 616                if (!strcmp(arg, "-l")) {
 617                        reflog = 1;
 618                        continue;
 619                }
 620                if (!prefixcmp(arg, "--no-abbrev")) {
 621                        abbrev = 0;
 622                        continue;
 623                }
 624                if (!prefixcmp(arg, "--abbrev=")) {
 625                        abbrev = strtoul(arg + 9, NULL, 10);
 626                        if (abbrev < MINIMUM_ABBREV)
 627                                abbrev = MINIMUM_ABBREV;
 628                        else if (abbrev > 40)
 629                                abbrev = 40;
 630                        continue;
 631                }
 632                if (!strcmp(arg, "-v")) {
 633                        verbose = 1;
 634                        continue;
 635                }
 636                if (!strcmp(arg, "--color")) {
 637                        branch_use_color = 1;
 638                        continue;
 639                }
 640                if (!strcmp(arg, "--no-color")) {
 641                        branch_use_color = 0;
 642                        continue;
 643                }
 644                usage(builtin_branch_usage);
 645        }
 646
 647        if ((delete && rename) || (delete && force_create) ||
 648            (rename && force_create))
 649                usage(builtin_branch_usage);
 650
 651        head = resolve_ref("HEAD", head_sha1, 0, NULL);
 652        if (!head)
 653                die("Failed to resolve HEAD as a valid ref.");
 654        head = xstrdup(head);
 655        if (!strcmp(head, "HEAD")) {
 656                detached = 1;
 657        }
 658        else {
 659                if (prefixcmp(head, "refs/heads/"))
 660                        die("HEAD not found below refs/heads!");
 661                head += 11;
 662        }
 663
 664        if (delete)
 665                return delete_branches(argc - i, argv + i, force_delete, kinds);
 666        else if (i == argc)
 667                print_ref_list(kinds, detached, verbose, abbrev);
 668        else if (rename && (i == argc - 1))
 669                rename_branch(head, argv[i], force_rename);
 670        else if (rename && (i == argc - 2))
 671                rename_branch(argv[i], argv[i + 1], force_rename);
 672        else if (i == argc - 1 || i == argc - 2)
 673                create_branch(argv[i], (i == argc - 2) ? argv[i+1] : head,
 674                              force_create, reflog, track);
 675        else
 676                usage(builtin_branch_usage);
 677
 678        return 0;
 679}