git.oblomov.eu Git - git/blob - pretty.c

   1 #include "cache.h"
   2 #include "commit.h"
   3 #include "utf8.h"
   4 #include "diff.h"
   5 #include "revision.h"
   6 #include "string-list.h"
   7 #include "mailmap.h"
   8 #include "log-tree.h"
   9 #include "notes.h"
  10 #include "color.h"
  11 #include "reflog-walk.h"
  12 #include "gpg-interface.h"
  13
  14 static char *user_format;
  15 static struct cmt_fmt_map {
  16         const char *name;
  17         enum cmit_fmt format;
  18         int is_tformat;
  19         int is_alias;
  20         const char *user_format;
  21 } *commit_formats;
  22 static size_t builtin_formats_len;
  23 static size_t commit_formats_len;
  24 static size_t commit_formats_alloc;
  25 static struct cmt_fmt_map *find_commit_format(const char *sought);
  26
  27 static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
  28 {
  29         free(user_format);
  30         user_format = xstrdup(cp);
  31         if (is_tformat)
  32                 rev->use_terminator = 1;
  33         rev->commit_format = CMIT_FMT_USERFORMAT;
  34 }
  35
  36 static int git_pretty_formats_config(const char *var, const char *value, void *cb)
  37 {
  38         struct cmt_fmt_map *commit_format = NULL;
  39         const char *name;
  40         const char *fmt;
  41         int i;
  42
  43         if (prefixcmp(var, "pretty."))
  44                 return 0;
  45
  46         name = var + strlen("pretty.");
  47         for (i = 0; i < builtin_formats_len; i++) {
  48                 if (!strcmp(commit_formats[i].name, name))
  49                         return 0;
  50         }
  51
  52         for (i = builtin_formats_len; i < commit_formats_len; i++) {
  53                 if (!strcmp(commit_formats[i].name, name)) {
  54                         commit_format = &commit_formats[i];
  55                         break;
  56                 }
  57         }
  58
  59         if (!commit_format) {
  60                 ALLOC_GROW(commit_formats, commit_formats_len+1,
  61                            commit_formats_alloc);
  62                 commit_format = &commit_formats[commit_formats_len];
  63                 memset(commit_format, 0, sizeof(*commit_format));
  64                 commit_formats_len++;
  65         }
  66
  67         commit_format->name = xstrdup(name);
  68         commit_format->format = CMIT_FMT_USERFORMAT;
  69         git_config_string(&fmt, var, value);
  70         if (!prefixcmp(fmt, "format:") || !prefixcmp(fmt, "tformat:")) {
  71                 commit_format->is_tformat = fmt[0] == 't';
  72                 fmt = strchr(fmt, ':') + 1;
  73         } else if (strchr(fmt, '%'))
  74                 commit_format->is_tformat = 1;
  75         else
  76                 commit_format->is_alias = 1;
  77         commit_format->user_format = fmt;
  78
  79         return 0;
  80 }
  81
  82 static void setup_commit_formats(void)
  83 {
  84         struct cmt_fmt_map builtin_formats[] = {
  85                 { "raw",        CMIT_FMT_RAW,           0 },
  86                 { "medium",     CMIT_FMT_MEDIUM,        0 },
  87                 { "short",      CMIT_FMT_SHORT,         0 },
  88                 { "email",      CMIT_FMT_EMAIL,         0 },
  89                 { "fuller",     CMIT_FMT_FULLER,        0 },
  90                 { "full",       CMIT_FMT_FULL,          0 },
  91                 { "oneline",    CMIT_FMT_ONELINE,       1 }
  92         };
  93         commit_formats_len = ARRAY_SIZE(builtin_formats);
  94         builtin_formats_len = commit_formats_len;
  95         ALLOC_GROW(commit_formats, commit_formats_len, commit_formats_alloc);
  96         memcpy(commit_formats, builtin_formats,
  97                sizeof(*builtin_formats)*ARRAY_SIZE(builtin_formats));
  98
  99         git_config(git_pretty_formats_config, NULL);
 100 }
 101
 102 static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
 103                                                         const char *original,
 104                                                         int num_redirections)
 105 {
 106         struct cmt_fmt_map *found = NULL;
 107         size_t found_match_len = 0;
 108         int i;
 109
 110         if (num_redirections >= commit_formats_len)
 111                 die("invalid --pretty format: "
 112                     "'%s' references an alias which points to itself",
 113                     original);
 114
 115         for (i = 0; i < commit_formats_len; i++) {
 116                 size_t match_len;
 117
 118                 if (prefixcmp(commit_formats[i].name, sought))
 119                         continue;
 120
 121                 match_len = strlen(commit_formats[i].name);
 122                 if (found == NULL || found_match_len > match_len) {
 123                         found = &commit_formats[i];
 124                         found_match_len = match_len;
 125                 }
 126         }
 127
 128         if (found && found->is_alias) {
 129                 found = find_commit_format_recursive(found->user_format,
 130                                                      original,
 131                                                      num_redirections+1);
 132         }
 133
 134         return found;
 135 }
 136
 137 static struct cmt_fmt_map *find_commit_format(const char *sought)
 138 {
 139         if (!commit_formats)
 140                 setup_commit_formats();
 141
 142         return find_commit_format_recursive(sought, sought, 0);
 143 }
 144
 145 void get_commit_format(const char *arg, struct rev_info *rev)
 146 {
 147         struct cmt_fmt_map *commit_format;
 148
 149         rev->use_terminator = 0;
 150         if (!arg || !*arg) {
 151                 rev->commit_format = CMIT_FMT_DEFAULT;
 152                 return;
 153         }
 154         if (!prefixcmp(arg, "format:") || !prefixcmp(arg, "tformat:")) {
 155                 save_user_format(rev, strchr(arg, ':') + 1, arg[0] == 't');
 156                 return;
 157         }
 158
 159         if (strchr(arg, '%')) {
 160                 save_user_format(rev, arg, 1);
 161                 return;
 162         }
 163
 164         commit_format = find_commit_format(arg);
 165         if (!commit_format)
 166                 die("invalid --pretty format: %s", arg);
 167
 168         rev->commit_format = commit_format->format;
 169         rev->use_terminator = commit_format->is_tformat;
 170         if (commit_format->format == CMIT_FMT_USERFORMAT) {
 171                 save_user_format(rev, commit_format->user_format,
 172                                  commit_format->is_tformat);
 173         }
 174 }
 175
 176 /*
 177  * Generic support for pretty-printing the header
 178  */
 179 static int get_one_line(const char *msg)
 180 {
 181         int ret = 0;
 182
 183         for (;;) {
 184                 char c = *msg++;
 185                 if (!c)
 186                         break;
 187                 ret++;
 188                 if (c == '\n')
 189                         break;
 190         }
 191         return ret;
 192 }
 193
 194 /* High bit set, or ISO-2022-INT */
 195 static int non_ascii(int ch)
 196 {
 197         return !isascii(ch) || ch == '\033';
 198 }
 199
 200 int has_non_ascii(const char *s)
 201 {
 202         int ch;
 203         if (!s)
 204                 return 0;
 205         while ((ch = *s++) != '\0') {
 206                 if (non_ascii(ch))
 207                         return 1;
 208         }
 209         return 0;
 210 }
 211
 212 static int is_rfc822_special(char ch)
 213 {
 214         switch (ch) {
 215         case '(':
 216         case ')':
 217         case '<':
 218         case '>':
 219         case '[':
 220         case ']':
 221         case ':':
 222         case ';':
 223         case '@':
 224         case ',':
 225         case '.':
 226         case '"':
 227         case '\\':
 228                 return 1;
 229         default:
 230                 return 0;
 231         }
 232 }
 233
 234 static int needs_rfc822_quoting(const char *s, int len)
 235 {
 236         int i;
 237         for (i = 0; i < len; i++)
 238                 if (is_rfc822_special(s[i]))
 239                         return 1;
 240         return 0;
 241 }
 242
 243 static int last_line_length(struct strbuf *sb)
 244 {
 245         int i;
 246
 247         /* How many bytes are already used on the last line? */
 248         for (i = sb->len - 1; i >= 0; i--)
 249                 if (sb->buf[i] == '\n')
 250                         break;
 251         return sb->len - (i + 1);
 252 }
 253
 254 static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
 255 {
 256         int i;
 257
 258         /* just a guess, we may have to also backslash-quote */
 259         strbuf_grow(out, len + 2);
 260
 261         strbuf_addch(out, '"');
 262         for (i = 0; i < len; i++) {
 263                 switch (s[i]) {
 264                 case '"':
 265                 case '\\':
 266                         strbuf_addch(out, '\\');
 267                         /* fall through */
 268                 default:
 269                         strbuf_addch(out, s[i]);
 270                 }
 271         }
 272         strbuf_addch(out, '"');
 273 }
 274
 275 enum rfc2047_type {
 276         RFC2047_SUBJECT,
 277         RFC2047_ADDRESS,
 278 };
 279
 280 static int is_rfc2047_special(char ch, enum rfc2047_type type)
 281 {
 282         /*
 283          * rfc2047, section 4.2:
 284          *
 285          *    8-bit values which correspond to printable ASCII characters other
 286          *    than "=", "?", and "_" (underscore), MAY be represented as those
 287          *    characters.  (But see section 5 for restrictions.)  In
 288          *    particular, SPACE and TAB MUST NOT be represented as themselves
 289          *    within encoded words.
 290          */
 291
 292         /*
 293          * rule out non-ASCII characters and non-printable characters (the
 294          * non-ASCII check should be redundant as isprint() is not localized
 295          * and only knows about ASCII, but be defensive about that)
 296          */
 297         if (non_ascii(ch) || !isprint(ch))
 298                 return 1;
 299
 300         /*
 301          * rule out special printable characters (' ' should be the only
 302          * whitespace character considered printable, but be defensive and use
 303          * isspace())
 304          */
 305         if (isspace(ch) || ch == '=' || ch == '?' || ch == '_')
 306                 return 1;
 307
 308         /*
 309          * rfc2047, section 5.3:
 310          *
 311          *    As a replacement for a 'word' entity within a 'phrase', for example,
 312          *    one that precedes an address in a From, To, or Cc header.  The ABNF
 313          *    definition for 'phrase' from RFC 822 thus becomes:
 314          *
 315          *    phrase = 1*( encoded-word / word )
 316          *
 317          *    In this case the set of characters that may be used in a "Q"-encoded
 318          *    'encoded-word' is restricted to: <upper and lower case ASCII
 319          *    letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
 320          *    (underscore, ASCII 95.)>.  An 'encoded-word' that appears within a
 321          *    'phrase' MUST be separated from any adjacent 'word', 'text' or
 322          *    'special' by 'linear-white-space'.
 323          */
 324
 325         if (type != RFC2047_ADDRESS)
 326                 return 0;
 327
 328         /* '=' and '_' are special cases and have been checked above */
 329         return !(isalnum(ch) || ch == '!' || ch == '*' || ch == '+' || ch == '-' || ch == '/');
 330 }
 331
 332 static int needs_rfc2047_encoding(const char *line, int len,
 333                                   enum rfc2047_type type)
 334 {
 335         int i;
 336
 337         for (i = 0; i < len; i++) {
 338                 int ch = line[i];
 339                 if (non_ascii(ch) || ch == '\n')
 340                         return 1;
 341                 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
 342                         return 1;
 343         }
 344
 345         return 0;
 346 }
 347
 348 static void add_rfc2047(struct strbuf *sb, const char *line, size_t len,
 349                        const char *encoding, enum rfc2047_type type)
 350 {
 351         static const int max_encoded_length = 76; /* per rfc2047 */
 352         int i;
 353         int line_len = last_line_length(sb);
 354
 355         strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
 356         strbuf_addf(sb, "=?%s?q?", encoding);
 357         line_len += strlen(encoding) + 5; /* 5 for =??q? */
 358
 359         while (len) {
 360                 /*
 361                  * RFC 2047, section 5 (3):
 362                  *
 363                  * Each 'encoded-word' MUST represent an integral number of
 364                  * characters.  A multi-octet character may not be split across
 365                  * adjacent 'encoded- word's.
 366                  */
 367                 const unsigned char *p = (const unsigned char *)line;
 368                 int chrlen = mbs_chrlen(&line, &len, encoding);
 369                 int is_special = (chrlen > 1) || is_rfc2047_special(*p, type);
 370
 371                 /* "=%02X" * chrlen, or the byte itself */
 372                 const char *encoded_fmt = is_special ? "=%02X"    : "%c";
 373                 int         encoded_len = is_special ? 3 * chrlen : 1;
 374
 375                 /*
 376                  * According to RFC 2047, we could encode the special character
 377                  * ' ' (space) with '_' (underscore) for readability. But many
 378                  * programs do not understand this and just leave the
 379                  * underscore in place. Thus, we do nothing special here, which
 380                  * causes ' ' to be encoded as '=20', avoiding this problem.
 381                  */
 382
 383                 if (line_len + encoded_len + 2 > max_encoded_length) {
 384                         /* It won't fit with trailing "?=" --- break the line */
 385                         strbuf_addf(sb, "?=\n =?%s?q?", encoding);
 386                         line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
 387                 }
 388
 389                 for (i = 0; i < chrlen; i++)
 390                         strbuf_addf(sb, encoded_fmt, p[i]);
 391                 line_len += encoded_len;
 392         }
 393         strbuf_addstr(sb, "?=");
 394 }
 395
 396 void pp_user_info(const struct pretty_print_context *pp,
 397                   const char *what, struct strbuf *sb,
 398                   const char *line, const char *encoding)
 399 {
 400         struct strbuf name;
 401         struct strbuf mail;
 402         struct ident_split ident;
 403         int linelen;
 404         char *line_end, *date;
 405         const char *mailbuf, *namebuf;
 406         size_t namelen, maillen;
 407         int max_length = 78; /* per rfc2822 */
 408         unsigned long time;
 409         int tz;
 410
 411         if (pp->fmt == CMIT_FMT_ONELINE)
 412                 return;
 413
 414         line_end = strchr(line, '\n');
 415         if (!line_end) {
 416                 line_end = strchr(line, '\0');
 417                 if (!line_end)
 418                         return;
 419         }
 420
 421         linelen = ++line_end - line;
 422         if (split_ident_line(&ident, line, linelen))
 423                 return;
 424
 425
 426         mailbuf = ident.mail_begin;
 427         maillen = ident.mail_end - ident.mail_begin;
 428         namebuf = ident.name_begin;
 429         namelen = ident.name_end - ident.name_begin;
 430
 431         if (pp->mailmap)
 432                 map_user(pp->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
 433
 434         strbuf_init(&mail, 0);
 435         strbuf_init(&name, 0);
 436
 437         strbuf_add(&mail, mailbuf, maillen);
 438         strbuf_add(&name, namebuf, namelen);
 439
 440         namelen = name.len + mail.len + 3; /* ' ' + '<' + '>' */
 441         time = strtoul(ident.date_begin, &date, 10);
 442         tz = strtol(date, NULL, 10);
 443
 444         if (pp->fmt == CMIT_FMT_EMAIL) {
 445                 strbuf_addstr(sb, "From: ");
 446                 if (needs_rfc2047_encoding(name.buf, name.len, RFC2047_ADDRESS)) {
 447                         add_rfc2047(sb, name.buf, name.len,
 448                                     encoding, RFC2047_ADDRESS);
 449                         max_length = 76; /* per rfc2047 */
 450                 } else if (needs_rfc822_quoting(name.buf, name.len)) {
 451                         struct strbuf quoted = STRBUF_INIT;
 452                         add_rfc822_quoted(&quoted, name.buf, name.len);
 453                         strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
 454                                                         -6, 1, max_length);
 455                         strbuf_release(&quoted);
 456                 } else {
 457                         strbuf_add_wrapped_bytes(sb, name.buf, name.len,
 458                                                  -6, 1, max_length);
 459                 }
 460                 if (namelen - name.len + last_line_length(sb) > max_length)
 461                         strbuf_addch(sb, '\n');
 462
 463                 strbuf_addf(sb, " <%s>\n", mail.buf);
 464         } else {
 465                 strbuf_addf(sb, "%s: %.*s%s <%s>\n", what,
 466                               (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0,
 467                               "    ", name.buf, mail.buf);
 468         }
 469
 470         strbuf_release(&mail);
 471         strbuf_release(&name);
 472
 473         switch (pp->fmt) {
 474         case CMIT_FMT_MEDIUM:
 475                 strbuf_addf(sb, "Date:   %s\n", show_date(time, tz, pp->date_mode));
 476                 break;
 477         case CMIT_FMT_EMAIL:
 478                 strbuf_addf(sb, "Date: %s\n", show_date(time, tz, DATE_RFC2822));
 479                 break;
 480         case CMIT_FMT_FULLER:
 481                 strbuf_addf(sb, "%sDate: %s\n", what, show_date(time, tz, pp->date_mode));
 482                 break;
 483         default:
 484                 /* notin' */
 485                 break;
 486         }
 487 }
 488
 489 static int is_empty_line(const char *line, int *len_p)
 490 {
 491         int len = *len_p;
 492         while (len && isspace(line[len-1]))
 493                 len--;
 494         *len_p = len;
 495         return !len;
 496 }
 497
 498 static const char *skip_empty_lines(const char *msg)
 499 {
 500         for (;;) {
 501                 int linelen = get_one_line(msg);
 502                 int ll = linelen;
 503                 if (!linelen)
 504                         break;
 505                 if (!is_empty_line(msg, &ll))
 506                         break;
 507                 msg += linelen;
 508         }
 509         return msg;
 510 }
 511
 512 static void add_merge_info(const struct pretty_print_context *pp,
 513                            struct strbuf *sb, const struct commit *commit)
 514 {
 515         struct commit_list *parent = commit->parents;
 516
 517         if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
 518             !parent || !parent->next)
 519                 return;
 520
 521         strbuf_addstr(sb, "Merge:");
 522
 523         while (parent) {
 524                 struct commit *p = parent->item;
 525                 const char *hex = NULL;
 526                 if (pp->abbrev)
 527                         hex = find_unique_abbrev(p->object.sha1, pp->abbrev);
 528                 if (!hex)
 529                         hex = sha1_to_hex(p->object.sha1);
 530                 parent = parent->next;
 531
 532                 strbuf_addf(sb, " %s", hex);
 533         }
 534         strbuf_addch(sb, '\n');
 535 }
 536
 537 static char *get_header(const struct commit *commit, const char *msg,
 538                         const char *key)
 539 {
 540         int key_len = strlen(key);
 541         const char *line = msg;
 542
 543         while (line) {
 544                 const char *eol = strchr(line, '\n'), *next;
 545
 546                 if (line == eol)
 547                         return NULL;
 548                 if (!eol) {
 549                         warning("malformed commit (header is missing newline): %s",
 550                                 sha1_to_hex(commit->object.sha1));
 551                         eol = line + strlen(line);
 552                         next = NULL;
 553                 } else
 554                         next = eol + 1;
 555                 if (eol - line > key_len &&
 556                     !strncmp(line, key, key_len) &&
 557                     line[key_len] == ' ') {
 558                         return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
 559                 }
 560                 line = next;
 561         }
 562         return NULL;
 563 }
 564
 565 static char *replace_encoding_header(char *buf, const char *encoding)
 566 {
 567         struct strbuf tmp = STRBUF_INIT;
 568         size_t start, len;
 569         char *cp = buf;
 570
 571         /* guess if there is an encoding header before a \n\n */
 572         while (strncmp(cp, "encoding ", strlen("encoding "))) {
 573                 cp = strchr(cp, '\n');
 574                 if (!cp || *++cp == '\n')
 575                         return buf;
 576         }
 577         start = cp - buf;
 578         cp = strchr(cp, '\n');
 579         if (!cp)
 580                 return buf; /* should not happen but be defensive */
 581         len = cp + 1 - (buf + start);
 582
 583         strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
 584         if (is_encoding_utf8(encoding)) {
 585                 /* we have re-coded to UTF-8; drop the header */
 586                 strbuf_remove(&tmp, start, len);
 587         } else {
 588                 /* just replaces XXXX in 'encoding XXXX\n' */
 589                 strbuf_splice(&tmp, start + strlen("encoding "),
 590                                           len - strlen("encoding \n"),
 591                                           encoding, strlen(encoding));
 592         }
 593         return strbuf_detach(&tmp, NULL);
 594 }
 595
 596 char *logmsg_reencode(const struct commit *commit,
 597                       char **commit_encoding,
 598                       const char *output_encoding)
 599 {
 600         static const char *utf8 = "UTF-8";
 601         const char *use_encoding;
 602         char *encoding;
 603         char *msg = commit->buffer;
 604         char *out;
 605
 606         if (!msg) {
 607                 enum object_type type;
 608                 unsigned long size;
 609
 610                 msg = read_sha1_file(commit->object.sha1, &type, &size);
 611                 if (!msg)
 612                         die("Cannot read commit object %s",
 613                             sha1_to_hex(commit->object.sha1));
 614                 if (type != OBJ_COMMIT)
 615                         die("Expected commit for '%s', got %s",
 616                             sha1_to_hex(commit->object.sha1), typename(type));
 617         }
 618
 619         if (!output_encoding || !*output_encoding) {
 620                 if (commit_encoding)
 621                         *commit_encoding =
 622                                 get_header(commit, msg, "encoding");
 623                 return msg;
 624         }
 625         encoding = get_header(commit, msg, "encoding");
 626         if (commit_encoding)
 627                 *commit_encoding = encoding;
 628         use_encoding = encoding ? encoding : utf8;
 629         if (same_encoding(use_encoding, output_encoding)) {
 630                 /*
 631                  * No encoding work to be done. If we have no encoding header
 632                  * at all, then there's nothing to do, and we can return the
 633                  * message verbatim (whether newly allocated or not).
 634                  */
 635                 if (!encoding)
 636                         return msg;
 637
 638                 /*
 639                  * Otherwise, we still want to munge the encoding header in the
 640                  * result, which will be done by modifying the buffer. If we
 641                  * are using a fresh copy, we can reuse it. But if we are using
 642                  * the cached copy from commit->buffer, we need to duplicate it
 643                  * to avoid munging commit->buffer.
 644                  */
 645                 out = msg;
 646                 if (out == commit->buffer)
 647                         out = xstrdup(out);
 648         }
 649         else {
 650                 /*
 651                  * There's actual encoding work to do. Do the reencoding, which
 652                  * still leaves the header to be replaced in the next step. At
 653                  * this point, we are done with msg. If we allocated a fresh
 654                  * copy, we can free it.
 655                  */
 656                 out = reencode_string(msg, output_encoding, use_encoding);
 657                 if (out && msg != commit->buffer)
 658                         free(msg);
 659         }
 660
 661         /*
 662          * This replacement actually consumes the buffer we hand it, so we do
 663          * not have to worry about freeing the old "out" here.
 664          */
 665         if (out)
 666                 out = replace_encoding_header(out, output_encoding);
 667
 668         if (!commit_encoding)
 669                 free(encoding);
 670         /*
 671          * If the re-encoding failed, out might be NULL here; in that
 672          * case we just return the commit message verbatim.
 673          */
 674         return out ? out : msg;
 675 }
 676
 677 void logmsg_free(char *msg, const struct commit *commit)
 678 {
 679         if (msg != commit->buffer)
 680                 free(msg);
 681 }
 682
 683 static int mailmap_name(const char **email, size_t *email_len,
 684                         const char **name, size_t *name_len)
 685 {
 686         static struct string_list *mail_map;
 687         if (!mail_map) {
 688                 mail_map = xcalloc(1, sizeof(*mail_map));
 689                 read_mailmap(mail_map, NULL);
 690         }
 691         return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
 692 }
 693
 694 static size_t format_person_part(struct strbuf *sb, char part,
 695                                  const char *msg, int len, enum date_mode dmode)
 696 {
 697         /* currently all placeholders have same length */
 698         const int placeholder_len = 2;
 699         int tz;
 700         unsigned long date = 0;
 701         struct ident_split s;
 702         const char *name, *mail;
 703         size_t maillen, namelen;
 704
 705         if (split_ident_line(&s, msg, len) < 0)
 706                 goto skip;
 707
 708         name = s.name_begin;
 709         namelen = s.name_end - s.name_begin;
 710         mail = s.mail_begin;
 711         maillen = s.mail_end - s.mail_begin;
 712
 713         if (part == 'N' || part == 'E') /* mailmap lookup */
 714                 mailmap_name(&mail, &maillen, &name, &namelen);
 715         if (part == 'n' || part == 'N') {       /* name */
 716                 strbuf_add(sb, name, namelen);
 717                 return placeholder_len;
 718         }
 719         if (part == 'e' || part == 'E') {       /* email */
 720                 strbuf_add(sb, mail, maillen);
 721                 return placeholder_len;
 722         }
 723
 724         if (!s.date_begin)
 725                 goto skip;
 726
 727         date = strtoul(s.date_begin, NULL, 10);
 728
 729         if (part == 't') {      /* date, UNIX timestamp */
 730                 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
 731                 return placeholder_len;
 732         }
 733
 734         /* parse tz */
 735         tz = strtoul(s.tz_begin + 1, NULL, 10);
 736         if (*s.tz_begin == '-')
 737                 tz = -tz;
 738
 739         switch (part) {
 740         case 'd':       /* date */
 741                 strbuf_addstr(sb, show_date(date, tz, dmode));
 742                 return placeholder_len;
 743         case 'D':       /* date, RFC2822 style */
 744                 strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
 745                 return placeholder_len;
 746         case 'r':       /* date, relative */
 747                 strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
 748                 return placeholder_len;
 749         case 'i':       /* date, ISO 8601 */
 750                 strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
 751                 return placeholder_len;
 752         }
 753
 754 skip:
 755         /*
 756          * reading from either a bogus commit, or a reflog entry with
 757          * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
 758          * to compute a valid return value.
 759          */
 760         if (part == 'n' || part == 'e' || part == 't' || part == 'd'
 761             || part == 'D' || part == 'r' || part == 'i')
 762                 return placeholder_len;
 763
 764         return 0; /* unknown placeholder */
 765 }
 766
 767 struct chunk {
 768         size_t off;
 769         size_t len;
 770 };
 771
 772 enum flush_type {
 773         no_flush,
 774         flush_right,
 775         flush_left,
 776         flush_both
 777 };
 778
 779 enum trunc_type {
 780         trunc_none,
 781         trunc_left,
 782         trunc_middle,
 783         trunc_right
 784 };
 785
 786 struct format_commit_context {
 787         const struct commit *commit;
 788         const struct pretty_print_context *pretty_ctx;
 789         unsigned commit_header_parsed:1;
 790         unsigned commit_message_parsed:1;
 791         struct signature_check signature_check;
 792         enum flush_type flush_type;
 793         enum trunc_type truncate;
 794         char *message;
 795         char *commit_encoding;
 796         size_t width, indent1, indent2;
 797         int auto_color;
 798         int padding;
 799
 800         /* These offsets are relative to the start of the commit message. */
 801         struct chunk author;
 802         struct chunk committer;
 803         size_t message_off;
 804         size_t subject_off;
 805         size_t body_off;
 806
 807         /* The following ones are relative to the result struct strbuf. */
 808         struct chunk abbrev_commit_hash;
 809         struct chunk abbrev_tree_hash;
 810         struct chunk abbrev_parent_hashes;
 811         size_t wrap_start;
 812 };
 813
 814 static int add_again(struct strbuf *sb, struct chunk *chunk)
 815 {
 816         if (chunk->len) {
 817                 strbuf_adddup(sb, chunk->off, chunk->len);
 818                 return 1;
 819         }
 820
 821         /*
 822          * We haven't seen this chunk before.  Our caller is surely
 823          * going to add it the hard way now.  Remember the most likely
 824          * start of the to-be-added chunk: the current end of the
 825          * struct strbuf.
 826          */
 827         chunk->off = sb->len;
 828         return 0;
 829 }
 830
 831 static void parse_commit_header(struct format_commit_context *context)
 832 {
 833         const char *msg = context->message;
 834         int i;
 835
 836         for (i = 0; msg[i]; i++) {
 837                 int eol;
 838                 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
 839                         ; /* do nothing */
 840
 841                 if (i == eol) {
 842                         break;
 843                 } else if (!prefixcmp(msg + i, "author ")) {
 844                         context->author.off = i + 7;
 845                         context->author.len = eol - i - 7;
 846                 } else if (!prefixcmp(msg + i, "committer ")) {
 847                         context->committer.off = i + 10;
 848                         context->committer.len = eol - i - 10;
 849                 }
 850                 i = eol;
 851         }
 852         context->message_off = i;
 853         context->commit_header_parsed = 1;
 854 }
 855
 856 static int istitlechar(char c)
 857 {
 858         return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
 859                 (c >= '0' && c <= '9') || c == '.' || c == '_';
 860 }
 861
 862 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
 863 {
 864         size_t trimlen;
 865         size_t start_len = sb->len;
 866         int space = 2;
 867
 868         for (; *msg && *msg != '\n'; msg++) {
 869                 if (istitlechar(*msg)) {
 870                         if (space == 1)
 871                                 strbuf_addch(sb, '-');
 872                         space = 0;
 873                         strbuf_addch(sb, *msg);
 874                         if (*msg == '.')
 875                                 while (*(msg+1) == '.')
 876                                         msg++;
 877                 } else
 878                         space |= 1;
 879         }
 880
 881         /* trim any trailing '.' or '-' characters */
 882         trimlen = 0;
 883         while (sb->len - trimlen > start_len &&
 884                 (sb->buf[sb->len - 1 - trimlen] == '.'
 885                 || sb->buf[sb->len - 1 - trimlen] == '-'))
 886                 trimlen++;
 887         strbuf_remove(sb, sb->len - trimlen, trimlen);
 888 }
 889
 890 const char *format_subject(struct strbuf *sb, const char *msg,
 891                            const char *line_separator)
 892 {
 893         int first = 1;
 894
 895         for (;;) {
 896                 const char *line = msg;
 897                 int linelen = get_one_line(line);
 898
 899                 msg += linelen;
 900                 if (!linelen || is_empty_line(line, &linelen))
 901                         break;
 902
 903                 if (!sb)
 904                         continue;
 905                 strbuf_grow(sb, linelen + 2);
 906                 if (!first)
 907                         strbuf_addstr(sb, line_separator);
 908                 strbuf_add(sb, line, linelen);
 909                 first = 0;
 910         }
 911         return msg;
 912 }
 913
 914 static void parse_commit_message(struct format_commit_context *c)
 915 {
 916         const char *msg = c->message + c->message_off;
 917         const char *start = c->message;
 918
 919         msg = skip_empty_lines(msg);
 920         c->subject_off = msg - start;
 921
 922         msg = format_subject(NULL, msg, NULL);
 923         msg = skip_empty_lines(msg);
 924         c->body_off = msg - start;
 925
 926         c->commit_message_parsed = 1;
 927 }
 928
 929 static void strbuf_wrap(struct strbuf *sb, size_t pos,
 930                         size_t width, size_t indent1, size_t indent2)
 931 {
 932         struct strbuf tmp = STRBUF_INIT;
 933
 934         if (pos)
 935                 strbuf_add(&tmp, sb->buf, pos);
 936         strbuf_add_wrapped_text(&tmp, sb->buf + pos,
 937                                 (int) indent1, (int) indent2, (int) width);
 938         strbuf_swap(&tmp, sb);
 939         strbuf_release(&tmp);
 940 }
 941
 942 static void rewrap_message_tail(struct strbuf *sb,
 943                                 struct format_commit_context *c,
 944                                 size_t new_width, size_t new_indent1,
 945                                 size_t new_indent2)
 946 {
 947         if (c->width == new_width && c->indent1 == new_indent1 &&
 948             c->indent2 == new_indent2)
 949                 return;
 950         if (c->wrap_start < sb->len)
 951                 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
 952         c->wrap_start = sb->len;
 953         c->width = new_width;
 954         c->indent1 = new_indent1;
 955         c->indent2 = new_indent2;
 956 }
 957
 958 static int format_reflog_person(struct strbuf *sb,
 959                                 char part,
 960                                 struct reflog_walk_info *log,
 961                                 enum date_mode dmode)
 962 {
 963         const char *ident;
 964
 965         if (!log)
 966                 return 2;
 967
 968         ident = get_reflog_ident(log);
 969         if (!ident)
 970                 return 2;
 971
 972         return format_person_part(sb, part, ident, strlen(ident), dmode);
 973 }
 974
 975 static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
 976                           const char *placeholder,
 977                           struct format_commit_context *c)
 978 {
 979         if (placeholder[1] == '(') {
 980                 const char *begin = placeholder + 2;
 981                 const char *end = strchr(begin, ')');
 982                 char color[COLOR_MAXLEN];
 983
 984                 if (!end)
 985                         return 0;
 986                 if (!prefixcmp(begin, "auto,")) {
 987                         if (!want_color(c->pretty_ctx->color))
 988                                 return end - placeholder + 1;
 989                         begin += 5;
 990                 }
 991                 color_parse_mem(begin,
 992                                 end - begin,
 993                                 "--pretty format", color);
 994                 strbuf_addstr(sb, color);
 995                 return end - placeholder + 1;
 996         }
 997         if (!prefixcmp(placeholder + 1, "red")) {
 998                 strbuf_addstr(sb, GIT_COLOR_RED);
 999                 return 4;
1000         } else if (!prefixcmp(placeholder + 1, "green")) {
1001                 strbuf_addstr(sb, GIT_COLOR_GREEN);
1002                 return 6;
1003         } else if (!prefixcmp(placeholder + 1, "blue")) {
1004                 strbuf_addstr(sb, GIT_COLOR_BLUE);
1005                 return 5;
1006         } else if (!prefixcmp(placeholder + 1, "reset")) {
1007                 strbuf_addstr(sb, GIT_COLOR_RESET);
1008                 return 6;
1009         } else
1010                 return 0;
1011 }
1012
1013 static size_t parse_padding_placeholder(struct strbuf *sb,
1014                                         const char *placeholder,
1015                                         struct format_commit_context *c)
1016 {
1017         const char *ch = placeholder;
1018         enum flush_type flush_type;
1019         int to_column = 0;
1020
1021         switch (*ch++) {
1022         case '<':
1023                 flush_type = flush_right;
1024                 break;
1025         case '>':
1026                 if (*ch == '<') {
1027                         flush_type = flush_both;
1028                         ch++;
1029                 } else
1030                         flush_type = flush_left;
1031                 break;
1032         default:
1033                 return 0;
1034         }
1035
1036         /* the next value means "wide enough to that column" */
1037         if (*ch == '|') {
1038                 to_column = 1;
1039                 ch++;
1040         }
1041
1042         if (*ch == '(') {
1043                 const char *start = ch + 1;
1044                 const char *end = start + strcspn(start, ",)");
1045                 char *next;
1046                 int width;
1047                 if (!end || end == start)
1048                         return 0;
1049                 width = strtoul(start, &next, 10);
1050                 if (next == start || width == 0)
1051                         return 0;
1052                 c->padding = to_column ? -width : width;
1053                 c->flush_type = flush_type;
1054
1055                 if (*end == ',') {
1056                         start = end + 1;
1057                         end = strchr(start, ')');
1058                         if (!end || end == start)
1059                                 return 0;
1060                         if (!prefixcmp(start, "trunc)"))
1061                                 c->truncate = trunc_right;
1062                         else if (!prefixcmp(start, "ltrunc)"))
1063                                 c->truncate = trunc_left;
1064                         else if (!prefixcmp(start, "mtrunc)"))
1065                                 c->truncate = trunc_middle;
1066                         else
1067                                 return 0;
1068                 } else
1069                         c->truncate = trunc_none;
1070
1071                 return end - placeholder + 1;
1072         }
1073         return 0;
1074 }
1075
1076 static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
1077                                 const char *placeholder,
1078                                 void *context)
1079 {
1080         struct format_commit_context *c = context;
1081         const struct commit *commit = c->commit;
1082         const char *msg = c->message;
1083         struct commit_list *p;
1084         int h1, h2;
1085
1086         /* these are independent of the commit */
1087         switch (placeholder[0]) {
1088         case 'C':
1089                 if (!prefixcmp(placeholder + 1, "(auto)")) {
1090                         c->auto_color = 1;
1091                         return 7; /* consumed 7 bytes, "C(auto)" */
1092                 } else {
1093                         int ret = parse_color(sb, placeholder, c);
1094                         if (ret)
1095                                 c->auto_color = 0;
1096                         /*
1097                          * Otherwise, we decided to treat %C<unknown>
1098                          * as a literal string, and the previous
1099                          * %C(auto) is still valid.
1100                          */
1101                         return ret;
1102                 }
1103         case 'n':               /* newline */
1104                 strbuf_addch(sb, '\n');
1105                 return 1;
1106         case 'x':
1107                 /* %x00 == NUL, %x0a == LF, etc. */
1108                 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
1109                     h1 <= 16 &&
1110                     0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
1111                     h2 <= 16) {
1112                         strbuf_addch(sb, (h1<<4)|h2);
1113                         return 3;
1114                 } else
1115                         return 0;
1116         case 'w':
1117                 if (placeholder[1] == '(') {
1118                         unsigned long width = 0, indent1 = 0, indent2 = 0;
1119                         char *next;
1120                         const char *start = placeholder + 2;
1121                         const char *end = strchr(start, ')');
1122                         if (!end)
1123                                 return 0;
1124                         if (end > start) {
1125                                 width = strtoul(start, &next, 10);
1126                                 if (*next == ',') {
1127                                         indent1 = strtoul(next + 1, &next, 10);
1128                                         if (*next == ',') {
1129                                                 indent2 = strtoul(next + 1,
1130                                                                  &next, 10);
1131                                         }
1132                                 }
1133                                 if (*next != ')')
1134                                         return 0;
1135                         }
1136                         rewrap_message_tail(sb, c, width, indent1, indent2);
1137                         return end - placeholder + 1;
1138                 } else
1139                         return 0;
1140
1141         case '<':
1142         case '>':
1143                 return parse_padding_placeholder(sb, placeholder, c);
1144         }
1145
1146         /* these depend on the commit */
1147         if (!commit->object.parsed)
1148                 parse_object(commit->object.sha1);
1149
1150         switch (placeholder[0]) {
1151         case 'H':               /* commit hash */
1152                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1153                 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
1154                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1155                 return 1;
1156         case 'h':               /* abbreviated commit hash */
1157                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1158                 if (add_again(sb, &c->abbrev_commit_hash)) {
1159                         strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1160                         return 1;
1161                 }
1162                 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
1163                                                      c->pretty_ctx->abbrev));
1164                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1165                 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
1166                 return 1;
1167         case 'T':               /* tree hash */
1168                 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
1169                 return 1;
1170         case 't':               /* abbreviated tree hash */
1171                 if (add_again(sb, &c->abbrev_tree_hash))
1172                         return 1;
1173                 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
1174                                                      c->pretty_ctx->abbrev));
1175                 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
1176                 return 1;
1177         case 'P':               /* parent hashes */
1178                 for (p = commit->parents; p; p = p->next) {
1179                         if (p != commit->parents)
1180                                 strbuf_addch(sb, ' ');
1181                         strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
1182                 }
1183                 return 1;
1184         case 'p':               /* abbreviated parent hashes */
1185                 if (add_again(sb, &c->abbrev_parent_hashes))
1186                         return 1;
1187                 for (p = commit->parents; p; p = p->next) {
1188                         if (p != commit->parents)
1189                                 strbuf_addch(sb, ' ');
1190                         strbuf_addstr(sb, find_unique_abbrev(
1191                                         p->item->object.sha1,
1192                                         c->pretty_ctx->abbrev));
1193                 }
1194                 c->abbrev_parent_hashes.len = sb->len -
1195                                               c->abbrev_parent_hashes.off;
1196                 return 1;
1197         case 'm':               /* left/right/bottom */
1198                 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1199                 return 1;
1200         case 'd':
1201                 load_ref_decorations(DECORATE_SHORT_REFS);
1202                 format_decorations(sb, commit, c->auto_color);
1203                 return 1;
1204         case 'g':               /* reflog info */
1205                 switch(placeholder[1]) {
1206                 case 'd':       /* reflog selector */
1207                 case 'D':
1208                         if (c->pretty_ctx->reflog_info)
1209                                 get_reflog_selector(sb,
1210                                                     c->pretty_ctx->reflog_info,
1211                                                     c->pretty_ctx->date_mode,
1212                                                     c->pretty_ctx->date_mode_explicit,
1213                                                     (placeholder[1] == 'd'));
1214                         return 2;
1215                 case 's':       /* reflog message */
1216                         if (c->pretty_ctx->reflog_info)
1217                                 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1218                         return 2;
1219                 case 'n':
1220                 case 'N':
1221                 case 'e':
1222                 case 'E':
1223                         return format_reflog_person(sb,
1224                                                     placeholder[1],
1225                                                     c->pretty_ctx->reflog_info,
1226                                                     c->pretty_ctx->date_mode);
1227                 }
1228                 return 0;       /* unknown %g placeholder */
1229         case 'N':
1230                 if (c->pretty_ctx->notes_message) {
1231                         strbuf_addstr(sb, c->pretty_ctx->notes_message);
1232                         return 1;
1233                 }
1234                 return 0;
1235         }
1236
1237         if (placeholder[0] == 'G') {
1238                 if (!c->signature_check.result)
1239                         check_commit_signature(c->commit, &(c->signature_check));
1240                 switch (placeholder[1]) {
1241                 case 'G':
1242                         if (c->signature_check.gpg_output)
1243                                 strbuf_addstr(sb, c->signature_check.gpg_output);
1244                         break;
1245                 case '?':
1246                         switch (c->signature_check.result) {
1247                         case 'G':
1248                         case 'B':
1249                         case 'U':
1250                         case 'N':
1251                                 strbuf_addch(sb, c->signature_check.result);
1252                         }
1253                         break;
1254                 case 'S':
1255                         if (c->signature_check.signer)
1256                                 strbuf_addstr(sb, c->signature_check.signer);
1257                         break;
1258                 case 'K':
1259                         if (c->signature_check.key)
1260                                 strbuf_addstr(sb, c->signature_check.key);
1261                         break;
1262                 }
1263                 return 2;
1264         }
1265
1266
1267         /* For the rest we have to parse the commit header. */
1268         if (!c->commit_header_parsed)
1269                 parse_commit_header(c);
1270
1271         switch (placeholder[0]) {
1272         case 'a':       /* author ... */
1273                 return format_person_part(sb, placeholder[1],
1274                                    msg + c->author.off, c->author.len,
1275                                    c->pretty_ctx->date_mode);
1276         case 'c':       /* committer ... */
1277                 return format_person_part(sb, placeholder[1],
1278                                    msg + c->committer.off, c->committer.len,
1279                                    c->pretty_ctx->date_mode);
1280         case 'e':       /* encoding */
1281                 if (c->commit_encoding)
1282                         strbuf_addstr(sb, c->commit_encoding);
1283                 return 1;
1284         case 'B':       /* raw body */
1285                 /* message_off is always left at the initial newline */
1286                 strbuf_addstr(sb, msg + c->message_off + 1);
1287                 return 1;
1288         }
1289
1290         /* Now we need to parse the commit message. */
1291         if (!c->commit_message_parsed)
1292                 parse_commit_message(c);
1293
1294         switch (placeholder[0]) {
1295         case 's':       /* subject */
1296                 format_subject(sb, msg + c->subject_off, " ");
1297                 return 1;
1298         case 'f':       /* sanitized subject */
1299                 format_sanitized_subject(sb, msg + c->subject_off);
1300                 return 1;
1301         case 'b':       /* body */
1302                 strbuf_addstr(sb, msg + c->body_off);
1303                 return 1;
1304         }
1305         return 0;       /* unknown placeholder */
1306 }
1307
1308 static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
1309                                     const char *placeholder,
1310                                     struct format_commit_context *c)
1311 {
1312         struct strbuf local_sb = STRBUF_INIT;
1313         int total_consumed = 0, len, padding = c->padding;
1314         if (padding < 0) {
1315                 const char *start = strrchr(sb->buf, '\n');
1316                 int occupied;
1317                 if (!start)
1318                         start = sb->buf;
1319                 occupied = utf8_strnwidth(start, -1, 1);
1320                 padding = (-padding) - occupied;
1321         }
1322         while (1) {
1323                 int modifier = *placeholder == 'C';
1324                 int consumed = format_commit_one(&local_sb, placeholder, c);
1325                 total_consumed += consumed;
1326
1327                 if (!modifier)
1328                         break;
1329
1330                 placeholder += consumed;
1331                 if (*placeholder != '%')
1332                         break;
1333                 placeholder++;
1334                 total_consumed++;
1335         }
1336         len = utf8_strnwidth(local_sb.buf, -1, 1);
1337         if (len > padding) {
1338                 switch (c->truncate) {
1339                 case trunc_left:
1340                         strbuf_utf8_replace(&local_sb,
1341                                             0, len - (padding - 2),
1342                                             "..");
1343                         break;
1344                 case trunc_middle:
1345                         strbuf_utf8_replace(&local_sb,
1346                                             padding / 2 - 1,
1347                                             len - (padding - 2),
1348                                             "..");
1349                         break;
1350                 case trunc_right:
1351                         strbuf_utf8_replace(&local_sb,
1352                                             padding - 2, len - (padding - 2),
1353                                             "..");
1354                         break;
1355                 case trunc_none:
1356                         break;
1357                 }
1358                 strbuf_addstr(sb, local_sb.buf);
1359         } else {
1360                 int sb_len = sb->len, offset = 0;
1361                 if (c->flush_type == flush_left)
1362                         offset = padding - len;
1363                 else if (c->flush_type == flush_both)
1364                         offset = (padding - len) / 2;
1365                 /*
1366                  * we calculate padding in columns, now
1367                  * convert it back to chars
1368                  */
1369                 padding = padding - len + local_sb.len;
1370                 strbuf_grow(sb, padding);
1371                 strbuf_setlen(sb, sb_len + padding);
1372                 memset(sb->buf + sb_len, ' ', sb->len - sb_len);
1373                 memcpy(sb->buf + sb_len + offset, local_sb.buf,
1374                        local_sb.len);
1375         }
1376         strbuf_release(&local_sb);
1377         c->flush_type = no_flush;
1378         return total_consumed;
1379 }
1380
1381 static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
1382                                  const char *placeholder,
1383                                  void *context)
1384 {
1385         int consumed;
1386         size_t orig_len;
1387         enum {
1388                 NO_MAGIC,
1389                 ADD_LF_BEFORE_NON_EMPTY,
1390                 DEL_LF_BEFORE_EMPTY,
1391                 ADD_SP_BEFORE_NON_EMPTY
1392         } magic = NO_MAGIC;
1393
1394         switch (placeholder[0]) {
1395         case '-':
1396                 magic = DEL_LF_BEFORE_EMPTY;
1397                 break;
1398         case '+':
1399                 magic = ADD_LF_BEFORE_NON_EMPTY;
1400                 break;
1401         case ' ':
1402                 magic = ADD_SP_BEFORE_NON_EMPTY;
1403                 break;
1404         default:
1405                 break;
1406         }
1407         if (magic != NO_MAGIC)
1408                 placeholder++;
1409
1410         orig_len = sb->len;
1411         if (((struct format_commit_context *)context)->flush_type != no_flush)
1412                 consumed = format_and_pad_commit(sb, placeholder, context);
1413         else
1414                 consumed = format_commit_one(sb, placeholder, context);
1415         if (magic == NO_MAGIC)
1416                 return consumed;
1417
1418         if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1419                 while (sb->len && sb->buf[sb->len - 1] == '\n')
1420                         strbuf_setlen(sb, sb->len - 1);
1421         } else if (orig_len != sb->len) {
1422                 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1423                         strbuf_insert(sb, orig_len, "\n", 1);
1424                 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1425                         strbuf_insert(sb, orig_len, " ", 1);
1426         }
1427         return consumed + 1;
1428 }
1429
1430 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1431                                    void *context)
1432 {
1433         struct userformat_want *w = context;
1434
1435         if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1436                 placeholder++;
1437
1438         switch (*placeholder) {
1439         case 'N':
1440                 w->notes = 1;
1441                 break;
1442         }
1443         return 0;
1444 }
1445
1446 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1447 {
1448         struct strbuf dummy = STRBUF_INIT;
1449
1450         if (!fmt) {
1451                 if (!user_format)
1452                         return;
1453                 fmt = user_format;
1454         }
1455         strbuf_expand(&dummy, fmt, userformat_want_item, w);
1456         strbuf_release(&dummy);
1457 }
1458
1459 void format_commit_message(const struct commit *commit,
1460                            const char *format, struct strbuf *sb,
1461                            const struct pretty_print_context *pretty_ctx)
1462 {
1463         struct format_commit_context context;
1464         const char *output_enc = pretty_ctx->output_encoding;
1465         const char *utf8 = "UTF-8";
1466
1467         memset(&context, 0, sizeof(context));
1468         context.commit = commit;
1469         context.pretty_ctx = pretty_ctx;
1470         context.wrap_start = sb->len;
1471         context.message = logmsg_reencode(commit,
1472                                           &context.commit_encoding,
1473                                           output_enc);
1474
1475         strbuf_expand(sb, format, format_commit_item, &context);
1476         rewrap_message_tail(sb, &context, 0, 0, 0);
1477
1478         if (output_enc) {
1479                 if (same_encoding(utf8, output_enc))
1480                         output_enc = NULL;
1481         } else {
1482                 if (context.commit_encoding &&
1483                     !same_encoding(context.commit_encoding, utf8))
1484                         output_enc = context.commit_encoding;
1485         }
1486
1487         if (output_enc) {
1488                 int outsz;
1489                 char *out = reencode_string_len(sb->buf, sb->len,
1490                                                 output_enc, utf8, &outsz);
1491                 if (out)
1492                         strbuf_attach(sb, out, outsz, outsz + 1);
1493         }
1494
1495         free(context.commit_encoding);
1496         logmsg_free(context.message, commit);
1497         free(context.signature_check.gpg_output);
1498         free(context.signature_check.signer);
1499 }
1500
1501 static void pp_header(const struct pretty_print_context *pp,
1502                       const char *encoding,
1503                       const struct commit *commit,
1504                       const char **msg_p,
1505                       struct strbuf *sb)
1506 {
1507         int parents_shown = 0;
1508
1509         for (;;) {
1510                 const char *line = *msg_p;
1511                 int linelen = get_one_line(*msg_p);
1512
1513                 if (!linelen)
1514                         return;
1515                 *msg_p += linelen;
1516
1517                 if (linelen == 1)
1518                         /* End of header */
1519                         return;
1520
1521                 if (pp->fmt == CMIT_FMT_RAW) {
1522                         strbuf_add(sb, line, linelen);
1523                         continue;
1524                 }
1525
1526                 if (!prefixcmp(line, "parent ")) {
1527                         if (linelen != 48)
1528                                 die("bad parent line in commit");
1529                         continue;
1530                 }
1531
1532                 if (!parents_shown) {
1533                         struct commit_list *parent;
1534                         int num;
1535                         for (parent = commit->parents, num = 0;
1536                              parent;
1537                              parent = parent->next, num++)
1538                                 ;
1539                         /* with enough slop */
1540                         strbuf_grow(sb, num * 50 + 20);
1541                         add_merge_info(pp, sb, commit);
1542                         parents_shown = 1;
1543                 }
1544
1545                 /*
1546                  * MEDIUM == DEFAULT shows only author with dates.
1547                  * FULL shows both authors but not dates.
1548                  * FULLER shows both authors and dates.
1549                  */
1550                 if (!prefixcmp(line, "author ")) {
1551                         strbuf_grow(sb, linelen + 80);
1552                         pp_user_info(pp, "Author", sb, line + 7, encoding);
1553                 }
1554                 if (!prefixcmp(line, "committer ") &&
1555                     (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1556                         strbuf_grow(sb, linelen + 80);
1557                         pp_user_info(pp, "Commit", sb, line + 10, encoding);
1558                 }
1559         }
1560 }
1561
1562 void pp_title_line(const struct pretty_print_context *pp,
1563                    const char **msg_p,
1564                    struct strbuf *sb,
1565                    const char *encoding,
1566                    int need_8bit_cte)
1567 {
1568         static const int max_length = 78; /* per rfc2047 */
1569         struct strbuf title;
1570
1571         strbuf_init(&title, 80);
1572         *msg_p = format_subject(&title, *msg_p,
1573                                 pp->preserve_subject ? "\n" : " ");
1574
1575         strbuf_grow(sb, title.len + 1024);
1576         if (pp->subject) {
1577                 strbuf_addstr(sb, pp->subject);
1578                 if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
1579                         add_rfc2047(sb, title.buf, title.len,
1580                                                 encoding, RFC2047_SUBJECT);
1581                 else
1582                         strbuf_add_wrapped_bytes(sb, title.buf, title.len,
1583                                          -last_line_length(sb), 1, max_length);
1584         } else {
1585                 strbuf_addbuf(sb, &title);
1586         }
1587         strbuf_addch(sb, '\n');
1588
1589         if (need_8bit_cte > 0) {
1590                 const char *header_fmt =
1591                         "MIME-Version: 1.0\n"
1592                         "Content-Type: text/plain; charset=%s\n"
1593                         "Content-Transfer-Encoding: 8bit\n";
1594                 strbuf_addf(sb, header_fmt, encoding);
1595         }
1596         if (pp->after_subject) {
1597                 strbuf_addstr(sb, pp->after_subject);
1598         }
1599         if (pp->fmt == CMIT_FMT_EMAIL) {
1600                 strbuf_addch(sb, '\n');
1601         }
1602         strbuf_release(&title);
1603 }
1604
1605 void pp_remainder(const struct pretty_print_context *pp,
1606                   const char **msg_p,
1607                   struct strbuf *sb,
1608                   int indent)
1609 {
1610         int first = 1;
1611         for (;;) {
1612                 const char *line = *msg_p;
1613                 int linelen = get_one_line(line);
1614                 *msg_p += linelen;
1615
1616                 if (!linelen)
1617                         break;
1618
1619                 if (is_empty_line(line, &linelen)) {
1620                         if (first)
1621                                 continue;
1622                         if (pp->fmt == CMIT_FMT_SHORT)
1623                                 break;
1624                 }
1625                 first = 0;
1626
1627                 strbuf_grow(sb, linelen + indent + 20);
1628                 if (indent) {
1629                         memset(sb->buf + sb->len, ' ', indent);
1630                         strbuf_setlen(sb, sb->len + indent);
1631                 }
1632                 strbuf_add(sb, line, linelen);
1633                 strbuf_addch(sb, '\n');
1634         }
1635 }
1636
1637 void pretty_print_commit(const struct pretty_print_context *pp,
1638                          const struct commit *commit,
1639                          struct strbuf *sb)
1640 {
1641         unsigned long beginning_of_body;
1642         int indent = 4;
1643         const char *msg;
1644         char *reencoded;
1645         const char *encoding;
1646         int need_8bit_cte = pp->need_8bit_cte;
1647
1648         if (pp->fmt == CMIT_FMT_USERFORMAT) {
1649                 format_commit_message(commit, user_format, sb, pp);
1650                 return;
1651         }
1652
1653         encoding = get_log_output_encoding();
1654         msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1655
1656         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1657                 indent = 0;
1658
1659         /*
1660          * We need to check and emit Content-type: to mark it
1661          * as 8-bit if we haven't done so.
1662          */
1663         if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1664                 int i, ch, in_body;
1665
1666                 for (in_body = i = 0; (ch = msg[i]); i++) {
1667                         if (!in_body) {
1668                                 /* author could be non 7-bit ASCII but
1669                                  * the log may be so; skip over the
1670                                  * header part first.
1671                                  */
1672                                 if (ch == '\n' && msg[i+1] == '\n')
1673                                         in_body = 1;
1674                         }
1675                         else if (non_ascii(ch)) {
1676                                 need_8bit_cte = 1;
1677                                 break;
1678                         }
1679                 }
1680         }
1681
1682         pp_header(pp, encoding, commit, &msg, sb);
1683         if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1684                 strbuf_addch(sb, '\n');
1685         }
1686
1687         /* Skip excess blank lines at the beginning of body, if any... */
1688         msg = skip_empty_lines(msg);
1689
1690         /* These formats treat the title line specially. */
1691         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1692                 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1693
1694         beginning_of_body = sb->len;
1695         if (pp->fmt != CMIT_FMT_ONELINE)
1696                 pp_remainder(pp, &msg, sb, indent);
1697         strbuf_rtrim(sb);
1698
1699         /* Make sure there is an EOLN for the non-oneline case */
1700         if (pp->fmt != CMIT_FMT_ONELINE)
1701                 strbuf_addch(sb, '\n');
1702
1703         /*
1704          * The caller may append additional body text in e-mail
1705          * format.  Make sure we did not strip the blank line
1706          * between the header and the body.
1707          */
1708         if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1709                 strbuf_addch(sb, '\n');
1710
1711         logmsg_free(reencoded, commit);
1712 }
1713
1714 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1715                     struct strbuf *sb)
1716 {
1717         struct pretty_print_context pp = {0};
1718         pp.fmt = fmt;
1719         pretty_print_commit(&pp, commit, sb);
1720 }