Andrew's git - gitweb.git/blob

   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        enum cmit_fmt fmt;
  73        int abbrev;
  74        const char *subject;
  75        const char *after_subject;
  76        int preserve_subject;
  77        enum date_mode date_mode;
  78        int need_8bit_cte;
  79        int show_notes;
  80        struct reflog_walk_info *reflog_info;
  81        const char *output_encoding;
  82};
  83
  84struct userformat_want {
  85        unsigned notes:1;
  86};
  87
  88extern int has_non_ascii(const char *text);
  89struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  90extern char *logmsg_reencode(const struct commit *commit,
  91                             const char *output_encoding);
  92extern char *reencode_commit_message(const struct commit *commit,
  93                                     const char **encoding_p);
  94extern void get_commit_format(const char *arg, struct rev_info *);
  95extern const char *format_subject(struct strbuf *sb, const char *msg,
  96                                  const char *line_separator);
  97extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
  98extern void format_commit_message(const struct commit *commit,
  99                                  const char *format, struct strbuf *sb,
 100                                  const struct pretty_print_context *context);
 101extern void pretty_print_commit(const struct pretty_print_context *pp,
 102                                const struct commit *commit,
 103                                struct strbuf *sb);
 104extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
 105                           struct strbuf *sb);
 106void pp_user_info(const struct pretty_print_context *pp,
 107                  const char *what, struct strbuf *sb,
 108                  const char *line, const char *encoding);
 109void pp_title_line(const struct pretty_print_context *pp,
 110                   const char **msg_p,
 111                   struct strbuf *sb,
 112                   const char *encoding,
 113                   int need_8bit_cte);
 114void pp_remainder(const struct pretty_print_context *pp,
 115                  const char **msg_p,
 116                  struct strbuf *sb,
 117                  int indent);
 118
 119
 120/** Removes the first commit from a list sorted by date, and adds all
 121 * of its parents.
 122 **/
 123struct commit *pop_most_recent_commit(struct commit_list **list,
 124                                      unsigned int mark);
 125
 126struct commit *pop_commit(struct commit_list **stack);
 127
 128void clear_commit_marks(struct commit *commit, unsigned int mark);
 129
 130/*
 131 * Performs an in-place topological sort of list supplied.
 132 *
 133 *   invariant of resulting list is:
 134 *      a reachable from b => ord(b) < ord(a)
 135 *   in addition, when lifo == 0, commits on parallel tracks are
 136 *   sorted in the dates order.
 137 */
 138void sort_in_topological_order(struct commit_list ** list, int lifo);
 139
 140struct commit_graft {
 141        unsigned char sha1[20];
 142        int nr_parent; /* < 0 if shallow commit */
 143        unsigned char parent[FLEX_ARRAY][20]; /* more */
 144};
 145typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 146
 147struct commit_graft *read_graft_line(char *buf, int len);
 148int register_commit_graft(struct commit_graft *, int);
 149struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 150
 151extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 152extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 153extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 154
 155extern int register_shallow(const unsigned char *sha1);
 156extern int unregister_shallow(const unsigned char *sha1);
 157extern int for_each_commit_graft(each_commit_graft_fn, void *);
 158extern int is_repository_shallow(void);
 159extern struct commit_list *get_shallow_commits(struct object_array *heads,
 160                int depth, int shallow_flag, int not_shallow_flag);
 161
 162int is_descendant_of(struct commit *, struct commit_list *);
 163int in_merge_bases(struct commit *, struct commit **, int);
 164
 165extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 166extern int run_add_interactive(const char *revision, const char *patch_mode,
 167                               const char **pathspec);
 168
 169static inline int single_parent(struct commit *commit)
 170{
 171        return commit->parents && !commit->parents->next;
 172}
 173
 174struct commit_list *reduce_heads(struct commit_list *heads);
 175
 176extern int commit_tree(const char *msg, unsigned char *tree,
 177                struct commit_list *parents, unsigned char *ret,
 178                const char *author);
 179
 180#endif /* COMMIT_H */