commit.hon commit t3404: fix a grammo (commands are ran -> commands are run) (fa90ab4)
   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);
  39
  40int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
  41
  42int parse_commit(struct commit *item);
  43
  44struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  45unsigned commit_list_count(const struct commit_list *l);
  46struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  47
  48void free_commit_list(struct commit_list *list);
  49
  50void sort_by_date(struct commit_list **list);
  51
  52/* Commit formats */
  53enum cmit_fmt {
  54        CMIT_FMT_RAW,
  55        CMIT_FMT_MEDIUM,
  56        CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  57        CMIT_FMT_SHORT,
  58        CMIT_FMT_FULL,
  59        CMIT_FMT_FULLER,
  60        CMIT_FMT_ONELINE,
  61        CMIT_FMT_EMAIL,
  62        CMIT_FMT_USERFORMAT,
  63
  64        CMIT_FMT_UNSPECIFIED
  65};
  66
  67struct pretty_print_context
  68{
  69        int abbrev;
  70        const char *subject;
  71        const char *after_subject;
  72        enum date_mode date_mode;
  73        int need_8bit_cte;
  74        int show_notes;
  75        struct reflog_walk_info *reflog_info;
  76};
  77
  78struct userformat_want {
  79        unsigned notes:1;
  80};
  81
  82extern int has_non_ascii(const char *text);
  83struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  84extern char *reencode_commit_message(const struct commit *commit,
  85                                     const char **encoding_p);
  86extern void get_commit_format(const char *arg, struct rev_info *);
  87extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
  88extern void format_commit_message(const struct commit *commit,
  89                                  const char *format, struct strbuf *sb,
  90                                  const struct pretty_print_context *context);
  91extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
  92                                struct strbuf *sb,
  93                                const struct pretty_print_context *context);
  94void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
  95                   const char *line, enum date_mode dmode,
  96                   const char *encoding);
  97void pp_title_line(enum cmit_fmt fmt,
  98                   const char **msg_p,
  99                   struct strbuf *sb,
 100                   const char *subject,
 101                   const char *after_subject,
 102                   const char *encoding,
 103                   int need_8bit_cte);
 104void pp_remainder(enum cmit_fmt fmt,
 105                  const char **msg_p,
 106                  struct strbuf *sb,
 107                  int indent);
 108
 109
 110/** Removes the first commit from a list sorted by date, and adds all
 111 * of its parents.
 112 **/
 113struct commit *pop_most_recent_commit(struct commit_list **list,
 114                                      unsigned int mark);
 115
 116struct commit *pop_commit(struct commit_list **stack);
 117
 118void clear_commit_marks(struct commit *commit, unsigned int mark);
 119
 120/*
 121 * Performs an in-place topological sort of list supplied.
 122 *
 123 *   invariant of resulting list is:
 124 *      a reachable from b => ord(b) < ord(a)
 125 *   in addition, when lifo == 0, commits on parallel tracks are
 126 *   sorted in the dates order.
 127 */
 128void sort_in_topological_order(struct commit_list ** list, int lifo);
 129
 130struct commit_graft {
 131        unsigned char sha1[20];
 132        int nr_parent; /* < 0 if shallow commit */
 133        unsigned char parent[FLEX_ARRAY][20]; /* more */
 134};
 135
 136struct commit_graft *read_graft_line(char *buf, int len);
 137int register_commit_graft(struct commit_graft *, int);
 138struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 139
 140const unsigned char *lookup_replace_object(const unsigned char *sha1);
 141
 142extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 143extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 144extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 145
 146extern int register_shallow(const unsigned char *sha1);
 147extern int unregister_shallow(const unsigned char *sha1);
 148extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol);
 149extern int is_repository_shallow(void);
 150extern struct commit_list *get_shallow_commits(struct object_array *heads,
 151                int depth, int shallow_flag, int not_shallow_flag);
 152
 153int is_descendant_of(struct commit *, struct commit_list *);
 154int in_merge_bases(struct commit *, struct commit **, int);
 155
 156extern int interactive_add(int argc, const char **argv, const char *prefix);
 157extern int run_add_interactive(const char *revision, const char *patch_mode,
 158                               const char **pathspec);
 159
 160static inline int single_parent(struct commit *commit)
 161{
 162        return commit->parents && !commit->parents->next;
 163}
 164
 165struct commit_list *reduce_heads(struct commit_list *heads);
 166
 167extern int commit_tree(const char *msg, unsigned char *tree,
 168                struct commit_list *parents, unsigned char *ret,
 169                const char *author);
 170
 171#endif /* COMMIT_H */