commit.h

   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
   9 struct commit_list {
  10         struct commit *item;
  11         struct commit_list *next;
  12 };
  13
  14 struct commit {
  15         struct object object;
  16         void *util;
  17         unsigned long date;
  18         struct commit_list *parents;
  19         struct tree *tree;
  20         char *buffer;
  21 };
  22
  23 extern int save_commit_buffer;
  24 extern const char *commit_type;
  25
  26 /* While we can decorate any object with a name, it's only used for commits.. */
  27 extern struct decoration name_decoration;
  28 struct name_decoration {
  29         struct name_decoration *next;
  30         char name[1];
  31 };
  32
  33 struct commit *lookup_commit(const unsigned char *sha1);
  34 struct commit *lookup_commit_reference(const unsigned char *sha1);
  35 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  36                                               int quiet);
  37
  38 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
  39
  40 int parse_commit(struct commit *item);
  41
  42 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  43 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  44
  45 void free_commit_list(struct commit_list *list);
  46
  47 void sort_by_date(struct commit_list **list);
  48
  49 /* Commit formats */
  50 enum cmit_fmt {
  51         CMIT_FMT_RAW,
  52         CMIT_FMT_MEDIUM,
  53         CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  54         CMIT_FMT_SHORT,
  55         CMIT_FMT_FULL,
  56         CMIT_FMT_FULLER,
  57         CMIT_FMT_ONELINE,
  58         CMIT_FMT_EMAIL,
  59         CMIT_FMT_USERFORMAT,
  60
  61         CMIT_FMT_UNSPECIFIED,
  62 };
  63
  64 extern int non_ascii(int);
  65 extern enum cmit_fmt get_commit_format(const char *arg);
  66 extern void format_commit_message(const struct commit *commit,
  67                                   const void *format, struct strbuf *sb);
  68 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
  69                                 struct strbuf *,
  70                                 int abbrev, const char *subject,
  71                                 const char *after_subject, enum date_mode,
  72                                 int non_ascii_present);
  73
  74 /** Removes the first commit from a list sorted by date, and adds all
  75  * of its parents.
  76  **/
  77 struct commit *pop_most_recent_commit(struct commit_list **list,
  78                                       unsigned int mark);
  79
  80 struct commit *pop_commit(struct commit_list **stack);
  81
  82 void clear_commit_marks(struct commit *commit, unsigned int mark);
  83
  84 /*
  85  * Performs an in-place topological sort of list supplied.
  86  *
  87  * Pre-conditions for sort_in_topological_order:
  88  *   all commits in input list and all parents of those
  89  *   commits must have object.util == NULL
  90  *
  91  * Pre-conditions for sort_in_topological_order_fn:
  92  *   all commits in input list and all parents of those
  93  *   commits must have getter(commit) == NULL
  94  *
  95  * Post-conditions:
  96  *   invariant of resulting list is:
  97  *      a reachable from b => ord(b) < ord(a)
  98  *   in addition, when lifo == 0, commits on parallel tracks are
  99  *   sorted in the dates order.
 100  */
 101
 102 typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
 103 typedef void* (*topo_sort_get_fn_t)(struct commit*);
 104
 105 void topo_sort_default_setter(struct commit *c, void *data);
 106 void *topo_sort_default_getter(struct commit *c);
 107
 108 void sort_in_topological_order(struct commit_list ** list, int lifo);
 109 void sort_in_topological_order_fn(struct commit_list ** list, int lifo,
 110                                   topo_sort_set_fn_t setter,
 111                                   topo_sort_get_fn_t getter);
 112
 113 struct commit_graft {
 114         unsigned char sha1[20];
 115         int nr_parent; /* < 0 if shallow commit */
 116         unsigned char parent[FLEX_ARRAY][20]; /* more */
 117 };
 118
 119 struct commit_graft *read_graft_line(char *buf, int len);
 120 int register_commit_graft(struct commit_graft *, int);
 121 int read_graft_file(const char *graft_file);
 122
 123 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 124
 125 extern int register_shallow(const unsigned char *sha1);
 126 extern int unregister_shallow(const unsigned char *sha1);
 127 extern int write_shallow_commits(int fd, int use_pack_protocol);
 128 extern int is_repository_shallow(void);
 129 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 130                 int depth, int shallow_flag, int not_shallow_flag);
 131
 132 int in_merge_bases(struct commit *, struct commit **, int);
 133
 134 extern int interactive_add(void);
 135 extern void add_files_to_cache(int verbose, const char *prefix, const char **files);
 136 extern int rerere(void);
 137
 138 #endif /* COMMIT_H */