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 * Indicates object was reached by traversal. i.e. not given by user on
39 * command-line or stdin.
40 * NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support
41 * filtering trees and blobs, but it may be useful to support filtering commits
44 #define NOT_USER_GIVEN (1u<<25)
45 #define TRACK_LINEAR (1u<<26)
46 #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR)
48 #define TOPO_WALK_EXPLORED (1u<<27)
49 #define TOPO_WALK_INDEGREE (1u<<28)
51 #define DECORATE_SHORT_REFS 1
52 #define DECORATE_FULL_REFS 2
59 define_shared_commit_slab(revision_sources, char *);
61 struct rev_cmdline_info {
64 struct rev_cmdline_entry {
79 #define REVISION_WALK_WALK 0
80 #define REVISION_WALK_NO_WALK_SORTED 1
81 #define REVISION_WALK_NO_WALK_UNSORTED 2
84 struct topo_walk_info;
88 struct commit_list *commits;
89 struct object_array pending;
90 struct repository *repo;
92 /* Parents of shown commits */
93 struct object_array boundary_commits;
95 /* The end-points specified by the end user */
96 struct rev_cmdline_info cmdline;
98 /* excluding from --branches, --refs, etc. expansion */
99 struct string_list *ref_excludes;
101 /* Basic information */
104 struct pathspec prune_data;
107 * Whether the arguments parsed by setup_revisions() included any
108 * "input" revisions that might still have yielded an empty pending
109 * list (e.g., patterns like "--all" or "--glob").
114 * Whether we read from stdin due to the --stdin option.
119 enum rev_sort_order sort_order;
121 unsigned int early_output;
123 unsigned int ignore_missing:1,
124 ignore_missing_links:1;
126 /* Traversal flags */
127 unsigned int dense:1,
130 remove_empty_trees:1,
134 simplify_by_decoration:1,
141 edge_hint_aggressive:1,
153 reverse_output_stage:1,
159 line_level_traverse:1,
160 tree_blobs_in_commit_order:1,
163 * Blobs are shown without regard for their existence.
164 * But not so for trees: unless exclude_promisor_objects
165 * is set and the tree in question is a promisor object;
166 * OR ignore_missing_links is set, the revision walker
167 * dies with a "bad tree object HASH" message when
168 * encountering a missing tree. For callers that can
169 * handle missing trees and want them to be filterable
170 * and showable, set this to true. The revision walker
171 * will filter and show such a missing tree as usual,
172 * but will not attempt to recurse into this tree
175 do_not_die_on_missing_tree:1,
177 /* for internal use only */
178 exclude_promisor_objects:1;
188 combined_all_paths:1,
189 dense_combined_merges:1,
190 always_show_header:1;
194 unsigned int shown_one:1,
201 abbrev_commit_given:1,
205 date_mode_explicit:1,
207 unsigned int disable_stdin:1;
208 /* --show-linear-break */
209 unsigned int track_linear:1,
213 struct date_mode date_mode;
214 int expand_tabs_in_log; /* unset if negative */
215 int expand_tabs_in_log_default;
218 enum cmit_fmt commit_format;
219 struct log_info *loginfo;
221 const char *mime_boundary;
222 const char *patch_suffix;
226 struct ident_split from_ident;
227 struct string_list *ref_message_ids;
229 const char *extra_headers;
230 const char *log_reencode;
231 const char *subject_prefix;
234 struct string_list *mailmap;
236 /* Filter by commit log message */
237 struct grep_opt grep_filter;
238 /* Negate the match of grep_filter */
241 /* Display history graph */
242 struct git_graph *graph;
251 int (*include_check)(struct commit *, void *);
252 void *include_check_data;
254 /* diff info for patches and for paths limiting */
255 struct diff_options diffopt;
256 struct diff_options pruning;
258 struct reflog_walk_info *reflog_info;
259 struct decoration children;
260 struct decoration merge_simplification;
261 struct decoration treesame;
263 /* notes-specific options: which refs to show */
264 struct display_notes_opt notes_opt;
267 const struct object_id *idiff_oid1;
268 const struct object_id *idiff_oid2;
269 const char *idiff_title;
275 const char *rdiff_title;
282 /* line level range that we are chasing */
283 struct decoration line_log_data;
285 /* copies of the parent lists, for --full-diff display */
286 struct saved_parents *saved_parents_slab;
288 struct commit_list *previous_parents;
289 const char *break_bar;
291 struct revision_sources *sources;
293 struct topo_walk_info *topo_walk_info;
296 int ref_excluded(struct string_list *, const char *path);
297 void clear_ref_exclusion(struct string_list **);
298 void add_ref_exclusion(struct string_list **, const char *exclude);
301 #define REV_TREE_SAME 0
302 #define REV_TREE_NEW 1 /* Only new files */
303 #define REV_TREE_OLD 2 /* Only files removed */
304 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
307 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
308 extern volatile show_early_output_fn_t show_early_output;
310 struct setup_revision_opt {
312 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
313 const char *submodule; /* TODO: drop this and use rev_info->repo */
314 unsigned int assume_dashdash:1,
315 allow_exclude_promisor_objects:1;
319 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
320 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
324 * Initialize a rev_info structure with default values. The third parameter may
325 * be NULL or can be prefix path, and then the `.prefix` variable will be set
326 * to it. This is typically the first function you want to call when you want
327 * to deal with a revision list. After calling this function, you are free to
328 * customize options, like set `.ignore_merges` to 0 if you don't want to
329 * ignore merges, and so on.
331 void repo_init_revisions(struct repository *r,
332 struct rev_info *revs,
336 * Parse revision information, filling in the `rev_info` structure, and
337 * removing the used arguments from the argument list. Returns the number
338 * of arguments left that weren't recognized, which are also moved to the
339 * head of the argument list. The last parameter is used in case no
340 * parameter given by the first two arguments.
342 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
343 struct setup_revision_opt *);
345 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
346 const struct option *options,
347 const char * const usagestr[]);
348 #define REVARG_CANNOT_BE_FILENAME 01
349 #define REVARG_COMMITTISH 02
350 int handle_revision_arg(const char *arg, struct rev_info *revs,
351 int flags, unsigned revarg_opt);
354 * Reset the flags used by the revision walking api. You can use this to do
355 * multiple sequential revision walks.
357 void reset_revision_walk(void);
360 * Prepares the rev_info structure for a walk. You should check if it returns
361 * any error (non-zero return code) and if it does not, you can start using
362 * get_revision() to do the iteration.
364 int prepare_revision_walk(struct rev_info *revs);
367 * Takes a pointer to a `rev_info` structure and iterates over it, returning a
368 * `struct commit *` each time you call it. The end of the revision list is
369 * indicated by returning a NULL pointer.
371 struct commit *get_revision(struct rev_info *revs);
373 const char *get_revision_mark(const struct rev_info *revs,
374 const struct commit *commit);
375 void put_revision_mark(const struct rev_info *revs,
376 const struct commit *commit);
378 void mark_parents_uninteresting(struct commit *commit);
379 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
380 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
382 void show_object_with_name(FILE *, struct object *, const char *);
385 * This function can be used if you want to add commit objects as revision
386 * information. You can use the `UNINTERESTING` object flag to indicate if
387 * you want to include or exclude the given commit (and commits reachable
388 * from the given commit) from the revision list.
390 * NOTE: If you have the commits as a string list then you probably want to
391 * use setup_revisions(), instead of parsing each string and using this
394 void add_pending_object(struct rev_info *revs,
395 struct object *obj, const char *name);
397 void add_pending_oid(struct rev_info *revs,
398 const char *name, const struct object_id *oid,
401 void add_head_to_pending(struct rev_info *);
402 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
403 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
411 enum commit_action get_commit_action(struct rev_info *revs,
412 struct commit *commit);
413 enum commit_action simplify_commit(struct rev_info *revs,
414 struct commit *commit);
416 enum rewrite_result {
418 rewrite_one_noparents,
422 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
424 int rewrite_parents(struct rev_info *revs,
425 struct commit *commit,
426 rewrite_parent_fn_t rewrite_parent);
429 * The log machinery saves the original parent list so that
430 * get_saved_parents() can later tell what the real parents of the
431 * commits are, when commit->parents has been modified by history
434 * get_saved_parents() will transparently return commit->parents if
435 * history simplification is off.
437 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);