6 #include "string-list.h"
11 #include "reflog-walk.h"
12 #include "gpg-interface.h"
14 static char *user_format
;
15 static struct cmt_fmt_map
{
20 const char *user_format
;
22 static size_t builtin_formats_len
;
23 static size_t commit_formats_len
;
24 static size_t commit_formats_alloc
;
25 static struct cmt_fmt_map
*find_commit_format(const char *sought
);
27 static void save_user_format(struct rev_info
*rev
, const char *cp
, int is_tformat
)
30 user_format
= xstrdup(cp
);
32 rev
->use_terminator
= 1;
33 rev
->commit_format
= CMIT_FMT_USERFORMAT
;
36 static int git_pretty_formats_config(const char *var
, const char *value
, void *cb
)
38 struct cmt_fmt_map
*commit_format
= NULL
;
43 if (prefixcmp(var
, "pretty."))
46 name
= var
+ strlen("pretty.");
47 for (i
= 0; i
< builtin_formats_len
; i
++) {
48 if (!strcmp(commit_formats
[i
].name
, name
))
52 for (i
= builtin_formats_len
; i
< commit_formats_len
; i
++) {
53 if (!strcmp(commit_formats
[i
].name
, name
)) {
54 commit_format
= &commit_formats
[i
];
60 ALLOC_GROW(commit_formats
, commit_formats_len
+1,
61 commit_formats_alloc
);
62 commit_format
= &commit_formats
[commit_formats_len
];
63 memset(commit_format
, 0, sizeof(*commit_format
));
67 commit_format
->name
= xstrdup(name
);
68 commit_format
->format
= CMIT_FMT_USERFORMAT
;
69 git_config_string(&fmt
, var
, value
);
70 if (!prefixcmp(fmt
, "format:") || !prefixcmp(fmt
, "tformat:")) {
71 commit_format
->is_tformat
= fmt
[0] == 't';
72 fmt
= strchr(fmt
, ':') + 1;
73 } else if (strchr(fmt
, '%'))
74 commit_format
->is_tformat
= 1;
76 commit_format
->is_alias
= 1;
77 commit_format
->user_format
= fmt
;
82 static void setup_commit_formats(void)
84 struct cmt_fmt_map builtin_formats
[] = {
85 { "raw", CMIT_FMT_RAW
, 0 },
86 { "medium", CMIT_FMT_MEDIUM
, 0 },
87 { "short", CMIT_FMT_SHORT
, 0 },
88 { "email", CMIT_FMT_EMAIL
, 0 },
89 { "fuller", CMIT_FMT_FULLER
, 0 },
90 { "full", CMIT_FMT_FULL
, 0 },
91 { "oneline", CMIT_FMT_ONELINE
, 1 }
93 commit_formats_len
= ARRAY_SIZE(builtin_formats
);
94 builtin_formats_len
= commit_formats_len
;
95 ALLOC_GROW(commit_formats
, commit_formats_len
, commit_formats_alloc
);
96 memcpy(commit_formats
, builtin_formats
,
97 sizeof(*builtin_formats
)*ARRAY_SIZE(builtin_formats
));
99 git_config(git_pretty_formats_config
, NULL
);
102 static struct cmt_fmt_map
*find_commit_format_recursive(const char *sought
,
103 const char *original
,
104 int num_redirections
)
106 struct cmt_fmt_map
*found
= NULL
;
107 size_t found_match_len
= 0;
110 if (num_redirections
>= commit_formats_len
)
111 die("invalid --pretty format: "
112 "'%s' references an alias which points to itself",
115 for (i
= 0; i
< commit_formats_len
; i
++) {
118 if (prefixcmp(commit_formats
[i
].name
, sought
))
121 match_len
= strlen(commit_formats
[i
].name
);
122 if (found
== NULL
|| found_match_len
> match_len
) {
123 found
= &commit_formats
[i
];
124 found_match_len
= match_len
;
128 if (found
&& found
->is_alias
) {
129 found
= find_commit_format_recursive(found
->user_format
,
137 static struct cmt_fmt_map
*find_commit_format(const char *sought
)
140 setup_commit_formats();
142 return find_commit_format_recursive(sought
, sought
, 0);
145 void get_commit_format(const char *arg
, struct rev_info
*rev
)
147 struct cmt_fmt_map
*commit_format
;
149 rev
->use_terminator
= 0;
151 rev
->commit_format
= CMIT_FMT_DEFAULT
;
154 if (!prefixcmp(arg
, "format:") || !prefixcmp(arg
, "tformat:")) {
155 save_user_format(rev
, strchr(arg
, ':') + 1, arg
[0] == 't');
159 if (strchr(arg
, '%')) {
160 save_user_format(rev
, arg
, 1);
164 commit_format
= find_commit_format(arg
);
166 die("invalid --pretty format: %s", arg
);
168 rev
->commit_format
= commit_format
->format
;
169 rev
->use_terminator
= commit_format
->is_tformat
;
170 if (commit_format
->format
== CMIT_FMT_USERFORMAT
) {
171 save_user_format(rev
, commit_format
->user_format
,
172 commit_format
->is_tformat
);
177 * Generic support for pretty-printing the header
179 static int get_one_line(const char *msg
)
194 /* High bit set, or ISO-2022-INT */
195 static int non_ascii(int ch
)
197 return !isascii(ch
) || ch
== '\033';
200 int has_non_ascii(const char *s
)
205 while ((ch
= *s
++) != '\0') {
212 static int is_rfc822_special(char ch
)
234 static int needs_rfc822_quoting(const char *s
, int len
)
237 for (i
= 0; i
< len
; i
++)
238 if (is_rfc822_special(s
[i
]))
243 static int last_line_length(struct strbuf
*sb
)
247 /* How many bytes are already used on the last line? */
248 for (i
= sb
->len
- 1; i
>= 0; i
--)
249 if (sb
->buf
[i
] == '\n')
251 return sb
->len
- (i
+ 1);
254 static void add_rfc822_quoted(struct strbuf
*out
, const char *s
, int len
)
258 /* just a guess, we may have to also backslash-quote */
259 strbuf_grow(out
, len
+ 2);
261 strbuf_addch(out
, '"');
262 for (i
= 0; i
< len
; i
++) {
266 strbuf_addch(out
, '\\');
269 strbuf_addch(out
, s
[i
]);
272 strbuf_addch(out
, '"');
280 static int is_rfc2047_special(char ch
, enum rfc2047_type type
)
283 * rfc2047, section 4.2:
285 * 8-bit values which correspond to printable ASCII characters other
286 * than "=", "?", and "_" (underscore), MAY be represented as those
287 * characters. (But see section 5 for restrictions.) In
288 * particular, SPACE and TAB MUST NOT be represented as themselves
289 * within encoded words.
293 * rule out non-ASCII characters and non-printable characters (the
294 * non-ASCII check should be redundant as isprint() is not localized
295 * and only knows about ASCII, but be defensive about that)
297 if (non_ascii(ch
) || !isprint(ch
))
301 * rule out special printable characters (' ' should be the only
302 * whitespace character considered printable, but be defensive and use
305 if (isspace(ch
) || ch
== '=' || ch
== '?' || ch
== '_')
309 * rfc2047, section 5.3:
311 * As a replacement for a 'word' entity within a 'phrase', for example,
312 * one that precedes an address in a From, To, or Cc header. The ABNF
313 * definition for 'phrase' from RFC 822 thus becomes:
315 * phrase = 1*( encoded-word / word )
317 * In this case the set of characters that may be used in a "Q"-encoded
318 * 'encoded-word' is restricted to: <upper and lower case ASCII
319 * letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
320 * (underscore, ASCII 95.)>. An 'encoded-word' that appears within a
321 * 'phrase' MUST be separated from any adjacent 'word', 'text' or
322 * 'special' by 'linear-white-space'.
325 if (type
!= RFC2047_ADDRESS
)
328 /* '=' and '_' are special cases and have been checked above */
329 return !(isalnum(ch
) || ch
== '!' || ch
== '*' || ch
== '+' || ch
== '-' || ch
== '/');
332 static int needs_rfc2047_encoding(const char *line
, int len
,
333 enum rfc2047_type type
)
337 for (i
= 0; i
< len
; i
++) {
339 if (non_ascii(ch
) || ch
== '\n')
341 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
348 static void add_rfc2047(struct strbuf
*sb
, const char *line
, size_t len
,
349 const char *encoding
, enum rfc2047_type type
)
351 static const int max_encoded_length
= 76; /* per rfc2047 */
353 int line_len
= last_line_length(sb
);
355 strbuf_grow(sb
, len
* 3 + strlen(encoding
) + 100);
356 strbuf_addf(sb
, "=?%s?q?", encoding
);
357 line_len
+= strlen(encoding
) + 5; /* 5 for =??q? */
361 * RFC 2047, section 5 (3):
363 * Each 'encoded-word' MUST represent an integral number of
364 * characters. A multi-octet character may not be split across
365 * adjacent 'encoded- word's.
367 const unsigned char *p
= (const unsigned char *)line
;
368 int chrlen
= mbs_chrlen(&line
, &len
, encoding
);
369 int is_special
= (chrlen
> 1) || is_rfc2047_special(*p
, type
);
371 /* "=%02X" * chrlen, or the byte itself */
372 const char *encoded_fmt
= is_special
? "=%02X" : "%c";
373 int encoded_len
= is_special
? 3 * chrlen
: 1;
376 * According to RFC 2047, we could encode the special character
377 * ' ' (space) with '_' (underscore) for readability. But many
378 * programs do not understand this and just leave the
379 * underscore in place. Thus, we do nothing special here, which
380 * causes ' ' to be encoded as '=20', avoiding this problem.
383 if (line_len
+ encoded_len
+ 2 > max_encoded_length
) {
384 /* It won't fit with trailing "?=" --- break the line */
385 strbuf_addf(sb
, "?=\n =?%s?q?", encoding
);
386 line_len
= strlen(encoding
) + 5 + 1; /* =??q? plus SP */
389 for (i
= 0; i
< chrlen
; i
++)
390 strbuf_addf(sb
, encoded_fmt
, p
[i
]);
391 line_len
+= encoded_len
;
393 strbuf_addstr(sb
, "?=");
396 static const char *show_ident_date(const struct ident_split
*ident
,
399 unsigned long date
= 0;
402 if (ident
->date_begin
&& ident
->date_end
)
403 date
= strtoul(ident
->date_begin
, NULL
, 10);
404 if (ident
->tz_begin
&& ident
->tz_end
)
405 tz
= strtol(ident
->tz_begin
, NULL
, 10);
406 return show_date(date
, tz
, mode
);
409 void pp_user_info(struct pretty_print_context
*pp
,
410 const char *what
, struct strbuf
*sb
,
411 const char *line
, const char *encoding
)
413 struct ident_split ident
;
415 const char *mailbuf
, *namebuf
;
416 size_t namelen
, maillen
;
417 int max_length
= 78; /* per rfc2822 */
419 if (pp
->fmt
== CMIT_FMT_ONELINE
)
422 line_end
= strchrnul(line
, '\n');
423 if (split_ident_line(&ident
, line
, line_end
- line
))
426 mailbuf
= ident
.mail_begin
;
427 maillen
= ident
.mail_end
- ident
.mail_begin
;
428 namebuf
= ident
.name_begin
;
429 namelen
= ident
.name_end
- ident
.name_begin
;
432 map_user(pp
->mailmap
, &mailbuf
, &maillen
, &namebuf
, &namelen
);
434 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
435 strbuf_addstr(sb
, "From: ");
436 if (needs_rfc2047_encoding(namebuf
, namelen
, RFC2047_ADDRESS
)) {
437 add_rfc2047(sb
, namebuf
, namelen
,
438 encoding
, RFC2047_ADDRESS
);
439 max_length
= 76; /* per rfc2047 */
440 } else if (needs_rfc822_quoting(namebuf
, namelen
)) {
441 struct strbuf quoted
= STRBUF_INIT
;
442 add_rfc822_quoted("ed
, namebuf
, namelen
);
443 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
445 strbuf_release("ed
);
447 strbuf_add_wrapped_bytes(sb
, namebuf
, namelen
,
452 last_line_length(sb
) + strlen(" <") + maillen
+ strlen(">"))
453 strbuf_addch(sb
, '\n');
454 strbuf_addf(sb
, " <%.*s>\n", (int)maillen
, mailbuf
);
456 strbuf_addf(sb
, "%s: %.*s%.*s <%.*s>\n", what
,
457 (pp
->fmt
== CMIT_FMT_FULLER
) ? 4 : 0, " ",
458 (int)namelen
, namebuf
, (int)maillen
, mailbuf
);
462 case CMIT_FMT_MEDIUM
:
463 strbuf_addf(sb
, "Date: %s\n",
464 show_ident_date(&ident
, pp
->date_mode
));
467 strbuf_addf(sb
, "Date: %s\n",
468 show_ident_date(&ident
, DATE_RFC2822
));
470 case CMIT_FMT_FULLER
:
471 strbuf_addf(sb
, "%sDate: %s\n", what
,
472 show_ident_date(&ident
, pp
->date_mode
));
480 static int is_empty_line(const char *line
, int *len_p
)
483 while (len
&& isspace(line
[len
-1]))
489 static const char *skip_empty_lines(const char *msg
)
492 int linelen
= get_one_line(msg
);
496 if (!is_empty_line(msg
, &ll
))
503 static void add_merge_info(const struct pretty_print_context
*pp
,
504 struct strbuf
*sb
, const struct commit
*commit
)
506 struct commit_list
*parent
= commit
->parents
;
508 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (pp
->fmt
== CMIT_FMT_EMAIL
) ||
509 !parent
|| !parent
->next
)
512 strbuf_addstr(sb
, "Merge:");
515 struct commit
*p
= parent
->item
;
516 const char *hex
= NULL
;
518 hex
= find_unique_abbrev(p
->object
.sha1
, pp
->abbrev
);
520 hex
= sha1_to_hex(p
->object
.sha1
);
521 parent
= parent
->next
;
523 strbuf_addf(sb
, " %s", hex
);
525 strbuf_addch(sb
, '\n');
528 static char *get_header(const struct commit
*commit
, const char *msg
,
531 int key_len
= strlen(key
);
532 const char *line
= msg
;
535 const char *eol
= strchr(line
, '\n'), *next
;
540 warning("malformed commit (header is missing newline): %s",
541 sha1_to_hex(commit
->object
.sha1
));
542 eol
= line
+ strlen(line
);
546 if (eol
- line
> key_len
&&
547 !strncmp(line
, key
, key_len
) &&
548 line
[key_len
] == ' ') {
549 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
556 static char *replace_encoding_header(char *buf
, const char *encoding
)
558 struct strbuf tmp
= STRBUF_INIT
;
562 /* guess if there is an encoding header before a \n\n */
563 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
564 cp
= strchr(cp
, '\n');
565 if (!cp
|| *++cp
== '\n')
569 cp
= strchr(cp
, '\n');
571 return buf
; /* should not happen but be defensive */
572 len
= cp
+ 1 - (buf
+ start
);
574 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
575 if (is_encoding_utf8(encoding
)) {
576 /* we have re-coded to UTF-8; drop the header */
577 strbuf_remove(&tmp
, start
, len
);
579 /* just replaces XXXX in 'encoding XXXX\n' */
580 strbuf_splice(&tmp
, start
+ strlen("encoding "),
581 len
- strlen("encoding \n"),
582 encoding
, strlen(encoding
));
584 return strbuf_detach(&tmp
, NULL
);
587 char *logmsg_reencode(const struct commit
*commit
,
588 char **commit_encoding
,
589 const char *output_encoding
)
591 static const char *utf8
= "UTF-8";
592 const char *use_encoding
;
594 char *msg
= commit
->buffer
;
598 enum object_type type
;
601 msg
= read_sha1_file(commit
->object
.sha1
, &type
, &size
);
603 die("Cannot read commit object %s",
604 sha1_to_hex(commit
->object
.sha1
));
605 if (type
!= OBJ_COMMIT
)
606 die("Expected commit for '%s', got %s",
607 sha1_to_hex(commit
->object
.sha1
), typename(type
));
610 if (!output_encoding
|| !*output_encoding
) {
613 get_header(commit
, msg
, "encoding");
616 encoding
= get_header(commit
, msg
, "encoding");
618 *commit_encoding
= encoding
;
619 use_encoding
= encoding
? encoding
: utf8
;
620 if (same_encoding(use_encoding
, output_encoding
)) {
622 * No encoding work to be done. If we have no encoding header
623 * at all, then there's nothing to do, and we can return the
624 * message verbatim (whether newly allocated or not).
630 * Otherwise, we still want to munge the encoding header in the
631 * result, which will be done by modifying the buffer. If we
632 * are using a fresh copy, we can reuse it. But if we are using
633 * the cached copy from commit->buffer, we need to duplicate it
634 * to avoid munging commit->buffer.
637 if (out
== commit
->buffer
)
642 * There's actual encoding work to do. Do the reencoding, which
643 * still leaves the header to be replaced in the next step. At
644 * this point, we are done with msg. If we allocated a fresh
645 * copy, we can free it.
647 out
= reencode_string(msg
, output_encoding
, use_encoding
);
648 if (out
&& msg
!= commit
->buffer
)
653 * This replacement actually consumes the buffer we hand it, so we do
654 * not have to worry about freeing the old "out" here.
657 out
= replace_encoding_header(out
, output_encoding
);
659 if (!commit_encoding
)
662 * If the re-encoding failed, out might be NULL here; in that
663 * case we just return the commit message verbatim.
665 return out
? out
: msg
;
668 void logmsg_free(char *msg
, const struct commit
*commit
)
670 if (msg
!= commit
->buffer
)
674 static int mailmap_name(const char **email
, size_t *email_len
,
675 const char **name
, size_t *name_len
)
677 static struct string_list
*mail_map
;
679 mail_map
= xcalloc(1, sizeof(*mail_map
));
680 read_mailmap(mail_map
, NULL
);
682 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
685 static size_t format_person_part(struct strbuf
*sb
, char part
,
686 const char *msg
, int len
, enum date_mode dmode
)
688 /* currently all placeholders have same length */
689 const int placeholder_len
= 2;
690 struct ident_split s
;
691 const char *name
, *mail
;
692 size_t maillen
, namelen
;
694 if (split_ident_line(&s
, msg
, len
) < 0)
698 namelen
= s
.name_end
- s
.name_begin
;
700 maillen
= s
.mail_end
- s
.mail_begin
;
702 if (part
== 'N' || part
== 'E') /* mailmap lookup */
703 mailmap_name(&mail
, &maillen
, &name
, &namelen
);
704 if (part
== 'n' || part
== 'N') { /* name */
705 strbuf_add(sb
, name
, namelen
);
706 return placeholder_len
;
708 if (part
== 'e' || part
== 'E') { /* email */
709 strbuf_add(sb
, mail
, maillen
);
710 return placeholder_len
;
716 if (part
== 't') { /* date, UNIX timestamp */
717 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
718 return placeholder_len
;
723 strbuf_addstr(sb
, show_ident_date(&s
, dmode
));
724 return placeholder_len
;
725 case 'D': /* date, RFC2822 style */
726 strbuf_addstr(sb
, show_ident_date(&s
, DATE_RFC2822
));
727 return placeholder_len
;
728 case 'r': /* date, relative */
729 strbuf_addstr(sb
, show_ident_date(&s
, DATE_RELATIVE
));
730 return placeholder_len
;
731 case 'i': /* date, ISO 8601 */
732 strbuf_addstr(sb
, show_ident_date(&s
, DATE_ISO8601
));
733 return placeholder_len
;
738 * reading from either a bogus commit, or a reflog entry with
739 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
740 * to compute a valid return value.
742 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
743 || part
== 'D' || part
== 'r' || part
== 'i')
744 return placeholder_len
;
746 return 0; /* unknown placeholder */
758 flush_left_and_steal
,
769 struct format_commit_context
{
770 const struct commit
*commit
;
771 const struct pretty_print_context
*pretty_ctx
;
772 unsigned commit_header_parsed
:1;
773 unsigned commit_message_parsed
:1;
774 struct signature_check signature_check
;
775 enum flush_type flush_type
;
776 enum trunc_type truncate
;
778 char *commit_encoding
;
779 size_t width
, indent1
, indent2
;
783 /* These offsets are relative to the start of the commit message. */
785 struct chunk committer
;
790 /* The following ones are relative to the result struct strbuf. */
791 struct chunk abbrev_commit_hash
;
792 struct chunk abbrev_tree_hash
;
793 struct chunk abbrev_parent_hashes
;
797 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
800 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
805 * We haven't seen this chunk before. Our caller is surely
806 * going to add it the hard way now. Remember the most likely
807 * start of the to-be-added chunk: the current end of the
810 chunk
->off
= sb
->len
;
814 static void parse_commit_header(struct format_commit_context
*context
)
816 const char *msg
= context
->message
;
819 for (i
= 0; msg
[i
]; i
++) {
821 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
826 } else if (!prefixcmp(msg
+ i
, "author ")) {
827 context
->author
.off
= i
+ 7;
828 context
->author
.len
= eol
- i
- 7;
829 } else if (!prefixcmp(msg
+ i
, "committer ")) {
830 context
->committer
.off
= i
+ 10;
831 context
->committer
.len
= eol
- i
- 10;
835 context
->message_off
= i
;
836 context
->commit_header_parsed
= 1;
839 static int istitlechar(char c
)
841 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
842 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
845 static void format_sanitized_subject(struct strbuf
*sb
, const char *msg
)
848 size_t start_len
= sb
->len
;
851 for (; *msg
&& *msg
!= '\n'; msg
++) {
852 if (istitlechar(*msg
)) {
854 strbuf_addch(sb
, '-');
856 strbuf_addch(sb
, *msg
);
858 while (*(msg
+1) == '.')
864 /* trim any trailing '.' or '-' characters */
866 while (sb
->len
- trimlen
> start_len
&&
867 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
868 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
870 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
873 const char *format_subject(struct strbuf
*sb
, const char *msg
,
874 const char *line_separator
)
879 const char *line
= msg
;
880 int linelen
= get_one_line(line
);
883 if (!linelen
|| is_empty_line(line
, &linelen
))
888 strbuf_grow(sb
, linelen
+ 2);
890 strbuf_addstr(sb
, line_separator
);
891 strbuf_add(sb
, line
, linelen
);
897 static void parse_commit_message(struct format_commit_context
*c
)
899 const char *msg
= c
->message
+ c
->message_off
;
900 const char *start
= c
->message
;
902 msg
= skip_empty_lines(msg
);
903 c
->subject_off
= msg
- start
;
905 msg
= format_subject(NULL
, msg
, NULL
);
906 msg
= skip_empty_lines(msg
);
907 c
->body_off
= msg
- start
;
909 c
->commit_message_parsed
= 1;
912 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
913 size_t width
, size_t indent1
, size_t indent2
)
915 struct strbuf tmp
= STRBUF_INIT
;
918 strbuf_add(&tmp
, sb
->buf
, pos
);
919 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
920 (int) indent1
, (int) indent2
, (int) width
);
921 strbuf_swap(&tmp
, sb
);
922 strbuf_release(&tmp
);
925 static void rewrap_message_tail(struct strbuf
*sb
,
926 struct format_commit_context
*c
,
927 size_t new_width
, size_t new_indent1
,
930 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
931 c
->indent2
== new_indent2
)
933 if (c
->wrap_start
< sb
->len
)
934 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
935 c
->wrap_start
= sb
->len
;
936 c
->width
= new_width
;
937 c
->indent1
= new_indent1
;
938 c
->indent2
= new_indent2
;
941 static int format_reflog_person(struct strbuf
*sb
,
943 struct reflog_walk_info
*log
,
944 enum date_mode dmode
)
951 ident
= get_reflog_ident(log
);
955 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
958 static size_t parse_color(struct strbuf
*sb
, /* in UTF-8 */
959 const char *placeholder
,
960 struct format_commit_context
*c
)
962 if (placeholder
[1] == '(') {
963 const char *begin
= placeholder
+ 2;
964 const char *end
= strchr(begin
, ')');
965 char color
[COLOR_MAXLEN
];
969 if (!prefixcmp(begin
, "auto,")) {
970 if (!want_color(c
->pretty_ctx
->color
))
971 return end
- placeholder
+ 1;
974 color_parse_mem(begin
,
976 "--pretty format", color
);
977 strbuf_addstr(sb
, color
);
978 return end
- placeholder
+ 1;
980 if (!prefixcmp(placeholder
+ 1, "red")) {
981 strbuf_addstr(sb
, GIT_COLOR_RED
);
983 } else if (!prefixcmp(placeholder
+ 1, "green")) {
984 strbuf_addstr(sb
, GIT_COLOR_GREEN
);
986 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
987 strbuf_addstr(sb
, GIT_COLOR_BLUE
);
989 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
990 strbuf_addstr(sb
, GIT_COLOR_RESET
);
996 static size_t parse_padding_placeholder(struct strbuf
*sb
,
997 const char *placeholder
,
998 struct format_commit_context
*c
)
1000 const char *ch
= placeholder
;
1001 enum flush_type flush_type
;
1006 flush_type
= flush_right
;
1010 flush_type
= flush_both
;
1012 } else if (*ch
== '>') {
1013 flush_type
= flush_left_and_steal
;
1016 flush_type
= flush_left
;
1022 /* the next value means "wide enough to that column" */
1029 const char *start
= ch
+ 1;
1030 const char *end
= start
+ strcspn(start
, ",)");
1033 if (!end
|| end
== start
)
1035 width
= strtoul(start
, &next
, 10);
1036 if (next
== start
|| width
== 0)
1038 c
->padding
= to_column
? -width
: width
;
1039 c
->flush_type
= flush_type
;
1043 end
= strchr(start
, ')');
1044 if (!end
|| end
== start
)
1046 if (!prefixcmp(start
, "trunc)"))
1047 c
->truncate
= trunc_right
;
1048 else if (!prefixcmp(start
, "ltrunc)"))
1049 c
->truncate
= trunc_left
;
1050 else if (!prefixcmp(start
, "mtrunc)"))
1051 c
->truncate
= trunc_middle
;
1055 c
->truncate
= trunc_none
;
1057 return end
- placeholder
+ 1;
1062 static size_t format_commit_one(struct strbuf
*sb
, /* in UTF-8 */
1063 const char *placeholder
,
1066 struct format_commit_context
*c
= context
;
1067 const struct commit
*commit
= c
->commit
;
1068 const char *msg
= c
->message
;
1069 struct commit_list
*p
;
1072 /* these are independent of the commit */
1073 switch (placeholder
[0]) {
1075 if (!prefixcmp(placeholder
+ 1, "(auto)")) {
1077 return 7; /* consumed 7 bytes, "C(auto)" */
1079 int ret
= parse_color(sb
, placeholder
, c
);
1083 * Otherwise, we decided to treat %C<unknown>
1084 * as a literal string, and the previous
1085 * %C(auto) is still valid.
1089 case 'n': /* newline */
1090 strbuf_addch(sb
, '\n');
1093 /* %x00 == NUL, %x0a == LF, etc. */
1094 if (0 <= (h1
= hexval_table
[0xff & placeholder
[1]]) &&
1096 0 <= (h2
= hexval_table
[0xff & placeholder
[2]]) &&
1098 strbuf_addch(sb
, (h1
<<4)|h2
);
1103 if (placeholder
[1] == '(') {
1104 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1106 const char *start
= placeholder
+ 2;
1107 const char *end
= strchr(start
, ')');
1111 width
= strtoul(start
, &next
, 10);
1113 indent1
= strtoul(next
+ 1, &next
, 10);
1115 indent2
= strtoul(next
+ 1,
1122 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1123 return end
- placeholder
+ 1;
1129 return parse_padding_placeholder(sb
, placeholder
, c
);
1132 /* these depend on the commit */
1133 if (!commit
->object
.parsed
)
1134 parse_object(commit
->object
.sha1
);
1136 switch (placeholder
[0]) {
1137 case 'H': /* commit hash */
1138 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1139 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
1140 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1142 case 'h': /* abbreviated commit hash */
1143 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_COMMIT
));
1144 if (add_again(sb
, &c
->abbrev_commit_hash
)) {
1145 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1148 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
1149 c
->pretty_ctx
->abbrev
));
1150 strbuf_addstr(sb
, diff_get_color(c
->auto_color
, DIFF_RESET
));
1151 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
1153 case 'T': /* tree hash */
1154 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
1156 case 't': /* abbreviated tree hash */
1157 if (add_again(sb
, &c
->abbrev_tree_hash
))
1159 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
1160 c
->pretty_ctx
->abbrev
));
1161 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
1163 case 'P': /* parent hashes */
1164 for (p
= commit
->parents
; p
; p
= p
->next
) {
1165 if (p
!= commit
->parents
)
1166 strbuf_addch(sb
, ' ');
1167 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
1170 case 'p': /* abbreviated parent hashes */
1171 if (add_again(sb
, &c
->abbrev_parent_hashes
))
1173 for (p
= commit
->parents
; p
; p
= p
->next
) {
1174 if (p
!= commit
->parents
)
1175 strbuf_addch(sb
, ' ');
1176 strbuf_addstr(sb
, find_unique_abbrev(
1177 p
->item
->object
.sha1
,
1178 c
->pretty_ctx
->abbrev
));
1180 c
->abbrev_parent_hashes
.len
= sb
->len
-
1181 c
->abbrev_parent_hashes
.off
;
1183 case 'm': /* left/right/bottom */
1184 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1187 load_ref_decorations(DECORATE_SHORT_REFS
);
1188 format_decorations(sb
, commit
, c
->auto_color
);
1190 case 'g': /* reflog info */
1191 switch(placeholder
[1]) {
1192 case 'd': /* reflog selector */
1194 if (c
->pretty_ctx
->reflog_info
)
1195 get_reflog_selector(sb
,
1196 c
->pretty_ctx
->reflog_info
,
1197 c
->pretty_ctx
->date_mode
,
1198 c
->pretty_ctx
->date_mode_explicit
,
1199 (placeholder
[1] == 'd'));
1201 case 's': /* reflog message */
1202 if (c
->pretty_ctx
->reflog_info
)
1203 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1209 return format_reflog_person(sb
,
1211 c
->pretty_ctx
->reflog_info
,
1212 c
->pretty_ctx
->date_mode
);
1214 return 0; /* unknown %g placeholder */
1216 if (c
->pretty_ctx
->notes_message
) {
1217 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1223 if (placeholder
[0] == 'G') {
1224 if (!c
->signature_check
.result
)
1225 check_commit_signature(c
->commit
, &(c
->signature_check
));
1226 switch (placeholder
[1]) {
1228 if (c
->signature_check
.gpg_output
)
1229 strbuf_addstr(sb
, c
->signature_check
.gpg_output
);
1232 switch (c
->signature_check
.result
) {
1237 strbuf_addch(sb
, c
->signature_check
.result
);
1241 if (c
->signature_check
.signer
)
1242 strbuf_addstr(sb
, c
->signature_check
.signer
);
1245 if (c
->signature_check
.key
)
1246 strbuf_addstr(sb
, c
->signature_check
.key
);
1253 /* For the rest we have to parse the commit header. */
1254 if (!c
->commit_header_parsed
)
1255 parse_commit_header(c
);
1257 switch (placeholder
[0]) {
1258 case 'a': /* author ... */
1259 return format_person_part(sb
, placeholder
[1],
1260 msg
+ c
->author
.off
, c
->author
.len
,
1261 c
->pretty_ctx
->date_mode
);
1262 case 'c': /* committer ... */
1263 return format_person_part(sb
, placeholder
[1],
1264 msg
+ c
->committer
.off
, c
->committer
.len
,
1265 c
->pretty_ctx
->date_mode
);
1266 case 'e': /* encoding */
1267 if (c
->commit_encoding
)
1268 strbuf_addstr(sb
, c
->commit_encoding
);
1270 case 'B': /* raw body */
1271 /* message_off is always left at the initial newline */
1272 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1276 /* Now we need to parse the commit message. */
1277 if (!c
->commit_message_parsed
)
1278 parse_commit_message(c
);
1280 switch (placeholder
[0]) {
1281 case 's': /* subject */
1282 format_subject(sb
, msg
+ c
->subject_off
, " ");
1284 case 'f': /* sanitized subject */
1285 format_sanitized_subject(sb
, msg
+ c
->subject_off
);
1287 case 'b': /* body */
1288 strbuf_addstr(sb
, msg
+ c
->body_off
);
1291 return 0; /* unknown placeholder */
1294 static size_t format_and_pad_commit(struct strbuf
*sb
, /* in UTF-8 */
1295 const char *placeholder
,
1296 struct format_commit_context
*c
)
1298 struct strbuf local_sb
= STRBUF_INIT
;
1299 int total_consumed
= 0, len
, padding
= c
->padding
;
1301 const char *start
= strrchr(sb
->buf
, '\n');
1305 occupied
= utf8_strnwidth(start
, -1, 1);
1306 padding
= (-padding
) - occupied
;
1309 int modifier
= *placeholder
== 'C';
1310 int consumed
= format_commit_one(&local_sb
, placeholder
, c
);
1311 total_consumed
+= consumed
;
1316 placeholder
+= consumed
;
1317 if (*placeholder
!= '%')
1322 len
= utf8_strnwidth(local_sb
.buf
, -1, 1);
1324 if (c
->flush_type
== flush_left_and_steal
) {
1325 const char *ch
= sb
->buf
+ sb
->len
- 1;
1326 while (len
> padding
&& ch
> sb
->buf
) {
1333 /* check for trailing ansi sequences */
1337 while (ch
- p
< 10 && *p
!= '\033')
1340 ch
+ 1 - p
!= display_mode_esc_sequence_len(p
))
1343 * got a good ansi sequence, put it back to
1344 * local_sb as we're cutting sb
1346 strbuf_insert(&local_sb
, 0, p
, ch
+ 1 - p
);
1349 strbuf_setlen(sb
, ch
+ 1 - sb
->buf
);
1350 c
->flush_type
= flush_left
;
1353 if (len
> padding
) {
1354 switch (c
->truncate
) {
1356 strbuf_utf8_replace(&local_sb
,
1357 0, len
- (padding
- 2),
1361 strbuf_utf8_replace(&local_sb
,
1363 len
- (padding
- 2),
1367 strbuf_utf8_replace(&local_sb
,
1368 padding
- 2, len
- (padding
- 2),
1374 strbuf_addstr(sb
, local_sb
.buf
);
1376 int sb_len
= sb
->len
, offset
= 0;
1377 if (c
->flush_type
== flush_left
)
1378 offset
= padding
- len
;
1379 else if (c
->flush_type
== flush_both
)
1380 offset
= (padding
- len
) / 2;
1382 * we calculate padding in columns, now
1383 * convert it back to chars
1385 padding
= padding
- len
+ local_sb
.len
;
1386 strbuf_grow(sb
, padding
);
1387 strbuf_setlen(sb
, sb_len
+ padding
);
1388 memset(sb
->buf
+ sb_len
, ' ', sb
->len
- sb_len
);
1389 memcpy(sb
->buf
+ sb_len
+ offset
, local_sb
.buf
,
1392 strbuf_release(&local_sb
);
1393 c
->flush_type
= no_flush
;
1394 return total_consumed
;
1397 static size_t format_commit_item(struct strbuf
*sb
, /* in UTF-8 */
1398 const char *placeholder
,
1405 ADD_LF_BEFORE_NON_EMPTY
,
1406 DEL_LF_BEFORE_EMPTY
,
1407 ADD_SP_BEFORE_NON_EMPTY
1410 switch (placeholder
[0]) {
1412 magic
= DEL_LF_BEFORE_EMPTY
;
1415 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1418 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1423 if (magic
!= NO_MAGIC
)
1427 if (((struct format_commit_context
*)context
)->flush_type
!= no_flush
)
1428 consumed
= format_and_pad_commit(sb
, placeholder
, context
);
1430 consumed
= format_commit_one(sb
, placeholder
, context
);
1431 if (magic
== NO_MAGIC
)
1434 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1435 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1436 strbuf_setlen(sb
, sb
->len
- 1);
1437 } else if (orig_len
!= sb
->len
) {
1438 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1439 strbuf_insert(sb
, orig_len
, "\n", 1);
1440 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1441 strbuf_insert(sb
, orig_len
, " ", 1);
1443 return consumed
+ 1;
1446 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1449 struct userformat_want
*w
= context
;
1451 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1454 switch (*placeholder
) {
1462 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1464 struct strbuf dummy
= STRBUF_INIT
;
1471 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1472 strbuf_release(&dummy
);
1475 void format_commit_message(const struct commit
*commit
,
1476 const char *format
, struct strbuf
*sb
,
1477 const struct pretty_print_context
*pretty_ctx
)
1479 struct format_commit_context context
;
1480 const char *output_enc
= pretty_ctx
->output_encoding
;
1481 const char *utf8
= "UTF-8";
1483 memset(&context
, 0, sizeof(context
));
1484 context
.commit
= commit
;
1485 context
.pretty_ctx
= pretty_ctx
;
1486 context
.wrap_start
= sb
->len
;
1487 context
.message
= logmsg_reencode(commit
,
1488 &context
.commit_encoding
,
1491 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1492 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1495 if (same_encoding(utf8
, output_enc
))
1498 if (context
.commit_encoding
&&
1499 !same_encoding(context
.commit_encoding
, utf8
))
1500 output_enc
= context
.commit_encoding
;
1505 char *out
= reencode_string_len(sb
->buf
, sb
->len
,
1506 output_enc
, utf8
, &outsz
);
1508 strbuf_attach(sb
, out
, outsz
, outsz
+ 1);
1511 free(context
.commit_encoding
);
1512 logmsg_free(context
.message
, commit
);
1513 free(context
.signature_check
.gpg_output
);
1514 free(context
.signature_check
.signer
);
1517 static void pp_header(struct pretty_print_context
*pp
,
1518 const char *encoding
,
1519 const struct commit
*commit
,
1523 int parents_shown
= 0;
1526 const char *line
= *msg_p
;
1527 int linelen
= get_one_line(*msg_p
);
1537 if (pp
->fmt
== CMIT_FMT_RAW
) {
1538 strbuf_add(sb
, line
, linelen
);
1542 if (!prefixcmp(line
, "parent ")) {
1544 die("bad parent line in commit");
1548 if (!parents_shown
) {
1549 struct commit_list
*parent
;
1551 for (parent
= commit
->parents
, num
= 0;
1553 parent
= parent
->next
, num
++)
1555 /* with enough slop */
1556 strbuf_grow(sb
, num
* 50 + 20);
1557 add_merge_info(pp
, sb
, commit
);
1562 * MEDIUM == DEFAULT shows only author with dates.
1563 * FULL shows both authors but not dates.
1564 * FULLER shows both authors and dates.
1566 if (!prefixcmp(line
, "author ")) {
1567 strbuf_grow(sb
, linelen
+ 80);
1568 pp_user_info(pp
, "Author", sb
, line
+ 7, encoding
);
1570 if (!prefixcmp(line
, "committer ") &&
1571 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1572 strbuf_grow(sb
, linelen
+ 80);
1573 pp_user_info(pp
, "Commit", sb
, line
+ 10, encoding
);
1578 void pp_title_line(struct pretty_print_context
*pp
,
1581 const char *encoding
,
1584 static const int max_length
= 78; /* per rfc2047 */
1585 struct strbuf title
;
1587 strbuf_init(&title
, 80);
1588 *msg_p
= format_subject(&title
, *msg_p
,
1589 pp
->preserve_subject
? "\n" : " ");
1591 strbuf_grow(sb
, title
.len
+ 1024);
1593 strbuf_addstr(sb
, pp
->subject
);
1594 if (needs_rfc2047_encoding(title
.buf
, title
.len
, RFC2047_SUBJECT
))
1595 add_rfc2047(sb
, title
.buf
, title
.len
,
1596 encoding
, RFC2047_SUBJECT
);
1598 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
1599 -last_line_length(sb
), 1, max_length
);
1601 strbuf_addbuf(sb
, &title
);
1603 strbuf_addch(sb
, '\n');
1605 if (need_8bit_cte
> 0) {
1606 const char *header_fmt
=
1607 "MIME-Version: 1.0\n"
1608 "Content-Type: text/plain; charset=%s\n"
1609 "Content-Transfer-Encoding: 8bit\n";
1610 strbuf_addf(sb
, header_fmt
, encoding
);
1612 if (pp
->after_subject
) {
1613 strbuf_addstr(sb
, pp
->after_subject
);
1615 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
1616 strbuf_addch(sb
, '\n');
1618 strbuf_release(&title
);
1621 void pp_remainder(struct pretty_print_context
*pp
,
1628 const char *line
= *msg_p
;
1629 int linelen
= get_one_line(line
);
1635 if (is_empty_line(line
, &linelen
)) {
1638 if (pp
->fmt
== CMIT_FMT_SHORT
)
1643 strbuf_grow(sb
, linelen
+ indent
+ 20);
1645 memset(sb
->buf
+ sb
->len
, ' ', indent
);
1646 strbuf_setlen(sb
, sb
->len
+ indent
);
1648 strbuf_add(sb
, line
, linelen
);
1649 strbuf_addch(sb
, '\n');
1653 void pretty_print_commit(struct pretty_print_context
*pp
,
1654 const struct commit
*commit
,
1657 unsigned long beginning_of_body
;
1661 const char *encoding
;
1662 int need_8bit_cte
= pp
->need_8bit_cte
;
1664 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
1665 format_commit_message(commit
, user_format
, sb
, pp
);
1669 encoding
= get_log_output_encoding();
1670 msg
= reencoded
= logmsg_reencode(commit
, NULL
, encoding
);
1672 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1676 * We need to check and emit Content-type: to mark it
1677 * as 8-bit if we haven't done so.
1679 if (pp
->fmt
== CMIT_FMT_EMAIL
&& need_8bit_cte
== 0) {
1682 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
1684 /* author could be non 7-bit ASCII but
1685 * the log may be so; skip over the
1686 * header part first.
1688 if (ch
== '\n' && msg
[i
+1] == '\n')
1691 else if (non_ascii(ch
)) {
1698 pp_header(pp
, encoding
, commit
, &msg
, sb
);
1699 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->subject
) {
1700 strbuf_addch(sb
, '\n');
1703 /* Skip excess blank lines at the beginning of body, if any... */
1704 msg
= skip_empty_lines(msg
);
1706 /* These formats treat the title line specially. */
1707 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1708 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
1710 beginning_of_body
= sb
->len
;
1711 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1712 pp_remainder(pp
, &msg
, sb
, indent
);
1715 /* Make sure there is an EOLN for the non-oneline case */
1716 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1717 strbuf_addch(sb
, '\n');
1720 * The caller may append additional body text in e-mail
1721 * format. Make sure we did not strip the blank line
1722 * between the header and the body.
1724 if (pp
->fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
1725 strbuf_addch(sb
, '\n');
1727 logmsg_free(reencoded
, commit
);
1730 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
1733 struct pretty_print_context pp
= {0};
1735 pretty_print_commit(&pp
, commit
, sb
);