7 #include "string-list.h"
12 #include "reflog-walk.h"
13 #include "gpg-interface.h"
15 #include "run-command.h"
18 * The limit for formatting directives, which enable the caller to append
19 * arbitrarily many bytes to the formatted buffer. This includes padding
20 * and wrapping formatters.
22 #define FORMATTING_LIMIT (16 * 1024)
24 static char *user_format
;
25 static struct cmt_fmt_map
{
29 int expand_tabs_in_log
;
31 enum date_mode_type default_date_mode_type
;
32 const char *user_format
;
34 static size_t builtin_formats_len
;
35 static size_t commit_formats_len
;
36 static size_t commit_formats_alloc
;
37 static struct cmt_fmt_map
*find_commit_format(const char *sought
);
39 int commit_format_is_empty(enum cmit_fmt fmt
)
41 return fmt
== CMIT_FMT_USERFORMAT
&& !*user_format
;
44 static void save_user_format(struct rev_info
*rev
, const char *cp
, int is_tformat
)
47 user_format
= xstrdup(cp
);
49 rev
->use_terminator
= 1;
50 rev
->commit_format
= CMIT_FMT_USERFORMAT
;
53 static int git_pretty_formats_config(const char *var
, const char *value
, void *cb
)
55 struct cmt_fmt_map
*commit_format
= NULL
;
60 if (!skip_prefix(var
, "pretty.", &name
))
63 for (i
= 0; i
< builtin_formats_len
; i
++) {
64 if (!strcmp(commit_formats
[i
].name
, name
))
68 for (i
= builtin_formats_len
; i
< commit_formats_len
; i
++) {
69 if (!strcmp(commit_formats
[i
].name
, name
)) {
70 commit_format
= &commit_formats
[i
];
76 ALLOC_GROW(commit_formats
, commit_formats_len
+1,
77 commit_formats_alloc
);
78 commit_format
= &commit_formats
[commit_formats_len
];
79 memset(commit_format
, 0, sizeof(*commit_format
));
83 commit_format
->name
= xstrdup(name
);
84 commit_format
->format
= CMIT_FMT_USERFORMAT
;
85 if (git_config_string(&fmt
, var
, value
))
88 if (skip_prefix(fmt
, "format:", &fmt
))
89 commit_format
->is_tformat
= 0;
90 else if (skip_prefix(fmt
, "tformat:", &fmt
) || strchr(fmt
, '%'))
91 commit_format
->is_tformat
= 1;
93 commit_format
->is_alias
= 1;
94 commit_format
->user_format
= fmt
;
99 static void setup_commit_formats(void)
101 struct cmt_fmt_map builtin_formats
[] = {
102 { "raw", CMIT_FMT_RAW
, 0, 0 },
103 { "medium", CMIT_FMT_MEDIUM
, 0, 8 },
104 { "short", CMIT_FMT_SHORT
, 0, 0 },
105 { "email", CMIT_FMT_EMAIL
, 0, 0 },
106 { "mboxrd", CMIT_FMT_MBOXRD
, 0, 0 },
107 { "fuller", CMIT_FMT_FULLER
, 0, 8 },
108 { "full", CMIT_FMT_FULL
, 0, 8 },
109 { "oneline", CMIT_FMT_ONELINE
, 1, 0 },
110 { "reference", CMIT_FMT_USERFORMAT
, 1, 0,
111 0, DATE_SHORT
, "%C(auto)%h (%s, %ad)" },
113 * Please update $__git_log_pretty_formats in
114 * git-completion.bash when you add new formats.
117 commit_formats_len
= ARRAY_SIZE(builtin_formats
);
118 builtin_formats_len
= commit_formats_len
;
119 ALLOC_GROW(commit_formats
, commit_formats_len
, commit_formats_alloc
);
120 COPY_ARRAY(commit_formats
, builtin_formats
,
121 ARRAY_SIZE(builtin_formats
));
123 git_config(git_pretty_formats_config
, NULL
);
126 static struct cmt_fmt_map
*find_commit_format_recursive(const char *sought
,
127 const char *original
,
128 int num_redirections
)
130 struct cmt_fmt_map
*found
= NULL
;
131 size_t found_match_len
= 0;
134 if (num_redirections
>= commit_formats_len
)
135 die("invalid --pretty format: "
136 "'%s' references an alias which points to itself",
139 for (i
= 0; i
< commit_formats_len
; i
++) {
142 if (!starts_with(commit_formats
[i
].name
, sought
))
145 match_len
= strlen(commit_formats
[i
].name
);
146 if (found
== NULL
|| found_match_len
> match_len
) {
147 found
= &commit_formats
[i
];
148 found_match_len
= match_len
;
152 if (found
&& found
->is_alias
) {
153 found
= find_commit_format_recursive(found
->user_format
,
161 static struct cmt_fmt_map
*find_commit_format(const char *sought
)
164 setup_commit_formats();
166 return find_commit_format_recursive(sought
, sought
, 0);
169 void get_commit_format(const char *arg
, struct rev_info
*rev
)
171 struct cmt_fmt_map
*commit_format
;
173 rev
->use_terminator
= 0;
175 rev
->commit_format
= CMIT_FMT_DEFAULT
;
178 if (skip_prefix(arg
, "format:", &arg
)) {
179 save_user_format(rev
, arg
, 0);
183 if (!*arg
|| skip_prefix(arg
, "tformat:", &arg
) || strchr(arg
, '%')) {
184 save_user_format(rev
, arg
, 1);
188 commit_format
= find_commit_format(arg
);
190 die("invalid --pretty format: %s", arg
);
192 rev
->commit_format
= commit_format
->format
;
193 rev
->use_terminator
= commit_format
->is_tformat
;
194 rev
->expand_tabs_in_log_default
= commit_format
->expand_tabs_in_log
;
195 if (!rev
->date_mode_explicit
&& commit_format
->default_date_mode_type
)
196 rev
->date_mode
.type
= commit_format
->default_date_mode_type
;
197 if (commit_format
->format
== CMIT_FMT_USERFORMAT
) {
198 save_user_format(rev
, commit_format
->user_format
,
199 commit_format
->is_tformat
);
204 * Generic support for pretty-printing the header
206 static int get_one_line(const char *msg
)
221 /* High bit set, or ISO-2022-INT */
222 static int non_ascii(int ch
)
224 return !isascii(ch
) || ch
== '\033';
227 int has_non_ascii(const char *s
)
232 while ((ch
= *s
++) != '\0') {
239 static int is_rfc822_special(char ch
)
261 static int needs_rfc822_quoting(const char *s
, int len
)
264 for (i
= 0; i
< len
; i
++)
265 if (is_rfc822_special(s
[i
]))
270 static int last_line_length(struct strbuf
*sb
)
274 /* How many bytes are already used on the last line? */
275 for (i
= sb
->len
- 1; i
>= 0; i
--)
276 if (sb
->buf
[i
] == '\n')
278 return sb
->len
- (i
+ 1);
281 static void add_rfc822_quoted(struct strbuf
*out
, const char *s
, int len
)
285 /* just a guess, we may have to also backslash-quote */
286 strbuf_grow(out
, len
+ 2);
288 strbuf_addch(out
, '"');
289 for (i
= 0; i
< len
; i
++) {
293 strbuf_addch(out
, '\\');
296 strbuf_addch(out
, s
[i
]);
299 strbuf_addch(out
, '"');
307 static int is_rfc2047_special(char ch
, enum rfc2047_type type
)
310 * rfc2047, section 4.2:
312 * 8-bit values which correspond to printable ASCII characters other
313 * than "=", "?", and "_" (underscore), MAY be represented as those
314 * characters. (But see section 5 for restrictions.) In
315 * particular, SPACE and TAB MUST NOT be represented as themselves
316 * within encoded words.
320 * rule out non-ASCII characters and non-printable characters (the
321 * non-ASCII check should be redundant as isprint() is not localized
322 * and only knows about ASCII, but be defensive about that)
324 if (non_ascii(ch
) || !isprint(ch
))
328 * rule out special printable characters (' ' should be the only
329 * whitespace character considered printable, but be defensive and use
332 if (isspace(ch
) || ch
== '=' || ch
== '?' || ch
== '_')
336 * rfc2047, section 5.3:
338 * As a replacement for a 'word' entity within a 'phrase', for example,
339 * one that precedes an address in a From, To, or Cc header. The ABNF
340 * definition for 'phrase' from RFC 822 thus becomes:
342 * phrase = 1*( encoded-word / word )
344 * In this case the set of characters that may be used in a "Q"-encoded
345 * 'encoded-word' is restricted to: <upper and lower case ASCII
346 * letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
347 * (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
348 * 'phrase' MUST be separated from any adjacent 'word', 'text' or
349 * 'special' by 'linear-white-space'.
352 if (type
!= RFC2047_ADDRESS
)
355 /* '=' and '_' are special cases and have been checked above */
356 return !(isalnum(ch
) || ch
== '!' || ch
== '*' || ch
== '+' || ch
== '-' || ch
== '/');
359 static int needs_rfc2047_encoding(const char *line
, int len
)
363 for (i
= 0; i
< len
; i
++) {
365 if (non_ascii(ch
) || ch
== '\n')
367 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
374 static void add_rfc2047(struct strbuf
*sb
, const char *line
, size_t len
,
375 const char *encoding
, enum rfc2047_type type
)
377 static const int max_encoded_length
= 76; /* per rfc2047 */
379 int line_len
= last_line_length(sb
);
381 strbuf_grow(sb
, len
* 3 + strlen(encoding
) + 100);
382 strbuf_addf(sb
, "=?%s?q?", encoding
);
383 line_len
+= strlen(encoding
) + 5; /* 5 for =??q? */
387 * RFC 2047, section 5 (3):
389 * Each 'encoded-word' MUST represent an integral number of
390 * characters. A multi-octet character may not be split across
391 * adjacent 'encoded- word's.
393 const unsigned char *p
= (const unsigned char *)line
;
394 int chrlen
= mbs_chrlen(&line
, &len
, encoding
);
395 int is_special
= (chrlen
> 1) || is_rfc2047_special(*p
, type
);
397 /* "=%02X" * chrlen, or the byte itself */
398 const char *encoded_fmt
= is_special
? "=%02X" : "%c";
399 int encoded_len
= is_special
? 3 * chrlen
: 1;
402 * According to RFC 2047, we could encode the special character
403 * ' ' (space) with '_' (underscore) for readability. But many
404 * programs do not understand this and just leave the
405 * underscore in place. Thus, we do nothing special here, which
406 * causes ' ' to be encoded as '=20', avoiding this problem.
409 if (line_len
+ encoded_len
+ 2 > max_encoded_length
) {
410 /* It won't fit with trailing "?=" --- break the line */
411 strbuf_addf(sb
, "?=\n =?%s?q?", encoding
);
412 line_len
= strlen(encoding
) + 5 + 1; /* =??q? plus SP */
415 for (i
= 0; i
< chrlen
; i
++)
416 strbuf_addf(sb
, encoded_fmt
, p
[i
]);
417 line_len
+= encoded_len
;
419 strbuf_addstr(sb
, "?=");
422 const char *show_ident_date(const struct ident_split
*ident
,
423 const struct date_mode
*mode
)
425 timestamp_t date
= 0;
428 if (ident
->date_begin
&& ident
->date_end
)
429 date
= parse_timestamp(ident
->date_begin
, NULL
, 10);
430 if (date_overflows(date
))
433 if (ident
->tz_begin
&& ident
->tz_end
)
434 tz
= strtol(ident
->tz_begin
, NULL
, 10);
435 if (tz
>= INT_MAX
|| tz
<= INT_MIN
)
438 return show_date(date
, tz
, mode
);
441 static inline void strbuf_add_with_color(struct strbuf
*sb
, const char *color
,
442 const char *buf
, size_t buflen
)
444 strbuf_addstr(sb
, color
);
445 strbuf_add(sb
, buf
, buflen
);
447 strbuf_addstr(sb
, GIT_COLOR_RESET
);
450 static void append_line_with_color(struct strbuf
*sb
, struct grep_opt
*opt
,
451 const char *line
, size_t linelen
,
452 int color
, enum grep_context ctx
,
453 enum grep_header_field field
)
455 const char *buf
, *eol
, *line_color
, *match_color
;
462 if (!opt
|| !want_color(color
) || opt
->invert
)
465 line_color
= opt
->colors
[GREP_COLOR_SELECTED
];
466 match_color
= opt
->colors
[GREP_COLOR_MATCH_SELECTED
];
468 while (grep_next_match(opt
, buf
, eol
, ctx
, &match
, field
, eflags
)) {
469 if (match
.rm_so
== match
.rm_eo
)
472 strbuf_add_with_color(sb
, line_color
, buf
, match
.rm_so
);
473 strbuf_add_with_color(sb
, match_color
, buf
+ match
.rm_so
,
474 match
.rm_eo
- match
.rm_so
);
480 strbuf_add_with_color(sb
, line_color
, buf
, eol
- buf
);
483 strbuf_add(sb
, buf
, eol
- buf
);
487 void pp_user_info(struct pretty_print_context
*pp
,
488 const char *what
, struct strbuf
*sb
,
489 const char *line
, const char *encoding
)
491 struct ident_split ident
;
493 const char *mailbuf
, *namebuf
;
494 size_t namelen
, maillen
;
495 int max_length
= 78; /* per rfc2822 */
497 if (pp
->fmt
== CMIT_FMT_ONELINE
)
500 line_end
= strchrnul(line
, '\n');
501 if (split_ident_line(&ident
, line
, line_end
- line
))
504 mailbuf
= ident
.mail_begin
;
505 maillen
= ident
.mail_end
- ident
.mail_begin
;
506 namebuf
= ident
.name_begin
;
507 namelen
= ident
.name_end
- ident
.name_begin
;
510 map_user(pp
->mailmap
, &mailbuf
, &maillen
, &namebuf
, &namelen
);
512 if (cmit_fmt_is_mail(pp
->fmt
)) {
513 if (pp
->from_ident
&& ident_cmp(pp
->from_ident
, &ident
)) {
514 struct strbuf buf
= STRBUF_INIT
;
516 strbuf_addstr(&buf
, "From: ");
517 strbuf_add(&buf
, namebuf
, namelen
);
518 strbuf_addstr(&buf
, " <");
519 strbuf_add(&buf
, mailbuf
, maillen
);
520 strbuf_addstr(&buf
, ">\n");
521 string_list_append(&pp
->in_body_headers
,
522 strbuf_detach(&buf
, NULL
));
524 mailbuf
= pp
->from_ident
->mail_begin
;
525 maillen
= pp
->from_ident
->mail_end
- mailbuf
;
526 namebuf
= pp
->from_ident
->name_begin
;
527 namelen
= pp
->from_ident
->name_end
- namebuf
;
530 strbuf_addstr(sb
, "From: ");
531 if (pp
->encode_email_headers
&&
532 needs_rfc2047_encoding(namebuf
, namelen
)) {
533 add_rfc2047(sb
, namebuf
, namelen
,
534 encoding
, RFC2047_ADDRESS
);
535 max_length
= 76; /* per rfc2047 */
536 } else if (needs_rfc822_quoting(namebuf
, namelen
)) {
537 struct strbuf quoted
= STRBUF_INIT
;
538 add_rfc822_quoted("ed
, namebuf
, namelen
);
539 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
541 strbuf_release("ed
);
543 strbuf_add_wrapped_bytes(sb
, namebuf
, namelen
,
548 last_line_length(sb
) + strlen(" <") + maillen
+ strlen(">"))
549 strbuf_addch(sb
, '\n');
550 strbuf_addf(sb
, " <%.*s>\n", (int)maillen
, mailbuf
);
552 struct strbuf id
= STRBUF_INIT
;
553 enum grep_header_field field
= GREP_HEADER_FIELD_MAX
;
554 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
556 if (!strcmp(what
, "Author"))
557 field
= GREP_HEADER_AUTHOR
;
558 else if (!strcmp(what
, "Commit"))
559 field
= GREP_HEADER_COMMITTER
;
561 strbuf_addf(sb
, "%s: ", what
);
562 if (pp
->fmt
== CMIT_FMT_FULLER
)
563 strbuf_addchars(sb
, ' ', 4);
565 strbuf_addf(&id
, "%.*s <%.*s>", (int)namelen
, namebuf
,
566 (int)maillen
, mailbuf
);
568 append_line_with_color(sb
, opt
, id
.buf
, id
.len
, pp
->color
,
569 GREP_CONTEXT_HEAD
, field
);
570 strbuf_addch(sb
, '\n');
575 case CMIT_FMT_MEDIUM
:
576 strbuf_addf(sb
, "Date: %s\n",
577 show_ident_date(&ident
, &pp
->date_mode
));
580 case CMIT_FMT_MBOXRD
:
581 strbuf_addf(sb
, "Date: %s\n",
582 show_ident_date(&ident
, DATE_MODE(RFC2822
)));
584 case CMIT_FMT_FULLER
:
585 strbuf_addf(sb
, "%sDate: %s\n", what
,
586 show_ident_date(&ident
, &pp
->date_mode
));
594 static int is_blank_line(const char *line
, int *len_p
)
597 while (len
&& isspace(line
[len
- 1]))
603 const char *skip_blank_lines(const char *msg
)
606 int linelen
= get_one_line(msg
);
610 if (!is_blank_line(msg
, &ll
))
617 static void add_merge_info(const struct pretty_print_context
*pp
,
618 struct strbuf
*sb
, const struct commit
*commit
)
620 struct commit_list
*parent
= commit
->parents
;
622 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (cmit_fmt_is_mail(pp
->fmt
)) ||
623 !parent
|| !parent
->next
)
626 strbuf_addstr(sb
, "Merge:");
629 struct object_id
*oidp
= &parent
->item
->object
.oid
;
630 strbuf_addch(sb
, ' ');
632 strbuf_add_unique_abbrev(sb
, oidp
, pp
->abbrev
);
634 strbuf_addstr(sb
, oid_to_hex(oidp
));
635 parent
= parent
->next
;
637 strbuf_addch(sb
, '\n');
640 static char *get_header(const char *msg
, const char *key
)
643 const char *v
= find_commit_header(msg
, key
, &len
);
644 return v
? xmemdupz(v
, len
) : NULL
;
647 static char *replace_encoding_header(char *buf
, const char *encoding
)
649 struct strbuf tmp
= STRBUF_INIT
;
653 /* guess if there is an encoding header before a \n\n */
654 while (!starts_with(cp
, "encoding ")) {
655 cp
= strchr(cp
, '\n');
656 if (!cp
|| *++cp
== '\n')
660 cp
= strchr(cp
, '\n');
662 return buf
; /* should not happen but be defensive */
663 len
= cp
+ 1 - (buf
+ start
);
665 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
666 if (is_encoding_utf8(encoding
)) {
667 /* we have re-coded to UTF-8; drop the header */
668 strbuf_remove(&tmp
, start
, len
);
670 /* just replaces XXXX in 'encoding XXXX\n' */
671 strbuf_splice(&tmp
, start
+ strlen("encoding "),
672 len
- strlen("encoding \n"),
673 encoding
, strlen(encoding
));
675 return strbuf_detach(&tmp
, NULL
);
678 const char *repo_logmsg_reencode(struct repository
*r
,
679 const struct commit
*commit
,
680 char **commit_encoding
,
681 const char *output_encoding
)
683 static const char *utf8
= "UTF-8";
684 const char *use_encoding
;
686 const char *msg
= repo_get_commit_buffer(r
, commit
, NULL
);
689 if (!output_encoding
|| !*output_encoding
) {
691 *commit_encoding
= get_header(msg
, "encoding");
694 encoding
= get_header(msg
, "encoding");
696 *commit_encoding
= encoding
;
697 use_encoding
= encoding
? encoding
: utf8
;
698 if (same_encoding(use_encoding
, output_encoding
)) {
700 * No encoding work to be done. If we have no encoding header
701 * at all, then there's nothing to do, and we can return the
702 * message verbatim (whether newly allocated or not).
708 * Otherwise, we still want to munge the encoding header in the
709 * result, which will be done by modifying the buffer. If we
710 * are using a fresh copy, we can reuse it. But if we are using
711 * the cached copy from get_commit_buffer, we need to duplicate it
712 * to avoid munging the cached copy.
714 if (msg
== get_cached_commit_buffer(r
, commit
, NULL
))
721 * There's actual encoding work to do. Do the reencoding, which
722 * still leaves the header to be replaced in the next step. At
723 * this point, we are done with msg. If we allocated a fresh
724 * copy, we can free it.
726 out
= reencode_string(msg
, output_encoding
, use_encoding
);
728 repo_unuse_commit_buffer(r
, commit
, msg
);
732 * This replacement actually consumes the buffer we hand it, so we do
733 * not have to worry about freeing the old "out" here.
736 out
= replace_encoding_header(out
, output_encoding
);
738 if (!commit_encoding
)
741 * If the re-encoding failed, out might be NULL here; in that
742 * case we just return the commit message verbatim.
744 return out
? out
: msg
;
747 static int mailmap_name(const char **email
, size_t *email_len
,
748 const char **name
, size_t *name_len
)
750 static struct string_list
*mail_map
;
752 CALLOC_ARRAY(mail_map
, 1);
753 read_mailmap(mail_map
);
755 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
758 static size_t format_person_part(struct strbuf
*sb
, char part
,
759 const char *msg
, int len
,
760 const struct date_mode
*dmode
)
762 /* currently all placeholders have same length */
763 const int placeholder_len
= 2;
764 struct ident_split s
;
765 const char *name
, *mail
;
766 size_t maillen
, namelen
;
768 if (split_ident_line(&s
, msg
, len
) < 0)
772 namelen
= s
.name_end
- s
.name_begin
;
774 maillen
= s
.mail_end
- s
.mail_begin
;
776 if (part
== 'N' || part
== 'E' || part
== 'L') /* mailmap lookup */
777 mailmap_name(&mail
, &maillen
, &name
, &namelen
);
778 if (part
== 'n' || part
== 'N') { /* name */
779 strbuf_add(sb
, name
, namelen
);
780 return placeholder_len
;
782 if (part
== 'e' || part
== 'E') { /* email */
783 strbuf_add(sb
, mail
, maillen
);
784 return placeholder_len
;
786 if (part
== 'l' || part
== 'L') { /* local-part */
787 const char *at
= memchr(mail
, '@', maillen
);
790 strbuf_add(sb
, mail
, maillen
);
791 return placeholder_len
;
797 if (part
== 't') { /* date, UNIX timestamp */
798 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
799 return placeholder_len
;
804 strbuf_addstr(sb
, show_ident_date(&s
, dmode
));
805 return placeholder_len
;
806 case 'D': /* date, RFC2822 style */
807 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(RFC2822
)));
808 return placeholder_len
;
809 case 'r': /* date, relative */
810 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(RELATIVE
)));
811 return placeholder_len
;
812 case 'i': /* date, ISO 8601-like */
813 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(ISO8601
)));
814 return placeholder_len
;
815 case 'I': /* date, ISO 8601 strict */
816 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(ISO8601_STRICT
)));
817 return placeholder_len
;
818 case 'h': /* date, human */
819 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(HUMAN
)));
820 return placeholder_len
;
822 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(SHORT
)));
823 return placeholder_len
;
828 * reading from either a bogus commit, or a reflog entry with
829 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
830 * to compute a valid return value.
832 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
833 || part
== 'D' || part
== 'r' || part
== 'i')
834 return placeholder_len
;
836 return 0; /* unknown placeholder */
848 flush_left_and_steal
,
859 struct format_commit_context
{
860 struct repository
*repository
;
861 const struct commit
*commit
;
862 const struct pretty_print_context
*pretty_ctx
;
863 unsigned commit_header_parsed
:1;
864 unsigned commit_message_parsed
:1;
865 struct signature_check signature_check
;
866 enum flush_type flush_type
;
867 enum trunc_type truncate
;
869 char *commit_encoding
;
870 size_t width
, indent1
, indent2
;
874 /* These offsets are relative to the start of the commit message. */
876 struct chunk committer
;
881 /* The following ones are relative to the result struct strbuf. */
885 static void parse_commit_header(struct format_commit_context
*context
)
887 const char *msg
= context
->message
;
890 for (i
= 0; msg
[i
]; i
++) {
893 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
898 } else if (skip_prefix(msg
+ i
, "author ", &name
)) {
899 context
->author
.off
= name
- msg
;
900 context
->author
.len
= msg
+ eol
- name
;
901 } else if (skip_prefix(msg
+ i
, "committer ", &name
)) {
902 context
->committer
.off
= name
- msg
;
903 context
->committer
.len
= msg
+ eol
- name
;
907 context
->message_off
= i
;
908 context
->commit_header_parsed
= 1;
911 static int istitlechar(char c
)
913 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
914 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
917 void format_sanitized_subject(struct strbuf
*sb
, const char *msg
, size_t len
)
920 size_t start_len
= sb
->len
;
924 for (i
= 0; i
< len
; i
++) {
925 if (istitlechar(msg
[i
])) {
927 strbuf_addch(sb
, '-');
929 strbuf_addch(sb
, msg
[i
]);
931 while (msg
[i
+1] == '.')
937 /* trim any trailing '.' or '-' characters */
939 while (sb
->len
- trimlen
> start_len
&&
940 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
941 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
943 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
946 const char *format_subject(struct strbuf
*sb
, const char *msg
,
947 const char *line_separator
)
952 const char *line
= msg
;
953 int linelen
= get_one_line(line
);
956 if (!linelen
|| is_blank_line(line
, &linelen
))
961 strbuf_grow(sb
, linelen
+ 2);
963 strbuf_addstr(sb
, line_separator
);
964 strbuf_add(sb
, line
, linelen
);
970 static void parse_commit_message(struct format_commit_context
*c
)
972 const char *msg
= c
->message
+ c
->message_off
;
973 const char *start
= c
->message
;
975 msg
= skip_blank_lines(msg
);
976 c
->subject_off
= msg
- start
;
978 msg
= format_subject(NULL
, msg
, NULL
);
979 msg
= skip_blank_lines(msg
);
980 c
->body_off
= msg
- start
;
982 c
->commit_message_parsed
= 1;
985 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
986 size_t width
, size_t indent1
, size_t indent2
)
988 struct strbuf tmp
= STRBUF_INIT
;
991 strbuf_add(&tmp
, sb
->buf
, pos
);
992 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
993 cast_size_t_to_int(indent1
),
994 cast_size_t_to_int(indent2
),
995 cast_size_t_to_int(width
));
996 strbuf_swap(&tmp
, sb
);
997 strbuf_release(&tmp
);
1000 static void rewrap_message_tail(struct strbuf
*sb
,
1001 struct format_commit_context
*c
,
1002 size_t new_width
, size_t new_indent1
,
1005 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
1006 c
->indent2
== new_indent2
)
1008 if (c
->wrap_start
< sb
->len
)
1009 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
1010 c
->wrap_start
= sb
->len
;
1011 c
->width
= new_width
;
1012 c
->indent1
= new_indent1
;
1013 c
->indent2
= new_indent2
;
1016 static int format_reflog_person(struct strbuf
*sb
,
1018 struct reflog_walk_info
*log
,
1019 const struct date_mode
*dmode
)
1026 ident
= get_reflog_ident(log
);
1030 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
1033 static size_t parse_color(struct strbuf
*sb
, /* in UTF-8 */
1034 const char *placeholder
,
1035 struct format_commit_context
*c
)
1037 const char *rest
= placeholder
;
1038 const char *basic_color
= NULL
;
1040 if (placeholder
[1] == '(') {
1041 const char *begin
= placeholder
+ 2;
1042 const char *end
= strchr(begin
, ')');
1043 char color
[COLOR_MAXLEN
];
1048 if (skip_prefix(begin
, "auto,", &begin
)) {
1049 if (!want_color(c
->pretty_ctx
->color
))
1050 return end
- placeholder
+ 1;
1051 } else if (skip_prefix(begin
, "always,", &begin
)) {
1052 /* nothing to do; we do not respect want_color at all */
1054 /* the default is the same as "auto" */
1055 if (!want_color(c
->pretty_ctx
->color
))
1056 return end
- placeholder
+ 1;
1059 if (color_parse_mem(begin
, end
- begin
, color
) < 0)
1060 die(_("unable to parse --pretty format"));
1061 strbuf_addstr(sb
, color
);
1062 return end
- placeholder
+ 1;
1066 * We handle things like "%C(red)" above; for historical reasons, there
1067 * are a few colors that can be specified without parentheses (and
1068 * they cannot support things like "auto" or "always" at all).
1070 if (skip_prefix(placeholder
+ 1, "red", &rest
))
1071 basic_color
= GIT_COLOR_RED
;
1072 else if (skip_prefix(placeholder
+ 1, "green", &rest
))
1073 basic_color
= GIT_COLOR_GREEN
;
1074 else if (skip_prefix(placeholder
+ 1, "blue", &rest
))
1075 basic_color
= GIT_COLOR_BLUE
;
1076 else if (skip_prefix(placeholder
+ 1, "reset", &rest
))
1077 basic_color
= GIT_COLOR_RESET
;
1079 if (basic_color
&& want_color(c
->pretty_ctx
->color
))
1080 strbuf_addstr(sb
, basic_color
);
1082 return rest
- placeholder
;
1085 static size_t parse_padding_placeholder(const char *placeholder
,
1086 struct format_commit_context
*c
)
1088 const char *ch
= placeholder
;
1089 enum flush_type flush_type
;
1094 flush_type
= flush_right
;
1098 flush_type
= flush_both
;
1100 } else if (*ch
== '>') {
1101 flush_type
= flush_left_and_steal
;
1104 flush_type
= flush_left
;
1110 /* the next value means "wide enough to that column" */
1117 const char *start
= ch
+ 1;
1118 const char *end
= start
+ strcspn(start
, ",)");
1121 if (!*end
|| end
== start
)
1123 width
= strtol(start
, &next
, 10);
1126 * We need to limit the amount of padding, or otherwise this
1127 * would allow the user to pad the buffer by arbitrarily many
1128 * bytes and thus cause resource exhaustion.
1130 if (width
< -FORMATTING_LIMIT
|| width
> FORMATTING_LIMIT
)
1133 if (next
== start
|| width
== 0)
1137 width
+= term_columns();
1141 c
->padding
= to_column
? -width
: width
;
1142 c
->flush_type
= flush_type
;
1146 end
= strchr(start
, ')');
1147 if (!end
|| end
== start
)
1149 if (starts_with(start
, "trunc)"))
1150 c
->truncate
= trunc_right
;
1151 else if (starts_with(start
, "ltrunc)"))
1152 c
->truncate
= trunc_left
;
1153 else if (starts_with(start
, "mtrunc)"))
1154 c
->truncate
= trunc_middle
;
1158 c
->truncate
= trunc_none
;
1160 return end
- placeholder
+ 1;
1165 static int match_placeholder_arg_value(const char *to_parse
, const char *candidate
,
1166 const char **end
, const char **valuestart
,
1171 if (!(skip_prefix(to_parse
, candidate
, &p
)))
1175 *valuestart
= p
+ 1;
1176 *valuelen
= strcspn(*valuestart
, ",)");
1177 p
= *valuestart
+ *valuelen
;
1179 if (*p
!= ',' && *p
!= ')')
1196 static int match_placeholder_bool_arg(const char *to_parse
, const char *candidate
,
1197 const char **end
, int *val
)
1204 if (!match_placeholder_arg_value(to_parse
, candidate
, end
, &argval
, &arglen
))
1212 strval
= xstrndup(argval
, arglen
);
1213 v
= git_parse_maybe_bool(strval
);
1224 static int format_trailer_match_cb(const struct strbuf
*key
, void *ud
)
1226 const struct string_list
*list
= ud
;
1227 const struct string_list_item
*item
;
1229 for_each_string_list_item (item
, list
) {
1230 if (key
->len
== (uintptr_t)item
->util
&&
1231 !strncasecmp(item
->string
, key
->buf
, key
->len
))
1237 int format_set_trailers_options(struct process_trailer_options
*opts
,
1238 struct string_list
*filter_list
,
1239 struct strbuf
*sepbuf
,
1240 struct strbuf
*kvsepbuf
,
1251 if (match_placeholder_arg_value(*arg
, "key", arg
, &argval
, &arglen
)) {
1252 uintptr_t len
= arglen
;
1257 if (len
&& argval
[len
- 1] == ':')
1259 string_list_append(filter_list
, argval
)->util
= (char *)len
;
1261 opts
->filter
= format_trailer_match_cb
;
1262 opts
->filter_data
= filter_list
;
1263 opts
->only_trailers
= 1;
1264 } else if (match_placeholder_arg_value(*arg
, "separator", arg
, &argval
, &arglen
)) {
1267 strbuf_reset(sepbuf
);
1268 fmt
= xstrndup(argval
, arglen
);
1269 strbuf_expand(sepbuf
, fmt
, strbuf_expand_literal_cb
, NULL
);
1271 opts
->separator
= sepbuf
;
1272 } else if (match_placeholder_arg_value(*arg
, "key_value_separator", arg
, &argval
, &arglen
)) {
1275 strbuf_reset(kvsepbuf
);
1276 fmt
= xstrndup(argval
, arglen
);
1277 strbuf_expand(kvsepbuf
, fmt
, strbuf_expand_literal_cb
, NULL
);
1279 opts
->key_value_separator
= kvsepbuf
;
1280 } else if (!match_placeholder_bool_arg(*arg
, "only", arg
, &opts
->only_trailers
) &&
1281 !match_placeholder_bool_arg(*arg
, "unfold", arg
, &opts
->unfold
) &&
1282 !match_placeholder_bool_arg(*arg
, "keyonly", arg
, &opts
->key_only
) &&
1283 !match_placeholder_bool_arg(*arg
, "valueonly", arg
, &opts
->value_only
)) {
1285 size_t len
= strcspn(*arg
, ",)");
1286 *invalid_arg
= xstrndup(*arg
, len
);
1294 static size_t parse_describe_args(const char *start
, struct strvec
*args
)
1296 const char *options
[] = { "match", "exclude" };
1297 const char *arg
= start
;
1300 const char *matched
= NULL
;
1305 for (i
= 0; i
< ARRAY_SIZE(options
); i
++) {
1306 if (match_placeholder_arg_value(arg
, options
[i
], &arg
,
1307 &argval
, &arglen
)) {
1308 matched
= options
[i
];
1317 strvec_pushf(args
, "--%s=%.*s", matched
, (int)arglen
, argval
);
1322 static size_t format_commit_one(struct strbuf
*sb
, /* in UTF-8 */
1323 const char *placeholder
,
1326 struct format_commit_context
*c
= context
;
1327 const struct commit
*commit
= c
->commit
;
1328 const char *msg
= c
->message
;
1329 struct commit_list
*p
;
1330 const char *arg
, *eol
;
1334 /* these are independent of the commit */
1335 res
= strbuf_expand_literal_cb(sb
, placeholder
, NULL
);
1339 switch (placeholder
[0]) {
1341 if (starts_with(placeholder
+ 1, "(auto)")) {
1342 c
->auto_color
= want_color(c
->pretty_ctx
->color
);
1343 if (c
->auto_color
&& sb
->len
)
1344 strbuf_addstr(sb
, GIT_COLOR_RESET
);
1345 return 7; /* consumed 7 bytes, "C(auto)" */
1347 int ret
= parse_color(sb
, placeholder
, c
);
1351 * Otherwise, we decided to treat %C<unknown>
1352 * as a literal string, and the previous
1353 * %C(auto) is still valid.
1358 if (placeholder
[1] == '(') {
1359 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1361 const char *start
= placeholder
+ 2;
1362 const char *end
= strchr(start
, ')');
1366 width
= strtoul(start
, &next
, 10);
1368 indent1
= strtoul(next
+ 1, &next
, 10);
1370 indent2
= strtoul(next
+ 1,
1379 * We need to limit the format here as it allows the
1380 * user to prepend arbitrarily many bytes to the buffer
1383 if (width
> FORMATTING_LIMIT
||
1384 indent1
> FORMATTING_LIMIT
||
1385 indent2
> FORMATTING_LIMIT
)
1387 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1388 return end
- placeholder
+ 1;
1394 return parse_padding_placeholder(placeholder
, c
);
1397 if (skip_prefix(placeholder
, "(describe", &arg
)) {
1398 struct child_process cmd
= CHILD_PROCESS_INIT
;
1399 struct strbuf out
= STRBUF_INIT
;
1400 struct strbuf err
= STRBUF_INIT
;
1401 struct pretty_print_describe_status
*describe_status
;
1403 describe_status
= c
->pretty_ctx
->describe_status
;
1404 if (describe_status
) {
1405 if (!describe_status
->max_invocations
)
1407 describe_status
->max_invocations
--;
1411 strvec_push(&cmd
.args
, "describe");
1415 arg
+= parse_describe_args(arg
, &cmd
.args
);
1419 child_process_clear(&cmd
);
1423 strvec_push(&cmd
.args
, oid_to_hex(&commit
->object
.oid
));
1424 pipe_command(&cmd
, NULL
, 0, &out
, 0, &err
, 0);
1426 strbuf_addbuf(sb
, &out
);
1427 strbuf_release(&out
);
1428 strbuf_release(&err
);
1429 return arg
- placeholder
+ 1;
1432 /* these depend on the commit */
1433 if (!commit
->object
.parsed
)
1434 parse_object(the_repository
, &commit
->object
.oid
);
1436 switch (placeholder
[0]) {
1437 case 'H': /* commit hash */
1438 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1439 strbuf_addstr(sb
, oid_to_hex(&commit
->object
.oid
));
1440 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1442 case 'h': /* abbreviated commit hash */
1443 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1444 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
,
1445 c
->pretty_ctx
->abbrev
);
1446 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1448 case 'T': /* tree hash */
1449 strbuf_addstr(sb
, oid_to_hex(get_commit_tree_oid(commit
)));
1451 case 't': /* abbreviated tree hash */
1452 strbuf_add_unique_abbrev(sb
,
1453 get_commit_tree_oid(commit
),
1454 c
->pretty_ctx
->abbrev
);
1456 case 'P': /* parent hashes */
1457 for (p
= commit
->parents
; p
; p
= p
->next
) {
1458 if (p
!= commit
->parents
)
1459 strbuf_addch(sb
, ' ');
1460 strbuf_addstr(sb
, oid_to_hex(&p
->item
->object
.oid
));
1463 case 'p': /* abbreviated parent hashes */
1464 for (p
= commit
->parents
; p
; p
= p
->next
) {
1465 if (p
!= commit
->parents
)
1466 strbuf_addch(sb
, ' ');
1467 strbuf_add_unique_abbrev(sb
, &p
->item
->object
.oid
,
1468 c
->pretty_ctx
->abbrev
);
1471 case 'm': /* left/right/bottom */
1472 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1475 format_decorations(sb
, commit
, c
->auto_color
);
1478 format_decorations_extended(sb
, commit
, c
->auto_color
, "", ", ", "");
1480 case 'S': /* tag/branch like --source */
1481 if (!(c
->pretty_ctx
->rev
&& c
->pretty_ctx
->rev
->sources
))
1483 slot
= revision_sources_at(c
->pretty_ctx
->rev
->sources
, commit
);
1484 if (!(slot
&& *slot
))
1486 strbuf_addstr(sb
, *slot
);
1488 case 'g': /* reflog info */
1489 switch(placeholder
[1]) {
1490 case 'd': /* reflog selector */
1492 if (c
->pretty_ctx
->reflog_info
)
1493 get_reflog_selector(sb
,
1494 c
->pretty_ctx
->reflog_info
,
1495 &c
->pretty_ctx
->date_mode
,
1496 c
->pretty_ctx
->date_mode_explicit
,
1497 (placeholder
[1] == 'd'));
1499 case 's': /* reflog message */
1500 if (c
->pretty_ctx
->reflog_info
)
1501 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1507 return format_reflog_person(sb
,
1509 c
->pretty_ctx
->reflog_info
,
1510 &c
->pretty_ctx
->date_mode
);
1512 return 0; /* unknown %g placeholder */
1514 if (c
->pretty_ctx
->notes_message
) {
1515 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1521 if (placeholder
[0] == 'G') {
1522 if (!c
->signature_check
.result
)
1523 check_commit_signature(c
->commit
, &(c
->signature_check
));
1524 switch (placeholder
[1]) {
1526 if (c
->signature_check
.output
)
1527 strbuf_addstr(sb
, c
->signature_check
.output
);
1530 switch (c
->signature_check
.result
) {
1532 switch (c
->signature_check
.trust_level
) {
1533 case TRUST_UNDEFINED
:
1535 strbuf_addch(sb
, 'U');
1538 strbuf_addch(sb
, 'G');
1548 strbuf_addch(sb
, c
->signature_check
.result
);
1552 if (c
->signature_check
.signer
)
1553 strbuf_addstr(sb
, c
->signature_check
.signer
);
1556 if (c
->signature_check
.key
)
1557 strbuf_addstr(sb
, c
->signature_check
.key
);
1560 if (c
->signature_check
.fingerprint
)
1561 strbuf_addstr(sb
, c
->signature_check
.fingerprint
);
1564 if (c
->signature_check
.primary_key_fingerprint
)
1565 strbuf_addstr(sb
, c
->signature_check
.primary_key_fingerprint
);
1568 switch (c
->signature_check
.trust_level
) {
1569 case TRUST_UNDEFINED
:
1570 strbuf_addstr(sb
, "undefined");
1573 strbuf_addstr(sb
, "never");
1575 case TRUST_MARGINAL
:
1576 strbuf_addstr(sb
, "marginal");
1579 strbuf_addstr(sb
, "fully");
1581 case TRUST_ULTIMATE
:
1582 strbuf_addstr(sb
, "ultimate");
1592 /* For the rest we have to parse the commit header. */
1593 if (!c
->commit_header_parsed
) {
1595 repo_logmsg_reencode(c
->repository
, commit
,
1596 &c
->commit_encoding
, "UTF-8");
1597 parse_commit_header(c
);
1600 switch (placeholder
[0]) {
1601 case 'a': /* author ... */
1602 return format_person_part(sb
, placeholder
[1],
1603 msg
+ c
->author
.off
, c
->author
.len
,
1604 &c
->pretty_ctx
->date_mode
);
1605 case 'c': /* committer ... */
1606 return format_person_part(sb
, placeholder
[1],
1607 msg
+ c
->committer
.off
, c
->committer
.len
,
1608 &c
->pretty_ctx
->date_mode
);
1609 case 'e': /* encoding */
1610 if (c
->commit_encoding
)
1611 strbuf_addstr(sb
, c
->commit_encoding
);
1613 case 'B': /* raw body */
1614 /* message_off is always left at the initial newline */
1615 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1619 /* Now we need to parse the commit message. */
1620 if (!c
->commit_message_parsed
)
1621 parse_commit_message(c
);
1623 switch (placeholder
[0]) {
1624 case 's': /* subject */
1625 format_subject(sb
, msg
+ c
->subject_off
, " ");
1627 case 'f': /* sanitized subject */
1628 eol
= strchrnul(msg
+ c
->subject_off
, '\n');
1629 format_sanitized_subject(sb
, msg
+ c
->subject_off
, eol
- (msg
+ c
->subject_off
));
1631 case 'b': /* body */
1632 strbuf_addstr(sb
, msg
+ c
->body_off
);
1636 if (skip_prefix(placeholder
, "(trailers", &arg
)) {
1637 struct process_trailer_options opts
= PROCESS_TRAILER_OPTIONS_INIT
;
1638 struct string_list filter_list
= STRING_LIST_INIT_NODUP
;
1639 struct strbuf sepbuf
= STRBUF_INIT
;
1640 struct strbuf kvsepbuf
= STRBUF_INIT
;
1643 opts
.no_divider
= 1;
1647 if (format_set_trailers_options(&opts
, &filter_list
, &sepbuf
, &kvsepbuf
, &arg
, NULL
))
1651 format_trailers_from_commit(sb
, msg
+ c
->subject_off
, &opts
);
1652 ret
= arg
- placeholder
+ 1;
1655 string_list_clear(&filter_list
, 0);
1656 strbuf_release(&sepbuf
);
1660 return 0; /* unknown placeholder */
1663 static size_t format_and_pad_commit(struct strbuf
*sb
, /* in UTF-8 */
1664 const char *placeholder
,
1665 struct format_commit_context
*c
)
1667 struct strbuf local_sb
= STRBUF_INIT
;
1668 size_t total_consumed
= 0;
1669 int len
, padding
= c
->padding
;
1672 const char *start
= strrchr(sb
->buf
, '\n');
1676 occupied
= utf8_strnwidth(start
, strlen(start
), 1);
1677 occupied
+= c
->pretty_ctx
->graph_width
;
1678 padding
= (-padding
) - occupied
;
1681 int modifier
= *placeholder
== 'C';
1682 size_t consumed
= format_commit_one(&local_sb
, placeholder
, c
);
1683 total_consumed
+= consumed
;
1688 placeholder
+= consumed
;
1689 if (*placeholder
!= '%')
1694 len
= utf8_strnwidth(local_sb
.buf
, local_sb
.len
, 1);
1696 if (c
->flush_type
== flush_left_and_steal
) {
1697 const char *ch
= sb
->buf
+ sb
->len
- 1;
1698 while (len
> padding
&& ch
> sb
->buf
) {
1705 /* check for trailing ansi sequences */
1709 while (p
> sb
->buf
&& ch
- p
< 10 && *p
!= '\033')
1712 ch
+ 1 - p
!= display_mode_esc_sequence_len(p
))
1715 * got a good ansi sequence, put it back to
1716 * local_sb as we're cutting sb
1718 strbuf_insert(&local_sb
, 0, p
, ch
+ 1 - p
);
1721 strbuf_setlen(sb
, ch
+ 1 - sb
->buf
);
1722 c
->flush_type
= flush_left
;
1725 if (len
> padding
) {
1726 switch (c
->truncate
) {
1728 strbuf_utf8_replace(&local_sb
,
1729 0, len
- (padding
- 2),
1733 strbuf_utf8_replace(&local_sb
,
1735 len
- (padding
- 2),
1739 strbuf_utf8_replace(&local_sb
,
1740 padding
- 2, len
- (padding
- 2),
1746 strbuf_addbuf(sb
, &local_sb
);
1748 size_t sb_len
= sb
->len
, offset
= 0;
1749 if (c
->flush_type
== flush_left
)
1750 offset
= padding
- len
;
1751 else if (c
->flush_type
== flush_both
)
1752 offset
= (padding
- len
) / 2;
1754 * we calculate padding in columns, now
1755 * convert it back to chars
1757 padding
= padding
- len
+ local_sb
.len
;
1758 strbuf_addchars(sb
, ' ', padding
);
1759 memcpy(sb
->buf
+ sb_len
+ offset
, local_sb
.buf
,
1762 strbuf_release(&local_sb
);
1763 c
->flush_type
= no_flush
;
1764 return total_consumed
;
1767 static size_t format_commit_item(struct strbuf
*sb
, /* in UTF-8 */
1768 const char *placeholder
,
1771 size_t consumed
, orig_len
;
1774 ADD_LF_BEFORE_NON_EMPTY
,
1775 DEL_LF_BEFORE_EMPTY
,
1776 ADD_SP_BEFORE_NON_EMPTY
1779 switch (placeholder
[0]) {
1781 magic
= DEL_LF_BEFORE_EMPTY
;
1784 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1787 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1792 if (magic
!= NO_MAGIC
) {
1795 switch (placeholder
[0]) {
1798 * `%+w()` cannot ever expand to a non-empty string,
1799 * and it potentially changes the layout of preceding
1800 * contents. We're thus not able to handle the magic in
1801 * this combination and refuse the pattern.
1808 if (((struct format_commit_context
*)context
)->flush_type
!= no_flush
)
1809 consumed
= format_and_pad_commit(sb
, placeholder
, context
);
1811 consumed
= format_commit_one(sb
, placeholder
, context
);
1812 if (magic
== NO_MAGIC
)
1815 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1816 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1817 strbuf_setlen(sb
, sb
->len
- 1);
1818 } else if (orig_len
!= sb
->len
) {
1819 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1820 strbuf_insertstr(sb
, orig_len
, "\n");
1821 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1822 strbuf_insertstr(sb
, orig_len
, " ");
1824 return consumed
+ 1;
1827 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1830 struct userformat_want
*w
= context
;
1832 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1835 switch (*placeholder
) {
1850 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1852 struct strbuf dummy
= STRBUF_INIT
;
1859 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1860 strbuf_release(&dummy
);
1863 void repo_format_commit_message(struct repository
*r
,
1864 const struct commit
*commit
,
1865 const char *format
, struct strbuf
*sb
,
1866 const struct pretty_print_context
*pretty_ctx
)
1868 struct format_commit_context context
= {
1871 .pretty_ctx
= pretty_ctx
,
1872 .wrap_start
= sb
->len
1874 const char *output_enc
= pretty_ctx
->output_encoding
;
1875 const char *utf8
= "UTF-8";
1877 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1878 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1881 * Convert output to an actual output encoding; note that
1882 * format_commit_item() will always use UTF-8, so we don't
1883 * have to bother if that's what the output wants.
1886 if (same_encoding(utf8
, output_enc
))
1889 if (context
.commit_encoding
&&
1890 !same_encoding(context
.commit_encoding
, utf8
))
1891 output_enc
= context
.commit_encoding
;
1896 char *out
= reencode_string_len(sb
->buf
, sb
->len
,
1897 output_enc
, utf8
, &outsz
);
1899 strbuf_attach(sb
, out
, outsz
, outsz
+ 1);
1902 free(context
.commit_encoding
);
1903 repo_unuse_commit_buffer(r
, commit
, context
.message
);
1906 static void pp_header(struct pretty_print_context
*pp
,
1907 const char *encoding
,
1908 const struct commit
*commit
,
1912 int parents_shown
= 0;
1915 const char *name
, *line
= *msg_p
;
1916 int linelen
= get_one_line(*msg_p
);
1926 if (pp
->fmt
== CMIT_FMT_RAW
) {
1927 strbuf_add(sb
, line
, linelen
);
1931 if (starts_with(line
, "parent ")) {
1932 if (linelen
!= the_hash_algo
->hexsz
+ 8)
1933 die("bad parent line in commit");
1937 if (!parents_shown
) {
1938 unsigned num
= commit_list_count(commit
->parents
);
1939 /* with enough slop */
1940 strbuf_grow(sb
, num
* (GIT_MAX_HEXSZ
+ 10) + 20);
1941 add_merge_info(pp
, sb
, commit
);
1946 * MEDIUM == DEFAULT shows only author with dates.
1947 * FULL shows both authors but not dates.
1948 * FULLER shows both authors and dates.
1950 if (skip_prefix(line
, "author ", &name
)) {
1951 strbuf_grow(sb
, linelen
+ 80);
1952 pp_user_info(pp
, "Author", sb
, name
, encoding
);
1954 if (skip_prefix(line
, "committer ", &name
) &&
1955 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1956 strbuf_grow(sb
, linelen
+ 80);
1957 pp_user_info(pp
, "Commit", sb
, name
, encoding
);
1962 void pp_title_line(struct pretty_print_context
*pp
,
1965 const char *encoding
,
1968 static const int max_length
= 78; /* per rfc2047 */
1969 struct strbuf title
;
1971 strbuf_init(&title
, 80);
1972 *msg_p
= format_subject(&title
, *msg_p
,
1973 pp
->preserve_subject
? "\n" : " ");
1975 strbuf_grow(sb
, title
.len
+ 1024);
1976 if (pp
->print_email_subject
) {
1978 fmt_output_email_subject(sb
, pp
->rev
);
1979 if (pp
->encode_email_headers
&&
1980 needs_rfc2047_encoding(title
.buf
, title
.len
))
1981 add_rfc2047(sb
, title
.buf
, title
.len
,
1982 encoding
, RFC2047_SUBJECT
);
1984 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
1985 -last_line_length(sb
), 1, max_length
);
1987 strbuf_addbuf(sb
, &title
);
1989 strbuf_addch(sb
, '\n');
1991 if (need_8bit_cte
== 0) {
1993 for (i
= 0; i
< pp
->in_body_headers
.nr
; i
++) {
1994 if (has_non_ascii(pp
->in_body_headers
.items
[i
].string
)) {
2001 if (need_8bit_cte
> 0) {
2002 const char *header_fmt
=
2003 "MIME-Version: 1.0\n"
2004 "Content-Type: text/plain; charset=%s\n"
2005 "Content-Transfer-Encoding: 8bit\n";
2006 strbuf_addf(sb
, header_fmt
, encoding
);
2008 if (pp
->after_subject
) {
2009 strbuf_addstr(sb
, pp
->after_subject
);
2011 if (cmit_fmt_is_mail(pp
->fmt
)) {
2012 strbuf_addch(sb
, '\n');
2015 if (pp
->in_body_headers
.nr
) {
2017 for (i
= 0; i
< pp
->in_body_headers
.nr
; i
++) {
2018 strbuf_addstr(sb
, pp
->in_body_headers
.items
[i
].string
);
2019 free(pp
->in_body_headers
.items
[i
].string
);
2021 string_list_clear(&pp
->in_body_headers
, 0);
2022 strbuf_addch(sb
, '\n');
2025 strbuf_release(&title
);
2028 static int pp_utf8_width(const char *start
, const char *end
)
2031 size_t remain
= end
- start
;
2034 int n
= utf8_width(&start
, &remain
);
2035 if (n
< 0 || !start
)
2042 static void strbuf_add_tabexpand(struct strbuf
*sb
, struct grep_opt
*opt
,
2043 int color
, int tabwidth
, const char *line
,
2048 while ((tab
= memchr(line
, '\t', linelen
)) != NULL
) {
2049 int width
= pp_utf8_width(line
, tab
);
2052 * If it wasn't well-formed utf8, or it
2053 * had characters with badly defined
2054 * width (control characters etc), just
2055 * give up on trying to align things.
2060 /* Output the data .. */
2061 append_line_with_color(sb
, opt
, line
, tab
- line
, color
,
2063 GREP_HEADER_FIELD_MAX
);
2065 /* .. and the de-tabified tab */
2066 strbuf_addchars(sb
, ' ', tabwidth
- (width
% tabwidth
));
2068 /* Skip over the printed part .. */
2069 linelen
-= tab
+ 1 - line
;
2074 * Print out everything after the last tab without
2075 * worrying about width - there's nothing more to
2078 append_line_with_color(sb
, opt
, line
, linelen
, color
, GREP_CONTEXT_BODY
,
2079 GREP_HEADER_FIELD_MAX
);
2083 * pp_handle_indent() prints out the intendation, and
2084 * the whole line (without the final newline), after
2087 static void pp_handle_indent(struct pretty_print_context
*pp
,
2088 struct strbuf
*sb
, int indent
,
2089 const char *line
, int linelen
)
2091 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
2093 strbuf_addchars(sb
, ' ', indent
);
2094 if (pp
->expand_tabs_in_log
)
2095 strbuf_add_tabexpand(sb
, opt
, pp
->color
, pp
->expand_tabs_in_log
,
2098 append_line_with_color(sb
, opt
, line
, linelen
, pp
->color
,
2100 GREP_HEADER_FIELD_MAX
);
2103 static int is_mboxrd_from(const char *line
, int len
)
2106 * a line matching /^From $/ here would only have len == 4
2107 * at this point because is_empty_line would've trimmed all
2110 return len
> 4 && starts_with(line
+ strspn(line
, ">"), "From ");
2113 void pp_remainder(struct pretty_print_context
*pp
,
2118 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
2122 const char *line
= *msg_p
;
2123 int linelen
= get_one_line(line
);
2129 if (is_blank_line(line
, &linelen
)) {
2132 if (pp
->fmt
== CMIT_FMT_SHORT
)
2137 strbuf_grow(sb
, linelen
+ indent
+ 20);
2139 pp_handle_indent(pp
, sb
, indent
, line
, linelen
);
2140 else if (pp
->expand_tabs_in_log
)
2141 strbuf_add_tabexpand(sb
, opt
, pp
->color
,
2142 pp
->expand_tabs_in_log
, line
,
2145 if (pp
->fmt
== CMIT_FMT_MBOXRD
&&
2146 is_mboxrd_from(line
, linelen
))
2147 strbuf_addch(sb
, '>');
2149 append_line_with_color(sb
, opt
, line
, linelen
,
2150 pp
->color
, GREP_CONTEXT_BODY
,
2151 GREP_HEADER_FIELD_MAX
);
2153 strbuf_addch(sb
, '\n');
2157 void pretty_print_commit(struct pretty_print_context
*pp
,
2158 const struct commit
*commit
,
2161 unsigned long beginning_of_body
;
2164 const char *reencoded
;
2165 const char *encoding
;
2166 int need_8bit_cte
= pp
->need_8bit_cte
;
2168 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
2169 format_commit_message(commit
, user_format
, sb
, pp
);
2173 encoding
= get_log_output_encoding();
2174 msg
= reencoded
= logmsg_reencode(commit
, NULL
, encoding
);
2176 if (pp
->fmt
== CMIT_FMT_ONELINE
|| cmit_fmt_is_mail(pp
->fmt
))
2180 * We need to check and emit Content-type: to mark it
2181 * as 8-bit if we haven't done so.
2183 if (cmit_fmt_is_mail(pp
->fmt
) && need_8bit_cte
== 0) {
2186 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
2188 /* author could be non 7-bit ASCII but
2189 * the log may be so; skip over the
2190 * header part first.
2192 if (ch
== '\n' && msg
[i
+1] == '\n')
2195 else if (non_ascii(ch
)) {
2202 pp_header(pp
, encoding
, commit
, &msg
, sb
);
2203 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->print_email_subject
) {
2204 strbuf_addch(sb
, '\n');
2207 /* Skip excess blank lines at the beginning of body, if any... */
2208 msg
= skip_blank_lines(msg
);
2210 /* These formats treat the title line specially. */
2211 if (pp
->fmt
== CMIT_FMT_ONELINE
|| cmit_fmt_is_mail(pp
->fmt
))
2212 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
2214 beginning_of_body
= sb
->len
;
2215 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
2216 pp_remainder(pp
, &msg
, sb
, indent
);
2219 /* Make sure there is an EOLN for the non-oneline case */
2220 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
2221 strbuf_addch(sb
, '\n');
2224 * The caller may append additional body text in e-mail
2225 * format. Make sure we did not strip the blank line
2226 * between the header and the body.
2228 if (cmit_fmt_is_mail(pp
->fmt
) && sb
->len
<= beginning_of_body
)
2229 strbuf_addch(sb
, '\n');
2231 unuse_commit_buffer(commit
, reencoded
);
2234 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
2237 struct pretty_print_context pp
= {0};
2239 pretty_print_commit(&pp
, commit
, sb
);