6 #include "string-list.h"
11 #include "reflog-walk.h"
12 #include "gpg-interface.h"
14 static char *user_format;
15 static struct cmt_fmt_map {
19 int expand_tabs_in_log;
21 const char *user_format;
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)
36 user_format = xstrdup(cp);
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;
49 if (!skip_prefix(var, "pretty.", &name))
52 for (i = 0; i < builtin_formats_len; i++) {
53 if (!strcmp(commit_formats[i].name, name))
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];
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));
72 commit_format->name = xstrdup(name);
73 commit_format->format = CMIT_FMT_USERFORMAT;
74 if (git_config_string(&fmt, var, value))
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;
82 commit_format->is_alias = 1;
83 commit_format->user_format = fmt;
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;
117 if (num_redirections >= commit_formats_len)
118 die("invalid --pretty format: "
119 "'%s' references an alias which points to itself",
122 for (i = 0; i < commit_formats_len; i++) {
125 if (!starts_with(commit_formats[i].name, sought))
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,
144 static struct cmt_fmt_map *find_commit_format(const char *sought)
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;
158 rev->commit_format = CMIT_FMT_DEFAULT;
161 if (skip_prefix(arg, "format:", &arg)) {
162 save_user_format(rev, arg, 0);
166 if (!*arg || skip_prefix(arg, "tformat:", &arg) || strchr(arg, '%')) {
167 save_user_format(rev, arg, 1);
171 commit_format = find_commit_format(arg);
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)
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)
213 while ((ch = *s++) != '\0') {
220 static int is_rfc822_special(char ch)
242 static int needs_rfc822_quoting(const char *s, int len)
245 for (i = 0; i < len; i++)
246 if (is_rfc822_special(s[i]))
251 static int last_line_length(struct strbuf *sb)
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')
259 return sb->len - (i + 1);
262 static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
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++) {
274 strbuf_addch(out, '\\');
277 strbuf_addch(out, s[i]);
280 strbuf_addch(out, '"');
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))
309 * rule out special printable characters (' ' should be the only
310 * whitespace character considered printable, but be defensive and use
313 if (isspace(ch) || ch == '=' || ch == '?' || ch == '_')
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)
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)
345 for (i = 0; i < len; i++) {
347 if (non_ascii(ch) || ch == '\n')
349 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
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 */
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? */
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;
410 if (ident->date_begin && ident->date_end)
411 date = strtoul(ident->date_begin, NULL, 10);
412 if (date_overflows(date))
415 if (ident->tz_begin && ident->tz_end)
416 tz = strtol(ident->tz_begin, NULL, 10);
417 if (tz >= INT_MAX || tz <= INT_MIN)
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;
429 const char *mailbuf, *namebuf;
430 size_t namelen, maillen;
431 int max_length = 78; /* per rfc2822 */
433 if (pp->fmt == CMIT_FMT_ONELINE)
436 line_end = strchrnul(line, '\n');
437 if (split_ident_line(&ident, line, line_end - line))
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;
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("ed, namebuf, namelen);
474 strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
476 strbuf_release("ed);
478 strbuf_add_wrapped_bytes(sb, namebuf, namelen,
483 last_line_length(sb) + strlen(" <") + maillen + strlen(">"))
484 strbuf_addch(sb, '\n');
485 strbuf_addf(sb, " <%.*s>\n", (int)maillen, mailbuf);
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);
493 case CMIT_FMT_MEDIUM:
494 strbuf_addf(sb, "Date: %s\n",
495 show_ident_date(&ident, &pp->date_mode));
498 case CMIT_FMT_MBOXRD:
499 strbuf_addf(sb, "Date: %s\n",
500 show_ident_date(&ident, DATE_MODE(RFC2822)));
502 case CMIT_FMT_FULLER:
503 strbuf_addf(sb, "%sDate: %s\n", what,
504 show_ident_date(&ident, &pp->date_mode));
512 static int is_blank_line(const char *line, int *len_p)
515 while (len && isspace(line[len - 1]))
521 const char *skip_blank_lines(const char *msg)
524 int linelen = get_one_line(msg);
528 if (!is_blank_line(msg, &ll))
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)
544 strbuf_addstr(sb, "Merge:");
547 struct commit *p = parent->item;
548 const char *hex = NULL;
550 hex = find_unique_abbrev(p->object.oid.hash, pp->abbrev);
552 hex = oid_to_hex(&p->object.oid);
553 parent = parent->next;
555 strbuf_addf(sb, " %s", hex);
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. */
787 struct chunk abbrev_commit_hash;
788 struct chunk abbrev_tree_hash;
789 struct chunk abbrev_parent_hashes;
793 static int add_again(struct strbuf *sb, struct chunk *chunk)
796 strbuf_adddup(sb, chunk->off, chunk->len);
801 * We haven't seen this chunk before. Our caller is surely
802 * going to add it the hard way now. Remember the most likely
803 * start of the to-be-added chunk: the current end of the
806 chunk->off = sb->len;
810 static void parse_commit_header(struct format_commit_context *context)
812 const char *msg = context->message;
815 for (i = 0; msg[i]; i++) {
818 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
823 } else if (skip_prefix(msg + i, "author ", &name)) {
824 context->author.off = name - msg;
825 context->author.len = msg + eol - name;
826 } else if (skip_prefix(msg + i, "committer ", &name)) {
827 context->committer.off = name - msg;
828 context->committer.len = msg + eol - name;
832 context->message_off = i;
833 context->commit_header_parsed = 1;
836 static int istitlechar(char c)
838 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
839 (c >= '0' && c <= '9') || c == '.' || c == '_';
842 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
845 size_t start_len = sb->len;
848 for (; *msg && *msg != '\n'; msg++) {
849 if (istitlechar(*msg)) {
851 strbuf_addch(sb, '-');
853 strbuf_addch(sb, *msg);
855 while (*(msg+1) == '.')
861 /* trim any trailing '.' or '-' characters */
863 while (sb->len - trimlen > start_len &&
864 (sb->buf[sb->len - 1 - trimlen] == '.'
865 || sb->buf[sb->len - 1 - trimlen] == '-'))
867 strbuf_remove(sb, sb->len - trimlen, trimlen);
870 const char *format_subject(struct strbuf *sb, const char *msg,
871 const char *line_separator)
876 const char *line = msg;
877 int linelen = get_one_line(line);
880 if (!linelen || is_blank_line(line, &linelen))
885 strbuf_grow(sb, linelen + 2);
887 strbuf_addstr(sb, line_separator);
888 strbuf_add(sb, line, linelen);
894 static void parse_commit_message(struct format_commit_context *c)
896 const char *msg = c->message + c->message_off;
897 const char *start = c->message;
899 msg = skip_blank_lines(msg);
900 c->subject_off = msg - start;
902 msg = format_subject(NULL, msg, NULL);
903 msg = skip_blank_lines(msg);
904 c->body_off = msg - start;
906 c->commit_message_parsed = 1;
909 static void strbuf_wrap(struct strbuf *sb, size_t pos,
910 size_t width, size_t indent1, size_t indent2)
912 struct strbuf tmp = STRBUF_INIT;
915 strbuf_add(&tmp, sb->buf, pos);
916 strbuf_add_wrapped_text(&tmp, sb->buf + pos,
917 (int) indent1, (int) indent2, (int) width);
918 strbuf_swap(&tmp, sb);
919 strbuf_release(&tmp);
922 static void rewrap_message_tail(struct strbuf *sb,
923 struct format_commit_context *c,
924 size_t new_width, size_t new_indent1,
927 if (c->width == new_width && c->indent1 == new_indent1 &&
928 c->indent2 == new_indent2)
930 if (c->wrap_start < sb->len)
931 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
932 c->wrap_start = sb->len;
933 c->width = new_width;
934 c->indent1 = new_indent1;
935 c->indent2 = new_indent2;
938 static int format_reflog_person(struct strbuf *sb,
940 struct reflog_walk_info *log,
941 const struct date_mode *dmode)
948 ident = get_reflog_ident(log);
952 return format_person_part(sb, part, ident, strlen(ident), dmode);
955 static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
956 const char *placeholder,
957 struct format_commit_context *c)
959 const char *rest = placeholder;
961 if (placeholder[1] == '(') {
962 const char *begin = placeholder + 2;
963 const char *end = strchr(begin, ')');
964 char color[COLOR_MAXLEN];
968 if (skip_prefix(begin, "auto,", &begin)) {
969 if (!want_color(c->pretty_ctx->color))
970 return end - placeholder + 1;
972 if (color_parse_mem(begin, end - begin, color) < 0)
973 die(_("unable to parse --pretty format"));
974 strbuf_addstr(sb, color);
975 return end - placeholder + 1;
977 if (skip_prefix(placeholder + 1, "red", &rest))
978 strbuf_addstr(sb, GIT_COLOR_RED);
979 else if (skip_prefix(placeholder + 1, "green", &rest))
980 strbuf_addstr(sb, GIT_COLOR_GREEN);
981 else if (skip_prefix(placeholder + 1, "blue", &rest))
982 strbuf_addstr(sb, GIT_COLOR_BLUE);
983 else if (skip_prefix(placeholder + 1, "reset", &rest))
984 strbuf_addstr(sb, GIT_COLOR_RESET);
985 return rest - placeholder;
988 static size_t parse_padding_placeholder(struct strbuf *sb,
989 const char *placeholder,
990 struct format_commit_context *c)
992 const char *ch = placeholder;
993 enum flush_type flush_type;
998 flush_type = flush_right;
1002 flush_type = flush_both;
1004 } else if (*ch == '>') {
1005 flush_type = flush_left_and_steal;
1008 flush_type = flush_left;
1014 /* the next value means "wide enough to that column" */
1021 const char *start = ch + 1;
1022 const char *end = start + strcspn(start, ",)");
1025 if (!end || end == start)
1027 width = strtol(start, &next, 10);
1028 if (next == start || width == 0)
1032 width += term_columns();
1036 c->padding = to_column ? -width : width;
1037 c->flush_type = flush_type;
1041 end = strchr(start, ')');
1042 if (!end || end == start)
1044 if (starts_with(start, "trunc)"))
1045 c->truncate = trunc_right;
1046 else if (starts_with(start, "ltrunc)"))
1047 c->truncate = trunc_left;
1048 else if (starts_with(start, "mtrunc)"))
1049 c->truncate = trunc_middle;
1053 c->truncate = trunc_none;
1055 return end - placeholder + 1;
1060 static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
1061 const char *placeholder,
1064 struct format_commit_context *c = context;
1065 const struct commit *commit = c->commit;
1066 const char *msg = c->message;
1067 struct commit_list *p;
1070 /* these are independent of the commit */
1071 switch (placeholder[0]) {
1073 if (starts_with(placeholder + 1, "(auto)")) {
1074 c->auto_color = want_color(c->pretty_ctx->color);
1075 return 7; /* consumed 7 bytes, "C(auto)" */
1077 int ret = parse_color(sb, placeholder, c);
1081 * Otherwise, we decided to treat %C<unknown>
1082 * as a literal string, and the previous
1083 * %C(auto) is still valid.
1087 case 'n': /* newline */
1088 strbuf_addch(sb, '\n');
1091 /* %x00 == NUL, %x0a == LF, etc. */
1092 ch = hex2chr(placeholder + 1);
1095 strbuf_addch(sb, ch);
1098 if (placeholder[1] == '(') {
1099 unsigned long width = 0, indent1 = 0, indent2 = 0;
1101 const char *start = placeholder + 2;
1102 const char *end = strchr(start, ')');
1106 width = strtoul(start, &next, 10);
1108 indent1 = strtoul(next + 1, &next, 10);
1110 indent2 = strtoul(next + 1,
1117 rewrap_message_tail(sb, c, width, indent1, indent2);
1118 return end - placeholder + 1;
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));
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));
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;
1148 case 'T': /* tree hash */
1149 strbuf_addstr(sb, oid_to_hex(&commit->tree->object.oid));
1151 case 't': /* abbreviated tree hash */
1152 if (add_again(sb, &c->abbrev_tree_hash))
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;
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));
1165 case 'p': /* abbreviated parent hashes */
1166 if (add_again(sb, &c->abbrev_parent_hashes))
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;
1177 case 'm': /* left/right/bottom */
1178 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1181 load_ref_decorations(DECORATE_SHORT_REFS);
1182 format_decorations(sb, commit, c->auto_color);
1185 load_ref_decorations(DECORATE_SHORT_REFS);
1186 format_decorations_extended(sb, commit, c->auto_color, "", ", ", "");
1188 case 'g': /* reflog info */
1189 switch(placeholder[1]) {
1190 case 'd': /* reflog selector */
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'));
1199 case 's': /* reflog message */
1200 if (c->pretty_ctx->reflog_info)
1201 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1207 return format_reflog_person(sb,
1209 c->pretty_ctx->reflog_info,
1210 &c->pretty_ctx->date_mode);
1212 return 0; /* unknown %g placeholder */
1214 if (c->pretty_ctx->notes_message) {
1215 strbuf_addstr(sb, c->pretty_ctx->notes_message);
1221 if (placeholder[0] == 'G') {
1222 if (!c->signature_check.result)
1223 check_commit_signature(c->commit, &(c->signature_check));
1224 switch (placeholder[1]) {
1226 if (c->signature_check.gpg_output)
1227 strbuf_addstr(sb, c->signature_check.gpg_output);
1230 switch (c->signature_check.result) {
1235 strbuf_addch(sb, c->signature_check.result);
1239 if (c->signature_check.signer)
1240 strbuf_addstr(sb, c->signature_check.signer);
1243 if (c->signature_check.key)
1244 strbuf_addstr(sb, c->signature_check.key);
1253 /* For the rest we have to parse the commit header. */
1254 if (!c->commit_header_parsed)
1255 parse_commit_header(c);
1257 switch (placeholder[0]) {
1258 case 'a': /* author ... */
1259 return format_person_part(sb, placeholder[1],
1260 msg + c->author.off, c->author.len,
1261 &c->pretty_ctx->date_mode);
1262 case 'c': /* committer ... */
1263 return format_person_part(sb, placeholder[1],
1264 msg + c->committer.off, c->committer.len,
1265 &c->pretty_ctx->date_mode);
1266 case 'e': /* encoding */
1267 if (c->commit_encoding)
1268 strbuf_addstr(sb, c->commit_encoding);
1270 case 'B': /* raw body */
1271 /* message_off is always left at the initial newline */
1272 strbuf_addstr(sb, msg + c->message_off + 1);
1276 /* Now we need to parse the commit message. */
1277 if (!c->commit_message_parsed)
1278 parse_commit_message(c);
1280 switch (placeholder[0]) {
1281 case 's': /* subject */
1282 format_subject(sb, msg + c->subject_off, " ");
1284 case 'f': /* sanitized subject */
1285 format_sanitized_subject(sb, msg + c->subject_off);
1287 case 'b': /* body */
1288 strbuf_addstr(sb, msg + c->body_off);
1291 return 0; /* unknown placeholder */
1294 static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
1295 const char *placeholder,
1296 struct format_commit_context *c)
1298 struct strbuf local_sb = STRBUF_INIT;
1299 int total_consumed = 0, len, padding = c->padding;
1301 const char *start = strrchr(sb->buf, '\n');
1305 occupied = utf8_strnwidth(start, -1, 1);
1306 occupied += c->pretty_ctx->graph_width;
1307 padding = (-padding) - occupied;
1310 int modifier = *placeholder == 'C';
1311 int consumed = format_commit_one(&local_sb, placeholder, c);
1312 total_consumed += consumed;
1317 placeholder += consumed;
1318 if (*placeholder != '%')
1323 len = utf8_strnwidth(local_sb.buf, -1, 1);
1325 if (c->flush_type == flush_left_and_steal) {
1326 const char *ch = sb->buf + sb->len - 1;
1327 while (len > padding && ch > sb->buf) {
1334 /* check for trailing ansi sequences */
1338 while (ch - p < 10 && *p != '\033')
1341 ch + 1 - p != display_mode_esc_sequence_len(p))
1344 * got a good ansi sequence, put it back to
1345 * local_sb as we're cutting sb
1347 strbuf_insert(&local_sb, 0, p, ch + 1 - p);
1350 strbuf_setlen(sb, ch + 1 - sb->buf);
1351 c->flush_type = flush_left;
1354 if (len > padding) {
1355 switch (c->truncate) {
1357 strbuf_utf8_replace(&local_sb,
1358 0, len - (padding - 2),
1362 strbuf_utf8_replace(&local_sb,
1364 len - (padding - 2),
1368 strbuf_utf8_replace(&local_sb,
1369 padding - 2, len - (padding - 2),
1375 strbuf_addbuf(sb, &local_sb);
1377 int sb_len = sb->len, offset = 0;
1378 if (c->flush_type == flush_left)
1379 offset = padding - len;
1380 else if (c->flush_type == flush_both)
1381 offset = (padding - len) / 2;
1383 * we calculate padding in columns, now
1384 * convert it back to chars
1386 padding = padding - len + local_sb.len;
1387 strbuf_addchars(sb, ' ', padding);
1388 memcpy(sb->buf + sb_len + offset, local_sb.buf,
1391 strbuf_release(&local_sb);
1392 c->flush_type = no_flush;
1393 return total_consumed;
1396 static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
1397 const char *placeholder,
1404 ADD_LF_BEFORE_NON_EMPTY,
1405 DEL_LF_BEFORE_EMPTY,
1406 ADD_SP_BEFORE_NON_EMPTY
1409 switch (placeholder[0]) {
1411 magic = DEL_LF_BEFORE_EMPTY;
1414 magic = ADD_LF_BEFORE_NON_EMPTY;
1417 magic = ADD_SP_BEFORE_NON_EMPTY;
1422 if (magic != NO_MAGIC)
1426 if (((struct format_commit_context *)context)->flush_type != no_flush)
1427 consumed = format_and_pad_commit(sb, placeholder, context);
1429 consumed = format_commit_one(sb, placeholder, context);
1430 if (magic == NO_MAGIC)
1433 if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1434 while (sb->len && sb->buf[sb->len - 1] == '\n')
1435 strbuf_setlen(sb, sb->len - 1);
1436 } else if (orig_len != sb->len) {
1437 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1438 strbuf_insert(sb, orig_len, "\n", 1);
1439 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1440 strbuf_insert(sb, orig_len, " ", 1);
1442 return consumed + 1;
1445 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1448 struct userformat_want *w = context;
1450 if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1453 switch (*placeholder) {
1461 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1463 struct strbuf dummy = STRBUF_INIT;
1470 strbuf_expand(&dummy, fmt, userformat_want_item, w);
1471 strbuf_release(&dummy);
1474 void format_commit_message(const struct commit *commit,
1475 const char *format, struct strbuf *sb,
1476 const struct pretty_print_context *pretty_ctx)
1478 struct format_commit_context context;
1479 const char *output_enc = pretty_ctx->output_encoding;
1480 const char *utf8 = "UTF-8";
1482 memset(&context, 0, sizeof(context));
1483 context.commit = commit;
1484 context.pretty_ctx = pretty_ctx;
1485 context.wrap_start = sb->len;
1487 * convert a commit message to UTF-8 first
1488 * as far as 'format_commit_item' assumes it in UTF-8
1490 context.message = logmsg_reencode(commit,
1491 &context.commit_encoding,
1494 strbuf_expand(sb, format, format_commit_item, &context);
1495 rewrap_message_tail(sb, &context, 0, 0, 0);
1497 /* then convert a commit message to an actual output encoding */
1499 if (same_encoding(utf8, output_enc))
1502 if (context.commit_encoding &&
1503 !same_encoding(context.commit_encoding, utf8))
1504 output_enc = context.commit_encoding;
1509 char *out = reencode_string_len(sb->buf, sb->len,
1510 output_enc, utf8, &outsz);
1512 strbuf_attach(sb, out, outsz, outsz + 1);
1515 free(context.commit_encoding);
1516 unuse_commit_buffer(commit, context.message);
1519 static void pp_header(struct pretty_print_context *pp,
1520 const char *encoding,
1521 const struct commit *commit,
1525 int parents_shown = 0;
1528 const char *name, *line = *msg_p;
1529 int linelen = get_one_line(*msg_p);
1539 if (pp->fmt == CMIT_FMT_RAW) {
1540 strbuf_add(sb, line, linelen);
1544 if (starts_with(line, "parent ")) {
1546 die("bad parent line in commit");
1550 if (!parents_shown) {
1551 unsigned num = commit_list_count(commit->parents);
1552 /* with enough slop */
1553 strbuf_grow(sb, num * 50 + 20);
1554 add_merge_info(pp, sb, commit);
1559 * MEDIUM == DEFAULT shows only author with dates.
1560 * FULL shows both authors but not dates.
1561 * FULLER shows both authors and dates.
1563 if (skip_prefix(line, "author ", &name)) {
1564 strbuf_grow(sb, linelen + 80);
1565 pp_user_info(pp, "Author", sb, name, encoding);
1567 if (skip_prefix(line, "committer ", &name) &&
1568 (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1569 strbuf_grow(sb, linelen + 80);
1570 pp_user_info(pp, "Commit", sb, name, encoding);
1575 void pp_title_line(struct pretty_print_context *pp,
1578 const char *encoding,
1581 static const int max_length = 78; /* per rfc2047 */
1582 struct strbuf title;
1584 strbuf_init(&title, 80);
1585 *msg_p = format_subject(&title, *msg_p,
1586 pp->preserve_subject ? "\n" : " ");
1588 strbuf_grow(sb, title.len + 1024);
1590 strbuf_addstr(sb, pp->subject);
1591 if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
1592 add_rfc2047(sb, title.buf, title.len,
1593 encoding, RFC2047_SUBJECT);
1595 strbuf_add_wrapped_bytes(sb, title.buf, title.len,
1596 -last_line_length(sb), 1, max_length);
1598 strbuf_addbuf(sb, &title);
1600 strbuf_addch(sb, '\n');
1602 if (need_8bit_cte == 0) {
1604 for (i = 0; i < pp->in_body_headers.nr; i++) {
1605 if (has_non_ascii(pp->in_body_headers.items[i].string)) {
1612 if (need_8bit_cte > 0) {
1613 const char *header_fmt =
1614 "MIME-Version: 1.0\n"
1615 "Content-Type: text/plain; charset=%s\n"
1616 "Content-Transfer-Encoding: 8bit\n";
1617 strbuf_addf(sb, header_fmt, encoding);
1619 if (pp->after_subject) {
1620 strbuf_addstr(sb, pp->after_subject);
1622 if (cmit_fmt_is_mail(pp->fmt)) {
1623 strbuf_addch(sb, '\n');
1626 if (pp->in_body_headers.nr) {
1628 for (i = 0; i < pp->in_body_headers.nr; i++) {
1629 strbuf_addstr(sb, pp->in_body_headers.items[i].string);
1630 free(pp->in_body_headers.items[i].string);
1632 string_list_clear(&pp->in_body_headers, 0);
1633 strbuf_addch(sb, '\n');
1636 strbuf_release(&title);
1639 static int pp_utf8_width(const char *start, const char *end)
1642 size_t remain = end - start;
1645 int n = utf8_width(&start, &remain);
1646 if (n < 0 || !start)
1653 static void strbuf_add_tabexpand(struct strbuf *sb, int tabwidth,
1654 const char *line, int linelen)
1658 while ((tab = memchr(line, '\t', linelen)) != NULL) {
1659 int width = pp_utf8_width(line, tab);
1662 * If it wasn't well-formed utf8, or it
1663 * had characters with badly defined
1664 * width (control characters etc), just
1665 * give up on trying to align things.
1670 /* Output the data .. */
1671 strbuf_add(sb, line, tab - line);
1673 /* .. and the de-tabified tab */
1674 strbuf_addchars(sb, ' ', tabwidth - (width % tabwidth));
1676 /* Skip over the printed part .. */
1677 linelen -= tab + 1 - line;
1682 * Print out everything after the last tab without
1683 * worrying about width - there's nothing more to
1686 strbuf_add(sb, line, linelen);
1690 * pp_handle_indent() prints out the intendation, and
1691 * the whole line (without the final newline), after
1694 static void pp_handle_indent(struct pretty_print_context *pp,
1695 struct strbuf *sb, int indent,
1696 const char *line, int linelen)
1698 strbuf_addchars(sb, ' ', indent);
1699 if (pp->expand_tabs_in_log)
1700 strbuf_add_tabexpand(sb, pp->expand_tabs_in_log, line, linelen);
1702 strbuf_add(sb, line, linelen);
1705 static int is_mboxrd_from(const char *line, int len)
1708 * a line matching /^From $/ here would only have len == 4
1709 * at this point because is_empty_line would've trimmed all
1712 return len > 4 && starts_with(line + strspn(line, ">"), "From ");
1715 void pp_remainder(struct pretty_print_context *pp,
1722 const char *line = *msg_p;
1723 int linelen = get_one_line(line);
1729 if (is_blank_line(line, &linelen)) {
1732 if (pp->fmt == CMIT_FMT_SHORT)
1737 strbuf_grow(sb, linelen + indent + 20);
1739 pp_handle_indent(pp, sb, indent, line, linelen);
1740 else if (pp->expand_tabs_in_log)
1741 strbuf_add_tabexpand(sb, pp->expand_tabs_in_log,
1744 if (pp->fmt == CMIT_FMT_MBOXRD &&
1745 is_mboxrd_from(line, linelen))
1746 strbuf_addch(sb, '>');
1748 strbuf_add(sb, line, linelen);
1750 strbuf_addch(sb, '\n');
1754 void pretty_print_commit(struct pretty_print_context *pp,
1755 const struct commit *commit,
1758 unsigned long beginning_of_body;
1761 const char *reencoded;
1762 const char *encoding;
1763 int need_8bit_cte = pp->need_8bit_cte;
1765 if (pp->fmt == CMIT_FMT_USERFORMAT) {
1766 format_commit_message(commit, user_format, sb, pp);
1770 encoding = get_log_output_encoding();
1771 msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1773 if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1777 * We need to check and emit Content-type: to mark it
1778 * as 8-bit if we haven't done so.
1780 if (cmit_fmt_is_mail(pp->fmt) && need_8bit_cte == 0) {
1783 for (in_body = i = 0; (ch = msg[i]); i++) {
1785 /* author could be non 7-bit ASCII but
1786 * the log may be so; skip over the
1787 * header part first.
1789 if (ch == '\n' && msg[i+1] == '\n')
1792 else if (non_ascii(ch)) {
1799 pp_header(pp, encoding, commit, &msg, sb);
1800 if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1801 strbuf_addch(sb, '\n');
1804 /* Skip excess blank lines at the beginning of body, if any... */
1805 msg = skip_blank_lines(msg);
1807 /* These formats treat the title line specially. */
1808 if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1809 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1811 beginning_of_body = sb->len;
1812 if (pp->fmt != CMIT_FMT_ONELINE)
1813 pp_remainder(pp, &msg, sb, indent);
1816 /* Make sure there is an EOLN for the non-oneline case */
1817 if (pp->fmt != CMIT_FMT_ONELINE)
1818 strbuf_addch(sb, '\n');
1821 * The caller may append additional body text in e-mail
1822 * format. Make sure we did not strip the blank line
1823 * between the header and the body.
1825 if (cmit_fmt_is_mail(pp->fmt) && sb->len <= beginning_of_body)
1826 strbuf_addch(sb, '\n');
1828 unuse_commit_buffer(commit, reencoded);
1831 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1834 struct pretty_print_context pp = {0};
1836 pretty_print_commit(&pp, commit, sb);