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(const struct object_id *oid);
  67 struct commit *lookup_commit_reference(const struct object_id *oid);
  68 #define lookup_commit_reference_gently(r, o, q) \
  69                 lookup_commit_reference_gently_##r(o, q)
  70 struct commit *lookup_commit_reference_gently_the_repository(
  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 commit *item, const void *buffer, unsigned long size, int check_graph);
  83 int parse_commit_gently(struct commit *item, int quiet_on_missing);
  84 static inline int parse_commit(struct commit *item)
  85 {
  86         return parse_commit_gently(item, 0);
  87 }
  88 void parse_commit_or_die(struct commit *item);
  89
  90 /*
  91  * Associate an object buffer with the commit. The ownership of the
  92  * memory is handed over to the commit, and must be free()-able.
  93  */
  94 void set_commit_buffer(struct commit *, void *buffer, unsigned long size);
  95
  96 /*
  97  * Get any cached object buffer associated with the commit. Returns NULL
  98  * if none. The resulting memory should not be freed.
  99  */
 100 const void *get_cached_commit_buffer(const struct commit *, unsigned long *size);
 101
 102 /*
 103  * Get the commit's object contents, either from cache or by reading the object
 104  * from disk. The resulting memory should not be modified, and must be given
 105  * to unuse_commit_buffer when the caller is done.
 106  */
 107 const void *get_commit_buffer(const struct commit *, unsigned long *size);
 108
 109 /*
 110  * Tell the commit subsytem that we are done with a particular commit buffer.
 111  * The commit and buffer should be the input and return value, respectively,
 112  * from an earlier call to get_commit_buffer.  The buffer may or may not be
 113  * freed by this call; callers should not access the memory afterwards.
 114  */
 115 void unuse_commit_buffer(const struct commit *, const void *buffer);
 116
 117 /*
 118  * Free any cached object buffer associated with the commit.
 119  */
 120 void free_commit_buffer(struct commit *);
 121
 122 struct tree *get_commit_tree(const struct commit *);
 123 struct object_id *get_commit_tree_oid(const struct commit *);
 124
 125 /*
 126  * Release memory related to a commit, including the parent list and
 127  * any cached object buffer.
 128  */
 129 void release_commit_memory(struct commit *c);
 130
 131 /*
 132  * Disassociate any cached object buffer from the commit, but do not free it.
 133  * The buffer (or NULL, if none) is returned.
 134  */
 135 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
 136
 137 /* Find beginning and length of commit subject. */
 138 int find_commit_subject(const char *commit_buffer, const char **subject);
 139
 140 struct commit_list *commit_list_insert(struct commit *item,
 141                                         struct commit_list **list);
 142 struct commit_list **commit_list_append(struct commit *commit,
 143                                         struct commit_list **next);
 144 unsigned commit_list_count(const struct commit_list *l);
 145 struct commit_list *commit_list_insert_by_date(struct commit *item,
 146                                     struct commit_list **list);
 147 void commit_list_sort_by_date(struct commit_list **list);
 148
 149 /* Shallow copy of the input list */
 150 struct commit_list *copy_commit_list(struct commit_list *list);
 151
 152 void free_commit_list(struct commit_list *list);
 153
 154 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 155
 156 extern int has_non_ascii(const char *text);
 157 extern const char *logmsg_reencode(const struct commit *commit,
 158                                    char **commit_encoding,
 159                                    const char *output_encoding);
 160 extern const char *skip_blank_lines(const char *msg);
 161
 162 /** Removes the first commit from a list sorted by date, and adds all
 163  * of its parents.
 164  **/
 165 struct commit *pop_most_recent_commit(struct commit_list **list,
 166                                       unsigned int mark);
 167
 168 struct commit *pop_commit(struct commit_list **stack);
 169
 170 void clear_commit_marks(struct commit *commit, unsigned int mark);
 171 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
 172
 173
 174 enum rev_sort_order {
 175         REV_SORT_IN_GRAPH_ORDER = 0,
 176         REV_SORT_BY_COMMIT_DATE,
 177         REV_SORT_BY_AUTHOR_DATE
 178 };
 179
 180 /*
 181  * Performs an in-place topological sort of list supplied.
 182  *
 183  *   invariant of resulting list is:
 184  *      a reachable from b => ord(b) < ord(a)
 185  *   sort_order further specifies:
 186  *   REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
 187  *                            chain together.
 188  *   REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
 189  */
 190 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
 191
 192 struct commit_graft {
 193         struct object_id oid;
 194         int nr_parent; /* < 0 if shallow commit */
 195         struct object_id parent[FLEX_ARRAY]; /* more */
 196 };
 197 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 198
 199 struct commit_graft *read_graft_line(struct strbuf *line);
 200 int register_commit_graft(struct repository *r, struct commit_graft *, int);
 201 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
 202
 203 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2);
 204 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos);
 205 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
 206
 207 /* To be used only when object flags after this call no longer matter */
 208 extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos);
 209
 210 /* largest positive number a signed 32-bit integer can contain */
 211 #define INFINITE_DEPTH 0x7fffffff
 212
 213 struct oid_array;
 214 struct ref;
 215 extern int register_shallow(struct repository *r, const struct object_id *oid);
 216 extern int unregister_shallow(const struct object_id *oid);
 217 extern int for_each_commit_graft(each_commit_graft_fn, void *);
 218 extern int is_repository_shallow(struct repository *r);
 219 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 220                 int depth, int shallow_flag, int not_shallow_flag);
 221 extern struct commit_list *get_shallow_commits_by_rev_list(
 222                 int ac, const char **av, int shallow_flag, int not_shallow_flag);
 223 extern void set_alternate_shallow_file(struct repository *r, const char *path, int override);
 224 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
 225                                  const struct oid_array *extra);
 226 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
 227                                     const char **alternate_shallow_file,
 228                                     const struct oid_array *extra);
 229 extern const char *setup_temporary_shallow(const struct oid_array *extra);
 230 extern void advertise_shallow_grafts(int);
 231
 232 struct shallow_info {
 233         struct oid_array *shallow;
 234         int *ours, nr_ours;
 235         int *theirs, nr_theirs;
 236         struct oid_array *ref;
 237
 238         /* for receive-pack */
 239         uint32_t **used_shallow;
 240         int *need_reachability_test;
 241         int *reachable;
 242         int *shallow_ref;
 243         struct commit **commits;
 244         int nr_commits;
 245 };
 246
 247 extern void prepare_shallow_info(struct shallow_info *, struct oid_array *);
 248 extern void clear_shallow_info(struct shallow_info *);
 249 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
 250 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
 251                                            uint32_t **used,
 252                                            int *ref_status);
 253 extern int delayed_reachability_test(struct shallow_info *si, int c);
 254 extern void prune_shallow(int show_only);
 255 extern struct trace_key trace_shallow;
 256
 257 int is_descendant_of(struct commit *, struct commit_list *);
 258 int in_merge_bases(struct commit *, struct commit *);
 259 int in_merge_bases_many(struct commit *, int, struct commit **);
 260
 261 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 262 extern int run_add_interactive(const char *revision, const char *patch_mode,
 263                                const struct pathspec *pathspec);
 264
 265 /*
 266  * Takes a list of commits and returns a new list where those
 267  * have been removed that can be reached from other commits in
 268  * the list. It is useful for, e.g., reducing the commits
 269  * randomly thrown at the git-merge command and removing
 270  * redundant commits that the user shouldn't have given to it.
 271  *
 272  * This function destroys the STALE bit of the commit objects'
 273  * flags.
 274  */
 275 extern struct commit_list *reduce_heads(struct commit_list *heads);
 276
 277 /*
 278  * Like `reduce_heads()`, except it replaces the list. Use this
 279  * instead of `foo = reduce_heads(foo);` to avoid memory leaks.
 280  */
 281 extern void reduce_heads_replace(struct commit_list **heads);
 282
 283 struct commit_extra_header {
 284         struct commit_extra_header *next;
 285         char *key;
 286         char *value;
 287         size_t len;
 288 };
 289
 290 extern void append_merge_tag_headers(struct commit_list *parents,
 291                                      struct commit_extra_header ***tail);
 292
 293 extern int commit_tree(const char *msg, size_t msg_len,
 294                        const struct object_id *tree,
 295                        struct commit_list *parents, struct object_id *ret,
 296                        const char *author, const char *sign_commit);
 297
 298 extern int commit_tree_extended(const char *msg, size_t msg_len,
 299                                 const struct object_id *tree,
 300                                 struct commit_list *parents,
 301                                 struct object_id *ret, const char *author,
 302                                 const char *sign_commit,
 303                                 struct commit_extra_header *);
 304
 305 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 306
 307 extern void free_commit_extra_headers(struct commit_extra_header *extra);
 308
 309 /*
 310  * Search the commit object contents given by "msg" for the header "key".
 311  * Returns a pointer to the start of the header contents, or NULL. The length
 312  * of the header, up to the first newline, is returned via out_len.
 313  *
 314  * Note that some headers (like mergetag) may be multi-line. It is the caller's
 315  * responsibility to parse further in this case!
 316  */
 317 extern const char *find_commit_header(const char *msg, const char *key,
 318                                       size_t *out_len);
 319
 320 /* Find the end of the log message, the right place for a new trailer. */
 321 extern int ignore_non_trailer(const char *buf, size_t len);
 322
 323 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
 324                                  void *cb_data);
 325
 326 extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
 327
 328 struct merge_remote_desc {
 329         struct object *obj; /* the named object, could be a tag */
 330         char name[FLEX_ARRAY];
 331 };
 332 extern struct merge_remote_desc *merge_remote_util(struct commit *);
 333 extern void set_merge_remote_desc(struct commit *commit,
 334                                   const char *name, struct object *obj);
 335
 336 /*
 337  * Given "name" from the command line to merge, find the commit object
 338  * and return it, while storing merge_remote_desc in its ->util field,
 339  * to allow callers to tell if we are told to merge a tag.
 340  */
 341 struct commit *get_merge_parent(const char *name);
 342
 343 extern int parse_signed_commit(const struct commit *commit,
 344                                struct strbuf *message, struct strbuf *signature);
 345 extern int remove_signature(struct strbuf *buf);
 346
 347 /*
 348  * Check the signature of the given commit. The result of the check is stored
 349  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 350  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 351  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 352  * sig->signer and sig->key.
 353  */
 354 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
 355
 356 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
 357 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
 358
 359 LAST_ARG_MUST_BE_NULL
 360 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
 361
 362 #endif /* COMMIT_H */