[thirdparty/git.git] / commit.h

#ifndef COMMIT_H
#define COMMIT_H

#include "object.h"
#include "tree.h"
#include "strbuf.h"
#include "decorate.h"

struct commit_list {
	struct commit *item;
	struct commit_list *next;
};

struct commit {
	struct object object;
	void *util;
	unsigned int indegree;
	unsigned long date;
	struct commit_list *parents;
	struct tree *tree;
	char *buffer;
};

extern int save_commit_buffer;
extern const char *commit_type;

/* While we can decorate any object with a name, it's only used for commits.. */
extern struct decoration name_decoration;
struct name_decoration {
	struct name_decoration *next;
	char name[1];
};

struct commit *lookup_commit(const unsigned char *sha1);
struct commit *lookup_commit_reference(const unsigned char *sha1);
struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
					      int quiet);

int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);

int parse_commit(struct commit *item);

struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);

void free_commit_list(struct commit_list *list);

void sort_by_date(struct commit_list **list);

/* Commit formats */
enum cmit_fmt {
	CMIT_FMT_RAW,
	CMIT_FMT_MEDIUM,
	CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
	CMIT_FMT_SHORT,
	CMIT_FMT_FULL,
	CMIT_FMT_FULLER,
	CMIT_FMT_ONELINE,
	CMIT_FMT_EMAIL,
	CMIT_FMT_USERFORMAT,

	CMIT_FMT_UNSPECIFIED,
};

extern int non_ascii(int);
struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
extern void get_commit_format(const char *arg, struct rev_info *);
extern void format_commit_message(const struct commit *commit,
                                  const void *format, struct strbuf *sb);
extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
                                struct strbuf *,
                                int abbrev, const char *subject,
                                const char *after_subject, enum date_mode,
				int need_8bit_cte);
void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
		   const char *line, enum date_mode dmode,
		   const char *encoding);
void pp_title_line(enum cmit_fmt fmt,
		   const char **msg_p,
		   struct strbuf *sb,
		   const char *subject,
		   const char *after_subject,
		   const char *encoding,
		   int need_8bit_cte);
void pp_remainder(enum cmit_fmt fmt,
		  const char **msg_p,
		  struct strbuf *sb,
		  int indent);


/** Removes the first commit from a list sorted by date, and adds all
 * of its parents.
 **/
struct commit *pop_most_recent_commit(struct commit_list **list,
				      unsigned int mark);

struct commit *pop_commit(struct commit_list **stack);

void clear_commit_marks(struct commit *commit, unsigned int mark);

/*
 * Performs an in-place topological sort of list supplied.
 *
 *   invariant of resulting list is:
 *      a reachable from b => ord(b) < ord(a)
 *   in addition, when lifo == 0, commits on parallel tracks are
 *   sorted in the dates order.
 */
void sort_in_topological_order(struct commit_list ** list, int lifo);

struct commit_graft {
	unsigned char sha1[20];
	int nr_parent; /* < 0 if shallow commit */
	unsigned char parent[FLEX_ARRAY][20]; /* more */
};

struct commit_graft *read_graft_line(char *buf, int len);
int register_commit_graft(struct commit_graft *, int);
int read_graft_file(const char *graft_file);
struct commit_graft *lookup_commit_graft(const unsigned char *sha1);

extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);

extern int register_shallow(const unsigned char *sha1);
extern int unregister_shallow(const unsigned char *sha1);
extern int write_shallow_commits(int fd, int use_pack_protocol);
extern int is_repository_shallow(void);
extern struct commit_list *get_shallow_commits(struct object_array *heads,
		int depth, int shallow_flag, int not_shallow_flag);

int in_merge_bases(struct commit *, struct commit **, int);

extern int interactive_add(int argc, const char **argv, const char *prefix);
extern int rerere(void);

static inline int single_parent(struct commit *commit)
{
	return commit->parents && !commit->parents->next;
}

#endif /* COMMIT_H */
Commit	Line	Data
	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
	9	struct commit_list {
	10	struct commit *item;
	11	struct commit_list *next;
	12	};
	13
	14	struct commit {
	15	struct object object;
	16	void *util;
	17	unsigned int indegree;
	18	unsigned long date;
	19	struct commit_list *parents;
	20	struct tree *tree;
	21	char *buffer;
	22	};
	23
	24	extern int save_commit_buffer;
	25	extern const char *commit_type;
	26
	27	/* While we can decorate any object with a name, it's only used for commits.. */
	28	extern struct decoration name_decoration;
	29	struct name_decoration {
	30	struct name_decoration *next;
	31	char name[1];
	32	};
	33
	34	struct commit lookup_commit(const unsigned char sha1);
	35	struct commit lookup_commit_reference(const unsigned char sha1);
	36	struct commit lookup_commit_reference_gently(const unsigned char sha1,
	37	int quiet);
	38
	39	int parse_commit_buffer(struct commit item, void buffer, unsigned long size);
	40
	41	int parse_commit(struct commit *item);
	42
	43	struct commit_list * commit_list_insert(struct commit item, struct commit_list *list_p);
	44	struct commit_list * insert_by_date(struct commit item, struct commit_list *list);
	45
	46	void free_commit_list(struct commit_list *list);
	47
	48	void sort_by_date(struct commit_list **list);
	49
	50	/* Commit formats */
	51	enum cmit_fmt {
	52	CMIT_FMT_RAW,
	53	CMIT_FMT_MEDIUM,
	54	CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
	55	CMIT_FMT_SHORT,
	56	CMIT_FMT_FULL,
	57	CMIT_FMT_FULLER,
	58	CMIT_FMT_ONELINE,
	59	CMIT_FMT_EMAIL,
	60	CMIT_FMT_USERFORMAT,
	61
	62	CMIT_FMT_UNSPECIFIED,
	63	};
	64
	65	extern int non_ascii(int);
	66	struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
	67	extern void get_commit_format(const char arg, struct rev_info );
	68	extern void format_commit_message(const struct commit *commit,
	69	const void format, struct strbuf sb);
	70	extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
	71	struct strbuf *,
	72	int abbrev, const char *subject,
	73	const char *after_subject, enum date_mode,
	74	int need_8bit_cte);
	75	void pp_user_info(const char what, enum cmit_fmt fmt, struct strbuf sb,
	76	const char *line, enum date_mode dmode,
	77	const char *encoding);
	78	void pp_title_line(enum cmit_fmt fmt,
	79	const char **msg_p,
	80	struct strbuf *sb,
	81	const char *subject,
	82	const char *after_subject,
	83	const char *encoding,
	84	int need_8bit_cte);
	85	void pp_remainder(enum cmit_fmt fmt,
	86	const char **msg_p,
	87	struct strbuf *sb,
	88	int indent);
	89
	90
	91	/** Removes the first commit from a list sorted by date, and adds all
	92	* of its parents.
	93	**/
	94	struct commit pop_most_recent_commit(struct commit_list *list,
	95	unsigned int mark);
	96
	97	struct commit pop_commit(struct commit_list *stack);
	98
	99	void clear_commit_marks(struct commit *commit, unsigned int mark);
	100
	101	/*
	102	* Performs an in-place topological sort of list supplied.
	103	*
	104	* invariant of resulting list is:
	105	* a reachable from b => ord(b) < ord(a)
	106	* in addition, when lifo == 0, commits on parallel tracks are
	107	* sorted in the dates order.
	108	*/
	109	void sort_in_topological_order(struct commit_list ** list, int lifo);
	110
	111	struct commit_graft {
	112	unsigned char sha1[20];
	113	int nr_parent; /* < 0 if shallow commit */
	114	unsigned char parent[FLEX_ARRAY][20]; /* more */
	115	};
	116
	117	struct commit_graft read_graft_line(char buf, int len);
	118	int register_commit_graft(struct commit_graft *, int);
	119	int read_graft_file(const char *graft_file);
	120	struct commit_graft lookup_commit_graft(const unsigned char sha1);
	121
	122	extern struct commit_list get_merge_bases(struct commit rev1, struct commit *rev2, int cleanup);
	123
	124	extern int register_shallow(const unsigned char *sha1);
	125	extern int unregister_shallow(const unsigned char *sha1);
	126	extern int write_shallow_commits(int fd, int use_pack_protocol);
	127	extern int is_repository_shallow(void);
	128	extern struct commit_list get_shallow_commits(struct object_array heads,
	129	int depth, int shallow_flag, int not_shallow_flag);
	130
	131	int in_merge_bases(struct commit , struct commit *, int);
	132
	133	extern int interactive_add(int argc, const char *argv, const char prefix);
	134	extern int rerere(void);
	135
	136	static inline int single_parent(struct commit *commit)
	137	{
	138	return commit->parents && !commit->parents->next;
	139	}
	140
	141	#endif /* COMMIT_H */