7 #include "string-list.h"
12 #include "reflog-walk.h"
13 #include "gpg-interface.h"
16 static char *user_format;
17 static struct cmt_fmt_map {
21 int expand_tabs_in_log;
23 const char *user_format;
25 static size_t builtin_formats_len;
26 static size_t commit_formats_len;
27 static size_t commit_formats_alloc;
28 static struct cmt_fmt_map *find_commit_format(const char *sought);
30 int commit_format_is_empty(enum cmit_fmt fmt)
32 return fmt == CMIT_FMT_USERFORMAT && !*user_format;
35 static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
38 user_format = xstrdup(cp);
40 rev->use_terminator = 1;
41 rev->commit_format = CMIT_FMT_USERFORMAT;
44 static int git_pretty_formats_config(const char *var, const char *value, void *cb)
46 struct cmt_fmt_map *commit_format = NULL;
51 if (!skip_prefix(var, "pretty.", &name))
54 for (i = 0; i < builtin_formats_len; i++) {
55 if (!strcmp(commit_formats[i].name, name))
59 for (i = builtin_formats_len; i < commit_formats_len; i++) {
60 if (!strcmp(commit_formats[i].name, name)) {
61 commit_format = &commit_formats[i];
67 ALLOC_GROW(commit_formats, commit_formats_len+1,
68 commit_formats_alloc);
69 commit_format = &commit_formats[commit_formats_len];
70 memset(commit_format, 0, sizeof(*commit_format));
74 commit_format->name = xstrdup(name);
75 commit_format->format = CMIT_FMT_USERFORMAT;
76 if (git_config_string(&fmt, var, value))
79 if (skip_prefix(fmt, "format:", &fmt))
80 commit_format->is_tformat = 0;
81 else if (skip_prefix(fmt, "tformat:", &fmt) || strchr(fmt, '%'))
82 commit_format->is_tformat = 1;
84 commit_format->is_alias = 1;
85 commit_format->user_format = fmt;
90 static void setup_commit_formats(void)
92 struct cmt_fmt_map builtin_formats[] = {
93 { "raw", CMIT_FMT_RAW, 0, 0 },
94 { "medium", CMIT_FMT_MEDIUM, 0, 8 },
95 { "short", CMIT_FMT_SHORT, 0, 0 },
96 { "email", CMIT_FMT_EMAIL, 0, 0 },
97 { "mboxrd", CMIT_FMT_MBOXRD, 0, 0 },
98 { "fuller", CMIT_FMT_FULLER, 0, 8 },
99 { "full", CMIT_FMT_FULL, 0, 8 },
100 { "oneline", CMIT_FMT_ONELINE, 1, 0 }
102 commit_formats_len = ARRAY_SIZE(builtin_formats);
103 builtin_formats_len = commit_formats_len;
104 ALLOC_GROW(commit_formats, commit_formats_len, commit_formats_alloc);
105 memcpy(commit_formats, builtin_formats,
106 sizeof(*builtin_formats)*ARRAY_SIZE(builtin_formats));
108 git_config(git_pretty_formats_config, NULL);
111 static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
112 const char *original,
113 int num_redirections)
115 struct cmt_fmt_map *found = NULL;
116 size_t found_match_len = 0;
119 if (num_redirections >= commit_formats_len)
120 die("invalid --pretty format: "
121 "'%s' references an alias which points to itself",
124 for (i = 0; i < commit_formats_len; i++) {
127 if (!starts_with(commit_formats[i].name, sought))
130 match_len = strlen(commit_formats[i].name);
131 if (found == NULL || found_match_len > match_len) {
132 found = &commit_formats[i];
133 found_match_len = match_len;
137 if (found && found->is_alias) {
138 found = find_commit_format_recursive(found->user_format,
146 static struct cmt_fmt_map *find_commit_format(const char *sought)
149 setup_commit_formats();
151 return find_commit_format_recursive(sought, sought, 0);
154 void get_commit_format(const char *arg, struct rev_info *rev)
156 struct cmt_fmt_map *commit_format;
158 rev->use_terminator = 0;
160 rev->commit_format = CMIT_FMT_DEFAULT;
163 if (skip_prefix(arg, "format:", &arg)) {
164 save_user_format(rev, arg, 0);
168 if (!*arg || skip_prefix(arg, "tformat:", &arg) || strchr(arg, '%')) {
169 save_user_format(rev, arg, 1);
173 commit_format = find_commit_format(arg);
175 die("invalid --pretty format: %s", arg);
177 rev->commit_format = commit_format->format;
178 rev->use_terminator = commit_format->is_tformat;
179 rev->expand_tabs_in_log_default = commit_format->expand_tabs_in_log;
180 if (commit_format->format == CMIT_FMT_USERFORMAT) {
181 save_user_format(rev, commit_format->user_format,
182 commit_format->is_tformat);
187 * Generic support for pretty-printing the header
189 static int get_one_line(const char *msg)
204 /* High bit set, or ISO-2022-INT */
205 static int non_ascii(int ch)
207 return !isascii(ch) || ch == '\033';
210 int has_non_ascii(const char *s)
215 while ((ch = *s++) != '\0') {
222 static int is_rfc822_special(char ch)
244 static int needs_rfc822_quoting(const char *s, int len)
247 for (i = 0; i < len; i++)
248 if (is_rfc822_special(s[i]))
253 static int last_line_length(struct strbuf *sb)
257 /* How many bytes are already used on the last line? */
258 for (i = sb->len - 1; i >= 0; i--)
259 if (sb->buf[i] == '\n')
261 return sb->len - (i + 1);
264 static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
268 /* just a guess, we may have to also backslash-quote */
269 strbuf_grow(out, len + 2);
271 strbuf_addch(out, '"');
272 for (i = 0; i < len; i++) {
276 strbuf_addch(out, '\\');
279 strbuf_addch(out, s[i]);
282 strbuf_addch(out, '"');
290 static int is_rfc2047_special(char ch, enum rfc2047_type type)
293 * rfc2047, section 4.2:
295 * 8-bit values which correspond to printable ASCII characters other
296 * than "=", "?", and "_" (underscore), MAY be represented as those
297 * characters. (But see section 5 for restrictions.) In
298 * particular, SPACE and TAB MUST NOT be represented as themselves
299 * within encoded words.
303 * rule out non-ASCII characters and non-printable characters (the
304 * non-ASCII check should be redundant as isprint() is not localized
305 * and only knows about ASCII, but be defensive about that)
307 if (non_ascii(ch) || !isprint(ch))
311 * rule out special printable characters (' ' should be the only
312 * whitespace character considered printable, but be defensive and use
315 if (isspace(ch) || ch == '=' || ch == '?' || ch == '_')
319 * rfc2047, section 5.3:
321 * As a replacement for a 'word' entity within a 'phrase', for example,
322 * one that precedes an address in a From, To, or Cc header. The ABNF
323 * definition for 'phrase' from RFC 822 thus becomes:
325 * phrase = 1*( encoded-word / word )
327 * In this case the set of characters that may be used in a "Q"-encoded
328 * 'encoded-word' is restricted to: <upper and lower case ASCII
329 * letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
330 * (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
331 * 'phrase' MUST be separated from any adjacent 'word', 'text' or
332 * 'special' by 'linear-white-space'.
335 if (type != RFC2047_ADDRESS)
338 /* '=' and '_' are special cases and have been checked above */
339 return !(isalnum(ch) || ch == '!' || ch == '*' || ch == '+' || ch == '-' || ch == '/');
342 static int needs_rfc2047_encoding(const char *line, int len,
343 enum rfc2047_type type)
347 for (i = 0; i < len; i++) {
349 if (non_ascii(ch) || ch == '\n')
351 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
358 static void add_rfc2047(struct strbuf *sb, const char *line, size_t len,
359 const char *encoding, enum rfc2047_type type)
361 static const int max_encoded_length = 76; /* per rfc2047 */
363 int line_len = last_line_length(sb);
365 strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
366 strbuf_addf(sb, "=?%s?q?", encoding);
367 line_len += strlen(encoding) + 5; /* 5 for =??q? */
371 * RFC 2047, section 5 (3):
373 * Each 'encoded-word' MUST represent an integral number of
374 * characters. A multi-octet character may not be split across
375 * adjacent 'encoded- word's.
377 const unsigned char *p = (const unsigned char *)line;
378 int chrlen = mbs_chrlen(&line, &len, encoding);
379 int is_special = (chrlen > 1) || is_rfc2047_special(*p, type);
381 /* "=%02X" * chrlen, or the byte itself */
382 const char *encoded_fmt = is_special ? "=%02X" : "%c";
383 int encoded_len = is_special ? 3 * chrlen : 1;
386 * According to RFC 2047, we could encode the special character
387 * ' ' (space) with '_' (underscore) for readability. But many
388 * programs do not understand this and just leave the
389 * underscore in place. Thus, we do nothing special here, which
390 * causes ' ' to be encoded as '=20', avoiding this problem.
393 if (line_len + encoded_len + 2 > max_encoded_length) {
394 /* It won't fit with trailing "?=" --- break the line */
395 strbuf_addf(sb, "?=\n =?%s?q?", encoding);
396 line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
399 for (i = 0; i < chrlen; i++)
400 strbuf_addf(sb, encoded_fmt, p[i]);
401 line_len += encoded_len;
403 strbuf_addstr(sb, "?=");
406 const char *show_ident_date(const struct ident_split *ident,
407 const struct date_mode *mode)
409 timestamp_t date = 0;
412 if (ident->date_begin && ident->date_end)
413 date = parse_timestamp(ident->date_begin, NULL, 10);
414 if (date_overflows(date))
417 if (ident->tz_begin && ident->tz_end)
418 tz = strtol(ident->tz_begin, NULL, 10);
419 if (tz >= INT_MAX || tz <= INT_MIN)
422 return show_date(date, tz, mode);
425 void pp_user_info(struct pretty_print_context *pp,
426 const char *what, struct strbuf *sb,
427 const char *line, const char *encoding)
429 struct ident_split ident;
431 const char *mailbuf, *namebuf;
432 size_t namelen, maillen;
433 int max_length = 78; /* per rfc2822 */
435 if (pp->fmt == CMIT_FMT_ONELINE)
438 line_end = strchrnul(line, '\n');
439 if (split_ident_line(&ident, line, line_end - line))
442 mailbuf = ident.mail_begin;
443 maillen = ident.mail_end - ident.mail_begin;
444 namebuf = ident.name_begin;
445 namelen = ident.name_end - ident.name_begin;
448 map_user(pp->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
450 if (cmit_fmt_is_mail(pp->fmt)) {
451 if (pp->from_ident && ident_cmp(pp->from_ident, &ident)) {
452 struct strbuf buf = STRBUF_INIT;
454 strbuf_addstr(&buf, "From: ");
455 strbuf_add(&buf, namebuf, namelen);
456 strbuf_addstr(&buf, " <");
457 strbuf_add(&buf, mailbuf, maillen);
458 strbuf_addstr(&buf, ">\n");
459 string_list_append(&pp->in_body_headers,
460 strbuf_detach(&buf, NULL));
462 mailbuf = pp->from_ident->mail_begin;
463 maillen = pp->from_ident->mail_end - mailbuf;
464 namebuf = pp->from_ident->name_begin;
465 namelen = pp->from_ident->name_end - namebuf;
468 strbuf_addstr(sb, "From: ");
469 if (needs_rfc2047_encoding(namebuf, namelen, RFC2047_ADDRESS)) {
470 add_rfc2047(sb, namebuf, namelen,
471 encoding, RFC2047_ADDRESS);
472 max_length = 76; /* per rfc2047 */
473 } else if (needs_rfc822_quoting(namebuf, namelen)) {
474 struct strbuf quoted = STRBUF_INIT;
475 add_rfc822_quoted("ed, namebuf, namelen);
476 strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
478 strbuf_release("ed);
480 strbuf_add_wrapped_bytes(sb, namebuf, namelen,
485 last_line_length(sb) + strlen(" <") + maillen + strlen(">"))
486 strbuf_addch(sb, '\n');
487 strbuf_addf(sb, " <%.*s>\n", (int)maillen, mailbuf);
489 strbuf_addf(sb, "%s: %.*s%.*s <%.*s>\n", what,
490 (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0, " ",
491 (int)namelen, namebuf, (int)maillen, mailbuf);
495 case CMIT_FMT_MEDIUM:
496 strbuf_addf(sb, "Date: %s\n",
497 show_ident_date(&ident, &pp->date_mode));
500 case CMIT_FMT_MBOXRD:
501 strbuf_addf(sb, "Date: %s\n",
502 show_ident_date(&ident, DATE_MODE(RFC2822)));
504 case CMIT_FMT_FULLER:
505 strbuf_addf(sb, "%sDate: %s\n", what,
506 show_ident_date(&ident, &pp->date_mode));
514 static int is_blank_line(const char *line, int *len_p)
517 while (len && isspace(line[len - 1]))
523 const char *skip_blank_lines(const char *msg)
526 int linelen = get_one_line(msg);
530 if (!is_blank_line(msg, &ll))
537 static void add_merge_info(const struct pretty_print_context *pp,
538 struct strbuf *sb, const struct commit *commit)
540 struct commit_list *parent = commit->parents;
542 if ((pp->fmt == CMIT_FMT_ONELINE) || (cmit_fmt_is_mail(pp->fmt)) ||
543 !parent || !parent->next)
546 strbuf_addstr(sb, "Merge:");
549 struct object_id *oidp = &parent->item->object.oid;
550 strbuf_addch(sb, ' ');
552 strbuf_add_unique_abbrev(sb, oidp->hash, pp->abbrev);
554 strbuf_addstr(sb, oid_to_hex(oidp));
555 parent = parent->next;
557 strbuf_addch(sb, '\n');
560 static char *get_header(const char *msg, const char *key)
563 const char *v = find_commit_header(msg, key, &len);
564 return v ? xmemdupz(v, len) : NULL;
567 static char *replace_encoding_header(char *buf, const char *encoding)
569 struct strbuf tmp = STRBUF_INIT;
573 /* guess if there is an encoding header before a \n\n */
574 while (!starts_with(cp, "encoding ")) {
575 cp = strchr(cp, '\n');
576 if (!cp || *++cp == '\n')
580 cp = strchr(cp, '\n');
582 return buf; /* should not happen but be defensive */
583 len = cp + 1 - (buf + start);
585 strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
586 if (is_encoding_utf8(encoding)) {
587 /* we have re-coded to UTF-8; drop the header */
588 strbuf_remove(&tmp, start, len);
590 /* just replaces XXXX in 'encoding XXXX\n' */
591 strbuf_splice(&tmp, start + strlen("encoding "),
592 len - strlen("encoding \n"),
593 encoding, strlen(encoding));
595 return strbuf_detach(&tmp, NULL);
598 const char *logmsg_reencode(const struct commit *commit,
599 char **commit_encoding,
600 const char *output_encoding)
602 static const char *utf8 = "UTF-8";
603 const char *use_encoding;
605 const char *msg = get_commit_buffer(commit, NULL);
608 if (!output_encoding || !*output_encoding) {
610 *commit_encoding = get_header(msg, "encoding");
613 encoding = get_header(msg, "encoding");
615 *commit_encoding = encoding;
616 use_encoding = encoding ? encoding : utf8;
617 if (same_encoding(use_encoding, output_encoding)) {
619 * No encoding work to be done. If we have no encoding header
620 * at all, then there's nothing to do, and we can return the
621 * message verbatim (whether newly allocated or not).
627 * Otherwise, we still want to munge the encoding header in the
628 * result, which will be done by modifying the buffer. If we
629 * are using a fresh copy, we can reuse it. But if we are using
630 * the cached copy from get_commit_buffer, we need to duplicate it
631 * to avoid munging the cached copy.
633 if (msg == get_cached_commit_buffer(commit, NULL))
640 * There's actual encoding work to do. Do the reencoding, which
641 * still leaves the header to be replaced in the next step. At
642 * this point, we are done with msg. If we allocated a fresh
643 * copy, we can free it.
645 out = reencode_string(msg, output_encoding, use_encoding);
647 unuse_commit_buffer(commit, msg);
651 * This replacement actually consumes the buffer we hand it, so we do
652 * not have to worry about freeing the old "out" here.
655 out = replace_encoding_header(out, output_encoding);
657 if (!commit_encoding)
660 * If the re-encoding failed, out might be NULL here; in that
661 * case we just return the commit message verbatim.
663 return out ? out : msg;
666 static int mailmap_name(const char **email, size_t *email_len,
667 const char **name, size_t *name_len)
669 static struct string_list *mail_map;
671 mail_map = xcalloc(1, sizeof(*mail_map));
672 read_mailmap(mail_map, NULL);
674 return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
677 static size_t format_person_part(struct strbuf *sb, char part,
678 const char *msg, int len,
679 const struct date_mode *dmode)
681 /* currently all placeholders have same length */
682 const int placeholder_len = 2;
683 struct ident_split s;
684 const char *name, *mail;
685 size_t maillen, namelen;
687 if (split_ident_line(&s, msg, len) < 0)
691 namelen = s.name_end - s.name_begin;
693 maillen = s.mail_end - s.mail_begin;
695 if (part == 'N' || part == 'E') /* mailmap lookup */
696 mailmap_name(&mail, &maillen, &name, &namelen);
697 if (part == 'n' || part == 'N') { /* name */
698 strbuf_add(sb, name, namelen);
699 return placeholder_len;
701 if (part == 'e' || part == 'E') { /* email */
702 strbuf_add(sb, mail, maillen);
703 return placeholder_len;
709 if (part == 't') { /* date, UNIX timestamp */
710 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
711 return placeholder_len;
716 strbuf_addstr(sb, show_ident_date(&s, dmode));
717 return placeholder_len;
718 case 'D': /* date, RFC2822 style */
719 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(RFC2822)));
720 return placeholder_len;
721 case 'r': /* date, relative */
722 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(RELATIVE)));
723 return placeholder_len;
724 case 'i': /* date, ISO 8601-like */
725 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601)));
726 return placeholder_len;
727 case 'I': /* date, ISO 8601 strict */
728 strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601_STRICT)));
729 return placeholder_len;
734 * reading from either a bogus commit, or a reflog entry with
735 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
736 * to compute a valid return value.
738 if (part == 'n' || part == 'e' || part == 't' || part == 'd'
739 || part == 'D' || part == 'r' || part == 'i')
740 return placeholder_len;
742 return 0; /* unknown placeholder */
754 flush_left_and_steal,
765 struct format_commit_context {
766 const struct commit *commit;
767 const struct pretty_print_context *pretty_ctx;
768 unsigned commit_header_parsed:1;
769 unsigned commit_message_parsed:1;
770 struct signature_check signature_check;
771 enum flush_type flush_type;
772 enum trunc_type truncate;
774 char *commit_encoding;
775 size_t width, indent1, indent2;
779 /* These offsets are relative to the start of the commit message. */
781 struct chunk committer;
786 /* The following ones are relative to the result struct strbuf. */
790 static void parse_commit_header(struct format_commit_context *context)
792 const char *msg = context->message;
795 for (i = 0; msg[i]; i++) {
798 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
803 } else if (skip_prefix(msg + i, "author ", &name)) {
804 context->author.off = name - msg;
805 context->author.len = msg + eol - name;
806 } else if (skip_prefix(msg + i, "committer ", &name)) {
807 context->committer.off = name - msg;
808 context->committer.len = msg + eol - name;
812 context->message_off = i;
813 context->commit_header_parsed = 1;
816 static int istitlechar(char c)
818 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
819 (c >= '0' && c <= '9') || c == '.' || c == '_';
822 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
825 size_t start_len = sb->len;
828 for (; *msg && *msg != '\n'; msg++) {
829 if (istitlechar(*msg)) {
831 strbuf_addch(sb, '-');
833 strbuf_addch(sb, *msg);
835 while (*(msg+1) == '.')
841 /* trim any trailing '.' or '-' characters */
843 while (sb->len - trimlen > start_len &&
844 (sb->buf[sb->len - 1 - trimlen] == '.'
845 || sb->buf[sb->len - 1 - trimlen] == '-'))
847 strbuf_remove(sb, sb->len - trimlen, trimlen);
850 const char *format_subject(struct strbuf *sb, const char *msg,
851 const char *line_separator)
856 const char *line = msg;
857 int linelen = get_one_line(line);
860 if (!linelen || is_blank_line(line, &linelen))
865 strbuf_grow(sb, linelen + 2);
867 strbuf_addstr(sb, line_separator);
868 strbuf_add(sb, line, linelen);
874 static void format_trailers(struct strbuf *sb, const char *msg)
876 struct trailer_info info;
878 trailer_info_get(&info, msg);
879 strbuf_add(sb, info.trailer_start,
880 info.trailer_end - info.trailer_start);
881 trailer_info_release(&info);
884 static void parse_commit_message(struct format_commit_context *c)
886 const char *msg = c->message + c->message_off;
887 const char *start = c->message;
889 msg = skip_blank_lines(msg);
890 c->subject_off = msg - start;
892 msg = format_subject(NULL, msg, NULL);
893 msg = skip_blank_lines(msg);
894 c->body_off = msg - start;
896 c->commit_message_parsed = 1;
899 static void strbuf_wrap(struct strbuf *sb, size_t pos,
900 size_t width, size_t indent1, size_t indent2)
902 struct strbuf tmp = STRBUF_INIT;
905 strbuf_add(&tmp, sb->buf, pos);
906 strbuf_add_wrapped_text(&tmp, sb->buf + pos,
907 (int) indent1, (int) indent2, (int) width);
908 strbuf_swap(&tmp, sb);
909 strbuf_release(&tmp);
912 static void rewrap_message_tail(struct strbuf *sb,
913 struct format_commit_context *c,
914 size_t new_width, size_t new_indent1,
917 if (c->width == new_width && c->indent1 == new_indent1 &&
918 c->indent2 == new_indent2)
920 if (c->wrap_start < sb->len)
921 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
922 c->wrap_start = sb->len;
923 c->width = new_width;
924 c->indent1 = new_indent1;
925 c->indent2 = new_indent2;
928 static int format_reflog_person(struct strbuf *sb,
930 struct reflog_walk_info *log,
931 const struct date_mode *dmode)
938 ident = get_reflog_ident(log);
942 return format_person_part(sb, part, ident, strlen(ident), dmode);
945 static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
946 const char *placeholder,
947 struct format_commit_context *c)
949 const char *rest = placeholder;
951 if (placeholder[1] == '(') {
952 const char *begin = placeholder + 2;
953 const char *end = strchr(begin, ')');
954 char color[COLOR_MAXLEN];
958 if (skip_prefix(begin, "auto,", &begin)) {
959 if (!want_color(c->pretty_ctx->color))
960 return end - placeholder + 1;
962 if (color_parse_mem(begin, end - begin, color) < 0)
963 die(_("unable to parse --pretty format"));
964 strbuf_addstr(sb, color);
965 return end - placeholder + 1;
967 if (skip_prefix(placeholder + 1, "red", &rest))
968 strbuf_addstr(sb, GIT_COLOR_RED);
969 else if (skip_prefix(placeholder + 1, "green", &rest))
970 strbuf_addstr(sb, GIT_COLOR_GREEN);
971 else if (skip_prefix(placeholder + 1, "blue", &rest))
972 strbuf_addstr(sb, GIT_COLOR_BLUE);
973 else if (skip_prefix(placeholder + 1, "reset", &rest))
974 strbuf_addstr(sb, GIT_COLOR_RESET);
975 return rest - placeholder;
978 static size_t parse_padding_placeholder(struct strbuf *sb,
979 const char *placeholder,
980 struct format_commit_context *c)
982 const char *ch = placeholder;
983 enum flush_type flush_type;
988 flush_type = flush_right;
992 flush_type = flush_both;
994 } else if (*ch == '>') {
995 flush_type = flush_left_and_steal;
998 flush_type = flush_left;
1004 /* the next value means "wide enough to that column" */
1011 const char *start = ch + 1;
1012 const char *end = start + strcspn(start, ",)");
1015 if (!end || end == start)
1017 width = strtol(start, &next, 10);
1018 if (next == start || width == 0)
1022 width += term_columns();
1026 c->padding = to_column ? -width : width;
1027 c->flush_type = flush_type;
1031 end = strchr(start, ')');
1032 if (!end || end == start)
1034 if (starts_with(start, "trunc)"))
1035 c->truncate = trunc_right;
1036 else if (starts_with(start, "ltrunc)"))
1037 c->truncate = trunc_left;
1038 else if (starts_with(start, "mtrunc)"))
1039 c->truncate = trunc_middle;
1043 c->truncate = trunc_none;
1045 return end - placeholder + 1;
1050 static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
1051 const char *placeholder,
1054 struct format_commit_context *c = context;
1055 const struct commit *commit = c->commit;
1056 const char *msg = c->message;
1057 struct commit_list *p;
1060 /* these are independent of the commit */
1061 switch (placeholder[0]) {
1063 if (starts_with(placeholder + 1, "(auto)")) {
1064 c->auto_color = want_color(c->pretty_ctx->color);
1065 if (c->auto_color && sb->len)
1066 strbuf_addstr(sb, GIT_COLOR_RESET);
1067 return 7; /* consumed 7 bytes, "C(auto)" */
1069 int ret = parse_color(sb, placeholder, c);
1073 * Otherwise, we decided to treat %C<unknown>
1074 * as a literal string, and the previous
1075 * %C(auto) is still valid.
1079 case 'n': /* newline */
1080 strbuf_addch(sb, '\n');
1083 /* %x00 == NUL, %x0a == LF, etc. */
1084 ch = hex2chr(placeholder + 1);
1087 strbuf_addch(sb, ch);
1090 if (placeholder[1] == '(') {
1091 unsigned long width = 0, indent1 = 0, indent2 = 0;
1093 const char *start = placeholder + 2;
1094 const char *end = strchr(start, ')');
1098 width = strtoul(start, &next, 10);
1100 indent1 = strtoul(next + 1, &next, 10);
1102 indent2 = strtoul(next + 1,
1109 rewrap_message_tail(sb, c, width, indent1, indent2);
1110 return end - placeholder + 1;
1116 return parse_padding_placeholder(sb, placeholder, c);
1119 /* these depend on the commit */
1120 if (!commit->object.parsed)
1121 parse_object(&commit->object.oid);
1123 switch (placeholder[0]) {
1124 case 'H': /* commit hash */
1125 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1126 strbuf_addstr(sb, oid_to_hex(&commit->object.oid));
1127 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1129 case 'h': /* abbreviated commit hash */
1130 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1131 strbuf_add_unique_abbrev(sb, commit->object.oid.hash,
1132 c->pretty_ctx->abbrev);
1133 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1135 case 'T': /* tree hash */
1136 strbuf_addstr(sb, oid_to_hex(&commit->tree->object.oid));
1138 case 't': /* abbreviated tree hash */
1139 strbuf_add_unique_abbrev(sb, commit->tree->object.oid.hash,
1140 c->pretty_ctx->abbrev);
1142 case 'P': /* parent hashes */
1143 for (p = commit->parents; p; p = p->next) {
1144 if (p != commit->parents)
1145 strbuf_addch(sb, ' ');
1146 strbuf_addstr(sb, oid_to_hex(&p->item->object.oid));
1149 case 'p': /* abbreviated parent hashes */
1150 for (p = commit->parents; p; p = p->next) {
1151 if (p != commit->parents)
1152 strbuf_addch(sb, ' ');
1153 strbuf_add_unique_abbrev(sb, p->item->object.oid.hash,
1154 c->pretty_ctx->abbrev);
1157 case 'm': /* left/right/bottom */
1158 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1161 load_ref_decorations(DECORATE_SHORT_REFS);
1162 format_decorations(sb, commit, c->auto_color);
1165 load_ref_decorations(DECORATE_SHORT_REFS);
1166 format_decorations_extended(sb, commit, c->auto_color, "", ", ", "");
1168 case 'g': /* reflog info */
1169 switch(placeholder[1]) {
1170 case 'd': /* reflog selector */
1172 if (c->pretty_ctx->reflog_info)
1173 get_reflog_selector(sb,
1174 c->pretty_ctx->reflog_info,
1175 &c->pretty_ctx->date_mode,
1176 c->pretty_ctx->date_mode_explicit,
1177 (placeholder[1] == 'd'));
1179 case 's': /* reflog message */
1180 if (c->pretty_ctx->reflog_info)
1181 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1187 return format_reflog_person(sb,
1189 c->pretty_ctx->reflog_info,
1190 &c->pretty_ctx->date_mode);
1192 return 0; /* unknown %g placeholder */
1194 if (c->pretty_ctx->notes_message) {
1195 strbuf_addstr(sb, c->pretty_ctx->notes_message);
1201 if (placeholder[0] == 'G') {
1202 if (!c->signature_check.result)
1203 check_commit_signature(c->commit, &(c->signature_check));
1204 switch (placeholder[1]) {
1206 if (c->signature_check.gpg_output)
1207 strbuf_addstr(sb, c->signature_check.gpg_output);
1210 switch (c->signature_check.result) {
1219 strbuf_addch(sb, c->signature_check.result);
1223 if (c->signature_check.signer)
1224 strbuf_addstr(sb, c->signature_check.signer);
1227 if (c->signature_check.key)
1228 strbuf_addstr(sb, c->signature_check.key);
1237 /* For the rest we have to parse the commit header. */
1238 if (!c->commit_header_parsed)
1239 parse_commit_header(c);
1241 switch (placeholder[0]) {
1242 case 'a': /* author ... */
1243 return format_person_part(sb, placeholder[1],
1244 msg + c->author.off, c->author.len,
1245 &c->pretty_ctx->date_mode);
1246 case 'c': /* committer ... */
1247 return format_person_part(sb, placeholder[1],
1248 msg + c->committer.off, c->committer.len,
1249 &c->pretty_ctx->date_mode);
1250 case 'e': /* encoding */
1251 if (c->commit_encoding)
1252 strbuf_addstr(sb, c->commit_encoding);
1254 case 'B': /* raw body */
1255 /* message_off is always left at the initial newline */
1256 strbuf_addstr(sb, msg + c->message_off + 1);
1260 /* Now we need to parse the commit message. */
1261 if (!c->commit_message_parsed)
1262 parse_commit_message(c);
1264 switch (placeholder[0]) {
1265 case 's': /* subject */
1266 format_subject(sb, msg + c->subject_off, " ");
1268 case 'f': /* sanitized subject */
1269 format_sanitized_subject(sb, msg + c->subject_off);
1271 case 'b': /* body */
1272 strbuf_addstr(sb, msg + c->body_off);
1276 if (starts_with(placeholder, "(trailers)")) {
1277 format_trailers(sb, msg + c->subject_off);
1278 return strlen("(trailers)");
1281 return 0; /* unknown placeholder */
1284 static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
1285 const char *placeholder,
1286 struct format_commit_context *c)
1288 struct strbuf local_sb = STRBUF_INIT;
1289 int total_consumed = 0, len, padding = c->padding;
1291 const char *start = strrchr(sb->buf, '\n');
1295 occupied = utf8_strnwidth(start, -1, 1);
1296 occupied += c->pretty_ctx->graph_width;
1297 padding = (-padding) - occupied;
1300 int modifier = *placeholder == 'C';
1301 int consumed = format_commit_one(&local_sb, placeholder, c);
1302 total_consumed += consumed;
1307 placeholder += consumed;
1308 if (*placeholder != '%')
1313 len = utf8_strnwidth(local_sb.buf, -1, 1);
1315 if (c->flush_type == flush_left_and_steal) {
1316 const char *ch = sb->buf + sb->len - 1;
1317 while (len > padding && ch > sb->buf) {
1324 /* check for trailing ansi sequences */
1328 while (ch - p < 10 && *p != '\033')
1331 ch + 1 - p != display_mode_esc_sequence_len(p))
1334 * got a good ansi sequence, put it back to
1335 * local_sb as we're cutting sb
1337 strbuf_insert(&local_sb, 0, p, ch + 1 - p);
1340 strbuf_setlen(sb, ch + 1 - sb->buf);
1341 c->flush_type = flush_left;
1344 if (len > padding) {
1345 switch (c->truncate) {
1347 strbuf_utf8_replace(&local_sb,
1348 0, len - (padding - 2),
1352 strbuf_utf8_replace(&local_sb,
1354 len - (padding - 2),
1358 strbuf_utf8_replace(&local_sb,
1359 padding - 2, len - (padding - 2),
1365 strbuf_addbuf(sb, &local_sb);
1367 int sb_len = sb->len, offset = 0;
1368 if (c->flush_type == flush_left)
1369 offset = padding - len;
1370 else if (c->flush_type == flush_both)
1371 offset = (padding - len) / 2;
1373 * we calculate padding in columns, now
1374 * convert it back to chars
1376 padding = padding - len + local_sb.len;
1377 strbuf_addchars(sb, ' ', padding);
1378 memcpy(sb->buf + sb_len + offset, local_sb.buf,
1381 strbuf_release(&local_sb);
1382 c->flush_type = no_flush;
1383 return total_consumed;
1386 static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
1387 const char *placeholder,
1394 ADD_LF_BEFORE_NON_EMPTY,
1395 DEL_LF_BEFORE_EMPTY,
1396 ADD_SP_BEFORE_NON_EMPTY
1399 switch (placeholder[0]) {
1401 magic = DEL_LF_BEFORE_EMPTY;
1404 magic = ADD_LF_BEFORE_NON_EMPTY;
1407 magic = ADD_SP_BEFORE_NON_EMPTY;
1412 if (magic != NO_MAGIC)
1416 if (((struct format_commit_context *)context)->flush_type != no_flush)
1417 consumed = format_and_pad_commit(sb, placeholder, context);
1419 consumed = format_commit_one(sb, placeholder, context);
1420 if (magic == NO_MAGIC)
1423 if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1424 while (sb->len && sb->buf[sb->len - 1] == '\n')
1425 strbuf_setlen(sb, sb->len - 1);
1426 } else if (orig_len != sb->len) {
1427 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1428 strbuf_insert(sb, orig_len, "\n", 1);
1429 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1430 strbuf_insert(sb, orig_len, " ", 1);
1432 return consumed + 1;
1435 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1438 struct userformat_want *w = context;
1440 if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1443 switch (*placeholder) {
1451 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1453 struct strbuf dummy = STRBUF_INIT;
1460 strbuf_expand(&dummy, fmt, userformat_want_item, w);
1461 strbuf_release(&dummy);
1464 void format_commit_message(const struct commit *commit,
1465 const char *format, struct strbuf *sb,
1466 const struct pretty_print_context *pretty_ctx)
1468 struct format_commit_context context;
1469 const char *output_enc = pretty_ctx->output_encoding;
1470 const char *utf8 = "UTF-8";
1472 memset(&context, 0, sizeof(context));
1473 context.commit = commit;
1474 context.pretty_ctx = pretty_ctx;
1475 context.wrap_start = sb->len;
1477 * convert a commit message to UTF-8 first
1478 * as far as 'format_commit_item' assumes it in UTF-8
1480 context.message = logmsg_reencode(commit,
1481 &context.commit_encoding,
1484 strbuf_expand(sb, format, format_commit_item, &context);
1485 rewrap_message_tail(sb, &context, 0, 0, 0);
1487 /* then convert a commit message to an actual output encoding */
1489 if (same_encoding(utf8, output_enc))
1492 if (context.commit_encoding &&
1493 !same_encoding(context.commit_encoding, utf8))
1494 output_enc = context.commit_encoding;
1499 char *out = reencode_string_len(sb->buf, sb->len,
1500 output_enc, utf8, &outsz);
1502 strbuf_attach(sb, out, outsz, outsz + 1);
1505 free(context.commit_encoding);
1506 unuse_commit_buffer(commit, context.message);
1509 static void pp_header(struct pretty_print_context *pp,
1510 const char *encoding,
1511 const struct commit *commit,
1515 int parents_shown = 0;
1518 const char *name, *line = *msg_p;
1519 int linelen = get_one_line(*msg_p);
1529 if (pp->fmt == CMIT_FMT_RAW) {
1530 strbuf_add(sb, line, linelen);
1534 if (starts_with(line, "parent ")) {
1536 die("bad parent line in commit");
1540 if (!parents_shown) {
1541 unsigned num = commit_list_count(commit->parents);
1542 /* with enough slop */
1543 strbuf_grow(sb, num * 50 + 20);
1544 add_merge_info(pp, sb, commit);
1549 * MEDIUM == DEFAULT shows only author with dates.
1550 * FULL shows both authors but not dates.
1551 * FULLER shows both authors and dates.
1553 if (skip_prefix(line, "author ", &name)) {
1554 strbuf_grow(sb, linelen + 80);
1555 pp_user_info(pp, "Author", sb, name, encoding);
1557 if (skip_prefix(line, "committer ", &name) &&
1558 (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1559 strbuf_grow(sb, linelen + 80);
1560 pp_user_info(pp, "Commit", sb, name, encoding);
1565 void pp_title_line(struct pretty_print_context *pp,
1568 const char *encoding,
1571 static const int max_length = 78; /* per rfc2047 */
1572 struct strbuf title;
1574 strbuf_init(&title, 80);
1575 *msg_p = format_subject(&title, *msg_p,
1576 pp->preserve_subject ? "\n" : " ");
1578 strbuf_grow(sb, title.len + 1024);
1579 if (pp->print_email_subject) {
1581 fmt_output_email_subject(sb, pp->rev);
1582 if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
1583 add_rfc2047(sb, title.buf, title.len,
1584 encoding, RFC2047_SUBJECT);
1586 strbuf_add_wrapped_bytes(sb, title.buf, title.len,
1587 -last_line_length(sb), 1, max_length);
1589 strbuf_addbuf(sb, &title);
1591 strbuf_addch(sb, '\n');
1593 if (need_8bit_cte == 0) {
1595 for (i = 0; i < pp->in_body_headers.nr; i++) {
1596 if (has_non_ascii(pp->in_body_headers.items[i].string)) {
1603 if (need_8bit_cte > 0) {
1604 const char *header_fmt =
1605 "MIME-Version: 1.0\n"
1606 "Content-Type: text/plain; charset=%s\n"
1607 "Content-Transfer-Encoding: 8bit\n";
1608 strbuf_addf(sb, header_fmt, encoding);
1610 if (pp->after_subject) {
1611 strbuf_addstr(sb, pp->after_subject);
1613 if (cmit_fmt_is_mail(pp->fmt)) {
1614 strbuf_addch(sb, '\n');
1617 if (pp->in_body_headers.nr) {
1619 for (i = 0; i < pp->in_body_headers.nr; i++) {
1620 strbuf_addstr(sb, pp->in_body_headers.items[i].string);
1621 free(pp->in_body_headers.items[i].string);
1623 string_list_clear(&pp->in_body_headers, 0);
1624 strbuf_addch(sb, '\n');
1627 strbuf_release(&title);
1630 static int pp_utf8_width(const char *start, const char *end)
1633 size_t remain = end - start;
1636 int n = utf8_width(&start, &remain);
1637 if (n < 0 || !start)
1644 static void strbuf_add_tabexpand(struct strbuf *sb, int tabwidth,
1645 const char *line, int linelen)
1649 while ((tab = memchr(line, '\t', linelen)) != NULL) {
1650 int width = pp_utf8_width(line, tab);
1653 * If it wasn't well-formed utf8, or it
1654 * had characters with badly defined
1655 * width (control characters etc), just
1656 * give up on trying to align things.
1661 /* Output the data .. */
1662 strbuf_add(sb, line, tab - line);
1664 /* .. and the de-tabified tab */
1665 strbuf_addchars(sb, ' ', tabwidth - (width % tabwidth));
1667 /* Skip over the printed part .. */
1668 linelen -= tab + 1 - line;
1673 * Print out everything after the last tab without
1674 * worrying about width - there's nothing more to
1677 strbuf_add(sb, line, linelen);
1681 * pp_handle_indent() prints out the intendation, and
1682 * the whole line (without the final newline), after
1685 static void pp_handle_indent(struct pretty_print_context *pp,
1686 struct strbuf *sb, int indent,
1687 const char *line, int linelen)
1689 strbuf_addchars(sb, ' ', indent);
1690 if (pp->expand_tabs_in_log)
1691 strbuf_add_tabexpand(sb, pp->expand_tabs_in_log, line, linelen);
1693 strbuf_add(sb, line, linelen);
1696 static int is_mboxrd_from(const char *line, int len)
1699 * a line matching /^From $/ here would only have len == 4
1700 * at this point because is_empty_line would've trimmed all
1703 return len > 4 && starts_with(line + strspn(line, ">"), "From ");
1706 void pp_remainder(struct pretty_print_context *pp,
1713 const char *line = *msg_p;
1714 int linelen = get_one_line(line);
1720 if (is_blank_line(line, &linelen)) {
1723 if (pp->fmt == CMIT_FMT_SHORT)
1728 strbuf_grow(sb, linelen + indent + 20);
1730 pp_handle_indent(pp, sb, indent, line, linelen);
1731 else if (pp->expand_tabs_in_log)
1732 strbuf_add_tabexpand(sb, pp->expand_tabs_in_log,
1735 if (pp->fmt == CMIT_FMT_MBOXRD &&
1736 is_mboxrd_from(line, linelen))
1737 strbuf_addch(sb, '>');
1739 strbuf_add(sb, line, linelen);
1741 strbuf_addch(sb, '\n');
1745 void pretty_print_commit(struct pretty_print_context *pp,
1746 const struct commit *commit,
1749 unsigned long beginning_of_body;
1752 const char *reencoded;
1753 const char *encoding;
1754 int need_8bit_cte = pp->need_8bit_cte;
1756 if (pp->fmt == CMIT_FMT_USERFORMAT) {
1757 format_commit_message(commit, user_format, sb, pp);
1761 encoding = get_log_output_encoding();
1762 msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1764 if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1768 * We need to check and emit Content-type: to mark it
1769 * as 8-bit if we haven't done so.
1771 if (cmit_fmt_is_mail(pp->fmt) && need_8bit_cte == 0) {
1774 for (in_body = i = 0; (ch = msg[i]); i++) {
1776 /* author could be non 7-bit ASCII but
1777 * the log may be so; skip over the
1778 * header part first.
1780 if (ch == '\n' && msg[i+1] == '\n')
1783 else if (non_ascii(ch)) {
1790 pp_header(pp, encoding, commit, &msg, sb);
1791 if (pp->fmt != CMIT_FMT_ONELINE && !pp->print_email_subject) {
1792 strbuf_addch(sb, '\n');
1795 /* Skip excess blank lines at the beginning of body, if any... */
1796 msg = skip_blank_lines(msg);
1798 /* These formats treat the title line specially. */
1799 if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1800 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1802 beginning_of_body = sb->len;
1803 if (pp->fmt != CMIT_FMT_ONELINE)
1804 pp_remainder(pp, &msg, sb, indent);
1807 /* Make sure there is an EOLN for the non-oneline case */
1808 if (pp->fmt != CMIT_FMT_ONELINE)
1809 strbuf_addch(sb, '\n');
1812 * The caller may append additional body text in e-mail
1813 * format. Make sure we did not strip the blank line
1814 * between the header and the body.
1816 if (cmit_fmt_is_mail(pp->fmt) && sb->len <= beginning_of_body)
1817 strbuf_addch(sb, '\n');
1819 unuse_commit_buffer(commit, reencoded);
1822 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1825 struct pretty_print_context pp = {0};
1827 pretty_print_commit(&pp, commit, sb);