format_commit_message(): fix function signature
[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"
c002922a 9#include "color.h"
93fc05eb 10
93fc05eb
JS
11static char *user_format;
12
36407548
NS
13static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
14{
15 free(user_format);
16 user_format = xstrdup(cp);
17 if (is_tformat)
18 rev->use_terminator = 1;
19 rev->commit_format = CMIT_FMT_USERFORMAT;
20}
21
4da45bef 22void get_commit_format(const char *arg, struct rev_info *rev)
93fc05eb
JS
23{
24 int i;
4da45bef
JH
25 static struct cmt_fmt_map {
26 const char *n;
27 size_t cmp_len;
28 enum cmit_fmt v;
29 } cmt_fmts[] = {
30 { "raw", 1, CMIT_FMT_RAW },
31 { "medium", 1, CMIT_FMT_MEDIUM },
32 { "short", 1, CMIT_FMT_SHORT },
33 { "email", 1, CMIT_FMT_EMAIL },
34 { "full", 5, CMIT_FMT_FULL },
35 { "fuller", 5, CMIT_FMT_FULLER },
36 { "oneline", 1, CMIT_FMT_ONELINE },
37 };
93fc05eb 38
4da45bef
JH
39 rev->use_terminator = 0;
40 if (!arg || !*arg) {
41 rev->commit_format = CMIT_FMT_DEFAULT;
42 return;
43 }
4da45bef 44 if (!prefixcmp(arg, "format:") || !prefixcmp(arg, "tformat:")) {
36407548 45 save_user_format(rev, strchr(arg, ':') + 1, arg[0] == 't');
4da45bef 46 return;
93fc05eb
JS
47 }
48 for (i = 0; i < ARRAY_SIZE(cmt_fmts); i++) {
49 if (!strncmp(arg, cmt_fmts[i].n, cmt_fmts[i].cmp_len) &&
4da45bef
JH
50 !strncmp(arg, cmt_fmts[i].n, strlen(arg))) {
51 if (cmt_fmts[i].v == CMIT_FMT_ONELINE)
52 rev->use_terminator = 1;
53 rev->commit_format = cmt_fmts[i].v;
54 return;
55 }
93fc05eb 56 }
36407548
NS
57 if (strchr(arg, '%')) {
58 save_user_format(rev, arg, 1);
59 return;
60 }
93fc05eb
JS
61
62 die("invalid --pretty format: %s", arg);
63}
64
65/*
66 * Generic support for pretty-printing the header
67 */
68static int get_one_line(const char *msg)
69{
70 int ret = 0;
71
72 for (;;) {
73 char c = *msg++;
74 if (!c)
75 break;
76 ret++;
77 if (c == '\n')
78 break;
79 }
80 return ret;
81}
82
83/* High bit set, or ISO-2022-INT */
84int non_ascii(int ch)
85{
c2e9364a 86 return !isascii(ch) || ch == '\033';
93fc05eb
JS
87}
88
28e9cf65
JS
89int has_non_ascii(const char *s)
90{
91 int ch;
92 if (!s)
93 return 0;
94 while ((ch = *s++) != '\0') {
95 if (non_ascii(ch))
96 return 1;
97 }
98 return 0;
99}
100
93fc05eb
JS
101static int is_rfc2047_special(char ch)
102{
103 return (non_ascii(ch) || (ch == '=') || (ch == '?') || (ch == '_'));
104}
105
106static void add_rfc2047(struct strbuf *sb, const char *line, int len,
107 const char *encoding)
108{
109 int i, last;
110
111 for (i = 0; i < len; i++) {
112 int ch = line[i];
113 if (non_ascii(ch))
114 goto needquote;
115 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
116 goto needquote;
117 }
118 strbuf_add(sb, line, len);
119 return;
120
121needquote:
122 strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
123 strbuf_addf(sb, "=?%s?q?", encoding);
124 for (i = last = 0; i < len; i++) {
125 unsigned ch = line[i] & 0xFF;
126 /*
127 * We encode ' ' using '=20' even though rfc2047
128 * allows using '_' for readability. Unfortunately,
129 * many programs do not understand this and just
130 * leave the underscore in place.
131 */
132 if (is_rfc2047_special(ch) || ch == ' ') {
133 strbuf_add(sb, line + last, i - last);
134 strbuf_addf(sb, "=%02X", ch);
135 last = i + 1;
136 }
137 }
138 strbuf_add(sb, line + last, len - last);
139 strbuf_addstr(sb, "?=");
140}
141
b02bd65f
DB
142void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
143 const char *line, enum date_mode dmode,
144 const char *encoding)
93fc05eb
JS
145{
146 char *date;
147 int namelen;
148 unsigned long time;
149 int tz;
93fc05eb
JS
150
151 if (fmt == CMIT_FMT_ONELINE)
152 return;
153 date = strchr(line, '>');
154 if (!date)
155 return;
156 namelen = ++date - line;
157 time = strtoul(date, &date, 10);
158 tz = strtol(date, NULL, 10);
159
160 if (fmt == CMIT_FMT_EMAIL) {
161 char *name_tail = strchr(line, '<');
162 int display_name_length;
163 if (!name_tail)
164 return;
165 while (line < name_tail && isspace(name_tail[-1]))
166 name_tail--;
167 display_name_length = name_tail - line;
93fc05eb
JS
168 strbuf_addstr(sb, "From: ");
169 add_rfc2047(sb, line, display_name_length, encoding);
170 strbuf_add(sb, name_tail, namelen - display_name_length);
171 strbuf_addch(sb, '\n');
172 } else {
173 strbuf_addf(sb, "%s: %.*s%.*s\n", what,
174 (fmt == CMIT_FMT_FULLER) ? 4 : 0,
8e76bf3f 175 " ", namelen, line);
93fc05eb
JS
176 }
177 switch (fmt) {
178 case CMIT_FMT_MEDIUM:
179 strbuf_addf(sb, "Date: %s\n", show_date(time, tz, dmode));
180 break;
181 case CMIT_FMT_EMAIL:
182 strbuf_addf(sb, "Date: %s\n", show_date(time, tz, DATE_RFC2822));
183 break;
184 case CMIT_FMT_FULLER:
185 strbuf_addf(sb, "%sDate: %s\n", what, show_date(time, tz, dmode));
186 break;
187 default:
188 /* notin' */
189 break;
190 }
191}
192
193static int is_empty_line(const char *line, int *len_p)
194{
195 int len = *len_p;
196 while (len && isspace(line[len-1]))
197 len--;
198 *len_p = len;
199 return !len;
200}
201
a0109668
RS
202static const char *skip_empty_lines(const char *msg)
203{
204 for (;;) {
205 int linelen = get_one_line(msg);
206 int ll = linelen;
207 if (!linelen)
208 break;
209 if (!is_empty_line(msg, &ll))
210 break;
211 msg += linelen;
212 }
213 return msg;
214}
215
93fc05eb
JS
216static void add_merge_info(enum cmit_fmt fmt, struct strbuf *sb,
217 const struct commit *commit, int abbrev)
218{
219 struct commit_list *parent = commit->parents;
220
221 if ((fmt == CMIT_FMT_ONELINE) || (fmt == CMIT_FMT_EMAIL) ||
222 !parent || !parent->next)
223 return;
224
225 strbuf_addstr(sb, "Merge:");
226
227 while (parent) {
228 struct commit *p = parent->item;
229 const char *hex = NULL;
93fc05eb
JS
230 if (abbrev)
231 hex = find_unique_abbrev(p->object.sha1, abbrev);
232 if (!hex)
233 hex = sha1_to_hex(p->object.sha1);
93fc05eb
JS
234 parent = parent->next;
235
7fcda920 236 strbuf_addf(sb, " %s", hex);
93fc05eb
JS
237 }
238 strbuf_addch(sb, '\n');
239}
240
241static char *get_header(const struct commit *commit, const char *key)
242{
243 int key_len = strlen(key);
244 const char *line = commit->buffer;
245
246 for (;;) {
247 const char *eol = strchr(line, '\n'), *next;
248
249 if (line == eol)
250 return NULL;
251 if (!eol) {
252 eol = line + strlen(line);
253 next = NULL;
254 } else
255 next = eol + 1;
256 if (eol - line > key_len &&
257 !strncmp(line, key, key_len) &&
258 line[key_len] == ' ') {
259 return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
260 }
261 line = next;
262 }
263}
264
265static char *replace_encoding_header(char *buf, const char *encoding)
266{
f285a2d7 267 struct strbuf tmp = STRBUF_INIT;
93fc05eb
JS
268 size_t start, len;
269 char *cp = buf;
270
271 /* guess if there is an encoding header before a \n\n */
272 while (strncmp(cp, "encoding ", strlen("encoding "))) {
273 cp = strchr(cp, '\n');
274 if (!cp || *++cp == '\n')
275 return buf;
276 }
277 start = cp - buf;
278 cp = strchr(cp, '\n');
279 if (!cp)
280 return buf; /* should not happen but be defensive */
281 len = cp + 1 - (buf + start);
282
93fc05eb
JS
283 strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
284 if (is_encoding_utf8(encoding)) {
285 /* we have re-coded to UTF-8; drop the header */
286 strbuf_remove(&tmp, start, len);
287 } else {
288 /* just replaces XXXX in 'encoding XXXX\n' */
289 strbuf_splice(&tmp, start + strlen("encoding "),
290 len - strlen("encoding \n"),
291 encoding, strlen(encoding));
292 }
293 return strbuf_detach(&tmp, NULL);
294}
295
296static char *logmsg_reencode(const struct commit *commit,
297 const char *output_encoding)
298{
330db18c 299 static const char *utf8 = "UTF-8";
93fc05eb
JS
300 const char *use_encoding;
301 char *encoding;
302 char *out;
303
304 if (!*output_encoding)
305 return NULL;
306 encoding = get_header(commit, "encoding");
307 use_encoding = encoding ? encoding : utf8;
308 if (!strcmp(use_encoding, output_encoding))
309 if (encoding) /* we'll strip encoding header later */
310 out = xstrdup(commit->buffer);
311 else
312 return NULL; /* nothing to do */
313 else
314 out = reencode_string(commit->buffer,
315 output_encoding, use_encoding);
316 if (out)
317 out = replace_encoding_header(out, output_encoding);
318
319 free(encoding);
320 return out;
321}
322
d20d654f 323static int mailmap_name(char *email, int email_len, char *name, int name_len)
e0cbc397 324{
c455c87c 325 static struct string_list *mail_map;
e0cbc397
JS
326 if (!mail_map) {
327 mail_map = xcalloc(1, sizeof(*mail_map));
d551a488 328 read_mailmap(mail_map, NULL);
e0cbc397 329 }
d20d654f 330 return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
e0cbc397
JS
331}
332
c3a670de 333static size_t format_person_part(struct strbuf *sb, char part,
d36f8679 334 const char *msg, int len, enum date_mode dmode)
93fc05eb 335{
c3a670de
MC
336 /* currently all placeholders have same length */
337 const int placeholder_len = 2;
93fc05eb 338 int start, end, tz = 0;
c3a670de 339 unsigned long date = 0;
93fc05eb 340 char *ep;
d20d654f
MSO
341 const char *name_start, *name_end, *mail_start, *mail_end, *msg_end = msg+len;
342 char person_name[1024];
343 char person_mail[1024];
93fc05eb 344
c3a670de 345 /* advance 'end' to point to email start delimiter */
93fc05eb
JS
346 for (end = 0; end < len && msg[end] != '<'; end++)
347 ; /* do nothing */
c3a670de 348
f7ab5c79 349 /*
c3a670de
MC
350 * When end points at the '<' that we found, it should have
351 * matching '>' later, which means 'end' must be strictly
352 * below len - 1.
f7ab5c79 353 */
c3a670de
MC
354 if (end >= len - 2)
355 goto skip;
356
d20d654f
MSO
357 /* Seek for both name and email part */
358 name_start = msg;
359 name_end = msg+end;
360 while (name_end > name_start && isspace(*(name_end-1)))
361 name_end--;
362 mail_start = msg+end+1;
363 mail_end = mail_start;
364 while (mail_end < msg_end && *mail_end != '>')
365 mail_end++;
366 if (mail_end == msg_end)
367 goto skip;
368 end = mail_end-msg;
369
370 if (part == 'N' || part == 'E') { /* mailmap lookup */
371 strlcpy(person_name, name_start, name_end-name_start+1);
372 strlcpy(person_mail, mail_start, mail_end-mail_start+1);
373 mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
374 name_start = person_name;
375 name_end = name_start + strlen(person_name);
376 mail_start = person_mail;
377 mail_end = mail_start + strlen(person_mail);
378 }
e0cbc397 379 if (part == 'n' || part == 'N') { /* name */
d20d654f 380 strbuf_add(sb, name_start, name_end-name_start);
c3a670de 381 return placeholder_len;
cde75e59 382 }
d20d654f
MSO
383 if (part == 'e' || part == 'E') { /* email */
384 strbuf_add(sb, mail_start, mail_end-mail_start);
c3a670de 385 return placeholder_len;
cde75e59 386 }
93fc05eb 387
c3a670de 388 /* advance 'start' to point to date start delimiter */
93fc05eb
JS
389 for (start = end + 1; start < len && isspace(msg[start]); start++)
390 ; /* do nothing */
391 if (start >= len)
c3a670de 392 goto skip;
93fc05eb
JS
393 date = strtoul(msg + start, &ep, 10);
394 if (msg + start == ep)
c3a670de 395 goto skip;
93fc05eb 396
cde75e59
RS
397 if (part == 't') { /* date, UNIX timestamp */
398 strbuf_add(sb, msg + start, ep - (msg + start));
c3a670de 399 return placeholder_len;
cde75e59 400 }
93fc05eb
JS
401
402 /* parse tz */
403 for (start = ep - msg + 1; start < len && isspace(msg[start]); start++)
404 ; /* do nothing */
405 if (start + 1 < len) {
406 tz = strtoul(msg + start + 1, NULL, 10);
407 if (msg[start] == '-')
408 tz = -tz;
409 }
410
cde75e59
RS
411 switch (part) {
412 case 'd': /* date */
d36f8679 413 strbuf_addstr(sb, show_date(date, tz, dmode));
c3a670de 414 return placeholder_len;
cde75e59
RS
415 case 'D': /* date, RFC2822 style */
416 strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
c3a670de 417 return placeholder_len;
cde75e59
RS
418 case 'r': /* date, relative */
419 strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
c3a670de 420 return placeholder_len;
cde75e59
RS
421 case 'i': /* date, ISO 8601 */
422 strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
c3a670de 423 return placeholder_len;
cde75e59 424 }
c3a670de
MC
425
426skip:
427 /*
428 * bogus commit, 'sb' cannot be updated, but we still need to
429 * compute a valid return value.
430 */
431 if (part == 'n' || part == 'e' || part == 't' || part == 'd'
432 || part == 'D' || part == 'r' || part == 'i')
433 return placeholder_len;
434
435 return 0; /* unknown placeholder */
93fc05eb
JS
436}
437
f29d5958
RS
438struct chunk {
439 size_t off;
440 size_t len;
441};
442
443struct format_commit_context {
444 const struct commit *commit;
d36f8679 445 enum date_mode dmode;
f53bd743
RS
446 unsigned commit_header_parsed:1;
447 unsigned commit_message_parsed:1;
f29d5958
RS
448
449 /* These offsets are relative to the start of the commit message. */
f29d5958
RS
450 struct chunk author;
451 struct chunk committer;
452 struct chunk encoding;
f53bd743
RS
453 size_t message_off;
454 size_t subject_off;
f29d5958 455 size_t body_off;
b9c62321
RS
456
457 /* The following ones are relative to the result struct strbuf. */
458 struct chunk abbrev_commit_hash;
459 struct chunk abbrev_tree_hash;
460 struct chunk abbrev_parent_hashes;
f29d5958
RS
461};
462
b9c62321
RS
463static int add_again(struct strbuf *sb, struct chunk *chunk)
464{
465 if (chunk->len) {
466 strbuf_adddup(sb, chunk->off, chunk->len);
467 return 1;
468 }
469
470 /*
471 * We haven't seen this chunk before. Our caller is surely
472 * going to add it the hard way now. Remember the most likely
473 * start of the to-be-added chunk: the current end of the
474 * struct strbuf.
475 */
476 chunk->off = sb->len;
477 return 0;
478}
479
f29d5958 480static void parse_commit_header(struct format_commit_context *context)
93fc05eb 481{
f29d5958 482 const char *msg = context->commit->buffer;
93fc05eb 483 int i;
f29d5958 484
f53bd743 485 for (i = 0; msg[i]; i++) {
f29d5958
RS
486 int eol;
487 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
488 ; /* do nothing */
489
f29d5958 490 if (i == eol) {
f53bd743 491 break;
f29d5958
RS
492 } else if (!prefixcmp(msg + i, "author ")) {
493 context->author.off = i + 7;
494 context->author.len = eol - i - 7;
495 } else if (!prefixcmp(msg + i, "committer ")) {
496 context->committer.off = i + 10;
497 context->committer.len = eol - i - 10;
498 } else if (!prefixcmp(msg + i, "encoding ")) {
499 context->encoding.off = i + 9;
500 context->encoding.len = eol - i - 9;
501 }
502 i = eol;
503 }
f53bd743 504 context->message_off = i;
f29d5958
RS
505 context->commit_header_parsed = 1;
506}
507
46d164b0
SB
508static int istitlechar(char c)
509{
510 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
511 (c >= '0' && c <= '9') || c == '.' || c == '_';
512}
513
514static void format_sanitized_subject(struct strbuf *sb, const char *msg)
515{
516 size_t trimlen;
871d21d4 517 size_t start_len = sb->len;
46d164b0
SB
518 int space = 2;
519
520 for (; *msg && *msg != '\n'; msg++) {
521 if (istitlechar(*msg)) {
522 if (space == 1)
523 strbuf_addch(sb, '-');
524 space = 0;
525 strbuf_addch(sb, *msg);
526 if (*msg == '.')
527 while (*(msg+1) == '.')
528 msg++;
529 } else
530 space |= 1;
531 }
532
533 /* trim any trailing '.' or '-' characters */
534 trimlen = 0;
871d21d4
SB
535 while (sb->len - trimlen > start_len &&
536 (sb->buf[sb->len - 1 - trimlen] == '.'
537 || sb->buf[sb->len - 1 - trimlen] == '-'))
46d164b0
SB
538 trimlen++;
539 strbuf_remove(sb, sb->len - trimlen, trimlen);
540}
541
cec08717
RS
542const char *format_subject(struct strbuf *sb, const char *msg,
543 const char *line_separator)
88c44735
RS
544{
545 int first = 1;
546
547 for (;;) {
548 const char *line = msg;
549 int linelen = get_one_line(line);
550
551 msg += linelen;
552 if (!linelen || is_empty_line(line, &linelen))
553 break;
554
f53bd743
RS
555 if (!sb)
556 continue;
88c44735
RS
557 strbuf_grow(sb, linelen + 2);
558 if (!first)
559 strbuf_addstr(sb, line_separator);
560 strbuf_add(sb, line, linelen);
561 first = 0;
562 }
563 return msg;
564}
565
f53bd743
RS
566static void parse_commit_message(struct format_commit_context *c)
567{
568 const char *msg = c->commit->buffer + c->message_off;
569 const char *start = c->commit->buffer;
570
571 msg = skip_empty_lines(msg);
572 c->subject_off = msg - start;
573
574 msg = format_subject(NULL, msg, NULL);
575 msg = skip_empty_lines(msg);
576 c->body_off = msg - start;
577
578 c->commit_message_parsed = 1;
579}
580
3b3d443f
RS
581static void format_decoration(struct strbuf *sb, const struct commit *commit)
582{
583 struct name_decoration *d;
584 const char *prefix = " (";
585
33e7018c 586 load_ref_decorations(DECORATE_SHORT_REFS);
3b3d443f
RS
587 d = lookup_decoration(&name_decoration, &commit->object);
588 while (d) {
589 strbuf_addstr(sb, prefix);
590 prefix = ", ";
591 strbuf_addstr(sb, d->name);
592 d = d->next;
593 }
594 if (prefix[0] == ',')
595 strbuf_addch(sb, ')');
596}
597
c3a670de 598static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
f29d5958
RS
599 void *context)
600{
601 struct format_commit_context *c = context;
602 const struct commit *commit = c->commit;
93fc05eb 603 const char *msg = commit->buffer;
f29d5958 604 struct commit_list *p;
42c8c74c 605 int h1, h2;
93fc05eb 606
93fc05eb 607 /* these are independent of the commit */
cde75e59
RS
608 switch (placeholder[0]) {
609 case 'C':
c002922a
JK
610 if (placeholder[1] == '(') {
611 const char *end = strchr(placeholder + 2, ')');
612 char color[COLOR_MAXLEN];
613 if (!end)
614 return 0;
615 color_parse_mem(placeholder + 2,
616 end - (placeholder + 2),
617 "--pretty format", color);
618 strbuf_addstr(sb, color);
619 return end - placeholder + 1;
620 }
c3a670de 621 if (!prefixcmp(placeholder + 1, "red")) {
dc6ebd4c 622 strbuf_addstr(sb, GIT_COLOR_RED);
c3a670de
MC
623 return 4;
624 } else if (!prefixcmp(placeholder + 1, "green")) {
dc6ebd4c 625 strbuf_addstr(sb, GIT_COLOR_GREEN);
c3a670de
MC
626 return 6;
627 } else if (!prefixcmp(placeholder + 1, "blue")) {
dc6ebd4c 628 strbuf_addstr(sb, GIT_COLOR_BLUE);
c3a670de
MC
629 return 5;
630 } else if (!prefixcmp(placeholder + 1, "reset")) {
dc6ebd4c 631 strbuf_addstr(sb, GIT_COLOR_RESET);
c3a670de
MC
632 return 6;
633 } else
634 return 0;
cde75e59
RS
635 case 'n': /* newline */
636 strbuf_addch(sb, '\n');
c3a670de 637 return 1;
42c8c74c
GS
638 case 'x':
639 /* %x00 == NUL, %x0a == LF, etc. */
640 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
641 h1 <= 16 &&
642 0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
643 h2 <= 16) {
644 strbuf_addch(sb, (h1<<4)|h2);
645 return 3;
646 } else
647 return 0;
cde75e59 648 }
93fc05eb
JS
649
650 /* these depend on the commit */
651 if (!commit->object.parsed)
652 parse_object(commit->object.sha1);
93fc05eb 653
cde75e59
RS
654 switch (placeholder[0]) {
655 case 'H': /* commit hash */
656 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
c3a670de 657 return 1;
cde75e59 658 case 'h': /* abbreviated commit hash */
b9c62321 659 if (add_again(sb, &c->abbrev_commit_hash))
c3a670de 660 return 1;
cde75e59
RS
661 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
662 DEFAULT_ABBREV));
b9c62321 663 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
c3a670de 664 return 1;
cde75e59
RS
665 case 'T': /* tree hash */
666 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
c3a670de 667 return 1;
cde75e59 668 case 't': /* abbreviated tree hash */
b9c62321 669 if (add_again(sb, &c->abbrev_tree_hash))
c3a670de 670 return 1;
cde75e59
RS
671 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
672 DEFAULT_ABBREV));
b9c62321 673 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
c3a670de 674 return 1;
cde75e59
RS
675 case 'P': /* parent hashes */
676 for (p = commit->parents; p; p = p->next) {
677 if (p != commit->parents)
678 strbuf_addch(sb, ' ');
679 strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
680 }
c3a670de 681 return 1;
cde75e59 682 case 'p': /* abbreviated parent hashes */
b9c62321 683 if (add_again(sb, &c->abbrev_parent_hashes))
c3a670de 684 return 1;
cde75e59
RS
685 for (p = commit->parents; p; p = p->next) {
686 if (p != commit->parents)
687 strbuf_addch(sb, ' ');
688 strbuf_addstr(sb, find_unique_abbrev(
689 p->item->object.sha1, DEFAULT_ABBREV));
690 }
b9c62321
RS
691 c->abbrev_parent_hashes.len = sb->len -
692 c->abbrev_parent_hashes.off;
c3a670de 693 return 1;
cde75e59
RS
694 case 'm': /* left/right/bottom */
695 strbuf_addch(sb, (commit->object.flags & BOUNDARY)
696 ? '-'
697 : (commit->object.flags & SYMMETRIC_LEFT)
698 ? '<'
699 : '>');
c3a670de 700 return 1;
3b3d443f
RS
701 case 'd':
702 format_decoration(sb, commit);
703 return 1;
cde75e59
RS
704 }
705
706 /* For the rest we have to parse the commit header. */
f29d5958
RS
707 if (!c->commit_header_parsed)
708 parse_commit_header(c);
93fc05eb 709
f29d5958 710 switch (placeholder[0]) {
c3a670de
MC
711 case 'a': /* author ... */
712 return format_person_part(sb, placeholder[1],
d36f8679
JK
713 msg + c->author.off, c->author.len,
714 c->dmode);
c3a670de
MC
715 case 'c': /* committer ... */
716 return format_person_part(sb, placeholder[1],
d36f8679
JK
717 msg + c->committer.off, c->committer.len,
718 c->dmode);
c3a670de 719 case 'e': /* encoding */
f29d5958 720 strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
c3a670de 721 return 1;
f53bd743
RS
722 }
723
724 /* Now we need to parse the commit message. */
725 if (!c->commit_message_parsed)
726 parse_commit_message(c);
727
728 switch (placeholder[0]) {
729 case 's': /* subject */
730 format_subject(sb, msg + c->subject_off, " ");
731 return 1;
46d164b0
SB
732 case 'f': /* sanitized subject */
733 format_sanitized_subject(sb, msg + c->subject_off);
734 return 1;
c3a670de 735 case 'b': /* body */
f29d5958 736 strbuf_addstr(sb, msg + c->body_off);
c3a670de 737 return 1;
93fc05eb 738 }
c3a670de 739 return 0; /* unknown placeholder */
cde75e59
RS
740}
741
742void format_commit_message(const struct commit *commit,
7f98ebc8 743 const char *format, struct strbuf *sb,
d36f8679 744 enum date_mode dmode)
cde75e59 745{
f29d5958
RS
746 struct format_commit_context context;
747
748 memset(&context, 0, sizeof(context));
749 context.commit = commit;
d36f8679 750 context.dmode = dmode;
c3a670de 751 strbuf_expand(sb, format, format_commit_item, &context);
93fc05eb
JS
752}
753
754static void pp_header(enum cmit_fmt fmt,
755 int abbrev,
756 enum date_mode dmode,
757 const char *encoding,
758 const struct commit *commit,
759 const char **msg_p,
760 struct strbuf *sb)
761{
762 int parents_shown = 0;
763
764 for (;;) {
765 const char *line = *msg_p;
766 int linelen = get_one_line(*msg_p);
767
768 if (!linelen)
769 return;
770 *msg_p += linelen;
771
772 if (linelen == 1)
773 /* End of header */
774 return;
775
776 if (fmt == CMIT_FMT_RAW) {
777 strbuf_add(sb, line, linelen);
778 continue;
779 }
780
781 if (!memcmp(line, "parent ", 7)) {
782 if (linelen != 48)
783 die("bad parent line in commit");
784 continue;
785 }
786
787 if (!parents_shown) {
788 struct commit_list *parent;
789 int num;
790 for (parent = commit->parents, num = 0;
791 parent;
792 parent = parent->next, num++)
793 ;
794 /* with enough slop */
795 strbuf_grow(sb, num * 50 + 20);
796 add_merge_info(fmt, sb, commit, abbrev);
797 parents_shown = 1;
798 }
799
800 /*
801 * MEDIUM == DEFAULT shows only author with dates.
802 * FULL shows both authors but not dates.
803 * FULLER shows both authors and dates.
804 */
805 if (!memcmp(line, "author ", 7)) {
806 strbuf_grow(sb, linelen + 80);
b02bd65f 807 pp_user_info("Author", fmt, sb, line + 7, dmode, encoding);
93fc05eb
JS
808 }
809 if (!memcmp(line, "committer ", 10) &&
810 (fmt == CMIT_FMT_FULL || fmt == CMIT_FMT_FULLER)) {
811 strbuf_grow(sb, linelen + 80);
b02bd65f 812 pp_user_info("Commit", fmt, sb, line + 10, dmode, encoding);
93fc05eb
JS
813 }
814 }
815}
816
b02bd65f
DB
817void pp_title_line(enum cmit_fmt fmt,
818 const char **msg_p,
819 struct strbuf *sb,
820 const char *subject,
821 const char *after_subject,
822 const char *encoding,
267123b4 823 int need_8bit_cte)
93fc05eb 824{
88c44735 825 const char *line_separator = (fmt == CMIT_FMT_EMAIL) ? "\n " : " ";
93fc05eb
JS
826 struct strbuf title;
827
828 strbuf_init(&title, 80);
88c44735 829 *msg_p = format_subject(&title, *msg_p, line_separator);
93fc05eb
JS
830
831 strbuf_grow(sb, title.len + 1024);
832 if (subject) {
833 strbuf_addstr(sb, subject);
834 add_rfc2047(sb, title.buf, title.len, encoding);
835 } else {
836 strbuf_addbuf(sb, &title);
837 }
838 strbuf_addch(sb, '\n');
839
6bf4f1b4 840 if (need_8bit_cte > 0) {
93fc05eb
JS
841 const char *header_fmt =
842 "MIME-Version: 1.0\n"
843 "Content-Type: text/plain; charset=%s\n"
844 "Content-Transfer-Encoding: 8bit\n";
845 strbuf_addf(sb, header_fmt, encoding);
846 }
847 if (after_subject) {
848 strbuf_addstr(sb, after_subject);
849 }
850 if (fmt == CMIT_FMT_EMAIL) {
851 strbuf_addch(sb, '\n');
852 }
853 strbuf_release(&title);
854}
855
b02bd65f
DB
856void pp_remainder(enum cmit_fmt fmt,
857 const char **msg_p,
858 struct strbuf *sb,
859 int indent)
93fc05eb
JS
860{
861 int first = 1;
862 for (;;) {
863 const char *line = *msg_p;
864 int linelen = get_one_line(line);
865 *msg_p += linelen;
866
867 if (!linelen)
868 break;
869
870 if (is_empty_line(line, &linelen)) {
871 if (first)
872 continue;
873 if (fmt == CMIT_FMT_SHORT)
874 break;
875 }
876 first = 0;
877
878 strbuf_grow(sb, linelen + indent + 20);
879 if (indent) {
880 memset(sb->buf + sb->len, ' ', indent);
881 strbuf_setlen(sb, sb->len + indent);
882 }
883 strbuf_add(sb, line, linelen);
884 strbuf_addch(sb, '\n');
885 }
886}
887
69cd8f63
AG
888char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
889{
890 const char *encoding;
891
892 encoding = (git_log_output_encoding
893 ? git_log_output_encoding
894 : git_commit_encoding);
895 if (!encoding)
330db18c 896 encoding = "UTF-8";
69cd8f63
AG
897 if (encoding_p)
898 *encoding_p = encoding;
899 return logmsg_reencode(commit, encoding);
900}
901
93fc05eb 902void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
6bf4f1b4
JH
903 struct strbuf *sb, int abbrev,
904 const char *subject, const char *after_subject,
905 enum date_mode dmode, int need_8bit_cte)
93fc05eb
JS
906{
907 unsigned long beginning_of_body;
908 int indent = 4;
909 const char *msg = commit->buffer;
910 char *reencoded;
911 const char *encoding;
912
913 if (fmt == CMIT_FMT_USERFORMAT) {
d36f8679 914 format_commit_message(commit, user_format, sb, dmode);
93fc05eb
JS
915 return;
916 }
917
69cd8f63 918 reencoded = reencode_commit_message(commit, &encoding);
93fc05eb
JS
919 if (reencoded) {
920 msg = reencoded;
921 }
922
923 if (fmt == CMIT_FMT_ONELINE || fmt == CMIT_FMT_EMAIL)
924 indent = 0;
925
6bf4f1b4
JH
926 /*
927 * We need to check and emit Content-type: to mark it
928 * as 8-bit if we haven't done so.
93fc05eb 929 */
6bf4f1b4 930 if (fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
93fc05eb
JS
931 int i, ch, in_body;
932
933 for (in_body = i = 0; (ch = msg[i]); i++) {
934 if (!in_body) {
935 /* author could be non 7-bit ASCII but
936 * the log may be so; skip over the
937 * header part first.
938 */
939 if (ch == '\n' && msg[i+1] == '\n')
940 in_body = 1;
941 }
942 else if (non_ascii(ch)) {
6bf4f1b4 943 need_8bit_cte = 1;
93fc05eb
JS
944 break;
945 }
946 }
947 }
948
949 pp_header(fmt, abbrev, dmode, encoding, commit, &msg, sb);
950 if (fmt != CMIT_FMT_ONELINE && !subject) {
951 strbuf_addch(sb, '\n');
952 }
953
954 /* Skip excess blank lines at the beginning of body, if any... */
a0109668 955 msg = skip_empty_lines(msg);
93fc05eb
JS
956
957 /* These formats treat the title line specially. */
958 if (fmt == CMIT_FMT_ONELINE || fmt == CMIT_FMT_EMAIL)
959 pp_title_line(fmt, &msg, sb, subject,
6bf4f1b4 960 after_subject, encoding, need_8bit_cte);
93fc05eb
JS
961
962 beginning_of_body = sb->len;
963 if (fmt != CMIT_FMT_ONELINE)
964 pp_remainder(fmt, &msg, sb, indent);
965 strbuf_rtrim(sb);
966
967 /* Make sure there is an EOLN for the non-oneline case */
968 if (fmt != CMIT_FMT_ONELINE)
969 strbuf_addch(sb, '\n');
970
971 /*
972 * The caller may append additional body text in e-mail
973 * format. Make sure we did not strip the blank line
974 * between the header and the body.
975 */
976 if (fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
977 strbuf_addch(sb, '\n');
978 free(reencoded);
979}