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#include "gpg-interface.h"
   9
  10struct commit_list {
  11        struct commit *item;
  12        struct commit_list *next;
  13};
  14
  15struct commit {
  16        struct object object;
  17        void *util;
  18        unsigned int indegree;
  19        unsigned long date;
  20        struct commit_list *parents;
  21        struct tree *tree;
  22        char *buffer;
  23};
  24
  25extern int save_commit_buffer;
  26extern const char *commit_type;
  27
  28/* While we can decorate any object with a name, it's only used for commits.. */
  29extern struct decoration name_decoration;
  30struct name_decoration {
  31        struct name_decoration *next;
  32        int type;
  33        char name[1];
  34};
  35
  36struct commit *lookup_commit(const unsigned char *sha1);
  37struct commit *lookup_commit_reference(const unsigned char *sha1);
  38struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  39                                              int quiet);
  40struct commit *lookup_commit_reference_by_name(const char *name);
  41
  42/*
  43 * Look up object named by "sha1", dereference tag as necessary,
  44 * get a commit and return it. If "sha1" does not dereference to
  45 * a commit, use ref_name to report an error and die.
  46 */
  47struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
  48
  49int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
  50int parse_commit(struct commit *item);
  51
  52/* Find beginning and length of commit subject. */
  53int find_commit_subject(const char *commit_buffer, const char **subject);
  54
  55struct commit_list *commit_list_insert(struct commit *item,
  56                                        struct commit_list **list);
  57struct commit_list **commit_list_append(struct commit *commit,
  58                                        struct commit_list **next);
  59unsigned commit_list_count(const struct commit_list *l);
  60struct commit_list *commit_list_insert_by_date(struct commit *item,
  61                                    struct commit_list **list);
  62void commit_list_sort_by_date(struct commit_list **list);
  63
  64void free_commit_list(struct commit_list *list);
  65
  66/* Commit formats */
  67enum cmit_fmt {
  68        CMIT_FMT_RAW,
  69        CMIT_FMT_MEDIUM,
  70        CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  71        CMIT_FMT_SHORT,
  72        CMIT_FMT_FULL,
  73        CMIT_FMT_FULLER,
  74        CMIT_FMT_ONELINE,
  75        CMIT_FMT_EMAIL,
  76        CMIT_FMT_USERFORMAT,
  77
  78        CMIT_FMT_UNSPECIFIED
  79};
  80
  81struct pretty_print_context {
  82        enum cmit_fmt fmt;
  83        int abbrev;
  84        const char *subject;
  85        const char *after_subject;
  86        int preserve_subject;
  87        enum date_mode date_mode;
  88        unsigned date_mode_explicit:1;
  89        int need_8bit_cte;
  90        char *notes_message;
  91        struct reflog_walk_info *reflog_info;
  92        const char *output_encoding;
  93        struct string_list *mailmap;
  94        int color;
  95};
  96
  97struct userformat_want {
  98        unsigned notes:1;
  99};
 100
 101extern int has_non_ascii(const char *text);
 102struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 103extern char *logmsg_reencode(const struct commit *commit,
 104                             char **commit_encoding,
 105                             const char *output_encoding);
 106extern void logmsg_free(char *msg, const struct commit *commit);
 107extern void get_commit_format(const char *arg, struct rev_info *);
 108extern const char *format_subject(struct strbuf *sb, const char *msg,
 109                                  const char *line_separator);
 110extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
 111extern void format_commit_message(const struct commit *commit,
 112                                  const char *format, struct strbuf *sb,
 113                                  const struct pretty_print_context *context);
 114extern void pretty_print_commit(const struct pretty_print_context *pp,
 115                                const struct commit *commit,
 116                                struct strbuf *sb);
 117extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
 118                           struct strbuf *sb);
 119void pp_user_info(const struct pretty_print_context *pp,
 120                  const char *what, struct strbuf *sb,
 121                  const char *line, const char *encoding);
 122void pp_title_line(const struct pretty_print_context *pp,
 123                   const char **msg_p,
 124                   struct strbuf *sb,
 125                   const char *encoding,
 126                   int need_8bit_cte);
 127void pp_remainder(const struct pretty_print_context *pp,
 128                  const char **msg_p,
 129                  struct strbuf *sb,
 130                  int indent);
 131
 132
 133/** Removes the first commit from a list sorted by date, and adds all
 134 * of its parents.
 135 **/
 136struct commit *pop_most_recent_commit(struct commit_list **list,
 137                                      unsigned int mark);
 138
 139struct commit *pop_commit(struct commit_list **stack);
 140
 141void clear_commit_marks(struct commit *commit, unsigned int mark);
 142void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
 143void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
 144
 145/*
 146 * Performs an in-place topological sort of list supplied.
 147 *
 148 *   invariant of resulting list is:
 149 *      a reachable from b => ord(b) < ord(a)
 150 *   in addition, when lifo == 0, commits on parallel tracks are
 151 *   sorted in the dates order.
 152 */
 153void sort_in_topological_order(struct commit_list ** list, int lifo);
 154
 155struct commit_graft {
 156        unsigned char sha1[20];
 157        int nr_parent; /* < 0 if shallow commit */
 158        unsigned char parent[FLEX_ARRAY][20]; /* more */
 159};
 160typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 161
 162struct commit_graft *read_graft_line(char *buf, int len);
 163int register_commit_graft(struct commit_graft *, int);
 164struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 165
 166extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 167extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 168extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 169
 170/* largest positive number a signed 32-bit integer can contain */
 171#define INFINITE_DEPTH 0x7fffffff
 172
 173extern int register_shallow(const unsigned char *sha1);
 174extern int unregister_shallow(const unsigned char *sha1);
 175extern int for_each_commit_graft(each_commit_graft_fn, void *);
 176extern int is_repository_shallow(void);
 177extern struct commit_list *get_shallow_commits(struct object_array *heads,
 178                int depth, int shallow_flag, int not_shallow_flag);
 179extern void check_shallow_file_for_update(void);
 180extern void set_alternate_shallow_file(const char *path);
 181
 182int is_descendant_of(struct commit *, struct commit_list *);
 183int in_merge_bases(struct commit *, struct commit *);
 184int in_merge_bases_many(struct commit *, int, struct commit **);
 185
 186extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 187extern int run_add_interactive(const char *revision, const char *patch_mode,
 188                               const char **pathspec);
 189
 190static inline int single_parent(struct commit *commit)
 191{
 192        return commit->parents && !commit->parents->next;
 193}
 194
 195struct commit_list *reduce_heads(struct commit_list *heads);
 196
 197struct commit_extra_header {
 198        struct commit_extra_header *next;
 199        char *key;
 200        char *value;
 201        size_t len;
 202};
 203
 204extern void append_merge_tag_headers(struct commit_list *parents,
 205                                     struct commit_extra_header ***tail);
 206
 207extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
 208                       struct commit_list *parents, unsigned char *ret,
 209                       const char *author, const char *sign_commit);
 210
 211extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
 212                                struct commit_list *parents, unsigned char *ret,
 213                                const char *author, const char *sign_commit,
 214                                struct commit_extra_header *);
 215
 216extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 217
 218extern void free_commit_extra_headers(struct commit_extra_header *extra);
 219
 220struct merge_remote_desc {
 221        struct object *obj; /* the named object, could be a tag */
 222        const char *name;
 223};
 224#define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
 225
 226/*
 227 * Given "name" from the command line to merge, find the commit object
 228 * and return it, while storing merge_remote_desc in its ->util field,
 229 * to allow callers to tell if we are told to merge a tag.
 230 */
 231struct commit *get_merge_parent(const char *name);
 232
 233extern int parse_signed_commit(const unsigned char *sha1,
 234                               struct strbuf *message, struct strbuf *signature);
 235extern void print_commit_list(struct commit_list *list,
 236                              const char *format_cur,
 237                              const char *format_last);
 238
 239/*
 240 * Check the signature of the given commit. The result of the check is stored
 241 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 242 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 243 * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 244 * sig->signer and sig->key.
 245 */
 246extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
 247
 248#endif /* COMMIT_H */