stash: teach 'push' (and 'create_stash') to honor pathspec
[git.git] / pretty.c
blob37b2c3b1f9954d79bf799a3af979e8c337698b79
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"
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 expand_tabs_in_log;
20 int is_alias;
21 const char *user_format;
22 } *commit_formats;
23 static size_t builtin_formats_len;
24 static size_t commit_formats_len;
25 static size_t commit_formats_alloc;
26 static struct cmt_fmt_map *find_commit_format(const char *sought);
28 int commit_format_is_empty(enum cmit_fmt fmt)
30 return fmt == CMIT_FMT_USERFORMAT && !*user_format;
33 static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
35 free(user_format);
36 user_format = xstrdup(cp);
37 if (is_tformat)
38 rev->use_terminator = 1;
39 rev->commit_format = CMIT_FMT_USERFORMAT;
42 static int git_pretty_formats_config(const char *var, const char *value, void *cb)
44 struct cmt_fmt_map *commit_format = NULL;
45 const char *name;
46 const char *fmt;
47 int i;
49 if (!skip_prefix(var, "pretty.", &name))
50 return 0;
52 for (i = 0; i < builtin_formats_len; i++) {
53 if (!strcmp(commit_formats[i].name, name))
54 return 0;
57 for (i = builtin_formats_len; i < commit_formats_len; i++) {
58 if (!strcmp(commit_formats[i].name, name)) {
59 commit_format = &commit_formats[i];
60 break;
64 if (!commit_format) {
65 ALLOC_GROW(commit_formats, commit_formats_len+1,
66 commit_formats_alloc);
67 commit_format = &commit_formats[commit_formats_len];
68 memset(commit_format, 0, sizeof(*commit_format));
69 commit_formats_len++;
72 commit_format->name = xstrdup(name);
73 commit_format->format = CMIT_FMT_USERFORMAT;
74 if (git_config_string(&fmt, var, value))
75 return -1;
77 if (skip_prefix(fmt, "format:", &fmt))
78 commit_format->is_tformat = 0;
79 else if (skip_prefix(fmt, "tformat:", &fmt) || strchr(fmt, '%'))
80 commit_format->is_tformat = 1;
81 else
82 commit_format->is_alias = 1;
83 commit_format->user_format = fmt;
85 return 0;
88 static void setup_commit_formats(void)
90 struct cmt_fmt_map builtin_formats[] = {
91 { "raw", CMIT_FMT_RAW, 0, 0 },
92 { "medium", CMIT_FMT_MEDIUM, 0, 8 },
93 { "short", CMIT_FMT_SHORT, 0, 0 },
94 { "email", CMIT_FMT_EMAIL, 0, 0 },
95 { "mboxrd", CMIT_FMT_MBOXRD, 0, 0 },
96 { "fuller", CMIT_FMT_FULLER, 0, 8 },
97 { "full", CMIT_FMT_FULL, 0, 8 },
98 { "oneline", CMIT_FMT_ONELINE, 1, 0 }
100 commit_formats_len = ARRAY_SIZE(builtin_formats);
101 builtin_formats_len = commit_formats_len;
102 ALLOC_GROW(commit_formats, commit_formats_len, commit_formats_alloc);
103 memcpy(commit_formats, builtin_formats,
104 sizeof(*builtin_formats)*ARRAY_SIZE(builtin_formats));
106 git_config(git_pretty_formats_config, NULL);
109 static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
110 const char *original,
111 int num_redirections)
113 struct cmt_fmt_map *found = NULL;
114 size_t found_match_len = 0;
115 int i;
117 if (num_redirections >= commit_formats_len)
118 die("invalid --pretty format: "
119 "'%s' references an alias which points to itself",
120 original);
122 for (i = 0; i < commit_formats_len; i++) {
123 size_t match_len;
125 if (!starts_with(commit_formats[i].name, sought))
126 continue;
128 match_len = strlen(commit_formats[i].name);
129 if (found == NULL || found_match_len > match_len) {
130 found = &commit_formats[i];
131 found_match_len = match_len;
135 if (found && found->is_alias) {
136 found = find_commit_format_recursive(found->user_format,
137 original,
138 num_redirections+1);
141 return found;
144 static struct cmt_fmt_map *find_commit_format(const char *sought)
146 if (!commit_formats)
147 setup_commit_formats();
149 return find_commit_format_recursive(sought, sought, 0);
152 void get_commit_format(const char *arg, struct rev_info *rev)
154 struct cmt_fmt_map *commit_format;
156 rev->use_terminator = 0;
157 if (!arg) {
158 rev->commit_format = CMIT_FMT_DEFAULT;
159 return;
161 if (skip_prefix(arg, "format:", &arg)) {
162 save_user_format(rev, arg, 0);
163 return;
166 if (!*arg || skip_prefix(arg, "tformat:", &arg) || strchr(arg, '%')) {
167 save_user_format(rev, arg, 1);
168 return;
171 commit_format = find_commit_format(arg);
172 if (!commit_format)
173 die("invalid --pretty format: %s", arg);
175 rev->commit_format = commit_format->format;
176 rev->use_terminator = commit_format->is_tformat;
177 rev->expand_tabs_in_log_default = commit_format->expand_tabs_in_log;
178 if (commit_format->format == CMIT_FMT_USERFORMAT) {
179 save_user_format(rev, commit_format->user_format,
180 commit_format->is_tformat);
185 * Generic support for pretty-printing the header
187 static int get_one_line(const char *msg)
189 int ret = 0;
191 for (;;) {
192 char c = *msg++;
193 if (!c)
194 break;
195 ret++;
196 if (c == '\n')
197 break;
199 return ret;
202 /* High bit set, or ISO-2022-INT */
203 static int non_ascii(int ch)
205 return !isascii(ch) || ch == '\033';
208 int has_non_ascii(const char *s)
210 int ch;
211 if (!s)
212 return 0;
213 while ((ch = *s++) != '\0') {
214 if (non_ascii(ch))
215 return 1;
217 return 0;
220 static int is_rfc822_special(char ch)
222 switch (ch) {
223 case '(':
224 case ')':
225 case '<':
226 case '>':
227 case '[':
228 case ']':
229 case ':':
230 case ';':
231 case '@':
232 case ',':
233 case '.':
234 case '"':
235 case '\\':
236 return 1;
237 default:
238 return 0;
242 static int needs_rfc822_quoting(const char *s, int len)
244 int i;
245 for (i = 0; i < len; i++)
246 if (is_rfc822_special(s[i]))
247 return 1;
248 return 0;
251 static int last_line_length(struct strbuf *sb)
253 int i;
255 /* How many bytes are already used on the last line? */
256 for (i = sb->len - 1; i >= 0; i--)
257 if (sb->buf[i] == '\n')
258 break;
259 return sb->len - (i + 1);
262 static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
264 int i;
266 /* just a guess, we may have to also backslash-quote */
267 strbuf_grow(out, len + 2);
269 strbuf_addch(out, '"');
270 for (i = 0; i < len; i++) {
271 switch (s[i]) {
272 case '"':
273 case '\\':
274 strbuf_addch(out, '\\');
275 /* fall through */
276 default:
277 strbuf_addch(out, s[i]);
280 strbuf_addch(out, '"');
283 enum rfc2047_type {
284 RFC2047_SUBJECT,
285 RFC2047_ADDRESS
288 static int is_rfc2047_special(char ch, enum rfc2047_type type)
291 * rfc2047, section 4.2:
293 * 8-bit values which correspond to printable ASCII characters other
294 * than "=", "?", and "_" (underscore), MAY be represented as those
295 * characters. (But see section 5 for restrictions.) In
296 * particular, SPACE and TAB MUST NOT be represented as themselves
297 * within encoded words.
301 * rule out non-ASCII characters and non-printable characters (the
302 * non-ASCII check should be redundant as isprint() is not localized
303 * and only knows about ASCII, but be defensive about that)
305 if (non_ascii(ch) || !isprint(ch))
306 return 1;
309 * rule out special printable characters (' ' should be the only
310 * whitespace character considered printable, but be defensive and use
311 * isspace())
313 if (isspace(ch) || ch == '=' || ch == '?' || ch == '_')
314 return 1;
317 * rfc2047, section 5.3:
319 * As a replacement for a 'word' entity within a 'phrase', for example,
320 * one that precedes an address in a From, To, or Cc header. The ABNF
321 * definition for 'phrase' from RFC 822 thus becomes:
323 * phrase = 1*( encoded-word / word )
325 * In this case the set of characters that may be used in a "Q"-encoded
326 * 'encoded-word' is restricted to: <upper and lower case ASCII
327 * letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
328 * (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
329 * 'phrase' MUST be separated from any adjacent 'word', 'text' or
330 * 'special' by 'linear-white-space'.
333 if (type != RFC2047_ADDRESS)
334 return 0;
336 /* '=' and '_' are special cases and have been checked above */
337 return !(isalnum(ch) || ch == '!' || ch == '*' || ch == '+' || ch == '-' || ch == '/');
340 static int needs_rfc2047_encoding(const char *line, int len,
341 enum rfc2047_type type)
343 int i;
345 for (i = 0; i < len; i++) {
346 int ch = line[i];
347 if (non_ascii(ch) || ch == '\n')
348 return 1;
349 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
350 return 1;
353 return 0;
356 static void add_rfc2047(struct strbuf *sb, const char *line, size_t len,
357 const char *encoding, enum rfc2047_type type)
359 static const int max_encoded_length = 76; /* per rfc2047 */
360 int i;
361 int line_len = last_line_length(sb);
363 strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
364 strbuf_addf(sb, "=?%s?q?", encoding);
365 line_len += strlen(encoding) + 5; /* 5 for =??q? */
367 while (len) {
369 * RFC 2047, section 5 (3):
371 * Each 'encoded-word' MUST represent an integral number of
372 * characters. A multi-octet character may not be split across
373 * adjacent 'encoded- word's.
375 const unsigned char *p = (const unsigned char *)line;
376 int chrlen = mbs_chrlen(&line, &len, encoding);
377 int is_special = (chrlen > 1) || is_rfc2047_special(*p, type);
379 /* "=%02X" * chrlen, or the byte itself */
380 const char *encoded_fmt = is_special ? "=%02X" : "%c";
381 int encoded_len = is_special ? 3 * chrlen : 1;
384 * According to RFC 2047, we could encode the special character
385 * ' ' (space) with '_' (underscore) for readability. But many
386 * programs do not understand this and just leave the
387 * underscore in place. Thus, we do nothing special here, which
388 * causes ' ' to be encoded as '=20', avoiding this problem.
391 if (line_len + encoded_len + 2 > max_encoded_length) {
392 /* It won't fit with trailing "?=" --- break the line */
393 strbuf_addf(sb, "?=\n =?%s?q?", encoding);
394 line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
397 for (i = 0; i < chrlen; i++)
398 strbuf_addf(sb, encoded_fmt, p[i]);
399 line_len += encoded_len;
401 strbuf_addstr(sb, "?=");
404 const char *show_ident_date(const struct ident_split *ident,
405 const struct date_mode *mode)
407 unsigned long date = 0;
408 long tz = 0;
410 if (ident->date_begin && ident->date_end)
411 date = strtoul(ident->date_begin, NULL, 10);
412 if (date_overflows(date))
413 date = 0;
414 else {
415 if (ident->tz_begin && ident->tz_end)
416 tz = strtol(ident->tz_begin, NULL, 10);
417 if (tz >= INT_MAX || tz <= INT_MIN)
418 tz = 0;
420 return show_date(date, tz, mode);
423 void pp_user_info(struct pretty_print_context *pp,
424 const char *what, struct strbuf *sb,
425 const char *line, const char *encoding)
427 struct ident_split ident;
428 char *line_end;
429 const char *mailbuf, *namebuf;
430 size_t namelen, maillen;
431 int max_length = 78; /* per rfc2822 */
433 if (pp->fmt == CMIT_FMT_ONELINE)
434 return;
436 line_end = strchrnul(line, '\n');
437 if (split_ident_line(&ident, line, line_end - line))
438 return;
440 mailbuf = ident.mail_begin;
441 maillen = ident.mail_end - ident.mail_begin;
442 namebuf = ident.name_begin;
443 namelen = ident.name_end - ident.name_begin;
445 if (pp->mailmap)
446 map_user(pp->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
448 if (cmit_fmt_is_mail(pp->fmt)) {
449 if (pp->from_ident && ident_cmp(pp->from_ident, &ident)) {
450 struct strbuf buf = STRBUF_INIT;
452 strbuf_addstr(&buf, "From: ");
453 strbuf_add(&buf, namebuf, namelen);
454 strbuf_addstr(&buf, " <");
455 strbuf_add(&buf, mailbuf, maillen);
456 strbuf_addstr(&buf, ">\n");
457 string_list_append(&pp->in_body_headers,
458 strbuf_detach(&buf, NULL));
460 mailbuf = pp->from_ident->mail_begin;
461 maillen = pp->from_ident->mail_end - mailbuf;
462 namebuf = pp->from_ident->name_begin;
463 namelen = pp->from_ident->name_end - namebuf;
466 strbuf_addstr(sb, "From: ");
467 if (needs_rfc2047_encoding(namebuf, namelen, RFC2047_ADDRESS)) {
468 add_rfc2047(sb, namebuf, namelen,
469 encoding, RFC2047_ADDRESS);
470 max_length = 76; /* per rfc2047 */
471 } else if (needs_rfc822_quoting(namebuf, namelen)) {
472 struct strbuf quoted = STRBUF_INIT;
473 add_rfc822_quoted(&quoted, namebuf, namelen);
474 strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
475 -6, 1, max_length);
476 strbuf_release(&quoted);
477 } else {
478 strbuf_add_wrapped_bytes(sb, namebuf, namelen,
479 -6, 1, max_length);
482 if (max_length <
483 last_line_length(sb) + strlen(" <") + maillen + strlen(">"))
484 strbuf_addch(sb, '\n');
485 strbuf_addf(sb, " <%.*s>\n", (int)maillen, mailbuf);
486 } else {
487 strbuf_addf(sb, "%s: %.*s%.*s <%.*s>\n", what,
488 (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0, " ",
489 (int)namelen, namebuf, (int)maillen, mailbuf);
492 switch (pp->fmt) {
493 case CMIT_FMT_MEDIUM:
494 strbuf_addf(sb, "Date: %s\n",
495 show_ident_date(&ident, &pp->date_mode));
496 break;
497 case CMIT_FMT_EMAIL:
498 case CMIT_FMT_MBOXRD:
499 strbuf_addf(sb, "Date: %s\n",
500 show_ident_date(&ident, DATE_MODE(RFC2822)));
501 break;
502 case CMIT_FMT_FULLER:
503 strbuf_addf(sb, "%sDate: %s\n", what,
504 show_ident_date(&ident, &pp->date_mode));
505 break;
506 default:
507 /* notin' */
508 break;
512 static int is_blank_line(const char *line, int *len_p)
514 int len = *len_p;
515 while (len && isspace(line[len - 1]))
516 len--;
517 *len_p = len;
518 return !len;
521 const char *skip_blank_lines(const char *msg)
523 for (;;) {
524 int linelen = get_one_line(msg);
525 int ll = linelen;
526 if (!linelen)
527 break;
528 if (!is_blank_line(msg, &ll))
529 break;
530 msg += linelen;
532 return msg;
535 static void add_merge_info(const struct pretty_print_context *pp,
536 struct strbuf *sb, const struct commit *commit)
538 struct commit_list *parent = commit->parents;
540 if ((pp->fmt == CMIT_FMT_ONELINE) || (cmit_fmt_is_mail(pp->fmt)) ||
541 !parent || !parent->next)
542 return;
544 strbuf_addstr(sb, "Merge:");
546 while (parent) {
547 struct object_id *oidp = &parent->item->object.oid;
548 strbuf_addch(sb, ' ');
549 if (pp->abbrev)
550 strbuf_add_unique_abbrev(sb, oidp->hash, pp->abbrev);
551 else
552 strbuf_addstr(sb, oid_to_hex(oidp));
553 parent = parent->next;
555 strbuf_addch(sb, '\n');
558 static char *get_header(const char *msg, const char *key)
560 size_t len;
561 const char *v = find_commit_header(msg, key, &len);
562 return v ? xmemdupz(v, len) : NULL;
565 static char *replace_encoding_header(char *buf, const char *encoding)
567 struct strbuf tmp = STRBUF_INIT;
568 size_t start, len;
569 char *cp = buf;
571 /* guess if there is an encoding header before a \n\n */
572 while (!starts_with(cp, "encoding ")) {
573 cp = strchr(cp, '\n');
574 if (!cp || *++cp == '\n')
575 return buf;
577 start = cp - buf;
578 cp = strchr(cp, '\n');
579 if (!cp)
580 return buf; /* should not happen but be defensive */
581 len = cp + 1 - (buf + start);
583 strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
584 if (is_encoding_utf8(encoding)) {
585 /* we have re-coded to UTF-8; drop the header */
586 strbuf_remove(&tmp, start, len);
587 } else {
588 /* just replaces XXXX in 'encoding XXXX\n' */
589 strbuf_splice(&tmp, start + strlen("encoding "),
590 len - strlen("encoding \n"),
591 encoding, strlen(encoding));
593 return strbuf_detach(&tmp, NULL);
596 const char *logmsg_reencode(const struct commit *commit,
597 char **commit_encoding,
598 const char *output_encoding)
600 static const char *utf8 = "UTF-8";
601 const char *use_encoding;
602 char *encoding;
603 const char *msg = get_commit_buffer(commit, NULL);
604 char *out;
606 if (!output_encoding || !*output_encoding) {
607 if (commit_encoding)
608 *commit_encoding = get_header(msg, "encoding");
609 return msg;
611 encoding = get_header(msg, "encoding");
612 if (commit_encoding)
613 *commit_encoding = encoding;
614 use_encoding = encoding ? encoding : utf8;
615 if (same_encoding(use_encoding, output_encoding)) {
617 * No encoding work to be done. If we have no encoding header
618 * at all, then there's nothing to do, and we can return the
619 * message verbatim (whether newly allocated or not).
621 if (!encoding)
622 return msg;
625 * Otherwise, we still want to munge the encoding header in the
626 * result, which will be done by modifying the buffer. If we
627 * are using a fresh copy, we can reuse it. But if we are using
628 * the cached copy from get_commit_buffer, we need to duplicate it
629 * to avoid munging the cached copy.
631 if (msg == get_cached_commit_buffer(commit, NULL))
632 out = xstrdup(msg);
633 else
634 out = (char *)msg;
636 else {
638 * There's actual encoding work to do. Do the reencoding, which
639 * still leaves the header to be replaced in the next step. At
640 * this point, we are done with msg. If we allocated a fresh
641 * copy, we can free it.
643 out = reencode_string(msg, output_encoding, use_encoding);
644 if (out)
645 unuse_commit_buffer(commit, msg);
649 * This replacement actually consumes the buffer we hand it, so we do
650 * not have to worry about freeing the old "out" here.
652 if (out)
653 out = replace_encoding_header(out, output_encoding);
655 if (!commit_encoding)
656 free(encoding);
658 * If the re-encoding failed, out might be NULL here; in that
659 * case we just return the commit message verbatim.
661 return out ? out : msg;
664 static int mailmap_name(const char **email, size_t *email_len,
665 const char **name, size_t *name_len)
667 static struct string_list *mail_map;
668 if (!mail_map) {
669 mail_map = xcalloc(1, sizeof(*mail_map));
670 read_mailmap(mail_map, NULL);
672 return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
675 static size_t format_person_part(struct strbuf *sb, char part,
676 const char *msg, int len,
677 const struct date_mode *dmode)
679 /* currently all placeholders have same length */
680 const int placeholder_len = 2;
681 struct ident_split s;
682 const char *name, *mail;
683 size_t maillen, namelen;
685 if (split_ident_line(&s, msg, len) < 0)
686 goto skip;
688 name = s.name_begin;
689 namelen = s.name_end - s.name_begin;
690 mail = s.mail_begin;
691 maillen = s.mail_end - s.mail_begin;
693 if (part == 'N' || part == 'E') /* mailmap lookup */
694 mailmap_name(&mail, &maillen, &name, &namelen);
695 if (part == 'n' || part == 'N') { /* name */
696 strbuf_add(sb, name, namelen);
697 return placeholder_len;
699 if (part == 'e' || part == 'E') { /* email */
700 strbuf_add(sb, mail, maillen);
701 return placeholder_len;
704 if (!s.date_begin)
705 goto skip;
707 if (part == 't') { /* date, UNIX timestamp */
708 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
709 return placeholder_len;
712 switch (part) {
713 case 'd': /* date */
714 strbuf_addstr(sb, show_ident_date(&s, dmode));
715 return placeholder_len;
716 case 'D': /* date, RFC2822 style */
717 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(RFC2822)));
718 return placeholder_len;
719 case 'r': /* date, relative */
720 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(RELATIVE)));
721 return placeholder_len;
722 case 'i': /* date, ISO 8601-like */
723 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601)));
724 return placeholder_len;
725 case 'I': /* date, ISO 8601 strict */
726 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601_STRICT)));
727 return placeholder_len;
730 skip:
732 * reading from either a bogus commit, or a reflog entry with
733 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
734 * to compute a valid return value.
736 if (part == 'n' || part == 'e' || part == 't' || part == 'd'
737 || part == 'D' || part == 'r' || part == 'i')
738 return placeholder_len;
740 return 0; /* unknown placeholder */
743 struct chunk {
744 size_t off;
745 size_t len;
748 enum flush_type {
749 no_flush,
750 flush_right,
751 flush_left,
752 flush_left_and_steal,
753 flush_both
756 enum trunc_type {
757 trunc_none,
758 trunc_left,
759 trunc_middle,
760 trunc_right
763 struct format_commit_context {
764 const struct commit *commit;
765 const struct pretty_print_context *pretty_ctx;
766 unsigned commit_header_parsed:1;
767 unsigned commit_message_parsed:1;
768 struct signature_check signature_check;
769 enum flush_type flush_type;
770 enum trunc_type truncate;
771 const char *message;
772 char *commit_encoding;
773 size_t width, indent1, indent2;
774 int auto_color;
775 int padding;
777 /* These offsets are relative to the start of the commit message. */
778 struct chunk author;
779 struct chunk committer;
780 size_t message_off;
781 size_t subject_off;
782 size_t body_off;
784 /* The following ones are relative to the result struct strbuf. */
785 struct chunk abbrev_commit_hash;
786 struct chunk abbrev_tree_hash;
787 struct chunk abbrev_parent_hashes;
788 size_t wrap_start;
791 static int add_again(struct strbuf *sb, struct chunk *chunk)
793 if (chunk->len) {
794 strbuf_adddup(sb, chunk->off, chunk->len);
795 return 1;
799 * We haven't seen this chunk before. Our caller is surely
800 * going to add it the hard way now. Remember the most likely
801 * start of the to-be-added chunk: the current end of the
802 * struct strbuf.
804 chunk->off = sb->len;
805 return 0;
808 static void parse_commit_header(struct format_commit_context *context)
810 const char *msg = context->message;
811 int i;
813 for (i = 0; msg[i]; i++) {
814 const char *name;
815 int eol;
816 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
817 ; /* do nothing */
819 if (i == eol) {
820 break;
821 } else if (skip_prefix(msg + i, "author ", &name)) {
822 context->author.off = name - msg;
823 context->author.len = msg + eol - name;
824 } else if (skip_prefix(msg + i, "committer ", &name)) {
825 context->committer.off = name - msg;
826 context->committer.len = msg + eol - name;
828 i = eol;
830 context->message_off = i;
831 context->commit_header_parsed = 1;
834 static int istitlechar(char c)
836 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
837 (c >= '0' && c <= '9') || c == '.' || c == '_';
840 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
842 size_t trimlen;
843 size_t start_len = sb->len;
844 int space = 2;
846 for (; *msg && *msg != '\n'; msg++) {
847 if (istitlechar(*msg)) {
848 if (space == 1)
849 strbuf_addch(sb, '-');
850 space = 0;
851 strbuf_addch(sb, *msg);
852 if (*msg == '.')
853 while (*(msg+1) == '.')
854 msg++;
855 } else
856 space |= 1;
859 /* trim any trailing '.' or '-' characters */
860 trimlen = 0;
861 while (sb->len - trimlen > start_len &&
862 (sb->buf[sb->len - 1 - trimlen] == '.'
863 || sb->buf[sb->len - 1 - trimlen] == '-'))
864 trimlen++;
865 strbuf_remove(sb, sb->len - trimlen, trimlen);
868 const char *format_subject(struct strbuf *sb, const char *msg,
869 const char *line_separator)
871 int first = 1;
873 for (;;) {
874 const char *line = msg;
875 int linelen = get_one_line(line);
877 msg += linelen;
878 if (!linelen || is_blank_line(line, &linelen))
879 break;
881 if (!sb)
882 continue;
883 strbuf_grow(sb, linelen + 2);
884 if (!first)
885 strbuf_addstr(sb, line_separator);
886 strbuf_add(sb, line, linelen);
887 first = 0;
889 return msg;
892 static void parse_commit_message(struct format_commit_context *c)
894 const char *msg = c->message + c->message_off;
895 const char *start = c->message;
897 msg = skip_blank_lines(msg);
898 c->subject_off = msg - start;
900 msg = format_subject(NULL, msg, NULL);
901 msg = skip_blank_lines(msg);
902 c->body_off = msg - start;
904 c->commit_message_parsed = 1;
907 static void strbuf_wrap(struct strbuf *sb, size_t pos,
908 size_t width, size_t indent1, size_t indent2)
910 struct strbuf tmp = STRBUF_INIT;
912 if (pos)
913 strbuf_add(&tmp, sb->buf, pos);
914 strbuf_add_wrapped_text(&tmp, sb->buf + pos,
915 (int) indent1, (int) indent2, (int) width);
916 strbuf_swap(&tmp, sb);
917 strbuf_release(&tmp);
920 static void rewrap_message_tail(struct strbuf *sb,
921 struct format_commit_context *c,
922 size_t new_width, size_t new_indent1,
923 size_t new_indent2)
925 if (c->width == new_width && c->indent1 == new_indent1 &&
926 c->indent2 == new_indent2)
927 return;
928 if (c->wrap_start < sb->len)
929 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
930 c->wrap_start = sb->len;
931 c->width = new_width;
932 c->indent1 = new_indent1;
933 c->indent2 = new_indent2;
936 static int format_reflog_person(struct strbuf *sb,
937 char part,
938 struct reflog_walk_info *log,
939 const struct date_mode *dmode)
941 const char *ident;
943 if (!log)
944 return 2;
946 ident = get_reflog_ident(log);
947 if (!ident)
948 return 2;
950 return format_person_part(sb, part, ident, strlen(ident), dmode);
953 static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
954 const char *placeholder,
955 struct format_commit_context *c)
957 const char *rest = placeholder;
959 if (placeholder[1] == '(') {
960 const char *begin = placeholder + 2;
961 const char *end = strchr(begin, ')');
962 char color[COLOR_MAXLEN];
964 if (!end)
965 return 0;
966 if (skip_prefix(begin, "auto,", &begin)) {
967 if (!want_color(c->pretty_ctx->color))
968 return end - placeholder + 1;
970 if (color_parse_mem(begin, end - begin, color) < 0)
971 die(_("unable to parse --pretty format"));
972 strbuf_addstr(sb, color);
973 return end - placeholder + 1;
975 if (skip_prefix(placeholder + 1, "red", &rest))
976 strbuf_addstr(sb, GIT_COLOR_RED);
977 else if (skip_prefix(placeholder + 1, "green", &rest))
978 strbuf_addstr(sb, GIT_COLOR_GREEN);
979 else if (skip_prefix(placeholder + 1, "blue", &rest))
980 strbuf_addstr(sb, GIT_COLOR_BLUE);
981 else if (skip_prefix(placeholder + 1, "reset", &rest))
982 strbuf_addstr(sb, GIT_COLOR_RESET);
983 return rest - placeholder;
986 static size_t parse_padding_placeholder(struct strbuf *sb,
987 const char *placeholder,
988 struct format_commit_context *c)
990 const char *ch = placeholder;
991 enum flush_type flush_type;
992 int to_column = 0;
994 switch (*ch++) {
995 case '<':
996 flush_type = flush_right;
997 break;
998 case '>':
999 if (*ch == '<') {
1000 flush_type = flush_both;
1001 ch++;
1002 } else if (*ch == '>') {
1003 flush_type = flush_left_and_steal;
1004 ch++;
1005 } else
1006 flush_type = flush_left;
1007 break;
1008 default:
1009 return 0;
1012 /* the next value means "wide enough to that column" */
1013 if (*ch == '|') {
1014 to_column = 1;
1015 ch++;
1018 if (*ch == '(') {
1019 const char *start = ch + 1;
1020 const char *end = start + strcspn(start, ",)");
1021 char *next;
1022 int width;
1023 if (!end || end == start)
1024 return 0;
1025 width = strtol(start, &next, 10);
1026 if (next == start || width == 0)
1027 return 0;
1028 if (width < 0) {
1029 if (to_column)
1030 width += term_columns();
1031 if (width < 0)
1032 return 0;
1034 c->padding = to_column ? -width : width;
1035 c->flush_type = flush_type;
1037 if (*end == ',') {
1038 start = end + 1;
1039 end = strchr(start, ')');
1040 if (!end || end == start)
1041 return 0;
1042 if (starts_with(start, "trunc)"))
1043 c->truncate = trunc_right;
1044 else if (starts_with(start, "ltrunc)"))
1045 c->truncate = trunc_left;
1046 else if (starts_with(start, "mtrunc)"))
1047 c->truncate = trunc_middle;
1048 else
1049 return 0;
1050 } else
1051 c->truncate = trunc_none;
1053 return end - placeholder + 1;
1055 return 0;
1058 static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
1059 const char *placeholder,
1060 void *context)
1062 struct format_commit_context *c = context;
1063 const struct commit *commit = c->commit;
1064 const char *msg = c->message;
1065 struct commit_list *p;
1066 int ch;
1068 /* these are independent of the commit */
1069 switch (placeholder[0]) {
1070 case 'C':
1071 if (starts_with(placeholder + 1, "(auto)")) {
1072 c->auto_color = want_color(c->pretty_ctx->color);
1073 if (c->auto_color && sb->len)
1074 strbuf_addstr(sb, GIT_COLOR_RESET);
1075 return 7; /* consumed 7 bytes, "C(auto)" */
1076 } else {
1077 int ret = parse_color(sb, placeholder, c);
1078 if (ret)
1079 c->auto_color = 0;
1081 * Otherwise, we decided to treat %C<unknown>
1082 * as a literal string, and the previous
1083 * %C(auto) is still valid.
1085 return ret;
1087 case 'n': /* newline */
1088 strbuf_addch(sb, '\n');
1089 return 1;
1090 case 'x':
1091 /* %x00 == NUL, %x0a == LF, etc. */
1092 ch = hex2chr(placeholder + 1);
1093 if (ch < 0)
1094 return 0;
1095 strbuf_addch(sb, ch);
1096 return 3;
1097 case 'w':
1098 if (placeholder[1] == '(') {
1099 unsigned long width = 0, indent1 = 0, indent2 = 0;
1100 char *next;
1101 const char *start = placeholder + 2;
1102 const char *end = strchr(start, ')');
1103 if (!end)
1104 return 0;
1105 if (end > start) {
1106 width = strtoul(start, &next, 10);
1107 if (*next == ',') {
1108 indent1 = strtoul(next + 1, &next, 10);
1109 if (*next == ',') {
1110 indent2 = strtoul(next + 1,
1111 &next, 10);
1114 if (*next != ')')
1115 return 0;
1117 rewrap_message_tail(sb, c, width, indent1, indent2);
1118 return end - placeholder + 1;
1119 } else
1120 return 0;
1122 case '<':
1123 case '>':
1124 return parse_padding_placeholder(sb, placeholder, c);
1127 /* these depend on the commit */
1128 if (!commit->object.parsed)
1129 parse_object(commit->object.oid.hash);
1131 switch (placeholder[0]) {
1132 case 'H': /* commit hash */
1133 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1134 strbuf_addstr(sb, oid_to_hex(&commit->object.oid));
1135 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1136 return 1;
1137 case 'h': /* abbreviated commit hash */
1138 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1139 if (add_again(sb, &c->abbrev_commit_hash)) {
1140 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1141 return 1;
1143 strbuf_add_unique_abbrev(sb, commit->object.oid.hash,
1144 c->pretty_ctx->abbrev);
1145 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1146 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
1147 return 1;
1148 case 'T': /* tree hash */
1149 strbuf_addstr(sb, oid_to_hex(&commit->tree->object.oid));
1150 return 1;
1151 case 't': /* abbreviated tree hash */
1152 if (add_again(sb, &c->abbrev_tree_hash))
1153 return 1;
1154 strbuf_add_unique_abbrev(sb, commit->tree->object.oid.hash,
1155 c->pretty_ctx->abbrev);
1156 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
1157 return 1;
1158 case 'P': /* parent hashes */
1159 for (p = commit->parents; p; p = p->next) {
1160 if (p != commit->parents)
1161 strbuf_addch(sb, ' ');
1162 strbuf_addstr(sb, oid_to_hex(&p->item->object.oid));
1164 return 1;
1165 case 'p': /* abbreviated parent hashes */
1166 if (add_again(sb, &c->abbrev_parent_hashes))
1167 return 1;
1168 for (p = commit->parents; p; p = p->next) {
1169 if (p != commit->parents)
1170 strbuf_addch(sb, ' ');
1171 strbuf_add_unique_abbrev(sb, p->item->object.oid.hash,
1172 c->pretty_ctx->abbrev);
1174 c->abbrev_parent_hashes.len = sb->len -
1175 c->abbrev_parent_hashes.off;
1176 return 1;
1177 case 'm': /* left/right/bottom */
1178 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1179 return 1;
1180 case 'd':
1181 load_ref_decorations(DECORATE_SHORT_REFS);
1182 format_decorations(sb, commit, c->auto_color);
1183 return 1;
1184 case 'D':
1185 load_ref_decorations(DECORATE_SHORT_REFS);
1186 format_decorations_extended(sb, commit, c->auto_color, "", ", ", "");
1187 return 1;
1188 case 'g': /* reflog info */
1189 switch(placeholder[1]) {
1190 case 'd': /* reflog selector */
1191 case 'D':
1192 if (c->pretty_ctx->reflog_info)
1193 get_reflog_selector(sb,
1194 c->pretty_ctx->reflog_info,
1195 &c->pretty_ctx->date_mode,
1196 c->pretty_ctx->date_mode_explicit,
1197 (placeholder[1] == 'd'));
1198 return 2;
1199 case 's': /* reflog message */
1200 if (c->pretty_ctx->reflog_info)
1201 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1202 return 2;
1203 case 'n':
1204 case 'N':
1205 case 'e':
1206 case 'E':
1207 return format_reflog_person(sb,
1208 placeholder[1],
1209 c->pretty_ctx->reflog_info,
1210 &c->pretty_ctx->date_mode);
1212 return 0; /* unknown %g placeholder */
1213 case 'N':
1214 if (c->pretty_ctx->notes_message) {
1215 strbuf_addstr(sb, c->pretty_ctx->notes_message);
1216 return 1;
1218 return 0;
1221 if (placeholder[0] == 'G') {
1222 if (!c->signature_check.result)
1223 check_commit_signature(c->commit, &(c->signature_check));
1224 switch (placeholder[1]) {
1225 case 'G':
1226 if (c->signature_check.gpg_output)
1227 strbuf_addstr(sb, c->signature_check.gpg_output);
1228 break;
1229 case '?':
1230 switch (c->signature_check.result) {
1231 case 'G':
1232 case 'B':
1233 case 'E':
1234 case 'U':
1235 case 'N':
1236 case 'X':
1237 case 'Y':
1238 case 'R':
1239 strbuf_addch(sb, c->signature_check.result);
1241 break;
1242 case 'S':
1243 if (c->signature_check.signer)
1244 strbuf_addstr(sb, c->signature_check.signer);
1245 break;
1246 case 'K':
1247 if (c->signature_check.key)
1248 strbuf_addstr(sb, c->signature_check.key);
1249 break;
1250 default:
1251 return 0;
1253 return 2;
1257 /* For the rest we have to parse the commit header. */
1258 if (!c->commit_header_parsed)
1259 parse_commit_header(c);
1261 switch (placeholder[0]) {
1262 case 'a': /* author ... */
1263 return format_person_part(sb, placeholder[1],
1264 msg + c->author.off, c->author.len,
1265 &c->pretty_ctx->date_mode);
1266 case 'c': /* committer ... */
1267 return format_person_part(sb, placeholder[1],
1268 msg + c->committer.off, c->committer.len,
1269 &c->pretty_ctx->date_mode);
1270 case 'e': /* encoding */
1271 if (c->commit_encoding)
1272 strbuf_addstr(sb, c->commit_encoding);
1273 return 1;
1274 case 'B': /* raw body */
1275 /* message_off is always left at the initial newline */
1276 strbuf_addstr(sb, msg + c->message_off + 1);
1277 return 1;
1280 /* Now we need to parse the commit message. */
1281 if (!c->commit_message_parsed)
1282 parse_commit_message(c);
1284 switch (placeholder[0]) {
1285 case 's': /* subject */
1286 format_subject(sb, msg + c->subject_off, " ");
1287 return 1;
1288 case 'f': /* sanitized subject */
1289 format_sanitized_subject(sb, msg + c->subject_off);
1290 return 1;
1291 case 'b': /* body */
1292 strbuf_addstr(sb, msg + c->body_off);
1293 return 1;
1295 return 0; /* unknown placeholder */
1298 static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
1299 const char *placeholder,
1300 struct format_commit_context *c)
1302 struct strbuf local_sb = STRBUF_INIT;
1303 int total_consumed = 0, len, padding = c->padding;
1304 if (padding < 0) {
1305 const char *start = strrchr(sb->buf, '\n');
1306 int occupied;
1307 if (!start)
1308 start = sb->buf;
1309 occupied = utf8_strnwidth(start, -1, 1);
1310 occupied += c->pretty_ctx->graph_width;
1311 padding = (-padding) - occupied;
1313 while (1) {
1314 int modifier = *placeholder == 'C';
1315 int consumed = format_commit_one(&local_sb, placeholder, c);
1316 total_consumed += consumed;
1318 if (!modifier)
1319 break;
1321 placeholder += consumed;
1322 if (*placeholder != '%')
1323 break;
1324 placeholder++;
1325 total_consumed++;
1327 len = utf8_strnwidth(local_sb.buf, -1, 1);
1329 if (c->flush_type == flush_left_and_steal) {
1330 const char *ch = sb->buf + sb->len - 1;
1331 while (len > padding && ch > sb->buf) {
1332 const char *p;
1333 if (*ch == ' ') {
1334 ch--;
1335 padding++;
1336 continue;
1338 /* check for trailing ansi sequences */
1339 if (*ch != 'm')
1340 break;
1341 p = ch - 1;
1342 while (ch - p < 10 && *p != '\033')
1343 p--;
1344 if (*p != '\033' ||
1345 ch + 1 - p != display_mode_esc_sequence_len(p))
1346 break;
1348 * got a good ansi sequence, put it back to
1349 * local_sb as we're cutting sb
1351 strbuf_insert(&local_sb, 0, p, ch + 1 - p);
1352 ch = p - 1;
1354 strbuf_setlen(sb, ch + 1 - sb->buf);
1355 c->flush_type = flush_left;
1358 if (len > padding) {
1359 switch (c->truncate) {
1360 case trunc_left:
1361 strbuf_utf8_replace(&local_sb,
1362 0, len - (padding - 2),
1363 "..");
1364 break;
1365 case trunc_middle:
1366 strbuf_utf8_replace(&local_sb,
1367 padding / 2 - 1,
1368 len - (padding - 2),
1369 "..");
1370 break;
1371 case trunc_right:
1372 strbuf_utf8_replace(&local_sb,
1373 padding - 2, len - (padding - 2),
1374 "..");
1375 break;
1376 case trunc_none:
1377 break;
1379 strbuf_addbuf(sb, &local_sb);
1380 } else {
1381 int sb_len = sb->len, offset = 0;
1382 if (c->flush_type == flush_left)
1383 offset = padding - len;
1384 else if (c->flush_type == flush_both)
1385 offset = (padding - len) / 2;
1387 * we calculate padding in columns, now
1388 * convert it back to chars
1390 padding = padding - len + local_sb.len;
1391 strbuf_addchars(sb, ' ', padding);
1392 memcpy(sb->buf + sb_len + offset, local_sb.buf,
1393 local_sb.len);
1395 strbuf_release(&local_sb);
1396 c->flush_type = no_flush;
1397 return total_consumed;
1400 static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
1401 const char *placeholder,
1402 void *context)
1404 int consumed;
1405 size_t orig_len;
1406 enum {
1407 NO_MAGIC,
1408 ADD_LF_BEFORE_NON_EMPTY,
1409 DEL_LF_BEFORE_EMPTY,
1410 ADD_SP_BEFORE_NON_EMPTY
1411 } magic = NO_MAGIC;
1413 switch (placeholder[0]) {
1414 case '-':
1415 magic = DEL_LF_BEFORE_EMPTY;
1416 break;
1417 case '+':
1418 magic = ADD_LF_BEFORE_NON_EMPTY;
1419 break;
1420 case ' ':
1421 magic = ADD_SP_BEFORE_NON_EMPTY;
1422 break;
1423 default:
1424 break;
1426 if (magic != NO_MAGIC)
1427 placeholder++;
1429 orig_len = sb->len;
1430 if (((struct format_commit_context *)context)->flush_type != no_flush)
1431 consumed = format_and_pad_commit(sb, placeholder, context);
1432 else
1433 consumed = format_commit_one(sb, placeholder, context);
1434 if (magic == NO_MAGIC)
1435 return consumed;
1437 if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1438 while (sb->len && sb->buf[sb->len - 1] == '\n')
1439 strbuf_setlen(sb, sb->len - 1);
1440 } else if (orig_len != sb->len) {
1441 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1442 strbuf_insert(sb, orig_len, "\n", 1);
1443 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1444 strbuf_insert(sb, orig_len, " ", 1);
1446 return consumed + 1;
1449 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1450 void *context)
1452 struct userformat_want *w = context;
1454 if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1455 placeholder++;
1457 switch (*placeholder) {
1458 case 'N':
1459 w->notes = 1;
1460 break;
1462 return 0;
1465 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1467 struct strbuf dummy = STRBUF_INIT;
1469 if (!fmt) {
1470 if (!user_format)
1471 return;
1472 fmt = user_format;
1474 strbuf_expand(&dummy, fmt, userformat_want_item, w);
1475 strbuf_release(&dummy);
1478 void format_commit_message(const struct commit *commit,
1479 const char *format, struct strbuf *sb,
1480 const struct pretty_print_context *pretty_ctx)
1482 struct format_commit_context context;
1483 const char *output_enc = pretty_ctx->output_encoding;
1484 const char *utf8 = "UTF-8";
1486 memset(&context, 0, sizeof(context));
1487 context.commit = commit;
1488 context.pretty_ctx = pretty_ctx;
1489 context.wrap_start = sb->len;
1491 * convert a commit message to UTF-8 first
1492 * as far as 'format_commit_item' assumes it in UTF-8
1494 context.message = logmsg_reencode(commit,
1495 &context.commit_encoding,
1496 utf8);
1498 strbuf_expand(sb, format, format_commit_item, &context);
1499 rewrap_message_tail(sb, &context, 0, 0, 0);
1501 /* then convert a commit message to an actual output encoding */
1502 if (output_enc) {
1503 if (same_encoding(utf8, output_enc))
1504 output_enc = NULL;
1505 } else {
1506 if (context.commit_encoding &&
1507 !same_encoding(context.commit_encoding, utf8))
1508 output_enc = context.commit_encoding;
1511 if (output_enc) {
1512 int outsz;
1513 char *out = reencode_string_len(sb->buf, sb->len,
1514 output_enc, utf8, &outsz);
1515 if (out)
1516 strbuf_attach(sb, out, outsz, outsz + 1);
1519 free(context.commit_encoding);
1520 unuse_commit_buffer(commit, context.message);
1523 static void pp_header(struct pretty_print_context *pp,
1524 const char *encoding,
1525 const struct commit *commit,
1526 const char **msg_p,
1527 struct strbuf *sb)
1529 int parents_shown = 0;
1531 for (;;) {
1532 const char *name, *line = *msg_p;
1533 int linelen = get_one_line(*msg_p);
1535 if (!linelen)
1536 return;
1537 *msg_p += linelen;
1539 if (linelen == 1)
1540 /* End of header */
1541 return;
1543 if (pp->fmt == CMIT_FMT_RAW) {
1544 strbuf_add(sb, line, linelen);
1545 continue;
1548 if (starts_with(line, "parent ")) {
1549 if (linelen != 48)
1550 die("bad parent line in commit");
1551 continue;
1554 if (!parents_shown) {
1555 unsigned num = commit_list_count(commit->parents);
1556 /* with enough slop */
1557 strbuf_grow(sb, num * 50 + 20);
1558 add_merge_info(pp, sb, commit);
1559 parents_shown = 1;
1563 * MEDIUM == DEFAULT shows only author with dates.
1564 * FULL shows both authors but not dates.
1565 * FULLER shows both authors and dates.
1567 if (skip_prefix(line, "author ", &name)) {
1568 strbuf_grow(sb, linelen + 80);
1569 pp_user_info(pp, "Author", sb, name, encoding);
1571 if (skip_prefix(line, "committer ", &name) &&
1572 (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1573 strbuf_grow(sb, linelen + 80);
1574 pp_user_info(pp, "Commit", sb, name, encoding);
1579 void pp_title_line(struct pretty_print_context *pp,
1580 const char **msg_p,
1581 struct strbuf *sb,
1582 const char *encoding,
1583 int need_8bit_cte)
1585 static const int max_length = 78; /* per rfc2047 */
1586 struct strbuf title;
1588 strbuf_init(&title, 80);
1589 *msg_p = format_subject(&title, *msg_p,
1590 pp->preserve_subject ? "\n" : " ");
1592 strbuf_grow(sb, title.len + 1024);
1593 if (pp->subject) {
1594 strbuf_addstr(sb, pp->subject);
1595 if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
1596 add_rfc2047(sb, title.buf, title.len,
1597 encoding, RFC2047_SUBJECT);
1598 else
1599 strbuf_add_wrapped_bytes(sb, title.buf, title.len,
1600 -last_line_length(sb), 1, max_length);
1601 } else {
1602 strbuf_addbuf(sb, &title);
1604 strbuf_addch(sb, '\n');
1606 if (need_8bit_cte == 0) {
1607 int i;
1608 for (i = 0; i < pp->in_body_headers.nr; i++) {
1609 if (has_non_ascii(pp->in_body_headers.items[i].string)) {
1610 need_8bit_cte = 1;
1611 break;
1616 if (need_8bit_cte > 0) {
1617 const char *header_fmt =
1618 "MIME-Version: 1.0\n"
1619 "Content-Type: text/plain; charset=%s\n"
1620 "Content-Transfer-Encoding: 8bit\n";
1621 strbuf_addf(sb, header_fmt, encoding);
1623 if (pp->after_subject) {
1624 strbuf_addstr(sb, pp->after_subject);
1626 if (cmit_fmt_is_mail(pp->fmt)) {
1627 strbuf_addch(sb, '\n');
1630 if (pp->in_body_headers.nr) {
1631 int i;
1632 for (i = 0; i < pp->in_body_headers.nr; i++) {
1633 strbuf_addstr(sb, pp->in_body_headers.items[i].string);
1634 free(pp->in_body_headers.items[i].string);
1636 string_list_clear(&pp->in_body_headers, 0);
1637 strbuf_addch(sb, '\n');
1640 strbuf_release(&title);
1643 static int pp_utf8_width(const char *start, const char *end)
1645 int width = 0;
1646 size_t remain = end - start;
1648 while (remain) {
1649 int n = utf8_width(&start, &remain);
1650 if (n < 0 || !start)
1651 return -1;
1652 width += n;
1654 return width;
1657 static void strbuf_add_tabexpand(struct strbuf *sb, int tabwidth,
1658 const char *line, int linelen)
1660 const char *tab;
1662 while ((tab = memchr(line, '\t', linelen)) != NULL) {
1663 int width = pp_utf8_width(line, tab);
1666 * If it wasn't well-formed utf8, or it
1667 * had characters with badly defined
1668 * width (control characters etc), just
1669 * give up on trying to align things.
1671 if (width < 0)
1672 break;
1674 /* Output the data .. */
1675 strbuf_add(sb, line, tab - line);
1677 /* .. and the de-tabified tab */
1678 strbuf_addchars(sb, ' ', tabwidth - (width % tabwidth));
1680 /* Skip over the printed part .. */
1681 linelen -= tab + 1 - line;
1682 line = tab + 1;
1686 * Print out everything after the last tab without
1687 * worrying about width - there's nothing more to
1688 * align.
1690 strbuf_add(sb, line, linelen);
1694 * pp_handle_indent() prints out the intendation, and
1695 * the whole line (without the final newline), after
1696 * de-tabifying.
1698 static void pp_handle_indent(struct pretty_print_context *pp,
1699 struct strbuf *sb, int indent,
1700 const char *line, int linelen)
1702 strbuf_addchars(sb, ' ', indent);
1703 if (pp->expand_tabs_in_log)
1704 strbuf_add_tabexpand(sb, pp->expand_tabs_in_log, line, linelen);
1705 else
1706 strbuf_add(sb, line, linelen);
1709 static int is_mboxrd_from(const char *line, int len)
1712 * a line matching /^From $/ here would only have len == 4
1713 * at this point because is_empty_line would've trimmed all
1714 * trailing space
1716 return len > 4 && starts_with(line + strspn(line, ">"), "From ");
1719 void pp_remainder(struct pretty_print_context *pp,
1720 const char **msg_p,
1721 struct strbuf *sb,
1722 int indent)
1724 int first = 1;
1725 for (;;) {
1726 const char *line = *msg_p;
1727 int linelen = get_one_line(line);
1728 *msg_p += linelen;
1730 if (!linelen)
1731 break;
1733 if (is_blank_line(line, &linelen)) {
1734 if (first)
1735 continue;
1736 if (pp->fmt == CMIT_FMT_SHORT)
1737 break;
1739 first = 0;
1741 strbuf_grow(sb, linelen + indent + 20);
1742 if (indent)
1743 pp_handle_indent(pp, sb, indent, line, linelen);
1744 else if (pp->expand_tabs_in_log)
1745 strbuf_add_tabexpand(sb, pp->expand_tabs_in_log,
1746 line, linelen);
1747 else {
1748 if (pp->fmt == CMIT_FMT_MBOXRD &&
1749 is_mboxrd_from(line, linelen))
1750 strbuf_addch(sb, '>');
1752 strbuf_add(sb, line, linelen);
1754 strbuf_addch(sb, '\n');
1758 void pretty_print_commit(struct pretty_print_context *pp,
1759 const struct commit *commit,
1760 struct strbuf *sb)
1762 unsigned long beginning_of_body;
1763 int indent = 4;
1764 const char *msg;
1765 const char *reencoded;
1766 const char *encoding;
1767 int need_8bit_cte = pp->need_8bit_cte;
1769 if (pp->fmt == CMIT_FMT_USERFORMAT) {
1770 format_commit_message(commit, user_format, sb, pp);
1771 return;
1774 encoding = get_log_output_encoding();
1775 msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1777 if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1778 indent = 0;
1781 * We need to check and emit Content-type: to mark it
1782 * as 8-bit if we haven't done so.
1784 if (cmit_fmt_is_mail(pp->fmt) && need_8bit_cte == 0) {
1785 int i, ch, in_body;
1787 for (in_body = i = 0; (ch = msg[i]); i++) {
1788 if (!in_body) {
1789 /* author could be non 7-bit ASCII but
1790 * the log may be so; skip over the
1791 * header part first.
1793 if (ch == '\n' && msg[i+1] == '\n')
1794 in_body = 1;
1796 else if (non_ascii(ch)) {
1797 need_8bit_cte = 1;
1798 break;
1803 pp_header(pp, encoding, commit, &msg, sb);
1804 if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1805 strbuf_addch(sb, '\n');
1808 /* Skip excess blank lines at the beginning of body, if any... */
1809 msg = skip_blank_lines(msg);
1811 /* These formats treat the title line specially. */
1812 if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1813 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1815 beginning_of_body = sb->len;
1816 if (pp->fmt != CMIT_FMT_ONELINE)
1817 pp_remainder(pp, &msg, sb, indent);
1818 strbuf_rtrim(sb);
1820 /* Make sure there is an EOLN for the non-oneline case */
1821 if (pp->fmt != CMIT_FMT_ONELINE)
1822 strbuf_addch(sb, '\n');
1825 * The caller may append additional body text in e-mail
1826 * format. Make sure we did not strip the blank line
1827 * between the header and the body.
1829 if (cmit_fmt_is_mail(pp->fmt) && sb->len <= beginning_of_body)
1830 strbuf_addch(sb, '\n');
1832 unuse_commit_buffer(commit, reencoded);
1835 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1836 struct strbuf *sb)
1838 struct pretty_print_context pp = {0};
1839 pp.fmt = fmt;
1840 pretty_print_commit(&pp, commit, sb);