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
  17static 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
  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        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
 181struct ref_item {
 182        char *name;
 183        unsigned int kind;
 184        unsigned char sha1[20];
 185};
 186
 187struct ref_list {
 188        int index, alloc, maxwidth;
 189        struct ref_item *list;
 190        struct commit_list *with_commit;
 191        int kinds;
 192};
 193
 194static 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
 214static 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
 273static 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
 282static 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
 292static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
 293                           int abbrev, int current)
 294{
 295        char c;
 296        int color;
 297        struct commit *commit;
 298
 299        switch (item->kind) {
 300        case REF_LOCAL_BRANCH:
 301                color = COLOR_BRANCH_LOCAL;
 302                break;
 303        case REF_REMOTE_BRANCH:
 304                color = COLOR_BRANCH_REMOTE;
 305                break;
 306        default:
 307                color = COLOR_BRANCH_PLAIN;
 308                break;
 309        }
 310
 311        c = ' ';
 312        if (current) {
 313                c = '*';
 314                color = COLOR_BRANCH_CURRENT;
 315        }
 316
 317        if (verbose) {
 318                struct strbuf subject;
 319                const char *sub = " **** invalid ref ****";
 320
 321                strbuf_init(&subject, 0);
 322
 323                commit = lookup_commit(item->sha1);
 324                if (commit && !parse_commit(commit)) {
 325                        pretty_print_commit(CMIT_FMT_ONELINE, commit,
 326                                            &subject, 0, NULL, NULL, 0, 0);
 327                        sub = subject.buf;
 328                }
 329                printf("%c %s%-*s%s %s %s\n", c, branch_get_color(color),
 330                       maxwidth, item->name,
 331                       branch_get_color(COLOR_BRANCH_RESET),
 332                       find_unique_abbrev(item->sha1, abbrev), sub);
 333                strbuf_release(&subject);
 334        } else {
 335                printf("%c %s%s%s\n", c, branch_get_color(color), item->name,
 336                       branch_get_color(COLOR_BRANCH_RESET));
 337        }
 338}
 339
 340static void print_ref_list(int kinds, int detached, int verbose, int abbrev, struct commit_list *with_commit)
 341{
 342        int i;
 343        struct ref_list ref_list;
 344
 345        memset(&ref_list, 0, sizeof(ref_list));
 346        ref_list.kinds = kinds;
 347        ref_list.with_commit = with_commit;
 348        for_each_ref(append_ref, &ref_list);
 349
 350        qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
 351
 352        detached = (detached && (kinds & REF_LOCAL_BRANCH));
 353        if (detached && has_commit(head_sha1, with_commit)) {
 354                struct ref_item item;
 355                item.name = xstrdup("(no branch)");
 356                item.kind = REF_LOCAL_BRANCH;
 357                hashcpy(item.sha1, head_sha1);
 358                if (strlen(item.name) > ref_list.maxwidth)
 359                              ref_list.maxwidth = strlen(item.name);
 360                print_ref_item(&item, ref_list.maxwidth, verbose, abbrev, 1);
 361                free(item.name);
 362        }
 363
 364        for (i = 0; i < ref_list.index; i++) {
 365                int current = !detached &&
 366                        (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
 367                        !strcmp(ref_list.list[i].name, head);
 368                print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
 369                               abbrev, current);
 370        }
 371
 372        free_ref_list(&ref_list);
 373}
 374
 375static void rename_branch(const char *oldname, const char *newname, int force)
 376{
 377        char oldref[PATH_MAX], newref[PATH_MAX], logmsg[PATH_MAX*2 + 100];
 378        unsigned char sha1[20];
 379        char oldsection[PATH_MAX], newsection[PATH_MAX];
 380
 381        if (!oldname)
 382                die("cannot rename the current branch while not on any.");
 383
 384        if (snprintf(oldref, sizeof(oldref), "refs/heads/%s", oldname) > sizeof(oldref))
 385                die("Old branchname too long");
 386
 387        if (check_ref_format(oldref))
 388                die("Invalid branch name: %s", oldref);
 389
 390        if (snprintf(newref, sizeof(newref), "refs/heads/%s", newname) > sizeof(newref))
 391                die("New branchname too long");
 392
 393        if (check_ref_format(newref))
 394                die("Invalid branch name: %s", newref);
 395
 396        if (resolve_ref(newref, sha1, 1, NULL) && !force)
 397                die("A branch named '%s' already exists.", newname);
 398
 399        snprintf(logmsg, sizeof(logmsg), "Branch: renamed %s to %s",
 400                 oldref, newref);
 401
 402        if (rename_ref(oldref, newref, logmsg))
 403                die("Branch rename failed");
 404
 405        /* no need to pass logmsg here as HEAD didn't really move */
 406        if (!strcmp(oldname, head) && create_symref("HEAD", newref, NULL))
 407                die("Branch renamed to %s, but HEAD is not updated!", newname);
 408
 409        snprintf(oldsection, sizeof(oldsection), "branch.%s", oldref + 11);
 410        snprintf(newsection, sizeof(newsection), "branch.%s", newref + 11);
 411        if (git_config_rename_section(oldsection, newsection) < 0)
 412                die("Branch is renamed, but update of config-file failed");
 413}
 414
 415static int opt_parse_with_commit(const struct option *opt, const char *arg, int unset)
 416{
 417        unsigned char sha1[20];
 418        struct commit *commit;
 419
 420        if (!arg)
 421                return -1;
 422        if (get_sha1(arg, sha1))
 423                die("malformed object name %s", arg);
 424        commit = lookup_commit_reference(sha1);
 425        if (!commit)
 426                die("no such commit %s", arg);
 427        commit_list_insert(commit, opt->value);
 428        return 0;
 429}
 430
 431static int opt_parse_merge_filter(const struct option *opt, const char *arg, int unset)
 432{
 433        merge_filter = ((opt->long_name[0] == 'n')
 434                        ? SHOW_NOT_MERGED
 435                        : SHOW_MERGED);
 436        if (unset)
 437                merge_filter = SHOW_NOT_MERGED; /* b/c for --no-merged */
 438        if (!arg)
 439                arg = "HEAD";
 440        if (get_sha1(arg, merge_filter_ref))
 441                die("malformed object name %s", arg);
 442        return 0;
 443}
 444
 445int cmd_branch(int argc, const char **argv, const char *prefix)
 446{
 447        int delete = 0, rename = 0, force_create = 0;
 448        int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
 449        int reflog = 0;
 450        enum branch_track track;
 451        int kinds = REF_LOCAL_BRANCH;
 452        struct commit_list *with_commit = NULL;
 453
 454        struct option options[] = {
 455                OPT_GROUP("Generic options"),
 456                OPT__VERBOSE(&verbose),
 457                OPT_SET_INT( 0 , "track",  &track, "set up tracking mode (see git-pull(1))",
 458                        BRANCH_TRACK_EXPLICIT),
 459                OPT_BOOLEAN( 0 , "color",  &branch_use_color, "use colored output"),
 460                OPT_SET_INT('r', NULL,     &kinds, "act on remote-tracking branches",
 461                        REF_REMOTE_BRANCH),
 462                {
 463                        OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
 464                        "print only branches that contain the commit",
 465                        PARSE_OPT_LASTARG_DEFAULT,
 466                        opt_parse_with_commit, (intptr_t)"HEAD",
 467                },
 468                {
 469                        OPTION_CALLBACK, 0, "with", &with_commit, "commit",
 470                        "print only branches that contain the commit",
 471                        PARSE_OPT_HIDDEN | PARSE_OPT_LASTARG_DEFAULT,
 472                        opt_parse_with_commit, (intptr_t) "HEAD",
 473                },
 474                OPT__ABBREV(&abbrev),
 475
 476                OPT_GROUP("Specific git-branch actions:"),
 477                OPT_SET_INT('a', NULL, &kinds, "list both remote-tracking and local branches",
 478                        REF_REMOTE_BRANCH | REF_LOCAL_BRANCH),
 479                OPT_BIT('d', NULL, &delete, "delete fully merged branch", 1),
 480                OPT_BIT('D', NULL, &delete, "delete branch (even if not merged)", 2),
 481                OPT_BIT('m', NULL, &rename, "move/rename a branch and its reflog", 1),
 482                OPT_BIT('M', NULL, &rename, "move/rename a branch, even if target exists", 2),
 483                OPT_BOOLEAN('l', NULL, &reflog, "create the branch's reflog"),
 484                OPT_BOOLEAN('f', NULL, &force_create, "force creation (when already exists)"),
 485                {
 486                        OPTION_CALLBACK, 0, "no-merged", &merge_filter_ref,
 487                        "commit", "print only not merged branches",
 488                        PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 489                        opt_parse_merge_filter, (intptr_t) "HEAD",
 490                },
 491                {
 492                        OPTION_CALLBACK, 0, "merged", &merge_filter_ref,
 493                        "commit", "print only merged branches",
 494                        PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG,
 495                        opt_parse_merge_filter, (intptr_t) "HEAD",
 496                },
 497                OPT_END(),
 498        };
 499
 500        git_config(git_branch_config, NULL);
 501
 502        if (branch_use_color == -1)
 503                branch_use_color = git_use_color_default;
 504
 505        track = git_branch_track;
 506
 507        head = resolve_ref("HEAD", head_sha1, 0, NULL);
 508        if (!head)
 509                die("Failed to resolve HEAD as a valid ref.");
 510        head = xstrdup(head);
 511        if (!strcmp(head, "HEAD")) {
 512                detached = 1;
 513        } else {
 514                if (prefixcmp(head, "refs/heads/"))
 515                        die("HEAD not found below refs/heads!");
 516                head += 11;
 517        }
 518        hashcpy(merge_filter_ref, head_sha1);
 519
 520        argc = parse_options(argc, argv, options, builtin_branch_usage, 0);
 521        if (!!delete + !!rename + !!force_create > 1)
 522                usage_with_options(builtin_branch_usage, options);
 523
 524        if (delete)
 525                return delete_branches(argc, argv, delete > 1, kinds);
 526        else if (argc == 0)
 527                print_ref_list(kinds, detached, verbose, abbrev, with_commit);
 528        else if (rename && (argc == 1))
 529                rename_branch(head, argv[0], rename > 1);
 530        else if (rename && (argc == 2))
 531                rename_branch(argv[0], argv[1], rename > 1);
 532        else if (argc <= 2)
 533                create_branch(head, argv[0], (argc == 2) ? argv[1] : head,
 534                              force_create, reflog, track);
 535        else
 536                usage_with_options(builtin_branch_usage, options);
 537
 538        return 0;
 539}