diff options
author | Junio C Hamano <gitster@pobox.com> | 2017-12-27 22:16:29 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-12-27 22:16:29 +0300 |
commit | 6bd396be0f9c87c2a7012d43eddc3c57f40a169b (patch) | |
tree | b689306d47202f5796005ec752e8d8829c1fec74 | |
parent | 00c4d2b6bca954b4505221616dd3f53230f9b299 (diff) | |
parent | d0e63260261f166b1e19ae4050404a9a71934dbe (diff) |
Merge branch 'ot/pretty'
Code clean-up.
* ot/pretty:
format: create docs for pretty.h
format: create pretty.h file
-rw-r--r-- | builtin/notes.c | 2 | ||||
-rw-r--r-- | builtin/reset.c | 2 | ||||
-rw-r--r-- | builtin/show-branch.c | 2 | ||||
-rw-r--r-- | commit.h | 81 | ||||
-rw-r--r-- | pretty.h | 131 | ||||
-rw-r--r-- | revision.h | 2 |
6 files changed, 136 insertions, 84 deletions
diff --git a/builtin/notes.c b/builtin/notes.c index 1a2c7d92ad..7c81761645 100644 --- a/builtin/notes.c +++ b/builtin/notes.c @@ -12,7 +12,7 @@ #include "builtin.h" #include "notes.h" #include "blob.h" -#include "commit.h" +#include "pretty.h" #include "refs.h" #include "exec_cmd.h" #include "run-command.h" diff --git a/builtin/reset.c b/builtin/reset.c index 906e541658..e15f595799 100644 --- a/builtin/reset.c +++ b/builtin/reset.c @@ -12,7 +12,7 @@ #include "lockfile.h" #include "tag.h" #include "object.h" -#include "commit.h" +#include "pretty.h" #include "run-command.h" #include "refs.h" #include "diff.h" diff --git a/builtin/show-branch.c b/builtin/show-branch.c index 2e24b5c330..e8a4aa40cb 100644 --- a/builtin/show-branch.c +++ b/builtin/show-branch.c @@ -1,6 +1,6 @@ #include "cache.h" #include "config.h" -#include "commit.h" +#include "pretty.h" #include "refs.h" #include "builtin.h" #include "color.h" @@ -7,6 +7,7 @@ #include "decorate.h" #include "gpg-interface.h" #include "string-list.h" +#include "pretty.h" struct commit_list { struct commit *item; @@ -121,93 +122,13 @@ struct commit_list *copy_commit_list(struct commit_list *list); void free_commit_list(struct commit_list *list); -/* 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 -}; - -static inline int cmit_fmt_is_mail(enum cmit_fmt fmt) -{ - return (fmt == CMIT_FMT_EMAIL || fmt == CMIT_FMT_MBOXRD); -} - struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ -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; -}; - -struct userformat_want { - unsigned notes:1; -}; - extern int has_non_ascii(const char *text); extern const char *logmsg_reencode(const struct commit *commit, char **commit_encoding, const char *output_encoding); -extern void get_commit_format(const char *arg, struct rev_info *); -extern const char *format_subject(struct strbuf *sb, const char *msg, - const char *line_separator); -extern void userformat_find_requirements(const char *fmt, struct userformat_want *w); -extern int commit_format_is_empty(enum cmit_fmt); extern const char *skip_blank_lines(const char *msg); -extern void format_commit_message(const struct commit *commit, - const char *format, struct strbuf *sb, - const struct pretty_print_context *context); -extern void pretty_print_commit(struct pretty_print_context *pp, - const struct commit *commit, - struct strbuf *sb); -extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit, - struct strbuf *sb); -void pp_user_info(struct pretty_print_context *pp, - const char *what, struct strbuf *sb, - const char *line, const char *encoding); -void pp_title_line(struct pretty_print_context *pp, - const char **msg_p, - struct strbuf *sb, - const char *encoding, - int need_8bit_cte); -void pp_remainder(struct pretty_print_context *pp, - const char **msg_p, - struct strbuf *sb, - int indent); - /** Removes the first commit from a list sorted by date, and adds all * of its parents. diff --git a/pretty.h b/pretty.h new file mode 100644 index 0000000000..5c85d94e33 --- /dev/null +++ b/pretty.h @@ -0,0 +1,131 @@ +#ifndef PRETTY_H +#define PRETTY_H + +struct commit; + +/* 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 */ diff --git a/revision.h b/revision.h index 54761200ad..747bce8d8a 100644 --- a/revision.h +++ b/revision.h @@ -4,7 +4,7 @@ #include "parse-options.h" #include "grep.h" #include "notes.h" -#include "commit.h" +#include "pretty.h" #include "diff.h" /* Remember to update object flag allocation in object.h */ |