9 #include "commit-slab-decl.h"
12 #include "list-objects-filter-options.h"
16 * The revision walking API offers functions to build a list of revisions
17 * and then iterate over that list.
22 * The walking API has a given calling sequence: first you need to initialize
23 * a rev_info structure, then add revisions to control what kind of revision
24 * list do you want to get, finally you can iterate over the revision list.
28 /* Remember to update object flag allocation in object.h */
30 #define UNINTERESTING (1u<<1)
31 #define TREESAME (1u<<2)
33 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
34 #define BOUNDARY (1u<<5)
35 #define CHILD_SHOWN (1u<<6)
36 #define ADDED (1u<<7) /* Parents already parsed and added? */
37 #define SYMMETRIC_LEFT (1u<<8)
38 #define PATCHSAME (1u<<9)
39 #define BOTTOM (1u<<10)
41 /* WARNING: This is also used as REACHABLE in commit-graph.c. */
42 #define PULL_MERGE (1u<<15)
44 #define TOPO_WALK_EXPLORED (1u<<23)
45 #define TOPO_WALK_INDEGREE (1u<<24)
48 * Indicates object was reached by traversal. i.e. not given by user on
49 * command-line or stdin.
51 #define NOT_USER_GIVEN (1u<<25)
52 #define TRACK_LINEAR (1u<<26)
53 #define ANCESTRY_PATH (1u<<27)
54 #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)
56 #define DECORATE_SHORT_REFS 1
57 #define DECORATE_FULL_REFS 2
65 struct bloom_filter_settings
;
67 struct parse_opt_ctx_t
;
68 define_shared_commit_slab(revision_sources
, char *);
70 struct rev_cmdline_info
{
73 struct rev_cmdline_entry
{
88 struct ref_exclusions
{
90 * Excluded refs is a list of wildmatch patterns. If any of the
91 * patterns match, the reference will be excluded.
93 struct string_list excluded_refs
;
96 * Hidden refs is a list of patterns that is to be hidden via
99 struct strvec hidden_refs
;
102 * Indicates whether hidden refs have been configured. This is to
103 * distinguish between no hidden refs existing and hidden refs not
106 char hidden_refs_configured
;
110 * Initialize a `struct ref_exclusions` with a macro.
112 #define REF_EXCLUSIONS_INIT { \
113 .excluded_refs = STRING_LIST_INIT_DUP, \
114 .hidden_refs = STRVEC_INIT, \
118 struct topo_walk_info
;
122 struct commit_list
*commits
;
123 struct object_array pending
;
124 struct repository
*repo
;
126 /* Parents of shown commits */
127 struct object_array boundary_commits
;
129 /* The end-points specified by the end user */
130 struct rev_cmdline_info cmdline
;
133 * Object filter options. No filtering is specified
134 * if and only if filter.choice is zero.
136 struct list_objects_filter_options filter
;
138 /* excluding from --branches, --refs, etc. expansion */
139 struct ref_exclusions ref_excludes
;
141 /* Basic information */
144 struct pathspec prune_data
;
147 * Whether the arguments parsed by setup_revisions() included any
148 * "input" revisions that might still have yielded an empty pending
149 * list (e.g., patterns like "--all" or "--glob").
154 * Whether we read from stdin due to the --stdin option.
159 enum rev_sort_order sort_order
;
161 unsigned int early_output
;
163 unsigned int ignore_missing
:1,
164 ignore_missing_links
:1;
166 /* Traversal flags */
167 unsigned int dense
:1,
171 remove_empty_trees
:1,
176 simplify_by_decoration
:1,
183 edge_hint_aggressive
:1,
196 reverse_output_stage
:1,
202 /* True if --ancestry-path was specified without an
203 * argument. The bottom revisions are implicitly
204 * the arguments in this case.
206 ancestry_path_implicit_bottoms
:1,
209 exclude_first_parent_only
:1,
210 line_level_traverse
:1,
211 tree_blobs_in_commit_order
:1,
214 * Blobs are shown without regard for their existence.
215 * But not so for trees: unless exclude_promisor_objects
216 * is set and the tree in question is a promisor object;
217 * OR ignore_missing_links is set, the revision walker
218 * dies with a "bad tree object HASH" message when
219 * encountering a missing tree. For callers that can
220 * handle missing trees and want them to be filterable
221 * and showable, set this to true. The revision walker
222 * will filter and show such a missing tree as usual,
223 * but will not attempt to recurse into this tree
226 do_not_die_on_missing_tree
:1,
228 /* for internal use only */
229 exclude_promisor_objects
:1;
238 always_show_header
:1,
239 /* Diff-merge flags */
240 explicit_diff_merges
: 1,
242 merges_imply_patch
:1,
245 combined_all_paths
:1,
246 dense_combined_merges
:1,
247 first_parent_merges
:1,
252 unsigned int shown_one
:1,
259 abbrev_commit_given
:1,
263 date_mode_explicit
:1,
265 force_in_body_from
:1,
266 encode_email_headers
:1,
268 unsigned int disable_stdin
:1;
269 /* --show-linear-break */
270 unsigned int track_linear
:1,
274 struct date_mode date_mode
;
275 int expand_tabs_in_log
; /* unset if negative */
276 int expand_tabs_in_log_default
;
279 enum cmit_fmt commit_format
;
280 struct log_info
*loginfo
;
282 const char *mime_boundary
;
283 const char *patch_suffix
;
285 const char *reroll_count
;
287 struct ident_split from_ident
;
288 struct string_list
*ref_message_ids
;
290 const char *extra_headers
;
291 const char *log_reencode
;
292 const char *subject_prefix
;
296 struct string_list
*mailmap
;
298 /* Filter by commit log message */
299 struct grep_opt grep_filter
;
301 /* Display history graph */
302 struct git_graph
*graph
;
308 timestamp_t max_age_as_filter
;
312 int (*include_check
)(struct commit
*, void *);
313 int (*include_check_obj
)(struct object
*obj
, void *);
314 void *include_check_data
;
316 /* diff info for patches and for paths limiting */
317 struct diff_options diffopt
;
318 struct diff_options pruning
;
320 struct reflog_walk_info
*reflog_info
;
321 struct decoration children
;
322 struct decoration merge_simplification
;
323 struct decoration treesame
;
325 /* notes-specific options: which refs to show */
326 struct display_notes_opt notes_opt
;
329 const struct object_id
*idiff_oid1
;
330 const struct object_id
*idiff_oid2
;
331 const char *idiff_title
;
337 const char *rdiff_title
;
344 /* line level range that we are chasing */
345 struct decoration line_log_data
;
347 /* copies of the parent lists, for --full-diff display */
348 struct saved_parents
*saved_parents_slab
;
350 struct commit_list
*previous_parents
;
351 struct commit_list
*ancestry_path_bottoms
;
352 const char *break_bar
;
354 struct revision_sources
*sources
;
356 struct topo_walk_info
*topo_walk_info
;
358 /* Commit graph bloom filter fields */
359 /* The bloom filter key(s) for the pathspec */
360 struct bloom_key
*bloom_keys
;
364 * The bloom filter settings used to generate the key.
365 * This is loaded from the commit-graph being used.
367 struct bloom_filter_settings
*bloom_filter_settings
;
369 /* misc. flags related to '--no-kept-objects' */
370 unsigned keep_pack_cache_flags
;
372 /* Location where temporary objects for remerge-diff are written. */
373 struct tmp_objdir
*remerge_objdir
;
377 * Initialize the "struct rev_info" structure with a macro.
379 * This will not fully initialize a "struct rev_info", the
380 * repo_init_revisions() function needs to be called before
381 * setup_revisions() and any revision walking takes place.
383 * Use REV_INFO_INIT to make the "struct rev_info" safe for passing to
384 * release_revisions() when it's inconvenient (e.g. due to a "goto
385 * cleanup" pattern) to arrange for repo_init_revisions() to be called
386 * before release_revisions() is called.
388 * Initializing with this REV_INFO_INIT is redundant to invoking
389 * repo_init_revisions(). If repo_init_revisions() is guaranteed to be
390 * called before release_revisions() the "struct rev_info" can be left
393 #define REV_INFO_INIT { \
394 .abbrev = DEFAULT_ABBREV, \
395 .simplify_history = 1, \
396 .pruning.flags.recursive = 1, \
397 .pruning.flags.quick = 1, \
398 .sort_order = REV_SORT_IN_GRAPH_ORDER, \
401 .max_age_as_filter = -1, \
406 .expand_tabs_in_log = -1, \
407 .commit_format = CMIT_FMT_DEFAULT, \
408 .expand_tabs_in_log_default = 8, \
412 * Initialize a rev_info structure with default values. The third parameter may
413 * be NULL or can be prefix path, and then the `.prefix` variable will be set
414 * to it. This is typically the first function you want to call when you want
415 * to deal with a revision list. After calling this function, you are free to
416 * customize options, like set `.ignore_merges` to 0 if you don't want to
417 * ignore merges, and so on.
419 void repo_init_revisions(struct repository
*r
,
420 struct rev_info
*revs
,
424 * Parse revision information, filling in the `rev_info` structure, and
425 * removing the used arguments from the argument list. Returns the number
426 * of arguments left that weren't recognized, which are also moved to the
427 * head of the argument list. The last parameter is used in case no
428 * parameter given by the first two arguments.
430 struct setup_revision_opt
{
432 void (*tweak
)(struct rev_info
*, struct setup_revision_opt
*);
433 unsigned int assume_dashdash
:1,
434 allow_exclude_promisor_objects
:1,
435 free_removed_argv_elements
:1;
438 int setup_revisions(int argc
, const char **argv
, struct rev_info
*revs
,
439 struct setup_revision_opt
*);
442 * Free data allocated in a "struct rev_info" after it's been
443 * initialized with repo_init_revisions() or REV_INFO_INIT.
445 void release_revisions(struct rev_info
*revs
);
447 void parse_revision_opt(struct rev_info
*revs
, struct parse_opt_ctx_t
*ctx
,
448 const struct option
*options
,
449 const char * const usagestr
[]);
450 #define REVARG_CANNOT_BE_FILENAME 01
451 #define REVARG_COMMITTISH 02
452 int handle_revision_arg(const char *arg
, struct rev_info
*revs
,
453 int flags
, unsigned revarg_opt
);
454 void revision_opts_finish(struct rev_info
*revs
);
457 * Reset the flags used by the revision walking api. You can use this to do
458 * multiple sequential revision walks.
460 void reset_revision_walk(void);
463 * Prepares the rev_info structure for a walk. You should check if it returns
464 * any error (non-zero return code) and if it does not, you can start using
465 * get_revision() to do the iteration.
467 int prepare_revision_walk(struct rev_info
*revs
);
470 * Takes a pointer to a `rev_info` structure and iterates over it, returning a
471 * `struct commit *` each time you call it. The end of the revision list is
472 * indicated by returning a NULL pointer.
474 struct commit
*get_revision(struct rev_info
*revs
);
476 const char *get_revision_mark(const struct rev_info
*revs
,
477 const struct commit
*commit
);
478 void put_revision_mark(const struct rev_info
*revs
,
479 const struct commit
*commit
);
481 void mark_parents_uninteresting(struct rev_info
*revs
, struct commit
*commit
);
482 void mark_tree_uninteresting(struct repository
*r
, struct tree
*tree
);
483 void mark_trees_uninteresting_sparse(struct repository
*r
, struct oidset
*trees
);
485 void show_object_with_name(FILE *, struct object
*, const char *);
488 * Helpers to check if a reference should be excluded.
491 int ref_excluded(const struct ref_exclusions
*exclusions
, const char *path
);
492 void init_ref_exclusions(struct ref_exclusions
*);
493 void clear_ref_exclusions(struct ref_exclusions
*);
494 void add_ref_exclusion(struct ref_exclusions
*, const char *exclude
);
495 void exclude_hidden_refs(struct ref_exclusions
*, const char *section
);
498 * This function can be used if you want to add commit objects as revision
499 * information. You can use the `UNINTERESTING` object flag to indicate if
500 * you want to include or exclude the given commit (and commits reachable
501 * from the given commit) from the revision list.
503 * NOTE: If you have the commits as a string list then you probably want to
504 * use setup_revisions(), instead of parsing each string and using this
507 void add_pending_object(struct rev_info
*revs
,
508 struct object
*obj
, const char *name
);
510 void add_pending_oid(struct rev_info
*revs
,
511 const char *name
, const struct object_id
*oid
,
514 void add_head_to_pending(struct rev_info
*);
515 void add_reflogs_to_pending(struct rev_info
*, unsigned int flags
);
516 void add_index_objects_to_pending(struct rev_info
*, unsigned int flags
);
524 enum commit_action
get_commit_action(struct rev_info
*revs
,
525 struct commit
*commit
);
526 enum commit_action
simplify_commit(struct rev_info
*revs
,
527 struct commit
*commit
);
529 enum rewrite_result
{
531 rewrite_one_noparents
,
535 typedef enum rewrite_result (*rewrite_parent_fn_t
)(struct rev_info
*revs
, struct commit
**pp
);
537 int rewrite_parents(struct rev_info
*revs
,
538 struct commit
*commit
,
539 rewrite_parent_fn_t rewrite_parent
);
542 * The log machinery saves the original parent list so that
543 * get_saved_parents() can later tell what the real parents of the
544 * commits are, when commit->parents has been modified by history
547 * get_saved_parents() will transparently return commit->parents if
548 * history simplification is off.
550 struct commit_list
*get_saved_parents(struct rev_info
*revs
, const struct commit
*commit
);
553 * Global for the (undocumented) "--early-output" flag for "git log".
555 typedef void (*show_early_output_fn_t
)(struct rev_info
*, struct commit_list
*);
556 extern volatile show_early_output_fn_t show_early_output
;