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