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 #include "pretty.h"
  11 #include "commit-slab.h"
  12
  13 #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
  14 #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
  15 #define GENERATION_NUMBER_MAX 0x3FFFFFFF
  16 #define GENERATION_NUMBER_ZERO 0
  17
  18 struct commit_list {
  19         struct commit *item;
  20         struct commit_list *next;
  21 };
  22
  23 /*
  24  * The size of this struct matters in full repo walk operations like
  25  * 'git clone' or 'git gc'. Consider using commit-slab to attach data
  26  * to a commit instead of adding new fields here.
  27  */
  28 struct commit {
  29         struct object object;
  30         timestamp_t date;
  31         struct commit_list *parents;
  32
  33         /*
  34          * If the commit is loaded from the commit-graph file, then this
  35          * member may be NULL. Only access it through get_commit_tree()
  36          * or get_commit_tree_oid().
  37          */
  38         struct tree *maybe_tree;
  39         uint32_t graph_pos;
  40         uint32_t generation;
  41         unsigned int index;
  42 };
  43
  44 extern int save_commit_buffer;
  45 extern const char *commit_type;
  46
  47 /* While we can decorate any object with a name, it's only used for commits.. */
  48 struct name_decoration {
  49         struct name_decoration *next;
  50         int type;
  51         char name[FLEX_ARRAY];
  52 };
  53
  54 enum decoration_type {
  55         DECORATION_NONE = 0,
  56         DECORATION_REF_LOCAL,
  57         DECORATION_REF_REMOTE,
  58         DECORATION_REF_TAG,
  59         DECORATION_REF_STASH,
  60         DECORATION_REF_HEAD,
  61         DECORATION_GRAFTED,
  62 };
  63
  64 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
  65 const struct name_decoration *get_name_decoration(const struct object *obj);
  66
  67 struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
  68 struct commit *lookup_commit_reference(struct repository *r,
  69                                        const struct object_id *oid);
  70 struct commit *lookup_commit_reference_gently(struct repository *r,
  71                                               const struct object_id *oid,
  72                                               int quiet);
  73 struct commit *lookup_commit_reference_by_name(const char *name);
  74
  75 /*
  76  * Look up object named by "oid", dereference tag as necessary,
  77  * get a commit and return it. If "oid" does not dereference to
  78  * a commit, use ref_name to report an error and die.
  79  */
  80 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
  81
  82 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
  83 int parse_commit_internal(struct commit *item, int quiet_on_missing, int use_commit_graph);
  84 int parse_commit_gently(struct commit *item, int quiet_on_missing);
  85 static inline int parse_commit(struct commit *item)
  86 {
  87         return parse_commit_gently(item, 0);
  88 }
  89 void parse_commit_or_die(struct commit *item);
  90
  91 struct buffer_slab;
  92 struct buffer_slab *allocate_commit_buffer_slab(void);
  93 void free_commit_buffer_slab(struct buffer_slab *bs);
  94
  95 /*
  96  * Associate an object buffer with the commit. The ownership of the
  97  * memory is handed over to the commit, and must be free()-able.
  98  */
  99 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
 100
 101 /*
 102  * Get any cached object buffer associated with the commit. Returns NULL
 103  * if none. The resulting memory should not be freed.
 104  */
 105 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
 106
 107 /*
 108  * Get the commit's object contents, either from cache or by reading the object
 109  * from disk. The resulting memory should not be modified, and must be given
 110  * to unuse_commit_buffer when the caller is done.
 111  */
 112 const void *get_commit_buffer(const struct commit *, unsigned long *size);
 113
 114 /*
 115  * Tell the commit subsytem that we are done with a particular commit buffer.
 116  * The commit and buffer should be the input and return value, respectively,
 117  * from an earlier call to get_commit_buffer.  The buffer may or may not be
 118  * freed by this call; callers should not access the memory afterwards.
 119  */
 120 void unuse_commit_buffer(const struct commit *, const void *buffer);
 121
 122 /*
 123  * Free any cached object buffer associated with the commit.
 124  */
 125 void free_commit_buffer(struct commit *);
 126
 127 struct tree *get_commit_tree(const struct commit *);
 128 struct object_id *get_commit_tree_oid(const struct commit *);
 129
 130 /*
 131  * Release memory related to a commit, including the parent list and
 132  * any cached object buffer.
 133  */
 134 void release_commit_memory(struct commit *c);
 135
 136 /*
 137  * Disassociate any cached object buffer from the commit, but do not free it.
 138  * The buffer (or NULL, if none) is returned.
 139  */
 140 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
 141
 142 /* Find beginning and length of commit subject. */
 143 int find_commit_subject(const char *commit_buffer, const char **subject);
 144
 145 struct commit_list *commit_list_insert(struct commit *item,
 146                                         struct commit_list **list);
 147 struct commit_list **commit_list_append(struct commit *commit,
 148                                         struct commit_list **next);
 149 unsigned commit_list_count(const struct commit_list *l);
 150 struct commit_list *commit_list_insert_by_date(struct commit *item,
 151                                     struct commit_list **list);
 152 void commit_list_sort_by_date(struct commit_list **list);
 153
 154 /* Shallow copy of the input list */
 155 struct commit_list *copy_commit_list(struct commit_list *list);
 156
 157 void free_commit_list(struct commit_list *list);
 158
 159 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 160
 161 extern int has_non_ascii(const char *text);
 162 extern const char *logmsg_reencode(const struct commit *commit,
 163                                    char **commit_encoding,
 164                                    const char *output_encoding);
 165 extern const char *skip_blank_lines(const char *msg);
 166
 167 /** Removes the first commit from a list sorted by date, and adds all
 168  * of its parents.
 169  **/
 170 struct commit *pop_most_recent_commit(struct commit_list **list,
 171                                       unsigned int mark);
 172
 173 struct commit *pop_commit(struct commit_list **stack);
 174
 175 void clear_commit_marks(struct commit *commit, unsigned int mark);
 176 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
 177
 178
 179 enum rev_sort_order {
 180         REV_SORT_IN_GRAPH_ORDER = 0,
 181         REV_SORT_BY_COMMIT_DATE,
 182         REV_SORT_BY_AUTHOR_DATE
 183 };
 184
 185 /*
 186  * Performs an in-place topological sort of list supplied.
 187  *
 188  *   invariant of resulting list is:
 189  *      a reachable from b => ord(b) < ord(a)
 190  *   sort_order further specifies:
 191  *   REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
 192  *                            chain together.
 193  *   REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
 194  */
 195 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
 196
 197 struct commit_graft {
 198         struct object_id oid;
 199         int nr_parent; /* < 0 if shallow commit */
 200         struct object_id parent[FLEX_ARRAY]; /* more */
 201 };
 202 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 203
 204 struct commit_graft *read_graft_line(struct strbuf *line);
 205 int register_commit_graft(struct repository *r, struct commit_graft *, int);
 206 void prepare_commit_graft(struct repository *r);
 207 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
 208
 209 struct commit *get_fork_point(const char *refname, struct commit *commit);
 210
 211 /* largest positive number a signed 32-bit integer can contain */
 212 #define INFINITE_DEPTH 0x7fffffff
 213
 214 struct oid_array;
 215 struct ref;
 216 extern int register_shallow(struct repository *r, const struct object_id *oid);
 217 extern int unregister_shallow(const struct object_id *oid);
 218 extern int for_each_commit_graft(each_commit_graft_fn, void *);
 219 extern int is_repository_shallow(struct repository *r);
 220 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 221                 int depth, int shallow_flag, int not_shallow_flag);
 222 extern struct commit_list *get_shallow_commits_by_rev_list(
 223                 int ac, const char **av, int shallow_flag, int not_shallow_flag);
 224 extern void set_alternate_shallow_file(struct repository *r, const char *path, int override);
 225 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
 226                                  const struct oid_array *extra);
 227 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
 228                                     const char **alternate_shallow_file,
 229                                     const struct oid_array *extra);
 230 extern const char *setup_temporary_shallow(const struct oid_array *extra);
 231 extern void advertise_shallow_grafts(int);
 232
 233 struct shallow_info {
 234         struct oid_array *shallow;
 235         int *ours, nr_ours;
 236         int *theirs, nr_theirs;
 237         struct oid_array *ref;
 238
 239         /* for receive-pack */
 240         uint32_t **used_shallow;
 241         int *need_reachability_test;
 242         int *reachable;
 243         int *shallow_ref;
 244         struct commit **commits;
 245         int nr_commits;
 246 };
 247
 248 extern void prepare_shallow_info(struct shallow_info *, struct oid_array *);
 249 extern void clear_shallow_info(struct shallow_info *);
 250 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
 251 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
 252                                            uint32_t **used,
 253                                            int *ref_status);
 254 extern int delayed_reachability_test(struct shallow_info *si, int c);
 255 #define PRUNE_SHOW_ONLY 1
 256 #define PRUNE_QUICK 2
 257 extern void prune_shallow(unsigned options);
 258 extern struct trace_key trace_shallow;
 259
 260 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 261 extern int run_add_interactive(const char *revision, const char *patch_mode,
 262                                const struct pathspec *pathspec);
 263
 264 struct commit_extra_header {
 265         struct commit_extra_header *next;
 266         char *key;
 267         char *value;
 268         size_t len;
 269 };
 270
 271 extern void append_merge_tag_headers(struct commit_list *parents,
 272                                      struct commit_extra_header ***tail);
 273
 274 extern int commit_tree(const char *msg, size_t msg_len,
 275                        const struct object_id *tree,
 276                        struct commit_list *parents, struct object_id *ret,
 277                        const char *author, const char *sign_commit);
 278
 279 extern int commit_tree_extended(const char *msg, size_t msg_len,
 280                                 const struct object_id *tree,
 281                                 struct commit_list *parents,
 282                                 struct object_id *ret, const char *author,
 283                                 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 /*
 291  * Search the commit object contents given by "msg" for the header "key".
 292  * Returns a pointer to the start of the header contents, or NULL. The length
 293  * of the header, up to the first newline, is returned via out_len.
 294  *
 295  * Note that some headers (like mergetag) may be multi-line. It is the caller's
 296  * responsibility to parse further in this case!
 297  */
 298 extern const char *find_commit_header(const char *msg, const char *key,
 299                                       size_t *out_len);
 300
 301 /* Find the end of the log message, the right place for a new trailer. */
 302 extern size_t ignore_non_trailer(const char *buf, size_t len);
 303
 304 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
 305                                  void *cb_data);
 306
 307 extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
 308
 309 struct merge_remote_desc {
 310         struct object *obj; /* the named object, could be a tag */
 311         char name[FLEX_ARRAY];
 312 };
 313 extern struct merge_remote_desc *merge_remote_util(struct commit *);
 314 extern void set_merge_remote_desc(struct commit *commit,
 315                                   const char *name, struct object *obj);
 316
 317 /*
 318  * Given "name" from the command line to merge, find the commit object
 319  * and return it, while storing merge_remote_desc in its ->util field,
 320  * to allow callers to tell if we are told to merge a tag.
 321  */
 322 struct commit *get_merge_parent(const char *name);
 323
 324 extern int parse_signed_commit(const struct commit *commit,
 325                                struct strbuf *message, struct strbuf *signature);
 326 extern int remove_signature(struct strbuf *buf);
 327
 328 /*
 329  * Check the signature of the given commit. The result of the check is stored
 330  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 331  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 332  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 333  * sig->signer and sig->key.
 334  */
 335 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
 336
 337 /* record author-date for each commit object */
 338 struct author_date_slab;
 339 void record_author_date(struct author_date_slab *author_date,
 340                         struct commit *commit);
 341
 342 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
 343
 344 /*
 345  * Verify a single commit with check_commit_signature() and die() if it is not
 346  * a good signature. This isn't really suitable for general use, but is a
 347  * helper to implement consistent logic for pull/merge --verify-signatures.
 348  */
 349 void verify_merge_signature(struct commit *commit, int verbose);
 350
 351 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
 352 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
 353
 354 LAST_ARG_MUST_BE_NULL
 355 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
 356
 357 #endif /* COMMIT_H */