[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"
#include "list-objects-filter-options.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.
 */
#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;
};

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;

	/*
	 * Object filter options. No filtering is specified
	 * if and only if filter.choice is zero.
	 */
	struct list_objects_filter_options filter;

	/* 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:1,
			unsorted_input:1,
			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,
			no_kept_objects: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,
			exclude_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,
			always_show_header:1,
			/* Diff-merge flags */
			explicit_diff_merges: 1,
			merges_need_diff: 1,
			merges_imply_patch:1,
			separate_merges: 1,
			combine_merges:1,
			combined_all_paths:1,
			dense_combined_merges:1,
			first_parent_merges:1,
			remerge_diff: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,
			include_header: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;
	const char	*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		patch_name_max;
	int		no_inline;
	int		show_log_size;
	struct string_list *mailmap;

	/* Filter by commit log message */
	struct grep_opt	grep_filter;

	/* 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 *);
	int (*include_check_obj)(struct object *obj, 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;

	/* misc. flags related to '--no-kept-objects' */
	unsigned keep_pack_cache_flags;

	/* Location where temporary objects for remerge-diff are written. */
	struct tmp_objdir *remerge_objdir;
};

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 *);
	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);
void revision_opts_finish(struct rev_info *revs);

/**
 * 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 rev_info *revs, 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
	1	#ifndef REVISION_H
	2	#define REVISION_H
	3
	4	#include "commit.h"
	5	#include "parse-options.h"
	6	#include "grep.h"
	7	#include "notes.h"
	8	#include "pretty.h"
	9	#include "diff.h"
	10	#include "commit-slab-decl.h"
	11	#include "list-objects-filter-options.h"
	12
	13	/**
	14	* The revision walking API offers functions to build a list of revisions
	15	* and then iterate over that list.
	16	*
	17	* Calling sequence
	18	* ----------------
	19	*
	20	* The walking API has a given calling sequence: first you need to initialize
	21	* a rev_info structure, then add revisions to control what kind of revision
	22	* list do you want to get, finally you can iterate over the revision list.
	23	*
	24	*/
	25
	26	/* Remember to update object flag allocation in object.h */
	27	#define SEEN (1u<<0)
	28	#define UNINTERESTING (1u<<1)
	29	#define TREESAME (1u<<2)
	30	#define SHOWN (1u<<3)
	31	#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
	32	#define BOUNDARY (1u<<5)
	33	#define CHILD_SHOWN (1u<<6)
	34	#define ADDED (1u<<7) /* Parents already parsed and added? */
	35	#define SYMMETRIC_LEFT (1u<<8)
	36	#define PATCHSAME (1u<<9)
	37	#define BOTTOM (1u<<10)
	38
	39	/* WARNING: This is also used as REACHABLE in commit-graph.c. */
	40	#define PULL_MERGE (1u<<15)
	41
	42	#define TOPO_WALK_EXPLORED (1u<<23)
	43	#define TOPO_WALK_INDEGREE (1u<<24)
	44
	45	/*
	46	* Indicates object was reached by traversal. i.e. not given by user on
	47	* command-line or stdin.
	48	*/
	49	#define NOT_USER_GIVEN (1u<<25)
	50	#define TRACK_LINEAR (1u<<26)
	51	#define ALL_REV_FLAGS (((1u<<11)-1) \| NOT_USER_GIVEN \| TRACK_LINEAR \| PULL_MERGE)
	52
	53	#define DECORATE_SHORT_REFS 1
	54	#define DECORATE_FULL_REFS 2
	55
	56	struct log_info;
	57	struct repository;
	58	struct rev_info;
	59	struct string_list;
	60	struct saved_parents;
	61	struct bloom_key;
	62	struct bloom_filter_settings;
	63	define_shared_commit_slab(revision_sources, char *);
	64
	65	struct rev_cmdline_info {
	66	unsigned int nr;
	67	unsigned int alloc;
	68	struct rev_cmdline_entry {
	69	struct object *item;
	70	const char *name;
	71	enum {
	72	REV_CMD_REF,
	73	REV_CMD_PARENTS_ONLY,
	74	REV_CMD_LEFT,
	75	REV_CMD_RIGHT,
	76	REV_CMD_MERGE_BASE,
	77	REV_CMD_REV
	78	} whence;
	79	unsigned flags;
	80	} *rev;
	81	};
	82
	83	struct oidset;
	84	struct topo_walk_info;
	85
	86	struct rev_info {
	87	/* Starting list */
	88	struct commit_list *commits;
	89	struct object_array pending;
	90	struct repository *repo;
	91
	92	/* Parents of shown commits */
	93	struct object_array boundary_commits;
	94
	95	/* The end-points specified by the end user */
	96	struct rev_cmdline_info cmdline;
	97
	98	/*
	99	* Object filter options. No filtering is specified
	100	* if and only if filter.choice is zero.
	101	*/
	102	struct list_objects_filter_options filter;
	103
	104	/* excluding from --branches, --refs, etc. expansion */
	105	struct string_list *ref_excludes;
	106
	107	/* Basic information */
	108	const char *prefix;
	109	const char *def;
	110	struct pathspec prune_data;
	111
	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
	119	/*
	120	* Whether we read from stdin due to the --stdin option.
	121	*/
	122	int read_from_stdin;
	123
	124	/* topo-sort */
	125	enum rev_sort_order sort_order;
	126
	127	unsigned int early_output;
	128
	129	unsigned int ignore_missing:1,
	130	ignore_missing_links:1;
	131
	132	/* Traversal flags */
	133	unsigned int dense:1,
	134	prune:1,
	135	no_walk:1,
	136	unsorted_input:1,
	137	remove_empty_trees:1,
	138	simplify_history:1,
	139	show_pulls:1,
	140	topo_order:1,
	141	simplify_merges:1,
	142	simplify_by_decoration:1,
	143	single_worktree:1,
	144	tag_objects:1,
	145	tree_objects:1,
	146	blob_objects:1,
	147	verify_objects:1,
	148	edge_hint:1,
	149	edge_hint_aggressive:1,
	150	limited:1,
	151	unpacked:1,
	152	no_kept_objects:1,
	153	boundary:2,
	154	count:1,
	155	left_right:1,
	156	left_only:1,
	157	right_only:1,
	158	rewrite_parents:1,
	159	print_parents:1,
	160	show_decorations:1,
	161	reverse:1,
	162	reverse_output_stage:1,
	163	cherry_pick:1,
	164	cherry_mark:1,
	165	bisect:1,
	166	ancestry_path:1,
	167	first_parent_only:1,
	168	exclude_first_parent_only:1,
	169	line_level_traverse:1,
	170	tree_blobs_in_commit_order:1,
	171
	172	/*
	173	* Blobs are shown without regard for their existence.
	174	* But not so for trees: unless exclude_promisor_objects
	175	* is set and the tree in question is a promisor object;
	176	* OR ignore_missing_links is set, the revision walker
	177	* dies with a "bad tree object HASH" message when
	178	* encountering a missing tree. For callers that can
	179	* handle missing trees and want them to be filterable
	180	* and showable, set this to true. The revision walker
	181	* will filter and show such a missing tree as usual,
	182	* but will not attempt to recurse into this tree
	183	* object.
	184	*/
	185	do_not_die_on_missing_tree:1,
	186
	187	/* for internal use only */
	188	exclude_promisor_objects:1;
	189
	190	/* Diff flags */
	191	unsigned int diff:1,
	192	full_diff:1,
	193	show_root_diff:1,
	194	match_missing:1,
	195	no_commit_id:1,
	196	verbose_header:1,
	197	always_show_header:1,
	198	/* Diff-merge flags */
	199	explicit_diff_merges: 1,
	200	merges_need_diff: 1,
	201	merges_imply_patch:1,
	202	separate_merges: 1,
	203	combine_merges:1,
	204	combined_all_paths:1,
	205	dense_combined_merges:1,
	206	first_parent_merges:1,
	207	remerge_diff:1;
	208
	209	/* Format info */
	210	int show_notes;
	211	unsigned int shown_one:1,
	212	shown_dashes:1,
	213	show_merge:1,
	214	show_notes_given:1,
	215	show_signature:1,
	216	pretty_given:1,
	217	abbrev_commit:1,
	218	abbrev_commit_given:1,
	219	zero_commit:1,
	220	use_terminator:1,
	221	missing_newline:1,
	222	date_mode_explicit:1,
	223	preserve_subject:1,
	224	encode_email_headers:1,
	225	include_header:1;
	226	unsigned int disable_stdin:1;
	227	/* --show-linear-break */
	228	unsigned int track_linear:1,
	229	track_first_time:1,
	230	linear:1;
	231
	232	struct date_mode date_mode;
	233	int expand_tabs_in_log; /* unset if negative */
	234	int expand_tabs_in_log_default;
	235
	236	unsigned int abbrev;
	237	enum cmit_fmt commit_format;
	238	struct log_info *loginfo;
	239	int nr, total;
	240	const char *mime_boundary;
	241	const char *patch_suffix;
	242	int numbered_files;
	243	const char *reroll_count;
	244	char *message_id;
	245	struct ident_split from_ident;
	246	struct string_list *ref_message_ids;
	247	int add_signoff;
	248	const char *extra_headers;
	249	const char *log_reencode;
	250	const char *subject_prefix;
	251	int patch_name_max;
	252	int no_inline;
	253	int show_log_size;
	254	struct string_list *mailmap;
	255
	256	/* Filter by commit log message */
	257	struct grep_opt grep_filter;
	258
	259	/* Display history graph */
	260	struct git_graph *graph;
	261
	262	/* special limits */
	263	int skip_count;
	264	int max_count;
	265	timestamp_t max_age;
	266	timestamp_t min_age;
	267	int min_parents;
	268	int max_parents;
	269	int (include_check)(struct commit , void *);
	270	int (include_check_obj)(struct object obj, void *);
	271	void *include_check_data;
	272
	273	/* diff info for patches and for paths limiting */
	274	struct diff_options diffopt;
	275	struct diff_options pruning;
	276
	277	struct reflog_walk_info *reflog_info;
	278	struct decoration children;
	279	struct decoration merge_simplification;
	280	struct decoration treesame;
	281
	282	/* notes-specific options: which refs to show */
	283	struct display_notes_opt notes_opt;
	284
	285	/* interdiff */
	286	const struct object_id *idiff_oid1;
	287	const struct object_id *idiff_oid2;
	288	const char *idiff_title;
	289
	290	/* range-diff */
	291	const char *rdiff1;
	292	const char *rdiff2;
	293	int creation_factor;
	294	const char *rdiff_title;
	295
	296	/* commit counts */
	297	int count_left;
	298	int count_right;
	299	int count_same;
	300
	301	/* line level range that we are chasing */
	302	struct decoration line_log_data;
	303
	304	/* copies of the parent lists, for --full-diff display */
	305	struct saved_parents *saved_parents_slab;
	306
	307	struct commit_list *previous_parents;
	308	const char *break_bar;
	309
	310	struct revision_sources *sources;
	311
	312	struct topo_walk_info *topo_walk_info;
	313
	314	/* Commit graph bloom filter fields */
	315	/* The bloom filter key(s) for the pathspec */
	316	struct bloom_key *bloom_keys;
	317	int bloom_keys_nr;
	318
	319	/*
	320	* The bloom filter settings used to generate the key.
	321	* This is loaded from the commit-graph being used.
	322	*/
	323	struct bloom_filter_settings *bloom_filter_settings;
	324
	325	/* misc. flags related to '--no-kept-objects' */
	326	unsigned keep_pack_cache_flags;
	327
	328	/* Location where temporary objects for remerge-diff are written. */
	329	struct tmp_objdir *remerge_objdir;
	330	};
	331
	332	int ref_excluded(struct string_list , const char path);
	333	void clear_ref_exclusion(struct string_list **);
	334	void add_ref_exclusion(struct string_list *, const char exclude);
	335
	336
	337	#define REV_TREE_SAME 0
	338	#define REV_TREE_NEW 1 /* Only new files */
	339	#define REV_TREE_OLD 2 /* Only files removed */
	340	#define REV_TREE_DIFFERENT 3 /* Mixed changes */
	341
	342	/* revision.c */
	343	typedef void (show_early_output_fn_t)(struct rev_info , struct commit_list *);
	344	extern volatile show_early_output_fn_t show_early_output;
	345
	346	struct setup_revision_opt {
	347	const char *def;
	348	void (tweak)(struct rev_info , struct setup_revision_opt *);
	349	unsigned int assume_dashdash:1,
	350	allow_exclude_promisor_objects:1;
	351	unsigned revarg_opt;
	352	};
	353
	354	#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
	355	#define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
	356	#endif
	357
	358	/**
	359	* Initialize a rev_info structure with default values. The third parameter may
	360	* be NULL or can be prefix path, and then the `.prefix` variable will be set
	361	* to it. This is typically the first function you want to call when you want
	362	* to deal with a revision list. After calling this function, you are free to
	363	* customize options, like set `.ignore_merges` to 0 if you don't want to
	364	* ignore merges, and so on.
	365	*/
	366	void repo_init_revisions(struct repository *r,
	367	struct rev_info *revs,
	368	const char *prefix);
	369
	370	/**
	371	* Parse revision information, filling in the `rev_info` structure, and
	372	* removing the used arguments from the argument list. Returns the number
	373	* of arguments left that weren't recognized, which are also moved to the
	374	* head of the argument list. The last parameter is used in case no
	375	* parameter given by the first two arguments.
	376	*/
	377	int setup_revisions(int argc, const char *argv, struct rev_info revs,
	378	struct setup_revision_opt *);
	379
	380	void parse_revision_opt(struct rev_info revs, struct parse_opt_ctx_t ctx,
	381	const struct option *options,
	382	const char * const usagestr[]);
	383	#define REVARG_CANNOT_BE_FILENAME 01
	384	#define REVARG_COMMITTISH 02
	385	int handle_revision_arg(const char arg, struct rev_info revs,
	386	int flags, unsigned revarg_opt);
	387	void revision_opts_finish(struct rev_info *revs);
	388
	389	/**
	390	* Reset the flags used by the revision walking api. You can use this to do
	391	* multiple sequential revision walks.
	392	*/
	393	void reset_revision_walk(void);
	394
	395	/**
	396	* Prepares the rev_info structure for a walk. You should check if it returns
	397	* any error (non-zero return code) and if it does not, you can start using
	398	* get_revision() to do the iteration.
	399	*/
	400	int prepare_revision_walk(struct rev_info *revs);
	401
	402	/**
	403	* Takes a pointer to a `rev_info` structure and iterates over it, returning a
	404	* `struct commit *` each time you call it. The end of the revision list is
	405	* indicated by returning a NULL pointer.
	406	*/
	407	struct commit get_revision(struct rev_info revs);
	408
	409	const char get_revision_mark(const struct rev_info revs,
	410	const struct commit *commit);
	411	void put_revision_mark(const struct rev_info *revs,
	412	const struct commit *commit);
	413
	414	void mark_parents_uninteresting(struct rev_info revs, struct commit commit);
	415	void mark_tree_uninteresting(struct repository r, struct tree tree);
	416	void mark_trees_uninteresting_sparse(struct repository r, struct oidset trees);
	417
	418	void show_object_with_name(FILE , struct object , const char *);
	419
	420	/**
	421	* This function can be used if you want to add commit objects as revision
	422	* information. You can use the `UNINTERESTING` object flag to indicate if
	423	* you want to include or exclude the given commit (and commits reachable
	424	* from the given commit) from the revision list.
	425	*
	426	* NOTE: If you have the commits as a string list then you probably want to
	427	* use setup_revisions(), instead of parsing each string and using this
	428	* function.
	429	*/
	430	void add_pending_object(struct rev_info *revs,
	431	struct object obj, const char name);
	432
	433	void add_pending_oid(struct rev_info *revs,
	434	const char name, const struct object_id oid,
	435	unsigned int flags);
	436
	437	void add_head_to_pending(struct rev_info *);
	438	void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
	439	void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
	440
	441	enum commit_action {
	442	commit_ignore,
	443	commit_show,
	444	commit_error
	445	};
	446
	447	enum commit_action get_commit_action(struct rev_info *revs,
	448	struct commit *commit);
	449	enum commit_action simplify_commit(struct rev_info *revs,
	450	struct commit *commit);
	451
	452	enum rewrite_result {
	453	rewrite_one_ok,
	454	rewrite_one_noparents,
	455	rewrite_one_error
	456	};
	457
	458	typedef enum rewrite_result (rewrite_parent_fn_t)(struct rev_info revs, struct commit **pp);
	459
	460	int rewrite_parents(struct rev_info *revs,
	461	struct commit *commit,
	462	rewrite_parent_fn_t rewrite_parent);
	463
	464	/*
	465	* The log machinery saves the original parent list so that
	466	* get_saved_parents() can later tell what the real parents of the
	467	* commits are, when commit->parents has been modified by history
	468	* simpification.
	469	*
	470	* get_saved_parents() will transparently return commit->parents if
	471	* history simplification is off.
	472	*/
	473	struct commit_list get_saved_parents(struct rev_info revs, const struct commit *commit);
	474
	475	#endif