[thirdparty/git.git] / revision.h

#ifndef REVISION_H
#define REVISION_H

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

/**
 * The revision walking API offers functions to build a list of revisions
 * and then iterate over that list.
 *
 * Calling sequence
 * ----------------
 *
 * The walking API has a given calling sequence: first you need to initialize
 * a rev_info structure, then add revisions to control what kind of revision
 * list do you want to get, finally you can iterate over the revision list.
 *
 */

/* 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)

/* WARNING: This is also used as REACHABLE in commit-graph.c. */
#define PULL_MERGE	(1u<<15)

#define TOPO_WALK_EXPLORED	(1u<<23)
#define TOPO_WALK_INDEGREE	(1u<<24)

/*
 * Indicates object was reached by traversal. i.e. not given by user on
 * command-line or stdin.
 * NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support
 * filtering trees and blobs, but it may be useful to support filtering commits
 * in the future.
 */
#define NOT_USER_GIVEN	(1u<<25)
#define TRACK_LINEAR	(1u<<26)
#define ALL_REV_FLAGS	(((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)

#define DECORATE_SHORT_REFS	1
#define DECORATE_FULL_REFS	2

struct log_info;
struct repository;
struct rev_info;
struct string_list;
struct saved_parents;
struct bloom_key;
struct bloom_filter_settings;
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 oidset;
struct topo_walk_info;

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

	/* 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;

	/*
	 * Whether we read from stdin due to the --stdin option.
	 */
	int read_from_stdin;

	/* 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,
			show_pulls: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,

			/*
			 * Blobs are shown without regard for their existence.
			 * But not so for trees: unless exclude_promisor_objects
			 * is set and the tree in question is a promisor object;
			 * OR ignore_missing_links is set, the revision walker
			 * dies with a "bad tree object HASH" message when
			 * encountering a missing tree. For callers that can
			 * handle missing trees and want them to be filterable
			 * and showable, set this to true. The revision walker
			 * will filter and show such a missing tree as usual,
			 * but will not attempt to recurse into this tree
			 * object.
			 */
			do_not_die_on_missing_tree:1,

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

	/* Diff flags */
	unsigned int	diff:1,
			full_diff:1,
			show_root_diff:1,
			match_missing:1,
			no_commit_id:1,
			verbose_header:1,
			explicit_diff_merges: 1,
			separate_merges: 1,
			combine_merges:1,
			combined_all_paths:1,
			dense_combined_merges:1,
			first_parent_merges:1,
			always_show_header:1;

	/* Format info */
	int		show_notes;
	unsigned int	shown_one:1,
			shown_dashes:1,
			show_merge: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,
			encode_email_headers: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;

	/* interdiff */
	const struct object_id *idiff_oid1;
	const struct object_id *idiff_oid2;
	const char *idiff_title;

	/* range-diff */
	const char *rdiff1;
	const char *rdiff2;
	int creation_factor;
	const char *rdiff_title;

	/* 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;

	struct topo_walk_info *topo_walk_info;

	/* Commit graph bloom filter fields */
	/* The bloom filter key(s) for the pathspec */
	struct bloom_key *bloom_keys;
	int bloom_keys_nr;

	/*
	 * The bloom filter settings used to generate the key.
	 * This is loaded from the commit-graph being used.
	 */
	struct bloom_filter_settings *bloom_filter_settings;
};

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;	/* TODO: drop this and use rev_info->repo */
	unsigned int	assume_dashdash:1,
			allow_exclude_promisor_objects:1;
	unsigned revarg_opt;
};

#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
#define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
#endif

/**
 * Initialize a rev_info structure with default values. The third parameter may
 * be NULL or can be prefix path, and then the `.prefix` variable will be set
 * to it. This is typically the first function you want to call when you want
 * to deal with a revision list. After calling this function, you are free to
 * customize options, like set `.ignore_merges` to 0 if you don't want to
 * ignore merges, and so on.
 */
void repo_init_revisions(struct repository *r,
			 struct rev_info *revs,
			 const char *prefix);

/**
 * Parse revision information, filling in the `rev_info` structure, and
 * removing the used arguments from the argument list. Returns the number
 * of arguments left that weren't recognized, which are also moved to the
 * head of the argument list. The last parameter is used in case no
 * parameter given by the first two arguments.
 */
int setup_revisions(int argc, const char **argv, struct rev_info *revs,
		    struct setup_revision_opt *);

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
int handle_revision_arg(const char *arg, struct rev_info *revs,
			int flags, unsigned revarg_opt);

/**
 * Reset the flags used by the revision walking api. You can use this to do
 * multiple sequential revision walks.
 */
void reset_revision_walk(void);

/**
 * Prepares the rev_info structure for a walk. You should check if it returns
 * any error (non-zero return code) and if it does not, you can start using
 * get_revision() to do the iteration.
 */
int prepare_revision_walk(struct rev_info *revs);

/**
 * Takes a pointer to a `rev_info` structure and iterates over it, returning a
 * `struct commit *` each time you call it. The end of the revision list is
 * indicated by returning a NULL pointer.
 */
struct commit *get_revision(struct rev_info *revs);

const char *get_revision_mark(const struct rev_info *revs,
			      const struct commit *commit);
void put_revision_mark(const struct rev_info *revs,
		       const struct commit *commit);

void mark_parents_uninteresting(struct commit *commit);
void mark_tree_uninteresting(struct repository *r, struct tree *tree);
void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);

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

/**
 * This function can be used if you want to add commit objects as revision
 * information. You can use the `UNINTERESTING` object flag to indicate if
 * you want to include or exclude the given commit (and commits reachable
 * from the given commit) from the revision list.
 *
 * NOTE: If you have the commits as a string list then you probably want to
 * use setup_revisions(), instead of parsing each string and using this
 * function.
 */
void add_pending_object(struct rev_info *revs,
			struct object *obj, const char *name);

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

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

enum commit_action {
	commit_ignore,
	commit_show,
	commit_error
};

enum commit_action get_commit_action(struct rev_info *revs,
				     struct commit *commit);
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);

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.
 */
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
ef3ca954	4	#include "commit.h"
6b61ec05	5	#include "parse-options.h"
0843acfd	6	#include "grep.h"
894a9d33	7	#include "notes.h"
cf394719	8	#include "pretty.h"
19ecb564	9	#include "diff.h"
87be2523	10	#include "commit-slab-decl.h"
6b61ec05	11
301d595e HW	12	/**
	13	* The revision walking API offers functions to build a list of revisions
	14	* and then iterate over that list.
	15	*
	16	* Calling sequence
	17	* ----------------
	18	*
	19	* The walking API has a given calling sequence: first you need to initialize
	20	* a rev_info structure, then add revisions to control what kind of revision
	21	* list do you want to get, finally you can iterate over the revision list.
	22	*
	23	*/
	24
208acbfb	25	/* Remember to update object flag allocation in object.h */
ae563542 LT	26	#define SEEN (1u<<0)
ae563542 LT	27	#define UNINTERESTING (1u<<1)
7dc0fe3b	28	#define TREESAME (1u<<2)
765ac8ec	29	#define SHOWN (1u<<3)
7ae0b0cb	30	#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
384e99a4	31	#define BOUNDARY (1u<<5)
2b064697	32	#define CHILD_SHOWN (1u<<6)
1b65a5aa	33	#define ADDED (1u<<7) /* Parents already parsed and added? */
577ed5c2	34	#define SYMMETRIC_LEFT (1u<<8)
adbbb31e	35	#define PATCHSAME (1u<<9)
7f34a46f	36	#define BOTTOM (1u<<10)
8d049e18 DS	37
	38	/* WARNING: This is also used as REACHABLE in commit-graph.c. */
	39	#define PULL_MERGE (1u<<15)
23c4319f RS	40
	41	#define TOPO_WALK_EXPLORED (1u<<23)
	42	#define TOPO_WALK_INDEGREE (1u<<24)
	43
99c9aa95 MD	44	/*
	45	* Indicates object was reached by traversal. i.e. not given by user on
	46	* command-line or stdin.
	47	* NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support
	48	* filtering trees and blobs, but it may be useful to support filtering commits
	49	* in the future.
	50	*/
	51	#define NOT_USER_GIVEN (1u<<25)
1b32dece	52	#define TRACK_LINEAR (1u<<26)
8d049e18	53	#define ALL_REV_FLAGS (((1u<<11)-1) \| NOT_USER_GIVEN \| TRACK_LINEAR \| PULL_MERGE)
ae563542	54
33e7018c LH	55	#define DECORATE_SHORT_REFS 1
	56	#define DECORATE_FULL_REFS 2
	57
91539833	58	struct log_info;
2abf3503 NTND	59	struct repository;
2abf3503 NTND	60	struct rev_info;
894a9d33	61	struct string_list;
53d00b39	62	struct saved_parents;
a56b9464 GS	63	struct bloom_key;
a56b9464 GS	64	struct bloom_filter_settings;
87be2523	65	define_shared_commit_slab(revision_sources, char *);
8efdc326	66
281eee47 JH	67	struct rev_cmdline_info {
	68	unsigned int nr;
	69	unsigned int alloc;
	70	struct rev_cmdline_entry {
	71	struct object *item;
	72	const char *name;
	73	enum {
	74	REV_CMD_REF,
	75	REV_CMD_PARENTS_ONLY,
	76	REV_CMD_LEFT,
	77	REV_CMD_RIGHT,
a765499a	78	REV_CMD_MERGE_BASE,
281eee47 JH	79	REV_CMD_REV
	80	} whence;
	81	unsigned flags;
	82	} *rev;
	83	};
	84
ca92e59e MZ	85	#define REVISION_WALK_WALK 0
	86	#define REVISION_WALK_NO_WALK_SORTED 1
	87	#define REVISION_WALK_NO_WALK_UNSORTED 2
	88
f1f5de44	89	struct oidset;
f0d9cc41 DS	90	struct topo_walk_info;
f0d9cc41 DS	91
ae563542 LT	92	struct rev_info {
	93	/* Starting list */
	94	struct commit_list *commits;
1f1e895f	95	struct object_array pending;
2abf3503	96	struct repository *repo;
ae563542	97
86ab4906 JH	98	/* Parents of shown commits */
	99	struct object_array boundary_commits;
	100
281eee47 JH	101	/* The end-points specified by the end user */
	102	struct rev_cmdline_info cmdline;
	103
e7b432c5 JH	104	/* excluding from --branches, --refs, etc. expansion */
	105	struct string_list *ref_excludes;
	106
ae563542 LT	107	/* Basic information */
ae563542 LT	108	const char *prefix;
02e54220	109	const char *def;
afe069d1	110	struct pathspec prune_data;
08f704f2	111
7ba82629 JK	112	/*
	113	* Whether the arguments parsed by setup_revisions() included any
	114	* "input" revisions that might still have yielded an empty pending
	115	* list (e.g., patterns like "--all" or "--glob").
	116	*/
	117	int rev_input_given;
	118
a12cbe23 JK	119	/*
	120	* Whether we read from stdin due to the --stdin option.
	121	*/
	122	int read_from_stdin;
	123
08f704f2 JH	124	/* topo-sort */
	125	enum rev_sort_order sort_order;
	126
e35b6ac5 SG	127	unsigned int early_output;
	128
	129	unsigned int ignore_missing:1,
2db1a43f	130	ignore_missing_links:1;
cdcefbc9	131
ae563542 LT	132	/* Traversal flags */
ae563542 LT	133	unsigned int dense:1,
53b2c823	134	prune:1,
ca92e59e	135	no_walk:2,
ae563542	136	remove_empty_trees:1,
9202434c	137	simplify_history:1,
8d049e18	138	show_pulls:1,
ae563542	139	topo_order:1,
6546b593	140	simplify_merges:1,
78892e32	141	simplify_by_decoration:1,
ff9445be	142	single_worktree:1,
ae563542 LT	143	tag_objects:1,
	144	tree_objects:1,
	145	blob_objects:1,
5a48d240	146	verify_objects:1,
d9a83684	147	edge_hint:1,
1684c1b2	148	edge_hint_aggressive:1,
d9a83684	149	limited:1,
03a9683d	150	unpacked:1,
86ab4906	151	boundary:2,
f69c5018	152	count:1,
74bd9029	153	left_right:1,
60adf7d7 MG	154	left_only:1,
60adf7d7 MG	155	right_only:1,
885cf808 AS	156	rewrite_parents:1,
885cf808 AS	157	print_parents:1,
d467a525	158	show_decorations:1,
0053e902	159	reverse:1,
498bcd31	160	reverse_output_stage:1,
d7a17cad	161	cherry_pick:1,
adbbb31e	162	cherry_mark:1,
ad3f9a71	163	bisect:1,
ebdc94f3	164	ancestry_path:1,
12da1d1f	165	first_parent_only:1,
ce5b6f9b	166	line_level_traverse:1,
f3d618d2	167	tree_blobs_in_commit_order:1,
df11e196	168
7c0fe330 MD	169	/*
	170	* Blobs are shown without regard for their existence.
	171	* But not so for trees: unless exclude_promisor_objects
	172	* is set and the tree in question is a promisor object;
	173	* OR ignore_missing_links is set, the revision walker
	174	* dies with a "bad tree object HASH" message when
	175	* encountering a missing tree. For callers that can
	176	* handle missing trees and want them to be filterable
	177	* and showable, set this to true. The revision walker
	178	* will filter and show such a missing tree as usual,
	179	* but will not attempt to recurse into this tree
	180	* object.
	181	*/
	182	do_not_die_on_missing_tree:1,
	183
df11e196 JT	184	/* for internal use only */
df11e196 JT	185	exclude_promisor_objects:1;
ae563542	186
cd2bdc53 LT	187	/* Diff flags */
	188	unsigned int diff:1,
	189	full_diff:1,
	190	show_root_diff:1,
572fc9aa	191	match_missing:1,
cd2bdc53 LT	192	no_commit_id:1,
cd2bdc53 LT	193	verbose_header:1,
1a2c4d80 SO	194	explicit_diff_merges: 1,
1a2c4d80 SO	195	separate_merges: 1,
cd2bdc53	196	combine_merges:1,
d76ce4f7	197	combined_all_paths:1,
cd2bdc53	198	dense_combined_merges:1,
3291eea3	199	first_parent_merges:1,
cd2bdc53 LT	200	always_show_header:1;
	201
	202	/* Format info */
1d729751	203	int show_notes;
91539833	204	unsigned int shown_one:1,
bd1470b8	205	shown_dashes:1,
02e54220	206	show_merge:1,
66b2ed09	207	show_notes_given:1,
0c37f1fc	208	show_signature:1,
66b2ed09	209	pretty_given:1,
4da45bef	210	abbrev_commit:1,
0c47695a	211	abbrev_commit_given:1,
3a30aa17	212	zero_commit:1,
7fefda5c	213	use_terminator:1,
f4ea32f0	214	missing_newline:1,
9553d2b2	215	date_mode_explicit:1,
19d097e3 EB	216	preserve_subject:1,
19d097e3 EB	217	encode_email_headers:1;
8b3dce56	218	unsigned int disable_stdin:1;
1b32dece NTND	219	/* --show-linear-break */
	220	unsigned int track_linear:1,
	221	track_first_time:1,
	222	linear:1;
8b3dce56	223
a5481a6c	224	struct date_mode date_mode;
0893eec8 JH	225	int expand_tabs_in_log; /* unset if negative */
0893eec8 JH	226	int expand_tabs_in_log_default;
106d710b	227
cd2bdc53 LT	228	unsigned int abbrev;
cd2bdc53 LT	229	enum cmit_fmt commit_format;
91539833	230	struct log_info *loginfo;
596524b3	231	int nr, total;
698ce6f8	232	const char *mime_boundary;
108dab28 SB	233	const char *patch_suffix;
108dab28 SB	234	int numbered_files;
5fe10fe8	235	int reroll_count;
e1a37346	236	char *message_id;
a9080475	237	struct ident_split from_ident;
b079c50e	238	struct string_list *ref_message_ids;
5289c56a	239	int add_signoff;
20ff0680	240	const char *extra_headers;
52883fbd	241	const char *log_reencode;
2d9e4a47	242	const char *subject_prefix;
c112f689	243	int no_inline;
9fa3465d	244	int show_log_size;
0e2913b0	245	struct string_list *mailmap;
cd2bdc53	246
8ecae9b0	247	/* Filter by commit log message */
0843acfd	248	struct grep_opt grep_filter;
22dfa8a2 CJ	249	/* Negate the match of grep_filter */
22dfa8a2 CJ	250	int invert_grep;
8ecae9b0	251
7fefda5c AS	252	/* Display history graph */
	253	struct git_graph *graph;
	254
ae563542	255	/* special limits */
d5db6c9e	256	int skip_count;
ae563542	257	int max_count;
dddbad72 JS	258	timestamp_t max_age;
dddbad72 JS	259	timestamp_t min_age;
ad5aeede MG	260	int min_parents;
ad5aeede MG	261	int max_parents;
a330de31 VM	262	int (include_check)(struct commit , void *);
a330de31 VM	263	void *include_check_data;
8efdc326	264
cd2bdc53	265	/* diff info for patches and for paths limiting */
c4e05b1a	266	struct diff_options diffopt;
cd2bdc53	267	struct diff_options pruning;
c4e05b1a	268
8860fd42	269	struct reflog_walk_info *reflog_info;
f35f5603	270	struct decoration children;
faf0156b	271	struct decoration merge_simplification;
d0af663e	272	struct decoration treesame;
894a9d33 TR	273
	274	/* notes-specific options: which refs to show */
	275	struct display_notes_opt notes_opt;
f69c5018	276
126facf8 ES	277	/* interdiff */
	278	const struct object_id *idiff_oid1;
	279	const struct object_id *idiff_oid2;
5ac290f9	280	const char *idiff_title;
126facf8	281
31e2617a ES	282	/* range-diff */
	283	const char *rdiff1;
	284	const char *rdiff2;
	285	int creation_factor;
4ee99689	286	const char *rdiff_title;
31e2617a	287
f69c5018 TR	288	/* commit counts */
	289	int count_left;
	290	int count_right;
b388e14b	291	int count_same;
12da1d1f TR	292
	293	/* line level range that we are chasing */
	294	struct decoration line_log_data;
53d00b39 TR	295
	296	/* copies of the parent lists, for --full-diff display */
	297	struct saved_parents *saved_parents_slab;
1b32dece NTND	298
	299	struct commit_list *previous_parents;
	300	const char *break_bar;
87be2523 NTND	301
87be2523 NTND	302	struct revision_sources *sources;
f0d9cc41 DS	303
f0d9cc41 DS	304	struct topo_walk_info *topo_walk_info;
a56b9464 GS	305
a56b9464 GS	306	/* Commit graph bloom filter fields */
c525ce95 SG	307	/* The bloom filter key(s) for the pathspec */
	308	struct bloom_key *bloom_keys;
	309	int bloom_keys_nr;
	310
a56b9464 GS	311	/*
	312	* The bloom filter settings used to generate the key.
	313	* This is loaded from the commit-graph being used.
	314	*/
	315	struct bloom_filter_settings *bloom_filter_settings;
ae563542 LT	316	};
ae563542 LT	317
d16ec9cd	318	int ref_excluded(struct string_list , const char path);
ff32d342 JH	319	void clear_ref_exclusion(struct string_list **);
	320	void add_ref_exclusion(struct string_list *, const char exclude);
	321
	322
8efdc326	323	#define REV_TREE_SAME 0
ceff8e7a LT	324	#define REV_TREE_NEW 1 /* Only new files */
	325	#define REV_TREE_OLD 2 /* Only files removed */
	326	#define REV_TREE_DIFFERENT 3 /* Mixed changes */
8efdc326	327
ae563542	328	/* revision.c */
cdcefbc9	329	typedef void (show_early_output_fn_t)(struct rev_info , struct commit_list *);
4dc1db0b	330	extern volatile show_early_output_fn_t show_early_output;
8efdc326	331
32962c9b JH	332	struct setup_revision_opt {
32962c9b JH	333	const char *def;
b4490059	334	void (tweak)(struct rev_info , struct setup_revision_opt *);
2abf3503	335	const char submodule; / TODO: drop this and use rev_info->repo */
bbcde41a MD	336	unsigned int assume_dashdash:1,
bbcde41a MD	337	allow_exclude_promisor_objects:1;
d5f6b1d7	338	unsigned revarg_opt;
32962c9b JH	339	};
32962c9b JH	340
2abf3503 NTND	341	#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
	342	#define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
	343	#endif
301d595e HW	344
	345	/**
	346	* Initialize a rev_info structure with default values. The third parameter may
	347	* be NULL or can be prefix path, and then the `.prefix` variable will be set
	348	* to it. This is typically the first function you want to call when you want
	349	* to deal with a revision list. After calling this function, you are free to
	350	* customize options, like set `.ignore_merges` to 0 if you don't want to
	351	* ignore merges, and so on.
	352	*/
2abf3503 NTND	353	void repo_init_revisions(struct repository *r,
	354	struct rev_info *revs,
	355	const char *prefix);
301d595e HW	356
	357	/**
	358	* Parse revision information, filling in the `rev_info` structure, and
	359	* removing the used arguments from the argument list. Returns the number
	360	* of arguments left that weren't recognized, which are also moved to the
	361	* head of the argument list. The last parameter is used in case no
	362	* parameter given by the first two arguments.
	363	*/
d16ec9cd NTND	364	int setup_revisions(int argc, const char *argv, struct rev_info revs,
d16ec9cd NTND	365	struct setup_revision_opt *);
301d595e	366
d16ec9cd NTND	367	void parse_revision_opt(struct rev_info revs, struct parse_opt_ctx_t ctx,
	368	const struct option *options,
	369	const char * const usagestr[]);
8e676e8b	370	#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7	371	#define REVARG_COMMITTISH 02
d16ec9cd NTND	372	int handle_revision_arg(const char arg, struct rev_info revs,
d16ec9cd NTND	373	int flags, unsigned revarg_opt);
5d6f0935	374
301d595e HW	375	/**
	376	* Reset the flags used by the revision walking api. You can use this to do
	377	* multiple sequential revision walks.
	378	*/
d16ec9cd	379	void reset_revision_walk(void);
301d595e HW	380
	381	/**
	382	* Prepares the rev_info structure for a walk. You should check if it returns
	383	* any error (non-zero return code) and if it does not, you can start using
	384	* get_revision() to do the iteration.
	385	*/
d16ec9cd	386	int prepare_revision_walk(struct rev_info *revs);
301d595e HW	387
	388	/**
	389	* Takes a pointer to a `rev_info` structure and iterates over it, returning a
	390	* `struct commit *` each time you call it. The end of the revision list is
	391	* indicated by returning a NULL pointer.
	392	*/
d16ec9cd	393	struct commit get_revision(struct rev_info revs);
301d595e	394
49825164 DL	395	const char get_revision_mark(const struct rev_info revs,
49825164 DL	396	const struct commit *commit);
d16ec9cd NTND	397	void put_revision_mark(const struct rev_info *revs,
d16ec9cd NTND	398	const struct commit *commit);
a4a88b2b	399
d16ec9cd	400	void mark_parents_uninteresting(struct commit *commit);
b3c7eef9	401	void mark_tree_uninteresting(struct repository r, struct tree tree);
f1f5de44	402	void mark_trees_uninteresting_sparse(struct repository r, struct oidset trees);
ae563542	403
d16ec9cd	404	void show_object_with_name(FILE , struct object , const char *);
91f17516	405
301d595e HW	406	/**
	407	* This function can be used if you want to add commit objects as revision
	408	* information. You can use the `UNINTERESTING` object flag to indicate if
	409	* you want to include or exclude the given commit (and commits reachable
	410	* from the given commit) from the revision list.
	411	*
	412	* NOTE: If you have the commits as a string list then you probably want to
	413	* use setup_revisions(), instead of parsing each string and using this
	414	* function.
	415	*/
d16ec9cd NTND	416	void add_pending_object(struct rev_info *revs,
d16ec9cd NTND	417	struct object obj, const char name);
301d595e	418
d16ec9cd NTND	419	void add_pending_oid(struct rev_info *revs,
	420	const char name, const struct object_id oid,
	421	unsigned int flags);
ae563542	422
d16ec9cd NTND	423	void add_head_to_pending(struct rev_info *);
	424	void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
	425	void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
3384a2df	426
252a7c02 LT	427	enum commit_action {
	428	commit_ignore,
	429	commit_show,
	430	commit_error
	431	};
	432
d16ec9cd NTND	433	enum commit_action get_commit_action(struct rev_info *revs,
	434	struct commit *commit);
	435	enum commit_action simplify_commit(struct rev_info *revs,
	436	struct commit *commit);
252a7c02	437
c7edcae0 BY	438	enum rewrite_result {
	439	rewrite_one_ok,
	440	rewrite_one_noparents,
	441	rewrite_one_error
	442	};
	443
	444	typedef enum rewrite_result (rewrite_parent_fn_t)(struct rev_info revs, struct commit **pp);
	445
d16ec9cd NTND	446	int rewrite_parents(struct rev_info *revs,
	447	struct commit *commit,
	448	rewrite_parent_fn_t rewrite_parent);
53d00b39 TR	449
53d00b39 TR	450	/*
0131c490 JH	451	* The log machinery saves the original parent list so that
	452	* get_saved_parents() can later tell what the real parents of the
	453	* commits are, when commit->parents has been modified by history
	454	* simpification.
53d00b39 TR	455	*
	456	* get_saved_parents() will transparently return commit->parents if
	457	* history simplification is off.
	458	*/
d16ec9cd	459	struct commit_list get_saved_parents(struct rev_info revs, const struct commit *commit);
53d00b39	460
ae563542	461	#endif