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
,
56 struct cmt_fmt_map
*commit_format
= NULL
;
61 if (!skip_prefix(var
, "pretty.", &name
))
64 for (i
= 0; i
< builtin_formats_len
; i
++) {
65 if (!strcmp(commit_formats
[i
].name
, name
))
69 for (i
= builtin_formats_len
; i
< commit_formats_len
; i
++) {
70 if (!strcmp(commit_formats
[i
].name
, name
)) {
71 commit_format
= &commit_formats
[i
];
77 ALLOC_GROW(commit_formats
, commit_formats_len
+1,
78 commit_formats_alloc
);
79 commit_format
= &commit_formats
[commit_formats_len
];
80 memset(commit_format
, 0, sizeof(*commit_format
));
84 commit_format
->name
= xstrdup(name
);
85 commit_format
->format
= CMIT_FMT_USERFORMAT
;
86 if (git_config_string(&fmt
, var
, value
))
89 if (skip_prefix(fmt
, "format:", &fmt
))
90 commit_format
->is_tformat
= 0;
91 else if (skip_prefix(fmt
, "tformat:", &fmt
) || strchr(fmt
, '%'))
92 commit_format
->is_tformat
= 1;
94 commit_format
->is_alias
= 1;
95 commit_format
->user_format
= fmt
;
100 static void setup_commit_formats(void)
102 struct cmt_fmt_map builtin_formats
[] = {
103 { "raw", CMIT_FMT_RAW
, 0, 0 },
104 { "medium", CMIT_FMT_MEDIUM
, 0, 8 },
105 { "short", CMIT_FMT_SHORT
, 0, 0 },
106 { "email", CMIT_FMT_EMAIL
, 0, 0 },
107 { "mboxrd", CMIT_FMT_MBOXRD
, 0, 0 },
108 { "fuller", CMIT_FMT_FULLER
, 0, 8 },
109 { "full", CMIT_FMT_FULL
, 0, 8 },
110 { "oneline", CMIT_FMT_ONELINE
, 1, 0 },
111 { "reference", CMIT_FMT_USERFORMAT
, 1, 0,
112 0, DATE_SHORT
, "%C(auto)%h (%s, %ad)" },
114 * Please update $__git_log_pretty_formats in
115 * git-completion.bash when you add new formats.
118 commit_formats_len
= ARRAY_SIZE(builtin_formats
);
119 builtin_formats_len
= commit_formats_len
;
120 ALLOC_GROW(commit_formats
, commit_formats_len
, commit_formats_alloc
);
121 COPY_ARRAY(commit_formats
, builtin_formats
,
122 ARRAY_SIZE(builtin_formats
));
124 git_config(git_pretty_formats_config
, NULL
);
127 static struct cmt_fmt_map
*find_commit_format_recursive(const char *sought
,
128 const char *original
,
129 int num_redirections
)
131 struct cmt_fmt_map
*found
= NULL
;
132 size_t found_match_len
= 0;
135 if (num_redirections
>= commit_formats_len
)
136 die("invalid --pretty format: "
137 "'%s' references an alias which points to itself",
140 for (i
= 0; i
< commit_formats_len
; i
++) {
143 if (!starts_with(commit_formats
[i
].name
, sought
))
146 match_len
= strlen(commit_formats
[i
].name
);
147 if (found
== NULL
|| found_match_len
> match_len
) {
148 found
= &commit_formats
[i
];
149 found_match_len
= match_len
;
153 if (found
&& found
->is_alias
) {
154 found
= find_commit_format_recursive(found
->user_format
,
162 static struct cmt_fmt_map
*find_commit_format(const char *sought
)
165 setup_commit_formats();
167 return find_commit_format_recursive(sought
, sought
, 0);
170 void get_commit_format(const char *arg
, struct rev_info
*rev
)
172 struct cmt_fmt_map
*commit_format
;
174 rev
->use_terminator
= 0;
176 rev
->commit_format
= CMIT_FMT_DEFAULT
;
179 if (skip_prefix(arg
, "format:", &arg
)) {
180 save_user_format(rev
, arg
, 0);
184 if (!*arg
|| skip_prefix(arg
, "tformat:", &arg
) || strchr(arg
, '%')) {
185 save_user_format(rev
, arg
, 1);
189 commit_format
= find_commit_format(arg
);
191 die("invalid --pretty format: %s", arg
);
193 rev
->commit_format
= commit_format
->format
;
194 rev
->use_terminator
= commit_format
->is_tformat
;
195 rev
->expand_tabs_in_log_default
= commit_format
->expand_tabs_in_log
;
196 if (!rev
->date_mode_explicit
&& commit_format
->default_date_mode_type
)
197 rev
->date_mode
.type
= commit_format
->default_date_mode_type
;
198 if (commit_format
->format
== CMIT_FMT_USERFORMAT
) {
199 save_user_format(rev
, commit_format
->user_format
,
200 commit_format
->is_tformat
);
205 * Generic support for pretty-printing the header
207 static int get_one_line(const char *msg
)
222 /* High bit set, or ISO-2022-INT */
223 static int non_ascii(int ch
)
225 return !isascii(ch
) || ch
== '\033';
228 int has_non_ascii(const char *s
)
233 while ((ch
= *s
++) != '\0') {
240 static int is_rfc822_special(char ch
)
262 static int needs_rfc822_quoting(const char *s
, int len
)
265 for (i
= 0; i
< len
; i
++)
266 if (is_rfc822_special(s
[i
]))
271 static int last_line_length(struct strbuf
*sb
)
275 /* How many bytes are already used on the last line? */
276 for (i
= sb
->len
- 1; i
>= 0; i
--)
277 if (sb
->buf
[i
] == '\n')
279 return sb
->len
- (i
+ 1);
282 static void add_rfc822_quoted(struct strbuf
*out
, const char *s
, int len
)
286 /* just a guess, we may have to also backslash-quote */
287 strbuf_grow(out
, len
+ 2);
289 strbuf_addch(out
, '"');
290 for (i
= 0; i
< len
; i
++) {
294 strbuf_addch(out
, '\\');
297 strbuf_addch(out
, s
[i
]);
300 strbuf_addch(out
, '"');
308 static int is_rfc2047_special(char ch
, enum rfc2047_type type
)
311 * rfc2047, section 4.2:
313 * 8-bit values which correspond to printable ASCII characters other
314 * than "=", "?", and "_" (underscore), MAY be represented as those
315 * characters. (But see section 5 for restrictions.) In
316 * particular, SPACE and TAB MUST NOT be represented as themselves
317 * within encoded words.
321 * rule out non-ASCII characters and non-printable characters (the
322 * non-ASCII check should be redundant as isprint() is not localized
323 * and only knows about ASCII, but be defensive about that)
325 if (non_ascii(ch
) || !isprint(ch
))
329 * rule out special printable characters (' ' should be the only
330 * whitespace character considered printable, but be defensive and use
333 if (isspace(ch
) || ch
== '=' || ch
== '?' || ch
== '_')
337 * rfc2047, section 5.3:
339 * As a replacement for a 'word' entity within a 'phrase', for example,
340 * one that precedes an address in a From, To, or Cc header. The ABNF
341 * definition for 'phrase' from RFC 822 thus becomes:
343 * phrase = 1*( encoded-word / word )
345 * In this case the set of characters that may be used in a "Q"-encoded
346 * 'encoded-word' is restricted to: <upper and lower case ASCII
347 * letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
348 * (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
349 * 'phrase' MUST be separated from any adjacent 'word', 'text' or
350 * 'special' by 'linear-white-space'.
353 if (type
!= RFC2047_ADDRESS
)
356 /* '=' and '_' are special cases and have been checked above */
357 return !(isalnum(ch
) || ch
== '!' || ch
== '*' || ch
== '+' || ch
== '-' || ch
== '/');
360 static int needs_rfc2047_encoding(const char *line
, int len
)
364 for (i
= 0; i
< len
; i
++) {
366 if (non_ascii(ch
) || ch
== '\n')
368 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
375 static void add_rfc2047(struct strbuf
*sb
, const char *line
, size_t len
,
376 const char *encoding
, enum rfc2047_type type
)
378 static const int max_encoded_length
= 76; /* per rfc2047 */
380 int line_len
= last_line_length(sb
);
382 strbuf_grow(sb
, len
* 3 + strlen(encoding
) + 100);
383 strbuf_addf(sb
, "=?%s?q?", encoding
);
384 line_len
+= strlen(encoding
) + 5; /* 5 for =??q? */
388 * RFC 2047, section 5 (3):
390 * Each 'encoded-word' MUST represent an integral number of
391 * characters. A multi-octet character may not be split across
392 * adjacent 'encoded- word's.
394 const unsigned char *p
= (const unsigned char *)line
;
395 int chrlen
= mbs_chrlen(&line
, &len
, encoding
);
396 int is_special
= (chrlen
> 1) || is_rfc2047_special(*p
, type
);
398 /* "=%02X" * chrlen, or the byte itself */
399 const char *encoded_fmt
= is_special
? "=%02X" : "%c";
400 int encoded_len
= is_special
? 3 * chrlen
: 1;
403 * According to RFC 2047, we could encode the special character
404 * ' ' (space) with '_' (underscore) for readability. But many
405 * programs do not understand this and just leave the
406 * underscore in place. Thus, we do nothing special here, which
407 * causes ' ' to be encoded as '=20', avoiding this problem.
410 if (line_len
+ encoded_len
+ 2 > max_encoded_length
) {
411 /* It won't fit with trailing "?=" --- break the line */
412 strbuf_addf(sb
, "?=\n =?%s?q?", encoding
);
413 line_len
= strlen(encoding
) + 5 + 1; /* =??q? plus SP */
416 for (i
= 0; i
< chrlen
; i
++)
417 strbuf_addf(sb
, encoded_fmt
, p
[i
]);
418 line_len
+= encoded_len
;
420 strbuf_addstr(sb
, "?=");
423 const char *show_ident_date(const struct ident_split
*ident
,
424 const struct date_mode
*mode
)
426 timestamp_t date
= 0;
429 if (ident
->date_begin
&& ident
->date_end
)
430 date
= parse_timestamp(ident
->date_begin
, NULL
, 10);
431 if (date_overflows(date
))
434 if (ident
->tz_begin
&& ident
->tz_end
)
435 tz
= strtol(ident
->tz_begin
, NULL
, 10);
436 if (tz
>= INT_MAX
|| tz
<= INT_MIN
)
439 return show_date(date
, tz
, mode
);
442 static inline void strbuf_add_with_color(struct strbuf
*sb
, const char *color
,
443 const char *buf
, size_t buflen
)
445 strbuf_addstr(sb
, color
);
446 strbuf_add(sb
, buf
, buflen
);
448 strbuf_addstr(sb
, GIT_COLOR_RESET
);
451 static void append_line_with_color(struct strbuf
*sb
, struct grep_opt
*opt
,
452 const char *line
, size_t linelen
,
453 int color
, enum grep_context ctx
,
454 enum grep_header_field field
)
456 const char *buf
, *eol
, *line_color
, *match_color
;
463 if (!opt
|| !want_color(color
) || opt
->invert
)
466 line_color
= opt
->colors
[GREP_COLOR_SELECTED
];
467 match_color
= opt
->colors
[GREP_COLOR_MATCH_SELECTED
];
469 while (grep_next_match(opt
, buf
, eol
, ctx
, &match
, field
, eflags
)) {
470 if (match
.rm_so
== match
.rm_eo
)
473 strbuf_add_with_color(sb
, line_color
, buf
, match
.rm_so
);
474 strbuf_add_with_color(sb
, match_color
, buf
+ match
.rm_so
,
475 match
.rm_eo
- match
.rm_so
);
481 strbuf_add_with_color(sb
, line_color
, buf
, eol
- buf
);
484 strbuf_add(sb
, buf
, eol
- buf
);
488 static int use_in_body_from(const struct pretty_print_context
*pp
,
489 const struct ident_split
*ident
)
491 if (pp
->rev
&& pp
->rev
->force_in_body_from
)
493 if (ident_cmp(pp
->from_ident
, ident
))
498 void pp_user_info(struct pretty_print_context
*pp
,
499 const char *what
, struct strbuf
*sb
,
500 const char *line
, const char *encoding
)
502 struct ident_split ident
;
504 const char *mailbuf
, *namebuf
;
505 size_t namelen
, maillen
;
506 int max_length
= 78; /* per rfc2822 */
508 if (pp
->fmt
== CMIT_FMT_ONELINE
)
511 line_end
= strchrnul(line
, '\n');
512 if (split_ident_line(&ident
, line
, line_end
- line
))
515 mailbuf
= ident
.mail_begin
;
516 maillen
= ident
.mail_end
- ident
.mail_begin
;
517 namebuf
= ident
.name_begin
;
518 namelen
= ident
.name_end
- ident
.name_begin
;
521 map_user(pp
->mailmap
, &mailbuf
, &maillen
, &namebuf
, &namelen
);
523 if (cmit_fmt_is_mail(pp
->fmt
)) {
524 if (pp
->from_ident
&& use_in_body_from(pp
, &ident
)) {
525 struct strbuf buf
= STRBUF_INIT
;
527 strbuf_addstr(&buf
, "From: ");
528 strbuf_add(&buf
, namebuf
, namelen
);
529 strbuf_addstr(&buf
, " <");
530 strbuf_add(&buf
, mailbuf
, maillen
);
531 strbuf_addstr(&buf
, ">\n");
532 string_list_append(&pp
->in_body_headers
,
533 strbuf_detach(&buf
, NULL
));
535 mailbuf
= pp
->from_ident
->mail_begin
;
536 maillen
= pp
->from_ident
->mail_end
- mailbuf
;
537 namebuf
= pp
->from_ident
->name_begin
;
538 namelen
= pp
->from_ident
->name_end
- namebuf
;
541 strbuf_addstr(sb
, "From: ");
542 if (pp
->encode_email_headers
&&
543 needs_rfc2047_encoding(namebuf
, namelen
)) {
544 add_rfc2047(sb
, namebuf
, namelen
,
545 encoding
, RFC2047_ADDRESS
);
546 max_length
= 76; /* per rfc2047 */
547 } else if (needs_rfc822_quoting(namebuf
, namelen
)) {
548 struct strbuf quoted
= STRBUF_INIT
;
549 add_rfc822_quoted("ed
, namebuf
, namelen
);
550 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
552 strbuf_release("ed
);
554 strbuf_add_wrapped_bytes(sb
, namebuf
, namelen
,
559 last_line_length(sb
) + strlen(" <") + maillen
+ strlen(">"))
560 strbuf_addch(sb
, '\n');
561 strbuf_addf(sb
, " <%.*s>\n", (int)maillen
, mailbuf
);
563 struct strbuf id
= STRBUF_INIT
;
564 enum grep_header_field field
= GREP_HEADER_FIELD_MAX
;
565 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
567 if (!strcmp(what
, "Author"))
568 field
= GREP_HEADER_AUTHOR
;
569 else if (!strcmp(what
, "Commit"))
570 field
= GREP_HEADER_COMMITTER
;
572 strbuf_addf(sb
, "%s: ", what
);
573 if (pp
->fmt
== CMIT_FMT_FULLER
)
574 strbuf_addchars(sb
, ' ', 4);
576 strbuf_addf(&id
, "%.*s <%.*s>", (int)namelen
, namebuf
,
577 (int)maillen
, mailbuf
);
579 append_line_with_color(sb
, opt
, id
.buf
, id
.len
, pp
->color
,
580 GREP_CONTEXT_HEAD
, field
);
581 strbuf_addch(sb
, '\n');
586 case CMIT_FMT_MEDIUM
:
587 strbuf_addf(sb
, "Date: %s\n",
588 show_ident_date(&ident
, &pp
->date_mode
));
591 case CMIT_FMT_MBOXRD
:
592 strbuf_addf(sb
, "Date: %s\n",
593 show_ident_date(&ident
, DATE_MODE(RFC2822
)));
595 case CMIT_FMT_FULLER
:
596 strbuf_addf(sb
, "%sDate: %s\n", what
,
597 show_ident_date(&ident
, &pp
->date_mode
));
605 static int is_blank_line(const char *line
, int *len_p
)
608 while (len
&& isspace(line
[len
- 1]))
614 const char *skip_blank_lines(const char *msg
)
617 int linelen
= get_one_line(msg
);
621 if (!is_blank_line(msg
, &ll
))
628 static void add_merge_info(const struct pretty_print_context
*pp
,
629 struct strbuf
*sb
, const struct commit
*commit
)
631 struct commit_list
*parent
= commit
->parents
;
633 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (cmit_fmt_is_mail(pp
->fmt
)) ||
634 !parent
|| !parent
->next
)
637 strbuf_addstr(sb
, "Merge:");
640 struct object_id
*oidp
= &parent
->item
->object
.oid
;
641 strbuf_addch(sb
, ' ');
643 strbuf_add_unique_abbrev(sb
, oidp
, pp
->abbrev
);
645 strbuf_addstr(sb
, oid_to_hex(oidp
));
646 parent
= parent
->next
;
648 strbuf_addch(sb
, '\n');
651 static char *get_header(const char *msg
, const char *key
)
654 const char *v
= find_commit_header(msg
, key
, &len
);
655 return v
? xmemdupz(v
, len
) : NULL
;
658 static char *replace_encoding_header(char *buf
, const char *encoding
)
660 struct strbuf tmp
= STRBUF_INIT
;
664 /* guess if there is an encoding header before a \n\n */
665 while (!starts_with(cp
, "encoding ")) {
666 cp
= strchr(cp
, '\n');
667 if (!cp
|| *++cp
== '\n')
671 cp
= strchr(cp
, '\n');
673 return buf
; /* should not happen but be defensive */
674 len
= cp
+ 1 - (buf
+ start
);
676 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
677 if (is_encoding_utf8(encoding
)) {
678 /* we have re-coded to UTF-8; drop the header */
679 strbuf_remove(&tmp
, start
, len
);
681 /* just replaces XXXX in 'encoding XXXX\n' */
682 strbuf_splice(&tmp
, start
+ strlen("encoding "),
683 len
- strlen("encoding \n"),
684 encoding
, strlen(encoding
));
686 return strbuf_detach(&tmp
, NULL
);
689 const char *repo_logmsg_reencode(struct repository
*r
,
690 const struct commit
*commit
,
691 char **commit_encoding
,
692 const char *output_encoding
)
694 static const char *utf8
= "UTF-8";
695 const char *use_encoding
;
697 const char *msg
= repo_get_commit_buffer(r
, commit
, NULL
);
700 if (!output_encoding
|| !*output_encoding
) {
702 *commit_encoding
= get_header(msg
, "encoding");
705 encoding
= get_header(msg
, "encoding");
707 *commit_encoding
= encoding
;
708 use_encoding
= encoding
? encoding
: utf8
;
709 if (same_encoding(use_encoding
, output_encoding
)) {
711 * No encoding work to be done. If we have no encoding header
712 * at all, then there's nothing to do, and we can return the
713 * message verbatim (whether newly allocated or not).
719 * Otherwise, we still want to munge the encoding header in the
720 * result, which will be done by modifying the buffer. If we
721 * are using a fresh copy, we can reuse it. But if we are using
722 * the cached copy from get_commit_buffer, we need to duplicate it
723 * to avoid munging the cached copy.
725 if (msg
== get_cached_commit_buffer(r
, commit
, NULL
))
732 * There's actual encoding work to do. Do the reencoding, which
733 * still leaves the header to be replaced in the next step. At
734 * this point, we are done with msg. If we allocated a fresh
735 * copy, we can free it.
737 out
= reencode_string(msg
, output_encoding
, use_encoding
);
739 repo_unuse_commit_buffer(r
, commit
, msg
);
743 * This replacement actually consumes the buffer we hand it, so we do
744 * not have to worry about freeing the old "out" here.
747 out
= replace_encoding_header(out
, output_encoding
);
749 if (!commit_encoding
)
752 * If the re-encoding failed, out might be NULL here; in that
753 * case we just return the commit message verbatim.
755 return out
? out
: msg
;
758 static int mailmap_name(const char **email
, size_t *email_len
,
759 const char **name
, size_t *name_len
)
761 static struct string_list
*mail_map
;
763 CALLOC_ARRAY(mail_map
, 1);
764 read_mailmap(mail_map
);
766 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
769 static size_t format_person_part(struct strbuf
*sb
, char part
,
770 const char *msg
, int len
,
771 const struct date_mode
*dmode
)
773 /* currently all placeholders have same length */
774 const int placeholder_len
= 2;
775 struct ident_split s
;
776 const char *name
, *mail
;
777 size_t maillen
, namelen
;
779 if (split_ident_line(&s
, msg
, len
) < 0)
783 namelen
= s
.name_end
- s
.name_begin
;
785 maillen
= s
.mail_end
- s
.mail_begin
;
787 if (part
== 'N' || part
== 'E' || part
== 'L') /* mailmap lookup */
788 mailmap_name(&mail
, &maillen
, &name
, &namelen
);
789 if (part
== 'n' || part
== 'N') { /* name */
790 strbuf_add(sb
, name
, namelen
);
791 return placeholder_len
;
793 if (part
== 'e' || part
== 'E') { /* email */
794 strbuf_add(sb
, mail
, maillen
);
795 return placeholder_len
;
797 if (part
== 'l' || part
== 'L') { /* local-part */
798 const char *at
= memchr(mail
, '@', maillen
);
801 strbuf_add(sb
, mail
, maillen
);
802 return placeholder_len
;
808 if (part
== 't') { /* date, UNIX timestamp */
809 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
810 return placeholder_len
;
815 strbuf_addstr(sb
, show_ident_date(&s
, dmode
));
816 return placeholder_len
;
817 case 'D': /* date, RFC2822 style */
818 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(RFC2822
)));
819 return placeholder_len
;
820 case 'r': /* date, relative */
821 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(RELATIVE
)));
822 return placeholder_len
;
823 case 'i': /* date, ISO 8601-like */
824 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(ISO8601
)));
825 return placeholder_len
;
826 case 'I': /* date, ISO 8601 strict */
827 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(ISO8601_STRICT
)));
828 return placeholder_len
;
829 case 'h': /* date, human */
830 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(HUMAN
)));
831 return placeholder_len
;
833 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(SHORT
)));
834 return placeholder_len
;
839 * reading from either a bogus commit, or a reflog entry with
840 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
841 * to compute a valid return value.
843 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
844 || part
== 'D' || part
== 'r' || part
== 'i')
845 return placeholder_len
;
847 return 0; /* unknown placeholder */
859 flush_left_and_steal
,
870 struct format_commit_context
{
871 struct repository
*repository
;
872 const struct commit
*commit
;
873 const struct pretty_print_context
*pretty_ctx
;
874 unsigned commit_header_parsed
:1;
875 unsigned commit_message_parsed
:1;
876 struct signature_check signature_check
;
877 enum flush_type flush_type
;
878 enum trunc_type truncate
;
880 char *commit_encoding
;
881 size_t width
, indent1
, indent2
;
885 /* These offsets are relative to the start of the commit message. */
887 struct chunk committer
;
892 /* The following ones are relative to the result struct strbuf. */
896 static void parse_commit_header(struct format_commit_context
*context
)
898 const char *msg
= context
->message
;
901 for (i
= 0; msg
[i
]; i
++) {
904 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
909 } else if (skip_prefix(msg
+ i
, "author ", &name
)) {
910 context
->author
.off
= name
- msg
;
911 context
->author
.len
= msg
+ eol
- name
;
912 } else if (skip_prefix(msg
+ i
, "committer ", &name
)) {
913 context
->committer
.off
= name
- msg
;
914 context
->committer
.len
= msg
+ eol
- name
;
918 context
->message_off
= i
;
919 context
->commit_header_parsed
= 1;
922 static int istitlechar(char c
)
924 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
925 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
928 void format_sanitized_subject(struct strbuf
*sb
, const char *msg
, size_t len
)
931 size_t start_len
= sb
->len
;
935 for (i
= 0; i
< len
; i
++) {
936 if (istitlechar(msg
[i
])) {
938 strbuf_addch(sb
, '-');
940 strbuf_addch(sb
, msg
[i
]);
942 while (msg
[i
+1] == '.')
948 /* trim any trailing '.' or '-' characters */
950 while (sb
->len
- trimlen
> start_len
&&
951 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
952 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
954 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
957 const char *format_subject(struct strbuf
*sb
, const char *msg
,
958 const char *line_separator
)
963 const char *line
= msg
;
964 int linelen
= get_one_line(line
);
967 if (!linelen
|| is_blank_line(line
, &linelen
))
972 strbuf_grow(sb
, linelen
+ 2);
974 strbuf_addstr(sb
, line_separator
);
975 strbuf_add(sb
, line
, linelen
);
981 static void parse_commit_message(struct format_commit_context
*c
)
983 const char *msg
= c
->message
+ c
->message_off
;
984 const char *start
= c
->message
;
986 msg
= skip_blank_lines(msg
);
987 c
->subject_off
= msg
- start
;
989 msg
= format_subject(NULL
, msg
, NULL
);
990 msg
= skip_blank_lines(msg
);
991 c
->body_off
= msg
- start
;
993 c
->commit_message_parsed
= 1;
996 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
997 size_t width
, size_t indent1
, size_t indent2
)
999 struct strbuf tmp
= STRBUF_INIT
;
1002 strbuf_add(&tmp
, sb
->buf
, pos
);
1003 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
1004 cast_size_t_to_int(indent1
),
1005 cast_size_t_to_int(indent2
),
1006 cast_size_t_to_int(width
));
1007 strbuf_swap(&tmp
, sb
);
1008 strbuf_release(&tmp
);
1011 static void rewrap_message_tail(struct strbuf
*sb
,
1012 struct format_commit_context
*c
,
1013 size_t new_width
, size_t new_indent1
,
1016 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
1017 c
->indent2
== new_indent2
)
1019 if (c
->wrap_start
< sb
->len
)
1020 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
1021 c
->wrap_start
= sb
->len
;
1022 c
->width
= new_width
;
1023 c
->indent1
= new_indent1
;
1024 c
->indent2
= new_indent2
;
1027 static int format_reflog_person(struct strbuf
*sb
,
1029 struct reflog_walk_info
*log
,
1030 const struct date_mode
*dmode
)
1037 ident
= get_reflog_ident(log
);
1041 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
1044 static size_t parse_color(struct strbuf
*sb
, /* in UTF-8 */
1045 const char *placeholder
,
1046 struct format_commit_context
*c
)
1048 const char *rest
= placeholder
;
1049 const char *basic_color
= NULL
;
1051 if (placeholder
[1] == '(') {
1052 const char *begin
= placeholder
+ 2;
1053 const char *end
= strchr(begin
, ')');
1054 char color
[COLOR_MAXLEN
];
1059 if (skip_prefix(begin
, "auto,", &begin
)) {
1060 if (!want_color(c
->pretty_ctx
->color
))
1061 return end
- placeholder
+ 1;
1062 } else if (skip_prefix(begin
, "always,", &begin
)) {
1063 /* nothing to do; we do not respect want_color at all */
1065 /* the default is the same as "auto" */
1066 if (!want_color(c
->pretty_ctx
->color
))
1067 return end
- placeholder
+ 1;
1070 if (color_parse_mem(begin
, end
- begin
, color
) < 0)
1071 die(_("unable to parse --pretty format"));
1072 strbuf_addstr(sb
, color
);
1073 return end
- placeholder
+ 1;
1077 * We handle things like "%C(red)" above; for historical reasons, there
1078 * are a few colors that can be specified without parentheses (and
1079 * they cannot support things like "auto" or "always" at all).
1081 if (skip_prefix(placeholder
+ 1, "red", &rest
))
1082 basic_color
= GIT_COLOR_RED
;
1083 else if (skip_prefix(placeholder
+ 1, "green", &rest
))
1084 basic_color
= GIT_COLOR_GREEN
;
1085 else if (skip_prefix(placeholder
+ 1, "blue", &rest
))
1086 basic_color
= GIT_COLOR_BLUE
;
1087 else if (skip_prefix(placeholder
+ 1, "reset", &rest
))
1088 basic_color
= GIT_COLOR_RESET
;
1090 if (basic_color
&& want_color(c
->pretty_ctx
->color
))
1091 strbuf_addstr(sb
, basic_color
);
1093 return rest
- placeholder
;
1096 static size_t parse_padding_placeholder(const char *placeholder
,
1097 struct format_commit_context
*c
)
1099 const char *ch
= placeholder
;
1100 enum flush_type flush_type
;
1105 flush_type
= flush_right
;
1109 flush_type
= flush_both
;
1111 } else if (*ch
== '>') {
1112 flush_type
= flush_left_and_steal
;
1115 flush_type
= flush_left
;
1121 /* the next value means "wide enough to that column" */
1128 const char *start
= ch
+ 1;
1129 const char *end
= start
+ strcspn(start
, ",)");
1132 if (!*end
|| end
== start
)
1134 width
= strtol(start
, &next
, 10);
1137 * We need to limit the amount of padding, or otherwise this
1138 * would allow the user to pad the buffer by arbitrarily many
1139 * bytes and thus cause resource exhaustion.
1141 if (width
< -FORMATTING_LIMIT
|| width
> FORMATTING_LIMIT
)
1144 if (next
== start
|| width
== 0)
1148 width
+= term_columns();
1152 c
->padding
= to_column
? -width
: width
;
1153 c
->flush_type
= flush_type
;
1157 end
= strchr(start
, ')');
1158 if (!end
|| end
== start
)
1160 if (starts_with(start
, "trunc)"))
1161 c
->truncate
= trunc_right
;
1162 else if (starts_with(start
, "ltrunc)"))
1163 c
->truncate
= trunc_left
;
1164 else if (starts_with(start
, "mtrunc)"))
1165 c
->truncate
= trunc_middle
;
1169 c
->truncate
= trunc_none
;
1171 return end
- placeholder
+ 1;
1176 static int match_placeholder_arg_value(const char *to_parse
, const char *candidate
,
1177 const char **end
, const char **valuestart
,
1182 if (!(skip_prefix(to_parse
, candidate
, &p
)))
1186 *valuestart
= p
+ 1;
1187 *valuelen
= strcspn(*valuestart
, ",)");
1188 p
= *valuestart
+ *valuelen
;
1190 if (*p
!= ',' && *p
!= ')')
1207 static int match_placeholder_bool_arg(const char *to_parse
, const char *candidate
,
1208 const char **end
, int *val
)
1215 if (!match_placeholder_arg_value(to_parse
, candidate
, end
, &argval
, &arglen
))
1223 strval
= xstrndup(argval
, arglen
);
1224 v
= git_parse_maybe_bool(strval
);
1235 static int format_trailer_match_cb(const struct strbuf
*key
, void *ud
)
1237 const struct string_list
*list
= ud
;
1238 const struct string_list_item
*item
;
1240 for_each_string_list_item (item
, list
) {
1241 if (key
->len
== (uintptr_t)item
->util
&&
1242 !strncasecmp(item
->string
, key
->buf
, key
->len
))
1248 int format_set_trailers_options(struct process_trailer_options
*opts
,
1249 struct string_list
*filter_list
,
1250 struct strbuf
*sepbuf
,
1251 struct strbuf
*kvsepbuf
,
1262 if (match_placeholder_arg_value(*arg
, "key", arg
, &argval
, &arglen
)) {
1263 uintptr_t len
= arglen
;
1268 if (len
&& argval
[len
- 1] == ':')
1270 string_list_append(filter_list
, argval
)->util
= (char *)len
;
1272 opts
->filter
= format_trailer_match_cb
;
1273 opts
->filter_data
= filter_list
;
1274 opts
->only_trailers
= 1;
1275 } else if (match_placeholder_arg_value(*arg
, "separator", arg
, &argval
, &arglen
)) {
1278 strbuf_reset(sepbuf
);
1279 fmt
= xstrndup(argval
, arglen
);
1280 strbuf_expand(sepbuf
, fmt
, strbuf_expand_literal_cb
, NULL
);
1282 opts
->separator
= sepbuf
;
1283 } else if (match_placeholder_arg_value(*arg
, "key_value_separator", arg
, &argval
, &arglen
)) {
1286 strbuf_reset(kvsepbuf
);
1287 fmt
= xstrndup(argval
, arglen
);
1288 strbuf_expand(kvsepbuf
, fmt
, strbuf_expand_literal_cb
, NULL
);
1290 opts
->key_value_separator
= kvsepbuf
;
1291 } else if (!match_placeholder_bool_arg(*arg
, "only", arg
, &opts
->only_trailers
) &&
1292 !match_placeholder_bool_arg(*arg
, "unfold", arg
, &opts
->unfold
) &&
1293 !match_placeholder_bool_arg(*arg
, "keyonly", arg
, &opts
->key_only
) &&
1294 !match_placeholder_bool_arg(*arg
, "valueonly", arg
, &opts
->value_only
)) {
1296 size_t len
= strcspn(*arg
, ",)");
1297 *invalid_arg
= xstrndup(*arg
, len
);
1305 static size_t parse_describe_args(const char *start
, struct strvec
*args
)
1311 DESCRIBE_ARG_INTEGER
,
1312 DESCRIBE_ARG_STRING
,
1315 { "tags", DESCRIBE_ARG_BOOL
},
1316 { "abbrev", DESCRIBE_ARG_INTEGER
},
1317 { "exclude", DESCRIBE_ARG_STRING
},
1318 { "match", DESCRIBE_ARG_STRING
},
1320 const char *arg
= start
;
1329 for (i
= 0; !found
&& i
< ARRAY_SIZE(option
); i
++) {
1330 switch (option
[i
].type
) {
1331 case DESCRIBE_ARG_BOOL
:
1332 if (match_placeholder_bool_arg(arg
, option
[i
].name
, &arg
, &optval
)) {
1334 strvec_pushf(args
, "--%s", option
[i
].name
);
1336 strvec_pushf(args
, "--no-%s", option
[i
].name
);
1340 case DESCRIBE_ARG_INTEGER
:
1341 if (match_placeholder_arg_value(arg
, option
[i
].name
, &arg
,
1342 &argval
, &arglen
)) {
1346 strtol(argval
, &endptr
, 10);
1347 if (endptr
- argval
!= arglen
)
1349 strvec_pushf(args
, "--%s=%.*s", option
[i
].name
, (int)arglen
, argval
);
1353 case DESCRIBE_ARG_STRING
:
1354 if (match_placeholder_arg_value(arg
, option
[i
].name
, &arg
,
1355 &argval
, &arglen
)) {
1358 strvec_pushf(args
, "--%s=%.*s", option
[i
].name
, (int)arglen
, argval
);
1371 static size_t format_commit_one(struct strbuf
*sb
, /* in UTF-8 */
1372 const char *placeholder
,
1375 struct format_commit_context
*c
= context
;
1376 const struct commit
*commit
= c
->commit
;
1377 const char *msg
= c
->message
;
1378 struct commit_list
*p
;
1379 const char *arg
, *eol
;
1383 /* these are independent of the commit */
1384 res
= strbuf_expand_literal_cb(sb
, placeholder
, NULL
);
1388 switch (placeholder
[0]) {
1390 if (starts_with(placeholder
+ 1, "(auto)")) {
1391 c
->auto_color
= want_color(c
->pretty_ctx
->color
);
1392 if (c
->auto_color
&& sb
->len
)
1393 strbuf_addstr(sb
, GIT_COLOR_RESET
);
1394 return 7; /* consumed 7 bytes, "C(auto)" */
1396 int ret
= parse_color(sb
, placeholder
, c
);
1400 * Otherwise, we decided to treat %C<unknown>
1401 * as a literal string, and the previous
1402 * %C(auto) is still valid.
1407 if (placeholder
[1] == '(') {
1408 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1410 const char *start
= placeholder
+ 2;
1411 const char *end
= strchr(start
, ')');
1415 width
= strtoul(start
, &next
, 10);
1417 indent1
= strtoul(next
+ 1, &next
, 10);
1419 indent2
= strtoul(next
+ 1,
1428 * We need to limit the format here as it allows the
1429 * user to prepend arbitrarily many bytes to the buffer
1432 if (width
> FORMATTING_LIMIT
||
1433 indent1
> FORMATTING_LIMIT
||
1434 indent2
> FORMATTING_LIMIT
)
1436 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1437 return end
- placeholder
+ 1;
1443 return parse_padding_placeholder(placeholder
, c
);
1446 if (skip_prefix(placeholder
, "(describe", &arg
)) {
1447 struct child_process cmd
= CHILD_PROCESS_INIT
;
1448 struct strbuf out
= STRBUF_INIT
;
1449 struct strbuf err
= STRBUF_INIT
;
1450 struct pretty_print_describe_status
*describe_status
;
1452 describe_status
= c
->pretty_ctx
->describe_status
;
1453 if (describe_status
) {
1454 if (!describe_status
->max_invocations
)
1456 describe_status
->max_invocations
--;
1460 strvec_push(&cmd
.args
, "describe");
1464 arg
+= parse_describe_args(arg
, &cmd
.args
);
1468 child_process_clear(&cmd
);
1472 strvec_push(&cmd
.args
, oid_to_hex(&commit
->object
.oid
));
1473 pipe_command(&cmd
, NULL
, 0, &out
, 0, &err
, 0);
1475 strbuf_addbuf(sb
, &out
);
1476 strbuf_release(&out
);
1477 strbuf_release(&err
);
1478 return arg
- placeholder
+ 1;
1481 /* these depend on the commit */
1482 if (!commit
->object
.parsed
)
1483 parse_object(the_repository
, &commit
->object
.oid
);
1485 switch (placeholder
[0]) {
1486 case 'H': /* commit hash */
1487 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1488 strbuf_addstr(sb
, oid_to_hex(&commit
->object
.oid
));
1489 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1491 case 'h': /* abbreviated commit hash */
1492 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1493 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
,
1494 c
->pretty_ctx
->abbrev
);
1495 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1497 case 'T': /* tree hash */
1498 strbuf_addstr(sb
, oid_to_hex(get_commit_tree_oid(commit
)));
1500 case 't': /* abbreviated tree hash */
1501 strbuf_add_unique_abbrev(sb
,
1502 get_commit_tree_oid(commit
),
1503 c
->pretty_ctx
->abbrev
);
1505 case 'P': /* parent hashes */
1506 for (p
= commit
->parents
; p
; p
= p
->next
) {
1507 if (p
!= commit
->parents
)
1508 strbuf_addch(sb
, ' ');
1509 strbuf_addstr(sb
, oid_to_hex(&p
->item
->object
.oid
));
1512 case 'p': /* abbreviated parent hashes */
1513 for (p
= commit
->parents
; p
; p
= p
->next
) {
1514 if (p
!= commit
->parents
)
1515 strbuf_addch(sb
, ' ');
1516 strbuf_add_unique_abbrev(sb
, &p
->item
->object
.oid
,
1517 c
->pretty_ctx
->abbrev
);
1520 case 'm': /* left/right/bottom */
1521 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1524 format_decorations(sb
, commit
, c
->auto_color
);
1527 format_decorations_extended(sb
, commit
, c
->auto_color
, "", ", ", "");
1529 case 'S': /* tag/branch like --source */
1530 if (!(c
->pretty_ctx
->rev
&& c
->pretty_ctx
->rev
->sources
))
1532 slot
= revision_sources_at(c
->pretty_ctx
->rev
->sources
, commit
);
1533 if (!(slot
&& *slot
))
1535 strbuf_addstr(sb
, *slot
);
1537 case 'g': /* reflog info */
1538 switch(placeholder
[1]) {
1539 case 'd': /* reflog selector */
1541 if (c
->pretty_ctx
->reflog_info
)
1542 get_reflog_selector(sb
,
1543 c
->pretty_ctx
->reflog_info
,
1544 &c
->pretty_ctx
->date_mode
,
1545 c
->pretty_ctx
->date_mode_explicit
,
1546 (placeholder
[1] == 'd'));
1548 case 's': /* reflog message */
1549 if (c
->pretty_ctx
->reflog_info
)
1550 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1556 return format_reflog_person(sb
,
1558 c
->pretty_ctx
->reflog_info
,
1559 &c
->pretty_ctx
->date_mode
);
1561 return 0; /* unknown %g placeholder */
1563 if (c
->pretty_ctx
->notes_message
) {
1564 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1570 if (placeholder
[0] == 'G') {
1571 if (!c
->signature_check
.result
)
1572 check_commit_signature(c
->commit
, &(c
->signature_check
));
1573 switch (placeholder
[1]) {
1575 if (c
->signature_check
.output
)
1576 strbuf_addstr(sb
, c
->signature_check
.output
);
1579 switch (c
->signature_check
.result
) {
1581 switch (c
->signature_check
.trust_level
) {
1582 case TRUST_UNDEFINED
:
1584 strbuf_addch(sb
, 'U');
1587 strbuf_addch(sb
, 'G');
1597 strbuf_addch(sb
, c
->signature_check
.result
);
1601 if (c
->signature_check
.signer
)
1602 strbuf_addstr(sb
, c
->signature_check
.signer
);
1605 if (c
->signature_check
.key
)
1606 strbuf_addstr(sb
, c
->signature_check
.key
);
1609 if (c
->signature_check
.fingerprint
)
1610 strbuf_addstr(sb
, c
->signature_check
.fingerprint
);
1613 if (c
->signature_check
.primary_key_fingerprint
)
1614 strbuf_addstr(sb
, c
->signature_check
.primary_key_fingerprint
);
1617 strbuf_addstr(sb
, gpg_trust_level_to_str(c
->signature_check
.trust_level
));
1625 /* For the rest we have to parse the commit header. */
1626 if (!c
->commit_header_parsed
) {
1628 repo_logmsg_reencode(c
->repository
, commit
,
1629 &c
->commit_encoding
, "UTF-8");
1630 parse_commit_header(c
);
1633 switch (placeholder
[0]) {
1634 case 'a': /* author ... */
1635 return format_person_part(sb
, placeholder
[1],
1636 msg
+ c
->author
.off
, c
->author
.len
,
1637 &c
->pretty_ctx
->date_mode
);
1638 case 'c': /* committer ... */
1639 return format_person_part(sb
, placeholder
[1],
1640 msg
+ c
->committer
.off
, c
->committer
.len
,
1641 &c
->pretty_ctx
->date_mode
);
1642 case 'e': /* encoding */
1643 if (c
->commit_encoding
)
1644 strbuf_addstr(sb
, c
->commit_encoding
);
1646 case 'B': /* raw body */
1647 /* message_off is always left at the initial newline */
1648 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1652 /* Now we need to parse the commit message. */
1653 if (!c
->commit_message_parsed
)
1654 parse_commit_message(c
);
1656 switch (placeholder
[0]) {
1657 case 's': /* subject */
1658 format_subject(sb
, msg
+ c
->subject_off
, " ");
1660 case 'f': /* sanitized subject */
1661 eol
= strchrnul(msg
+ c
->subject_off
, '\n');
1662 format_sanitized_subject(sb
, msg
+ c
->subject_off
, eol
- (msg
+ c
->subject_off
));
1664 case 'b': /* body */
1665 strbuf_addstr(sb
, msg
+ c
->body_off
);
1669 if (skip_prefix(placeholder
, "(trailers", &arg
)) {
1670 struct process_trailer_options opts
= PROCESS_TRAILER_OPTIONS_INIT
;
1671 struct string_list filter_list
= STRING_LIST_INIT_NODUP
;
1672 struct strbuf sepbuf
= STRBUF_INIT
;
1673 struct strbuf kvsepbuf
= STRBUF_INIT
;
1676 opts
.no_divider
= 1;
1680 if (format_set_trailers_options(&opts
, &filter_list
, &sepbuf
, &kvsepbuf
, &arg
, NULL
))
1684 format_trailers_from_commit(sb
, msg
+ c
->subject_off
, &opts
);
1685 ret
= arg
- placeholder
+ 1;
1688 string_list_clear(&filter_list
, 0);
1689 strbuf_release(&sepbuf
);
1693 return 0; /* unknown placeholder */
1696 static size_t format_and_pad_commit(struct strbuf
*sb
, /* in UTF-8 */
1697 const char *placeholder
,
1698 struct format_commit_context
*c
)
1700 struct strbuf local_sb
= STRBUF_INIT
;
1701 size_t total_consumed
= 0;
1702 int len
, padding
= c
->padding
;
1705 const char *start
= strrchr(sb
->buf
, '\n');
1709 occupied
= utf8_strnwidth(start
, strlen(start
), 1);
1710 occupied
+= c
->pretty_ctx
->graph_width
;
1711 padding
= (-padding
) - occupied
;
1714 int modifier
= *placeholder
== 'C';
1715 size_t consumed
= format_commit_one(&local_sb
, placeholder
, c
);
1716 total_consumed
+= consumed
;
1721 placeholder
+= consumed
;
1722 if (*placeholder
!= '%')
1727 len
= utf8_strnwidth(local_sb
.buf
, local_sb
.len
, 1);
1729 if (c
->flush_type
== flush_left_and_steal
) {
1730 const char *ch
= sb
->buf
+ sb
->len
- 1;
1731 while (len
> padding
&& ch
> sb
->buf
) {
1738 /* check for trailing ansi sequences */
1742 while (p
> sb
->buf
&& ch
- p
< 10 && *p
!= '\033')
1745 ch
+ 1 - p
!= display_mode_esc_sequence_len(p
))
1748 * got a good ansi sequence, put it back to
1749 * local_sb as we're cutting sb
1751 strbuf_insert(&local_sb
, 0, p
, ch
+ 1 - p
);
1754 strbuf_setlen(sb
, ch
+ 1 - sb
->buf
);
1755 c
->flush_type
= flush_left
;
1758 if (len
> padding
) {
1759 switch (c
->truncate
) {
1761 strbuf_utf8_replace(&local_sb
,
1762 0, len
- (padding
- 2),
1766 strbuf_utf8_replace(&local_sb
,
1768 len
- (padding
- 2),
1772 strbuf_utf8_replace(&local_sb
,
1773 padding
- 2, len
- (padding
- 2),
1779 strbuf_addbuf(sb
, &local_sb
);
1781 size_t sb_len
= sb
->len
, offset
= 0;
1782 if (c
->flush_type
== flush_left
)
1783 offset
= padding
- len
;
1784 else if (c
->flush_type
== flush_both
)
1785 offset
= (padding
- len
) / 2;
1787 * we calculate padding in columns, now
1788 * convert it back to chars
1790 padding
= padding
- len
+ local_sb
.len
;
1791 strbuf_addchars(sb
, ' ', padding
);
1792 memcpy(sb
->buf
+ sb_len
+ offset
, local_sb
.buf
,
1795 strbuf_release(&local_sb
);
1796 c
->flush_type
= no_flush
;
1797 return total_consumed
;
1800 static size_t format_commit_item(struct strbuf
*sb
, /* in UTF-8 */
1801 const char *placeholder
,
1804 size_t consumed
, orig_len
;
1807 ADD_LF_BEFORE_NON_EMPTY
,
1808 DEL_LF_BEFORE_EMPTY
,
1809 ADD_SP_BEFORE_NON_EMPTY
1812 switch (placeholder
[0]) {
1814 magic
= DEL_LF_BEFORE_EMPTY
;
1817 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1820 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1825 if (magic
!= NO_MAGIC
) {
1828 switch (placeholder
[0]) {
1831 * `%+w()` cannot ever expand to a non-empty string,
1832 * and it potentially changes the layout of preceding
1833 * contents. We're thus not able to handle the magic in
1834 * this combination and refuse the pattern.
1841 if (((struct format_commit_context
*)context
)->flush_type
!= no_flush
)
1842 consumed
= format_and_pad_commit(sb
, placeholder
, context
);
1844 consumed
= format_commit_one(sb
, placeholder
, context
);
1845 if (magic
== NO_MAGIC
)
1848 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1849 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1850 strbuf_setlen(sb
, sb
->len
- 1);
1851 } else if (orig_len
!= sb
->len
) {
1852 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1853 strbuf_insertstr(sb
, orig_len
, "\n");
1854 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1855 strbuf_insertstr(sb
, orig_len
, " ");
1857 return consumed
+ 1;
1860 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1863 struct userformat_want
*w
= context
;
1865 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1868 switch (*placeholder
) {
1883 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1885 struct strbuf dummy
= STRBUF_INIT
;
1892 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1893 strbuf_release(&dummy
);
1896 void repo_format_commit_message(struct repository
*r
,
1897 const struct commit
*commit
,
1898 const char *format
, struct strbuf
*sb
,
1899 const struct pretty_print_context
*pretty_ctx
)
1901 struct format_commit_context context
= {
1904 .pretty_ctx
= pretty_ctx
,
1905 .wrap_start
= sb
->len
1907 const char *output_enc
= pretty_ctx
->output_encoding
;
1908 const char *utf8
= "UTF-8";
1910 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1911 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1914 * Convert output to an actual output encoding; note that
1915 * format_commit_item() will always use UTF-8, so we don't
1916 * have to bother if that's what the output wants.
1919 if (same_encoding(utf8
, output_enc
))
1922 if (context
.commit_encoding
&&
1923 !same_encoding(context
.commit_encoding
, utf8
))
1924 output_enc
= context
.commit_encoding
;
1929 char *out
= reencode_string_len(sb
->buf
, sb
->len
,
1930 output_enc
, utf8
, &outsz
);
1932 strbuf_attach(sb
, out
, outsz
, outsz
+ 1);
1935 free(context
.commit_encoding
);
1936 repo_unuse_commit_buffer(r
, commit
, context
.message
);
1939 static void pp_header(struct pretty_print_context
*pp
,
1940 const char *encoding
,
1941 const struct commit
*commit
,
1945 int parents_shown
= 0;
1948 const char *name
, *line
= *msg_p
;
1949 int linelen
= get_one_line(*msg_p
);
1959 if (pp
->fmt
== CMIT_FMT_RAW
) {
1960 strbuf_add(sb
, line
, linelen
);
1964 if (starts_with(line
, "parent ")) {
1965 if (linelen
!= the_hash_algo
->hexsz
+ 8)
1966 die("bad parent line in commit");
1970 if (!parents_shown
) {
1971 unsigned num
= commit_list_count(commit
->parents
);
1972 /* with enough slop */
1973 strbuf_grow(sb
, num
* (GIT_MAX_HEXSZ
+ 10) + 20);
1974 add_merge_info(pp
, sb
, commit
);
1979 * MEDIUM == DEFAULT shows only author with dates.
1980 * FULL shows both authors but not dates.
1981 * FULLER shows both authors and dates.
1983 if (skip_prefix(line
, "author ", &name
)) {
1984 strbuf_grow(sb
, linelen
+ 80);
1985 pp_user_info(pp
, "Author", sb
, name
, encoding
);
1987 if (skip_prefix(line
, "committer ", &name
) &&
1988 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1989 strbuf_grow(sb
, linelen
+ 80);
1990 pp_user_info(pp
, "Commit", sb
, name
, encoding
);
1995 void pp_title_line(struct pretty_print_context
*pp
,
1998 const char *encoding
,
2001 static const int max_length
= 78; /* per rfc2047 */
2002 struct strbuf title
;
2004 strbuf_init(&title
, 80);
2005 *msg_p
= format_subject(&title
, *msg_p
,
2006 pp
->preserve_subject
? "\n" : " ");
2008 strbuf_grow(sb
, title
.len
+ 1024);
2009 if (pp
->print_email_subject
) {
2011 fmt_output_email_subject(sb
, pp
->rev
);
2012 if (pp
->encode_email_headers
&&
2013 needs_rfc2047_encoding(title
.buf
, title
.len
))
2014 add_rfc2047(sb
, title
.buf
, title
.len
,
2015 encoding
, RFC2047_SUBJECT
);
2017 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
2018 -last_line_length(sb
), 1, max_length
);
2020 strbuf_addbuf(sb
, &title
);
2022 strbuf_addch(sb
, '\n');
2024 if (need_8bit_cte
== 0) {
2026 for (i
= 0; i
< pp
->in_body_headers
.nr
; i
++) {
2027 if (has_non_ascii(pp
->in_body_headers
.items
[i
].string
)) {
2034 if (need_8bit_cte
> 0) {
2035 const char *header_fmt
=
2036 "MIME-Version: 1.0\n"
2037 "Content-Type: text/plain; charset=%s\n"
2038 "Content-Transfer-Encoding: 8bit\n";
2039 strbuf_addf(sb
, header_fmt
, encoding
);
2041 if (pp
->after_subject
) {
2042 strbuf_addstr(sb
, pp
->after_subject
);
2044 if (cmit_fmt_is_mail(pp
->fmt
)) {
2045 strbuf_addch(sb
, '\n');
2048 if (pp
->in_body_headers
.nr
) {
2050 for (i
= 0; i
< pp
->in_body_headers
.nr
; i
++) {
2051 strbuf_addstr(sb
, pp
->in_body_headers
.items
[i
].string
);
2052 free(pp
->in_body_headers
.items
[i
].string
);
2054 string_list_clear(&pp
->in_body_headers
, 0);
2055 strbuf_addch(sb
, '\n');
2058 strbuf_release(&title
);
2061 static int pp_utf8_width(const char *start
, const char *end
)
2064 size_t remain
= end
- start
;
2067 int n
= utf8_width(&start
, &remain
);
2068 if (n
< 0 || !start
)
2075 static void strbuf_add_tabexpand(struct strbuf
*sb
, struct grep_opt
*opt
,
2076 int color
, int tabwidth
, const char *line
,
2081 while ((tab
= memchr(line
, '\t', linelen
)) != NULL
) {
2082 int width
= pp_utf8_width(line
, tab
);
2085 * If it wasn't well-formed utf8, or it
2086 * had characters with badly defined
2087 * width (control characters etc), just
2088 * give up on trying to align things.
2093 /* Output the data .. */
2094 append_line_with_color(sb
, opt
, line
, tab
- line
, color
,
2096 GREP_HEADER_FIELD_MAX
);
2098 /* .. and the de-tabified tab */
2099 strbuf_addchars(sb
, ' ', tabwidth
- (width
% tabwidth
));
2101 /* Skip over the printed part .. */
2102 linelen
-= tab
+ 1 - line
;
2107 * Print out everything after the last tab without
2108 * worrying about width - there's nothing more to
2111 append_line_with_color(sb
, opt
, line
, linelen
, color
, GREP_CONTEXT_BODY
,
2112 GREP_HEADER_FIELD_MAX
);
2116 * pp_handle_indent() prints out the intendation, and
2117 * the whole line (without the final newline), after
2120 static void pp_handle_indent(struct pretty_print_context
*pp
,
2121 struct strbuf
*sb
, int indent
,
2122 const char *line
, int linelen
)
2124 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
2126 strbuf_addchars(sb
, ' ', indent
);
2127 if (pp
->expand_tabs_in_log
)
2128 strbuf_add_tabexpand(sb
, opt
, pp
->color
, pp
->expand_tabs_in_log
,
2131 append_line_with_color(sb
, opt
, line
, linelen
, pp
->color
,
2133 GREP_HEADER_FIELD_MAX
);
2136 static int is_mboxrd_from(const char *line
, int len
)
2139 * a line matching /^From $/ here would only have len == 4
2140 * at this point because is_empty_line would've trimmed all
2143 return len
> 4 && starts_with(line
+ strspn(line
, ">"), "From ");
2146 void pp_remainder(struct pretty_print_context
*pp
,
2151 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
2155 const char *line
= *msg_p
;
2156 int linelen
= get_one_line(line
);
2162 if (is_blank_line(line
, &linelen
)) {
2165 if (pp
->fmt
== CMIT_FMT_SHORT
)
2170 strbuf_grow(sb
, linelen
+ indent
+ 20);
2172 pp_handle_indent(pp
, sb
, indent
, line
, linelen
);
2173 else if (pp
->expand_tabs_in_log
)
2174 strbuf_add_tabexpand(sb
, opt
, pp
->color
,
2175 pp
->expand_tabs_in_log
, line
,
2178 if (pp
->fmt
== CMIT_FMT_MBOXRD
&&
2179 is_mboxrd_from(line
, linelen
))
2180 strbuf_addch(sb
, '>');
2182 append_line_with_color(sb
, opt
, line
, linelen
,
2183 pp
->color
, GREP_CONTEXT_BODY
,
2184 GREP_HEADER_FIELD_MAX
);
2186 strbuf_addch(sb
, '\n');
2190 void pretty_print_commit(struct pretty_print_context
*pp
,
2191 const struct commit
*commit
,
2194 unsigned long beginning_of_body
;
2197 const char *reencoded
;
2198 const char *encoding
;
2199 int need_8bit_cte
= pp
->need_8bit_cte
;
2201 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
2202 format_commit_message(commit
, user_format
, sb
, pp
);
2206 encoding
= get_log_output_encoding();
2207 msg
= reencoded
= logmsg_reencode(commit
, NULL
, encoding
);
2209 if (pp
->fmt
== CMIT_FMT_ONELINE
|| cmit_fmt_is_mail(pp
->fmt
))
2213 * We need to check and emit Content-type: to mark it
2214 * as 8-bit if we haven't done so.
2216 if (cmit_fmt_is_mail(pp
->fmt
) && need_8bit_cte
== 0) {
2219 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
2221 /* author could be non 7-bit ASCII but
2222 * the log may be so; skip over the
2223 * header part first.
2225 if (ch
== '\n' && msg
[i
+1] == '\n')
2228 else if (non_ascii(ch
)) {
2235 pp_header(pp
, encoding
, commit
, &msg
, sb
);
2236 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->print_email_subject
) {
2237 strbuf_addch(sb
, '\n');
2240 /* Skip excess blank lines at the beginning of body, if any... */
2241 msg
= skip_blank_lines(msg
);
2243 /* These formats treat the title line specially. */
2244 if (pp
->fmt
== CMIT_FMT_ONELINE
|| cmit_fmt_is_mail(pp
->fmt
))
2245 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
2247 beginning_of_body
= sb
->len
;
2248 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
2249 pp_remainder(pp
, &msg
, sb
, indent
);
2252 /* Make sure there is an EOLN for the non-oneline case */
2253 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
2254 strbuf_addch(sb
, '\n');
2257 * The caller may append additional body text in e-mail
2258 * format. Make sure we did not strip the blank line
2259 * between the header and the body.
2261 if (cmit_fmt_is_mail(pp
->fmt
) && sb
->len
<= beginning_of_body
)
2262 strbuf_addch(sb
, '\n');
2264 unuse_commit_buffer(commit
, reencoded
);
2267 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
2270 struct pretty_print_context pp
= {0};
2272 pretty_print_commit(&pp
, commit
, sb
);