builtin / blame.con commit object-store: move object access functions to object-store.h (cbd53a2)
   1/*
   2 * Blame
   3 *
   4 * Copyright (c) 2006, 2014 by its authors
   5 * See COPYING for licensing conditions
   6 */
   7
   8#include "cache.h"
   9#include "config.h"
  10#include "builtin.h"
  11#include "commit.h"
  12#include "diff.h"
  13#include "revision.h"
  14#include "quote.h"
  15#include "string-list.h"
  16#include "mailmap.h"
  17#include "parse-options.h"
  18#include "prio-queue.h"
  19#include "utf8.h"
  20#include "userdiff.h"
  21#include "line-range.h"
  22#include "line-log.h"
  23#include "dir.h"
  24#include "progress.h"
  25#include "object-store.h"
  26#include "blame.h"
  27
  28static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
  29
  30static const char *blame_opt_usage[] = {
  31        blame_usage,
  32        "",
  33        N_("<rev-opts> are documented in git-rev-list(1)"),
  34        NULL
  35};
  36
  37static int longest_file;
  38static int longest_author;
  39static int max_orig_digits;
  40static int max_digits;
  41static int max_score_digits;
  42static int show_root;
  43static int reverse;
  44static int blank_boundary;
  45static int incremental;
  46static int xdl_opts;
  47static int abbrev = -1;
  48static int no_whole_file_rename;
  49static int show_progress;
  50
  51static struct date_mode blame_date_mode = { DATE_ISO8601 };
  52static size_t blame_date_width;
  53
  54static struct string_list mailmap = STRING_LIST_INIT_NODUP;
  55
  56#ifndef DEBUG
  57#define DEBUG 0
  58#endif
  59
  60static unsigned blame_move_score;
  61static unsigned blame_copy_score;
  62
  63/* Remember to update object flag allocation in object.h */
  64#define METAINFO_SHOWN          (1u<<12)
  65#define MORE_THAN_ONE_PATH      (1u<<13)
  66
  67struct progress_info {
  68        struct progress *progress;
  69        int blamed_lines;
  70};
  71
  72static const char *nth_line_cb(void *data, long lno)
  73{
  74        return blame_nth_line((struct blame_scoreboard *)data, lno);
  75}
  76
  77/*
  78 * Information on commits, used for output.
  79 */
  80struct commit_info {
  81        struct strbuf author;
  82        struct strbuf author_mail;
  83        timestamp_t author_time;
  84        struct strbuf author_tz;
  85
  86        /* filled only when asked for details */
  87        struct strbuf committer;
  88        struct strbuf committer_mail;
  89        timestamp_t committer_time;
  90        struct strbuf committer_tz;
  91
  92        struct strbuf summary;
  93};
  94
  95/*
  96 * Parse author/committer line in the commit object buffer
  97 */
  98static void get_ac_line(const char *inbuf, const char *what,
  99        struct strbuf *name, struct strbuf *mail,
 100        timestamp_t *time, struct strbuf *tz)
 101{
 102        struct ident_split ident;
 103        size_t len, maillen, namelen;
 104        char *tmp, *endp;
 105        const char *namebuf, *mailbuf;
 106
 107        tmp = strstr(inbuf, what);
 108        if (!tmp)
 109                goto error_out;
 110        tmp += strlen(what);
 111        endp = strchr(tmp, '\n');
 112        if (!endp)
 113                len = strlen(tmp);
 114        else
 115                len = endp - tmp;
 116
 117        if (split_ident_line(&ident, tmp, len)) {
 118        error_out:
 119                /* Ugh */
 120                tmp = "(unknown)";
 121                strbuf_addstr(name, tmp);
 122                strbuf_addstr(mail, tmp);
 123                strbuf_addstr(tz, tmp);
 124                *time = 0;
 125                return;
 126        }
 127
 128        namelen = ident.name_end - ident.name_begin;
 129        namebuf = ident.name_begin;
 130
 131        maillen = ident.mail_end - ident.mail_begin;
 132        mailbuf = ident.mail_begin;
 133
 134        if (ident.date_begin && ident.date_end)
 135                *time = strtoul(ident.date_begin, NULL, 10);
 136        else
 137                *time = 0;
 138
 139        if (ident.tz_begin && ident.tz_end)
 140                strbuf_add(tz, ident.tz_begin, ident.tz_end - ident.tz_begin);
 141        else
 142                strbuf_addstr(tz, "(unknown)");
 143
 144        /*
 145         * Now, convert both name and e-mail using mailmap
 146         */
 147        map_user(&mailmap, &mailbuf, &maillen,
 148                 &namebuf, &namelen);
 149
 150        strbuf_addf(mail, "<%.*s>", (int)maillen, mailbuf);
 151        strbuf_add(name, namebuf, namelen);
 152}
 153
 154static void commit_info_init(struct commit_info *ci)
 155{
 156
 157        strbuf_init(&ci->author, 0);
 158        strbuf_init(&ci->author_mail, 0);
 159        strbuf_init(&ci->author_tz, 0);
 160        strbuf_init(&ci->committer, 0);
 161        strbuf_init(&ci->committer_mail, 0);
 162        strbuf_init(&ci->committer_tz, 0);
 163        strbuf_init(&ci->summary, 0);
 164}
 165
 166static void commit_info_destroy(struct commit_info *ci)
 167{
 168
 169        strbuf_release(&ci->author);
 170        strbuf_release(&ci->author_mail);
 171        strbuf_release(&ci->author_tz);
 172        strbuf_release(&ci->committer);
 173        strbuf_release(&ci->committer_mail);
 174        strbuf_release(&ci->committer_tz);
 175        strbuf_release(&ci->summary);
 176}
 177
 178static void get_commit_info(struct commit *commit,
 179                            struct commit_info *ret,
 180                            int detailed)
 181{
 182        int len;
 183        const char *subject, *encoding;
 184        const char *message;
 185
 186        commit_info_init(ret);
 187
 188        encoding = get_log_output_encoding();
 189        message = logmsg_reencode(commit, NULL, encoding);
 190        get_ac_line(message, "\nauthor ",
 191                    &ret->author, &ret->author_mail,
 192                    &ret->author_time, &ret->author_tz);
 193
 194        if (!detailed) {
 195                unuse_commit_buffer(commit, message);
 196                return;
 197        }
 198
 199        get_ac_line(message, "\ncommitter ",
 200                    &ret->committer, &ret->committer_mail,
 201                    &ret->committer_time, &ret->committer_tz);
 202
 203        len = find_commit_subject(message, &subject);
 204        if (len)
 205                strbuf_add(&ret->summary, subject, len);
 206        else
 207                strbuf_addf(&ret->summary, "(%s)", oid_to_hex(&commit->object.oid));
 208
 209        unuse_commit_buffer(commit, message);
 210}
 211
 212/*
 213 * Write out any suspect information which depends on the path. This must be
 214 * handled separately from emit_one_suspect_detail(), because a given commit
 215 * may have changes in multiple paths. So this needs to appear each time
 216 * we mention a new group.
 217 *
 218 * To allow LF and other nonportable characters in pathnames,
 219 * they are c-style quoted as needed.
 220 */
 221static void write_filename_info(struct blame_origin *suspect)
 222{
 223        if (suspect->previous) {
 224                struct blame_origin *prev = suspect->previous;
 225                printf("previous %s ", oid_to_hex(&prev->commit->object.oid));
 226                write_name_quoted(prev->path, stdout, '\n');
 227        }
 228        printf("filename ");
 229        write_name_quoted(suspect->path, stdout, '\n');
 230}
 231
 232/*
 233 * Porcelain/Incremental format wants to show a lot of details per
 234 * commit.  Instead of repeating this every line, emit it only once,
 235 * the first time each commit appears in the output (unless the
 236 * user has specifically asked for us to repeat).
 237 */
 238static int emit_one_suspect_detail(struct blame_origin *suspect, int repeat)
 239{
 240        struct commit_info ci;
 241
 242        if (!repeat && (suspect->commit->object.flags & METAINFO_SHOWN))
 243                return 0;
 244
 245        suspect->commit->object.flags |= METAINFO_SHOWN;
 246        get_commit_info(suspect->commit, &ci, 1);
 247        printf("author %s\n", ci.author.buf);
 248        printf("author-mail %s\n", ci.author_mail.buf);
 249        printf("author-time %"PRItime"\n", ci.author_time);
 250        printf("author-tz %s\n", ci.author_tz.buf);
 251        printf("committer %s\n", ci.committer.buf);
 252        printf("committer-mail %s\n", ci.committer_mail.buf);
 253        printf("committer-time %"PRItime"\n", ci.committer_time);
 254        printf("committer-tz %s\n", ci.committer_tz.buf);
 255        printf("summary %s\n", ci.summary.buf);
 256        if (suspect->commit->object.flags & UNINTERESTING)
 257                printf("boundary\n");
 258
 259        commit_info_destroy(&ci);
 260
 261        return 1;
 262}
 263
 264/*
 265 * The blame_entry is found to be guilty for the range.
 266 * Show it in incremental output.
 267 */
 268static void found_guilty_entry(struct blame_entry *ent, void *data)
 269{
 270        struct progress_info *pi = (struct progress_info *)data;
 271
 272        if (incremental) {
 273                struct blame_origin *suspect = ent->suspect;
 274
 275                printf("%s %d %d %d\n",
 276                       oid_to_hex(&suspect->commit->object.oid),
 277                       ent->s_lno + 1, ent->lno + 1, ent->num_lines);
 278                emit_one_suspect_detail(suspect, 0);
 279                write_filename_info(suspect);
 280                maybe_flush_or_die(stdout, "stdout");
 281        }
 282        pi->blamed_lines += ent->num_lines;
 283        display_progress(pi->progress, pi->blamed_lines);
 284}
 285
 286static const char *format_time(timestamp_t time, const char *tz_str,
 287                               int show_raw_time)
 288{
 289        static struct strbuf time_buf = STRBUF_INIT;
 290
 291        strbuf_reset(&time_buf);
 292        if (show_raw_time) {
 293                strbuf_addf(&time_buf, "%"PRItime" %s", time, tz_str);
 294        }
 295        else {
 296                const char *time_str;
 297                size_t time_width;
 298                int tz;
 299                tz = atoi(tz_str);
 300                time_str = show_date(time, tz, &blame_date_mode);
 301                strbuf_addstr(&time_buf, time_str);
 302                /*
 303                 * Add space paddings to time_buf to display a fixed width
 304                 * string, and use time_width for display width calibration.
 305                 */
 306                for (time_width = utf8_strwidth(time_str);
 307                     time_width < blame_date_width;
 308                     time_width++)
 309                        strbuf_addch(&time_buf, ' ');
 310        }
 311        return time_buf.buf;
 312}
 313
 314#define OUTPUT_ANNOTATE_COMPAT  001
 315#define OUTPUT_LONG_OBJECT_NAME 002
 316#define OUTPUT_RAW_TIMESTAMP    004
 317#define OUTPUT_PORCELAIN        010
 318#define OUTPUT_SHOW_NAME        020
 319#define OUTPUT_SHOW_NUMBER      040
 320#define OUTPUT_SHOW_SCORE      0100
 321#define OUTPUT_NO_AUTHOR       0200
 322#define OUTPUT_SHOW_EMAIL       0400
 323#define OUTPUT_LINE_PORCELAIN 01000
 324
 325static void emit_porcelain_details(struct blame_origin *suspect, int repeat)
 326{
 327        if (emit_one_suspect_detail(suspect, repeat) ||
 328            (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
 329                write_filename_info(suspect);
 330}
 331
 332static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent,
 333                           int opt)
 334{
 335        int repeat = opt & OUTPUT_LINE_PORCELAIN;
 336        int cnt;
 337        const char *cp;
 338        struct blame_origin *suspect = ent->suspect;
 339        char hex[GIT_MAX_HEXSZ + 1];
 340
 341        oid_to_hex_r(hex, &suspect->commit->object.oid);
 342        printf("%s %d %d %d\n",
 343               hex,
 344               ent->s_lno + 1,
 345               ent->lno + 1,
 346               ent->num_lines);
 347        emit_porcelain_details(suspect, repeat);
 348
 349        cp = blame_nth_line(sb, ent->lno);
 350        for (cnt = 0; cnt < ent->num_lines; cnt++) {
 351                char ch;
 352                if (cnt) {
 353                        printf("%s %d %d\n", hex,
 354                               ent->s_lno + 1 + cnt,
 355                               ent->lno + 1 + cnt);
 356                        if (repeat)
 357                                emit_porcelain_details(suspect, 1);
 358                }
 359                putchar('\t');
 360                do {
 361                        ch = *cp++;
 362                        putchar(ch);
 363                } while (ch != '\n' &&
 364                         cp < sb->final_buf + sb->final_buf_size);
 365        }
 366
 367        if (sb->final_buf_size && cp[-1] != '\n')
 368                putchar('\n');
 369}
 370
 371static void emit_other(struct blame_scoreboard *sb, struct blame_entry *ent, int opt)
 372{
 373        int cnt;
 374        const char *cp;
 375        struct blame_origin *suspect = ent->suspect;
 376        struct commit_info ci;
 377        char hex[GIT_MAX_HEXSZ + 1];
 378        int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
 379
 380        get_commit_info(suspect->commit, &ci, 1);
 381        oid_to_hex_r(hex, &suspect->commit->object.oid);
 382
 383        cp = blame_nth_line(sb, ent->lno);
 384        for (cnt = 0; cnt < ent->num_lines; cnt++) {
 385                char ch;
 386                int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? GIT_SHA1_HEXSZ : abbrev;
 387
 388                if (suspect->commit->object.flags & UNINTERESTING) {
 389                        if (blank_boundary)
 390                                memset(hex, ' ', length);
 391                        else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
 392                                length--;
 393                                putchar('^');
 394                        }
 395                }
 396
 397                printf("%.*s", length, hex);
 398                if (opt & OUTPUT_ANNOTATE_COMPAT) {
 399                        const char *name;
 400                        if (opt & OUTPUT_SHOW_EMAIL)
 401                                name = ci.author_mail.buf;
 402                        else
 403                                name = ci.author.buf;
 404                        printf("\t(%10s\t%10s\t%d)", name,
 405                               format_time(ci.author_time, ci.author_tz.buf,
 406                                           show_raw_time),
 407                               ent->lno + 1 + cnt);
 408                } else {
 409                        if (opt & OUTPUT_SHOW_SCORE)
 410                                printf(" %*d %02d",
 411                                       max_score_digits, ent->score,
 412                                       ent->suspect->refcnt);
 413                        if (opt & OUTPUT_SHOW_NAME)
 414                                printf(" %-*.*s", longest_file, longest_file,
 415                                       suspect->path);
 416                        if (opt & OUTPUT_SHOW_NUMBER)
 417                                printf(" %*d", max_orig_digits,
 418                                       ent->s_lno + 1 + cnt);
 419
 420                        if (!(opt & OUTPUT_NO_AUTHOR)) {
 421                                const char *name;
 422                                int pad;
 423                                if (opt & OUTPUT_SHOW_EMAIL)
 424                                        name = ci.author_mail.buf;
 425                                else
 426                                        name = ci.author.buf;
 427                                pad = longest_author - utf8_strwidth(name);
 428                                printf(" (%s%*s %10s",
 429                                       name, pad, "",
 430                                       format_time(ci.author_time,
 431                                                   ci.author_tz.buf,
 432                                                   show_raw_time));
 433                        }
 434                        printf(" %*d) ",
 435                               max_digits, ent->lno + 1 + cnt);
 436                }
 437                do {
 438                        ch = *cp++;
 439                        putchar(ch);
 440                } while (ch != '\n' &&
 441                         cp < sb->final_buf + sb->final_buf_size);
 442        }
 443
 444        if (sb->final_buf_size && cp[-1] != '\n')
 445                putchar('\n');
 446
 447        commit_info_destroy(&ci);
 448}
 449
 450static void output(struct blame_scoreboard *sb, int option)
 451{
 452        struct blame_entry *ent;
 453
 454        if (option & OUTPUT_PORCELAIN) {
 455                for (ent = sb->ent; ent; ent = ent->next) {
 456                        int count = 0;
 457                        struct blame_origin *suspect;
 458                        struct commit *commit = ent->suspect->commit;
 459                        if (commit->object.flags & MORE_THAN_ONE_PATH)
 460                                continue;
 461                        for (suspect = commit->util; suspect; suspect = suspect->next) {
 462                                if (suspect->guilty && count++) {
 463                                        commit->object.flags |= MORE_THAN_ONE_PATH;
 464                                        break;
 465                                }
 466                        }
 467                }
 468        }
 469
 470        for (ent = sb->ent; ent; ent = ent->next) {
 471                if (option & OUTPUT_PORCELAIN)
 472                        emit_porcelain(sb, ent, option);
 473                else {
 474                        emit_other(sb, ent, option);
 475                }
 476        }
 477}
 478
 479/*
 480 * Add phony grafts for use with -S; this is primarily to
 481 * support git's cvsserver that wants to give a linear history
 482 * to its clients.
 483 */
 484static int read_ancestry(const char *graft_file)
 485{
 486        FILE *fp = fopen_or_warn(graft_file, "r");
 487        struct strbuf buf = STRBUF_INIT;
 488        if (!fp)
 489                return -1;
 490        while (!strbuf_getwholeline(&buf, fp, '\n')) {
 491                /* The format is just "Commit Parent1 Parent2 ...\n" */
 492                struct commit_graft *graft = read_graft_line(&buf);
 493                if (graft)
 494                        register_commit_graft(graft, 0);
 495        }
 496        fclose(fp);
 497        strbuf_release(&buf);
 498        return 0;
 499}
 500
 501static int update_auto_abbrev(int auto_abbrev, struct blame_origin *suspect)
 502{
 503        const char *uniq = find_unique_abbrev(&suspect->commit->object.oid,
 504                                              auto_abbrev);
 505        int len = strlen(uniq);
 506        if (auto_abbrev < len)
 507                return len;
 508        return auto_abbrev;
 509}
 510
 511/*
 512 * How many columns do we need to show line numbers, authors,
 513 * and filenames?
 514 */
 515static void find_alignment(struct blame_scoreboard *sb, int *option)
 516{
 517        int longest_src_lines = 0;
 518        int longest_dst_lines = 0;
 519        unsigned largest_score = 0;
 520        struct blame_entry *e;
 521        int compute_auto_abbrev = (abbrev < 0);
 522        int auto_abbrev = DEFAULT_ABBREV;
 523
 524        for (e = sb->ent; e; e = e->next) {
 525                struct blame_origin *suspect = e->suspect;
 526                int num;
 527
 528                if (compute_auto_abbrev)
 529                        auto_abbrev = update_auto_abbrev(auto_abbrev, suspect);
 530                if (strcmp(suspect->path, sb->path))
 531                        *option |= OUTPUT_SHOW_NAME;
 532                num = strlen(suspect->path);
 533                if (longest_file < num)
 534                        longest_file = num;
 535                if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
 536                        struct commit_info ci;
 537                        suspect->commit->object.flags |= METAINFO_SHOWN;
 538                        get_commit_info(suspect->commit, &ci, 1);
 539                        if (*option & OUTPUT_SHOW_EMAIL)
 540                                num = utf8_strwidth(ci.author_mail.buf);
 541                        else
 542                                num = utf8_strwidth(ci.author.buf);
 543                        if (longest_author < num)
 544                                longest_author = num;
 545                        commit_info_destroy(&ci);
 546                }
 547                num = e->s_lno + e->num_lines;
 548                if (longest_src_lines < num)
 549                        longest_src_lines = num;
 550                num = e->lno + e->num_lines;
 551                if (longest_dst_lines < num)
 552                        longest_dst_lines = num;
 553                if (largest_score < blame_entry_score(sb, e))
 554                        largest_score = blame_entry_score(sb, e);
 555        }
 556        max_orig_digits = decimal_width(longest_src_lines);
 557        max_digits = decimal_width(longest_dst_lines);
 558        max_score_digits = decimal_width(largest_score);
 559
 560        if (compute_auto_abbrev)
 561                /* one more abbrev length is needed for the boundary commit */
 562                abbrev = auto_abbrev + 1;
 563}
 564
 565static void sanity_check_on_fail(struct blame_scoreboard *sb, int baa)
 566{
 567        int opt = OUTPUT_SHOW_SCORE | OUTPUT_SHOW_NUMBER | OUTPUT_SHOW_NAME;
 568        find_alignment(sb, &opt);
 569        output(sb, opt);
 570        die("Baa %d!", baa);
 571}
 572
 573static unsigned parse_score(const char *arg)
 574{
 575        char *end;
 576        unsigned long score = strtoul(arg, &end, 10);
 577        if (*end)
 578                return 0;
 579        return score;
 580}
 581
 582static const char *add_prefix(const char *prefix, const char *path)
 583{
 584        return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
 585}
 586
 587static int git_blame_config(const char *var, const char *value, void *cb)
 588{
 589        if (!strcmp(var, "blame.showroot")) {
 590                show_root = git_config_bool(var, value);
 591                return 0;
 592        }
 593        if (!strcmp(var, "blame.blankboundary")) {
 594                blank_boundary = git_config_bool(var, value);
 595                return 0;
 596        }
 597        if (!strcmp(var, "blame.showemail")) {
 598                int *output_option = cb;
 599                if (git_config_bool(var, value))
 600                        *output_option |= OUTPUT_SHOW_EMAIL;
 601                else
 602                        *output_option &= ~OUTPUT_SHOW_EMAIL;
 603                return 0;
 604        }
 605        if (!strcmp(var, "blame.date")) {
 606                if (!value)
 607                        return config_error_nonbool(var);
 608                parse_date_format(value, &blame_date_mode);
 609                return 0;
 610        }
 611
 612        if (git_diff_heuristic_config(var, value, cb) < 0)
 613                return -1;
 614        if (userdiff_config(var, value) < 0)
 615                return -1;
 616
 617        return git_default_config(var, value, cb);
 618}
 619
 620static int blame_copy_callback(const struct option *option, const char *arg, int unset)
 621{
 622        int *opt = option->value;
 623
 624        /*
 625         * -C enables copy from removed files;
 626         * -C -C enables copy from existing files, but only
 627         *       when blaming a new file;
 628         * -C -C -C enables copy from existing files for
 629         *          everybody
 630         */
 631        if (*opt & PICKAXE_BLAME_COPY_HARDER)
 632                *opt |= PICKAXE_BLAME_COPY_HARDEST;
 633        if (*opt & PICKAXE_BLAME_COPY)
 634                *opt |= PICKAXE_BLAME_COPY_HARDER;
 635        *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
 636
 637        if (arg)
 638                blame_copy_score = parse_score(arg);
 639        return 0;
 640}
 641
 642static int blame_move_callback(const struct option *option, const char *arg, int unset)
 643{
 644        int *opt = option->value;
 645
 646        *opt |= PICKAXE_BLAME_MOVE;
 647
 648        if (arg)
 649                blame_move_score = parse_score(arg);
 650        return 0;
 651}
 652
 653static int is_a_rev(const char *name)
 654{
 655        struct object_id oid;
 656
 657        if (get_oid(name, &oid))
 658                return 0;
 659        return OBJ_NONE < oid_object_info(the_repository, &oid, NULL);
 660}
 661
 662int cmd_blame(int argc, const char **argv, const char *prefix)
 663{
 664        struct rev_info revs;
 665        const char *path;
 666        struct blame_scoreboard sb;
 667        struct blame_origin *o;
 668        struct blame_entry *ent = NULL;
 669        long dashdash_pos, lno;
 670        struct progress_info pi = { NULL, 0 };
 671
 672        struct string_list range_list = STRING_LIST_INIT_NODUP;
 673        int output_option = 0, opt = 0;
 674        int show_stats = 0;
 675        const char *revs_file = NULL;
 676        const char *contents_from = NULL;
 677        const struct option options[] = {
 678                OPT_BOOL(0, "incremental", &incremental, N_("Show blame entries as we find them, incrementally")),
 679                OPT_BOOL('b', NULL, &blank_boundary, N_("Show blank SHA-1 for boundary commits (Default: off)")),
 680                OPT_BOOL(0, "root", &show_root, N_("Do not treat root commits as boundaries (Default: off)")),
 681                OPT_BOOL(0, "show-stats", &show_stats, N_("Show work cost statistics")),
 682                OPT_BOOL(0, "progress", &show_progress, N_("Force progress reporting")),
 683                OPT_BIT(0, "score-debug", &output_option, N_("Show output score for blame entries"), OUTPUT_SHOW_SCORE),
 684                OPT_BIT('f', "show-name", &output_option, N_("Show original filename (Default: auto)"), OUTPUT_SHOW_NAME),
 685                OPT_BIT('n', "show-number", &output_option, N_("Show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER),
 686                OPT_BIT('p', "porcelain", &output_option, N_("Show in a format designed for machine consumption"), OUTPUT_PORCELAIN),
 687                OPT_BIT(0, "line-porcelain", &output_option, N_("Show porcelain format with per-line commit information"), OUTPUT_PORCELAIN|OUTPUT_LINE_PORCELAIN),
 688                OPT_BIT('c', NULL, &output_option, N_("Use the same output mode as git-annotate (Default: off)"), OUTPUT_ANNOTATE_COMPAT),
 689                OPT_BIT('t', NULL, &output_option, N_("Show raw timestamp (Default: off)"), OUTPUT_RAW_TIMESTAMP),
 690                OPT_BIT('l', NULL, &output_option, N_("Show long commit SHA1 (Default: off)"), OUTPUT_LONG_OBJECT_NAME),
 691                OPT_BIT('s', NULL, &output_option, N_("Suppress author name and timestamp (Default: off)"), OUTPUT_NO_AUTHOR),
 692                OPT_BIT('e', "show-email", &output_option, N_("Show author email instead of name (Default: off)"), OUTPUT_SHOW_EMAIL),
 693                OPT_BIT('w', NULL, &xdl_opts, N_("Ignore whitespace differences"), XDF_IGNORE_WHITESPACE),
 694
 695                /*
 696                 * The following two options are parsed by parse_revision_opt()
 697                 * and are only included here to get included in the "-h"
 698                 * output:
 699                 */
 700                { OPTION_LOWLEVEL_CALLBACK, 0, "indent-heuristic", NULL, NULL, N_("Use an experimental heuristic to improve diffs"), PARSE_OPT_NOARG, parse_opt_unknown_cb },
 701
 702                OPT_BIT(0, "minimal", &xdl_opts, N_("Spend extra cycles to find better match"), XDF_NEED_MINIMAL),
 703                OPT_STRING('S', NULL, &revs_file, N_("file"), N_("Use revisions from <file> instead of calling git-rev-list")),
 704                OPT_STRING(0, "contents", &contents_from, N_("file"), N_("Use <file>'s contents as the final image")),
 705                { OPTION_CALLBACK, 'C', NULL, &opt, N_("score"), N_("Find line copies within and across files"), PARSE_OPT_OPTARG, blame_copy_callback },
 706                { OPTION_CALLBACK, 'M', NULL, &opt, N_("score"), N_("Find line movements within and across files"), PARSE_OPT_OPTARG, blame_move_callback },
 707                OPT_STRING_LIST('L', NULL, &range_list, N_("n,m"), N_("Process only line range n,m, counting from 1")),
 708                OPT__ABBREV(&abbrev),
 709                OPT_END()
 710        };
 711
 712        struct parse_opt_ctx_t ctx;
 713        int cmd_is_annotate = !strcmp(argv[0], "annotate");
 714        struct range_set ranges;
 715        unsigned int range_i;
 716        long anchor;
 717
 718        git_config(git_blame_config, &output_option);
 719        init_revisions(&revs, NULL);
 720        revs.date_mode = blame_date_mode;
 721        revs.diffopt.flags.allow_textconv = 1;
 722        revs.diffopt.flags.follow_renames = 1;
 723
 724        save_commit_buffer = 0;
 725        dashdash_pos = 0;
 726        show_progress = -1;
 727
 728        parse_options_start(&ctx, argc, argv, prefix, options,
 729                            PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
 730        for (;;) {
 731                switch (parse_options_step(&ctx, options, blame_opt_usage)) {
 732                case PARSE_OPT_HELP:
 733                case PARSE_OPT_ERROR:
 734                        exit(129);
 735                case PARSE_OPT_DONE:
 736                        if (ctx.argv[0])
 737                                dashdash_pos = ctx.cpidx;
 738                        goto parse_done;
 739                }
 740
 741                if (!strcmp(ctx.argv[0], "--reverse")) {
 742                        ctx.argv[0] = "--children";
 743                        reverse = 1;
 744                }
 745                parse_revision_opt(&revs, &ctx, options, blame_opt_usage);
 746        }
 747parse_done:
 748        no_whole_file_rename = !revs.diffopt.flags.follow_renames;
 749        xdl_opts |= revs.diffopt.xdl_opts & XDF_INDENT_HEURISTIC;
 750        revs.diffopt.flags.follow_renames = 0;
 751        argc = parse_options_end(&ctx);
 752
 753        if (incremental || (output_option & OUTPUT_PORCELAIN)) {
 754                if (show_progress > 0)
 755                        die(_("--progress can't be used with --incremental or porcelain formats"));
 756                show_progress = 0;
 757        } else if (show_progress < 0)
 758                show_progress = isatty(2);
 759
 760        if (0 < abbrev && abbrev < GIT_SHA1_HEXSZ)
 761                /* one more abbrev length is needed for the boundary commit */
 762                abbrev++;
 763        else if (!abbrev)
 764                abbrev = GIT_SHA1_HEXSZ;
 765
 766        if (revs_file && read_ancestry(revs_file))
 767                die_errno("reading graft file '%s' failed", revs_file);
 768
 769        if (cmd_is_annotate) {
 770                output_option |= OUTPUT_ANNOTATE_COMPAT;
 771                blame_date_mode.type = DATE_ISO8601;
 772        } else {
 773                blame_date_mode = revs.date_mode;
 774        }
 775
 776        /* The maximum width used to show the dates */
 777        switch (blame_date_mode.type) {
 778        case DATE_RFC2822:
 779                blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
 780                break;
 781        case DATE_ISO8601_STRICT:
 782                blame_date_width = sizeof("2006-10-19T16:00:04-07:00");
 783                break;
 784        case DATE_ISO8601:
 785                blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
 786                break;
 787        case DATE_RAW:
 788                blame_date_width = sizeof("1161298804 -0700");
 789                break;
 790        case DATE_UNIX:
 791                blame_date_width = sizeof("1161298804");
 792                break;
 793        case DATE_SHORT:
 794                blame_date_width = sizeof("2006-10-19");
 795                break;
 796        case DATE_RELATIVE:
 797                /*
 798                 * TRANSLATORS: This string is used to tell us the
 799                 * maximum display width for a relative timestamp in
 800                 * "git blame" output.  For C locale, "4 years, 11
 801                 * months ago", which takes 22 places, is the longest
 802                 * among various forms of relative timestamps, but
 803                 * your language may need more or fewer display
 804                 * columns.
 805                 */
 806                blame_date_width = utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
 807                break;
 808        case DATE_NORMAL:
 809                blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
 810                break;
 811        case DATE_STRFTIME:
 812                blame_date_width = strlen(show_date(0, 0, &blame_date_mode)) + 1; /* add the null */
 813                break;
 814        }
 815        blame_date_width -= 1; /* strip the null */
 816
 817        if (revs.diffopt.flags.find_copies_harder)
 818                opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
 819                        PICKAXE_BLAME_COPY_HARDER);
 820
 821        /*
 822         * We have collected options unknown to us in argv[1..unk]
 823         * which are to be passed to revision machinery if we are
 824         * going to do the "bottom" processing.
 825         *
 826         * The remaining are:
 827         *
 828         * (1) if dashdash_pos != 0, it is either
 829         *     "blame [revisions] -- <path>" or
 830         *     "blame -- <path> <rev>"
 831         *
 832         * (2) otherwise, it is one of the two:
 833         *     "blame [revisions] <path>"
 834         *     "blame <path> <rev>"
 835         *
 836         * Note that we must strip out <path> from the arguments: we do not
 837         * want the path pruning but we may want "bottom" processing.
 838         */
 839        if (dashdash_pos) {
 840                switch (argc - dashdash_pos - 1) {
 841                case 2: /* (1b) */
 842                        if (argc != 4)
 843                                usage_with_options(blame_opt_usage, options);
 844                        /* reorder for the new way: <rev> -- <path> */
 845                        argv[1] = argv[3];
 846                        argv[3] = argv[2];
 847                        argv[2] = "--";
 848                        /* FALLTHROUGH */
 849                case 1: /* (1a) */
 850                        path = add_prefix(prefix, argv[--argc]);
 851                        argv[argc] = NULL;
 852                        break;
 853                default:
 854                        usage_with_options(blame_opt_usage, options);
 855                }
 856        } else {
 857                if (argc < 2)
 858                        usage_with_options(blame_opt_usage, options);
 859                if (argc == 3 && is_a_rev(argv[argc - 1])) { /* (2b) */
 860                        path = add_prefix(prefix, argv[1]);
 861                        argv[1] = argv[2];
 862                } else {        /* (2a) */
 863                        if (argc == 2 && is_a_rev(argv[1]) && !get_git_work_tree())
 864                                die("missing <path> to blame");
 865                        path = add_prefix(prefix, argv[argc - 1]);
 866                }
 867                argv[argc - 1] = "--";
 868        }
 869
 870        revs.disable_stdin = 1;
 871        setup_revisions(argc, argv, &revs, NULL);
 872
 873        init_scoreboard(&sb);
 874        sb.revs = &revs;
 875        sb.contents_from = contents_from;
 876        sb.reverse = reverse;
 877        setup_scoreboard(&sb, path, &o);
 878        lno = sb.num_lines;
 879
 880        if (lno && !range_list.nr)
 881                string_list_append(&range_list, "1");
 882
 883        anchor = 1;
 884        range_set_init(&ranges, range_list.nr);
 885        for (range_i = 0; range_i < range_list.nr; ++range_i) {
 886                long bottom, top;
 887                if (parse_range_arg(range_list.items[range_i].string,
 888                                    nth_line_cb, &sb, lno, anchor,
 889                                    &bottom, &top, sb.path))
 890                        usage(blame_usage);
 891                if (lno < top || ((lno || bottom) && lno < bottom))
 892                        die(Q_("file %s has only %lu line",
 893                               "file %s has only %lu lines",
 894                               lno), path, lno);
 895                if (bottom < 1)
 896                        bottom = 1;
 897                if (top < 1)
 898                        top = lno;
 899                bottom--;
 900                range_set_append_unsafe(&ranges, bottom, top);
 901                anchor = top + 1;
 902        }
 903        sort_and_merge_range_set(&ranges);
 904
 905        for (range_i = ranges.nr; range_i > 0; --range_i) {
 906                const struct range *r = &ranges.ranges[range_i - 1];
 907                ent = blame_entry_prepend(ent, r->start, r->end, o);
 908        }
 909
 910        o->suspects = ent;
 911        prio_queue_put(&sb.commits, o->commit);
 912
 913        blame_origin_decref(o);
 914
 915        range_set_release(&ranges);
 916        string_list_clear(&range_list, 0);
 917
 918        sb.ent = NULL;
 919        sb.path = path;
 920
 921        if (blame_move_score)
 922                sb.move_score = blame_move_score;
 923        if (blame_copy_score)
 924                sb.copy_score = blame_copy_score;
 925
 926        sb.debug = DEBUG;
 927        sb.on_sanity_fail = &sanity_check_on_fail;
 928
 929        sb.show_root = show_root;
 930        sb.xdl_opts = xdl_opts;
 931        sb.no_whole_file_rename = no_whole_file_rename;
 932
 933        read_mailmap(&mailmap, NULL);
 934
 935        sb.found_guilty_entry = &found_guilty_entry;
 936        sb.found_guilty_entry_data = &pi;
 937        if (show_progress)
 938                pi.progress = start_delayed_progress(_("Blaming lines"), sb.num_lines);
 939
 940        assign_blame(&sb, opt);
 941
 942        stop_progress(&pi.progress);
 943
 944        if (!incremental)
 945                setup_pager();
 946        else
 947                return 0;
 948
 949        blame_sort_final(&sb);
 950
 951        blame_coalesce(&sb);
 952
 953        if (!(output_option & OUTPUT_PORCELAIN))
 954                find_alignment(&sb, &output_option);
 955
 956        output(&sb, output_option);
 957        free((void *)sb.final_buf);
 958        for (ent = sb.ent; ent; ) {
 959                struct blame_entry *e = ent->next;
 960                free(ent);
 961                ent = e;
 962        }
 963
 964        if (show_stats) {
 965                printf("num read blob: %d\n", sb.num_read_blob);
 966                printf("num get patch: %d\n", sb.num_get_patch);
 967                printf("num commits: %d\n", sb.num_commits);
 968        }
 969        return 0;
 970}