5 #include "parse-options.h"
10 #include "commit-slab-decl.h"
13 * The revision walking API offers functions to build a list of revisions
14 * and then iterate over that list.
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.
25 /* Remember to update object flag allocation in object.h */
27 #define UNINTERESTING (1u<<1)
28 #define TREESAME (1u<<2)
30 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
31 #define BOUNDARY (1u<<5)
32 #define CHILD_SHOWN (1u<<6)
33 #define ADDED (1u<<7) /* Parents already parsed and added? */
34 #define SYMMETRIC_LEFT (1u<<8)
35 #define PATCHSAME (1u<<9)
36 #define BOTTOM (1u<<10)
38 /* WARNING: This is also used as REACHABLE in commit-graph.c. */
39 #define PULL_MERGE (1u<<15)
41 #define TOPO_WALK_EXPLORED (1u<<23)
42 #define TOPO_WALK_INDEGREE (1u<<24)
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
51 #define NOT_USER_GIVEN (1u<<25)
52 #define TRACK_LINEAR (1u<<26)
53 #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)
55 #define DECORATE_SHORT_REFS 1
56 #define DECORATE_FULL_REFS 2
64 struct bloom_filter_settings;
65 define_shared_commit_slab(revision_sources, char *);
67 struct rev_cmdline_info {
70 struct rev_cmdline_entry {
85 #define REVISION_WALK_WALK 0
86 #define REVISION_WALK_NO_WALK_SORTED 1
87 #define REVISION_WALK_NO_WALK_UNSORTED 2
90 struct topo_walk_info;
94 struct commit_list *commits;
95 struct object_array pending;
96 struct repository *repo;
98 /* Parents of shown commits */
99 struct object_array boundary_commits;
101 /* The end-points specified by the end user */
102 struct rev_cmdline_info cmdline;
104 /* excluding from --branches, --refs, etc. expansion */
105 struct string_list *ref_excludes;
107 /* Basic information */
110 struct pathspec prune_data;
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").
120 * Whether we read from stdin due to the --stdin option.
125 enum rev_sort_order sort_order;
127 unsigned int early_output;
129 unsigned int ignore_missing:1,
130 ignore_missing_links:1;
132 /* Traversal flags */
133 unsigned int dense:1,
136 remove_empty_trees:1,
141 simplify_by_decoration:1,
148 edge_hint_aggressive:1,
160 reverse_output_stage:1,
166 line_level_traverse:1,
167 tree_blobs_in_commit_order:1,
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
182 do_not_die_on_missing_tree:1,
184 /* for internal use only */
185 exclude_promisor_objects:1;
194 always_show_header:1,
195 /* Diff-merge flags */
196 explicit_diff_merges: 1,
199 combined_all_paths:1,
200 dense_combined_merges:1,
201 first_parent_merges:1;
205 unsigned int shown_one:1,
212 abbrev_commit_given:1,
216 date_mode_explicit:1,
218 encode_email_headers:1;
219 unsigned int disable_stdin:1;
220 /* --show-linear-break */
221 unsigned int track_linear:1,
225 struct date_mode date_mode;
226 int expand_tabs_in_log; /* unset if negative */
227 int expand_tabs_in_log_default;
230 enum cmit_fmt commit_format;
231 struct log_info *loginfo;
233 const char *mime_boundary;
234 const char *patch_suffix;
238 struct ident_split from_ident;
239 struct string_list *ref_message_ids;
241 const char *extra_headers;
242 const char *log_reencode;
243 const char *subject_prefix;
246 struct string_list *mailmap;
248 /* Filter by commit log message */
249 struct grep_opt grep_filter;
250 /* Negate the match of grep_filter */
253 /* Display history graph */
254 struct git_graph *graph;
263 int (*include_check)(struct commit *, void *);
264 void *include_check_data;
266 /* diff info for patches and for paths limiting */
267 struct diff_options diffopt;
268 struct diff_options pruning;
270 struct reflog_walk_info *reflog_info;
271 struct decoration children;
272 struct decoration merge_simplification;
273 struct decoration treesame;
275 /* notes-specific options: which refs to show */
276 struct display_notes_opt notes_opt;
279 const struct object_id *idiff_oid1;
280 const struct object_id *idiff_oid2;
281 const char *idiff_title;
287 const char *rdiff_title;
294 /* line level range that we are chasing */
295 struct decoration line_log_data;
297 /* copies of the parent lists, for --full-diff display */
298 struct saved_parents *saved_parents_slab;
300 struct commit_list *previous_parents;
301 const char *break_bar;
303 struct revision_sources *sources;
305 struct topo_walk_info *topo_walk_info;
307 /* Commit graph bloom filter fields */
308 /* The bloom filter key(s) for the pathspec */
309 struct bloom_key *bloom_keys;
313 * The bloom filter settings used to generate the key.
314 * This is loaded from the commit-graph being used.
316 struct bloom_filter_settings *bloom_filter_settings;
319 int ref_excluded(struct string_list *, const char *path);
320 void clear_ref_exclusion(struct string_list **);
321 void add_ref_exclusion(struct string_list **, const char *exclude);
324 #define REV_TREE_SAME 0
325 #define REV_TREE_NEW 1 /* Only new files */
326 #define REV_TREE_OLD 2 /* Only files removed */
327 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
330 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
331 extern volatile show_early_output_fn_t show_early_output;
333 struct setup_revision_opt {
335 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
336 const char *submodule; /* TODO: drop this and use rev_info->repo */
337 unsigned int assume_dashdash:1,
338 allow_exclude_promisor_objects:1;
342 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
343 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
347 * Initialize a rev_info structure with default values. The third parameter may
348 * be NULL or can be prefix path, and then the `.prefix` variable will be set
349 * to it. This is typically the first function you want to call when you want
350 * to deal with a revision list. After calling this function, you are free to
351 * customize options, like set `.ignore_merges` to 0 if you don't want to
352 * ignore merges, and so on.
354 void repo_init_revisions(struct repository *r,
355 struct rev_info *revs,
359 * Parse revision information, filling in the `rev_info` structure, and
360 * removing the used arguments from the argument list. Returns the number
361 * of arguments left that weren't recognized, which are also moved to the
362 * head of the argument list. The last parameter is used in case no
363 * parameter given by the first two arguments.
365 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
366 struct setup_revision_opt *);
368 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
369 const struct option *options,
370 const char * const usagestr[]);
371 #define REVARG_CANNOT_BE_FILENAME 01
372 #define REVARG_COMMITTISH 02
373 int handle_revision_arg(const char *arg, struct rev_info *revs,
374 int flags, unsigned revarg_opt);
377 * Reset the flags used by the revision walking api. You can use this to do
378 * multiple sequential revision walks.
380 void reset_revision_walk(void);
383 * Prepares the rev_info structure for a walk. You should check if it returns
384 * any error (non-zero return code) and if it does not, you can start using
385 * get_revision() to do the iteration.
387 int prepare_revision_walk(struct rev_info *revs);
390 * Takes a pointer to a `rev_info` structure and iterates over it, returning a
391 * `struct commit *` each time you call it. The end of the revision list is
392 * indicated by returning a NULL pointer.
394 struct commit *get_revision(struct rev_info *revs);
396 const char *get_revision_mark(const struct rev_info *revs,
397 const struct commit *commit);
398 void put_revision_mark(const struct rev_info *revs,
399 const struct commit *commit);
401 void mark_parents_uninteresting(struct commit *commit);
402 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
403 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
405 void show_object_with_name(FILE *, struct object *, const char *);
408 * This function can be used if you want to add commit objects as revision
409 * information. You can use the `UNINTERESTING` object flag to indicate if
410 * you want to include or exclude the given commit (and commits reachable
411 * from the given commit) from the revision list.
413 * NOTE: If you have the commits as a string list then you probably want to
414 * use setup_revisions(), instead of parsing each string and using this
417 void add_pending_object(struct rev_info *revs,
418 struct object *obj, const char *name);
420 void add_pending_oid(struct rev_info *revs,
421 const char *name, const struct object_id *oid,
424 void add_head_to_pending(struct rev_info *);
425 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
426 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
434 enum commit_action get_commit_action(struct rev_info *revs,
435 struct commit *commit);
436 enum commit_action simplify_commit(struct rev_info *revs,
437 struct commit *commit);
439 enum rewrite_result {
441 rewrite_one_noparents,
445 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
447 int rewrite_parents(struct rev_info *revs,
448 struct commit *commit,
449 rewrite_parent_fn_t rewrite_parent);
452 * The log machinery saves the original parent list so that
453 * get_saved_parents() can later tell what the real parents of the
454 * commits are, when commit->parents has been modified by history
457 * get_saved_parents() will transparently return commit->parents if
458 * history simplification is off.
460 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);