7 static struct cmt_fmt_map
{
12 { "raw", 1, CMIT_FMT_RAW
},
13 { "medium", 1, CMIT_FMT_MEDIUM
},
14 { "short", 1, CMIT_FMT_SHORT
},
15 { "email", 1, CMIT_FMT_EMAIL
},
16 { "full", 5, CMIT_FMT_FULL
},
17 { "fuller", 5, CMIT_FMT_FULLER
},
18 { "oneline", 1, CMIT_FMT_ONELINE
},
19 { "format:", 7, CMIT_FMT_USERFORMAT
},
22 static char *user_format
;
24 enum cmit_fmt
get_commit_format(const char *arg
)
29 return CMIT_FMT_DEFAULT
;
32 if (!prefixcmp(arg
, "format:")) {
34 user_format
= xstrdup(arg
+ 7);
35 return CMIT_FMT_USERFORMAT
;
37 for (i
= 0; i
< ARRAY_SIZE(cmt_fmts
); i
++) {
38 if (!strncmp(arg
, cmt_fmts
[i
].n
, cmt_fmts
[i
].cmp_len
) &&
39 !strncmp(arg
, cmt_fmts
[i
].n
, strlen(arg
)))
43 die("invalid --pretty format: %s", arg
);
47 * Generic support for pretty-printing the header
49 static int get_one_line(const char *msg
)
64 /* High bit set, or ISO-2022-INT */
68 return ((ch
& 0x80) || (ch
== 0x1b));
71 static int is_rfc2047_special(char ch
)
73 return (non_ascii(ch
) || (ch
== '=') || (ch
== '?') || (ch
== '_'));
76 static void add_rfc2047(struct strbuf
*sb
, const char *line
, int len
,
81 for (i
= 0; i
< len
; i
++) {
85 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
88 strbuf_add(sb
, line
, len
);
92 strbuf_grow(sb
, len
* 3 + strlen(encoding
) + 100);
93 strbuf_addf(sb
, "=?%s?q?", encoding
);
94 for (i
= last
= 0; i
< len
; i
++) {
95 unsigned ch
= line
[i
] & 0xFF;
97 * We encode ' ' using '=20' even though rfc2047
98 * allows using '_' for readability. Unfortunately,
99 * many programs do not understand this and just
100 * leave the underscore in place.
102 if (is_rfc2047_special(ch
) || ch
== ' ') {
103 strbuf_add(sb
, line
+ last
, i
- last
);
104 strbuf_addf(sb
, "=%02X", ch
);
108 strbuf_add(sb
, line
+ last
, len
- last
);
109 strbuf_addstr(sb
, "?=");
112 void pp_user_info(const char *what
, enum cmit_fmt fmt
, struct strbuf
*sb
,
113 const char *line
, enum date_mode dmode
,
114 const char *encoding
)
120 const char *filler
= " ";
122 if (fmt
== CMIT_FMT_ONELINE
)
124 date
= strchr(line
, '>');
127 namelen
= ++date
- line
;
128 time
= strtoul(date
, &date
, 10);
129 tz
= strtol(date
, NULL
, 10);
131 if (fmt
== CMIT_FMT_EMAIL
) {
132 char *name_tail
= strchr(line
, '<');
133 int display_name_length
;
136 while (line
< name_tail
&& isspace(name_tail
[-1]))
138 display_name_length
= name_tail
- line
;
140 strbuf_addstr(sb
, "From: ");
141 add_rfc2047(sb
, line
, display_name_length
, encoding
);
142 strbuf_add(sb
, name_tail
, namelen
- display_name_length
);
143 strbuf_addch(sb
, '\n');
145 strbuf_addf(sb
, "%s: %.*s%.*s\n", what
,
146 (fmt
== CMIT_FMT_FULLER
) ? 4 : 0,
147 filler
, namelen
, line
);
150 case CMIT_FMT_MEDIUM
:
151 strbuf_addf(sb
, "Date: %s\n", show_date(time
, tz
, dmode
));
154 strbuf_addf(sb
, "Date: %s\n", show_date(time
, tz
, DATE_RFC2822
));
156 case CMIT_FMT_FULLER
:
157 strbuf_addf(sb
, "%sDate: %s\n", what
, show_date(time
, tz
, dmode
));
165 static int is_empty_line(const char *line
, int *len_p
)
168 while (len
&& isspace(line
[len
-1]))
174 static void add_merge_info(enum cmit_fmt fmt
, struct strbuf
*sb
,
175 const struct commit
*commit
, int abbrev
)
177 struct commit_list
*parent
= commit
->parents
;
179 if ((fmt
== CMIT_FMT_ONELINE
) || (fmt
== CMIT_FMT_EMAIL
) ||
180 !parent
|| !parent
->next
)
183 strbuf_addstr(sb
, "Merge:");
186 struct commit
*p
= parent
->item
;
187 const char *hex
= NULL
;
190 hex
= find_unique_abbrev(p
->object
.sha1
, abbrev
);
192 hex
= sha1_to_hex(p
->object
.sha1
);
193 dots
= (abbrev
&& strlen(hex
) != 40) ? "..." : "";
194 parent
= parent
->next
;
196 strbuf_addf(sb
, " %s%s", hex
, dots
);
198 strbuf_addch(sb
, '\n');
201 static char *get_header(const struct commit
*commit
, const char *key
)
203 int key_len
= strlen(key
);
204 const char *line
= commit
->buffer
;
207 const char *eol
= strchr(line
, '\n'), *next
;
212 eol
= line
+ strlen(line
);
216 if (eol
- line
> key_len
&&
217 !strncmp(line
, key
, key_len
) &&
218 line
[key_len
] == ' ') {
219 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
225 static char *replace_encoding_header(char *buf
, const char *encoding
)
231 /* guess if there is an encoding header before a \n\n */
232 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
233 cp
= strchr(cp
, '\n');
234 if (!cp
|| *++cp
== '\n')
238 cp
= strchr(cp
, '\n');
240 return buf
; /* should not happen but be defensive */
241 len
= cp
+ 1 - (buf
+ start
);
243 strbuf_init(&tmp
, 0);
244 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
245 if (is_encoding_utf8(encoding
)) {
246 /* we have re-coded to UTF-8; drop the header */
247 strbuf_remove(&tmp
, start
, len
);
249 /* just replaces XXXX in 'encoding XXXX\n' */
250 strbuf_splice(&tmp
, start
+ strlen("encoding "),
251 len
- strlen("encoding \n"),
252 encoding
, strlen(encoding
));
254 return strbuf_detach(&tmp
, NULL
);
257 static char *logmsg_reencode(const struct commit
*commit
,
258 const char *output_encoding
)
260 static const char *utf8
= "utf-8";
261 const char *use_encoding
;
265 if (!*output_encoding
)
267 encoding
= get_header(commit
, "encoding");
268 use_encoding
= encoding
? encoding
: utf8
;
269 if (!strcmp(use_encoding
, output_encoding
))
270 if (encoding
) /* we'll strip encoding header later */
271 out
= xstrdup(commit
->buffer
);
273 return NULL
; /* nothing to do */
275 out
= reencode_string(commit
->buffer
,
276 output_encoding
, use_encoding
);
278 out
= replace_encoding_header(out
, output_encoding
);
284 static size_t format_person_part(struct strbuf
*sb
, char part
,
285 const char *msg
, int len
)
287 /* currently all placeholders have same length */
288 const int placeholder_len
= 2;
289 int start
, end
, tz
= 0;
290 unsigned long date
= 0;
293 /* advance 'end' to point to email start delimiter */
294 for (end
= 0; end
< len
&& msg
[end
] != '<'; end
++)
298 * When end points at the '<' that we found, it should have
299 * matching '>' later, which means 'end' must be strictly
305 if (part
== 'n') { /* name */
306 while (end
> 0 && isspace(msg
[end
- 1]))
308 strbuf_add(sb
, msg
, end
);
309 return placeholder_len
;
311 start
= ++end
; /* save email start position */
313 /* advance 'end' to point to email end delimiter */
314 for ( ; end
< len
&& msg
[end
] != '>'; end
++)
320 if (part
== 'e') { /* email */
321 strbuf_add(sb
, msg
+ start
, end
- start
);
322 return placeholder_len
;
325 /* advance 'start' to point to date start delimiter */
326 for (start
= end
+ 1; start
< len
&& isspace(msg
[start
]); start
++)
330 date
= strtoul(msg
+ start
, &ep
, 10);
331 if (msg
+ start
== ep
)
334 if (part
== 't') { /* date, UNIX timestamp */
335 strbuf_add(sb
, msg
+ start
, ep
- (msg
+ start
));
336 return placeholder_len
;
340 for (start
= ep
- msg
+ 1; start
< len
&& isspace(msg
[start
]); start
++)
342 if (start
+ 1 < len
) {
343 tz
= strtoul(msg
+ start
+ 1, NULL
, 10);
344 if (msg
[start
] == '-')
350 strbuf_addstr(sb
, show_date(date
, tz
, DATE_NORMAL
));
351 return placeholder_len
;
352 case 'D': /* date, RFC2822 style */
353 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RFC2822
));
354 return placeholder_len
;
355 case 'r': /* date, relative */
356 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RELATIVE
));
357 return placeholder_len
;
358 case 'i': /* date, ISO 8601 */
359 strbuf_addstr(sb
, show_date(date
, tz
, DATE_ISO8601
));
360 return placeholder_len
;
365 * bogus commit, 'sb' cannot be updated, but we still need to
366 * compute a valid return value.
368 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
369 || part
== 'D' || part
== 'r' || part
== 'i')
370 return placeholder_len
;
372 return 0; /* unknown placeholder */
380 struct format_commit_context
{
381 const struct commit
*commit
;
383 /* These offsets are relative to the start of the commit message. */
384 int commit_header_parsed
;
385 struct chunk subject
;
387 struct chunk committer
;
388 struct chunk encoding
;
391 /* The following ones are relative to the result struct strbuf. */
392 struct chunk abbrev_commit_hash
;
393 struct chunk abbrev_tree_hash
;
394 struct chunk abbrev_parent_hashes
;
397 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
400 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
405 * We haven't seen this chunk before. Our caller is surely
406 * going to add it the hard way now. Remember the most likely
407 * start of the to-be-added chunk: the current end of the
410 chunk
->off
= sb
->len
;
414 static void parse_commit_header(struct format_commit_context
*context
)
416 const char *msg
= context
->commit
->buffer
;
418 enum { HEADER
, SUBJECT
, BODY
} state
;
420 for (i
= 0, state
= HEADER
; msg
[i
] && state
< BODY
; i
++) {
422 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
425 if (state
== SUBJECT
) {
426 context
->subject
.off
= i
;
427 context
->subject
.len
= eol
- i
;
432 /* strip empty lines */
433 while (msg
[eol
] == '\n' && msg
[eol
+ 1] == '\n')
435 } else if (!prefixcmp(msg
+ i
, "author ")) {
436 context
->author
.off
= i
+ 7;
437 context
->author
.len
= eol
- i
- 7;
438 } else if (!prefixcmp(msg
+ i
, "committer ")) {
439 context
->committer
.off
= i
+ 10;
440 context
->committer
.len
= eol
- i
- 10;
441 } else if (!prefixcmp(msg
+ i
, "encoding ")) {
442 context
->encoding
.off
= i
+ 9;
443 context
->encoding
.len
= eol
- i
- 9;
449 context
->body_off
= i
;
450 context
->commit_header_parsed
= 1;
453 static size_t format_commit_item(struct strbuf
*sb
, const char *placeholder
,
456 struct format_commit_context
*c
= context
;
457 const struct commit
*commit
= c
->commit
;
458 const char *msg
= commit
->buffer
;
459 struct commit_list
*p
;
461 /* these are independent of the commit */
462 switch (placeholder
[0]) {
464 if (!prefixcmp(placeholder
+ 1, "red")) {
465 strbuf_addstr(sb
, "\033[31m");
467 } else if (!prefixcmp(placeholder
+ 1, "green")) {
468 strbuf_addstr(sb
, "\033[32m");
470 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
471 strbuf_addstr(sb
, "\033[34m");
473 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
474 strbuf_addstr(sb
, "\033[m");
478 case 'n': /* newline */
479 strbuf_addch(sb
, '\n');
483 /* these depend on the commit */
484 if (!commit
->object
.parsed
)
485 parse_object(commit
->object
.sha1
);
487 switch (placeholder
[0]) {
488 case 'H': /* commit hash */
489 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
491 case 'h': /* abbreviated commit hash */
492 if (add_again(sb
, &c
->abbrev_commit_hash
))
494 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
496 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
498 case 'T': /* tree hash */
499 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
501 case 't': /* abbreviated tree hash */
502 if (add_again(sb
, &c
->abbrev_tree_hash
))
504 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
506 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
508 case 'P': /* parent hashes */
509 for (p
= commit
->parents
; p
; p
= p
->next
) {
510 if (p
!= commit
->parents
)
511 strbuf_addch(sb
, ' ');
512 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
515 case 'p': /* abbreviated parent hashes */
516 if (add_again(sb
, &c
->abbrev_parent_hashes
))
518 for (p
= commit
->parents
; p
; p
= p
->next
) {
519 if (p
!= commit
->parents
)
520 strbuf_addch(sb
, ' ');
521 strbuf_addstr(sb
, find_unique_abbrev(
522 p
->item
->object
.sha1
, DEFAULT_ABBREV
));
524 c
->abbrev_parent_hashes
.len
= sb
->len
-
525 c
->abbrev_parent_hashes
.off
;
527 case 'm': /* left/right/bottom */
528 strbuf_addch(sb
, (commit
->object
.flags
& BOUNDARY
)
530 : (commit
->object
.flags
& SYMMETRIC_LEFT
)
536 /* For the rest we have to parse the commit header. */
537 if (!c
->commit_header_parsed
)
538 parse_commit_header(c
);
540 switch (placeholder
[0]) {
541 case 's': /* subject */
542 strbuf_add(sb
, msg
+ c
->subject
.off
, c
->subject
.len
);
544 case 'a': /* author ... */
545 return format_person_part(sb
, placeholder
[1],
546 msg
+ c
->author
.off
, c
->author
.len
);
547 case 'c': /* committer ... */
548 return format_person_part(sb
, placeholder
[1],
549 msg
+ c
->committer
.off
, c
->committer
.len
);
550 case 'e': /* encoding */
551 strbuf_add(sb
, msg
+ c
->encoding
.off
, c
->encoding
.len
);
554 strbuf_addstr(sb
, msg
+ c
->body_off
);
557 return 0; /* unknown placeholder */
560 void format_commit_message(const struct commit
*commit
,
561 const void *format
, struct strbuf
*sb
)
563 struct format_commit_context context
;
565 memset(&context
, 0, sizeof(context
));
566 context
.commit
= commit
;
567 strbuf_expand(sb
, format
, format_commit_item
, &context
);
570 static void pp_header(enum cmit_fmt fmt
,
572 enum date_mode dmode
,
573 const char *encoding
,
574 const struct commit
*commit
,
578 int parents_shown
= 0;
581 const char *line
= *msg_p
;
582 int linelen
= get_one_line(*msg_p
);
592 if (fmt
== CMIT_FMT_RAW
) {
593 strbuf_add(sb
, line
, linelen
);
597 if (!memcmp(line
, "parent ", 7)) {
599 die("bad parent line in commit");
603 if (!parents_shown
) {
604 struct commit_list
*parent
;
606 for (parent
= commit
->parents
, num
= 0;
608 parent
= parent
->next
, num
++)
610 /* with enough slop */
611 strbuf_grow(sb
, num
* 50 + 20);
612 add_merge_info(fmt
, sb
, commit
, abbrev
);
617 * MEDIUM == DEFAULT shows only author with dates.
618 * FULL shows both authors but not dates.
619 * FULLER shows both authors and dates.
621 if (!memcmp(line
, "author ", 7)) {
622 strbuf_grow(sb
, linelen
+ 80);
623 pp_user_info("Author", fmt
, sb
, line
+ 7, dmode
, encoding
);
625 if (!memcmp(line
, "committer ", 10) &&
626 (fmt
== CMIT_FMT_FULL
|| fmt
== CMIT_FMT_FULLER
)) {
627 strbuf_grow(sb
, linelen
+ 80);
628 pp_user_info("Commit", fmt
, sb
, line
+ 10, dmode
, encoding
);
633 void pp_title_line(enum cmit_fmt fmt
,
637 const char *after_subject
,
638 const char *encoding
,
643 strbuf_init(&title
, 80);
646 const char *line
= *msg_p
;
647 int linelen
= get_one_line(line
);
650 if (!linelen
|| is_empty_line(line
, &linelen
))
653 strbuf_grow(&title
, linelen
+ 2);
655 if (fmt
== CMIT_FMT_EMAIL
) {
656 strbuf_addch(&title
, '\n');
658 strbuf_addch(&title
, ' ');
660 strbuf_add(&title
, line
, linelen
);
663 strbuf_grow(sb
, title
.len
+ 1024);
665 strbuf_addstr(sb
, subject
);
666 add_rfc2047(sb
, title
.buf
, title
.len
, encoding
);
668 strbuf_addbuf(sb
, &title
);
670 strbuf_addch(sb
, '\n');
672 if (plain_non_ascii
) {
673 const char *header_fmt
=
674 "MIME-Version: 1.0\n"
675 "Content-Type: text/plain; charset=%s\n"
676 "Content-Transfer-Encoding: 8bit\n";
677 strbuf_addf(sb
, header_fmt
, encoding
);
680 strbuf_addstr(sb
, after_subject
);
682 if (fmt
== CMIT_FMT_EMAIL
) {
683 strbuf_addch(sb
, '\n');
685 strbuf_release(&title
);
688 void pp_remainder(enum cmit_fmt fmt
,
695 const char *line
= *msg_p
;
696 int linelen
= get_one_line(line
);
702 if (is_empty_line(line
, &linelen
)) {
705 if (fmt
== CMIT_FMT_SHORT
)
710 strbuf_grow(sb
, linelen
+ indent
+ 20);
712 memset(sb
->buf
+ sb
->len
, ' ', indent
);
713 strbuf_setlen(sb
, sb
->len
+ indent
);
715 strbuf_add(sb
, line
, linelen
);
716 strbuf_addch(sb
, '\n');
720 void pretty_print_commit(enum cmit_fmt fmt
, const struct commit
*commit
,
721 struct strbuf
*sb
, int abbrev
,
722 const char *subject
, const char *after_subject
,
723 enum date_mode dmode
, int plain_non_ascii
)
725 unsigned long beginning_of_body
;
727 const char *msg
= commit
->buffer
;
729 const char *encoding
;
731 if (fmt
== CMIT_FMT_USERFORMAT
) {
732 format_commit_message(commit
, user_format
, sb
);
736 encoding
= (git_log_output_encoding
737 ? git_log_output_encoding
738 : git_commit_encoding
);
741 reencoded
= logmsg_reencode(commit
, encoding
);
746 if (fmt
== CMIT_FMT_ONELINE
|| fmt
== CMIT_FMT_EMAIL
)
749 /* After-subject is used to pass in Content-Type: multipart
750 * MIME header; in that case we do not have to do the
751 * plaintext content type even if the commit message has
752 * non 7-bit ASCII character. Otherwise, check if we need
753 * to say this is not a 7-bit ASCII.
755 if (fmt
== CMIT_FMT_EMAIL
&& !after_subject
) {
758 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
760 /* author could be non 7-bit ASCII but
761 * the log may be so; skip over the
764 if (ch
== '\n' && msg
[i
+1] == '\n')
767 else if (non_ascii(ch
)) {
774 pp_header(fmt
, abbrev
, dmode
, encoding
, commit
, &msg
, sb
);
775 if (fmt
!= CMIT_FMT_ONELINE
&& !subject
) {
776 strbuf_addch(sb
, '\n');
779 /* Skip excess blank lines at the beginning of body, if any... */
781 int linelen
= get_one_line(msg
);
785 if (!is_empty_line(msg
, &ll
))
790 /* These formats treat the title line specially. */
791 if (fmt
== CMIT_FMT_ONELINE
|| fmt
== CMIT_FMT_EMAIL
)
792 pp_title_line(fmt
, &msg
, sb
, subject
,
793 after_subject
, encoding
, plain_non_ascii
);
795 beginning_of_body
= sb
->len
;
796 if (fmt
!= CMIT_FMT_ONELINE
)
797 pp_remainder(fmt
, &msg
, sb
, indent
);
800 /* Make sure there is an EOLN for the non-oneline case */
801 if (fmt
!= CMIT_FMT_ONELINE
)
802 strbuf_addch(sb
, '\n');
805 * The caller may append additional body text in e-mail
806 * format. Make sure we did not strip the blank line
807 * between the header and the body.
809 if (fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
810 strbuf_addch(sb
, '\n');