pretty.h

   1 #ifndef PRETTY_H
   2 #define PRETTY_H
   3
   4 #include "cache.h"
   5 #include "date.h"
   6 #include "string-list.h"
   7
   8 struct commit;
   9 struct strbuf;
  10 struct process_trailer_options;
  11
  12 /* Commit formats */
  13 enum cmit_fmt {
  14         CMIT_FMT_RAW,
  15         CMIT_FMT_MEDIUM,
  16         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  17         CMIT_FMT_SHORT,
  18         CMIT_FMT_FULL,
  19         CMIT_FMT_FULLER,
  20         CMIT_FMT_ONELINE,
  21         CMIT_FMT_EMAIL,
  22         CMIT_FMT_MBOXRD,
  23         CMIT_FMT_USERFORMAT,
  24
  25         CMIT_FMT_UNSPECIFIED
  26 };
  27
  28 struct pretty_print_describe_status {
  29         unsigned int max_invocations;
  30 };
  31
  32 struct pretty_print_context {
  33         /*
  34          * Callers should tweak these to change the behavior of pp_* functions.
  35          */
  36         enum cmit_fmt fmt;
  37         int abbrev;
  38         const char *after_subject;
  39         int preserve_subject;
  40         struct date_mode date_mode;
  41         unsigned date_mode_explicit:1;
  42         int print_email_subject;
  43         int expand_tabs_in_log;
  44         int need_8bit_cte;
  45         char *notes_message;
  46         struct reflog_walk_info *reflog_info;
  47         struct rev_info *rev;
  48         const char *output_encoding;
  49         struct string_list *mailmap;
  50         int color;
  51         struct ident_split *from_ident;
  52         unsigned encode_email_headers:1;
  53         struct pretty_print_describe_status *describe_status;
  54
  55         /*
  56          * Fields below here are manipulated internally by pp_* functions and
  57          * should not be counted on by callers.
  58          */
  59         struct string_list in_body_headers;
  60         int graph_width;
  61 };
  62
  63 /* Check whether commit format is mail. */
  64 static inline int cmit_fmt_is_mail(enum cmit_fmt fmt)
  65 {
  66         return (fmt == CMIT_FMT_EMAIL || fmt == CMIT_FMT_MBOXRD);
  67 }
  68
  69 /*
  70  * Examine the user-specified format given by "fmt" (or if NULL, the global one
  71  * previously saved by get_commit_format()), and set flags based on which items
  72  * the format will need when it is expanded.
  73  */
  74 struct userformat_want {
  75         unsigned notes:1;
  76         unsigned source:1;
  77         unsigned decorate:1;
  78 };
  79 void userformat_find_requirements(const char *fmt, struct userformat_want *w);
  80
  81 /*
  82  * Shortcut for invoking pretty_print_commit if we do not have any context.
  83  * Context would be set empty except "fmt".
  84  */
  85 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
  86                         struct strbuf *sb);
  87
  88 /*
  89  * Get information about user and date from "line", format it and
  90  * put it into "sb".
  91  * Format of "line" must be readable for split_ident_line function.
  92  * The resulting format is "what: name <email> date".
  93  */
  94 void pp_user_info(struct pretty_print_context *pp, const char *what,
  95                         struct strbuf *sb, const char *line,
  96                         const char *encoding);
  97
  98 /*
  99  * Format title line of commit message taken from "msg_p" and
 100  * put it into "sb".
 101  * First line of "msg_p" is also affected.
 102  */
 103 void pp_title_line(struct pretty_print_context *pp, const char **msg_p,
 104                         struct strbuf *sb, const char *encoding,
 105                         int need_8bit_cte);
 106
 107 /*
 108  * Get current state of commit message from "msg_p" and continue formatting
 109  * by adding indentation and '>' signs. Put result into "sb".
 110  */
 111 void pp_remainder(struct pretty_print_context *pp, const char **msg_p,
 112                         struct strbuf *sb, int indent);
 113
 114 /*
 115  * Create a text message about commit using given "format" and "context".
 116  * Put the result to "sb".
 117  * Please use this function for custom formats.
 118  */
 119 void repo_format_commit_message(struct repository *r,
 120                         const struct commit *commit,
 121                         const char *format, struct strbuf *sb,
 122                         const struct pretty_print_context *context);
 123 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 124 #define format_commit_message(c, f, s, con) \
 125         repo_format_commit_message(the_repository, c, f, s, con)
 126 #endif
 127
 128 /*
 129  * Parse given arguments from "arg", check it for correctness and
 130  * fill struct rev_info.
 131  */
 132 void get_commit_format(const char *arg, struct rev_info *);
 133
 134 /*
 135  * Make a commit message with all rules from given "pp"
 136  * and put it into "sb".
 137  * Please use this function if you have a context (candidate for "pp").
 138  */
 139 void pretty_print_commit(struct pretty_print_context *pp,
 140                         const struct commit *commit,
 141                         struct strbuf *sb);
 142
 143 /*
 144  * Change line breaks in "msg" to "line_separator" and put it into "sb".
 145  * Return "msg" itself.
 146  */
 147 const char *format_subject(struct strbuf *sb, const char *msg,
 148                         const char *line_separator);
 149
 150 /* Check if "cmit_fmt" will produce an empty output. */
 151 int commit_format_is_empty(enum cmit_fmt);
 152
 153 /* Make subject of commit message suitable for filename */
 154 void format_sanitized_subject(struct strbuf *sb, const char *msg, size_t len);
 155
 156 /*
 157  * Set values of fields in "struct process_trailer_options"
 158  * according to trailers arguments.
 159  */
 160 int format_set_trailers_options(struct process_trailer_options *opts,
 161                         struct string_list *filter_list,
 162                         struct strbuf *sepbuf,
 163                         struct strbuf *kvsepbuf,
 164                         const char **arg,
 165                         char **invalid_arg);
 166
 167 /*
 168  * Like show_date, but pull the timestamp and tz parameters from
 169  * the ident_split. It will also sanity-check the values and produce
 170  * a well-known sentinel date if they appear bogus.
 171  */
 172 const char *show_ident_date(const struct ident_split *id,
 173                             const struct date_mode *mode);
 174
 175
 176 #endif /* PRETTY_H */