commit.hon commit Documentation: Add filter.<driver>.* to config (26488f5)
   1#ifndef COMMIT_H
   2#define COMMIT_H
   3
   4#include "object.h"
   5#include "tree.h"
   6#include "strbuf.h"
   7#include "decorate.h"
   8
   9struct commit_list {
  10        struct commit *item;
  11        struct commit_list *next;
  12};
  13
  14struct commit {
  15        struct object object;
  16        void *util;
  17        unsigned int indegree;
  18        unsigned long date;
  19        struct commit_list *parents;
  20        struct tree *tree;
  21        char *buffer;
  22};
  23
  24extern int save_commit_buffer;
  25extern const char *commit_type;
  26
  27/* While we can decorate any object with a name, it's only used for commits.. */
  28extern struct decoration name_decoration;
  29struct name_decoration {
  30        struct name_decoration *next;
  31        int type;
  32        char name[1];
  33};
  34
  35struct commit *lookup_commit(const unsigned char *sha1);
  36struct commit *lookup_commit_reference(const unsigned char *sha1);
  37struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  38                                              int quiet);
  39struct commit *lookup_commit_reference_by_name(const char *name);
  40
  41int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
  42int parse_commit(struct commit *item);
  43
  44/* Find beginning and length of commit subject. */
  45int find_commit_subject(const char *commit_buffer, const char **subject);
  46
  47struct commit_list *commit_list_insert(struct commit *item,
  48                                        struct commit_list **list);
  49unsigned commit_list_count(const struct commit_list *l);
  50struct commit_list *commit_list_insert_by_date(struct commit *item,
  51                                    struct commit_list **list);
  52void commit_list_sort_by_date(struct commit_list **list);
  53
  54void free_commit_list(struct commit_list *list);
  55
  56/* Commit formats */
  57enum cmit_fmt {
  58        CMIT_FMT_RAW,
  59        CMIT_FMT_MEDIUM,
  60        CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  61        CMIT_FMT_SHORT,
  62        CMIT_FMT_FULL,
  63        CMIT_FMT_FULLER,
  64        CMIT_FMT_ONELINE,
  65        CMIT_FMT_EMAIL,
  66        CMIT_FMT_USERFORMAT,
  67
  68        CMIT_FMT_UNSPECIFIED
  69};
  70
  71struct pretty_print_context {
  72        int abbrev;
  73        const char *subject;
  74        const char *after_subject;
  75        enum date_mode date_mode;
  76        int need_8bit_cte;
  77        int show_notes;
  78        struct reflog_walk_info *reflog_info;
  79        const char *output_encoding;
  80};
  81
  82struct userformat_want {
  83        unsigned notes:1;
  84};
  85
  86extern int has_non_ascii(const char *text);
  87struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  88extern char *logmsg_reencode(const struct commit *commit,
  89                             const char *output_encoding);
  90extern char *reencode_commit_message(const struct commit *commit,
  91                                     const char **encoding_p);
  92extern void get_commit_format(const char *arg, struct rev_info *);
  93extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
  94extern void format_commit_message(const struct commit *commit,
  95                                  const char *format, struct strbuf *sb,
  96                                  const struct pretty_print_context *context);
  97extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
  98                                struct strbuf *sb,
  99                                const struct pretty_print_context *context);
 100void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
 101                   const char *line, enum date_mode dmode,
 102                   const char *encoding);
 103void pp_title_line(enum cmit_fmt fmt,
 104                   const char **msg_p,
 105                   struct strbuf *sb,
 106                   const char *subject,
 107                   const char *after_subject,
 108                   const char *encoding,
 109                   int need_8bit_cte);
 110void pp_remainder(enum cmit_fmt fmt,
 111                  const char **msg_p,
 112                  struct strbuf *sb,
 113                  int indent);
 114
 115
 116/** Removes the first commit from a list sorted by date, and adds all
 117 * of its parents.
 118 **/
 119struct commit *pop_most_recent_commit(struct commit_list **list,
 120                                      unsigned int mark);
 121
 122struct commit *pop_commit(struct commit_list **stack);
 123
 124void clear_commit_marks(struct commit *commit, unsigned int mark);
 125
 126/*
 127 * Performs an in-place topological sort of list supplied.
 128 *
 129 *   invariant of resulting list is:
 130 *      a reachable from b => ord(b) < ord(a)
 131 *   in addition, when lifo == 0, commits on parallel tracks are
 132 *   sorted in the dates order.
 133 */
 134void sort_in_topological_order(struct commit_list ** list, int lifo);
 135
 136struct commit_graft {
 137        unsigned char sha1[20];
 138        int nr_parent; /* < 0 if shallow commit */
 139        unsigned char parent[FLEX_ARRAY][20]; /* more */
 140};
 141
 142struct commit_graft *read_graft_line(char *buf, int len);
 143int register_commit_graft(struct commit_graft *, int);
 144struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 145
 146const unsigned char *lookup_replace_object(const unsigned char *sha1);
 147
 148extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 149extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 150extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 151
 152extern int register_shallow(const unsigned char *sha1);
 153extern int unregister_shallow(const unsigned char *sha1);
 154extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
 155extern int is_repository_shallow(void);
 156extern struct commit_list *get_shallow_commits(struct object_array *heads,
 157                int depth, int shallow_flag, int not_shallow_flag);
 158
 159int is_descendant_of(struct commit *, struct commit_list *);
 160int in_merge_bases(struct commit *, struct commit **, int);
 161
 162extern int interactive_add(int argc, const char **argv, const char *prefix);
 163extern int run_add_interactive(const char *revision, const char *patch_mode,
 164                               const char **pathspec);
 165
 166static inline int single_parent(struct commit *commit)
 167{
 168        return commit->parents && !commit->parents->next;
 169}
 170
 171struct commit_list *reduce_heads(struct commit_list *heads);
 172
 173extern int commit_tree(const char *msg, unsigned char *tree,
 174                struct commit_list *parents, unsigned char *ret,
 175                const char *author);
 176
 177#endif /* COMMIT_H */