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 has_rfc822_specials(const char *s
, int len
)
237 for (i
= 0; i
< len
; i
++)
238 if (is_rfc822_special(s
[i
]))
243 static void add_rfc822_quoted(struct strbuf
*out
, const char *s
, int len
)
247 /* just a guess, we may have to also backslash-quote */
248 strbuf_grow(out
, len
+ 2);
250 strbuf_addch(out
, '"');
251 for (i
= 0; i
< len
; i
++) {
255 strbuf_addch(out
, '\\');
258 strbuf_addch(out
, s
[i
]);
261 strbuf_addch(out
, '"');
264 static int is_rfc2047_special(char ch
)
266 return (non_ascii(ch
) || (ch
== '=') || (ch
== '?') || (ch
== '_'));
269 static void add_rfc2047(struct strbuf
*sb
, const char *line
, int len
,
270 const char *encoding
)
272 static const int max_length
= 78; /* per rfc2822 */
276 /* How many bytes are already used on the current line? */
277 for (i
= sb
->len
- 1; i
>= 0; i
--)
278 if (sb
->buf
[i
] == '\n')
280 line_len
= sb
->len
- (i
+1);
282 for (i
= 0; i
< len
; i
++) {
284 if (non_ascii(ch
) || ch
== '\n')
286 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
289 strbuf_add_wrapped_bytes(sb
, line
, len
, 0, 1, max_length
- line_len
);
293 strbuf_grow(sb
, len
* 3 + strlen(encoding
) + 100);
294 strbuf_addf(sb
, "=?%s?q?", encoding
);
295 line_len
+= strlen(encoding
) + 5; /* 5 for =??q? */
296 for (i
= 0; i
< len
; i
++) {
297 unsigned ch
= line
[i
] & 0xFF;
299 if (line_len
>= max_length
- 2) {
300 strbuf_addf(sb
, "?=\n =?%s?q?", encoding
);
301 line_len
= strlen(encoding
) + 5 + 1; /* =??q? plus SP */
305 * We encode ' ' using '=20' even though rfc2047
306 * allows using '_' for readability. Unfortunately,
307 * many programs do not understand this and just
308 * leave the underscore in place.
310 if (is_rfc2047_special(ch
) || ch
== ' ' || ch
== '\n') {
311 strbuf_addf(sb
, "=%02X", ch
);
315 strbuf_addch(sb
, ch
);
319 strbuf_addstr(sb
, "?=");
322 void pp_user_info(const struct pretty_print_context
*pp
,
323 const char *what
, struct strbuf
*sb
,
324 const char *line
, const char *encoding
)
331 if (pp
->fmt
== CMIT_FMT_ONELINE
)
333 date
= strchr(line
, '>');
336 namelen
= ++date
- line
;
337 time
= strtoul(date
, &date
, 10);
338 tz
= strtol(date
, NULL
, 10);
340 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
341 char *name_tail
= strchr(line
, '<');
342 int display_name_length
;
346 while (line
< name_tail
&& isspace(name_tail
[-1]))
348 display_name_length
= name_tail
- line
;
349 strbuf_addstr(sb
, "From: ");
350 if (!has_rfc822_specials(line
, display_name_length
)) {
351 add_rfc2047(sb
, line
, display_name_length
, encoding
);
353 struct strbuf quoted
= STRBUF_INIT
;
354 add_rfc822_quoted("ed
, line
, display_name_length
);
355 add_rfc2047(sb
, quoted
.buf
, quoted
.len
, encoding
);
356 strbuf_release("ed
);
358 for (final_line
= 0; final_line
< sb
->len
; final_line
++)
359 if (sb
->buf
[sb
->len
- final_line
- 1] == '\n')
361 if (namelen
- display_name_length
+ final_line
> 78) {
362 strbuf_addch(sb
, '\n');
363 if (!isspace(name_tail
[0]))
364 strbuf_addch(sb
, ' ');
366 strbuf_add(sb
, name_tail
, namelen
- display_name_length
);
367 strbuf_addch(sb
, '\n');
369 strbuf_addf(sb
, "%s: %.*s%.*s\n", what
,
370 (pp
->fmt
== CMIT_FMT_FULLER
) ? 4 : 0,
374 case CMIT_FMT_MEDIUM
:
375 strbuf_addf(sb
, "Date: %s\n", show_date(time
, tz
, pp
->date_mode
));
378 strbuf_addf(sb
, "Date: %s\n", show_date(time
, tz
, DATE_RFC2822
));
380 case CMIT_FMT_FULLER
:
381 strbuf_addf(sb
, "%sDate: %s\n", what
, show_date(time
, tz
, pp
->date_mode
));
389 static int is_empty_line(const char *line
, int *len_p
)
392 while (len
&& isspace(line
[len
-1]))
398 static const char *skip_empty_lines(const char *msg
)
401 int linelen
= get_one_line(msg
);
405 if (!is_empty_line(msg
, &ll
))
412 static void add_merge_info(const struct pretty_print_context
*pp
,
413 struct strbuf
*sb
, const struct commit
*commit
)
415 struct commit_list
*parent
= commit
->parents
;
417 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (pp
->fmt
== CMIT_FMT_EMAIL
) ||
418 !parent
|| !parent
->next
)
421 strbuf_addstr(sb
, "Merge:");
424 struct commit
*p
= parent
->item
;
425 const char *hex
= NULL
;
427 hex
= find_unique_abbrev(p
->object
.sha1
, pp
->abbrev
);
429 hex
= sha1_to_hex(p
->object
.sha1
);
430 parent
= parent
->next
;
432 strbuf_addf(sb
, " %s", hex
);
434 strbuf_addch(sb
, '\n');
437 static char *get_header(const struct commit
*commit
, const char *key
)
439 int key_len
= strlen(key
);
440 const char *line
= commit
->buffer
;
443 const char *eol
= strchr(line
, '\n'), *next
;
448 warning("malformed commit (header is missing newline): %s",
449 sha1_to_hex(commit
->object
.sha1
));
450 eol
= line
+ strlen(line
);
454 if (eol
- line
> key_len
&&
455 !strncmp(line
, key
, key_len
) &&
456 line
[key_len
] == ' ') {
457 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
464 static char *replace_encoding_header(char *buf
, const char *encoding
)
466 struct strbuf tmp
= STRBUF_INIT
;
470 /* guess if there is an encoding header before a \n\n */
471 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
472 cp
= strchr(cp
, '\n');
473 if (!cp
|| *++cp
== '\n')
477 cp
= strchr(cp
, '\n');
479 return buf
; /* should not happen but be defensive */
480 len
= cp
+ 1 - (buf
+ start
);
482 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
483 if (is_encoding_utf8(encoding
)) {
484 /* we have re-coded to UTF-8; drop the header */
485 strbuf_remove(&tmp
, start
, len
);
487 /* just replaces XXXX in 'encoding XXXX\n' */
488 strbuf_splice(&tmp
, start
+ strlen("encoding "),
489 len
- strlen("encoding \n"),
490 encoding
, strlen(encoding
));
492 return strbuf_detach(&tmp
, NULL
);
495 char *logmsg_reencode(const struct commit
*commit
,
496 const char *output_encoding
)
498 static const char *utf8
= "UTF-8";
499 const char *use_encoding
;
503 if (!*output_encoding
)
505 encoding
= get_header(commit
, "encoding");
506 use_encoding
= encoding
? encoding
: utf8
;
507 if (!strcmp(use_encoding
, output_encoding
))
508 if (encoding
) /* we'll strip encoding header later */
509 out
= xstrdup(commit
->buffer
);
511 return NULL
; /* nothing to do */
513 out
= reencode_string(commit
->buffer
,
514 output_encoding
, use_encoding
);
516 out
= replace_encoding_header(out
, output_encoding
);
522 static int mailmap_name(char *email
, int email_len
, char *name
, int name_len
)
524 static struct string_list
*mail_map
;
526 mail_map
= xcalloc(1, sizeof(*mail_map
));
527 read_mailmap(mail_map
, NULL
);
529 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
532 static size_t format_person_part(struct strbuf
*sb
, char part
,
533 const char *msg
, int len
, enum date_mode dmode
)
535 /* currently all placeholders have same length */
536 const int placeholder_len
= 2;
538 unsigned long date
= 0;
539 char person_name
[1024];
540 char person_mail
[1024];
541 struct ident_split s
;
542 const char *name_start
, *name_end
, *mail_start
, *mail_end
;
544 if (split_ident_line(&s
, msg
, len
) < 0)
547 name_start
= s
.name_begin
;
548 name_end
= s
.name_end
;
549 mail_start
= s
.mail_begin
;
550 mail_end
= s
.mail_end
;
552 if (part
== 'N' || part
== 'E') { /* mailmap lookup */
553 strlcpy(person_name
, name_start
, name_end
- name_start
+ 1);
554 strlcpy(person_mail
, mail_start
, mail_end
- mail_start
+ 1);
555 mailmap_name(person_mail
, sizeof(person_mail
), person_name
, sizeof(person_name
));
556 name_start
= person_name
;
557 name_end
= name_start
+ strlen(person_name
);
558 mail_start
= person_mail
;
559 mail_end
= mail_start
+ strlen(person_mail
);
561 if (part
== 'n' || part
== 'N') { /* name */
562 strbuf_add(sb
, name_start
, name_end
-name_start
);
563 return placeholder_len
;
565 if (part
== 'e' || part
== 'E') { /* email */
566 strbuf_add(sb
, mail_start
, mail_end
-mail_start
);
567 return placeholder_len
;
573 date
= strtoul(s
.date_begin
, NULL
, 10);
575 if (part
== 't') { /* date, UNIX timestamp */
576 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
577 return placeholder_len
;
581 tz
= strtoul(s
.tz_begin
+ 1, NULL
, 10);
582 if (*s
.tz_begin
== '-')
587 strbuf_addstr(sb
, show_date(date
, tz
, dmode
));
588 return placeholder_len
;
589 case 'D': /* date, RFC2822 style */
590 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RFC2822
));
591 return placeholder_len
;
592 case 'r': /* date, relative */
593 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RELATIVE
));
594 return placeholder_len
;
595 case 'i': /* date, ISO 8601 */
596 strbuf_addstr(sb
, show_date(date
, tz
, DATE_ISO8601
));
597 return placeholder_len
;
602 * reading from either a bogus commit, or a reflog entry with
603 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
604 * to compute a valid return value.
606 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
607 || part
== 'D' || part
== 'r' || part
== 'i')
608 return placeholder_len
;
610 return 0; /* unknown placeholder */
618 struct format_commit_context
{
619 const struct commit
*commit
;
620 const struct pretty_print_context
*pretty_ctx
;
621 unsigned commit_header_parsed
:1;
622 unsigned commit_message_parsed
:1;
623 unsigned commit_signature_parsed
:1;
630 size_t width
, indent1
, indent2
;
632 /* These offsets are relative to the start of the commit message. */
634 struct chunk committer
;
635 struct chunk encoding
;
640 /* The following ones are relative to the result struct strbuf. */
641 struct chunk abbrev_commit_hash
;
642 struct chunk abbrev_tree_hash
;
643 struct chunk abbrev_parent_hashes
;
647 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
650 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
655 * We haven't seen this chunk before. Our caller is surely
656 * going to add it the hard way now. Remember the most likely
657 * start of the to-be-added chunk: the current end of the
660 chunk
->off
= sb
->len
;
664 static void parse_commit_header(struct format_commit_context
*context
)
666 const char *msg
= context
->message
;
669 for (i
= 0; msg
[i
]; i
++) {
671 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
676 } else if (!prefixcmp(msg
+ i
, "author ")) {
677 context
->author
.off
= i
+ 7;
678 context
->author
.len
= eol
- i
- 7;
679 } else if (!prefixcmp(msg
+ i
, "committer ")) {
680 context
->committer
.off
= i
+ 10;
681 context
->committer
.len
= eol
- i
- 10;
682 } else if (!prefixcmp(msg
+ i
, "encoding ")) {
683 context
->encoding
.off
= i
+ 9;
684 context
->encoding
.len
= eol
- i
- 9;
688 context
->message_off
= i
;
689 context
->commit_header_parsed
= 1;
692 static int istitlechar(char c
)
694 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
695 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
698 static void format_sanitized_subject(struct strbuf
*sb
, const char *msg
)
701 size_t start_len
= sb
->len
;
704 for (; *msg
&& *msg
!= '\n'; msg
++) {
705 if (istitlechar(*msg
)) {
707 strbuf_addch(sb
, '-');
709 strbuf_addch(sb
, *msg
);
711 while (*(msg
+1) == '.')
717 /* trim any trailing '.' or '-' characters */
719 while (sb
->len
- trimlen
> start_len
&&
720 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
721 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
723 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
726 const char *format_subject(struct strbuf
*sb
, const char *msg
,
727 const char *line_separator
)
732 const char *line
= msg
;
733 int linelen
= get_one_line(line
);
736 if (!linelen
|| is_empty_line(line
, &linelen
))
741 strbuf_grow(sb
, linelen
+ 2);
743 strbuf_addstr(sb
, line_separator
);
744 strbuf_add(sb
, line
, linelen
);
750 static void parse_commit_message(struct format_commit_context
*c
)
752 const char *msg
= c
->message
+ c
->message_off
;
753 const char *start
= c
->message
;
755 msg
= skip_empty_lines(msg
);
756 c
->subject_off
= msg
- start
;
758 msg
= format_subject(NULL
, msg
, NULL
);
759 msg
= skip_empty_lines(msg
);
760 c
->body_off
= msg
- start
;
762 c
->commit_message_parsed
= 1;
765 static void format_decoration(struct strbuf
*sb
, const struct commit
*commit
)
767 struct name_decoration
*d
;
768 const char *prefix
= " (";
770 load_ref_decorations(DECORATE_SHORT_REFS
);
771 d
= lookup_decoration(&name_decoration
, &commit
->object
);
773 strbuf_addstr(sb
, prefix
);
775 strbuf_addstr(sb
, d
->name
);
778 if (prefix
[0] == ',')
779 strbuf_addch(sb
, ')');
782 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
783 size_t width
, size_t indent1
, size_t indent2
)
785 struct strbuf tmp
= STRBUF_INIT
;
788 strbuf_add(&tmp
, sb
->buf
, pos
);
789 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
790 (int) indent1
, (int) indent2
, (int) width
);
791 strbuf_swap(&tmp
, sb
);
792 strbuf_release(&tmp
);
795 static void rewrap_message_tail(struct strbuf
*sb
,
796 struct format_commit_context
*c
,
797 size_t new_width
, size_t new_indent1
,
800 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
801 c
->indent2
== new_indent2
)
803 if (c
->wrap_start
< sb
->len
)
804 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
805 c
->wrap_start
= sb
->len
;
806 c
->width
= new_width
;
807 c
->indent1
= new_indent1
;
808 c
->indent2
= new_indent2
;
814 } signature_check
[] = {
815 { 'G', ": Good signature from " },
816 { 'B', ": BAD signature from " },
819 static void parse_signature_lines(struct format_commit_context
*ctx
)
821 const char *buf
= ctx
->signature
.gpg_output
;
824 for (i
= 0; i
< ARRAY_SIZE(signature_check
); i
++) {
825 const char *found
= strstr(buf
, signature_check
[i
].check
);
829 ctx
->signature
.good_bad
= signature_check
[i
].result
;
830 found
+= strlen(signature_check
[i
].check
);
831 next
= strchrnul(found
, '\n');
832 ctx
->signature
.signer
= xmemdupz(found
, next
- found
);
837 static void parse_commit_signature(struct format_commit_context
*ctx
)
839 struct strbuf payload
= STRBUF_INIT
;
840 struct strbuf signature
= STRBUF_INIT
;
841 struct strbuf gpg_output
= STRBUF_INIT
;
844 ctx
->commit_signature_parsed
= 1;
846 if (parse_signed_commit(ctx
->commit
->object
.sha1
,
847 &payload
, &signature
) <= 0)
849 status
= verify_signed_buffer(payload
.buf
, payload
.len
,
850 signature
.buf
, signature
.len
,
852 if (status
&& !gpg_output
.len
)
854 ctx
->signature
.gpg_output
= strbuf_detach(&gpg_output
, NULL
);
855 parse_signature_lines(ctx
);
858 strbuf_release(&gpg_output
);
859 strbuf_release(&payload
);
860 strbuf_release(&signature
);
864 static int format_reflog_person(struct strbuf
*sb
,
866 struct reflog_walk_info
*log
,
867 enum date_mode dmode
)
874 ident
= get_reflog_ident(log
);
878 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
881 static size_t format_commit_one(struct strbuf
*sb
, const char *placeholder
,
884 struct format_commit_context
*c
= context
;
885 const struct commit
*commit
= c
->commit
;
886 const char *msg
= c
->message
;
887 struct commit_list
*p
;
890 /* these are independent of the commit */
891 switch (placeholder
[0]) {
893 if (placeholder
[1] == '(') {
894 const char *end
= strchr(placeholder
+ 2, ')');
895 char color
[COLOR_MAXLEN
];
898 color_parse_mem(placeholder
+ 2,
899 end
- (placeholder
+ 2),
900 "--pretty format", color
);
901 strbuf_addstr(sb
, color
);
902 return end
- placeholder
+ 1;
904 if (!prefixcmp(placeholder
+ 1, "red")) {
905 strbuf_addstr(sb
, GIT_COLOR_RED
);
907 } else if (!prefixcmp(placeholder
+ 1, "green")) {
908 strbuf_addstr(sb
, GIT_COLOR_GREEN
);
910 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
911 strbuf_addstr(sb
, GIT_COLOR_BLUE
);
913 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
914 strbuf_addstr(sb
, GIT_COLOR_RESET
);
918 case 'n': /* newline */
919 strbuf_addch(sb
, '\n');
922 /* %x00 == NUL, %x0a == LF, etc. */
923 if (0 <= (h1
= hexval_table
[0xff & placeholder
[1]]) &&
925 0 <= (h2
= hexval_table
[0xff & placeholder
[2]]) &&
927 strbuf_addch(sb
, (h1
<<4)|h2
);
932 if (placeholder
[1] == '(') {
933 unsigned long width
= 0, indent1
= 0, indent2
= 0;
935 const char *start
= placeholder
+ 2;
936 const char *end
= strchr(start
, ')');
940 width
= strtoul(start
, &next
, 10);
942 indent1
= strtoul(next
+ 1, &next
, 10);
944 indent2
= strtoul(next
+ 1,
951 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
952 return end
- placeholder
+ 1;
957 /* these depend on the commit */
958 if (!commit
->object
.parsed
)
959 parse_object(commit
->object
.sha1
);
961 switch (placeholder
[0]) {
962 case 'H': /* commit hash */
963 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
965 case 'h': /* abbreviated commit hash */
966 if (add_again(sb
, &c
->abbrev_commit_hash
))
968 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
969 c
->pretty_ctx
->abbrev
));
970 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
972 case 'T': /* tree hash */
973 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
975 case 't': /* abbreviated tree hash */
976 if (add_again(sb
, &c
->abbrev_tree_hash
))
978 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
979 c
->pretty_ctx
->abbrev
));
980 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
982 case 'P': /* parent hashes */
983 for (p
= commit
->parents
; p
; p
= p
->next
) {
984 if (p
!= commit
->parents
)
985 strbuf_addch(sb
, ' ');
986 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
989 case 'p': /* abbreviated parent hashes */
990 if (add_again(sb
, &c
->abbrev_parent_hashes
))
992 for (p
= commit
->parents
; p
; p
= p
->next
) {
993 if (p
!= commit
->parents
)
994 strbuf_addch(sb
, ' ');
995 strbuf_addstr(sb
, find_unique_abbrev(
996 p
->item
->object
.sha1
,
997 c
->pretty_ctx
->abbrev
));
999 c
->abbrev_parent_hashes
.len
= sb
->len
-
1000 c
->abbrev_parent_hashes
.off
;
1002 case 'm': /* left/right/bottom */
1003 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1006 format_decoration(sb
, commit
);
1008 case 'g': /* reflog info */
1009 switch(placeholder
[1]) {
1010 case 'd': /* reflog selector */
1012 if (c
->pretty_ctx
->reflog_info
)
1013 get_reflog_selector(sb
,
1014 c
->pretty_ctx
->reflog_info
,
1015 c
->pretty_ctx
->date_mode
,
1016 c
->pretty_ctx
->date_mode_explicit
,
1017 (placeholder
[1] == 'd'));
1019 case 's': /* reflog message */
1020 if (c
->pretty_ctx
->reflog_info
)
1021 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1027 return format_reflog_person(sb
,
1029 c
->pretty_ctx
->reflog_info
,
1030 c
->pretty_ctx
->date_mode
);
1032 return 0; /* unknown %g placeholder */
1034 if (c
->pretty_ctx
->show_notes
) {
1035 format_display_notes(commit
->object
.sha1
, sb
,
1036 get_log_output_encoding(), 0);
1042 if (placeholder
[0] == 'G') {
1043 if (!c
->commit_signature_parsed
)
1044 parse_commit_signature(c
);
1045 switch (placeholder
[1]) {
1047 if (c
->signature
.gpg_output
)
1048 strbuf_addstr(sb
, c
->signature
.gpg_output
);
1051 switch (c
->signature
.good_bad
) {
1054 strbuf_addch(sb
, c
->signature
.good_bad
);
1058 if (c
->signature
.signer
)
1059 strbuf_addstr(sb
, c
->signature
.signer
);
1066 /* For the rest we have to parse the commit header. */
1067 if (!c
->commit_header_parsed
)
1068 parse_commit_header(c
);
1070 switch (placeholder
[0]) {
1071 case 'a': /* author ... */
1072 return format_person_part(sb
, placeholder
[1],
1073 msg
+ c
->author
.off
, c
->author
.len
,
1074 c
->pretty_ctx
->date_mode
);
1075 case 'c': /* committer ... */
1076 return format_person_part(sb
, placeholder
[1],
1077 msg
+ c
->committer
.off
, c
->committer
.len
,
1078 c
->pretty_ctx
->date_mode
);
1079 case 'e': /* encoding */
1080 strbuf_add(sb
, msg
+ c
->encoding
.off
, c
->encoding
.len
);
1082 case 'B': /* raw body */
1083 /* message_off is always left at the initial newline */
1084 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1088 /* Now we need to parse the commit message. */
1089 if (!c
->commit_message_parsed
)
1090 parse_commit_message(c
);
1092 switch (placeholder
[0]) {
1093 case 's': /* subject */
1094 format_subject(sb
, msg
+ c
->subject_off
, " ");
1096 case 'f': /* sanitized subject */
1097 format_sanitized_subject(sb
, msg
+ c
->subject_off
);
1099 case 'b': /* body */
1100 strbuf_addstr(sb
, msg
+ c
->body_off
);
1103 return 0; /* unknown placeholder */
1106 static size_t format_commit_item(struct strbuf
*sb
, const char *placeholder
,
1113 ADD_LF_BEFORE_NON_EMPTY
,
1114 DEL_LF_BEFORE_EMPTY
,
1115 ADD_SP_BEFORE_NON_EMPTY
1118 switch (placeholder
[0]) {
1120 magic
= DEL_LF_BEFORE_EMPTY
;
1123 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1126 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1131 if (magic
!= NO_MAGIC
)
1135 consumed
= format_commit_one(sb
, placeholder
, context
);
1136 if (magic
== NO_MAGIC
)
1139 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1140 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1141 strbuf_setlen(sb
, sb
->len
- 1);
1142 } else if (orig_len
!= sb
->len
) {
1143 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1144 strbuf_insert(sb
, orig_len
, "\n", 1);
1145 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1146 strbuf_insert(sb
, orig_len
, " ", 1);
1148 return consumed
+ 1;
1151 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1154 struct userformat_want
*w
= context
;
1156 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1159 switch (*placeholder
) {
1167 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1169 struct strbuf dummy
= STRBUF_INIT
;
1176 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1177 strbuf_release(&dummy
);
1180 void format_commit_message(const struct commit
*commit
,
1181 const char *format
, struct strbuf
*sb
,
1182 const struct pretty_print_context
*pretty_ctx
)
1184 struct format_commit_context context
;
1185 static const char utf8
[] = "UTF-8";
1186 const char *output_enc
= pretty_ctx
->output_encoding
;
1188 memset(&context
, 0, sizeof(context
));
1189 context
.commit
= commit
;
1190 context
.pretty_ctx
= pretty_ctx
;
1191 context
.wrap_start
= sb
->len
;
1192 context
.message
= commit
->buffer
;
1194 char *enc
= get_header(commit
, "encoding");
1195 if (strcmp(enc
? enc
: utf8
, output_enc
)) {
1196 context
.message
= logmsg_reencode(commit
, output_enc
);
1197 if (!context
.message
)
1198 context
.message
= commit
->buffer
;
1203 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1204 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1206 if (context
.message
!= commit
->buffer
)
1207 free(context
.message
);
1208 free(context
.signature
.gpg_output
);
1209 free(context
.signature
.signer
);
1212 static void pp_header(const struct pretty_print_context
*pp
,
1213 const char *encoding
,
1214 const struct commit
*commit
,
1218 int parents_shown
= 0;
1221 const char *line
= *msg_p
;
1222 int linelen
= get_one_line(*msg_p
);
1232 if (pp
->fmt
== CMIT_FMT_RAW
) {
1233 strbuf_add(sb
, line
, linelen
);
1237 if (!memcmp(line
, "parent ", 7)) {
1239 die("bad parent line in commit");
1243 if (!parents_shown
) {
1244 struct commit_list
*parent
;
1246 for (parent
= commit
->parents
, num
= 0;
1248 parent
= parent
->next
, num
++)
1250 /* with enough slop */
1251 strbuf_grow(sb
, num
* 50 + 20);
1252 add_merge_info(pp
, sb
, commit
);
1257 * MEDIUM == DEFAULT shows only author with dates.
1258 * FULL shows both authors but not dates.
1259 * FULLER shows both authors and dates.
1261 if (!memcmp(line
, "author ", 7)) {
1262 strbuf_grow(sb
, linelen
+ 80);
1263 pp_user_info(pp
, "Author", sb
, line
+ 7, encoding
);
1265 if (!memcmp(line
, "committer ", 10) &&
1266 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1267 strbuf_grow(sb
, linelen
+ 80);
1268 pp_user_info(pp
, "Commit", sb
, line
+ 10, encoding
);
1273 void pp_title_line(const struct pretty_print_context
*pp
,
1276 const char *encoding
,
1279 struct strbuf title
;
1281 strbuf_init(&title
, 80);
1282 *msg_p
= format_subject(&title
, *msg_p
,
1283 pp
->preserve_subject
? "\n" : " ");
1285 strbuf_grow(sb
, title
.len
+ 1024);
1287 strbuf_addstr(sb
, pp
->subject
);
1288 add_rfc2047(sb
, title
.buf
, title
.len
, encoding
);
1290 strbuf_addbuf(sb
, &title
);
1292 strbuf_addch(sb
, '\n');
1294 if (need_8bit_cte
> 0) {
1295 const char *header_fmt
=
1296 "MIME-Version: 1.0\n"
1297 "Content-Type: text/plain; charset=%s\n"
1298 "Content-Transfer-Encoding: 8bit\n";
1299 strbuf_addf(sb
, header_fmt
, encoding
);
1301 if (pp
->after_subject
) {
1302 strbuf_addstr(sb
, pp
->after_subject
);
1304 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
1305 strbuf_addch(sb
, '\n');
1307 strbuf_release(&title
);
1310 void pp_remainder(const struct pretty_print_context
*pp
,
1317 const char *line
= *msg_p
;
1318 int linelen
= get_one_line(line
);
1324 if (is_empty_line(line
, &linelen
)) {
1327 if (pp
->fmt
== CMIT_FMT_SHORT
)
1332 strbuf_grow(sb
, linelen
+ indent
+ 20);
1334 memset(sb
->buf
+ sb
->len
, ' ', indent
);
1335 strbuf_setlen(sb
, sb
->len
+ indent
);
1337 strbuf_add(sb
, line
, linelen
);
1338 strbuf_addch(sb
, '\n');
1342 char *reencode_commit_message(const struct commit
*commit
, const char **encoding_p
)
1344 const char *encoding
;
1346 encoding
= get_log_output_encoding();
1348 *encoding_p
= encoding
;
1349 return logmsg_reencode(commit
, encoding
);
1352 void pretty_print_commit(const struct pretty_print_context
*pp
,
1353 const struct commit
*commit
,
1356 unsigned long beginning_of_body
;
1358 const char *msg
= commit
->buffer
;
1360 const char *encoding
;
1361 int need_8bit_cte
= pp
->need_8bit_cte
;
1363 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
1364 format_commit_message(commit
, user_format
, sb
, pp
);
1368 reencoded
= reencode_commit_message(commit
, &encoding
);
1373 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1377 * We need to check and emit Content-type: to mark it
1378 * as 8-bit if we haven't done so.
1380 if (pp
->fmt
== CMIT_FMT_EMAIL
&& need_8bit_cte
== 0) {
1383 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
1385 /* author could be non 7-bit ASCII but
1386 * the log may be so; skip over the
1387 * header part first.
1389 if (ch
== '\n' && msg
[i
+1] == '\n')
1392 else if (non_ascii(ch
)) {
1399 pp_header(pp
, encoding
, commit
, &msg
, sb
);
1400 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->subject
) {
1401 strbuf_addch(sb
, '\n');
1404 /* Skip excess blank lines at the beginning of body, if any... */
1405 msg
= skip_empty_lines(msg
);
1407 /* These formats treat the title line specially. */
1408 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1409 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
1411 beginning_of_body
= sb
->len
;
1412 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1413 pp_remainder(pp
, &msg
, sb
, indent
);
1416 /* Make sure there is an EOLN for the non-oneline case */
1417 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1418 strbuf_addch(sb
, '\n');
1421 * The caller may append additional body text in e-mail
1422 * format. Make sure we did not strip the blank line
1423 * between the header and the body.
1425 if (pp
->fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
1426 strbuf_addch(sb
, '\n');
1429 format_display_notes(commit
->object
.sha1
, sb
, encoding
,
1430 NOTES_SHOW_HEADER
| NOTES_INDENT
);
1435 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
1438 struct pretty_print_context pp
= {0};
1440 pretty_print_commit(&pp
, commit
, sb
);