Git 2.27-rc2
[git.git] / revision.h
blob93491b79d475adb32414008558d0d94ec9240d56
1 #ifndef REVISION_H
2 #define REVISION_H
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"
12 /**
13 * The revision walking API offers functions to build a list of revisions
14 * and then iterate over that list.
16 * Calling sequence
17 * ----------------
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 */
26 #define SEEN (1u<<0)
27 #define UNINTERESTING (1u<<1)
28 #define TREESAME (1u<<2)
29 #define SHOWN (1u<<3)
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 * Indicates object was reached by traversal. i.e. not given by user on
42 * command-line or stdin.
43 * NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support
44 * filtering trees and blobs, but it may be useful to support filtering commits
45 * in the future.
47 #define NOT_USER_GIVEN (1u<<25)
48 #define TRACK_LINEAR (1u<<26)
49 #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)
51 #define TOPO_WALK_EXPLORED (1u<<27)
52 #define TOPO_WALK_INDEGREE (1u<<28)
54 #define DECORATE_SHORT_REFS 1
55 #define DECORATE_FULL_REFS 2
57 struct log_info;
58 struct repository;
59 struct rev_info;
60 struct string_list;
61 struct saved_parents;
62 struct bloom_key;
63 struct bloom_filter_settings;
64 define_shared_commit_slab(revision_sources, char *);
66 struct rev_cmdline_info {
67 unsigned int nr;
68 unsigned int alloc;
69 struct rev_cmdline_entry {
70 struct object *item;
71 const char *name;
72 enum {
73 REV_CMD_REF,
74 REV_CMD_PARENTS_ONLY,
75 REV_CMD_LEFT,
76 REV_CMD_RIGHT,
77 REV_CMD_MERGE_BASE,
78 REV_CMD_REV
79 } whence;
80 unsigned flags;
81 } *rev;
84 #define REVISION_WALK_WALK 0
85 #define REVISION_WALK_NO_WALK_SORTED 1
86 #define REVISION_WALK_NO_WALK_UNSORTED 2
88 struct oidset;
89 struct topo_walk_info;
91 struct rev_info {
92 /* Starting list */
93 struct commit_list *commits;
94 struct object_array pending;
95 struct repository *repo;
97 /* Parents of shown commits */
98 struct object_array boundary_commits;
100 /* The end-points specified by the end user */
101 struct rev_cmdline_info cmdline;
103 /* excluding from --branches, --refs, etc. expansion */
104 struct string_list *ref_excludes;
106 /* Basic information */
107 const char *prefix;
108 const char *def;
109 struct pathspec prune_data;
112 * Whether the arguments parsed by setup_revisions() included any
113 * "input" revisions that might still have yielded an empty pending
114 * list (e.g., patterns like "--all" or "--glob").
116 int rev_input_given;
119 * Whether we read from stdin due to the --stdin option.
121 int read_from_stdin;
123 /* topo-sort */
124 enum rev_sort_order sort_order;
126 unsigned int early_output;
128 unsigned int ignore_missing:1,
129 ignore_missing_links:1;
131 /* Traversal flags */
132 unsigned int dense:1,
133 prune:1,
134 no_walk:2,
135 remove_empty_trees:1,
136 simplify_history:1,
137 show_pulls:1,
138 topo_order:1,
139 simplify_merges:1,
140 simplify_by_decoration:1,
141 single_worktree:1,
142 tag_objects:1,
143 tree_objects:1,
144 blob_objects:1,
145 verify_objects:1,
146 edge_hint:1,
147 edge_hint_aggressive:1,
148 limited:1,
149 unpacked:1,
150 boundary:2,
151 count:1,
152 left_right:1,
153 left_only:1,
154 right_only:1,
155 rewrite_parents:1,
156 print_parents:1,
157 show_decorations:1,
158 reverse:1,
159 reverse_output_stage:1,
160 cherry_pick:1,
161 cherry_mark:1,
162 bisect:1,
163 ancestry_path:1,
164 first_parent_only:1,
165 line_level_traverse:1,
166 tree_blobs_in_commit_order:1,
169 * Blobs are shown without regard for their existence.
170 * But not so for trees: unless exclude_promisor_objects
171 * is set and the tree in question is a promisor object;
172 * OR ignore_missing_links is set, the revision walker
173 * dies with a "bad tree object HASH" message when
174 * encountering a missing tree. For callers that can
175 * handle missing trees and want them to be filterable
176 * and showable, set this to true. The revision walker
177 * will filter and show such a missing tree as usual,
178 * but will not attempt to recurse into this tree
179 * object.
181 do_not_die_on_missing_tree:1,
183 /* for internal use only */
184 exclude_promisor_objects:1;
186 /* Diff flags */
187 unsigned int diff:1,
188 full_diff:1,
189 show_root_diff:1,
190 no_commit_id:1,
191 verbose_header:1,
192 ignore_merges:1,
193 combine_merges:1,
194 combined_all_paths:1,
195 dense_combined_merges:1,
196 always_show_header:1;
198 /* Format info */
199 int show_notes;
200 unsigned int shown_one:1,
201 shown_dashes:1,
202 show_merge:1,
203 show_notes_given:1,
204 show_signature:1,
205 pretty_given:1,
206 abbrev_commit:1,
207 abbrev_commit_given:1,
208 zero_commit:1,
209 use_terminator:1,
210 missing_newline:1,
211 date_mode_explicit:1,
212 preserve_subject:1,
213 encode_email_headers:1;
214 unsigned int disable_stdin:1;
215 /* --show-linear-break */
216 unsigned int track_linear:1,
217 track_first_time:1,
218 linear:1;
220 struct date_mode date_mode;
221 int expand_tabs_in_log; /* unset if negative */
222 int expand_tabs_in_log_default;
224 unsigned int abbrev;
225 enum cmit_fmt commit_format;
226 struct log_info *loginfo;
227 int nr, total;
228 const char *mime_boundary;
229 const char *patch_suffix;
230 int numbered_files;
231 int reroll_count;
232 char *message_id;
233 struct ident_split from_ident;
234 struct string_list *ref_message_ids;
235 int add_signoff;
236 const char *extra_headers;
237 const char *log_reencode;
238 const char *subject_prefix;
239 int no_inline;
240 int show_log_size;
241 struct string_list *mailmap;
243 /* Filter by commit log message */
244 struct grep_opt grep_filter;
245 /* Negate the match of grep_filter */
246 int invert_grep;
248 /* Display history graph */
249 struct git_graph *graph;
251 /* special limits */
252 int skip_count;
253 int max_count;
254 timestamp_t max_age;
255 timestamp_t min_age;
256 int min_parents;
257 int max_parents;
258 int (*include_check)(struct commit *, void *);
259 void *include_check_data;
261 /* diff info for patches and for paths limiting */
262 struct diff_options diffopt;
263 struct diff_options pruning;
265 struct reflog_walk_info *reflog_info;
266 struct decoration children;
267 struct decoration merge_simplification;
268 struct decoration treesame;
270 /* notes-specific options: which refs to show */
271 struct display_notes_opt notes_opt;
273 /* interdiff */
274 const struct object_id *idiff_oid1;
275 const struct object_id *idiff_oid2;
276 const char *idiff_title;
278 /* range-diff */
279 const char *rdiff1;
280 const char *rdiff2;
281 int creation_factor;
282 const char *rdiff_title;
284 /* commit counts */
285 int count_left;
286 int count_right;
287 int count_same;
289 /* line level range that we are chasing */
290 struct decoration line_log_data;
292 /* copies of the parent lists, for --full-diff display */
293 struct saved_parents *saved_parents_slab;
295 struct commit_list *previous_parents;
296 const char *break_bar;
298 struct revision_sources *sources;
300 struct topo_walk_info *topo_walk_info;
302 /* Commit graph bloom filter fields */
303 /* The bloom filter key for the pathspec */
304 struct bloom_key *bloom_key;
306 * The bloom filter settings used to generate the key.
307 * This is loaded from the commit-graph being used.
309 struct bloom_filter_settings *bloom_filter_settings;
312 int ref_excluded(struct string_list *, const char *path);
313 void clear_ref_exclusion(struct string_list **);
314 void add_ref_exclusion(struct string_list **, const char *exclude);
317 #define REV_TREE_SAME 0
318 #define REV_TREE_NEW 1 /* Only new files */
319 #define REV_TREE_OLD 2 /* Only files removed */
320 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
322 /* revision.c */
323 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
324 extern volatile show_early_output_fn_t show_early_output;
326 struct setup_revision_opt {
327 const char *def;
328 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
329 const char *submodule; /* TODO: drop this and use rev_info->repo */
330 unsigned int assume_dashdash:1,
331 allow_exclude_promisor_objects:1;
332 unsigned revarg_opt;
335 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
336 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
337 #endif
340 * Initialize a rev_info structure with default values. The third parameter may
341 * be NULL or can be prefix path, and then the `.prefix` variable will be set
342 * to it. This is typically the first function you want to call when you want
343 * to deal with a revision list. After calling this function, you are free to
344 * customize options, like set `.ignore_merges` to 0 if you don't want to
345 * ignore merges, and so on.
347 void repo_init_revisions(struct repository *r,
348 struct rev_info *revs,
349 const char *prefix);
352 * Parse revision information, filling in the `rev_info` structure, and
353 * removing the used arguments from the argument list. Returns the number
354 * of arguments left that weren't recognized, which are also moved to the
355 * head of the argument list. The last parameter is used in case no
356 * parameter given by the first two arguments.
358 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
359 struct setup_revision_opt *);
361 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
362 const struct option *options,
363 const char * const usagestr[]);
364 #define REVARG_CANNOT_BE_FILENAME 01
365 #define REVARG_COMMITTISH 02
366 int handle_revision_arg(const char *arg, struct rev_info *revs,
367 int flags, unsigned revarg_opt);
370 * Reset the flags used by the revision walking api. You can use this to do
371 * multiple sequential revision walks.
373 void reset_revision_walk(void);
376 * Prepares the rev_info structure for a walk. You should check if it returns
377 * any error (non-zero return code) and if it does not, you can start using
378 * get_revision() to do the iteration.
380 int prepare_revision_walk(struct rev_info *revs);
383 * Takes a pointer to a `rev_info` structure and iterates over it, returning a
384 * `struct commit *` each time you call it. The end of the revision list is
385 * indicated by returning a NULL pointer.
387 struct commit *get_revision(struct rev_info *revs);
389 const char *get_revision_mark(const struct rev_info *revs,
390 const struct commit *commit);
391 void put_revision_mark(const struct rev_info *revs,
392 const struct commit *commit);
394 void mark_parents_uninteresting(struct commit *commit);
395 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
396 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
398 void show_object_with_name(FILE *, struct object *, const char *);
401 * This function can be used if you want to add commit objects as revision
402 * information. You can use the `UNINTERESTING` object flag to indicate if
403 * you want to include or exclude the given commit (and commits reachable
404 * from the given commit) from the revision list.
406 * NOTE: If you have the commits as a string list then you probably want to
407 * use setup_revisions(), instead of parsing each string and using this
408 * function.
410 void add_pending_object(struct rev_info *revs,
411 struct object *obj, const char *name);
413 void add_pending_oid(struct rev_info *revs,
414 const char *name, const struct object_id *oid,
415 unsigned int flags);
417 void add_head_to_pending(struct rev_info *);
418 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
419 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
421 enum commit_action {
422 commit_ignore,
423 commit_show,
424 commit_error
427 enum commit_action get_commit_action(struct rev_info *revs,
428 struct commit *commit);
429 enum commit_action simplify_commit(struct rev_info *revs,
430 struct commit *commit);
432 enum rewrite_result {
433 rewrite_one_ok,
434 rewrite_one_noparents,
435 rewrite_one_error
438 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
440 int rewrite_parents(struct rev_info *revs,
441 struct commit *commit,
442 rewrite_parent_fn_t rewrite_parent);
445 * The log machinery saves the original parent list so that
446 * get_saved_parents() can later tell what the real parents of the
447 * commits are, when commit->parents has been modified by history
448 * simpification.
450 * get_saved_parents() will transparently return commit->parents if
451 * history simplification is off.
453 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
455 #endif