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
   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);
  39struct commit *lookup_commit_reference_by_name(const char *name);
  40
  41/*
  42 * Look up object named by "sha1", dereference tag as necessary,
  43 * get a commit and return it. If "sha1" does not dereference to
  44 * a commit, use ref_name to report an error and die.
  45 */
  46struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
  47
  48int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
  49int parse_commit(struct commit *item);
  50
  51/* Find beginning and length of commit subject. */
  52int find_commit_subject(const char *commit_buffer, const char **subject);
  53
  54struct commit_list *commit_list_insert(struct commit *item,
  55                                        struct commit_list **list);
  56struct commit_list **commit_list_append(struct commit *commit,
  57                                        struct commit_list **next);
  58unsigned commit_list_count(const struct commit_list *l);
  59struct commit_list *commit_list_insert_by_date(struct commit *item,
  60                                    struct commit_list **list);
  61void commit_list_sort_by_date(struct commit_list **list);
  62
  63void free_commit_list(struct commit_list *list);
  64
  65/* Commit formats */
  66enum cmit_fmt {
  67        CMIT_FMT_RAW,
  68        CMIT_FMT_MEDIUM,
  69        CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  70        CMIT_FMT_SHORT,
  71        CMIT_FMT_FULL,
  72        CMIT_FMT_FULLER,
  73        CMIT_FMT_ONELINE,
  74        CMIT_FMT_EMAIL,
  75        CMIT_FMT_USERFORMAT,
  76
  77        CMIT_FMT_UNSPECIFIED
  78};
  79
  80struct pretty_print_context {
  81        enum cmit_fmt fmt;
  82        int abbrev;
  83        const char *subject;
  84        const char *after_subject;
  85        int preserve_subject;
  86        enum date_mode date_mode;
  87        int need_8bit_cte;
  88        int show_notes;
  89        struct reflog_walk_info *reflog_info;
  90        const char *output_encoding;
  91};
  92
  93struct userformat_want {
  94        unsigned notes:1;
  95};
  96
  97extern int has_non_ascii(const char *text);
  98struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
  99extern char *logmsg_reencode(const struct commit *commit,
 100                             const char *output_encoding);
 101extern char *reencode_commit_message(const struct commit *commit,
 102                                     const char **encoding_p);
 103extern void get_commit_format(const char *arg, struct rev_info *);
 104extern const char *format_subject(struct strbuf *sb, const char *msg,
 105                                  const char *line_separator);
 106extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
 107extern void format_commit_message(const struct commit *commit,
 108                                  const char *format, struct strbuf *sb,
 109                                  const struct pretty_print_context *context);
 110extern void pretty_print_commit(const struct pretty_print_context *pp,
 111                                const struct commit *commit,
 112                                struct strbuf *sb);
 113extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
 114                           struct strbuf *sb);
 115void pp_user_info(const struct pretty_print_context *pp,
 116                  const char *what, struct strbuf *sb,
 117                  const char *line, const char *encoding);
 118void pp_title_line(const struct pretty_print_context *pp,
 119                   const char **msg_p,
 120                   struct strbuf *sb,
 121                   const char *encoding,
 122                   int need_8bit_cte);
 123void pp_remainder(const struct pretty_print_context *pp,
 124                  const char **msg_p,
 125                  struct strbuf *sb,
 126                  int indent);
 127
 128
 129/** Removes the first commit from a list sorted by date, and adds all
 130 * of its parents.
 131 **/
 132struct commit *pop_most_recent_commit(struct commit_list **list,
 133                                      unsigned int mark);
 134
 135struct commit *pop_commit(struct commit_list **stack);
 136
 137void clear_commit_marks(struct commit *commit, unsigned int mark);
 138void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
 139
 140/*
 141 * Performs an in-place topological sort of list supplied.
 142 *
 143 *   invariant of resulting list is:
 144 *      a reachable from b => ord(b) < ord(a)
 145 *   in addition, when lifo == 0, commits on parallel tracks are
 146 *   sorted in the dates order.
 147 */
 148void sort_in_topological_order(struct commit_list ** list, int lifo);
 149
 150struct commit_graft {
 151        unsigned char sha1[20];
 152        int nr_parent; /* < 0 if shallow commit */
 153        unsigned char parent[FLEX_ARRAY][20]; /* more */
 154};
 155typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 156
 157struct commit_graft *read_graft_line(char *buf, int len);
 158int register_commit_graft(struct commit_graft *, int);
 159struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
 160
 161extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 162extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
 163extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 164
 165extern int register_shallow(const unsigned char *sha1);
 166extern int unregister_shallow(const unsigned char *sha1);
 167extern int for_each_commit_graft(each_commit_graft_fn, void *);
 168extern int is_repository_shallow(void);
 169extern struct commit_list *get_shallow_commits(struct object_array *heads,
 170                int depth, int shallow_flag, int not_shallow_flag);
 171
 172int is_descendant_of(struct commit *, struct commit_list *);
 173int in_merge_bases(struct commit *, struct commit **, int);
 174
 175extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 176extern int run_add_interactive(const char *revision, const char *patch_mode,
 177                               const char **pathspec);
 178
 179static inline int single_parent(struct commit *commit)
 180{
 181        return commit->parents && !commit->parents->next;
 182}
 183
 184struct commit_list *reduce_heads(struct commit_list *heads);
 185
 186struct commit_extra_header {
 187        struct commit_extra_header *next;
 188        char *key;
 189        char *value;
 190        size_t len;
 191};
 192
 193extern void append_merge_tag_headers(struct commit_list *parents,
 194                                     struct commit_extra_header ***tail);
 195
 196extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
 197                       struct commit_list *parents, unsigned char *ret,
 198                       const char *author, const char *sign_commit);
 199
 200extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
 201                                struct commit_list *parents, unsigned char *ret,
 202                                const char *author, const char *sign_commit,
 203                                struct commit_extra_header *);
 204
 205extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 206extern struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **);
 207
 208extern void free_commit_extra_headers(struct commit_extra_header *extra);
 209
 210struct merge_remote_desc {
 211        struct object *obj; /* the named object, could be a tag */
 212        const char *name;
 213};
 214#define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
 215
 216/*
 217 * Given "name" from the command line to merge, find the commit object
 218 * and return it, while storing merge_remote_desc in its ->util field,
 219 * to allow callers to tell if we are told to merge a tag.
 220 */
 221struct commit *get_merge_parent(const char *name);
 222
 223extern int parse_signed_commit(const unsigned char *sha1,
 224                               struct strbuf *message, struct strbuf *signature);
 225#endif /* COMMIT_H */