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

static char *user_format;
15 16 17 18
static struct cmt_fmt_map {
	const char *name;
	enum cmit_fmt format;
	int is_tformat;
19 20
	int is_alias;
	const char *user_format;
21
} *commit_formats;
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);
26

27 28 29 30 31
int commit_format_is_empty(enum cmit_fmt fmt)
{
	return fmt == CMIT_FMT_USERFORMAT && !*user_format;
}

32 33 34 35 36 37 38 39 40
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;
}

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

48
	if (!skip_prefix(var, "pretty.", &name))
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
		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];
67
		memset(commit_format, 0, sizeof(*commit_format));
68 69 70 71 72
		commit_formats_len++;
	}

	commit_format->name = xstrdup(name);
	commit_format->format = CMIT_FMT_USERFORMAT;
73 74 75
	if (git_config_string(&fmt, var, value))
		return -1;

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

	return 0;
}

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

	git_config(git_pretty_formats_config, NULL);
105 106
}

107 108 109
static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
							const char *original,
							int num_redirections)
110 111 112 113 114
{
	struct cmt_fmt_map *found = NULL;
	size_t found_match_len = 0;
	int i;

115 116 117 118
	if (num_redirections >= commit_formats_len)
		die("invalid --pretty format: "
		    "'%s' references an alias which points to itself",
		    original);
119 120 121 122

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

123
		if (!starts_with(commit_formats[i].name, sought))
124 125 126 127 128 129 130 131
			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;
		}
	}
132 133 134 135 136 137 138

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

139 140 141
	return found;
}

142 143 144 145 146 147 148 149
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);
}

150 151 152
void get_commit_format(const char *arg, struct rev_info *rev)
{
	struct cmt_fmt_map *commit_format;
153

154
	rev->use_terminator = 0;
155
	if (!arg) {
156 157 158
		rev->commit_format = CMIT_FMT_DEFAULT;
		return;
	}
159 160
	if (skip_prefix(arg, "format:", &arg)) {
		save_user_format(rev, arg, 0);
161
		return;
162
	}
163

164
	if (!*arg || skip_prefix(arg, "tformat:", &arg) || strchr(arg, '%')) {
165 166 167
		save_user_format(rev, arg, 1);
		return;
	}
168

169 170 171 172 173 174
	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;
175 176 177 178
	if (commit_format->format == CMIT_FMT_USERFORMAT) {
		save_user_format(rev, commit_format->user_format,
				 commit_format->is_tformat);
	}
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
}

/*
 * 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 */
200
static int non_ascii(int ch)
201
{
R
René Scharfe 已提交
202
	return !isascii(ch) || ch == '\033';
203 204
}

205 206 207 208 209 210 211 212 213 214 215 216
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;
}

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
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;
	}
}

239
static int needs_rfc822_quoting(const char *s, int len)
240 241 242 243 244 245 246 247
{
	int i;
	for (i = 0; i < len; i++)
		if (is_rfc822_special(s[i]))
			return 1;
	return 0;
}

248 249 250 251 252 253 254 255 256 257 258
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);
}

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
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, '"');
}

280 281
enum rfc2047_type {
	RFC2047_SUBJECT,
282
	RFC2047_ADDRESS
283 284 285
};

static int is_rfc2047_special(char ch, enum rfc2047_type type)
286
{
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
	/*
	 * 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 == '_')
311 312
		return 1;

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
	/*
	 * 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 == '/');
335 336
}

337 338
static int needs_rfc2047_encoding(const char *line, int len,
				  enum rfc2047_type type)
339
{
J
Jeff King 已提交
340
	int i;
341 342 343

	for (i = 0; i < len; i++) {
		int ch = line[i];
344
		if (non_ascii(ch) || ch == '\n')
345
			return 1;
346
		if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
347
			return 1;
348 349
	}

350 351 352
	return 0;
}

353
static void add_rfc2047(struct strbuf *sb, const char *line, size_t len,
354 355 356 357 358 359
		       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);

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

	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;
379 380 381 382 383 384 385 386

		/*
		 * 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 已提交
387

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

394 395 396
		for (i = 0; i < chrlen; i++)
			strbuf_addf(sb, encoded_fmt, p[i]);
		line_len += encoded_len;
397 398 399 400
	}
	strbuf_addstr(sb, "?=");
}

J
Jeff King 已提交
401
const char *show_ident_date(const struct ident_split *ident,
402
			    const struct date_mode *mode)
403 404
{
	unsigned long date = 0;
J
Jeff King 已提交
405
	long tz = 0;
406 407 408

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

420
void pp_user_info(struct pretty_print_context *pp,
421 422
		  const char *what, struct strbuf *sb,
		  const char *line, const char *encoding)
423
{
424
	struct ident_split ident;
425
	char *line_end;
426 427
	const char *mailbuf, *namebuf;
	size_t namelen, maillen;
428
	int max_length = 78; /* per rfc2822 */
429

430
	if (pp->fmt == CMIT_FMT_ONELINE)
431
		return;
432

433 434
	line_end = strchrnul(line, '\n');
	if (split_ident_line(&ident, line, line_end - line))
435
		return;
436

437 438 439 440 441 442 443 444
	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);

445
	if (pp->fmt == CMIT_FMT_EMAIL) {
446
		if (pp->from_ident && ident_cmp(pp->from_ident, &ident)) {
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
			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;
		}

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

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

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

static int is_empty_line(const char *line, int *len_p)
{
	int len = *len_p;
F
Felipe Contreras 已提交
511
	while (len && isspace(line[len - 1]))
512 513 514 515 516
		len--;
	*len_p = len;
	return !len;
}

517 518 519 520 521 522 523 524 525 526 527 528 529 530
static const char *skip_empty_lines(const char *msg)
{
	for (;;) {
		int linelen = get_one_line(msg);
		int ll = linelen;
		if (!linelen)
			break;
		if (!is_empty_line(msg, &ll))
			break;
		msg += linelen;
	}
	return msg;
}

531 532
static void add_merge_info(const struct pretty_print_context *pp,
			   struct strbuf *sb, const struct commit *commit)
533 534 535
{
	struct commit_list *parent = commit->parents;

536
	if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
537 538 539 540 541 542 543 544
	    !parent || !parent->next)
		return;

	strbuf_addstr(sb, "Merge:");

	while (parent) {
		struct commit *p = parent->item;
		const char *hex = NULL;
545
		if (pp->abbrev)
546
			hex = find_unique_abbrev(get_object_hash(p->object), pp->abbrev);
547
		if (!hex)
548
			hex = oid_to_hex(&p->object.oid);
549 550
		parent = parent->next;

551
		strbuf_addf(sb, " %s", hex);
552 553 554 555
	}
	strbuf_addch(sb, '\n');
}

556
static char *get_header(const char *msg, const char *key)
557
{
558 559 560
	size_t len;
	const char *v = find_commit_header(msg, key, &len);
	return v ? xmemdupz(v, len) : NULL;
561 562 563 564
}

static char *replace_encoding_header(char *buf, const char *encoding)
{
565
	struct strbuf tmp = STRBUF_INIT;
566 567 568 569
	size_t start, len;
	char *cp = buf;

	/* guess if there is an encoding header before a \n\n */
570
	while (!starts_with(cp, "encoding ")) {
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
		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 已提交
594 595 596
const char *logmsg_reencode(const struct commit *commit,
			    char **commit_encoding,
			    const char *output_encoding)
597
{
598
	static const char *utf8 = "UTF-8";
599 600
	const char *use_encoding;
	char *encoding;
601
	const char *msg = get_commit_buffer(commit, NULL);
602 603
	char *out;

604 605
	if (!output_encoding || !*output_encoding) {
		if (commit_encoding)
606
			*commit_encoding = get_header(msg, "encoding");
J
Jeff King 已提交
607
		return msg;
608
	}
609
	encoding = get_header(msg, "encoding");
610 611
	if (commit_encoding)
		*commit_encoding = encoding;
612
	use_encoding = encoding ? encoding : utf8;
613 614 615 616 617 618 619 620 621 622 623 624 625
	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
626 627
		 * the cached copy from get_commit_buffer, we need to duplicate it
		 * to avoid munging the cached copy.
628
		 */
629
		if (msg == get_cached_commit_buffer(commit, NULL))
630 631 632
			out = xstrdup(msg);
		else
			out = (char *)msg;
633 634 635 636 637 638 639 640 641
	}
	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);
642 643
		if (out)
			unuse_commit_buffer(commit, msg);
644 645 646 647 648 649
	}

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

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

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

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

683
	if (split_ident_line(&s, msg, len) < 0)
684 685
		goto skip;

686 687 688 689 690 691 692
	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);
693
	if (part == 'n' || part == 'N') {	/* name */
694
		strbuf_add(sb, name, namelen);
695
		return placeholder_len;
696
	}
697
	if (part == 'e' || part == 'E') {	/* email */
698
		strbuf_add(sb, mail, maillen);
699
		return placeholder_len;
700
	}
701

702
	if (!s.date_begin)
703
		goto skip;
704

705
	if (part == 't') {	/* date, UNIX timestamp */
706
		strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
707
		return placeholder_len;
708
	}
709

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

skip:
	/*
730 731 732
	 * 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.
733 734 735 736 737 738
	 */
	if (part == 'n' || part == 'e' || part == 't' || part == 'd'
	    || part == 'D' || part == 'r' || part == 'i')
		return placeholder_len;

	return 0; /* unknown placeholder */
739 740
}

741 742 743 744 745
struct chunk {
	size_t off;
	size_t len;
};

746 747 748 749
enum flush_type {
	no_flush,
	flush_right,
	flush_left,
750
	flush_left_and_steal,
751 752 753
	flush_both
};

754 755 756 757 758 759 760
enum trunc_type {
	trunc_none,
	trunc_left,
	trunc_middle,
	trunc_right
};

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

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

	/* The following ones are relative to the result struct strbuf. */
	struct chunk abbrev_commit_hash;
	struct chunk abbrev_tree_hash;
	struct chunk abbrev_parent_hashes;
786
	size_t wrap_start;
787 788
};

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
static int add_again(struct strbuf *sb, struct chunk *chunk)
{
	if (chunk->len) {
		strbuf_adddup(sb, chunk->off, chunk->len);
		return 1;
	}

	/*
	 * We haven't seen this chunk before.  Our caller is surely
	 * going to add it the hard way now.  Remember the most likely
	 * start of the to-be-added chunk: the current end of the
	 * struct strbuf.
	 */
	chunk->off = sb->len;
	return 0;
}

806
static void parse_commit_header(struct format_commit_context *context)
807
{
808
	const char *msg = context->message;
809
	int i;
810

811
	for (i = 0; msg[i]; i++) {
812
		const char *name;
813 814 815 816 817
		int eol;
		for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
			; /* do nothing */

		if (i == eol) {
818
			break;
819 820 821 822 823 824
		} 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;
825 826 827
		}
		i = eol;
	}
828
	context->message_off = i;
829 830 831
	context->commit_header_parsed = 1;
}

832 833 834 835 836 837 838 839 840
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;
841
	size_t start_len = sb->len;
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
	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;
859 860 861
	while (sb->len - trimlen > start_len &&
		(sb->buf[sb->len - 1 - trimlen] == '.'
		|| sb->buf[sb->len - 1 - trimlen] == '-'))
862 863 864 865
		trimlen++;
	strbuf_remove(sb, sb->len - trimlen, trimlen);
}

866 867
const char *format_subject(struct strbuf *sb, const char *msg,
			   const char *line_separator)
868 869 870 871 872 873 874 875 876 877 878
{
	int first = 1;

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

		msg += linelen;
		if (!linelen || is_empty_line(line, &linelen))
			break;

879 880
		if (!sb)
			continue;
881 882 883 884 885 886 887 888 889
		strbuf_grow(sb, linelen + 2);
		if (!first)
			strbuf_addstr(sb, line_separator);
		strbuf_add(sb, line, linelen);
		first = 0;
	}
	return msg;
}

890 891
static void parse_commit_message(struct format_commit_context *c)
{
892 893
	const char *msg = c->message + c->message_off;
	const char *start = c->message;
894 895 896 897 898 899 900 901 902 903 904

	msg = skip_empty_lines(msg);
	c->subject_off = msg - start;

	msg = format_subject(NULL, msg, NULL);
	msg = skip_empty_lines(msg);
	c->body_off = msg - start;

	c->commit_message_parsed = 1;
}

905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
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;
926
	if (c->wrap_start < sb->len)
927 928 929 930 931 932 933
		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;
}

934 935 936
static int format_reflog_person(struct strbuf *sb,
				char part,
				struct reflog_walk_info *log,
937
				const struct date_mode *dmode)
938 939 940 941 942 943 944 945 946 947 948 949 950
{
	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);
}

951 952 953 954
static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
			  const char *placeholder,
			  struct format_commit_context *c)
{
955 956
	const char *rest = placeholder;

957 958 959 960 961 962 963
	if (placeholder[1] == '(') {
		const char *begin = placeholder + 2;
		const char *end = strchr(begin, ')');
		char color[COLOR_MAXLEN];

		if (!end)
			return 0;
964
		if (skip_prefix(begin, "auto,", &begin)) {
965 966 967
			if (!want_color(c->pretty_ctx->color))
				return end - placeholder + 1;
		}
968 969
		if (color_parse_mem(begin, end - begin, color) < 0)
			die(_("unable to parse --pretty format"));
970 971 972
		strbuf_addstr(sb, color);
		return end - placeholder + 1;
	}
973
	if (skip_prefix(placeholder + 1, "red", &rest))
974
		strbuf_addstr(sb, GIT_COLOR_RED);
975
	else if (skip_prefix(placeholder + 1, "green", &rest))
976
		strbuf_addstr(sb, GIT_COLOR_GREEN);
977
	else if (skip_prefix(placeholder + 1, "blue", &rest))
978
		strbuf_addstr(sb, GIT_COLOR_BLUE);
979
	else if (skip_prefix(placeholder + 1, "reset", &rest))
980
		strbuf_addstr(sb, GIT_COLOR_RESET);
981
	return rest - placeholder;
982 983
}

984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
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++;
1000 1001 1002
		} else if (*ch == '>') {
			flush_type = flush_left_and_steal;
			ch++;
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
		} 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;
1018
		const char *end = start + strcspn(start, ",)");
1019 1020 1021 1022 1023 1024 1025 1026 1027
		char *next;
		int width;
		if (!end || end == start)
			return 0;
		width = strtoul(start, &next, 10);
		if (next == start || width == 0)
			return 0;
		c->padding = to_column ? -width : width;
		c->flush_type = flush_type;
1028 1029 1030 1031 1032 1033

		if (*end == ',') {
			start = end + 1;
			end = strchr(start, ')');
			if (!end || end == start)
				return 0;
1034
			if (starts_with(start, "trunc)"))
1035
				c->truncate = trunc_right;
1036
			else if (starts_with(start, "ltrunc)"))
1037
				c->truncate = trunc_left;
1038
			else if (starts_with(start, "mtrunc)"))
1039 1040 1041 1042 1043 1044
				c->truncate = trunc_middle;
			else
				return 0;
		} else
			c->truncate = trunc_none;

1045 1046 1047 1048 1049
		return end - placeholder + 1;
	}
	return 0;
}

1050 1051
static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
				const char *placeholder,
1052
				void *context)
1053 1054 1055
{
	struct format_commit_context *c = context;
	const struct commit *commit = c->commit;
1056
	const char *msg = c->message;
1057
	struct commit_list *p;
1058
	int h1, h2;
1059 1060

	/* these are independent of the commit */
1061 1062
	switch (placeholder[0]) {
	case 'C':
1063
		if (starts_with(placeholder + 1, "(auto)")) {
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
			c->auto_color = 1;
			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 已提交
1076
		}
1077 1078
	case 'n':		/* newline */
		strbuf_addch(sb, '\n');
1079
		return 1;
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
	case 'x':
		/* %x00 == NUL, %x0a == LF, etc. */
		if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
		    h1 <= 16 &&
		    0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
		    h2 <= 16) {
			strbuf_addch(sb, (h1<<4)|h2);
			return 3;
		} else
			return 0;
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
	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;
1114 1115 1116 1117

	case '<':
	case '>':
		return parse_padding_placeholder(sb, placeholder, c);
1118
	}
1119 1120 1121

	/* these depend on the commit */
	if (!commit->object.parsed)
1122
		parse_object(get_object_hash(commit->object));
1123

1124 1125
	switch (placeholder[0]) {
	case 'H':		/* commit hash */
1126
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1127
		strbuf_addstr(sb, oid_to_hex(&commit->object.oid));
1128
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1129
		return 1;
1130
	case 'h':		/* abbreviated commit hash */
1131 1132 1133
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
		if (add_again(sb, &c->abbrev_commit_hash)) {
			strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1134
			return 1;
1135
		}
1136
		strbuf_addstr(sb, find_unique_abbrev(get_object_hash(commit->object),
W
Will Palmer 已提交
1137
						     c->pretty_ctx->abbrev));
1138
		strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1139
		c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
1140
		return 1;
1141
	case 'T':		/* tree hash */
1142
		strbuf_addstr(sb, oid_to_hex(&commit->tree->object.oid));
1143
		return 1;
1144
	case 't':		/* abbreviated tree hash */
1145
		if (add_again(sb, &c->abbrev_tree_hash))
1146
			return 1;
1147
		strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.oid.hash,
W
Will Palmer 已提交
1148
						     c->pretty_ctx->abbrev));
1149
		c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
1150
		return 1;
1151 1152 1153 1154
	case 'P':		/* parent hashes */
		for (p = commit->parents; p; p = p->next) {
			if (p != commit->parents)
				strbuf_addch(sb, ' ');
1155
			strbuf_addstr(sb, oid_to_hex(&p->item->object.oid));
1156
		}
1157
		return 1;
1158
	case 'p':		/* abbreviated parent hashes */
1159
		if (add_again(sb, &c->abbrev_parent_hashes))
1160
			return 1;
1161 1162 1163 1164
		for (p = commit->parents; p; p = p->next) {
			if (p != commit->parents)
				strbuf_addch(sb, ' ');
			strbuf_addstr(sb, find_unique_abbrev(
1165
					get_object_hash(p->item->object),
W
Will Palmer 已提交
1166
					c->pretty_ctx->abbrev));
1167
		}
1168 1169
		c->abbrev_parent_hashes.len = sb->len -
		                              c->abbrev_parent_hashes.off;
1170
		return 1;
1171
	case 'm':		/* left/right/bottom */
1172
		strbuf_addstr(sb, get_revision_mark(NULL, commit));
1173
		return 1;
1174
	case 'd':
1175
		load_ref_decorations(DECORATE_SHORT_REFS);
1176
		format_decorations(sb, commit, c->auto_color);
1177
		return 1;
H
Harry Jeffery 已提交
1178 1179 1180 1181
	case 'D':
		load_ref_decorations(DECORATE_SHORT_REFS);
		format_decorations_extended(sb, commit, c->auto_color, "", ", ", "");
		return 1;
1182 1183 1184 1185 1186 1187 1188
	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,
1189
						    &c->pretty_ctx->date_mode,
1190
						    c->pretty_ctx->date_mode_explicit,
1191 1192 1193 1194 1195 1196
						    (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;
1197 1198 1199 1200 1201 1202 1203
		case 'n':
		case 'N':
		case 'e':
		case 'E':
			return format_reflog_person(sb,
						    placeholder[1],
						    c->pretty_ctx->reflog_info,
1204
						    &c->pretty_ctx->date_mode);
1205 1206
		}
		return 0;	/* unknown %g placeholder */
1207
	case 'N':
1208 1209
		if (c->pretty_ctx->notes_message) {
			strbuf_addstr(sb, c->pretty_ctx->notes_message);
1210 1211 1212
			return 1;
		}
		return 0;
1213 1214
	}

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


1247
	/* For the rest we have to parse the commit header. */
1248 1249
	if (!c->commit_header_parsed)
		parse_commit_header(c);
1250

1251
	switch (placeholder[0]) {
1252 1253
	case 'a':	/* author ... */
		return format_person_part(sb, placeholder[1],
1254
				   msg + c->author.off, c->author.len,
1255
				   &c->pretty_ctx->date_mode);
1256 1257
	case 'c':	/* committer ... */
		return format_person_part(sb, placeholder[1],
1258
				   msg + c->committer.off, c->committer.len,
1259
				   &c->pretty_ctx->date_mode);
1260
	case 'e':	/* encoding */
1261 1262
		if (c->commit_encoding)
			strbuf_addstr(sb, c->commit_encoding);
1263
		return 1;
1264 1265 1266 1267
	case 'B':	/* raw body */
		/* message_off is always left at the initial newline */
		strbuf_addstr(sb, msg + c->message_off + 1);
		return 1;
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
	}

	/* 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;
1278 1279 1280
	case 'f':	/* sanitized subject */
		format_sanitized_subject(sb, msg + c->subject_off);
		return 1;
1281
	case 'b':	/* body */
1282
		strbuf_addstr(sb, msg + c->body_off);
1283
		return 1;
1284
	}
1285
	return 0;	/* unknown placeholder */
1286 1287
}

1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
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);
		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);
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346

	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;
	}

1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
	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;
		}
1368
		strbuf_addbuf(sb, &local_sb);
1369
	} else {
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
		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;
1380
		strbuf_addchars(sb, ' ', padding);
1381 1382 1383 1384 1385 1386 1387 1388
		memcpy(sb->buf + sb_len + offset, local_sb.buf,
		       local_sb.len);
	}
	strbuf_release(&local_sb);
	c->flush_type = no_flush;
	return total_consumed;
}

1389 1390
static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
				 const char *placeholder,
1391 1392 1393 1394 1395 1396 1397 1398
				 void *context)
{
	int consumed;
	size_t orig_len;
	enum {
		NO_MAGIC,
		ADD_LF_BEFORE_NON_EMPTY,
		DEL_LF_BEFORE_EMPTY,
1399
		ADD_SP_BEFORE_NON_EMPTY
1400 1401 1402 1403 1404 1405 1406 1407 1408
	} magic = NO_MAGIC;

	switch (placeholder[0]) {
	case '-':
		magic = DEL_LF_BEFORE_EMPTY;
		break;
	case '+':
		magic = ADD_LF_BEFORE_NON_EMPTY;
		break;
1409 1410 1411
	case ' ':
		magic = ADD_SP_BEFORE_NON_EMPTY;
		break;
1412 1413 1414 1415 1416 1417 1418
	default:
		break;
	}
	if (magic != NO_MAGIC)
		placeholder++;

	orig_len = sb->len;
1419 1420 1421 1422
	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);
1423 1424 1425 1426 1427 1428
	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);
1429 1430 1431 1432 1433
	} 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);
1434 1435 1436 1437
	}
	return consumed + 1;
}

1438 1439 1440 1441 1442
static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
				   void *context)
{
	struct userformat_want *w = context;

1443
	if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
		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;
	}
1463
	strbuf_expand(&dummy, fmt, userformat_want_item, w);
1464 1465 1466
	strbuf_release(&dummy);
}

1467
void format_commit_message(const struct commit *commit,
1468
			   const char *format, struct strbuf *sb,
1469
			   const struct pretty_print_context *pretty_ctx)
1470
{
1471
	struct format_commit_context context;
1472
	const char *output_enc = pretty_ctx->output_encoding;
1473
	const char *utf8 = "UTF-8";
1474 1475 1476

	memset(&context, 0, sizeof(context));
	context.commit = commit;
1477
	context.pretty_ctx = pretty_ctx;
1478
	context.wrap_start = sb->len;
1479 1480 1481 1482
	/*
	 * convert a commit message to UTF-8 first
	 * as far as 'format_commit_item' assumes it in UTF-8
	 */
1483 1484
	context.message = logmsg_reencode(commit,
					  &context.commit_encoding,
1485
					  utf8);
1486

1487
	strbuf_expand(sb, format, format_commit_item, &context);
1488
	rewrap_message_tail(sb, &context, 0, 0, 0);
1489

1490
	/* then convert a commit message to an actual output encoding */
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
	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);
	}

1508
	free(context.commit_encoding);
1509
	unuse_commit_buffer(commit, context.message);
1510 1511
}

1512
static void pp_header(struct pretty_print_context *pp,
1513 1514 1515 1516 1517 1518 1519 1520
		      const char *encoding,
		      const struct commit *commit,
		      const char **msg_p,
		      struct strbuf *sb)
{
	int parents_shown = 0;

	for (;;) {
1521
		const char *name, *line = *msg_p;
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
		int linelen = get_one_line(*msg_p);

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

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

1532
		if (pp->fmt == CMIT_FMT_RAW) {
1533 1534 1535 1536
			strbuf_add(sb, line, linelen);
			continue;
		}

1537
		if (starts_with(line, "parent ")) {
1538 1539 1540 1541 1542 1543
			if (linelen != 48)
				die("bad parent line in commit");
			continue;
		}

		if (!parents_shown) {
1544
			unsigned num = commit_list_count(commit->parents);
1545 1546
			/* with enough slop */
			strbuf_grow(sb, num * 50 + 20);
1547
			add_merge_info(pp, sb, commit);
1548 1549 1550 1551 1552 1553 1554 1555
			parents_shown = 1;
		}

		/*
		 * MEDIUM == DEFAULT shows only author with dates.
		 * FULL shows both authors but not dates.
		 * FULLER shows both authors and dates.
		 */
1556
		if (skip_prefix(line, "author ", &name)) {
1557
			strbuf_grow(sb, linelen + 80);
1558
			pp_user_info(pp, "Author", sb, name, encoding);
1559
		}
1560
		if (skip_prefix(line, "committer ", &name) &&
1561
		    (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1562
			strbuf_grow(sb, linelen + 80);
1563
			pp_user_info(pp, "Commit", sb, name, encoding);
1564 1565 1566 1567
		}
	}
}

1568
void pp_title_line(struct pretty_print_context *pp,
1569 1570 1571
		   const char **msg_p,
		   struct strbuf *sb,
		   const char *encoding,
J
Junio C Hamano 已提交
1572
		   int need_8bit_cte)
1573
{
1574
	static const int max_length = 78; /* per rfc2047 */
1575 1576 1577
	struct strbuf title;

	strbuf_init(&title, 80);
1578 1579
	*msg_p = format_subject(&title, *msg_p,
				pp->preserve_subject ? "\n" : " ");
1580 1581

	strbuf_grow(sb, title.len + 1024);
1582 1583
	if (pp->subject) {
		strbuf_addstr(sb, pp->subject);
1584 1585 1586 1587 1588 1589
		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);
1590 1591 1592 1593 1594
	} else {
		strbuf_addbuf(sb, &title);
	}
	strbuf_addch(sb, '\n');

1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
	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;
			}
		}
	}

1605
	if (need_8bit_cte > 0) {
1606 1607 1608 1609 1610 1611
		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);
	}
1612 1613
	if (pp->after_subject) {
		strbuf_addstr(sb, pp->after_subject);
1614
	}
1615
	if (pp->fmt == CMIT_FMT_EMAIL) {
1616 1617
		strbuf_addch(sb, '\n');
	}
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628

	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');
	}

1629 1630 1631
	strbuf_release(&title);
}

1632
void pp_remainder(struct pretty_print_context *pp,
1633 1634 1635
		  const char **msg_p,
		  struct strbuf *sb,
		  int indent)
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
{
	int first = 1;
	for (;;) {
		const char *line = *msg_p;
		int linelen = get_one_line(line);
		*msg_p += linelen;

		if (!linelen)
			break;

		if (is_empty_line(line, &linelen)) {
			if (first)
				continue;
1649
			if (pp->fmt == CMIT_FMT_SHORT)
1650 1651 1652 1653 1654
				break;
		}
		first = 0;

		strbuf_grow(sb, linelen + indent + 20);
1655 1656
		if (indent)
			strbuf_addchars(sb, ' ', indent);
1657 1658 1659 1660 1661
		strbuf_add(sb, line, linelen);
		strbuf_addch(sb, '\n');
	}
}

1662
void pretty_print_commit(struct pretty_print_context *pp,
1663 1664
			 const struct commit *commit,
			 struct strbuf *sb)
1665 1666 1667
{
	unsigned long beginning_of_body;
	int indent = 4;
J
Jeff King 已提交
1668
	const char *msg;
J
Jeff King 已提交
1669
	const char *reencoded;
1670
	const char *encoding;
1671
	int need_8bit_cte = pp->need_8bit_cte;
1672

1673 1674
	if (pp->fmt == CMIT_FMT_USERFORMAT) {
		format_commit_message(commit, user_format, sb, pp);
1675 1676 1677
		return;
	}

1678
	encoding = get_log_output_encoding();
1679
	msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1680

1681
	if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1682 1683
		indent = 0;

1684 1685 1686
	/*
	 * We need to check and emit Content-type: to mark it
	 * as 8-bit if we haven't done so.
1687
	 */
1688
	if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
		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)) {
1701
				need_8bit_cte = 1;
1702 1703 1704 1705 1706
				break;
			}
		}
	}

1707 1708
	pp_header(pp, encoding, commit, &msg, sb);
	if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1709 1710 1711 1712
		strbuf_addch(sb, '\n');
	}

	/* Skip excess blank lines at the beginning of body, if any... */
1713
	msg = skip_empty_lines(msg);
1714 1715

	/* These formats treat the title line specially. */
1716 1717
	if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
		pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1718 1719

	beginning_of_body = sb->len;
1720 1721
	if (pp->fmt != CMIT_FMT_ONELINE)
		pp_remainder(pp, &msg, sb, indent);
1722 1723 1724
	strbuf_rtrim(sb);

	/* Make sure there is an EOLN for the non-oneline case */
1725
	if (pp->fmt != CMIT_FMT_ONELINE)
1726 1727 1728 1729 1730 1731 1732
		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.
	 */
1733
	if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1734
		strbuf_addch(sb, '\n');
J
Johannes Schindelin 已提交
1735

1736
	unuse_commit_buffer(commit, reencoded);
1737
}
1738 1739 1740 1741 1742

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