1 #include "git-compat-util.h"
5 #include "environment.h"
12 #include "string-list.h"
17 #include "reflog-walk.h"
18 #include "gpg-interface.h"
20 #include "run-command.h"
23 * The limit for formatting directives, which enable the caller to append
24 * arbitrarily many bytes to the formatted buffer. This includes padding
25 * and wrapping formatters.
27 #define FORMATTING_LIMIT (16 * 1024)
29 static char *user_format
;
30 static struct cmt_fmt_map
{
34 int expand_tabs_in_log
;
36 enum date_mode_type default_date_mode_type
;
37 const char *user_format
;
39 static size_t builtin_formats_len
;
40 static size_t commit_formats_len
;
41 static size_t commit_formats_alloc
;
42 static struct cmt_fmt_map
*find_commit_format(const char *sought
);
44 int commit_format_is_empty(enum cmit_fmt fmt
)
46 return fmt
== CMIT_FMT_USERFORMAT
&& !*user_format
;
49 static void save_user_format(struct rev_info
*rev
, const char *cp
, int is_tformat
)
52 user_format
= xstrdup(cp
);
54 rev
->use_terminator
= 1;
55 rev
->commit_format
= CMIT_FMT_USERFORMAT
;
58 static int git_pretty_formats_config(const char *var
, const char *value
,
61 struct cmt_fmt_map
*commit_format
= NULL
;
66 if (!skip_prefix(var
, "pretty.", &name
))
69 for (i
= 0; i
< builtin_formats_len
; i
++) {
70 if (!strcmp(commit_formats
[i
].name
, name
))
74 for (i
= builtin_formats_len
; i
< commit_formats_len
; i
++) {
75 if (!strcmp(commit_formats
[i
].name
, name
)) {
76 commit_format
= &commit_formats
[i
];
82 ALLOC_GROW(commit_formats
, commit_formats_len
+1,
83 commit_formats_alloc
);
84 commit_format
= &commit_formats
[commit_formats_len
];
85 memset(commit_format
, 0, sizeof(*commit_format
));
89 commit_format
->name
= xstrdup(name
);
90 commit_format
->format
= CMIT_FMT_USERFORMAT
;
91 if (git_config_string(&fmt
, var
, value
))
94 if (skip_prefix(fmt
, "format:", &fmt
))
95 commit_format
->is_tformat
= 0;
96 else if (skip_prefix(fmt
, "tformat:", &fmt
) || strchr(fmt
, '%'))
97 commit_format
->is_tformat
= 1;
99 commit_format
->is_alias
= 1;
100 commit_format
->user_format
= fmt
;
105 static void setup_commit_formats(void)
107 struct cmt_fmt_map builtin_formats
[] = {
108 { "raw", CMIT_FMT_RAW
, 0, 0 },
109 { "medium", CMIT_FMT_MEDIUM
, 0, 8 },
110 { "short", CMIT_FMT_SHORT
, 0, 0 },
111 { "email", CMIT_FMT_EMAIL
, 0, 0 },
112 { "mboxrd", CMIT_FMT_MBOXRD
, 0, 0 },
113 { "fuller", CMIT_FMT_FULLER
, 0, 8 },
114 { "full", CMIT_FMT_FULL
, 0, 8 },
115 { "oneline", CMIT_FMT_ONELINE
, 1, 0 },
116 { "reference", CMIT_FMT_USERFORMAT
, 1, 0,
117 0, DATE_SHORT
, "%C(auto)%h (%s, %ad)" },
119 * Please update $__git_log_pretty_formats in
120 * git-completion.bash when you add new formats.
123 commit_formats_len
= ARRAY_SIZE(builtin_formats
);
124 builtin_formats_len
= commit_formats_len
;
125 ALLOC_GROW(commit_formats
, commit_formats_len
, commit_formats_alloc
);
126 COPY_ARRAY(commit_formats
, builtin_formats
,
127 ARRAY_SIZE(builtin_formats
));
129 git_config(git_pretty_formats_config
, NULL
);
132 static struct cmt_fmt_map
*find_commit_format_recursive(const char *sought
,
133 const char *original
,
134 int num_redirections
)
136 struct cmt_fmt_map
*found
= NULL
;
137 size_t found_match_len
= 0;
140 if (num_redirections
>= commit_formats_len
)
141 die("invalid --pretty format: "
142 "'%s' references an alias which points to itself",
145 for (i
= 0; i
< commit_formats_len
; i
++) {
148 if (!starts_with(commit_formats
[i
].name
, sought
))
151 match_len
= strlen(commit_formats
[i
].name
);
152 if (found
== NULL
|| found_match_len
> match_len
) {
153 found
= &commit_formats
[i
];
154 found_match_len
= match_len
;
158 if (found
&& found
->is_alias
) {
159 found
= find_commit_format_recursive(found
->user_format
,
167 static struct cmt_fmt_map
*find_commit_format(const char *sought
)
170 setup_commit_formats();
172 return find_commit_format_recursive(sought
, sought
, 0);
175 void get_commit_format(const char *arg
, struct rev_info
*rev
)
177 struct cmt_fmt_map
*commit_format
;
179 rev
->use_terminator
= 0;
181 rev
->commit_format
= CMIT_FMT_DEFAULT
;
184 if (skip_prefix(arg
, "format:", &arg
)) {
185 save_user_format(rev
, arg
, 0);
189 if (!*arg
|| skip_prefix(arg
, "tformat:", &arg
) || strchr(arg
, '%')) {
190 save_user_format(rev
, arg
, 1);
194 commit_format
= find_commit_format(arg
);
196 die("invalid --pretty format: %s", arg
);
198 rev
->commit_format
= commit_format
->format
;
199 rev
->use_terminator
= commit_format
->is_tformat
;
200 rev
->expand_tabs_in_log_default
= commit_format
->expand_tabs_in_log
;
201 if (!rev
->date_mode_explicit
&& commit_format
->default_date_mode_type
)
202 rev
->date_mode
.type
= commit_format
->default_date_mode_type
;
203 if (commit_format
->format
== CMIT_FMT_USERFORMAT
) {
204 save_user_format(rev
, commit_format
->user_format
,
205 commit_format
->is_tformat
);
210 * Generic support for pretty-printing the header
212 static int get_one_line(const char *msg
)
227 /* High bit set, or ISO-2022-INT */
228 static int non_ascii(int ch
)
230 return !isascii(ch
) || ch
== '\033';
233 int has_non_ascii(const char *s
)
238 while ((ch
= *s
++) != '\0') {
245 static int is_rfc822_special(char ch
)
267 static int needs_rfc822_quoting(const char *s
, int len
)
270 for (i
= 0; i
< len
; i
++)
271 if (is_rfc822_special(s
[i
]))
276 static int last_line_length(struct strbuf
*sb
)
280 /* How many bytes are already used on the last line? */
281 for (i
= sb
->len
- 1; i
>= 0; i
--)
282 if (sb
->buf
[i
] == '\n')
284 return sb
->len
- (i
+ 1);
287 static void add_rfc822_quoted(struct strbuf
*out
, const char *s
, int len
)
291 /* just a guess, we may have to also backslash-quote */
292 strbuf_grow(out
, len
+ 2);
294 strbuf_addch(out
, '"');
295 for (i
= 0; i
< len
; i
++) {
299 strbuf_addch(out
, '\\');
302 strbuf_addch(out
, s
[i
]);
305 strbuf_addch(out
, '"');
313 static int is_rfc2047_special(char ch
, enum rfc2047_type type
)
316 * rfc2047, section 4.2:
318 * 8-bit values which correspond to printable ASCII characters other
319 * than "=", "?", and "_" (underscore), MAY be represented as those
320 * characters. (But see section 5 for restrictions.) In
321 * particular, SPACE and TAB MUST NOT be represented as themselves
322 * within encoded words.
326 * rule out non-ASCII characters and non-printable characters (the
327 * non-ASCII check should be redundant as isprint() is not localized
328 * and only knows about ASCII, but be defensive about that)
330 if (non_ascii(ch
) || !isprint(ch
))
334 * rule out special printable characters (' ' should be the only
335 * whitespace character considered printable, but be defensive and use
338 if (isspace(ch
) || ch
== '=' || ch
== '?' || ch
== '_')
342 * rfc2047, section 5.3:
344 * As a replacement for a 'word' entity within a 'phrase', for example,
345 * one that precedes an address in a From, To, or Cc header. The ABNF
346 * definition for 'phrase' from RFC 822 thus becomes:
348 * phrase = 1*( encoded-word / word )
350 * In this case the set of characters that may be used in a "Q"-encoded
351 * 'encoded-word' is restricted to: <upper and lower case ASCII
352 * letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
353 * (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
354 * 'phrase' MUST be separated from any adjacent 'word', 'text' or
355 * 'special' by 'linear-white-space'.
358 if (type
!= RFC2047_ADDRESS
)
361 /* '=' and '_' are special cases and have been checked above */
362 return !(isalnum(ch
) || ch
== '!' || ch
== '*' || ch
== '+' || ch
== '-' || ch
== '/');
365 static int needs_rfc2047_encoding(const char *line
, int len
)
369 for (i
= 0; i
< len
; i
++) {
371 if (non_ascii(ch
) || ch
== '\n')
373 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
380 static void add_rfc2047(struct strbuf
*sb
, const char *line
, size_t len
,
381 const char *encoding
, enum rfc2047_type type
)
383 static const int max_encoded_length
= 76; /* per rfc2047 */
385 int line_len
= last_line_length(sb
);
387 strbuf_grow(sb
, len
* 3 + strlen(encoding
) + 100);
388 strbuf_addf(sb
, "=?%s?q?", encoding
);
389 line_len
+= strlen(encoding
) + 5; /* 5 for =??q? */
393 * RFC 2047, section 5 (3):
395 * Each 'encoded-word' MUST represent an integral number of
396 * characters. A multi-octet character may not be split across
397 * adjacent 'encoded- word's.
399 const unsigned char *p
= (const unsigned char *)line
;
400 int chrlen
= mbs_chrlen(&line
, &len
, encoding
);
401 int is_special
= (chrlen
> 1) || is_rfc2047_special(*p
, type
);
403 /* "=%02X" * chrlen, or the byte itself */
404 const char *encoded_fmt
= is_special
? "=%02X" : "%c";
405 int encoded_len
= is_special
? 3 * chrlen
: 1;
408 * According to RFC 2047, we could encode the special character
409 * ' ' (space) with '_' (underscore) for readability. But many
410 * programs do not understand this and just leave the
411 * underscore in place. Thus, we do nothing special here, which
412 * causes ' ' to be encoded as '=20', avoiding this problem.
415 if (line_len
+ encoded_len
+ 2 > max_encoded_length
) {
416 /* It won't fit with trailing "?=" --- break the line */
417 strbuf_addf(sb
, "?=\n =?%s?q?", encoding
);
418 line_len
= strlen(encoding
) + 5 + 1; /* =??q? plus SP */
421 for (i
= 0; i
< chrlen
; i
++)
422 strbuf_addf(sb
, encoded_fmt
, p
[i
]);
423 line_len
+= encoded_len
;
425 strbuf_addstr(sb
, "?=");
428 const char *show_ident_date(const struct ident_split
*ident
,
429 const struct date_mode
*mode
)
431 timestamp_t date
= 0;
434 if (ident
->date_begin
&& ident
->date_end
)
435 date
= parse_timestamp(ident
->date_begin
, NULL
, 10);
436 if (date_overflows(date
))
439 if (ident
->tz_begin
&& ident
->tz_end
)
440 tz
= strtol(ident
->tz_begin
, NULL
, 10);
441 if (tz
>= INT_MAX
|| tz
<= INT_MIN
)
444 return show_date(date
, tz
, mode
);
447 static inline void strbuf_add_with_color(struct strbuf
*sb
, const char *color
,
448 const char *buf
, size_t buflen
)
450 strbuf_addstr(sb
, color
);
451 strbuf_add(sb
, buf
, buflen
);
453 strbuf_addstr(sb
, GIT_COLOR_RESET
);
456 static void append_line_with_color(struct strbuf
*sb
, struct grep_opt
*opt
,
457 const char *line
, size_t linelen
,
458 int color
, enum grep_context ctx
,
459 enum grep_header_field field
)
461 const char *buf
, *eol
, *line_color
, *match_color
;
468 if (!opt
|| !want_color(color
) || opt
->invert
)
471 line_color
= opt
->colors
[GREP_COLOR_SELECTED
];
472 match_color
= opt
->colors
[GREP_COLOR_MATCH_SELECTED
];
474 while (grep_next_match(opt
, buf
, eol
, ctx
, &match
, field
, eflags
)) {
475 if (match
.rm_so
== match
.rm_eo
)
478 strbuf_add_with_color(sb
, line_color
, buf
, match
.rm_so
);
479 strbuf_add_with_color(sb
, match_color
, buf
+ match
.rm_so
,
480 match
.rm_eo
- match
.rm_so
);
486 strbuf_add_with_color(sb
, line_color
, buf
, eol
- buf
);
489 strbuf_add(sb
, buf
, eol
- buf
);
493 static int use_in_body_from(const struct pretty_print_context
*pp
,
494 const struct ident_split
*ident
)
496 if (pp
->rev
&& pp
->rev
->force_in_body_from
)
498 if (ident_cmp(pp
->from_ident
, ident
))
503 void pp_user_info(struct pretty_print_context
*pp
,
504 const char *what
, struct strbuf
*sb
,
505 const char *line
, const char *encoding
)
507 struct ident_split ident
;
509 const char *mailbuf
, *namebuf
;
510 size_t namelen
, maillen
;
511 int max_length
= 78; /* per rfc2822 */
513 if (pp
->fmt
== CMIT_FMT_ONELINE
)
516 line_end
= strchrnul(line
, '\n');
517 if (split_ident_line(&ident
, line
, line_end
- line
))
520 mailbuf
= ident
.mail_begin
;
521 maillen
= ident
.mail_end
- ident
.mail_begin
;
522 namebuf
= ident
.name_begin
;
523 namelen
= ident
.name_end
- ident
.name_begin
;
526 map_user(pp
->mailmap
, &mailbuf
, &maillen
, &namebuf
, &namelen
);
528 if (cmit_fmt_is_mail(pp
->fmt
)) {
529 if (pp
->from_ident
&& use_in_body_from(pp
, &ident
)) {
530 struct strbuf buf
= STRBUF_INIT
;
532 strbuf_addstr(&buf
, "From: ");
533 strbuf_add(&buf
, namebuf
, namelen
);
534 strbuf_addstr(&buf
, " <");
535 strbuf_add(&buf
, mailbuf
, maillen
);
536 strbuf_addstr(&buf
, ">\n");
537 string_list_append(&pp
->in_body_headers
,
538 strbuf_detach(&buf
, NULL
));
540 mailbuf
= pp
->from_ident
->mail_begin
;
541 maillen
= pp
->from_ident
->mail_end
- mailbuf
;
542 namebuf
= pp
->from_ident
->name_begin
;
543 namelen
= pp
->from_ident
->name_end
- namebuf
;
546 strbuf_addstr(sb
, "From: ");
547 if (pp
->encode_email_headers
&&
548 needs_rfc2047_encoding(namebuf
, namelen
)) {
549 add_rfc2047(sb
, namebuf
, namelen
,
550 encoding
, RFC2047_ADDRESS
);
551 max_length
= 76; /* per rfc2047 */
552 } else if (needs_rfc822_quoting(namebuf
, namelen
)) {
553 struct strbuf quoted
= STRBUF_INIT
;
554 add_rfc822_quoted("ed
, namebuf
, namelen
);
555 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
557 strbuf_release("ed
);
559 strbuf_add_wrapped_bytes(sb
, namebuf
, namelen
,
564 last_line_length(sb
) + strlen(" <") + maillen
+ strlen(">"))
565 strbuf_addch(sb
, '\n');
566 strbuf_addf(sb
, " <%.*s>\n", (int)maillen
, mailbuf
);
568 struct strbuf id
= STRBUF_INIT
;
569 enum grep_header_field field
= GREP_HEADER_FIELD_MAX
;
570 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
572 if (!strcmp(what
, "Author"))
573 field
= GREP_HEADER_AUTHOR
;
574 else if (!strcmp(what
, "Commit"))
575 field
= GREP_HEADER_COMMITTER
;
577 strbuf_addf(sb
, "%s: ", what
);
578 if (pp
->fmt
== CMIT_FMT_FULLER
)
579 strbuf_addchars(sb
, ' ', 4);
581 strbuf_addf(&id
, "%.*s <%.*s>", (int)namelen
, namebuf
,
582 (int)maillen
, mailbuf
);
584 append_line_with_color(sb
, opt
, id
.buf
, id
.len
, pp
->color
,
585 GREP_CONTEXT_HEAD
, field
);
586 strbuf_addch(sb
, '\n');
591 case CMIT_FMT_MEDIUM
:
592 strbuf_addf(sb
, "Date: %s\n",
593 show_ident_date(&ident
, &pp
->date_mode
));
596 case CMIT_FMT_MBOXRD
:
597 strbuf_addf(sb
, "Date: %s\n",
598 show_ident_date(&ident
, DATE_MODE(RFC2822
)));
600 case CMIT_FMT_FULLER
:
601 strbuf_addf(sb
, "%sDate: %s\n", what
,
602 show_ident_date(&ident
, &pp
->date_mode
));
610 static int is_blank_line(const char *line
, int *len_p
)
613 while (len
&& isspace(line
[len
- 1]))
619 const char *skip_blank_lines(const char *msg
)
622 int linelen
= get_one_line(msg
);
626 if (!is_blank_line(msg
, &ll
))
633 static void add_merge_info(const struct pretty_print_context
*pp
,
634 struct strbuf
*sb
, const struct commit
*commit
)
636 struct commit_list
*parent
= commit
->parents
;
638 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (cmit_fmt_is_mail(pp
->fmt
)) ||
639 !parent
|| !parent
->next
)
642 strbuf_addstr(sb
, "Merge:");
645 struct object_id
*oidp
= &parent
->item
->object
.oid
;
646 strbuf_addch(sb
, ' ');
648 strbuf_add_unique_abbrev(sb
, oidp
, pp
->abbrev
);
650 strbuf_addstr(sb
, oid_to_hex(oidp
));
651 parent
= parent
->next
;
653 strbuf_addch(sb
, '\n');
656 static char *get_header(const char *msg
, const char *key
)
659 const char *v
= find_commit_header(msg
, key
, &len
);
660 return v
? xmemdupz(v
, len
) : NULL
;
663 static char *replace_encoding_header(char *buf
, const char *encoding
)
665 struct strbuf tmp
= STRBUF_INIT
;
669 /* guess if there is an encoding header before a \n\n */
670 while (!starts_with(cp
, "encoding ")) {
671 cp
= strchr(cp
, '\n');
672 if (!cp
|| *++cp
== '\n')
676 cp
= strchr(cp
, '\n');
678 return buf
; /* should not happen but be defensive */
679 len
= cp
+ 1 - (buf
+ start
);
681 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
682 if (is_encoding_utf8(encoding
)) {
683 /* we have re-coded to UTF-8; drop the header */
684 strbuf_remove(&tmp
, start
, len
);
686 /* just replaces XXXX in 'encoding XXXX\n' */
687 strbuf_splice(&tmp
, start
+ strlen("encoding "),
688 len
- strlen("encoding \n"),
689 encoding
, strlen(encoding
));
691 return strbuf_detach(&tmp
, NULL
);
694 const char *repo_logmsg_reencode(struct repository
*r
,
695 const struct commit
*commit
,
696 char **commit_encoding
,
697 const char *output_encoding
)
699 static const char *utf8
= "UTF-8";
700 const char *use_encoding
;
702 const char *msg
= repo_get_commit_buffer(r
, commit
, NULL
);
705 if (!output_encoding
|| !*output_encoding
) {
707 *commit_encoding
= get_header(msg
, "encoding");
710 encoding
= get_header(msg
, "encoding");
712 *commit_encoding
= encoding
;
713 use_encoding
= encoding
? encoding
: utf8
;
714 if (same_encoding(use_encoding
, output_encoding
)) {
716 * No encoding work to be done. If we have no encoding header
717 * at all, then there's nothing to do, and we can return the
718 * message verbatim (whether newly allocated or not).
724 * Otherwise, we still want to munge the encoding header in the
725 * result, which will be done by modifying the buffer. If we
726 * are using a fresh copy, we can reuse it. But if we are using
727 * the cached copy from repo_get_commit_buffer, we need to duplicate it
728 * to avoid munging the cached copy.
730 if (msg
== get_cached_commit_buffer(r
, commit
, NULL
))
737 * There's actual encoding work to do. Do the reencoding, which
738 * still leaves the header to be replaced in the next step. At
739 * this point, we are done with msg. If we allocated a fresh
740 * copy, we can free it.
742 out
= reencode_string(msg
, output_encoding
, use_encoding
);
744 repo_unuse_commit_buffer(r
, commit
, msg
);
748 * This replacement actually consumes the buffer we hand it, so we do
749 * not have to worry about freeing the old "out" here.
752 out
= replace_encoding_header(out
, output_encoding
);
754 if (!commit_encoding
)
757 * If the re-encoding failed, out might be NULL here; in that
758 * case we just return the commit message verbatim.
760 return out
? out
: msg
;
763 static int mailmap_name(const char **email
, size_t *email_len
,
764 const char **name
, size_t *name_len
)
766 static struct string_list
*mail_map
;
768 CALLOC_ARRAY(mail_map
, 1);
769 read_mailmap(mail_map
);
771 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
774 static size_t format_person_part(struct strbuf
*sb
, char part
,
775 const char *msg
, int len
,
776 const struct date_mode
*dmode
)
778 /* currently all placeholders have same length */
779 const int placeholder_len
= 2;
780 struct ident_split s
;
781 const char *name
, *mail
;
782 size_t maillen
, namelen
;
784 if (split_ident_line(&s
, msg
, len
) < 0)
788 namelen
= s
.name_end
- s
.name_begin
;
790 maillen
= s
.mail_end
- s
.mail_begin
;
792 if (part
== 'N' || part
== 'E' || part
== 'L') /* mailmap lookup */
793 mailmap_name(&mail
, &maillen
, &name
, &namelen
);
794 if (part
== 'n' || part
== 'N') { /* name */
795 strbuf_add(sb
, name
, namelen
);
796 return placeholder_len
;
798 if (part
== 'e' || part
== 'E') { /* email */
799 strbuf_add(sb
, mail
, maillen
);
800 return placeholder_len
;
802 if (part
== 'l' || part
== 'L') { /* local-part */
803 const char *at
= memchr(mail
, '@', maillen
);
806 strbuf_add(sb
, mail
, maillen
);
807 return placeholder_len
;
813 if (part
== 't') { /* date, UNIX timestamp */
814 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
815 return placeholder_len
;
820 strbuf_addstr(sb
, show_ident_date(&s
, dmode
));
821 return placeholder_len
;
822 case 'D': /* date, RFC2822 style */
823 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(RFC2822
)));
824 return placeholder_len
;
825 case 'r': /* date, relative */
826 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(RELATIVE
)));
827 return placeholder_len
;
828 case 'i': /* date, ISO 8601-like */
829 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(ISO8601
)));
830 return placeholder_len
;
831 case 'I': /* date, ISO 8601 strict */
832 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(ISO8601_STRICT
)));
833 return placeholder_len
;
834 case 'h': /* date, human */
835 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(HUMAN
)));
836 return placeholder_len
;
838 strbuf_addstr(sb
, show_ident_date(&s
, DATE_MODE(SHORT
)));
839 return placeholder_len
;
844 * reading from either a bogus commit, or a reflog entry with
845 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
846 * to compute a valid return value.
848 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
849 || part
== 'D' || part
== 'r' || part
== 'i')
850 return placeholder_len
;
852 return 0; /* unknown placeholder */
864 flush_left_and_steal
,
875 struct format_commit_context
{
876 struct repository
*repository
;
877 const struct commit
*commit
;
878 const struct pretty_print_context
*pretty_ctx
;
879 unsigned commit_header_parsed
:1;
880 unsigned commit_message_parsed
:1;
881 struct signature_check signature_check
;
882 enum flush_type flush_type
;
883 enum trunc_type truncate
;
885 char *commit_encoding
;
886 size_t width
, indent1
, indent2
;
890 /* These offsets are relative to the start of the commit message. */
892 struct chunk committer
;
897 /* The following ones are relative to the result struct strbuf. */
901 static void parse_commit_header(struct format_commit_context
*context
)
903 const char *msg
= context
->message
;
906 for (i
= 0; msg
[i
]; i
++) {
909 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
914 } else if (skip_prefix(msg
+ i
, "author ", &name
)) {
915 context
->author
.off
= name
- msg
;
916 context
->author
.len
= msg
+ eol
- name
;
917 } else if (skip_prefix(msg
+ i
, "committer ", &name
)) {
918 context
->committer
.off
= name
- msg
;
919 context
->committer
.len
= msg
+ eol
- name
;
923 context
->message_off
= i
;
924 context
->commit_header_parsed
= 1;
927 static int istitlechar(char c
)
929 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
930 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
933 void format_sanitized_subject(struct strbuf
*sb
, const char *msg
, size_t len
)
936 size_t start_len
= sb
->len
;
940 for (i
= 0; i
< len
; i
++) {
941 if (istitlechar(msg
[i
])) {
943 strbuf_addch(sb
, '-');
945 strbuf_addch(sb
, msg
[i
]);
947 while (msg
[i
+1] == '.')
953 /* trim any trailing '.' or '-' characters */
955 while (sb
->len
- trimlen
> start_len
&&
956 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
957 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
959 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
962 const char *format_subject(struct strbuf
*sb
, const char *msg
,
963 const char *line_separator
)
968 const char *line
= msg
;
969 int linelen
= get_one_line(line
);
972 if (!linelen
|| is_blank_line(line
, &linelen
))
977 strbuf_grow(sb
, linelen
+ 2);
979 strbuf_addstr(sb
, line_separator
);
980 strbuf_add(sb
, line
, linelen
);
986 static void parse_commit_message(struct format_commit_context
*c
)
988 const char *msg
= c
->message
+ c
->message_off
;
989 const char *start
= c
->message
;
991 msg
= skip_blank_lines(msg
);
992 c
->subject_off
= msg
- start
;
994 msg
= format_subject(NULL
, msg
, NULL
);
995 msg
= skip_blank_lines(msg
);
996 c
->body_off
= msg
- start
;
998 c
->commit_message_parsed
= 1;
1001 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
1002 size_t width
, size_t indent1
, size_t indent2
)
1004 struct strbuf tmp
= STRBUF_INIT
;
1007 strbuf_add(&tmp
, sb
->buf
, pos
);
1008 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
1009 cast_size_t_to_int(indent1
),
1010 cast_size_t_to_int(indent2
),
1011 cast_size_t_to_int(width
));
1012 strbuf_swap(&tmp
, sb
);
1013 strbuf_release(&tmp
);
1016 static void rewrap_message_tail(struct strbuf
*sb
,
1017 struct format_commit_context
*c
,
1018 size_t new_width
, size_t new_indent1
,
1021 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
1022 c
->indent2
== new_indent2
)
1024 if (c
->wrap_start
< sb
->len
)
1025 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
1026 c
->wrap_start
= sb
->len
;
1027 c
->width
= new_width
;
1028 c
->indent1
= new_indent1
;
1029 c
->indent2
= new_indent2
;
1032 static int format_reflog_person(struct strbuf
*sb
,
1034 struct reflog_walk_info
*log
,
1035 const struct date_mode
*dmode
)
1042 ident
= get_reflog_ident(log
);
1046 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
1049 static size_t parse_color(struct strbuf
*sb
, /* in UTF-8 */
1050 const char *placeholder
,
1051 struct format_commit_context
*c
)
1053 const char *rest
= placeholder
;
1054 const char *basic_color
= NULL
;
1056 if (placeholder
[1] == '(') {
1057 const char *begin
= placeholder
+ 2;
1058 const char *end
= strchr(begin
, ')');
1059 char color
[COLOR_MAXLEN
];
1064 if (skip_prefix(begin
, "auto,", &begin
)) {
1065 if (!want_color(c
->pretty_ctx
->color
))
1066 return end
- placeholder
+ 1;
1067 } else if (skip_prefix(begin
, "always,", &begin
)) {
1068 /* nothing to do; we do not respect want_color at all */
1070 /* the default is the same as "auto" */
1071 if (!want_color(c
->pretty_ctx
->color
))
1072 return end
- placeholder
+ 1;
1075 if (color_parse_mem(begin
, end
- begin
, color
) < 0)
1076 die(_("unable to parse --pretty format"));
1077 strbuf_addstr(sb
, color
);
1078 return end
- placeholder
+ 1;
1082 * We handle things like "%C(red)" above; for historical reasons, there
1083 * are a few colors that can be specified without parentheses (and
1084 * they cannot support things like "auto" or "always" at all).
1086 if (skip_prefix(placeholder
+ 1, "red", &rest
))
1087 basic_color
= GIT_COLOR_RED
;
1088 else if (skip_prefix(placeholder
+ 1, "green", &rest
))
1089 basic_color
= GIT_COLOR_GREEN
;
1090 else if (skip_prefix(placeholder
+ 1, "blue", &rest
))
1091 basic_color
= GIT_COLOR_BLUE
;
1092 else if (skip_prefix(placeholder
+ 1, "reset", &rest
))
1093 basic_color
= GIT_COLOR_RESET
;
1095 if (basic_color
&& want_color(c
->pretty_ctx
->color
))
1096 strbuf_addstr(sb
, basic_color
);
1098 return rest
- placeholder
;
1101 static size_t parse_padding_placeholder(const char *placeholder
,
1102 struct format_commit_context
*c
)
1104 const char *ch
= placeholder
;
1105 enum flush_type flush_type
;
1110 flush_type
= flush_right
;
1114 flush_type
= flush_both
;
1116 } else if (*ch
== '>') {
1117 flush_type
= flush_left_and_steal
;
1120 flush_type
= flush_left
;
1126 /* the next value means "wide enough to that column" */
1133 const char *start
= ch
+ 1;
1134 const char *end
= start
+ strcspn(start
, ",)");
1137 if (!*end
|| end
== start
)
1139 width
= strtol(start
, &next
, 10);
1142 * We need to limit the amount of padding, or otherwise this
1143 * would allow the user to pad the buffer by arbitrarily many
1144 * bytes and thus cause resource exhaustion.
1146 if (width
< -FORMATTING_LIMIT
|| width
> FORMATTING_LIMIT
)
1149 if (next
== start
|| width
== 0)
1153 width
+= term_columns();
1157 c
->padding
= to_column
? -width
: width
;
1158 c
->flush_type
= flush_type
;
1162 end
= strchr(start
, ')');
1163 if (!end
|| end
== start
)
1165 if (starts_with(start
, "trunc)"))
1166 c
->truncate
= trunc_right
;
1167 else if (starts_with(start
, "ltrunc)"))
1168 c
->truncate
= trunc_left
;
1169 else if (starts_with(start
, "mtrunc)"))
1170 c
->truncate
= trunc_middle
;
1174 c
->truncate
= trunc_none
;
1176 return end
- placeholder
+ 1;
1181 static int match_placeholder_arg_value(const char *to_parse
, const char *candidate
,
1182 const char **end
, const char **valuestart
,
1187 if (!(skip_prefix(to_parse
, candidate
, &p
)))
1191 *valuestart
= p
+ 1;
1192 *valuelen
= strcspn(*valuestart
, ",)");
1193 p
= *valuestart
+ *valuelen
;
1195 if (*p
!= ',' && *p
!= ')')
1212 static int match_placeholder_bool_arg(const char *to_parse
, const char *candidate
,
1213 const char **end
, int *val
)
1220 if (!match_placeholder_arg_value(to_parse
, candidate
, end
, &argval
, &arglen
))
1228 strval
= xstrndup(argval
, arglen
);
1229 v
= git_parse_maybe_bool(strval
);
1240 static int format_trailer_match_cb(const struct strbuf
*key
, void *ud
)
1242 const struct string_list
*list
= ud
;
1243 const struct string_list_item
*item
;
1245 for_each_string_list_item (item
, list
) {
1246 if (key
->len
== (uintptr_t)item
->util
&&
1247 !strncasecmp(item
->string
, key
->buf
, key
->len
))
1253 static struct strbuf
*expand_separator(struct strbuf
*sb
,
1254 const char *argval
, size_t arglen
)
1256 char *fmt
= xstrndup(argval
, arglen
);
1259 strbuf_expand(sb
, fmt
, strbuf_expand_literal_cb
, NULL
);
1264 int format_set_trailers_options(struct process_trailer_options
*opts
,
1265 struct string_list
*filter_list
,
1266 struct strbuf
*sepbuf
,
1267 struct strbuf
*kvsepbuf
,
1278 if (match_placeholder_arg_value(*arg
, "key", arg
, &argval
, &arglen
)) {
1279 uintptr_t len
= arglen
;
1284 if (len
&& argval
[len
- 1] == ':')
1286 string_list_append(filter_list
, argval
)->util
= (char *)len
;
1288 opts
->filter
= format_trailer_match_cb
;
1289 opts
->filter_data
= filter_list
;
1290 opts
->only_trailers
= 1;
1291 } else if (match_placeholder_arg_value(*arg
, "separator", arg
, &argval
, &arglen
)) {
1292 opts
->separator
= expand_separator(sepbuf
, argval
, arglen
);
1293 } else if (match_placeholder_arg_value(*arg
, "key_value_separator", arg
, &argval
, &arglen
)) {
1294 opts
->key_value_separator
= expand_separator(kvsepbuf
, argval
, arglen
);
1295 } else if (!match_placeholder_bool_arg(*arg
, "only", arg
, &opts
->only_trailers
) &&
1296 !match_placeholder_bool_arg(*arg
, "unfold", arg
, &opts
->unfold
) &&
1297 !match_placeholder_bool_arg(*arg
, "keyonly", arg
, &opts
->key_only
) &&
1298 !match_placeholder_bool_arg(*arg
, "valueonly", arg
, &opts
->value_only
)) {
1300 size_t len
= strcspn(*arg
, ",)");
1301 *invalid_arg
= xstrndup(*arg
, len
);
1309 static size_t parse_describe_args(const char *start
, struct strvec
*args
)
1315 DESCRIBE_ARG_INTEGER
,
1316 DESCRIBE_ARG_STRING
,
1319 { "tags", DESCRIBE_ARG_BOOL
},
1320 { "abbrev", DESCRIBE_ARG_INTEGER
},
1321 { "exclude", DESCRIBE_ARG_STRING
},
1322 { "match", DESCRIBE_ARG_STRING
},
1324 const char *arg
= start
;
1333 for (i
= 0; !found
&& i
< ARRAY_SIZE(option
); i
++) {
1334 switch (option
[i
].type
) {
1335 case DESCRIBE_ARG_BOOL
:
1336 if (match_placeholder_bool_arg(arg
, option
[i
].name
, &arg
, &optval
)) {
1338 strvec_pushf(args
, "--%s", option
[i
].name
);
1340 strvec_pushf(args
, "--no-%s", option
[i
].name
);
1344 case DESCRIBE_ARG_INTEGER
:
1345 if (match_placeholder_arg_value(arg
, option
[i
].name
, &arg
,
1346 &argval
, &arglen
)) {
1350 strtol(argval
, &endptr
, 10);
1351 if (endptr
- argval
!= arglen
)
1353 strvec_pushf(args
, "--%s=%.*s", option
[i
].name
, (int)arglen
, argval
);
1357 case DESCRIBE_ARG_STRING
:
1358 if (match_placeholder_arg_value(arg
, option
[i
].name
, &arg
,
1359 &argval
, &arglen
)) {
1362 strvec_pushf(args
, "--%s=%.*s", option
[i
].name
, (int)arglen
, argval
);
1375 static size_t format_commit_one(struct strbuf
*sb
, /* in UTF-8 */
1376 const char *placeholder
,
1379 struct format_commit_context
*c
= context
;
1380 const struct commit
*commit
= c
->commit
;
1381 const char *msg
= c
->message
;
1382 struct commit_list
*p
;
1383 const char *arg
, *eol
;
1387 /* these are independent of the commit */
1388 res
= strbuf_expand_literal_cb(sb
, placeholder
, NULL
);
1392 switch (placeholder
[0]) {
1394 if (starts_with(placeholder
+ 1, "(auto)")) {
1395 c
->auto_color
= want_color(c
->pretty_ctx
->color
);
1396 if (c
->auto_color
&& sb
->len
)
1397 strbuf_addstr(sb
, GIT_COLOR_RESET
);
1398 return 7; /* consumed 7 bytes, "C(auto)" */
1400 int ret
= parse_color(sb
, placeholder
, c
);
1404 * Otherwise, we decided to treat %C<unknown>
1405 * as a literal string, and the previous
1406 * %C(auto) is still valid.
1411 if (placeholder
[1] == '(') {
1412 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1414 const char *start
= placeholder
+ 2;
1415 const char *end
= strchr(start
, ')');
1419 width
= strtoul(start
, &next
, 10);
1421 indent1
= strtoul(next
+ 1, &next
, 10);
1423 indent2
= strtoul(next
+ 1,
1432 * We need to limit the format here as it allows the
1433 * user to prepend arbitrarily many bytes to the buffer
1436 if (width
> FORMATTING_LIMIT
||
1437 indent1
> FORMATTING_LIMIT
||
1438 indent2
> FORMATTING_LIMIT
)
1440 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1441 return end
- placeholder
+ 1;
1447 return parse_padding_placeholder(placeholder
, c
);
1450 if (skip_prefix(placeholder
, "(describe", &arg
)) {
1451 struct child_process cmd
= CHILD_PROCESS_INIT
;
1452 struct strbuf out
= STRBUF_INIT
;
1453 struct strbuf err
= STRBUF_INIT
;
1454 struct pretty_print_describe_status
*describe_status
;
1456 describe_status
= c
->pretty_ctx
->describe_status
;
1457 if (describe_status
) {
1458 if (!describe_status
->max_invocations
)
1460 describe_status
->max_invocations
--;
1464 strvec_push(&cmd
.args
, "describe");
1468 arg
+= parse_describe_args(arg
, &cmd
.args
);
1472 child_process_clear(&cmd
);
1476 strvec_push(&cmd
.args
, oid_to_hex(&commit
->object
.oid
));
1477 pipe_command(&cmd
, NULL
, 0, &out
, 0, &err
, 0);
1479 strbuf_addbuf(sb
, &out
);
1480 strbuf_release(&out
);
1481 strbuf_release(&err
);
1482 return arg
- placeholder
+ 1;
1485 /* these depend on the commit */
1486 if (!commit
->object
.parsed
)
1487 parse_object(the_repository
, &commit
->object
.oid
);
1489 switch (placeholder
[0]) {
1490 case 'H': /* commit hash */
1491 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1492 strbuf_addstr(sb
, oid_to_hex(&commit
->object
.oid
));
1493 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1495 case 'h': /* abbreviated commit hash */
1496 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1497 strbuf_add_unique_abbrev(sb
, &commit
->object
.oid
,
1498 c
->pretty_ctx
->abbrev
);
1499 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1501 case 'T': /* tree hash */
1502 strbuf_addstr(sb
, oid_to_hex(get_commit_tree_oid(commit
)));
1504 case 't': /* abbreviated tree hash */
1505 strbuf_add_unique_abbrev(sb
,
1506 get_commit_tree_oid(commit
),
1507 c
->pretty_ctx
->abbrev
);
1509 case 'P': /* parent hashes */
1510 for (p
= commit
->parents
; p
; p
= p
->next
) {
1511 if (p
!= commit
->parents
)
1512 strbuf_addch(sb
, ' ');
1513 strbuf_addstr(sb
, oid_to_hex(&p
->item
->object
.oid
));
1516 case 'p': /* abbreviated parent hashes */
1517 for (p
= commit
->parents
; p
; p
= p
->next
) {
1518 if (p
!= commit
->parents
)
1519 strbuf_addch(sb
, ' ');
1520 strbuf_add_unique_abbrev(sb
, &p
->item
->object
.oid
,
1521 c
->pretty_ctx
->abbrev
);
1524 case 'm': /* left/right/bottom */
1525 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1528 format_decorations(sb
, commit
, c
->auto_color
);
1531 format_decorations_extended(sb
, commit
, c
->auto_color
, "", ", ", "");
1533 case 'S': /* tag/branch like --source */
1534 if (!(c
->pretty_ctx
->rev
&& c
->pretty_ctx
->rev
->sources
))
1536 slot
= revision_sources_at(c
->pretty_ctx
->rev
->sources
, commit
);
1537 if (!(slot
&& *slot
))
1539 strbuf_addstr(sb
, *slot
);
1541 case 'g': /* reflog info */
1542 switch(placeholder
[1]) {
1543 case 'd': /* reflog selector */
1545 if (c
->pretty_ctx
->reflog_info
)
1546 get_reflog_selector(sb
,
1547 c
->pretty_ctx
->reflog_info
,
1548 &c
->pretty_ctx
->date_mode
,
1549 c
->pretty_ctx
->date_mode_explicit
,
1550 (placeholder
[1] == 'd'));
1552 case 's': /* reflog message */
1553 if (c
->pretty_ctx
->reflog_info
)
1554 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1560 return format_reflog_person(sb
,
1562 c
->pretty_ctx
->reflog_info
,
1563 &c
->pretty_ctx
->date_mode
);
1565 return 0; /* unknown %g placeholder */
1567 if (c
->pretty_ctx
->notes_message
) {
1568 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1574 if (placeholder
[0] == 'G') {
1575 if (!c
->signature_check
.result
)
1576 check_commit_signature(c
->commit
, &(c
->signature_check
));
1577 switch (placeholder
[1]) {
1579 if (c
->signature_check
.output
)
1580 strbuf_addstr(sb
, c
->signature_check
.output
);
1583 switch (c
->signature_check
.result
) {
1585 switch (c
->signature_check
.trust_level
) {
1586 case TRUST_UNDEFINED
:
1588 strbuf_addch(sb
, 'U');
1591 strbuf_addch(sb
, 'G');
1601 strbuf_addch(sb
, c
->signature_check
.result
);
1605 if (c
->signature_check
.signer
)
1606 strbuf_addstr(sb
, c
->signature_check
.signer
);
1609 if (c
->signature_check
.key
)
1610 strbuf_addstr(sb
, c
->signature_check
.key
);
1613 if (c
->signature_check
.fingerprint
)
1614 strbuf_addstr(sb
, c
->signature_check
.fingerprint
);
1617 if (c
->signature_check
.primary_key_fingerprint
)
1618 strbuf_addstr(sb
, c
->signature_check
.primary_key_fingerprint
);
1621 strbuf_addstr(sb
, gpg_trust_level_to_str(c
->signature_check
.trust_level
));
1629 /* For the rest we have to parse the commit header. */
1630 if (!c
->commit_header_parsed
) {
1632 repo_logmsg_reencode(c
->repository
, commit
,
1633 &c
->commit_encoding
, "UTF-8");
1634 parse_commit_header(c
);
1637 switch (placeholder
[0]) {
1638 case 'a': /* author ... */
1639 return format_person_part(sb
, placeholder
[1],
1640 msg
+ c
->author
.off
, c
->author
.len
,
1641 &c
->pretty_ctx
->date_mode
);
1642 case 'c': /* committer ... */
1643 return format_person_part(sb
, placeholder
[1],
1644 msg
+ c
->committer
.off
, c
->committer
.len
,
1645 &c
->pretty_ctx
->date_mode
);
1646 case 'e': /* encoding */
1647 if (c
->commit_encoding
)
1648 strbuf_addstr(sb
, c
->commit_encoding
);
1650 case 'B': /* raw body */
1651 /* message_off is always left at the initial newline */
1652 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1656 /* Now we need to parse the commit message. */
1657 if (!c
->commit_message_parsed
)
1658 parse_commit_message(c
);
1660 switch (placeholder
[0]) {
1661 case 's': /* subject */
1662 format_subject(sb
, msg
+ c
->subject_off
, " ");
1664 case 'f': /* sanitized subject */
1665 eol
= strchrnul(msg
+ c
->subject_off
, '\n');
1666 format_sanitized_subject(sb
, msg
+ c
->subject_off
, eol
- (msg
+ c
->subject_off
));
1668 case 'b': /* body */
1669 strbuf_addstr(sb
, msg
+ c
->body_off
);
1673 if (skip_prefix(placeholder
, "(trailers", &arg
)) {
1674 struct process_trailer_options opts
= PROCESS_TRAILER_OPTIONS_INIT
;
1675 struct string_list filter_list
= STRING_LIST_INIT_NODUP
;
1676 struct strbuf sepbuf
= STRBUF_INIT
;
1677 struct strbuf kvsepbuf
= STRBUF_INIT
;
1680 opts
.no_divider
= 1;
1684 if (format_set_trailers_options(&opts
, &filter_list
, &sepbuf
, &kvsepbuf
, &arg
, NULL
))
1688 format_trailers_from_commit(sb
, msg
+ c
->subject_off
, &opts
);
1689 ret
= arg
- placeholder
+ 1;
1692 string_list_clear(&filter_list
, 0);
1693 strbuf_release(&sepbuf
);
1697 return 0; /* unknown placeholder */
1700 static size_t format_and_pad_commit(struct strbuf
*sb
, /* in UTF-8 */
1701 const char *placeholder
,
1702 struct format_commit_context
*c
)
1704 struct strbuf local_sb
= STRBUF_INIT
;
1705 size_t total_consumed
= 0;
1706 int len
, padding
= c
->padding
;
1709 const char *start
= strrchr(sb
->buf
, '\n');
1713 occupied
= utf8_strnwidth(start
, strlen(start
), 1);
1714 occupied
+= c
->pretty_ctx
->graph_width
;
1715 padding
= (-padding
) - occupied
;
1718 int modifier
= *placeholder
== 'C';
1719 size_t consumed
= format_commit_one(&local_sb
, placeholder
, c
);
1720 total_consumed
+= consumed
;
1725 placeholder
+= consumed
;
1726 if (*placeholder
!= '%')
1731 len
= utf8_strnwidth(local_sb
.buf
, local_sb
.len
, 1);
1733 if (c
->flush_type
== flush_left_and_steal
) {
1734 const char *ch
= sb
->buf
+ sb
->len
- 1;
1735 while (len
> padding
&& ch
> sb
->buf
) {
1742 /* check for trailing ansi sequences */
1746 while (p
> sb
->buf
&& ch
- p
< 10 && *p
!= '\033')
1749 ch
+ 1 - p
!= display_mode_esc_sequence_len(p
))
1752 * got a good ansi sequence, put it back to
1753 * local_sb as we're cutting sb
1755 strbuf_insert(&local_sb
, 0, p
, ch
+ 1 - p
);
1758 strbuf_setlen(sb
, ch
+ 1 - sb
->buf
);
1759 c
->flush_type
= flush_left
;
1762 if (len
> padding
) {
1763 switch (c
->truncate
) {
1765 strbuf_utf8_replace(&local_sb
,
1766 0, len
- (padding
- 2),
1770 strbuf_utf8_replace(&local_sb
,
1772 len
- (padding
- 2),
1776 strbuf_utf8_replace(&local_sb
,
1777 padding
- 2, len
- (padding
- 2),
1783 strbuf_addbuf(sb
, &local_sb
);
1785 size_t sb_len
= sb
->len
, offset
= 0;
1786 if (c
->flush_type
== flush_left
)
1787 offset
= padding
- len
;
1788 else if (c
->flush_type
== flush_both
)
1789 offset
= (padding
- len
) / 2;
1791 * we calculate padding in columns, now
1792 * convert it back to chars
1794 padding
= padding
- len
+ local_sb
.len
;
1795 strbuf_addchars(sb
, ' ', padding
);
1796 memcpy(sb
->buf
+ sb_len
+ offset
, local_sb
.buf
,
1799 strbuf_release(&local_sb
);
1800 c
->flush_type
= no_flush
;
1801 return total_consumed
;
1804 static size_t format_commit_item(struct strbuf
*sb
, /* in UTF-8 */
1805 const char *placeholder
,
1808 size_t consumed
, orig_len
;
1811 ADD_LF_BEFORE_NON_EMPTY
,
1812 DEL_LF_BEFORE_EMPTY
,
1813 ADD_SP_BEFORE_NON_EMPTY
1816 switch (placeholder
[0]) {
1818 magic
= DEL_LF_BEFORE_EMPTY
;
1821 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1824 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1829 if (magic
!= NO_MAGIC
) {
1832 switch (placeholder
[0]) {
1835 * `%+w()` cannot ever expand to a non-empty string,
1836 * and it potentially changes the layout of preceding
1837 * contents. We're thus not able to handle the magic in
1838 * this combination and refuse the pattern.
1845 if (((struct format_commit_context
*)context
)->flush_type
!= no_flush
)
1846 consumed
= format_and_pad_commit(sb
, placeholder
, context
);
1848 consumed
= format_commit_one(sb
, placeholder
, context
);
1849 if (magic
== NO_MAGIC
)
1852 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1853 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1854 strbuf_setlen(sb
, sb
->len
- 1);
1855 } else if (orig_len
!= sb
->len
) {
1856 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1857 strbuf_insertstr(sb
, orig_len
, "\n");
1858 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1859 strbuf_insertstr(sb
, orig_len
, " ");
1861 return consumed
+ 1;
1864 static size_t userformat_want_item(struct strbuf
*sb UNUSED
,
1865 const char *placeholder
,
1868 struct userformat_want
*w
= context
;
1870 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1873 switch (*placeholder
) {
1888 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1890 struct strbuf dummy
= STRBUF_INIT
;
1897 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1898 strbuf_release(&dummy
);
1901 void repo_format_commit_message(struct repository
*r
,
1902 const struct commit
*commit
,
1903 const char *format
, struct strbuf
*sb
,
1904 const struct pretty_print_context
*pretty_ctx
)
1906 struct format_commit_context context
= {
1909 .pretty_ctx
= pretty_ctx
,
1910 .wrap_start
= sb
->len
1912 const char *output_enc
= pretty_ctx
->output_encoding
;
1913 const char *utf8
= "UTF-8";
1915 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1916 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1919 * Convert output to an actual output encoding; note that
1920 * format_commit_item() will always use UTF-8, so we don't
1921 * have to bother if that's what the output wants.
1924 if (same_encoding(utf8
, output_enc
))
1927 if (context
.commit_encoding
&&
1928 !same_encoding(context
.commit_encoding
, utf8
))
1929 output_enc
= context
.commit_encoding
;
1934 char *out
= reencode_string_len(sb
->buf
, sb
->len
,
1935 output_enc
, utf8
, &outsz
);
1937 strbuf_attach(sb
, out
, outsz
, outsz
+ 1);
1940 free(context
.commit_encoding
);
1941 repo_unuse_commit_buffer(r
, commit
, context
.message
);
1944 static void pp_header(struct pretty_print_context
*pp
,
1945 const char *encoding
,
1946 const struct commit
*commit
,
1950 int parents_shown
= 0;
1953 const char *name
, *line
= *msg_p
;
1954 int linelen
= get_one_line(*msg_p
);
1964 if (pp
->fmt
== CMIT_FMT_RAW
) {
1965 strbuf_add(sb
, line
, linelen
);
1969 if (starts_with(line
, "parent ")) {
1970 if (linelen
!= the_hash_algo
->hexsz
+ 8)
1971 die("bad parent line in commit");
1975 if (!parents_shown
) {
1976 unsigned num
= commit_list_count(commit
->parents
);
1977 /* with enough slop */
1978 strbuf_grow(sb
, num
* (GIT_MAX_HEXSZ
+ 10) + 20);
1979 add_merge_info(pp
, sb
, commit
);
1984 * MEDIUM == DEFAULT shows only author with dates.
1985 * FULL shows both authors but not dates.
1986 * FULLER shows both authors and dates.
1988 if (skip_prefix(line
, "author ", &name
)) {
1989 strbuf_grow(sb
, linelen
+ 80);
1990 pp_user_info(pp
, "Author", sb
, name
, encoding
);
1992 if (skip_prefix(line
, "committer ", &name
) &&
1993 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1994 strbuf_grow(sb
, linelen
+ 80);
1995 pp_user_info(pp
, "Commit", sb
, name
, encoding
);
2000 void pp_title_line(struct pretty_print_context
*pp
,
2003 const char *encoding
,
2006 static const int max_length
= 78; /* per rfc2047 */
2007 struct strbuf title
;
2009 strbuf_init(&title
, 80);
2010 *msg_p
= format_subject(&title
, *msg_p
,
2011 pp
->preserve_subject
? "\n" : " ");
2013 strbuf_grow(sb
, title
.len
+ 1024);
2014 if (pp
->print_email_subject
) {
2016 fmt_output_email_subject(sb
, pp
->rev
);
2017 if (pp
->encode_email_headers
&&
2018 needs_rfc2047_encoding(title
.buf
, title
.len
))
2019 add_rfc2047(sb
, title
.buf
, title
.len
,
2020 encoding
, RFC2047_SUBJECT
);
2022 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
2023 -last_line_length(sb
), 1, max_length
);
2025 strbuf_addbuf(sb
, &title
);
2027 strbuf_addch(sb
, '\n');
2029 if (need_8bit_cte
== 0) {
2031 for (i
= 0; i
< pp
->in_body_headers
.nr
; i
++) {
2032 if (has_non_ascii(pp
->in_body_headers
.items
[i
].string
)) {
2039 if (need_8bit_cte
> 0) {
2040 const char *header_fmt
=
2041 "MIME-Version: 1.0\n"
2042 "Content-Type: text/plain; charset=%s\n"
2043 "Content-Transfer-Encoding: 8bit\n";
2044 strbuf_addf(sb
, header_fmt
, encoding
);
2046 if (pp
->after_subject
) {
2047 strbuf_addstr(sb
, pp
->after_subject
);
2049 if (cmit_fmt_is_mail(pp
->fmt
)) {
2050 strbuf_addch(sb
, '\n');
2053 if (pp
->in_body_headers
.nr
) {
2055 for (i
= 0; i
< pp
->in_body_headers
.nr
; i
++) {
2056 strbuf_addstr(sb
, pp
->in_body_headers
.items
[i
].string
);
2057 free(pp
->in_body_headers
.items
[i
].string
);
2059 string_list_clear(&pp
->in_body_headers
, 0);
2060 strbuf_addch(sb
, '\n');
2063 strbuf_release(&title
);
2066 static int pp_utf8_width(const char *start
, const char *end
)
2069 size_t remain
= end
- start
;
2072 int n
= utf8_width(&start
, &remain
);
2073 if (n
< 0 || !start
)
2080 static void strbuf_add_tabexpand(struct strbuf
*sb
, struct grep_opt
*opt
,
2081 int color
, int tabwidth
, const char *line
,
2086 while ((tab
= memchr(line
, '\t', linelen
)) != NULL
) {
2087 int width
= pp_utf8_width(line
, tab
);
2090 * If it wasn't well-formed utf8, or it
2091 * had characters with badly defined
2092 * width (control characters etc), just
2093 * give up on trying to align things.
2098 /* Output the data .. */
2099 append_line_with_color(sb
, opt
, line
, tab
- line
, color
,
2101 GREP_HEADER_FIELD_MAX
);
2103 /* .. and the de-tabified tab */
2104 strbuf_addchars(sb
, ' ', tabwidth
- (width
% tabwidth
));
2106 /* Skip over the printed part .. */
2107 linelen
-= tab
+ 1 - line
;
2112 * Print out everything after the last tab without
2113 * worrying about width - there's nothing more to
2116 append_line_with_color(sb
, opt
, line
, linelen
, color
, GREP_CONTEXT_BODY
,
2117 GREP_HEADER_FIELD_MAX
);
2121 * pp_handle_indent() prints out the intendation, and
2122 * the whole line (without the final newline), after
2125 static void pp_handle_indent(struct pretty_print_context
*pp
,
2126 struct strbuf
*sb
, int indent
,
2127 const char *line
, int linelen
)
2129 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
2131 strbuf_addchars(sb
, ' ', indent
);
2132 if (pp
->expand_tabs_in_log
)
2133 strbuf_add_tabexpand(sb
, opt
, pp
->color
, pp
->expand_tabs_in_log
,
2136 append_line_with_color(sb
, opt
, line
, linelen
, pp
->color
,
2138 GREP_HEADER_FIELD_MAX
);
2141 static int is_mboxrd_from(const char *line
, int len
)
2144 * a line matching /^From $/ here would only have len == 4
2145 * at this point because is_empty_line would've trimmed all
2148 return len
> 4 && starts_with(line
+ strspn(line
, ">"), "From ");
2151 void pp_remainder(struct pretty_print_context
*pp
,
2156 struct grep_opt
*opt
= pp
->rev
? &pp
->rev
->grep_filter
: NULL
;
2160 const char *line
= *msg_p
;
2161 int linelen
= get_one_line(line
);
2167 if (is_blank_line(line
, &linelen
)) {
2170 if (pp
->fmt
== CMIT_FMT_SHORT
)
2175 strbuf_grow(sb
, linelen
+ indent
+ 20);
2177 pp_handle_indent(pp
, sb
, indent
, line
, linelen
);
2178 else if (pp
->expand_tabs_in_log
)
2179 strbuf_add_tabexpand(sb
, opt
, pp
->color
,
2180 pp
->expand_tabs_in_log
, line
,
2183 if (pp
->fmt
== CMIT_FMT_MBOXRD
&&
2184 is_mboxrd_from(line
, linelen
))
2185 strbuf_addch(sb
, '>');
2187 append_line_with_color(sb
, opt
, line
, linelen
,
2188 pp
->color
, GREP_CONTEXT_BODY
,
2189 GREP_HEADER_FIELD_MAX
);
2191 strbuf_addch(sb
, '\n');
2195 void pretty_print_commit(struct pretty_print_context
*pp
,
2196 const struct commit
*commit
,
2199 unsigned long beginning_of_body
;
2202 const char *reencoded
;
2203 const char *encoding
;
2204 int need_8bit_cte
= pp
->need_8bit_cte
;
2206 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
2207 repo_format_commit_message(the_repository
, commit
,
2208 user_format
, sb
, pp
);
2212 encoding
= get_log_output_encoding();
2213 msg
= reencoded
= repo_logmsg_reencode(the_repository
, commit
, NULL
,
2216 if (pp
->fmt
== CMIT_FMT_ONELINE
|| cmit_fmt_is_mail(pp
->fmt
))
2220 * We need to check and emit Content-type: to mark it
2221 * as 8-bit if we haven't done so.
2223 if (cmit_fmt_is_mail(pp
->fmt
) && need_8bit_cte
== 0) {
2226 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
2228 /* author could be non 7-bit ASCII but
2229 * the log may be so; skip over the
2230 * header part first.
2232 if (ch
== '\n' && msg
[i
+1] == '\n')
2235 else if (non_ascii(ch
)) {
2242 pp_header(pp
, encoding
, commit
, &msg
, sb
);
2243 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->print_email_subject
) {
2244 strbuf_addch(sb
, '\n');
2247 /* Skip excess blank lines at the beginning of body, if any... */
2248 msg
= skip_blank_lines(msg
);
2250 /* These formats treat the title line specially. */
2251 if (pp
->fmt
== CMIT_FMT_ONELINE
|| cmit_fmt_is_mail(pp
->fmt
))
2252 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
2254 beginning_of_body
= sb
->len
;
2255 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
2256 pp_remainder(pp
, &msg
, sb
, indent
);
2259 /* Make sure there is an EOLN for the non-oneline case */
2260 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
2261 strbuf_addch(sb
, '\n');
2264 * The caller may append additional body text in e-mail
2265 * format. Make sure we did not strip the blank line
2266 * between the header and the body.
2268 if (cmit_fmt_is_mail(pp
->fmt
) && sb
->len
<= beginning_of_body
)
2269 strbuf_addch(sb
, '\n');
2271 repo_unuse_commit_buffer(the_repository
, commit
, reencoded
);
2274 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
2277 struct pretty_print_context pp
= {0};
2279 pretty_print_commit(&pp
, commit
, sb
);