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