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