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