[thirdparty/git.git] / revision.h

#ifndef REVISION_H
#define REVISION_H

#include "parse-options.h"
#include "grep.h"
#include "notes.h"
#include "pretty.h"
#include "diff.h"
#include "commit-slab-decl.h"

/* Remember to update object flag allocation in object.h */
#define SEEN		(1u<<0)
#define UNINTERESTING   (1u<<1)
#define TREESAME	(1u<<2)
#define SHOWN		(1u<<3)
#define TMP_MARK	(1u<<4) /* for isolated cases; clean after use */
#define BOUNDARY	(1u<<5)
#define CHILD_SHOWN	(1u<<6)
#define ADDED		(1u<<7)	/* Parents already parsed and added? */
#define SYMMETRIC_LEFT	(1u<<8)
#define PATCHSAME	(1u<<9)
#define BOTTOM		(1u<<10)
#define USER_GIVEN	(1u<<25) /* given directly by the user */
#define TRACK_LINEAR	(1u<<26)
#define ALL_REV_FLAGS	(((1u<<11)-1) | USER_GIVEN | TRACK_LINEAR)

#define DECORATE_SHORT_REFS	1
#define DECORATE_FULL_REFS	2

struct rev_info;
struct log_info;
struct string_list;
struct saved_parents;
define_shared_commit_slab(revision_sources, char *);

struct rev_cmdline_info {
	unsigned int nr;
	unsigned int alloc;
	struct rev_cmdline_entry {
		struct object *item;
		const char *name;
		enum {
			REV_CMD_REF,
			REV_CMD_PARENTS_ONLY,
			REV_CMD_LEFT,
			REV_CMD_RIGHT,
			REV_CMD_MERGE_BASE,
			REV_CMD_REV
		} whence;
		unsigned flags;
	} *rev;
};

#define REVISION_WALK_WALK 0
#define REVISION_WALK_NO_WALK_SORTED 1
#define REVISION_WALK_NO_WALK_UNSORTED 2

struct rev_info {
	/* Starting list */
	struct commit_list *commits;
	struct object_array pending;

	/* Parents of shown commits */
	struct object_array boundary_commits;

	/* The end-points specified by the end user */
	struct rev_cmdline_info cmdline;

	/* excluding from --branches, --refs, etc. expansion */
	struct string_list *ref_excludes;

	/* Basic information */
	const char *prefix;
	const char *def;
	struct pathspec prune_data;

	/*
	 * Whether the arguments parsed by setup_revisions() included any
	 * "input" revisions that might still have yielded an empty pending
	 * list (e.g., patterns like "--all" or "--glob").
	 */
	int rev_input_given;

	/* topo-sort */
	enum rev_sort_order sort_order;

	unsigned int early_output;

	unsigned int	ignore_missing:1,
			ignore_missing_links:1;

	/* Traversal flags */
	unsigned int	dense:1,
			prune:1,
			no_walk:2,
			remove_empty_trees:1,
			simplify_history:1,
			topo_order:1,
			simplify_merges:1,
			simplify_by_decoration:1,
			single_worktree:1,
			tag_objects:1,
			tree_objects:1,
			blob_objects:1,
			verify_objects:1,
			edge_hint:1,
			edge_hint_aggressive:1,
			limited:1,
			unpacked:1,
			boundary:2,
			count:1,
			left_right:1,
			left_only:1,
			right_only:1,
			rewrite_parents:1,
			print_parents:1,
			show_decorations:1,
			reverse:1,
			reverse_output_stage:1,
			cherry_pick:1,
			cherry_mark:1,
			bisect:1,
			ancestry_path:1,
			first_parent_only:1,
			line_level_traverse:1,
			tree_blobs_in_commit_order:1,

			/* for internal use only */
			exclude_promisor_objects:1;

	/* Diff flags */
	unsigned int	diff:1,
			full_diff:1,
			show_root_diff:1,
			no_commit_id:1,
			verbose_header:1,
			ignore_merges:1,
			combine_merges:1,
			dense_combined_merges:1,
			always_show_header:1;

	/* Format info */
	unsigned int	shown_one:1,
			shown_dashes:1,
			show_merge:1,
			show_notes:1,
			show_notes_given:1,
			show_signature:1,
			pretty_given:1,
			abbrev_commit:1,
			abbrev_commit_given:1,
			zero_commit:1,
			use_terminator:1,
			missing_newline:1,
			date_mode_explicit:1,
			preserve_subject:1;
	unsigned int	disable_stdin:1;
	/* --show-linear-break */
	unsigned int	track_linear:1,
			track_first_time:1,
			linear:1;

	struct date_mode date_mode;
	int		expand_tabs_in_log; /* unset if negative */
	int		expand_tabs_in_log_default;

	unsigned int	abbrev;
	enum cmit_fmt	commit_format;
	struct log_info *loginfo;
	int		nr, total;
	const char	*mime_boundary;
	const char	*patch_suffix;
	int		numbered_files;
	int		reroll_count;
	char		*message_id;
	struct ident_split from_ident;
	struct string_list *ref_message_ids;
	int		add_signoff;
	const char	*extra_headers;
	const char	*log_reencode;
	const char	*subject_prefix;
	int		no_inline;
	int		show_log_size;
	struct string_list *mailmap;

	/* Filter by commit log message */
	struct grep_opt	grep_filter;
	/* Negate the match of grep_filter */
	int invert_grep;

	/* Display history graph */
	struct git_graph *graph;

	/* special limits */
	int skip_count;
	int max_count;
	timestamp_t max_age;
	timestamp_t min_age;
	int min_parents;
	int max_parents;
	int (*include_check)(struct commit *, void *);
	void *include_check_data;

	/* diff info for patches and for paths limiting */
	struct diff_options diffopt;
	struct diff_options pruning;

	struct reflog_walk_info *reflog_info;
	struct decoration children;
	struct decoration merge_simplification;
	struct decoration treesame;

	/* notes-specific options: which refs to show */
	struct display_notes_opt notes_opt;

	/* commit counts */
	int count_left;
	int count_right;
	int count_same;

	/* line level range that we are chasing */
	struct decoration line_log_data;

	/* copies of the parent lists, for --full-diff display */
	struct saved_parents *saved_parents_slab;

	struct commit_list *previous_parents;
	const char *break_bar;

	struct revision_sources *sources;
};

extern int ref_excluded(struct string_list *, const char *path);
void clear_ref_exclusion(struct string_list **);
void add_ref_exclusion(struct string_list **, const char *exclude);


#define REV_TREE_SAME		0
#define REV_TREE_NEW		1	/* Only new files */
#define REV_TREE_OLD		2	/* Only files removed */
#define REV_TREE_DIFFERENT	3	/* Mixed changes */

/* revision.c */
typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
extern volatile show_early_output_fn_t show_early_output;

struct setup_revision_opt {
	const char *def;
	void (*tweak)(struct rev_info *, struct setup_revision_opt *);
	const char *submodule;
	int assume_dashdash;
	unsigned revarg_opt;
};

extern void init_revisions(struct rev_info *revs, const char *prefix);
extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
			   struct setup_revision_opt *);
extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
			       const struct option *options,
			       const char * const usagestr[]);
#define REVARG_CANNOT_BE_FILENAME 01
#define REVARG_COMMITTISH 02
extern int handle_revision_arg(const char *arg, struct rev_info *revs,
			       int flags, unsigned revarg_opt);

extern void reset_revision_walk(void);
extern int prepare_revision_walk(struct rev_info *revs);
extern struct commit *get_revision(struct rev_info *revs);
extern char *get_revision_mark(const struct rev_info *revs,
			       const struct commit *commit);
extern void put_revision_mark(const struct rev_info *revs,
			      const struct commit *commit);

extern void mark_parents_uninteresting(struct commit *commit);
extern void mark_tree_uninteresting(struct tree *tree);

extern void show_object_with_name(FILE *, struct object *, const char *);

extern void add_pending_object(struct rev_info *revs,
			       struct object *obj, const char *name);
extern void add_pending_oid(struct rev_info *revs,
			    const char *name, const struct object_id *oid,
			    unsigned int flags);

extern void add_head_to_pending(struct rev_info *);
extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);

enum commit_action {
	commit_ignore,
	commit_show,
	commit_error
};

extern enum commit_action get_commit_action(struct rev_info *revs,
					    struct commit *commit);
extern enum commit_action simplify_commit(struct rev_info *revs,
					  struct commit *commit);

enum rewrite_result {
	rewrite_one_ok,
	rewrite_one_noparents,
	rewrite_one_error
};

typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);

extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
	rewrite_parent_fn_t rewrite_parent);

/*
 * The log machinery saves the original parent list so that
 * get_saved_parents() can later tell what the real parents of the
 * commits are, when commit->parents has been modified by history
 * simpification.
 *
 * get_saved_parents() will transparently return commit->parents if
 * history simplification is off.
 */
extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);

#endif
Commit	Line	Data
ae563542 LT	1	#ifndef REVISION_H
	2	#define REVISION_H
	3
6b61ec05	4	#include "parse-options.h"
0843acfd	5	#include "grep.h"
894a9d33	6	#include "notes.h"
cf394719	7	#include "pretty.h"
19ecb564	8	#include "diff.h"
87be2523	9	#include "commit-slab-decl.h"
6b61ec05	10
208acbfb	11	/* Remember to update object flag allocation in object.h */
ae563542 LT	12	#define SEEN (1u<<0)
ae563542 LT	13	#define UNINTERESTING (1u<<1)
7dc0fe3b	14	#define TREESAME (1u<<2)
765ac8ec	15	#define SHOWN (1u<<3)
7ae0b0cb	16	#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
384e99a4	17	#define BOUNDARY (1u<<5)
2b064697	18	#define CHILD_SHOWN (1u<<6)
1b65a5aa	19	#define ADDED (1u<<7) /* Parents already parsed and added? */
577ed5c2	20	#define SYMMETRIC_LEFT (1u<<8)
adbbb31e	21	#define PATCHSAME (1u<<9)
7f34a46f	22	#define BOTTOM (1u<<10)
a0c9016a	23	#define USER_GIVEN (1u<<25) /* given directly by the user */
1b32dece	24	#define TRACK_LINEAR (1u<<26)
a0c9016a	25	#define ALL_REV_FLAGS (((1u<<11)-1) \| USER_GIVEN \| TRACK_LINEAR)
ae563542	26
33e7018c LH	27	#define DECORATE_SHORT_REFS 1
	28	#define DECORATE_FULL_REFS 2
	29
8efdc326	30	struct rev_info;
91539833	31	struct log_info;
894a9d33	32	struct string_list;
53d00b39	33	struct saved_parents;
87be2523	34	define_shared_commit_slab(revision_sources, char *);
8efdc326	35
281eee47 JH	36	struct rev_cmdline_info {
	37	unsigned int nr;
	38	unsigned int alloc;
	39	struct rev_cmdline_entry {
	40	struct object *item;
	41	const char *name;
	42	enum {
	43	REV_CMD_REF,
	44	REV_CMD_PARENTS_ONLY,
	45	REV_CMD_LEFT,
	46	REV_CMD_RIGHT,
a765499a	47	REV_CMD_MERGE_BASE,
281eee47 JH	48	REV_CMD_REV
	49	} whence;
	50	unsigned flags;
	51	} *rev;
	52	};
	53
ca92e59e MZ	54	#define REVISION_WALK_WALK 0
	55	#define REVISION_WALK_NO_WALK_SORTED 1
	56	#define REVISION_WALK_NO_WALK_UNSORTED 2
	57
ae563542 LT	58	struct rev_info {
	59	/* Starting list */
	60	struct commit_list *commits;
1f1e895f	61	struct object_array pending;
ae563542	62
86ab4906 JH	63	/* Parents of shown commits */
	64	struct object_array boundary_commits;
	65
281eee47 JH	66	/* The end-points specified by the end user */
	67	struct rev_cmdline_info cmdline;
	68
e7b432c5 JH	69	/* excluding from --branches, --refs, etc. expansion */
	70	struct string_list *ref_excludes;
	71
ae563542 LT	72	/* Basic information */
ae563542 LT	73	const char *prefix;
02e54220	74	const char *def;
afe069d1	75	struct pathspec prune_data;
08f704f2	76
7ba82629 JK	77	/*
	78	* Whether the arguments parsed by setup_revisions() included any
	79	* "input" revisions that might still have yielded an empty pending
	80	* list (e.g., patterns like "--all" or "--glob").
	81	*/
	82	int rev_input_given;
	83
08f704f2 JH	84	/* topo-sort */
	85	enum rev_sort_order sort_order;
	86
e35b6ac5 SG	87	unsigned int early_output;
	88
	89	unsigned int ignore_missing:1,
2db1a43f	90	ignore_missing_links:1;
cdcefbc9	91
ae563542 LT	92	/* Traversal flags */
ae563542 LT	93	unsigned int dense:1,
53b2c823	94	prune:1,
ca92e59e	95	no_walk:2,
ae563542	96	remove_empty_trees:1,
9202434c	97	simplify_history:1,
ae563542	98	topo_order:1,
6546b593	99	simplify_merges:1,
78892e32	100	simplify_by_decoration:1,
ff9445be	101	single_worktree:1,
ae563542 LT	102	tag_objects:1,
	103	tree_objects:1,
	104	blob_objects:1,
5a48d240	105	verify_objects:1,
d9a83684	106	edge_hint:1,
1684c1b2	107	edge_hint_aggressive:1,
d9a83684	108	limited:1,
03a9683d	109	unpacked:1,
86ab4906	110	boundary:2,
f69c5018	111	count:1,
74bd9029	112	left_right:1,
60adf7d7 MG	113	left_only:1,
60adf7d7 MG	114	right_only:1,
885cf808 AS	115	rewrite_parents:1,
885cf808 AS	116	print_parents:1,
d467a525	117	show_decorations:1,
0053e902	118	reverse:1,
498bcd31	119	reverse_output_stage:1,
d7a17cad	120	cherry_pick:1,
adbbb31e	121	cherry_mark:1,
ad3f9a71	122	bisect:1,
ebdc94f3	123	ancestry_path:1,
12da1d1f	124	first_parent_only:1,
ce5b6f9b	125	line_level_traverse:1,
f3d618d2	126	tree_blobs_in_commit_order:1,
df11e196 JT	127
	128	/* for internal use only */
	129	exclude_promisor_objects:1;
ae563542	130
cd2bdc53 LT	131	/* Diff flags */
	132	unsigned int diff:1,
	133	full_diff:1,
	134	show_root_diff:1,
	135	no_commit_id:1,
	136	verbose_header:1,
	137	ignore_merges:1,
	138	combine_merges:1,
	139	dense_combined_merges:1,
	140	always_show_header:1;
	141
	142	/* Format info */
91539833	143	unsigned int shown_one:1,
bd1470b8	144	shown_dashes:1,
02e54220	145	show_merge:1,
66b2ed09 JH	146	show_notes:1,
66b2ed09 JH	147	show_notes_given:1,
0c37f1fc	148	show_signature:1,
66b2ed09	149	pretty_given:1,
4da45bef	150	abbrev_commit:1,
0c47695a	151	abbrev_commit_given:1,
3a30aa17	152	zero_commit:1,
7fefda5c	153	use_terminator:1,
f4ea32f0	154	missing_newline:1,
9553d2b2 JK	155	date_mode_explicit:1,
9553d2b2 JK	156	preserve_subject:1;
8b3dce56	157	unsigned int disable_stdin:1;
1b32dece NTND	158	/* --show-linear-break */
	159	unsigned int track_linear:1,
	160	track_first_time:1,
	161	linear:1;
8b3dce56	162
a5481a6c	163	struct date_mode date_mode;
0893eec8 JH	164	int expand_tabs_in_log; /* unset if negative */
0893eec8 JH	165	int expand_tabs_in_log_default;
106d710b	166
cd2bdc53 LT	167	unsigned int abbrev;
cd2bdc53 LT	168	enum cmit_fmt commit_format;
91539833	169	struct log_info *loginfo;
596524b3	170	int nr, total;
698ce6f8	171	const char *mime_boundary;
108dab28 SB	172	const char *patch_suffix;
108dab28 SB	173	int numbered_files;
5fe10fe8	174	int reroll_count;
e1a37346	175	char *message_id;
a9080475	176	struct ident_split from_ident;
b079c50e	177	struct string_list *ref_message_ids;
5289c56a	178	int add_signoff;
20ff0680	179	const char *extra_headers;
52883fbd	180	const char *log_reencode;
2d9e4a47	181	const char *subject_prefix;
c112f689	182	int no_inline;
9fa3465d	183	int show_log_size;
0e2913b0	184	struct string_list *mailmap;
cd2bdc53	185
8ecae9b0	186	/* Filter by commit log message */
0843acfd	187	struct grep_opt grep_filter;
22dfa8a2 CJ	188	/* Negate the match of grep_filter */
22dfa8a2 CJ	189	int invert_grep;
8ecae9b0	190
7fefda5c AS	191	/* Display history graph */
	192	struct git_graph *graph;
	193
ae563542	194	/* special limits */
d5db6c9e	195	int skip_count;
ae563542	196	int max_count;
dddbad72 JS	197	timestamp_t max_age;
dddbad72 JS	198	timestamp_t min_age;
ad5aeede MG	199	int min_parents;
ad5aeede MG	200	int max_parents;
a330de31 VM	201	int (include_check)(struct commit , void *);
a330de31 VM	202	void *include_check_data;
8efdc326	203
cd2bdc53	204	/* diff info for patches and for paths limiting */
c4e05b1a	205	struct diff_options diffopt;
cd2bdc53	206	struct diff_options pruning;
c4e05b1a	207
8860fd42	208	struct reflog_walk_info *reflog_info;
f35f5603	209	struct decoration children;
faf0156b	210	struct decoration merge_simplification;
d0af663e	211	struct decoration treesame;
894a9d33 TR	212
	213	/* notes-specific options: which refs to show */
	214	struct display_notes_opt notes_opt;
f69c5018 TR	215
	216	/* commit counts */
	217	int count_left;
	218	int count_right;
b388e14b	219	int count_same;
12da1d1f TR	220
	221	/* line level range that we are chasing */
	222	struct decoration line_log_data;
53d00b39 TR	223
	224	/* copies of the parent lists, for --full-diff display */
	225	struct saved_parents *saved_parents_slab;
1b32dece NTND	226
	227	struct commit_list *previous_parents;
	228	const char *break_bar;
87be2523 NTND	229
87be2523 NTND	230	struct revision_sources *sources;
ae563542 LT	231	};
ae563542 LT	232
ff32d342 JH	233	extern int ref_excluded(struct string_list , const char path);
	234	void clear_ref_exclusion(struct string_list **);
	235	void add_ref_exclusion(struct string_list *, const char exclude);
	236
	237
8efdc326	238	#define REV_TREE_SAME 0
ceff8e7a LT	239	#define REV_TREE_NEW 1 /* Only new files */
	240	#define REV_TREE_OLD 2 /* Only files removed */
	241	#define REV_TREE_DIFFERENT 3 /* Mixed changes */
8efdc326	242
ae563542	243	/* revision.c */
cdcefbc9	244	typedef void (show_early_output_fn_t)(struct rev_info , struct commit_list *);
4dc1db0b	245	extern volatile show_early_output_fn_t show_early_output;
8efdc326	246
32962c9b JH	247	struct setup_revision_opt {
32962c9b JH	248	const char *def;
b4490059	249	void (tweak)(struct rev_info , struct setup_revision_opt *);
9ef6aeb0	250	const char *submodule;
6d5b93f2	251	int assume_dashdash;
d5f6b1d7	252	unsigned revarg_opt;
32962c9b JH	253	};
32962c9b JH	254
db6296a5	255	extern void init_revisions(struct rev_info revs, const char prefix);
ff5f5f26 MH	256	extern int setup_revisions(int argc, const char *argv, struct rev_info revs,
ff5f5f26 MH	257	struct setup_revision_opt *);
6b61ec05	258	extern void parse_revision_opt(struct rev_info revs, struct parse_opt_ctx_t ctx,
ff5f5f26 MH	259	const struct option *options,
ff5f5f26 MH	260	const char * const usagestr[]);
8e676e8b	261	#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7	262	#define REVARG_COMMITTISH 02
ff5f5f26 MH	263	extern int handle_revision_arg(const char arg, struct rev_info revs,
ff5f5f26 MH	264	int flags, unsigned revarg_opt);
5d6f0935	265
bcc0a3ea	266	extern void reset_revision_walk(void);
cc0e6c5a	267	extern int prepare_revision_walk(struct rev_info *revs);
a4a88b2b	268	extern struct commit get_revision(struct rev_info revs);
ff5f5f26 MH	269	extern char get_revision_mark(const struct rev_info revs,
	270	const struct commit *commit);
	271	extern void put_revision_mark(const struct rev_info *revs,
	272	const struct commit *commit);
a4a88b2b	273
ae563542 LT	274	extern void mark_parents_uninteresting(struct commit *commit);
	275	extern void mark_tree_uninteresting(struct tree *tree);
	276
de1e67d0	277	extern void show_object_with_name(FILE , struct object , const char *);
91f17516	278
ff5f5f26 MH	279	extern void add_pending_object(struct rev_info *revs,
ff5f5f26 MH	280	struct object obj, const char name);
a58a1b01	281	extern void add_pending_oid(struct rev_info *revs,
	282	const char name, const struct object_id oid,
	283	unsigned int flags);
ae563542	284
3384a2df	285	extern void add_head_to_pending(struct rev_info *);
718ccc97	286	extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
4fe10219	287	extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
3384a2df	288
252a7c02 LT	289	enum commit_action {
	290	commit_ignore,
	291	commit_show,
	292	commit_error
	293	};
	294
ff5f5f26 MH	295	extern enum commit_action get_commit_action(struct rev_info *revs,
	296	struct commit *commit);
	297	extern enum commit_action simplify_commit(struct rev_info *revs,
	298	struct commit *commit);
252a7c02	299
c7edcae0 BY	300	enum rewrite_result {
	301	rewrite_one_ok,
	302	rewrite_one_noparents,
	303	rewrite_one_error
	304	};
	305
	306	typedef enum rewrite_result (rewrite_parent_fn_t)(struct rev_info revs, struct commit **pp);
	307
	308	extern int rewrite_parents(struct rev_info revs, struct commit commit,
	309	rewrite_parent_fn_t rewrite_parent);
53d00b39 TR	310
53d00b39 TR	311	/*
0131c490 JH	312	* The log machinery saves the original parent list so that
	313	* get_saved_parents() can later tell what the real parents of the
	314	* commits are, when commit->parents has been modified by history
	315	* simpification.
53d00b39 TR	316	*
	317	* get_saved_parents() will transparently return commit->parents if
	318	* history simplification is off.
	319	*/
53d00b39	320	extern struct commit_list get_saved_parents(struct rev_info revs, const struct commit *commit);
53d00b39	321
ae563542	322	#endif