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