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 eol
= line
+ strlen(line
);
452 if (eol
- line
> key_len
&&
453 !strncmp(line
, key
, key_len
) &&
454 line
[key_len
] == ' ') {
455 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
461 static char *replace_encoding_header(char *buf
, const char *encoding
)
463 struct strbuf tmp
= STRBUF_INIT
;
467 /* guess if there is an encoding header before a \n\n */
468 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
469 cp
= strchr(cp
, '\n');
470 if (!cp
|| *++cp
== '\n')
474 cp
= strchr(cp
, '\n');
476 return buf
; /* should not happen but be defensive */
477 len
= cp
+ 1 - (buf
+ start
);
479 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
480 if (is_encoding_utf8(encoding
)) {
481 /* we have re-coded to UTF-8; drop the header */
482 strbuf_remove(&tmp
, start
, len
);
484 /* just replaces XXXX in 'encoding XXXX\n' */
485 strbuf_splice(&tmp
, start
+ strlen("encoding "),
486 len
- strlen("encoding \n"),
487 encoding
, strlen(encoding
));
489 return strbuf_detach(&tmp
, NULL
);
492 char *logmsg_reencode(const struct commit
*commit
,
493 const char *output_encoding
)
495 static const char *utf8
= "UTF-8";
496 const char *use_encoding
;
500 if (!*output_encoding
)
502 encoding
= get_header(commit
, "encoding");
503 use_encoding
= encoding
? encoding
: utf8
;
504 if (!strcmp(use_encoding
, output_encoding
))
505 if (encoding
) /* we'll strip encoding header later */
506 out
= xstrdup(commit
->buffer
);
508 return NULL
; /* nothing to do */
510 out
= reencode_string(commit
->buffer
,
511 output_encoding
, use_encoding
);
513 out
= replace_encoding_header(out
, output_encoding
);
519 static int mailmap_name(char *email
, int email_len
, char *name
, int name_len
)
521 static struct string_list
*mail_map
;
523 mail_map
= xcalloc(1, sizeof(*mail_map
));
524 read_mailmap(mail_map
, NULL
);
526 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
529 static size_t format_person_part(struct strbuf
*sb
, char part
,
530 const char *msg
, int len
, enum date_mode dmode
)
532 /* currently all placeholders have same length */
533 const int placeholder_len
= 2;
534 int start
, end
, tz
= 0;
535 unsigned long date
= 0;
537 const char *name_start
, *name_end
, *mail_start
, *mail_end
, *msg_end
= msg
+len
;
538 char person_name
[1024];
539 char person_mail
[1024];
541 /* advance 'end' to point to email start delimiter */
542 for (end
= 0; end
< len
&& msg
[end
] != '<'; end
++)
546 * When end points at the '<' that we found, it should have
547 * matching '>' later, which means 'end' must be strictly
553 /* Seek for both name and email part */
556 while (name_end
> name_start
&& isspace(*(name_end
-1)))
558 mail_start
= msg
+end
+1;
559 mail_end
= mail_start
;
560 while (mail_end
< msg_end
&& *mail_end
!= '>')
562 if (mail_end
== msg_end
)
566 if (part
== 'N' || part
== 'E') { /* mailmap lookup */
567 strlcpy(person_name
, name_start
, name_end
-name_start
+1);
568 strlcpy(person_mail
, mail_start
, mail_end
-mail_start
+1);
569 mailmap_name(person_mail
, sizeof(person_mail
), person_name
, sizeof(person_name
));
570 name_start
= person_name
;
571 name_end
= name_start
+ strlen(person_name
);
572 mail_start
= person_mail
;
573 mail_end
= mail_start
+ strlen(person_mail
);
575 if (part
== 'n' || part
== 'N') { /* name */
576 strbuf_add(sb
, name_start
, name_end
-name_start
);
577 return placeholder_len
;
579 if (part
== 'e' || part
== 'E') { /* email */
580 strbuf_add(sb
, mail_start
, mail_end
-mail_start
);
581 return placeholder_len
;
584 /* advance 'start' to point to date start delimiter */
585 for (start
= end
+ 1; start
< len
&& isspace(msg
[start
]); start
++)
589 date
= strtoul(msg
+ start
, &ep
, 10);
590 if (msg
+ start
== ep
)
593 if (part
== 't') { /* date, UNIX timestamp */
594 strbuf_add(sb
, msg
+ start
, ep
- (msg
+ start
));
595 return placeholder_len
;
599 for (start
= ep
- msg
+ 1; start
< len
&& isspace(msg
[start
]); start
++)
601 if (start
+ 1 < len
) {
602 tz
= strtoul(msg
+ start
+ 1, NULL
, 10);
603 if (msg
[start
] == '-')
609 strbuf_addstr(sb
, show_date(date
, tz
, dmode
));
610 return placeholder_len
;
611 case 'D': /* date, RFC2822 style */
612 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RFC2822
));
613 return placeholder_len
;
614 case 'r': /* date, relative */
615 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RELATIVE
));
616 return placeholder_len
;
617 case 'i': /* date, ISO 8601 */
618 strbuf_addstr(sb
, show_date(date
, tz
, DATE_ISO8601
));
619 return placeholder_len
;
624 * bogus commit, 'sb' cannot be updated, but we still need to
625 * compute a valid return value.
627 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
628 || part
== 'D' || part
== 'r' || part
== 'i')
629 return placeholder_len
;
631 return 0; /* unknown placeholder */
639 struct format_commit_context
{
640 const struct commit
*commit
;
641 const struct pretty_print_context
*pretty_ctx
;
642 unsigned commit_header_parsed
:1;
643 unsigned commit_message_parsed
:1;
644 unsigned commit_signature_parsed
:1;
651 size_t width
, indent1
, indent2
;
653 /* These offsets are relative to the start of the commit message. */
655 struct chunk committer
;
656 struct chunk encoding
;
661 /* The following ones are relative to the result struct strbuf. */
662 struct chunk abbrev_commit_hash
;
663 struct chunk abbrev_tree_hash
;
664 struct chunk abbrev_parent_hashes
;
668 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
671 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
676 * We haven't seen this chunk before. Our caller is surely
677 * going to add it the hard way now. Remember the most likely
678 * start of the to-be-added chunk: the current end of the
681 chunk
->off
= sb
->len
;
685 static void parse_commit_header(struct format_commit_context
*context
)
687 const char *msg
= context
->message
;
690 for (i
= 0; msg
[i
]; i
++) {
692 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
697 } else if (!prefixcmp(msg
+ i
, "author ")) {
698 context
->author
.off
= i
+ 7;
699 context
->author
.len
= eol
- i
- 7;
700 } else if (!prefixcmp(msg
+ i
, "committer ")) {
701 context
->committer
.off
= i
+ 10;
702 context
->committer
.len
= eol
- i
- 10;
703 } else if (!prefixcmp(msg
+ i
, "encoding ")) {
704 context
->encoding
.off
= i
+ 9;
705 context
->encoding
.len
= eol
- i
- 9;
709 context
->message_off
= i
;
710 context
->commit_header_parsed
= 1;
713 static int istitlechar(char c
)
715 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
716 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
719 static void format_sanitized_subject(struct strbuf
*sb
, const char *msg
)
722 size_t start_len
= sb
->len
;
725 for (; *msg
&& *msg
!= '\n'; msg
++) {
726 if (istitlechar(*msg
)) {
728 strbuf_addch(sb
, '-');
730 strbuf_addch(sb
, *msg
);
732 while (*(msg
+1) == '.')
738 /* trim any trailing '.' or '-' characters */
740 while (sb
->len
- trimlen
> start_len
&&
741 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
742 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
744 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
747 const char *format_subject(struct strbuf
*sb
, const char *msg
,
748 const char *line_separator
)
753 const char *line
= msg
;
754 int linelen
= get_one_line(line
);
757 if (!linelen
|| is_empty_line(line
, &linelen
))
762 strbuf_grow(sb
, linelen
+ 2);
764 strbuf_addstr(sb
, line_separator
);
765 strbuf_add(sb
, line
, linelen
);
771 static void parse_commit_message(struct format_commit_context
*c
)
773 const char *msg
= c
->message
+ c
->message_off
;
774 const char *start
= c
->message
;
776 msg
= skip_empty_lines(msg
);
777 c
->subject_off
= msg
- start
;
779 msg
= format_subject(NULL
, msg
, NULL
);
780 msg
= skip_empty_lines(msg
);
781 c
->body_off
= msg
- start
;
783 c
->commit_message_parsed
= 1;
786 static void format_decoration(struct strbuf
*sb
, const struct commit
*commit
)
788 struct name_decoration
*d
;
789 const char *prefix
= " (";
791 load_ref_decorations(DECORATE_SHORT_REFS
);
792 d
= lookup_decoration(&name_decoration
, &commit
->object
);
794 strbuf_addstr(sb
, prefix
);
796 strbuf_addstr(sb
, d
->name
);
799 if (prefix
[0] == ',')
800 strbuf_addch(sb
, ')');
803 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
804 size_t width
, size_t indent1
, size_t indent2
)
806 struct strbuf tmp
= STRBUF_INIT
;
809 strbuf_add(&tmp
, sb
->buf
, pos
);
810 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
811 (int) indent1
, (int) indent2
, (int) width
);
812 strbuf_swap(&tmp
, sb
);
813 strbuf_release(&tmp
);
816 static void rewrap_message_tail(struct strbuf
*sb
,
817 struct format_commit_context
*c
,
818 size_t new_width
, size_t new_indent1
,
821 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
822 c
->indent2
== new_indent2
)
824 if (c
->wrap_start
< sb
->len
)
825 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
826 c
->wrap_start
= sb
->len
;
827 c
->width
= new_width
;
828 c
->indent1
= new_indent1
;
829 c
->indent2
= new_indent2
;
835 } signature_check
[] = {
836 { 'G', ": Good signature from " },
837 { 'B', ": BAD signature from " },
840 static void parse_signature_lines(struct format_commit_context
*ctx
)
842 const char *buf
= ctx
->signature
.gpg_output
;
845 for (i
= 0; i
< ARRAY_SIZE(signature_check
); i
++) {
846 const char *found
= strstr(buf
, signature_check
[i
].check
);
850 ctx
->signature
.good_bad
= signature_check
[i
].result
;
851 found
+= strlen(signature_check
[i
].check
);
852 next
= strchrnul(found
, '\n');
853 ctx
->signature
.signer
= xmemdupz(found
, next
- found
);
858 static void parse_commit_signature(struct format_commit_context
*ctx
)
860 struct strbuf payload
= STRBUF_INIT
;
861 struct strbuf signature
= STRBUF_INIT
;
862 struct strbuf gpg_output
= STRBUF_INIT
;
865 ctx
->commit_signature_parsed
= 1;
867 if (parse_signed_commit(ctx
->commit
->object
.sha1
,
868 &payload
, &signature
) <= 0)
870 status
= verify_signed_buffer(payload
.buf
, payload
.len
,
871 signature
.buf
, signature
.len
,
873 if (status
&& !gpg_output
.len
)
875 ctx
->signature
.gpg_output
= strbuf_detach(&gpg_output
, NULL
);
876 parse_signature_lines(ctx
);
879 strbuf_release(&gpg_output
);
880 strbuf_release(&payload
);
881 strbuf_release(&signature
);
885 static size_t format_commit_one(struct strbuf
*sb
, const char *placeholder
,
888 struct format_commit_context
*c
= context
;
889 const struct commit
*commit
= c
->commit
;
890 const char *msg
= c
->message
;
891 struct commit_list
*p
;
894 /* these are independent of the commit */
895 switch (placeholder
[0]) {
897 if (placeholder
[1] == '(') {
898 const char *end
= strchr(placeholder
+ 2, ')');
899 char color
[COLOR_MAXLEN
];
902 color_parse_mem(placeholder
+ 2,
903 end
- (placeholder
+ 2),
904 "--pretty format", color
);
905 strbuf_addstr(sb
, color
);
906 return end
- placeholder
+ 1;
908 if (!prefixcmp(placeholder
+ 1, "red")) {
909 strbuf_addstr(sb
, GIT_COLOR_RED
);
911 } else if (!prefixcmp(placeholder
+ 1, "green")) {
912 strbuf_addstr(sb
, GIT_COLOR_GREEN
);
914 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
915 strbuf_addstr(sb
, GIT_COLOR_BLUE
);
917 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
918 strbuf_addstr(sb
, GIT_COLOR_RESET
);
922 case 'n': /* newline */
923 strbuf_addch(sb
, '\n');
926 /* %x00 == NUL, %x0a == LF, etc. */
927 if (0 <= (h1
= hexval_table
[0xff & placeholder
[1]]) &&
929 0 <= (h2
= hexval_table
[0xff & placeholder
[2]]) &&
931 strbuf_addch(sb
, (h1
<<4)|h2
);
936 if (placeholder
[1] == '(') {
937 unsigned long width
= 0, indent1
= 0, indent2
= 0;
939 const char *start
= placeholder
+ 2;
940 const char *end
= strchr(start
, ')');
944 width
= strtoul(start
, &next
, 10);
946 indent1
= strtoul(next
+ 1, &next
, 10);
948 indent2
= strtoul(next
+ 1,
955 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
956 return end
- placeholder
+ 1;
961 /* these depend on the commit */
962 if (!commit
->object
.parsed
)
963 parse_object(commit
->object
.sha1
);
965 switch (placeholder
[0]) {
966 case 'H': /* commit hash */
967 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
969 case 'h': /* abbreviated commit hash */
970 if (add_again(sb
, &c
->abbrev_commit_hash
))
972 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
973 c
->pretty_ctx
->abbrev
));
974 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
976 case 'T': /* tree hash */
977 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
979 case 't': /* abbreviated tree hash */
980 if (add_again(sb
, &c
->abbrev_tree_hash
))
982 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
983 c
->pretty_ctx
->abbrev
));
984 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
986 case 'P': /* parent hashes */
987 for (p
= commit
->parents
; p
; p
= p
->next
) {
988 if (p
!= commit
->parents
)
989 strbuf_addch(sb
, ' ');
990 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
993 case 'p': /* abbreviated parent hashes */
994 if (add_again(sb
, &c
->abbrev_parent_hashes
))
996 for (p
= commit
->parents
; p
; p
= p
->next
) {
997 if (p
!= commit
->parents
)
998 strbuf_addch(sb
, ' ');
999 strbuf_addstr(sb
, find_unique_abbrev(
1000 p
->item
->object
.sha1
,
1001 c
->pretty_ctx
->abbrev
));
1003 c
->abbrev_parent_hashes
.len
= sb
->len
-
1004 c
->abbrev_parent_hashes
.off
;
1006 case 'm': /* left/right/bottom */
1007 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1010 format_decoration(sb
, commit
);
1012 case 'g': /* reflog info */
1013 switch(placeholder
[1]) {
1014 case 'd': /* reflog selector */
1016 if (c
->pretty_ctx
->reflog_info
)
1017 get_reflog_selector(sb
,
1018 c
->pretty_ctx
->reflog_info
,
1019 c
->pretty_ctx
->date_mode
,
1020 (placeholder
[1] == 'd'));
1022 case 's': /* reflog message */
1023 if (c
->pretty_ctx
->reflog_info
)
1024 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1027 return 0; /* unknown %g placeholder */
1029 if (c
->pretty_ctx
->show_notes
) {
1030 format_display_notes(commit
->object
.sha1
, sb
,
1031 get_log_output_encoding(), 0);
1037 if (placeholder
[0] == 'G') {
1038 if (!c
->commit_signature_parsed
)
1039 parse_commit_signature(c
);
1040 switch (placeholder
[1]) {
1042 if (c
->signature
.gpg_output
)
1043 strbuf_addstr(sb
, c
->signature
.gpg_output
);
1046 switch (c
->signature
.good_bad
) {
1049 strbuf_addch(sb
, c
->signature
.good_bad
);
1053 if (c
->signature
.signer
)
1054 strbuf_addstr(sb
, c
->signature
.signer
);
1061 /* For the rest we have to parse the commit header. */
1062 if (!c
->commit_header_parsed
)
1063 parse_commit_header(c
);
1065 switch (placeholder
[0]) {
1066 case 'a': /* author ... */
1067 return format_person_part(sb
, placeholder
[1],
1068 msg
+ c
->author
.off
, c
->author
.len
,
1069 c
->pretty_ctx
->date_mode
);
1070 case 'c': /* committer ... */
1071 return format_person_part(sb
, placeholder
[1],
1072 msg
+ c
->committer
.off
, c
->committer
.len
,
1073 c
->pretty_ctx
->date_mode
);
1074 case 'e': /* encoding */
1075 strbuf_add(sb
, msg
+ c
->encoding
.off
, c
->encoding
.len
);
1077 case 'B': /* raw body */
1078 /* message_off is always left at the initial newline */
1079 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1083 /* Now we need to parse the commit message. */
1084 if (!c
->commit_message_parsed
)
1085 parse_commit_message(c
);
1087 switch (placeholder
[0]) {
1088 case 's': /* subject */
1089 format_subject(sb
, msg
+ c
->subject_off
, " ");
1091 case 'f': /* sanitized subject */
1092 format_sanitized_subject(sb
, msg
+ c
->subject_off
);
1094 case 'b': /* body */
1095 strbuf_addstr(sb
, msg
+ c
->body_off
);
1098 return 0; /* unknown placeholder */
1101 static size_t format_commit_item(struct strbuf
*sb
, const char *placeholder
,
1108 ADD_LF_BEFORE_NON_EMPTY
,
1109 DEL_LF_BEFORE_EMPTY
,
1110 ADD_SP_BEFORE_NON_EMPTY
1113 switch (placeholder
[0]) {
1115 magic
= DEL_LF_BEFORE_EMPTY
;
1118 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1121 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1126 if (magic
!= NO_MAGIC
)
1130 consumed
= format_commit_one(sb
, placeholder
, context
);
1131 if (magic
== NO_MAGIC
)
1134 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1135 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1136 strbuf_setlen(sb
, sb
->len
- 1);
1137 } else if (orig_len
!= sb
->len
) {
1138 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1139 strbuf_insert(sb
, orig_len
, "\n", 1);
1140 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1141 strbuf_insert(sb
, orig_len
, " ", 1);
1143 return consumed
+ 1;
1146 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1149 struct userformat_want
*w
= context
;
1151 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1154 switch (*placeholder
) {
1162 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1164 struct strbuf dummy
= STRBUF_INIT
;
1171 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1172 strbuf_release(&dummy
);
1175 void format_commit_message(const struct commit
*commit
,
1176 const char *format
, struct strbuf
*sb
,
1177 const struct pretty_print_context
*pretty_ctx
)
1179 struct format_commit_context context
;
1180 static const char utf8
[] = "UTF-8";
1181 const char *output_enc
= pretty_ctx
->output_encoding
;
1183 memset(&context
, 0, sizeof(context
));
1184 context
.commit
= commit
;
1185 context
.pretty_ctx
= pretty_ctx
;
1186 context
.wrap_start
= sb
->len
;
1187 context
.message
= commit
->buffer
;
1189 char *enc
= get_header(commit
, "encoding");
1190 if (strcmp(enc
? enc
: utf8
, output_enc
)) {
1191 context
.message
= logmsg_reencode(commit
, output_enc
);
1192 if (!context
.message
)
1193 context
.message
= commit
->buffer
;
1198 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1199 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1201 if (context
.message
!= commit
->buffer
)
1202 free(context
.message
);
1203 free(context
.signature
.gpg_output
);
1204 free(context
.signature
.signer
);
1207 static void pp_header(const struct pretty_print_context
*pp
,
1208 const char *encoding
,
1209 const struct commit
*commit
,
1213 int parents_shown
= 0;
1216 const char *line
= *msg_p
;
1217 int linelen
= get_one_line(*msg_p
);
1227 if (pp
->fmt
== CMIT_FMT_RAW
) {
1228 strbuf_add(sb
, line
, linelen
);
1232 if (!memcmp(line
, "parent ", 7)) {
1234 die("bad parent line in commit");
1238 if (!parents_shown
) {
1239 struct commit_list
*parent
;
1241 for (parent
= commit
->parents
, num
= 0;
1243 parent
= parent
->next
, num
++)
1245 /* with enough slop */
1246 strbuf_grow(sb
, num
* 50 + 20);
1247 add_merge_info(pp
, sb
, commit
);
1252 * MEDIUM == DEFAULT shows only author with dates.
1253 * FULL shows both authors but not dates.
1254 * FULLER shows both authors and dates.
1256 if (!memcmp(line
, "author ", 7)) {
1257 strbuf_grow(sb
, linelen
+ 80);
1258 pp_user_info(pp
, "Author", sb
, line
+ 7, encoding
);
1260 if (!memcmp(line
, "committer ", 10) &&
1261 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1262 strbuf_grow(sb
, linelen
+ 80);
1263 pp_user_info(pp
, "Commit", sb
, line
+ 10, encoding
);
1268 void pp_title_line(const struct pretty_print_context
*pp
,
1271 const char *encoding
,
1274 struct strbuf title
;
1276 strbuf_init(&title
, 80);
1277 *msg_p
= format_subject(&title
, *msg_p
,
1278 pp
->preserve_subject
? "\n" : " ");
1280 strbuf_grow(sb
, title
.len
+ 1024);
1282 strbuf_addstr(sb
, pp
->subject
);
1283 add_rfc2047(sb
, title
.buf
, title
.len
, encoding
);
1285 strbuf_addbuf(sb
, &title
);
1287 strbuf_addch(sb
, '\n');
1289 if (need_8bit_cte
> 0) {
1290 const char *header_fmt
=
1291 "MIME-Version: 1.0\n"
1292 "Content-Type: text/plain; charset=%s\n"
1293 "Content-Transfer-Encoding: 8bit\n";
1294 strbuf_addf(sb
, header_fmt
, encoding
);
1296 if (pp
->after_subject
) {
1297 strbuf_addstr(sb
, pp
->after_subject
);
1299 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
1300 strbuf_addch(sb
, '\n');
1302 strbuf_release(&title
);
1305 void pp_remainder(const struct pretty_print_context
*pp
,
1312 const char *line
= *msg_p
;
1313 int linelen
= get_one_line(line
);
1319 if (is_empty_line(line
, &linelen
)) {
1322 if (pp
->fmt
== CMIT_FMT_SHORT
)
1327 strbuf_grow(sb
, linelen
+ indent
+ 20);
1329 memset(sb
->buf
+ sb
->len
, ' ', indent
);
1330 strbuf_setlen(sb
, sb
->len
+ indent
);
1332 strbuf_add(sb
, line
, linelen
);
1333 strbuf_addch(sb
, '\n');
1337 char *reencode_commit_message(const struct commit
*commit
, const char **encoding_p
)
1339 const char *encoding
;
1341 encoding
= get_log_output_encoding();
1343 *encoding_p
= encoding
;
1344 return logmsg_reencode(commit
, encoding
);
1347 void pretty_print_commit(const struct pretty_print_context
*pp
,
1348 const struct commit
*commit
,
1351 unsigned long beginning_of_body
;
1353 const char *msg
= commit
->buffer
;
1355 const char *encoding
;
1356 int need_8bit_cte
= pp
->need_8bit_cte
;
1358 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
1359 format_commit_message(commit
, user_format
, sb
, pp
);
1363 reencoded
= reencode_commit_message(commit
, &encoding
);
1368 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1372 * We need to check and emit Content-type: to mark it
1373 * as 8-bit if we haven't done so.
1375 if (pp
->fmt
== CMIT_FMT_EMAIL
&& need_8bit_cte
== 0) {
1378 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
1380 /* author could be non 7-bit ASCII but
1381 * the log may be so; skip over the
1382 * header part first.
1384 if (ch
== '\n' && msg
[i
+1] == '\n')
1387 else if (non_ascii(ch
)) {
1394 pp_header(pp
, encoding
, commit
, &msg
, sb
);
1395 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->subject
) {
1396 strbuf_addch(sb
, '\n');
1399 /* Skip excess blank lines at the beginning of body, if any... */
1400 msg
= skip_empty_lines(msg
);
1402 /* These formats treat the title line specially. */
1403 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1404 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
1406 beginning_of_body
= sb
->len
;
1407 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1408 pp_remainder(pp
, &msg
, sb
, indent
);
1411 /* Make sure there is an EOLN for the non-oneline case */
1412 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1413 strbuf_addch(sb
, '\n');
1416 * The caller may append additional body text in e-mail
1417 * format. Make sure we did not strip the blank line
1418 * between the header and the body.
1420 if (pp
->fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
1421 strbuf_addch(sb
, '\n');
1424 format_display_notes(commit
->object
.sha1
, sb
, encoding
,
1425 NOTES_SHOW_HEADER
| NOTES_INDENT
);
1430 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
1433 struct pretty_print_context pp
= {0};
1435 pretty_print_commit(&pp
, commit
, sb
);