format: create pretty.h file
authorOlga Telezhnaya <olyatelezhnaya@gmail.com>
Tue, 12 Dec 2017 08:55:35 +0000 (08:55 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 12 Dec 2017 18:39:43 +0000 (10:39 -0800)
Create header for pretty.c to make formatting interface more structured.
This is a middle point, this file would be merged further with other
files which contain formatting stuff.

Signed-off-by: Olga Telezhnaia <olyatelezhnaya@gmail.com>
Mentored-by: Christian Couder <christian.couder@gmail.com>
Mentored by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/notes.c
builtin/reset.c
builtin/show-branch.c
commit.h
pretty.h [new file with mode: 0644]
revision.h

index e435286..166bb3f 100644 (file)
@@ -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"
index 9cd89b2..43c8514 100644 (file)
@@ -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"
index 6fa1f62..f4069d6 100644 (file)
@@ -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"
index 99a3fea..8c68ca1 100644 (file)
--- a/commit.h
+++ b/commit.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 (file)
index 0000000..ef51674
--- /dev/null
+++ b/pretty.h
@@ -0,0 +1,87 @@
+#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;
+};
+
+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;
+};
+
+void userformat_find_requirements(const char *fmt, struct userformat_want *w);
+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);
+
+void format_commit_message(const struct commit *commit,
+                       const char *format, struct strbuf *sb,
+                       const struct pretty_print_context *context);
+
+void get_commit_format(const char *arg, struct rev_info *);
+
+void pretty_print_commit(struct pretty_print_context *pp,
+                       const struct commit *commit,
+                       struct strbuf *sb);
+
+const char *format_subject(struct strbuf *sb, const char *msg,
+                       const char *line_separator);
+
+int commit_format_is_empty(enum cmit_fmt);
+
+#endif /* PRETTY_H */
index 5476120..747bce8 100644 (file)
@@ -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 */