revision.h 9.82 KB
Newer Older
1 2 3
#ifndef REVISION_H
#define REVISION_H

4
#include "commit.h"
5
#include "parse-options.h"
Jeff King's avatar
Jeff King committed
6
#include "grep.h"
7
#include "notes.h"
8
#include "pretty.h"
9
#include "diff.h"
10
#include "commit-slab-decl.h"
11

12
/* Remember to update object flag allocation in object.h */
13 14
#define SEEN		(1u<<0)
#define UNINTERESTING   (1u<<1)
15
#define TREESAME	(1u<<2)
16
#define SHOWN		(1u<<3)
17
#define TMP_MARK	(1u<<4) /* for isolated cases; clean after use */
Junio C Hamano's avatar
Junio C Hamano committed
18
#define BOUNDARY	(1u<<5)
19
#define CHILD_SHOWN	(1u<<6)
20
#define ADDED		(1u<<7)	/* Parents already parsed and added? */
Junio C Hamano's avatar
Junio C Hamano committed
21
#define SYMMETRIC_LEFT	(1u<<8)
22
#define PATCHSAME	(1u<<9)
23
#define BOTTOM		(1u<<10)
24 25 26 27 28 29 30 31
/*
 * 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)
32
#define TRACK_LINEAR	(1u<<26)
33
#define ALL_REV_FLAGS	(((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR)
34

35 36
#define TOPO_WALK_EXPLORED	(1u<<27)
#define TOPO_WALK_INDEGREE	(1u<<28)
37

38 39 40
#define DECORATE_SHORT_REFS	1
#define DECORATE_FULL_REFS	2

41
struct log_info;
42 43
struct repository;
struct rev_info;
44
struct string_list;
45
struct saved_parents;
46
define_shared_commit_slab(revision_sources, char *);
47

48 49 50 51 52 53 54 55 56 57 58
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,
59
			REV_CMD_MERGE_BASE,
60 61 62 63 64 65
			REV_CMD_REV
		} whence;
		unsigned flags;
	} *rev;
};

66 67 68 69
#define REVISION_WALK_WALK 0
#define REVISION_WALK_NO_WALK_SORTED 1
#define REVISION_WALK_NO_WALK_UNSORTED 2

70
struct oidset;
71 72
struct topo_walk_info;

73 74 75
struct rev_info {
	/* Starting list */
	struct commit_list *commits;
76
	struct object_array pending;
77
	struct repository *repo;
78

79 80 81
	/* Parents of shown commits */
	struct object_array boundary_commits;

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

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

88 89
	/* Basic information */
	const char *prefix;
90
	const char *def;
91
	struct pathspec prune_data;
92

93 94 95 96 97 98 99
	/*
	 * 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;

100 101 102 103 104
	/*
	 * Whether we read from stdin due to the --stdin option.
	 */
	int read_from_stdin;

105 106 107
	/* topo-sort */
	enum rev_sort_order sort_order;

108 109 110
	unsigned int early_output;

	unsigned int	ignore_missing:1,
111
			ignore_missing_links:1;
112

113 114
	/* Traversal flags */
	unsigned int	dense:1,
115
			prune:1,
116
			no_walk:2,
117
			remove_empty_trees:1,
118
			simplify_history:1,
119
			topo_order:1,
120
			simplify_merges:1,
121
			simplify_by_decoration:1,
122
			single_worktree:1,
123 124 125
			tag_objects:1,
			tree_objects:1,
			blob_objects:1,
126
			verify_objects:1,
127
			edge_hint:1,
128
			edge_hint_aggressive:1,
129
			limited:1,
Junio C Hamano's avatar
Junio C Hamano committed
130
			unpacked:1,
131
			boundary:2,
132
			count:1,
133
			left_right:1,
134 135
			left_only:1,
			right_only:1,
136 137
			rewrite_parents:1,
			print_parents:1,
138
			show_decorations:1,
139
			reverse:1,
140
			reverse_output_stage:1,
141
			cherry_pick:1,
142
			cherry_mark:1,
143
			bisect:1,
144
			ancestry_path:1,
145
			first_parent_only:1,
146
			line_level_traverse:1,
147
			tree_blobs_in_commit_order:1,
148

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
			/*
			 * 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,

164 165
			/* for internal use only */
			exclude_promisor_objects:1;
166

167 168 169 170 171 172 173 174 175 176 177 178
	/* 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 */
179
	unsigned int	shown_one:1,
180
			shown_dashes:1,
181
			show_merge:1,
182 183
			show_notes:1,
			show_notes_given:1,
Junio C Hamano's avatar
Junio C Hamano committed
184
			show_signature:1,
185
			pretty_given:1,
186
			abbrev_commit:1,
187
			abbrev_commit_given:1,
188
			zero_commit:1,
189
			use_terminator:1,
190
			missing_newline:1,
191 192
			date_mode_explicit:1,
			preserve_subject:1;
193
	unsigned int	disable_stdin:1;
194 195 196 197
	/* --show-linear-break */
	unsigned int	track_linear:1,
			track_first_time:1,
			linear:1;
198

199
	struct date_mode date_mode;
200 201
	int		expand_tabs_in_log; /* unset if negative */
	int		expand_tabs_in_log_default;
202

203 204
	unsigned int	abbrev;
	enum cmit_fmt	commit_format;
205
	struct log_info *loginfo;
206
	int		nr, total;
207
	const char	*mime_boundary;
208 209
	const char	*patch_suffix;
	int		numbered_files;
210
	int		reroll_count;
211
	char		*message_id;
212
	struct ident_split from_ident;
213
	struct string_list *ref_message_ids;
214
	int		add_signoff;
215
	const char	*extra_headers;
216
	const char	*log_reencode;
217
	const char	*subject_prefix;
218
	int		no_inline;
219
	int		show_log_size;
220
	struct string_list *mailmap;
221

222
	/* Filter by commit log message */
Jeff King's avatar
Jeff King committed
223
	struct grep_opt	grep_filter;
224 225
	/* Negate the match of grep_filter */
	int invert_grep;
226

227 228 229
	/* Display history graph */
	struct git_graph *graph;

230
	/* special limits */
Junio C Hamano's avatar
Junio C Hamano committed
231
	int skip_count;
232
	int max_count;
233 234
	timestamp_t max_age;
	timestamp_t min_age;
235 236
	int min_parents;
	int max_parents;
237 238
	int (*include_check)(struct commit *, void *);
	void *include_check_data;
239

240
	/* diff info for patches and for paths limiting */
241
	struct diff_options diffopt;
242
	struct diff_options pruning;
243

244
	struct reflog_walk_info *reflog_info;
245
	struct decoration children;
246
	struct decoration merge_simplification;
247
	struct decoration treesame;
248 249 250

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

252 253 254
	/* interdiff */
	const struct object_id *idiff_oid1;
	const struct object_id *idiff_oid2;
255
	const char *idiff_title;
256

257 258 259 260
	/* range-diff */
	const char *rdiff1;
	const char *rdiff2;
	int creation_factor;
261
	const char *rdiff_title;
262

263 264 265
	/* commit counts */
	int count_left;
	int count_right;
266
	int count_same;
267 268 269

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

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

	struct commit_list *previous_parents;
	const char *break_bar;
276 277

	struct revision_sources *sources;
278 279

	struct topo_walk_info *topo_walk_info;
280 281
};

282
int ref_excluded(struct string_list *, const char *path);
283 284 285 286
void clear_ref_exclusion(struct string_list **);
void add_ref_exclusion(struct string_list **, const char *exclude);


287
#define REV_TREE_SAME		0
288 289 290
#define REV_TREE_NEW		1	/* Only new files */
#define REV_TREE_OLD		2	/* Only files removed */
#define REV_TREE_DIFFERENT	3	/* Mixed changes */
291

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

296 297
struct setup_revision_opt {
	const char *def;
298
	void (*tweak)(struct rev_info *, struct setup_revision_opt *);
299
	const char *submodule;	/* TODO: drop this and use rev_info->repo */
300 301
	unsigned int	assume_dashdash:1,
			allow_exclude_promisor_objects:1;
302
	unsigned revarg_opt;
303 304
};

305 306 307 308 309 310
#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
#define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
#endif
void repo_init_revisions(struct repository *r,
			 struct rev_info *revs,
			 const char *prefix);
311 312 313 314 315
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[]);
316
#define REVARG_CANNOT_BE_FILENAME 01
317
#define REVARG_COMMITTISH 02
318 319
int handle_revision_arg(const char *arg, struct rev_info *revs,
			int flags, unsigned revarg_opt);
320

321 322 323 324 325 326 327
void reset_revision_walk(void);
int prepare_revision_walk(struct rev_info *revs);
struct commit *get_revision(struct rev_info *revs);
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);
328

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

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

335 336 337 338 339
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);
340

341 342 343
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);
344

345 346 347 348 349 350
enum commit_action {
	commit_ignore,
	commit_show,
	commit_error
};

351 352 353 354
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);
355

356 357 358 359 360 361 362 363
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);

364 365 366
int rewrite_parents(struct rev_info *revs,
		    struct commit *commit,
		    rewrite_parent_fn_t rewrite_parent);
367 368

/*
369 370 371 372
 * 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.
373 374 375 376
 *
 * get_saved_parents() will transparently return commit->parents if
 * history simplification is off.
 */
377
struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
378

379
#endif