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