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