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