pretty.c 44.9 KB
Newer Older
1
#include "cache.h"
2
#include "config.h"
3 4 5 6
#include "commit.h"
#include "utf8.h"
#include "diff.h"
#include "revision.h"
7
#include "string-list.h"
8
#include "mailmap.h"
9
#include "log-tree.h"
J
Johannes Schindelin 已提交
10
#include "notes.h"
J
Jeff King 已提交
11
#include "color.h"
12
#include "reflog-walk.h"
J
Junio C Hamano 已提交
13
#include "gpg-interface.h"
14
#include "trailer.h"
15 16

static char *user_format;
17 18 19 20
static struct cmt_fmt_map {
	const char *name;
	enum cmit_fmt format;
	int is_tformat;
21
	int expand_tabs_in_log;
22 23
	int is_alias;
	const char *user_format;
24
} *commit_formats;
25
static size_t builtin_formats_len;
26
static size_t commit_formats_len;
27
static size_t commit_formats_alloc;
28
static struct cmt_fmt_map *find_commit_format(const char *sought);
29

30 31 32 33 34
int commit_format_is_empty(enum cmit_fmt fmt)
{
	return fmt == CMIT_FMT_USERFORMAT && !*user_format;
}

35 36 37 38 39 40 41 42 43
static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
{
	free(user_format);
	user_format = xstrdup(cp);
	if (is_tformat)
		rev->use_terminator = 1;
	rev->commit_format = CMIT_FMT_USERFORMAT;
}

44
static int git_pretty_formats_config(const char *var, const char *value, void *cb)
45
{
46 47 48
	struct cmt_fmt_map *commit_format = NULL;
	const char *name;
	const char *fmt;
49
	int i;
50

51
	if (!skip_prefix(var, "pretty.", &name))
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
		return 0;

	for (i = 0; i < builtin_formats_len; i++) {
		if (!strcmp(commit_formats[i].name, name))
			return 0;
	}

	for (i = builtin_formats_len; i < commit_formats_len; i++) {
		if (!strcmp(commit_formats[i].name, name)) {
			commit_format = &commit_formats[i];
			break;
		}
	}

	if (!commit_format) {
		ALLOC_GROW(commit_formats, commit_formats_len+1,
			   commit_formats_alloc);
		commit_format = &commit_formats[commit_formats_len];
70
		memset(commit_format, 0, sizeof(*commit_format));
71 72 73 74 75
		commit_formats_len++;
	}

	commit_format->name = xstrdup(name);
	commit_format->format = CMIT_FMT_USERFORMAT;
76 77 78
	if (git_config_string(&fmt, var, value))
		return -1;

79 80 81
	if (skip_prefix(fmt, "format:", &fmt))
		commit_format->is_tformat = 0;
	else if (skip_prefix(fmt, "tformat:", &fmt) || strchr(fmt, '%'))
82 83 84 85 86 87 88 89
		commit_format->is_tformat = 1;
	else
		commit_format->is_alias = 1;
	commit_format->user_format = fmt;

	return 0;
}

90
static void setup_commit_formats(void)
91
{
92
	struct cmt_fmt_map builtin_formats[] = {
93
		{ "raw",	CMIT_FMT_RAW,		0,	0 },
94
		{ "medium",	CMIT_FMT_MEDIUM,	0,	8 },
95 96
		{ "short",	CMIT_FMT_SHORT,		0,	0 },
		{ "email",	CMIT_FMT_EMAIL,		0,	0 },
97
		{ "mboxrd",	CMIT_FMT_MBOXRD,	0,	0 },
98 99
		{ "fuller",	CMIT_FMT_FULLER,	0,	8 },
		{ "full",	CMIT_FMT_FULL,		0,	8 },
100
		{ "oneline",	CMIT_FMT_ONELINE,	1,	0 }
101
	};
102
	commit_formats_len = ARRAY_SIZE(builtin_formats);
103 104
	builtin_formats_len = commit_formats_len;
	ALLOC_GROW(commit_formats, commit_formats_len, commit_formats_alloc);
105 106
	memcpy(commit_formats, builtin_formats,
	       sizeof(*builtin_formats)*ARRAY_SIZE(builtin_formats));
107 108

	git_config(git_pretty_formats_config, NULL);
109 110
}

111 112 113
static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
							const char *original,
							int num_redirections)
114 115 116 117 118
{
	struct cmt_fmt_map *found = NULL;
	size_t found_match_len = 0;
	int i;

119 120 121 122
	if (num_redirections >= commit_formats_len)
		die("invalid --pretty format: "
		    "'%s' references an alias which points to itself",
		    original);
123 124 125 126

	for (i = 0; i < commit_formats_len; i++) {
		size_t match_len;

127
		if (!starts_with(commit_formats[i].name, sought))
128 129 130 131 132 133 134 135
			continue;

		match_len = strlen(commit_formats[i].name);
		if (found == NULL || found_match_len > match_len) {
			found = &commit_formats[i];
			found_match_len = match_len;
		}
	}
136 137 138 139 140 141 142

	if (found && found->is_alias) {
		found = find_commit_format_recursive(found->user_format,
						     original,
						     num_redirections+1);
	}

143 144 145
	return found;
}

146 147 148 149 150 151 152 153
static struct cmt_fmt_map *find_commit_format(const char *sought)
{
	if (!commit_formats)
		setup_commit_formats();

	return find_commit_format_recursive(sought, sought, 0);
}

154 155 156
void get_commit_format(const char *arg, struct rev_info *rev)
{
	struct cmt_fmt_map *commit_format;
157

158
	rev->use_terminator = 0;
159
	if (!arg) {
160 161 162
		rev->commit_format = CMIT_FMT_DEFAULT;
		return;
	}
163 164
	if (skip_prefix(arg, "format:", &arg)) {
		save_user_format(rev, arg, 0);
165
		return;
166
	}
167

168
	if (!*arg || skip_prefix(arg, "tformat:", &arg) || strchr(arg, '%')) {
169 170 171
		save_user_format(rev, arg, 1);
		return;
	}
172

173 174 175 176 177 178
	commit_format = find_commit_format(arg);
	if (!commit_format)
		die("invalid --pretty format: %s", arg);

	rev->commit_format = commit_format->format;
	rev->use_terminator = commit_format->is_tformat;
179
	rev->expand_tabs_in_log_default = commit_format->expand_tabs_in_log;
180 181 182 183
	if (commit_format->format == CMIT_FMT_USERFORMAT) {
		save_user_format(rev, commit_format->user_format,
				 commit_format->is_tformat);
	}
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
}

/*
 * Generic support for pretty-printing the header
 */
static int get_one_line(const char *msg)
{
	int ret = 0;

	for (;;) {
		char c = *msg++;
		if (!c)
			break;
		ret++;
		if (c == '\n')
			break;
	}
	return ret;
}

/* High bit set, or ISO-2022-INT */
205
static int non_ascii(int ch)
206
{
R
René Scharfe 已提交
207
	return !isascii(ch) || ch == '\033';
208 209
}

210 211 212 213 214 215 216 217 218 219 220 221
int has_non_ascii(const char *s)
{
	int ch;
	if (!s)
		return 0;
	while ((ch = *s++) != '\0') {
		if (non_ascii(ch))
			return 1;
	}
	return 0;
}

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
static int is_rfc822_special(char ch)
{
	switch (ch) {
	case '(':
	case ')':
	case '<':
	case '>':
	case '[':
	case ']':
	case ':':
	case ';':
	case '@':
	case ',':
	case '.':
	case '"':
	case '\\':
		return 1;
	default:
		return 0;
	}
}

244
static int needs_rfc822_quoting(const char *s, int len)
245 246 247 248 249 250 251 252
{
	int i;
	for (i = 0; i < len; i++)
		if (is_rfc822_special(s[i]))
			return 1;
	return 0;
}

253 254 255 256 257 258 259 260 261 262 263
static int last_line_length(struct strbuf *sb)
{
	int i;

	/* How many bytes are already used on the last line? */
	for (i = sb->len - 1; i >= 0; i--)
		if (sb->buf[i] == '\n')
			break;
	return sb->len - (i + 1);
}

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
{
	int i;

	/* just a guess, we may have to also backslash-quote */
	strbuf_grow(out, len + 2);

	strbuf_addch(out, '"');
	for (i = 0; i < len; i++) {
		switch (s[i]) {
		case '"':
		case '\\':
			strbuf_addch(out, '\\');
			/* fall through */
		default:
			strbuf_addch(out, s[i]);
		}
	}
	strbuf_addch(out, '"');
}

285 286
enum rfc2047_type {
	RFC2047_SUBJECT,
287
	RFC2047_ADDRESS
288 289 290
};

static int is_rfc2047_special(char ch, enum rfc2047_type type)
291
{
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
	/*
	 * rfc2047, section 4.2:
	 *
	 *    8-bit values which correspond to printable ASCII characters other
	 *    than "=", "?", and "_" (underscore), MAY be represented as those
	 *    characters.  (But see section 5 for restrictions.)  In
	 *    particular, SPACE and TAB MUST NOT be represented as themselves
	 *    within encoded words.
	 */

	/*
	 * rule out non-ASCII characters and non-printable characters (the
	 * non-ASCII check should be redundant as isprint() is not localized
	 * and only knows about ASCII, but be defensive about that)
	 */
	if (non_ascii(ch) || !isprint(ch))
		return 1;

	/*
	 * rule out special printable characters (' ' should be the only
	 * whitespace character considered printable, but be defensive and use
	 * isspace())
	 */
	if (isspace(ch) || ch == '=' || ch == '?' || ch == '_')
316 317
		return 1;

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
	/*
	 * rfc2047, section 5.3:
	 *
	 *    As a replacement for a 'word' entity within a 'phrase', for example,
	 *    one that precedes an address in a From, To, or Cc header.  The ABNF
	 *    definition for 'phrase' from RFC 822 thus becomes:
	 *
	 *    phrase = 1*( encoded-word / word )
	 *
	 *    In this case the set of characters that may be used in a "Q"-encoded
	 *    'encoded-word' is restricted to: <upper and lower case ASCII
	 *    letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
	 *    (underscore, ASCII 95.)>.  An 'encoded-word' that appears within a
	 *    'phrase' MUST be separated from any adjacent 'word', 'text' or
	 *    'special' by 'linear-white-space'.
	 */

	if (type != RFC2047_ADDRESS)
		return 0;

	/* '=' and '_' are special cases and have been checked above */
	return !(isalnum(ch) || ch == '!' || ch == '*' || ch == '+' || ch == '-' || ch == '/');
340 341
}

342 343
static int needs_rfc2047_encoding(const char *line, int len,
				  enum rfc2047_type type)
344
{
J
Jeff King 已提交
345
	int i;
346 347 348

	for (i = 0; i < len; i++) {
		int ch = line[i];
349
		if (non_ascii(ch) || ch == '\n')
350
			return 1;
351
		if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
352
			return 1;
353 354
	}

355 356 357
	return 0;
}

358
static void add_rfc2047(struct strbuf *sb, const char *line, size_t len,
359 360 361 362 363 364
		       const char *encoding, enum rfc2047_type type)
{
	static const int max_encoded_length = 76; /* per rfc2047 */
	int i;
	int line_len = last_line_length(sb);

365 366
	strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
	strbuf_addf(sb, "=?%s?q?", encoding);
J
Jeff King 已提交
367
	line_len += strlen(encoding) + 5; /* 5 for =??q? */
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

	while (len) {
		/*
		 * RFC 2047, section 5 (3):
		 *
		 * Each 'encoded-word' MUST represent an integral number of
		 * characters.  A multi-octet character may not be split across
		 * adjacent 'encoded- word's.
		 */
		const unsigned char *p = (const unsigned char *)line;
		int chrlen = mbs_chrlen(&line, &len, encoding);
		int is_special = (chrlen > 1) || is_rfc2047_special(*p, type);

		/* "=%02X" * chrlen, or the byte itself */
		const char *encoded_fmt = is_special ? "=%02X"    : "%c";
		int	    encoded_len = is_special ? 3 * chrlen : 1;
384 385 386 387 388 389 390 391

		/*
		 * According to RFC 2047, we could encode the special character
		 * ' ' (space) with '_' (underscore) for readability. But many
		 * programs do not understand this and just leave the
		 * underscore in place. Thus, we do nothing special here, which
		 * causes ' ' to be encoded as '=20', avoiding this problem.
		 */
J
Jeff King 已提交
392

393 394
		if (line_len + encoded_len + 2 > max_encoded_length) {
			/* It won't fit with trailing "?=" --- break the line */
J
Jeff King 已提交
395 396 397 398
			strbuf_addf(sb, "?=\n =?%s?q?", encoding);
			line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
		}

399 400 401
		for (i = 0; i < chrlen; i++)
			strbuf_addf(sb, encoded_fmt, p[i]);
		line_len += encoded_len;
402 403 404 405
	}
	strbuf_addstr(sb, "?=");
}

J
Jeff King 已提交
406
const char *show_ident_date(const struct ident_split *ident,
407
			    const struct date_mode *mode)
408
{
409
	timestamp_t date = 0;
J
Jeff King 已提交
410
	long tz = 0;
411 412

	if (ident->date_begin && ident->date_end)
413
		date = parse_timestamp(ident->date_begin, NULL, 10);
414 415 416 417 418
	if (date_overflows(date))
		date = 0;
	else {
		if (ident->tz_begin && ident->tz_end)
			tz = strtol(ident->tz_begin, NULL, 10);
J
Jeff King 已提交
419
		if (tz >= INT_MAX || tz <= INT_MIN)
420 421
			tz = 0;
	}
422 423 424
	return show_date(date, tz, mode);
}

425
void pp_user_info(struct pretty_print_context *pp,
426 427
		  const char *what, struct strbuf *sb,
		  const char *line, const char *encoding)
428
{
429
	struct ident_split ident;
430
	char *line_end;
431 432
	const char *mailbuf, *namebuf;
	size_t namelen, maillen;
433
	int max_length = 78; /* per rfc2822 */
434

435
	if (pp->fmt == CMIT_FMT_ONELINE)
436
		return;
437

438 439
	line_end = strchrnul(line, '\n');
	if (split_ident_line(&ident, line, line_end - line))
440
		return;
441

442 443 444 445 446 447 448 449
	mailbuf = ident.mail_begin;
	maillen = ident.mail_end - ident.mail_begin;
	namebuf = ident.name_begin;
	namelen = ident.name_end - ident.name_begin;

	if (pp->mailmap)
		map_user(pp->mailmap, &mailbuf, &maillen, &namebuf, &namelen);

450
	if (cmit_fmt_is_mail(pp->fmt)) {
451
		if (pp->from_ident && ident_cmp(pp->from_ident, &ident)) {
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
			struct strbuf buf = STRBUF_INIT;

			strbuf_addstr(&buf, "From: ");
			strbuf_add(&buf, namebuf, namelen);
			strbuf_addstr(&buf, " <");
			strbuf_add(&buf, mailbuf, maillen);
			strbuf_addstr(&buf, ">\n");
			string_list_append(&pp->in_body_headers,
					   strbuf_detach(&buf, NULL));

			mailbuf = pp->from_ident->mail_begin;
			maillen = pp->from_ident->mail_end - mailbuf;
			namebuf = pp->from_ident->name_begin;
			namelen = pp->from_ident->name_end - namebuf;
		}

468
		strbuf_addstr(sb, "From: ");
469 470
		if (needs_rfc2047_encoding(namebuf, namelen, RFC2047_ADDRESS)) {
			add_rfc2047(sb, namebuf, namelen,
471
				    encoding, RFC2047_ADDRESS);
472
			max_length = 76; /* per rfc2047 */
473
		} else if (needs_rfc822_quoting(namebuf, namelen)) {
474
			struct strbuf quoted = STRBUF_INIT;
475
			add_rfc822_quoted(&quoted, namebuf, namelen);
476 477
			strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
							-6, 1, max_length);
478
			strbuf_release(&quoted);
479
		} else {
480
			strbuf_add_wrapped_bytes(sb, namebuf, namelen,
481
						 -6, 1, max_length);
482
		}
483

484 485 486
		if (max_length <
		    last_line_length(sb) + strlen(" <") + maillen + strlen(">"))
			strbuf_addch(sb, '\n');
487
		strbuf_addf(sb, " <%.*s>\n", (int)maillen, mailbuf);
488
	} else {
489 490 491
		strbuf_addf(sb, "%s: %.*s%.*s <%.*s>\n", what,
			    (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0, "    ",
			    (int)namelen, namebuf, (int)maillen, mailbuf);
492
	}
493

494
	switch (pp->fmt) {
495
	case CMIT_FMT_MEDIUM:
496
		strbuf_addf(sb, "Date:   %s\n",
497
			    show_ident_date(&ident, &pp->date_mode));
498 499
		break;
	case CMIT_FMT_EMAIL:
500
	case CMIT_FMT_MBOXRD:
501
		strbuf_addf(sb, "Date: %s\n",
502
			    show_ident_date(&ident, DATE_MODE(RFC2822)));
503 504
		break;
	case CMIT_FMT_FULLER:
505
		strbuf_addf(sb, "%sDate: %s\n", what,
506
			    show_ident_date(&ident, &pp->date_mode));
507 508 509 510 511 512 513
		break;
	default:
		/* notin' */
		break;
	}
}

514
static int is_blank_line(const char *line, int *len_p)
515 516
{
	int len = *len_p;
F
Felipe Contreras 已提交
517
	while (len && isspace(line[len - 1]))
518 519 520 521 522
		len--;
	*len_p = len;
	return !len;
}

523
const char *skip_blank_lines(const char *msg)
524 525 526 527 528 529
{
	for (;;) {
		int linelen = get_one_line(msg);
		int ll = linelen;
		if (!linelen)
			break;
530
		if (!is_blank_line(msg, &ll))
531 532 533 534 535 536
			break;
		msg += linelen;
	}
	return msg;
}

537 538
static void add_merge_info(const struct pretty_print_context *pp,
			   struct strbuf *sb, const struct commit *commit)
539 540 541
{
	struct commit_list *parent = commit->parents;

542
	if ((pp->fmt == CMIT_FMT_ONELINE) || (cmit_fmt_is_mail(pp->fmt)) ||
543 544 545 546 547 548
	    !parent || !parent->next)
		return;

	strbuf_addstr(sb, "Merge:");

	while (parent) {
549 550
		struct object_id *oidp = &parent->item->object.oid;
		strbuf_addch(sb, ' ');
551
		if (pp->abbrev)
552 553 554
			strbuf_add_unique_abbrev(sb, oidp->hash, pp->abbrev);
		else
			strbuf_addstr(sb, oid_to_hex(oidp));
555 556 557 558 559
		parent = parent->next;
	}
	strbuf_addch(sb, '\n');
}

560
static char *get_header(const char *msg, const char *key)
561
{
562 563 564
	size_t len;
	const char *v = find_commit_header(msg, key, &len);
	return v ? xmemdupz(v, len) : NULL;
565 566 567 568
}

static char *replace_encoding_header(char *buf, const char *encoding)
{
569
	struct strbuf tmp = STRBUF_INIT;
570 571 572 573
	size_t start, len;
	char *cp = buf;

	/* guess if there is an encoding header before a \n\n */
574
	while (!starts_with(cp, "encoding ")) {
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
		cp = strchr(cp, '\n');
		if (!cp || *++cp == '\n')
			return buf;
	}
	start = cp - buf;
	cp = strchr(cp, '\n');
	if (!cp)
		return buf; /* should not happen but be defensive */
	len = cp + 1 - (buf + start);

	strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
	if (is_encoding_utf8(encoding)) {
		/* we have re-coded to UTF-8; drop the header */
		strbuf_remove(&tmp, start, len);
	} else {
		/* just replaces XXXX in 'encoding XXXX\n' */
		strbuf_splice(&tmp, start + strlen("encoding "),
					  len - strlen("encoding \n"),
					  encoding, strlen(encoding));
	}
	return strbuf_detach(&tmp, NULL);
}

J
Jeff King 已提交
598 599 600
const char *logmsg_reencode(const struct commit *commit,
			    char **commit_encoding,
			    const char *output_encoding)
601
{
602
	static const char *utf8 = "UTF-8";
603 604
	const char *use_encoding;
	char *encoding;
605
	const char *msg = get_commit_buffer(commit, NULL);
606 607
	char *out;

608 609
	if (!output_encoding || !*output_encoding) {
		if (commit_encoding)
610
			*commit_encoding = get_header(msg, "encoding");
J
Jeff King 已提交
611
		return msg;
612
	}
613
	encoding = get_header(msg, "encoding");
614 615
	if (commit_encoding)
		*commit_encoding = encoding;
616
	use_encoding = encoding ? encoding : utf8;
617 618 619 620 621 622 623 624 625 626 627 628 629
	if (same_encoding(use_encoding, output_encoding)) {
		/*
		 * No encoding work to be done. If we have no encoding header
		 * at all, then there's nothing to do, and we can return the
		 * message verbatim (whether newly allocated or not).
		 */
		if (!encoding)
			return msg;

		/*
		 * Otherwise, we still want to munge the encoding header in the
		 * result, which will be done by modifying the buffer. If we
		 * are using a fresh copy, we can reuse it. But if we are using
630 631
		 * the cached copy from get_commit_buffer, we need to duplicate it
		 * to avoid munging the cached copy.
632
		 */
633
		if (msg == get_cached_commit_buffer(commit, NULL))
634 635 636
			out = xstrdup(msg);
		else
			out = (char *)msg;
637 638 639 640 641 642 643 644 645
	}
	else {
		/*
		 * There's actual encoding work to do. Do the reencoding, which
		 * still leaves the header to be replaced in the next step. At
		 * this point, we are done with msg. If we allocated a fresh
		 * copy, we can free it.
		 */
		out = reencode_string(msg, output_encoding, use_encoding);
646 647
		if (out)
			unuse_commit_buffer(commit, msg);
648 649 650 651 652 653
	}

	/*
	 * This replacement actually consumes the buffer we hand it, so we do
	 * not have to worry about freeing the old "out" here.
	 */
654 655 656
	if (out)
		out = replace_encoding_header(out, output_encoding);

657 658
	if (!commit_encoding)
		free(encoding);
J
Jeff King 已提交
659 660 661 662 663 664 665
	/*
	 * If the re-encoding failed, out might be NULL here; in that
	 * case we just return the commit message verbatim.
	 */
	return out ? out : msg;
}

666 667
static int mailmap_name(const char **email, size_t *email_len,
			const char **name, size_t *name_len)
668
{
669
	static struct string_list *mail_map;
670 671
	if (!mail_map) {
		mail_map = xcalloc(1, sizeof(*mail_map));
672
		read_mailmap(mail_map, NULL);
673
	}
674
	return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
675 676
}

677
static size_t format_person_part(struct strbuf *sb, char part,
678 679
				 const char *msg, int len,
				 const struct date_mode *dmode)
680
{
681 682
	/* currently all placeholders have same length */
	const int placeholder_len = 2;
683
	struct ident_split s;
684 685
	const char *name, *mail;
	size_t maillen, namelen;
686

687
	if (split_ident_line(&s, msg, len) < 0)
688 689
		goto skip;

690 691 692 693 694 695 696
	name = s.name_begin;
	namelen = s.name_end - s.name_begin;
	mail = s.mail_begin;
	maillen = s.mail_end - s.mail_begin;

	if (part == 'N' || part == 'E') /* mailmap lookup */
		mailmap_name(&mail, &maillen, &name, &namelen);
697
	if (part == 'n' || part == 'N') {	/* name */
698
		strbuf_add(sb, name, namelen);
699
		return placeholder_len;
700
	}
701
	if (part == 'e' || part == 'E') {	/* email */
702
		strbuf_add(sb, mail, maillen);
703
		return placeholder_len;
704
	}
705

706
	if (!s.date_begin)
707
		goto skip;
708

709
	if (part == 't') {	/* date, UNIX timestamp */
710
		strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
711
		return placeholder_len;
712
	}
713

714 715
	switch (part) {
	case 'd':	/* date */
716
		strbuf_addstr(sb, show_ident_date(&s, dmode));
717
		return placeholder_len;
718
	case 'D':	/* date, RFC2822 style */
719
		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(RFC2822)));
720
		return placeholder_len;
721
	case 'r':	/* date, relative */
722
		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(RELATIVE)));
723
		return placeholder_len;
724
	case 'i':	/* date, ISO 8601-like */
725
		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601)));
726
		return placeholder_len;
727
	case 'I':	/* date, ISO 8601 strict */
728
		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601_STRICT)));
729
		return placeholder_len;
730
	}
731 732 733

skip:
	/*
734 735 736
	 * reading from either a bogus commit, or a reflog entry with
	 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
	 * to compute a valid return value.
737 738 739 740 741 742
	 */
	if (part == 'n' || part == 'e' || part == 't' || part == 'd'
	    || part == 'D' || part == 'r' || part == 'i')
		return placeholder_len;

	return 0; /* unknown placeholder */
743 744
}

745 746 747 748 749
struct chunk {
	size_t off;
	size_t len;
};

750 751 752 753
enum flush_type {
	no_flush,
	flush_right,
	flush_left,
754
	flush_left_and_steal,
755 756 757
	flush_both
};

758 759 760 761 762 763 764
enum trunc_type {
	trunc_none,
	trunc_left,
	trunc_middle,
	trunc_right
};

765 766
struct format_commit_context {
	const struct commit *commit;
767
	const struct pretty_print_context *pretty_ctx;
768 769
	unsigned commit_header_parsed:1;
	unsigned commit_message_parsed:1;
770
	struct signature_check signature_check;
771
	enum flush_type flush_type;
772
	enum trunc_type truncate;
J
Jeff King 已提交
773
	const char *message;
774
	char *commit_encoding;
775
	size_t width, indent1, indent2;
776
	int auto_color;
777
	int padding;
778 779 780 781

	/* These offsets are relative to the start of the commit message. */
	struct chunk author;
	struct chunk committer;
782 783
	size_t message_off;
	size_t subject_off;
784
	size_t body_off;
785 786

	/* The following ones are relative to the result struct strbuf. */
787
	size_t wrap_start;
788 789 790
};

static void parse_commit_header(struct format_commit_context *context)
791
{
792
	const char *msg = context->message;
793
	int i;
794

795
	for (i = 0; msg[i]; i++) {
796
		const char *name;
797 798 799 800 801
		int eol;
		for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
			; /* do nothing */

		if (i == eol) {
802
			break;
803 804 805 806 807 808
		} else if (skip_prefix(msg + i, "author ", &name)) {
			context->author.off = name - msg;
			context->author.len = msg + eol - name;
		} else if (skip_prefix(msg + i, "committer ", &name)) {
			context->committer.off = name - msg;
			context->committer.len = msg + eol - name;
809 810 811
		}
		i = eol;
	}
812
	context->message_off = i;
813 814 815
	context->commit_header_parsed = 1;
}

816 817 818 819 820 821 822 823 824
static int istitlechar(char c)
{
	return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
		(c >= '0' && c <= '9') || c == '.' || c == '_';
}

static void format_sanitized_subject(struct strbuf *sb, const char *msg)
{
	size_t trimlen;
825
	size_t start_len = sb->len;
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
	int space = 2;

	for (; *msg && *msg != '\n'; msg++) {
		if (istitlechar(*msg)) {
			if (space == 1)
				strbuf_addch(sb, '-');
			space = 0;
			strbuf_addch(sb, *msg);
			if (*msg == '.')
				while (*(msg+1) == '.')
					msg++;
		} else
			space |= 1;
	}

	/* trim any trailing '.' or '-' characters */
	trimlen = 0;
843 844 845
	while (sb->len - trimlen > start_len &&
		(sb->buf[sb->len - 1 - trimlen] == '.'
		|| sb->buf[sb->len - 1 - trimlen] == '-'))
846 847 848 849
		trimlen++;
	strbuf_remove(sb, sb->len - trimlen, trimlen);
}

850 851
const char *format_subject(struct strbuf *sb, const char *msg,
			   const char *line_separator)
852 853 854 855 856 857 858 859
{
	int first = 1;

	for (;;) {
		const char *line = msg;
		int linelen = get_one_line(line);

		msg += linelen;
860
		if (!linelen || is_blank_line(line, &linelen))
861 862
			break;

863 864
		if (!sb)
			continue;
865 866 867 868 869 870 871 872 873
		strbuf_grow(sb, linelen + 2);
		if (!first)
			strbuf_addstr(sb, line_separator);
		strbuf_add(sb, line, linelen);
		first = 0;
	}
	return msg;
}

874 875 876 877 878 879 880 881 882 883
static void format_trailers(struct strbuf *sb, const char *msg)
{
	struct trailer_info info;

	trailer_info_get(&info, msg);
	strbuf_add(sb, info.trailer_start,
		   info.trailer_end - info.trailer_start);
	trailer_info_release(&info);
}

884 885
static void parse_commit_message(struct format_commit_context *c)
{
886 887
	const char *msg = c->message + c->message_off;
	const char *start = c->message;
888

889
	msg = skip_blank_lines(msg);
890 891 892
	c->subject_off = msg - start;

	msg = format_subject(NULL, msg, NULL);
893
	msg = skip_blank_lines(msg);
894 895 896 897 898
	c->body_off = msg - start;

	c->commit_message_parsed = 1;
}

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
static void strbuf_wrap(struct strbuf *sb, size_t pos,
			size_t width, size_t indent1, size_t indent2)
{
	struct strbuf tmp = STRBUF_INIT;

	if (pos)
		strbuf_add(&tmp, sb->buf, pos);
	strbuf_add_wrapped_text(&tmp, sb->buf + pos,
				(int) indent1, (int) indent2, (int) width);
	strbuf_swap(&tmp, sb);
	strbuf_release(&tmp);
}

static void rewrap_message_tail(struct strbuf *sb,
				struct format_commit_context *c,
				size_t new_width, size_t new_indent1,
				size_t new_indent2)
{
	if (c->width == new_width && c->indent1 == new_indent1 &&
	    c->indent2 == new_indent2)
		return;
920
	if (c->wrap_start < sb->len)
921 922 923 924 925 926 927
		strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
	c->wrap_start = sb->len;
	c->width = new_width;
	c->indent1 = new_indent1;
	c->indent2 = new_indent2;
}

928 929 930
static int format_reflog_person(struct strbuf *sb,
				char part,
				struct reflog_walk_info *log,
931
				const struct date_mode *dmode)
932 933 934 935 936 937 938 939 940 941 942 943 944
{
	const char *ident;

	if (!log)
		return 2;

	ident = get_reflog_ident(log);
	if (!ident)
		return 2;

	return format_person_part(sb, part, ident, strlen(ident), dmode);
}

945 946 947 948
static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
			  const char *placeholder,
			  struct format_commit_context *c)
{
949
	const char *rest = placeholder;
950
	const char *basic_color = NULL;
951

952 953 954 955 956 957 958
	if (placeholder[1] == '(') {
		const char *begin = placeholder + 2;
		const char *end = strchr(begin, ')');
		char color[COLOR_MAXLEN];

		if (!end)
			return 0;
959

960
		if (skip_prefix(begin, "auto,", &begin)) {
961 962
			if (!want_color(c->pretty_ctx->color))
				return end - placeholder + 1;
963 964 965 966 967 968
		} else if (skip_prefix(begin, "always,", &begin)) {
			/* nothing to do; we do not respect want_color at all */
		} else {
			/* the default is the same as "auto" */
			if (!want_color(c->pretty_ctx->color))
				return end - placeholder + 1;
969
		}
970

971 972
		if (color_parse_mem(begin, end - begin, color) < 0)
			die(_("unable to parse --pretty format"));
973 974 975
		strbuf_addstr(sb, color);
		return end - placeholder + 1;
	}
976 977 978 979 980 981

	/*
	 * We handle things like "%C(red)" above; for historical reasons, there
	 * are a few colors that can be specified without parentheses (and
	 * they cannot support things like "auto" or "always" at all).
	 */
982
	if (skip_prefix(placeholder + 1, "red", &rest))
983
		basic_color = GIT_COLOR_RED;
984
	else if (skip_prefix(placeholder + 1, "green", &rest))
985
		basic_color = GIT_COLOR_GREEN;
986
	else if (skip_prefix(placeholder + 1, "blue", &rest))
987
		basic_color = GIT_COLOR_BLUE;
988
	else if (skip_prefix(placeholder + 1, "reset", &rest))
989 990 991 992 993
		basic_color = GIT_COLOR_RESET;

	if (basic_color && want_color(c->pretty_ctx->color))
		strbuf_addstr(sb, basic_color);

994
	return rest - placeholder;
995 996
}

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
static size_t parse_padding_placeholder(struct strbuf *sb,
					const char *placeholder,
					struct format_commit_context *c)
{
	const char *ch = placeholder;
	enum flush_type flush_type;
	int to_column = 0;

	switch (*ch++) {
	case '<':
		flush_type = flush_right;
		break;
	case '>':
		if (*ch == '<') {
			flush_type = flush_both;
			ch++;
1013 1014 1015
		} else if (*ch == '>') {
			flush_type = flush_left_and_steal;
			ch++;
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
		} else
			flush_type = flush_left;
		break;
	default:
		return 0;
	}

	/* the next value means "wide enough to that column" */
	if (*ch == '|') {
		to_column = 1;
		ch++;
	}

	if (*ch == '(') {
		const char *start = ch + 1;
1031
		const char *end = start + strcspn(start, ",)");
1032 1033 1034 1035
		char *next;
		int width;
		if (!end || end == start)
			return 0;
1036
		width = strtol(start, &next, 10);
1037 1038
		if (next == start || width == 0)
			return 0;
1039 1040 1041 1042 1043 1044
		if (width < 0) {
			if (to_column)
				width += term_columns();
			if (width < 0)
				return 0;
		}
1045 1046
		c->padding = to_column ? -width : width;
		c->flush_type = flush_type;
1047 1048 1049 1050 1051 1052

		if (*end == ',') {
			start = end + 1;
			end = strchr(start, ')');
			if (!end || end == start)
				return 0;
1053
			if (starts_with(start, "trunc)"))
1054
				c->truncate = trunc_right;
1055
			else if (starts_with(start, "ltrunc)"))
1056
				c->truncate = trunc_left;
1057
			else if (starts_with(start, "mtrunc)"))
1058 1059 1060 1061 1062 1063
				c->truncate = trunc_middle;
			else
				return 0;
		} else
			c->truncate = trunc_none;

1064 1065 1066 1067 1068
		return end - placeholder + 1;
	}
	return 0;
}

1069 1070
static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
				const char *placeholder,
1071
				void *context)
1072 1073 1074
{
	struct format_commit_context *c = context;
	const struct commit *commit = c->commit;
1075
	const char *msg = c->message;
1076
	struct commit_list *p;
1077
	int ch;
1078 1079

	/* these are independent of the commit */
1080 1081
	switch (placeholder[0]) {
	case 'C':
1082
		if (starts_with(placeholder + 1, "(auto)")) {
1083
			c->auto_color = want_color(c->pretty_ctx->color);
1084
			if (c->auto_color && sb->len)
1085
				strbuf_addstr(sb, GIT_COLOR_RESET);
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
			return 7; /* consumed 7 bytes, "C(auto)" */
		} else {
			int ret = parse_color(sb, placeholder, c);
			if (ret)
				c->auto_color = 0;
			/*
			 * Otherwise, we decided to treat %C<unknown>
			 * as a literal string, and the previous
			 * %C(auto) is still valid.
			 */
			return ret;
J
Jeff King 已提交
1097
		}
1098 1099
	case 'n':		/* newline */
		strbuf_addch(sb, '\n');
1100
		return 1;
1101 1102
	case 'x':
		/* %x00 == NUL, %x0a == LF, etc. */
1103 1104
		ch = hex2chr(placeholder + 1);
		if (ch < 0)
1105
			return 0;
1106 1107
		strbuf_addch(sb, ch);
		return 3;
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
	case 'w':
		if (placeholder[1] == '(') {
			unsigned long width = 0, indent1 = 0, indent2 = 0;
			char *next;
			const char *start = placeholder + 2;
			const char *end = strchr(start, ')');
			if (!end)
				return 0;
			if (end > start) {
				width = strtoul(start, &next, 10);
				if (*next == ',') {
					indent1 = strtoul(next + 1, &next, 10);
					if (*next == ',') {
						indent2 = strtoul(next + 1,
								 &next, 10);
					}
				}
				if (*next != ')')
					return 0;
			}
			rewrap_message_tail(sb, c, width, indent1, indent2);
			return end - placeholder + 1;
		} else
			return 0;
1132 1133 1134 1135

	case '<':
	case '>':
		return parse_padding_placeholder(sb, placeholder, c);
1136
	}
1137 1138 1139

	/* these depend on the commit */
	if (!commit->object.parsed)
1140
		parse_object(&commit->object.oid);
1141

1142 1143
	switch (placeholder[0]) {
	case 'H':		/* commit hash */
1144
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1145
		strbuf_addstr(sb, oid_to_hex(&commit->object.oid));
1146
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1147
		return 1;
1148
	case 'h':		/* abbreviated commit hash */
1149
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1150 1151
		strbuf_add_unique_abbrev(sb, commit->object.oid.hash,
					 c->pretty_ctx->abbrev);
1152
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1153
		return 1;
1154
	case 'T':		/* tree hash */
1155
		strbuf_addstr(sb, oid_to_hex(&commit->tree->object.oid));
1156
		return 1;
1157
	case 't':		/* abbreviated tree hash */
1158 1159
		strbuf_add_unique_abbrev(sb, commit->tree->object.oid.hash,
					 c->pretty_ctx->abbrev);
1160
		return 1;
1161 1162 1163 1164
	case 'P':		/* parent hashes */
		for (p = commit->parents; p; p = p->next) {
			if (p != commit->parents)
				strbuf_addch(sb, ' ');
1165
			strbuf_addstr(sb, oid_to_hex(&p->item->object.oid));
1166
		}
1167
		return 1;
1168 1169 1170 1171
	case 'p':		/* abbreviated parent hashes */
		for (p = commit->parents; p; p = p->next) {
			if (p != commit->parents)
				strbuf_addch(sb, ' ');
1172 1173
			strbuf_add_unique_abbrev(sb, p->item->object.oid.hash,
						 c->pretty_ctx->abbrev);
1174
		}
1175
		return 1;
1176
	case 'm':		/* left/right/bottom */
1177
		strbuf_addstr(sb, get_revision_mark(NULL, commit));
1178
		return 1;
1179
	case 'd':
1180
		load_ref_decorations(DECORATE_SHORT_REFS);
1181
		format_decorations(sb, commit, c->auto_color);
1182
		return 1;
H
Harry Jeffery 已提交
1183 1184 1185 1186
	case 'D':
		load_ref_decorations(DECORATE_SHORT_REFS);
		format_decorations_extended(sb, commit, c->auto_color, "", ", ", "");
		return 1;
1187 1188 1189 1190 1191 1192 1193
	case 'g':		/* reflog info */
		switch(placeholder[1]) {
		case 'd':	/* reflog selector */
		case 'D':
			if (c->pretty_ctx->reflog_info)
				get_reflog_selector(sb,
						    c->pretty_ctx->reflog_info,
1194
						    &c->pretty_ctx->date_mode,
1195
						    c->pretty_ctx->date_mode_explicit,
1196 1197 1198 1199 1200 1201
						    (placeholder[1] == 'd'));
			return 2;
		case 's':	/* reflog message */
			if (c->pretty_ctx->reflog_info)
				get_reflog_message(sb, c->pretty_ctx->reflog_info);
			return 2;
1202 1203 1204 1205 1206 1207 1208
		case 'n':
		case 'N':
		case 'e':
		case 'E':
			return format_reflog_person(sb,
						    placeholder[1],
						    c->pretty_ctx->reflog_info,
1209
						    &c->pretty_ctx->date_mode);
1210 1211
		}
		return 0;	/* unknown %g placeholder */
1212
	case 'N':
1213 1214
		if (c->pretty_ctx->notes_message) {
			strbuf_addstr(sb, c->pretty_ctx->notes_message);
1215 1216 1217
			return 1;
		}
		return 0;
1218 1219
	}

J
Junio C Hamano 已提交
1220
	if (placeholder[0] == 'G') {
1221 1222
		if (!c->signature_check.result)
			check_commit_signature(c->commit, &(c->signature_check));
J
Junio C Hamano 已提交
1223 1224
		switch (placeholder[1]) {
		case 'G':
1225 1226
			if (c->signature_check.gpg_output)
				strbuf_addstr(sb, c->signature_check.gpg_output);
J
Junio C Hamano 已提交
1227 1228
			break;
		case '?':
1229
			switch (c->signature_check.result) {
J
Junio C Hamano 已提交
1230 1231
			case 'G':
			case 'B':
1232
			case 'E':
1233 1234
			case 'U':
			case 'N':
1235 1236 1237
			case 'X':
			case 'Y':
			case 'R':
1238
				strbuf_addch(sb, c->signature_check.result);
J
Junio C Hamano 已提交
1239 1240 1241
			}
			break;
		case 'S':
1242 1243
			if (c->signature_check.signer)
				strbuf_addstr(sb, c->signature_check.signer);
J
Junio C Hamano 已提交
1244
			break;
1245
		case 'K':
1246 1247
			if (c->signature_check.key)
				strbuf_addstr(sb, c->signature_check.key);
1248
			break;
1249 1250
		default:
			return 0;
J
Junio C Hamano 已提交
1251 1252 1253 1254 1255
		}
		return 2;
	}


1256
	/* For the rest we have to parse the commit header. */
1257 1258
	if (!c->commit_header_parsed)
		parse_commit_header(c);
1259

1260
	switch (placeholder[0]) {
1261 1262
	case 'a':	/* author ... */
		return format_person_part(sb, placeholder[1],
1263
				   msg + c->author.off, c->author.len,
1264
				   &c->pretty_ctx->date_mode);
1265 1266
	case 'c':	/* committer ... */
		return format_person_part(sb, placeholder[1],
1267
				   msg + c->committer.off, c->committer.len,
1268
				   &c->pretty_ctx->date_mode);
1269
	case 'e':	/* encoding */
1270 1271
		if (c->commit_encoding)
			strbuf_addstr(sb, c->commit_encoding);
1272
		return 1;
1273 1274 1275 1276
	case 'B':	/* raw body */
		/* message_off is always left at the initial newline */
		strbuf_addstr(sb, msg + c->message_off + 1);
		return 1;
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
	}

	/* Now we need to parse the commit message. */
	if (!c->commit_message_parsed)
		parse_commit_message(c);

	switch (placeholder[0]) {
	case 's':	/* subject */
		format_subject(sb, msg + c->subject_off, " ");
		return 1;
1287 1288 1289
	case 'f':	/* sanitized subject */
		format_sanitized_subject(sb, msg + c->subject_off);
		return 1;
1290
	case 'b':	/* body */
1291
		strbuf_addstr(sb, msg + c->body_off);
1292
		return 1;
1293
	}
1294 1295 1296 1297 1298 1299

	if (starts_with(placeholder, "(trailers)")) {
		format_trailers(sb, msg + c->subject_off);
		return strlen("(trailers)");
	}

1300
	return 0;	/* unknown placeholder */
1301 1302
}

1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
				    const char *placeholder,
				    struct format_commit_context *c)
{
	struct strbuf local_sb = STRBUF_INIT;
	int total_consumed = 0, len, padding = c->padding;
	if (padding < 0) {
		const char *start = strrchr(sb->buf, '\n');
		int occupied;
		if (!start)
			start = sb->buf;
		occupied = utf8_strnwidth(start, -1, 1);
1315
		occupied += c->pretty_ctx->graph_width;
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
		padding = (-padding) - occupied;
	}
	while (1) {
		int modifier = *placeholder == 'C';
		int consumed = format_commit_one(&local_sb, placeholder, c);
		total_consumed += consumed;

		if (!modifier)
			break;

		placeholder += consumed;
		if (*placeholder != '%')
			break;
		placeholder++;
		total_consumed++;
	}
	len = utf8_strnwidth(local_sb.buf, -1, 1);
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362

	if (c->flush_type == flush_left_and_steal) {
		const char *ch = sb->buf + sb->len - 1;
		while (len > padding && ch > sb->buf) {
			const char *p;
			if (*ch == ' ') {
				ch--;
				padding++;
				continue;
			}
			/* check for trailing ansi sequences */
			if (*ch != 'm')
				break;
			p = ch - 1;
			while (ch - p < 10 && *p != '\033')
				p--;
			if (*p != '\033' ||
			    ch + 1 - p != display_mode_esc_sequence_len(p))
				break;
			/*
			 * got a good ansi sequence, put it back to
			 * local_sb as we're cutting sb
			 */
			strbuf_insert(&local_sb, 0, p, ch + 1 - p);
			ch = p - 1;
		}
		strbuf_setlen(sb, ch + 1 - sb->buf);
		c->flush_type = flush_left;
	}

1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
	if (len > padding) {
		switch (c->truncate) {
		case trunc_left:
			strbuf_utf8_replace(&local_sb,
					    0, len - (padding - 2),
					    "..");
			break;
		case trunc_middle:
			strbuf_utf8_replace(&local_sb,
					    padding / 2 - 1,
					    len - (padding - 2),
					    "..");
			break;
		case trunc_right:
			strbuf_utf8_replace(&local_sb,
					    padding - 2, len - (padding - 2),
					    "..");
			break;
		case trunc_none:
			break;
		}
1384
		strbuf_addbuf(sb, &local_sb);
1385
	} else {
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
		int sb_len = sb->len, offset = 0;
		if (c->flush_type == flush_left)
			offset = padding - len;
		else if (c->flush_type == flush_both)
			offset = (padding - len) / 2;
		/*
		 * we calculate padding in columns, now
		 * convert it back to chars
		 */
		padding = padding - len + local_sb.len;
1396
		strbuf_addchars(sb, ' ', padding);
1397 1398 1399 1400 1401 1402 1403 1404
		memcpy(sb->buf + sb_len + offset, local_sb.buf,
		       local_sb.len);
	}
	strbuf_release(&local_sb);
	c->flush_type = no_flush;
	return total_consumed;
}

1405 1406
static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
				 const char *placeholder,
1407 1408 1409 1410 1411 1412 1413 1414
				 void *context)
{
	int consumed;
	size_t orig_len;
	enum {
		NO_MAGIC,
		ADD_LF_BEFORE_NON_EMPTY,
		DEL_LF_BEFORE_EMPTY,
1415
		ADD_SP_BEFORE_NON_EMPTY
1416 1417 1418 1419 1420 1421 1422 1423 1424
	} magic = NO_MAGIC;

	switch (placeholder[0]) {
	case '-':
		magic = DEL_LF_BEFORE_EMPTY;
		break;
	case '+':
		magic = ADD_LF_BEFORE_NON_EMPTY;
		break;
1425 1426 1427
	case ' ':
		magic = ADD_SP_BEFORE_NON_EMPTY;
		break;
1428 1429 1430 1431 1432 1433 1434
	default:
		break;
	}
	if (magic != NO_MAGIC)
		placeholder++;

	orig_len = sb->len;
1435 1436 1437 1438
	if (((struct format_commit_context *)context)->flush_type != no_flush)
		consumed = format_and_pad_commit(sb, placeholder, context);
	else
		consumed = format_commit_one(sb, placeholder, context);
1439 1440 1441 1442 1443 1444
	if (magic == NO_MAGIC)
		return consumed;

	if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
		while (sb->len && sb->buf[sb->len - 1] == '\n')
			strbuf_setlen(sb, sb->len - 1);
1445 1446 1447 1448 1449
	} else if (orig_len != sb->len) {
		if (magic == ADD_LF_BEFORE_NON_EMPTY)
			strbuf_insert(sb, orig_len, "\n", 1);
		else if (magic == ADD_SP_BEFORE_NON_EMPTY)
			strbuf_insert(sb, orig_len, " ", 1);
1450 1451 1452 1453
	}
	return consumed + 1;
}

1454 1455 1456 1457 1458
static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
				   void *context)
{
	struct userformat_want *w = context;

1459
	if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
		placeholder++;

	switch (*placeholder) {
	case 'N':
		w->notes = 1;
		break;
	}
	return 0;
}

void userformat_find_requirements(const char *fmt, struct userformat_want *w)
{
	struct strbuf dummy = STRBUF_INIT;

	if (!fmt) {
		if (!user_format)
			return;
		fmt = user_format;
	}
1479
	strbuf_expand(&dummy, fmt, userformat_want_item, w);
1480 1481 1482
	strbuf_release(&dummy);
}

1483
void format_commit_message(const struct commit *commit,
1484
			   const char *format, struct strbuf *sb,
1485
			   const struct pretty_print_context *pretty_ctx)
1486
{
1487
	struct format_commit_context context;
1488
	const char *output_enc = pretty_ctx->output_encoding;
1489
	const char *utf8 = "UTF-8";
1490 1491 1492

	memset(&context, 0, sizeof(context));
	context.commit = commit;
1493
	context.pretty_ctx = pretty_ctx;
1494
	context.wrap_start = sb->len;
1495 1496 1497 1498
	/*
	 * convert a commit message to UTF-8 first
	 * as far as 'format_commit_item' assumes it in UTF-8
	 */
1499 1500
	context.message = logmsg_reencode(commit,
					  &context.commit_encoding,
1501
					  utf8);
1502

1503
	strbuf_expand(sb, format, format_commit_item, &context);
1504
	rewrap_message_tail(sb, &context, 0, 0, 0);
1505

1506
	/* then convert a commit message to an actual output encoding */
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
	if (output_enc) {
		if (same_encoding(utf8, output_enc))
			output_enc = NULL;
	} else {
		if (context.commit_encoding &&
		    !same_encoding(context.commit_encoding, utf8))
			output_enc = context.commit_encoding;
	}

	if (output_enc) {
		int outsz;
		char *out = reencode_string_len(sb->buf, sb->len,
						output_enc, utf8, &outsz);
		if (out)
			strbuf_attach(sb, out, outsz, outsz + 1);
	}

1524
	free(context.commit_encoding);
1525
	unuse_commit_buffer(commit, context.message);
1526 1527
}

1528
static void pp_header(struct pretty_print_context *pp,
1529 1530 1531 1532 1533 1534 1535 1536
		      const char *encoding,
		      const struct commit *commit,
		      const char **msg_p,
		      struct strbuf *sb)
{
	int parents_shown = 0;

	for (;;) {
1537
		const char *name, *line = *msg_p;
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
		int linelen = get_one_line(*msg_p);

		if (!linelen)
			return;
		*msg_p += linelen;

		if (linelen == 1)
			/* End of header */
			return;

1548
		if (pp->fmt == CMIT_FMT_RAW) {
1549 1550 1551 1552
			strbuf_add(sb, line, linelen);
			continue;
		}

1553
		if (starts_with(line, "parent ")) {
1554 1555 1556 1557 1558 1559
			if (linelen != 48)
				die("bad parent line in commit");
			continue;
		}

		if (!parents_shown) {
1560
			unsigned num = commit_list_count(commit->parents);
1561 1562
			/* with enough slop */
			strbuf_grow(sb, num * 50 + 20);
1563
			add_merge_info(pp, sb, commit);
1564 1565 1566 1567 1568 1569 1570 1571
			parents_shown = 1;
		}

		/*
		 * MEDIUM == DEFAULT shows only author with dates.
		 * FULL shows both authors but not dates.
		 * FULLER shows both authors and dates.
		 */
1572
		if (skip_prefix(line, "author ", &name)) {
1573
			strbuf_grow(sb, linelen + 80);
1574
			pp_user_info(pp, "Author", sb, name, encoding);
1575
		}
1576
		if (skip_prefix(line, "committer ", &name) &&
1577
		    (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1578
			strbuf_grow(sb, linelen + 80);
1579
			pp_user_info(pp, "Commit", sb, name, encoding);
1580 1581 1582 1583
		}
	}
}

1584
void pp_title_line(struct pretty_print_context *pp,
1585 1586 1587
		   const char **msg_p,
		   struct strbuf *sb,
		   const char *encoding,
J
Junio C Hamano 已提交
1588
		   int need_8bit_cte)
1589
{
1590
	static const int max_length = 78; /* per rfc2047 */
1591 1592 1593
	struct strbuf title;

	strbuf_init(&title, 80);
1594 1595
	*msg_p = format_subject(&title, *msg_p,
				pp->preserve_subject ? "\n" : " ");
1596 1597

	strbuf_grow(sb, title.len + 1024);
1598 1599 1600
	if (pp->print_email_subject) {
		if (pp->rev)
			fmt_output_email_subject(sb, pp->rev);
1601 1602 1603 1604 1605 1606
		if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
			add_rfc2047(sb, title.buf, title.len,
						encoding, RFC2047_SUBJECT);
		else
			strbuf_add_wrapped_bytes(sb, title.buf, title.len,
					 -last_line_length(sb), 1, max_length);
1607 1608 1609 1610 1611
	} else {
		strbuf_addbuf(sb, &title);
	}
	strbuf_addch(sb, '\n');

1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
	if (need_8bit_cte == 0) {
		int i;
		for (i = 0; i < pp->in_body_headers.nr; i++) {
			if (has_non_ascii(pp->in_body_headers.items[i].string)) {
				need_8bit_cte = 1;
				break;
			}
		}
	}

1622
	if (need_8bit_cte > 0) {
1623 1624 1625 1626 1627 1628
		const char *header_fmt =
			"MIME-Version: 1.0\n"
			"Content-Type: text/plain; charset=%s\n"
			"Content-Transfer-Encoding: 8bit\n";
		strbuf_addf(sb, header_fmt, encoding);
	}
1629 1630
	if (pp->after_subject) {
		strbuf_addstr(sb, pp->after_subject);
1631
	}
1632
	if (cmit_fmt_is_mail(pp->fmt)) {
1633 1634
		strbuf_addch(sb, '\n');
	}
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645

	if (pp->in_body_headers.nr) {
		int i;
		for (i = 0; i < pp->in_body_headers.nr; i++) {
			strbuf_addstr(sb, pp->in_body_headers.items[i].string);
			free(pp->in_body_headers.items[i].string);
		}
		string_list_clear(&pp->in_body_headers, 0);
		strbuf_addch(sb, '\n');
	}

1646 1647 1648
	strbuf_release(&title);
}

1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
static int pp_utf8_width(const char *start, const char *end)
{
	int width = 0;
	size_t remain = end - start;

	while (remain) {
		int n = utf8_width(&start, &remain);
		if (n < 0 || !start)
			return -1;
		width += n;
	}
	return width;
}

1663
static void strbuf_add_tabexpand(struct strbuf *sb, int tabwidth,
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
				 const char *line, int linelen)
{
	const char *tab;

	while ((tab = memchr(line, '\t', linelen)) != NULL) {
		int width = pp_utf8_width(line, tab);

		/*
		 * If it wasn't well-formed utf8, or it
		 * had characters with badly defined
		 * width (control characters etc), just
		 * give up on trying to align things.
		 */
		if (width < 0)
			break;

		/* Output the data .. */
		strbuf_add(sb, line, tab - line);

		/* .. and the de-tabified tab */
1684
		strbuf_addchars(sb, ' ', tabwidth - (width % tabwidth));
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709

		/* Skip over the printed part .. */
		linelen -= tab + 1 - line;
		line = tab + 1;
	}

	/*
	 * Print out everything after the last tab without
	 * worrying about width - there's nothing more to
	 * align.
	 */
	strbuf_add(sb, line, linelen);
}

/*
 * pp_handle_indent() prints out the intendation, and
 * the whole line (without the final newline), after
 * de-tabifying.
 */
static void pp_handle_indent(struct pretty_print_context *pp,
			     struct strbuf *sb, int indent,
			     const char *line, int linelen)
{
	strbuf_addchars(sb, ' ', indent);
	if (pp->expand_tabs_in_log)
1710
		strbuf_add_tabexpand(sb, pp->expand_tabs_in_log, line, linelen);
1711 1712 1713 1714
	else
		strbuf_add(sb, line, linelen);
}

1715 1716 1717 1718 1719 1720 1721 1722 1723 1724
static int is_mboxrd_from(const char *line, int len)
{
	/*
	 * a line matching /^From $/ here would only have len == 4
	 * at this point because is_empty_line would've trimmed all
	 * trailing space
	 */
	return len > 4 && starts_with(line + strspn(line, ">"), "From ");
}

1725
void pp_remainder(struct pretty_print_context *pp,
1726 1727 1728
		  const char **msg_p,
		  struct strbuf *sb,
		  int indent)
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
{
	int first = 1;
	for (;;) {
		const char *line = *msg_p;
		int linelen = get_one_line(line);
		*msg_p += linelen;

		if (!linelen)
			break;

1739
		if (is_blank_line(line, &linelen)) {
1740 1741
			if (first)
				continue;
1742
			if (pp->fmt == CMIT_FMT_SHORT)
1743 1744 1745 1746 1747
				break;
		}
		first = 0;

		strbuf_grow(sb, linelen + indent + 20);
1748
		if (indent)
1749
			pp_handle_indent(pp, sb, indent, line, linelen);
1750
		else if (pp->expand_tabs_in_log)
1751 1752
			strbuf_add_tabexpand(sb, pp->expand_tabs_in_log,
					     line, linelen);
1753 1754 1755 1756 1757
		else {
			if (pp->fmt == CMIT_FMT_MBOXRD &&
					is_mboxrd_from(line, linelen))
				strbuf_addch(sb, '>');

1758
			strbuf_add(sb, line, linelen);
1759
		}
1760 1761 1762 1763
		strbuf_addch(sb, '\n');
	}
}

1764
void pretty_print_commit(struct pretty_print_context *pp,
1765 1766
			 const struct commit *commit,
			 struct strbuf *sb)
1767 1768 1769
{
	unsigned long beginning_of_body;
	int indent = 4;
J
Jeff King 已提交
1770
	const char *msg;
J
Jeff King 已提交
1771
	const char *reencoded;
1772
	const char *encoding;
1773
	int need_8bit_cte = pp->need_8bit_cte;
1774

1775 1776
	if (pp->fmt == CMIT_FMT_USERFORMAT) {
		format_commit_message(commit, user_format, sb, pp);
1777 1778 1779
		return;
	}

1780
	encoding = get_log_output_encoding();
1781
	msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1782

1783
	if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1784 1785
		indent = 0;

1786 1787 1788
	/*
	 * We need to check and emit Content-type: to mark it
	 * as 8-bit if we haven't done so.
1789
	 */
1790
	if (cmit_fmt_is_mail(pp->fmt) && need_8bit_cte == 0) {
1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
		int i, ch, in_body;

		for (in_body = i = 0; (ch = msg[i]); i++) {
			if (!in_body) {
				/* author could be non 7-bit ASCII but
				 * the log may be so; skip over the
				 * header part first.
				 */
				if (ch == '\n' && msg[i+1] == '\n')
					in_body = 1;
			}
			else if (non_ascii(ch)) {
1803
				need_8bit_cte = 1;
1804 1805 1806 1807 1808
				break;
			}
		}
	}

1809
	pp_header(pp, encoding, commit, &msg, sb);
1810
	if (pp->fmt != CMIT_FMT_ONELINE && !pp->print_email_subject) {
1811 1812 1813 1814
		strbuf_addch(sb, '\n');
	}

	/* Skip excess blank lines at the beginning of body, if any... */
1815
	msg = skip_blank_lines(msg);
1816 1817

	/* These formats treat the title line specially. */
1818
	if (pp->fmt == CMIT_FMT_ONELINE || cmit_fmt_is_mail(pp->fmt))
1819
		pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1820 1821

	beginning_of_body = sb->len;
1822 1823
	if (pp->fmt != CMIT_FMT_ONELINE)
		pp_remainder(pp, &msg, sb, indent);
1824 1825 1826
	strbuf_rtrim(sb);

	/* Make sure there is an EOLN for the non-oneline case */
1827
	if (pp->fmt != CMIT_FMT_ONELINE)
1828 1829 1830 1831 1832 1833 1834
		strbuf_addch(sb, '\n');

	/*
	 * The caller may append additional body text in e-mail
	 * format.  Make sure we did not strip the blank line
	 * between the header and the body.
	 */
1835
	if (cmit_fmt_is_mail(pp->fmt) && sb->len <= beginning_of_body)
1836
		strbuf_addch(sb, '\n');
J
Johannes Schindelin 已提交
1837

1838
	unuse_commit_buffer(commit, reencoded);
1839
}
1840 1841 1842 1843 1844

void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
		    struct strbuf *sb)
{
	struct pretty_print_context pp = {0};
1845 1846
	pp.fmt = fmt;
	pretty_print_commit(&pp, commit, sb);
1847
}