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