commit.hon commit Documentation: more examples. (1e2ccd3)
   1#ifndef COMMIT_H
   2#define COMMIT_H
   3
   4#include "object.h"
   5#include "tree.h"
   6
   7struct commit_list {
   8        struct commit *item;
   9        struct commit_list *next;
  10};
  11
  12struct commit {
  13        struct object object;
  14        unsigned long date;
  15        struct commit_list *parents;
  16        struct tree *tree;
  17        char *buffer;
  18};
  19
  20extern int save_commit_buffer;
  21extern const char *commit_type;
  22
  23struct commit *lookup_commit(const unsigned char *sha1);
  24struct commit *lookup_commit_reference(const unsigned char *sha1);
  25struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
  26                                              int quiet);
  27
  28int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
  29
  30int parse_commit(struct commit *item);
  31
  32struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
  33struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
  34
  35void free_commit_list(struct commit_list *list);
  36
  37void sort_by_date(struct commit_list **list);
  38
  39/* Commit formats */
  40enum cmit_fmt {
  41        CMIT_FMT_RAW,
  42        CMIT_FMT_MEDIUM,
  43        CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
  44        CMIT_FMT_SHORT,
  45        CMIT_FMT_FULL,
  46        CMIT_FMT_FULLER,
  47        CMIT_FMT_ONELINE,
  48};
  49
  50extern enum cmit_fmt get_commit_format(const char *arg);
  51extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const char *msg, unsigned long len, char *buf, unsigned long space);
  52
  53/** Removes the first commit from a list sorted by date, and adds all
  54 * of its parents.
  55 **/
  56struct commit *pop_most_recent_commit(struct commit_list **list, 
  57                                      unsigned int mark);
  58
  59struct commit *pop_commit(struct commit_list **stack);
  60
  61int count_parents(struct commit * commit);
  62
  63/*
  64 * Performs an in-place topological sort of list supplied.
  65 *
  66 * Pre-conditions:
  67 *   all commits in input list and all parents of those
  68 *   commits must have object.util == NULL
  69 *        
  70 * Post-conditions: 
  71 *   invariant of resulting list is:
  72 *      a reachable from b => ord(b) < ord(a)
  73 */
  74void sort_in_topological_order(struct commit_list ** list);
  75#endif /* COMMIT_H */