Andrew's git - gitweb.git/blob

011ddb146f4699a7333f4db3689f4eaac997bb10
   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 index;
  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        /*
  83         * Callers should tweak these to change the behavior of pp_* functions.
  84         */
  85        enum cmit_fmt fmt;
  86        int abbrev;
  87        const char *subject;
  88        const char *after_subject;
  89        int preserve_subject;
  90        enum date_mode date_mode;
  91        unsigned date_mode_explicit:1;
  92        int need_8bit_cte;
  93        char *notes_message;
  94        struct reflog_walk_info *reflog_info;
  95        const char *output_encoding;
  96        struct string_list *mailmap;
  97        int color;
  98
  99        /*
 100         * Fields below here are manipulated internally by pp_* functions and
 101         * should not be counted on by callers.
 102         */
 103};
 104
 105struct userformat_want {
 106        unsigned notes:1;
 107};
 108
 109extern int has_non_ascii(const char *text);
 110struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 111extern char *logmsg_reencode(const struct commit *commit,
 112                             char **commit_encoding,
 113                             const char *output_encoding);
 114extern void logmsg_free(char *msg, const struct commit *commit);
 115extern void get_commit_format(const char *arg, struct rev_info *);
 116extern const char *format_subject(struct strbuf *sb, const char *msg,
 117                                  const char *line_separator);
 118extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
 119extern void format_commit_message(const struct commit *commit,
 120                                  const char *format, struct strbuf *sb,
 121                                  const struct pretty_print_context *context);
 122extern void pretty_print_commit(struct pretty_print_context *pp,
 123                                const struct commit *commit,
 124                                struct strbuf *sb);
 125extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
 126                           struct strbuf *sb);
 127void pp_user_info(struct pretty_print_context *pp,
 128                  const char *what, struct strbuf *sb,
 129                  const char *line, const char *encoding);
 130void pp_title_line(struct pretty_print_context *pp,
 131                   const char **msg_p,
 132                   struct strbuf *sb,
 133                   const char *encoding,
 134                   int need_8bit_cte);
 135void pp_remainder(struct pretty_print_context *pp,
 136                  const char **msg_p,
 137                  struct strbuf *sb,
 138                  int indent);
 139
 140
 141/** Removes the first commit from a list sorted by date, and adds all
 142 * of its parents.
 143 **/
 144struct commit *pop_most_recent_commit(struct commit_list **list,
 145                                      unsigned int mark);
 146
 147struct commit *pop_commit(struct commit_list **stack);
 148
 149void clear_commit_marks(struct commit *commit, unsigned int mark);
 150void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
 151void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
 152
 153
 154enum rev_sort_order {
 155        REV_SORT_IN_GRAPH_ORDER = 0,
 156        REV_SORT_BY_COMMIT_DATE,
 157        REV_SORT_BY_AUTHOR_DATE
 158};
 159
 160/*
 161 * Performs an in-place topological sort of list supplied.
 162 *
 163 *   invariant of resulting list is:
 164 *      a reachable from b => ord(b) < ord(a)
 165 *   sort_order further specifies:
 166 *   REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
 167 *                            chain together.
 168 *   REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
 169 */
 170void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
 171
 172struct commit_graft {
 173        unsigned char sha1[20];
 174        int nr_parent; /* < 0 if shallow commit */
 175        unsigned char parent[FLEX_ARRAY][20]; /* more */
 176};
 177typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 178
 179struct commit_graft *read_graft_line(char *buf, int len);
 180int register_commit_graft(struct commit_graft *, int);
 181struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 182
 183extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 184extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 185extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 186
 187/* largest positive number a signed 32-bit integer can contain */
 188#define INFINITE_DEPTH 0x7fffffff
 189
 190extern int register_shallow(const unsigned char *sha1);
 191extern int unregister_shallow(const unsigned char *sha1);
 192extern int for_each_commit_graft(each_commit_graft_fn, void *);
 193extern int is_repository_shallow(void);
 194extern struct commit_list *get_shallow_commits(struct object_array *heads,
 195                int depth, int shallow_flag, int not_shallow_flag);
 196extern void check_shallow_file_for_update(void);
 197extern void set_alternate_shallow_file(const char *path);
 198
 199int is_descendant_of(struct commit *, struct commit_list *);
 200int in_merge_bases(struct commit *, struct commit *);
 201int in_merge_bases_many(struct commit *, int, struct commit **);
 202
 203extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 204extern int run_add_interactive(const char *revision, const char *patch_mode,
 205                               const char **pathspec);
 206
 207static inline int single_parent(struct commit *commit)
 208{
 209        return commit->parents && !commit->parents->next;
 210}
 211
 212struct commit_list *reduce_heads(struct commit_list *heads);
 213
 214struct commit_extra_header {
 215        struct commit_extra_header *next;
 216        char *key;
 217        char *value;
 218        size_t len;
 219};
 220
 221extern void append_merge_tag_headers(struct commit_list *parents,
 222                                     struct commit_extra_header ***tail);
 223
 224extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
 225                       struct commit_list *parents, unsigned char *ret,
 226                       const char *author, const char *sign_commit);
 227
 228extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
 229                                struct commit_list *parents, unsigned char *ret,
 230                                const char *author, const char *sign_commit,
 231                                struct commit_extra_header *);
 232
 233extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 234
 235extern void free_commit_extra_headers(struct commit_extra_header *extra);
 236
 237struct merge_remote_desc {
 238        struct object *obj; /* the named object, could be a tag */
 239        const char *name;
 240};
 241#define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
 242
 243/*
 244 * Given "name" from the command line to merge, find the commit object
 245 * and return it, while storing merge_remote_desc in its ->util field,
 246 * to allow callers to tell if we are told to merge a tag.
 247 */
 248struct commit *get_merge_parent(const char *name);
 249
 250extern int parse_signed_commit(const unsigned char *sha1,
 251                               struct strbuf *message, struct strbuf *signature);
 252extern void print_commit_list(struct commit_list *list,
 253                              const char *format_cur,
 254                              const char *format_last);
 255
 256/*
 257 * Check the signature of the given commit. The result of the check is stored
 258 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 259 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 260 * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 261 * sig->signer and sig->key.
 262 */
 263extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
 264
 265#endif /* COMMIT_H */