[thirdparty/git.git] / pretty.h

#ifndef PRETTY_H
#define PRETTY_H

#include "cache.h"
#include "string-list.h"

struct commit;
struct strbuf;

/* Commit formats */
enum cmit_fmt {
	CMIT_FMT_RAW,
	CMIT_FMT_MEDIUM,
	CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
	CMIT_FMT_SHORT,
	CMIT_FMT_FULL,
	CMIT_FMT_FULLER,
	CMIT_FMT_ONELINE,
	CMIT_FMT_EMAIL,
	CMIT_FMT_MBOXRD,
	CMIT_FMT_USERFORMAT,

	CMIT_FMT_UNSPECIFIED
};

struct pretty_print_context {
	/*
	 * Callers should tweak these to change the behavior of pp_* functions.
	 */
	enum cmit_fmt fmt;
	int abbrev;
	const char *after_subject;
	int preserve_subject;
	struct date_mode date_mode;
	unsigned date_mode_explicit:1;
	int print_email_subject;
	int expand_tabs_in_log;
	int need_8bit_cte;
	char *notes_message;
	struct reflog_walk_info *reflog_info;
	struct rev_info *rev;
	const char *output_encoding;
	struct string_list *mailmap;
	int color;
	struct ident_split *from_ident;

	/*
	 * Fields below here are manipulated internally by pp_* functions and
	 * should not be counted on by callers.
	 */
	struct string_list in_body_headers;
	int graph_width;
};

/* Check whether commit format is mail. */
static inline int cmit_fmt_is_mail(enum cmit_fmt fmt)
{
	return (fmt == CMIT_FMT_EMAIL || fmt == CMIT_FMT_MBOXRD);
}

struct userformat_want {
	unsigned notes:1;
};

/* Set the flag "w->notes" if there is placeholder %N in "fmt". */
void userformat_find_requirements(const char *fmt, struct userformat_want *w);

/*
 * Shortcut for invoking pretty_print_commit if we do not have any context.
 * Context would be set empty except "fmt".
 */
void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
			struct strbuf *sb);

/*
 * Get information about user and date from "line", format it and
 * put it into "sb".
 * Format of "line" must be readable for split_ident_line function.
 * The resulting format is "what: name <email> date".
 */
void pp_user_info(struct pretty_print_context *pp, const char *what,
			struct strbuf *sb, const char *line,
			const char *encoding);

/*
 * Format title line of commit message taken from "msg_p" and
 * put it into "sb".
 * First line of "msg_p" is also affected.
 */
void pp_title_line(struct pretty_print_context *pp, const char **msg_p,
			struct strbuf *sb, const char *encoding,
			int need_8bit_cte);

/*
 * Get current state of commit message from "msg_p" and continue formatting
 * by adding indentation and '>' signs. Put result into "sb".
 */
void pp_remainder(struct pretty_print_context *pp, const char **msg_p,
			struct strbuf *sb, int indent);

/*
 * Create a text message about commit using given "format" and "context".
 * Put the result to "sb".
 * Please use this function for custom formats.
 */
void format_commit_message(const struct commit *commit,
			const char *format, struct strbuf *sb,
			const struct pretty_print_context *context);

/*
 * Parse given arguments from "arg", check it for correctness and
 * fill struct rev_info.
 */
void get_commit_format(const char *arg, struct rev_info *);

/*
 * Make a commit message with all rules from given "pp"
 * and put it into "sb".
 * Please use this function if you have a context (candidate for "pp").
 */
void pretty_print_commit(struct pretty_print_context *pp,
			const struct commit *commit,
			struct strbuf *sb);

/*
 * Change line breaks in "msg" to "line_separator" and put it into "sb".
 * Return "msg" itself.
 */
const char *format_subject(struct strbuf *sb, const char *msg,
			const char *line_separator);

/* Check if "cmit_fmt" will produce an empty output. */
int commit_format_is_empty(enum cmit_fmt);

#endif /* PRETTY_H */
Commit	Line	Data
cf394719 OT	1	#ifndef PRETTY_H
	2	#define PRETTY_H
	3
ef3ca954 EN	4	#include "cache.h"
	5	#include "string-list.h"
	6
cf394719	7	struct commit;
ef3ca954	8	struct strbuf;
cf394719 OT	9
	10	/* Commit formats */
	11	enum cmit_fmt {
	12	CMIT_FMT_RAW,
	13	CMIT_FMT_MEDIUM,
	14	CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
	15	CMIT_FMT_SHORT,
	16	CMIT_FMT_FULL,
	17	CMIT_FMT_FULLER,
	18	CMIT_FMT_ONELINE,
	19	CMIT_FMT_EMAIL,
	20	CMIT_FMT_MBOXRD,
	21	CMIT_FMT_USERFORMAT,
	22
	23	CMIT_FMT_UNSPECIFIED
	24	};
	25
	26	struct pretty_print_context {
	27	/*
	28	* Callers should tweak these to change the behavior of pp_* functions.
	29	*/
	30	enum cmit_fmt fmt;
	31	int abbrev;
	32	const char *after_subject;
	33	int preserve_subject;
	34	struct date_mode date_mode;
	35	unsigned date_mode_explicit:1;
	36	int print_email_subject;
	37	int expand_tabs_in_log;
	38	int need_8bit_cte;
	39	char *notes_message;
	40	struct reflog_walk_info *reflog_info;
	41	struct rev_info *rev;
	42	const char *output_encoding;
	43	struct string_list *mailmap;
	44	int color;
	45	struct ident_split *from_ident;
	46
	47	/*
	48	* Fields below here are manipulated internally by pp_* functions and
	49	* should not be counted on by callers.
	50	*/
	51	struct string_list in_body_headers;
	52	int graph_width;
	53	};
	54
d0e63260	55	/* Check whether commit format is mail. */
cf394719 OT	56	static inline int cmit_fmt_is_mail(enum cmit_fmt fmt)
	57	{
	58	return (fmt == CMIT_FMT_EMAIL \|\| fmt == CMIT_FMT_MBOXRD);
	59	}
	60
	61	struct userformat_want {
	62	unsigned notes:1;
	63	};
	64
d0e63260	65	/* Set the flag "w->notes" if there is placeholder %N in "fmt". */
cf394719	66	void userformat_find_requirements(const char fmt, struct userformat_want w);
d0e63260 OT	67
	68	/*
	69	* Shortcut for invoking pretty_print_commit if we do not have any context.
	70	* Context would be set empty except "fmt".
	71	*/
cf394719 OT	72	void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
cf394719 OT	73	struct strbuf *sb);
d0e63260 OT	74
	75	/*
	76	* Get information about user and date from "line", format it and
	77	* put it into "sb".
	78	* Format of "line" must be readable for split_ident_line function.
	79	* The resulting format is "what: name <email> date".
	80	*/
cf394719 OT	81	void pp_user_info(struct pretty_print_context pp, const char what,
	82	struct strbuf sb, const char line,
	83	const char *encoding);
d0e63260 OT	84
	85	/*
	86	* Format title line of commit message taken from "msg_p" and
	87	* put it into "sb".
	88	* First line of "msg_p" is also affected.
	89	*/
cf394719 OT	90	void pp_title_line(struct pretty_print_context pp, const char *msg_p,
	91	struct strbuf sb, const char encoding,
	92	int need_8bit_cte);
d0e63260 OT	93
	94	/*
	95	* Get current state of commit message from "msg_p" and continue formatting
	96	* by adding indentation and '>' signs. Put result into "sb".
	97	*/
cf394719 OT	98	void pp_remainder(struct pretty_print_context pp, const char *msg_p,
	99	struct strbuf *sb, int indent);
	100
d0e63260 OT	101	/*
	102	* Create a text message about commit using given "format" and "context".
	103	* Put the result to "sb".
	104	* Please use this function for custom formats.
	105	*/
cf394719 OT	106	void format_commit_message(const struct commit *commit,
	107	const char format, struct strbuf sb,
	108	const struct pretty_print_context *context);
	109
d0e63260 OT	110	/*
	111	* Parse given arguments from "arg", check it for correctness and
	112	* fill struct rev_info.
	113	*/
cf394719 OT	114	void get_commit_format(const char arg, struct rev_info );
cf394719 OT	115
d0e63260 OT	116	/*
	117	* Make a commit message with all rules from given "pp"
	118	* and put it into "sb".
	119	* Please use this function if you have a context (candidate for "pp").
	120	*/
cf394719 OT	121	void pretty_print_commit(struct pretty_print_context *pp,
	122	const struct commit *commit,
	123	struct strbuf *sb);
	124
d0e63260 OT	125	/*
	126	* Change line breaks in "msg" to "line_separator" and put it into "sb".
	127	* Return "msg" itself.
	128	*/
cf394719 OT	129	const char format_subject(struct strbuf sb, const char *msg,
	130	const char *line_separator);
	131
d0e63260	132	/* Check if "cmit_fmt" will produce an empty output. */
cf394719 OT	133	int commit_format_is_empty(enum cmit_fmt);
	134
	135	#endif /* PRETTY_H */