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