Merge branch 'master' of github.com:git/git
[alt-git.git] / revision.h
blob5578bb4720ae37c2824a220a487dce0451bc7a85
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 #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.
48 #define NOT_USER_GIVEN (1u<<25)
49 #define TRACK_LINEAR (1u<<26)
50 #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)
52 #define DECORATE_SHORT_REFS 1
53 #define DECORATE_FULL_REFS 2
55 struct log_info;
56 struct repository;
57 struct rev_info;
58 struct string_list;
59 struct saved_parents;
60 struct bloom_key;
61 struct bloom_filter_settings;
62 define_shared_commit_slab(revision_sources, char *);
64 struct rev_cmdline_info {
65 unsigned int nr;
66 unsigned int alloc;
67 struct rev_cmdline_entry {
68 struct object *item;
69 const char *name;
70 enum {
71 REV_CMD_REF,
72 REV_CMD_PARENTS_ONLY,
73 REV_CMD_LEFT,
74 REV_CMD_RIGHT,
75 REV_CMD_MERGE_BASE,
76 REV_CMD_REV
77 } whence;
78 unsigned flags;
79 } *rev;
82 struct oidset;
83 struct topo_walk_info;
85 struct rev_info {
86 /* Starting list */
87 struct commit_list *commits;
88 struct object_array pending;
89 struct repository *repo;
91 /* Parents of shown commits */
92 struct object_array boundary_commits;
94 /* The end-points specified by the end user */
95 struct rev_cmdline_info cmdline;
97 /* excluding from --branches, --refs, etc. expansion */
98 struct string_list *ref_excludes;
100 /* Basic information */
101 const char *prefix;
102 const char *def;
103 struct pathspec prune_data;
106 * Whether the arguments parsed by setup_revisions() included any
107 * "input" revisions that might still have yielded an empty pending
108 * list (e.g., patterns like "--all" or "--glob").
110 int rev_input_given;
113 * Whether we read from stdin due to the --stdin option.
115 int read_from_stdin;
117 /* topo-sort */
118 enum rev_sort_order sort_order;
120 unsigned int early_output;
122 unsigned int ignore_missing:1,
123 ignore_missing_links:1;
125 /* Traversal flags */
126 unsigned int dense:1,
127 prune:1,
128 no_walk:1,
129 unsorted_input:1,
130 remove_empty_trees:1,
131 simplify_history:1,
132 show_pulls:1,
133 topo_order:1,
134 simplify_merges:1,
135 simplify_by_decoration:1,
136 single_worktree:1,
137 tag_objects:1,
138 tree_objects:1,
139 blob_objects:1,
140 verify_objects:1,
141 edge_hint:1,
142 edge_hint_aggressive:1,
143 limited:1,
144 unpacked:1,
145 no_kept_objects:1,
146 boundary:2,
147 count:1,
148 left_right:1,
149 left_only:1,
150 right_only:1,
151 rewrite_parents:1,
152 print_parents:1,
153 show_decorations:1,
154 reverse:1,
155 reverse_output_stage:1,
156 cherry_pick:1,
157 cherry_mark:1,
158 bisect:1,
159 ancestry_path:1,
160 first_parent_only:1,
161 line_level_traverse:1,
162 tree_blobs_in_commit_order:1,
165 * Blobs are shown without regard for their existence.
166 * But not so for trees: unless exclude_promisor_objects
167 * is set and the tree in question is a promisor object;
168 * OR ignore_missing_links is set, the revision walker
169 * dies with a "bad tree object HASH" message when
170 * encountering a missing tree. For callers that can
171 * handle missing trees and want them to be filterable
172 * and showable, set this to true. The revision walker
173 * will filter and show such a missing tree as usual,
174 * but will not attempt to recurse into this tree
175 * object.
177 do_not_die_on_missing_tree:1,
179 /* for internal use only */
180 exclude_promisor_objects:1;
182 /* Diff flags */
183 unsigned int diff:1,
184 full_diff:1,
185 show_root_diff:1,
186 match_missing:1,
187 no_commit_id:1,
188 verbose_header:1,
189 always_show_header:1,
190 /* Diff-merge flags */
191 explicit_diff_merges: 1,
192 merges_need_diff: 1,
193 merges_imply_patch:1,
194 separate_merges: 1,
195 combine_merges:1,
196 combined_all_paths:1,
197 dense_combined_merges:1,
198 first_parent_merges:1;
200 /* Format info */
201 int show_notes;
202 unsigned int shown_one:1,
203 shown_dashes:1,
204 show_merge:1,
205 show_notes_given:1,
206 show_signature:1,
207 pretty_given:1,
208 abbrev_commit:1,
209 abbrev_commit_given:1,
210 zero_commit:1,
211 use_terminator:1,
212 missing_newline:1,
213 date_mode_explicit:1,
214 preserve_subject:1,
215 encode_email_headers:1,
216 include_header:1;
217 unsigned int disable_stdin:1;
218 /* --show-linear-break */
219 unsigned int track_linear:1,
220 track_first_time:1,
221 linear:1;
223 struct date_mode date_mode;
224 int expand_tabs_in_log; /* unset if negative */
225 int expand_tabs_in_log_default;
227 unsigned int abbrev;
228 enum cmit_fmt commit_format;
229 struct log_info *loginfo;
230 int nr, total;
231 const char *mime_boundary;
232 const char *patch_suffix;
233 int numbered_files;
234 const char *reroll_count;
235 char *message_id;
236 struct ident_split from_ident;
237 struct string_list *ref_message_ids;
238 int add_signoff;
239 const char *extra_headers;
240 const char *log_reencode;
241 const char *subject_prefix;
242 int patch_name_max;
243 int no_inline;
244 int show_log_size;
245 struct string_list *mailmap;
247 /* Filter by commit log message */
248 struct grep_opt grep_filter;
249 /* Negate the match of grep_filter */
250 int invert_grep;
252 /* Display history graph */
253 struct git_graph *graph;
255 /* special limits */
256 int skip_count;
257 int max_count;
258 timestamp_t max_age;
259 timestamp_t min_age;
260 int min_parents;
261 int max_parents;
262 int (*include_check)(struct commit *, void *);
263 int (*include_check_obj)(struct object *obj, 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;
278 /* interdiff */
279 const struct object_id *idiff_oid1;
280 const struct object_id *idiff_oid2;
281 const char *idiff_title;
283 /* range-diff */
284 const char *rdiff1;
285 const char *rdiff2;
286 int creation_factor;
287 const char *rdiff_title;
289 /* commit counts */
290 int count_left;
291 int count_right;
292 int count_same;
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;
310 int bloom_keys_nr;
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;
318 /* misc. flags related to '--no-kept-objects' */
319 unsigned keep_pack_cache_flags;
322 int ref_excluded(struct string_list *, const char *path);
323 void clear_ref_exclusion(struct string_list **);
324 void add_ref_exclusion(struct string_list **, const char *exclude);
327 #define REV_TREE_SAME 0
328 #define REV_TREE_NEW 1 /* Only new files */
329 #define REV_TREE_OLD 2 /* Only files removed */
330 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
332 /* revision.c */
333 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
334 extern volatile show_early_output_fn_t show_early_output;
336 struct setup_revision_opt {
337 const char *def;
338 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
339 unsigned int assume_dashdash:1,
340 allow_exclude_promisor_objects:1;
341 unsigned revarg_opt;
344 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
345 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
346 #endif
349 * Initialize a rev_info structure with default values. The third parameter may
350 * be NULL or can be prefix path, and then the `.prefix` variable will be set
351 * to it. This is typically the first function you want to call when you want
352 * to deal with a revision list. After calling this function, you are free to
353 * customize options, like set `.ignore_merges` to 0 if you don't want to
354 * ignore merges, and so on.
356 void repo_init_revisions(struct repository *r,
357 struct rev_info *revs,
358 const char *prefix);
361 * Parse revision information, filling in the `rev_info` structure, and
362 * removing the used arguments from the argument list. Returns the number
363 * of arguments left that weren't recognized, which are also moved to the
364 * head of the argument list. The last parameter is used in case no
365 * parameter given by the first two arguments.
367 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
368 struct setup_revision_opt *);
370 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
371 const struct option *options,
372 const char * const usagestr[]);
373 #define REVARG_CANNOT_BE_FILENAME 01
374 #define REVARG_COMMITTISH 02
375 int handle_revision_arg(const char *arg, struct rev_info *revs,
376 int flags, unsigned revarg_opt);
379 * Reset the flags used by the revision walking api. You can use this to do
380 * multiple sequential revision walks.
382 void reset_revision_walk(void);
385 * Prepares the rev_info structure for a walk. You should check if it returns
386 * any error (non-zero return code) and if it does not, you can start using
387 * get_revision() to do the iteration.
389 int prepare_revision_walk(struct rev_info *revs);
392 * Takes a pointer to a `rev_info` structure and iterates over it, returning a
393 * `struct commit *` each time you call it. The end of the revision list is
394 * indicated by returning a NULL pointer.
396 struct commit *get_revision(struct rev_info *revs);
398 const char *get_revision_mark(const struct rev_info *revs,
399 const struct commit *commit);
400 void put_revision_mark(const struct rev_info *revs,
401 const struct commit *commit);
403 void mark_parents_uninteresting(struct commit *commit);
404 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
405 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
407 void show_object_with_name(FILE *, struct object *, const char *);
410 * This function can be used if you want to add commit objects as revision
411 * information. You can use the `UNINTERESTING` object flag to indicate if
412 * you want to include or exclude the given commit (and commits reachable
413 * from the given commit) from the revision list.
415 * NOTE: If you have the commits as a string list then you probably want to
416 * use setup_revisions(), instead of parsing each string and using this
417 * function.
419 void add_pending_object(struct rev_info *revs,
420 struct object *obj, const char *name);
422 void add_pending_oid(struct rev_info *revs,
423 const char *name, const struct object_id *oid,
424 unsigned int flags);
426 void add_head_to_pending(struct rev_info *);
427 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
428 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
430 enum commit_action {
431 commit_ignore,
432 commit_show,
433 commit_error
436 enum commit_action get_commit_action(struct rev_info *revs,
437 struct commit *commit);
438 enum commit_action simplify_commit(struct rev_info *revs,
439 struct commit *commit);
441 enum rewrite_result {
442 rewrite_one_ok,
443 rewrite_one_noparents,
444 rewrite_one_error
447 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
449 int rewrite_parents(struct rev_info *revs,
450 struct commit *commit,
451 rewrite_parent_fn_t rewrite_parent);
454 * The log machinery saves the original parent list so that
455 * get_saved_parents() can later tell what the real parents of the
456 * commits are, when commit->parents has been modified by history
457 * simpification.
459 * get_saved_parents() will transparently return commit->parents if
460 * history simplification is off.
462 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
464 #endif