commit.hon commit Doc fix for git-reflog: mention @{...} syntax, and <ref> in synopsys. (97e92e2)
   1#ifndef COMMIT_H
   2#define COMMIT_H
   3
   4#include "object.h"
   5#include "tree.h"
   6#include "decorate.h"
   7
   8struct commit_list {
   9        struct commit *item;
  10        struct commit_list *next;
  11};
  12
  13struct commit {
  14        struct object object;
  15        void *util;
  16        unsigned long date;
  17        struct commit_list *parents;
  18        struct tree *tree;
  19        char *buffer;
  20};
  21
  22extern int save_commit_buffer;
  23extern const char *commit_type;
  24
  25/* While we can decorate any object with a name, it's only used for commits.. */
  26extern struct decoration name_decoration;
  27struct name_decoration {
  28        struct name_decoration *next;
  29        char name[1];
  30};
  31
  32struct commit *lookup_commit(const unsigned char *sha1);
  33struct commit *lookup_commit_reference(const unsigned char *sha1);
  34struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  35                                              int quiet);
  36
  37int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
  38
  39int parse_commit(struct commit *item);
  40
  41struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  42struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  43
  44void free_commit_list(struct commit_list *list);
  45
  46void sort_by_date(struct commit_list **list);
  47
  48/* Commit formats */
  49enum cmit_fmt {
  50        CMIT_FMT_RAW,
  51        CMIT_FMT_MEDIUM,
  52        CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  53        CMIT_FMT_SHORT,
  54        CMIT_FMT_FULL,
  55        CMIT_FMT_FULLER,
  56        CMIT_FMT_ONELINE,
  57        CMIT_FMT_EMAIL,
  58        CMIT_FMT_USERFORMAT,
  59
  60        CMIT_FMT_UNSPECIFIED,
  61};
  62
  63extern enum cmit_fmt get_commit_format(const char *arg);
  64extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const struct commit *, unsigned long len, char **buf_p, unsigned long *space_p, int abbrev, const char *subject, const char *after_subject, enum date_mode dmode);
  65
  66/** Removes the first commit from a list sorted by date, and adds all
  67 * of its parents.
  68 **/
  69struct commit *pop_most_recent_commit(struct commit_list **list,
  70                                      unsigned int mark);
  71
  72struct commit *pop_commit(struct commit_list **stack);
  73
  74void clear_commit_marks(struct commit *commit, unsigned int mark);
  75
  76/*
  77 * Performs an in-place topological sort of list supplied.
  78 *
  79 * Pre-conditions for sort_in_topological_order:
  80 *   all commits in input list and all parents of those
  81 *   commits must have object.util == NULL
  82 *
  83 * Pre-conditions for sort_in_topological_order_fn:
  84 *   all commits in input list and all parents of those
  85 *   commits must have getter(commit) == NULL
  86 *
  87 * Post-conditions:
  88 *   invariant of resulting list is:
  89 *      a reachable from b => ord(b) < ord(a)
  90 *   in addition, when lifo == 0, commits on parallel tracks are
  91 *   sorted in the dates order.
  92 */
  93
  94typedef void (*topo_sort_set_fn_t)(struct commit*, void *data);
  95typedef void* (*topo_sort_get_fn_t)(struct commit*);
  96
  97void topo_sort_default_setter(struct commit *c, void *data);
  98void *topo_sort_default_getter(struct commit *c);
  99
 100void sort_in_topological_order(struct commit_list ** list, int lifo);
 101void sort_in_topological_order_fn(struct commit_list ** list, int lifo,
 102                                  topo_sort_set_fn_t setter,
 103                                  topo_sort_get_fn_t getter);
 104
 105struct commit_graft {
 106        unsigned char sha1[20];
 107        int nr_parent; /* < 0 if shallow commit */
 108        unsigned char parent[FLEX_ARRAY][20]; /* more */
 109};
 110
 111struct commit_graft *read_graft_line(char *buf, int len);
 112int register_commit_graft(struct commit_graft *, int);
 113int read_graft_file(const char *graft_file);
 114
 115extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
 116
 117extern int register_shallow(const unsigned char *sha1);
 118extern int unregister_shallow(const unsigned char *sha1);
 119extern int write_shallow_commits(int fd, int use_pack_protocol);
 120extern int is_repository_shallow(void);
 121extern struct commit_list *get_shallow_commits(struct object_array *heads,
 122                int depth, int shallow_flag, int not_shallow_flag);
 123
 124int in_merge_bases(struct commit *, struct commit **, int);
 125#endif /* COMMIT_H */