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