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