commit.h

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