]>
Commit | Line | Data |
---|---|---|
1 | #ifndef REVISION_H | |
2 | #define REVISION_H | |
3 | ||
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" | |
11 | ||
12 | /** | |
13 | * The revision walking API offers functions to build a list of revisions | |
14 | * and then iterate over that list. | |
15 | * | |
16 | * Calling sequence | |
17 | * ---------------- | |
18 | * | |
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. | |
22 | * | |
23 | */ | |
24 | ||
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) | |
37 | ||
38 | /* WARNING: This is also used as REACHABLE in commit-graph.c. */ | |
39 | #define PULL_MERGE (1u<<15) | |
40 | ||
41 | #define TOPO_WALK_EXPLORED (1u<<23) | |
42 | #define TOPO_WALK_INDEGREE (1u<<24) | |
43 | ||
44 | /* | |
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 | |
49 | * in the future. | |
50 | */ | |
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) | |
54 | ||
55 | #define DECORATE_SHORT_REFS 1 | |
56 | #define DECORATE_FULL_REFS 2 | |
57 | ||
58 | struct log_info; | |
59 | struct repository; | |
60 | struct rev_info; | |
61 | struct string_list; | |
62 | struct saved_parents; | |
63 | struct bloom_key; | |
64 | struct bloom_filter_settings; | |
65 | define_shared_commit_slab(revision_sources, char *); | |
66 | ||
67 | struct rev_cmdline_info { | |
68 | unsigned int nr; | |
69 | unsigned int alloc; | |
70 | struct rev_cmdline_entry { | |
71 | struct object *item; | |
72 | const char *name; | |
73 | enum { | |
74 | REV_CMD_REF, | |
75 | REV_CMD_PARENTS_ONLY, | |
76 | REV_CMD_LEFT, | |
77 | REV_CMD_RIGHT, | |
78 | REV_CMD_MERGE_BASE, | |
79 | REV_CMD_REV | |
80 | } whence; | |
81 | unsigned flags; | |
82 | } *rev; | |
83 | }; | |
84 | ||
85 | #define REVISION_WALK_WALK 0 | |
86 | #define REVISION_WALK_NO_WALK_SORTED 1 | |
87 | #define REVISION_WALK_NO_WALK_UNSORTED 2 | |
88 | ||
89 | struct oidset; | |
90 | struct topo_walk_info; | |
91 | ||
92 | struct rev_info { | |
93 | /* Starting list */ | |
94 | struct commit_list *commits; | |
95 | struct object_array pending; | |
96 | struct repository *repo; | |
97 | ||
98 | /* Parents of shown commits */ | |
99 | struct object_array boundary_commits; | |
100 | ||
101 | /* The end-points specified by the end user */ | |
102 | struct rev_cmdline_info cmdline; | |
103 | ||
104 | /* excluding from --branches, --refs, etc. expansion */ | |
105 | struct string_list *ref_excludes; | |
106 | ||
107 | /* Basic information */ | |
108 | const char *prefix; | |
109 | const char *def; | |
110 | struct pathspec prune_data; | |
111 | ||
112 | /* | |
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"). | |
116 | */ | |
117 | int rev_input_given; | |
118 | ||
119 | /* | |
120 | * Whether we read from stdin due to the --stdin option. | |
121 | */ | |
122 | int read_from_stdin; | |
123 | ||
124 | /* topo-sort */ | |
125 | enum rev_sort_order sort_order; | |
126 | ||
127 | unsigned int early_output; | |
128 | ||
129 | unsigned int ignore_missing:1, | |
130 | ignore_missing_links:1; | |
131 | ||
132 | /* Traversal flags */ | |
133 | unsigned int dense:1, | |
134 | prune:1, | |
135 | no_walk:2, | |
136 | remove_empty_trees:1, | |
137 | simplify_history:1, | |
138 | show_pulls:1, | |
139 | topo_order:1, | |
140 | simplify_merges:1, | |
141 | simplify_by_decoration:1, | |
142 | single_worktree:1, | |
143 | tag_objects:1, | |
144 | tree_objects:1, | |
145 | blob_objects:1, | |
146 | verify_objects:1, | |
147 | edge_hint:1, | |
148 | edge_hint_aggressive:1, | |
149 | limited:1, | |
150 | unpacked:1, | |
151 | boundary:2, | |
152 | count:1, | |
153 | left_right:1, | |
154 | left_only:1, | |
155 | right_only:1, | |
156 | rewrite_parents:1, | |
157 | print_parents:1, | |
158 | show_decorations:1, | |
159 | reverse:1, | |
160 | reverse_output_stage:1, | |
161 | cherry_pick:1, | |
162 | cherry_mark:1, | |
163 | bisect:1, | |
164 | ancestry_path:1, | |
165 | first_parent_only:1, | |
166 | line_level_traverse:1, | |
167 | tree_blobs_in_commit_order:1, | |
168 | ||
169 | /* | |
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 | |
180 | * object. | |
181 | */ | |
182 | do_not_die_on_missing_tree:1, | |
183 | ||
184 | /* for internal use only */ | |
185 | exclude_promisor_objects:1; | |
186 | ||
187 | /* Diff flags */ | |
188 | unsigned int diff:1, | |
189 | full_diff:1, | |
190 | show_root_diff:1, | |
191 | match_missing:1, | |
192 | no_commit_id:1, | |
193 | verbose_header:1, | |
194 | combine_merges:1, | |
195 | combined_all_paths:1, | |
196 | dense_combined_merges:1, | |
197 | always_show_header:1; | |
198 | int ignore_merges:2; | |
199 | ||
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 | unsigned int disable_stdin:1; | |
217 | /* --show-linear-break */ | |
218 | unsigned int track_linear:1, | |
219 | track_first_time:1, | |
220 | linear:1; | |
221 | ||
222 | struct date_mode date_mode; | |
223 | int expand_tabs_in_log; /* unset if negative */ | |
224 | int expand_tabs_in_log_default; | |
225 | ||
226 | unsigned int abbrev; | |
227 | enum cmit_fmt commit_format; | |
228 | struct log_info *loginfo; | |
229 | int nr, total; | |
230 | const char *mime_boundary; | |
231 | const char *patch_suffix; | |
232 | int numbered_files; | |
233 | int reroll_count; | |
234 | char *message_id; | |
235 | struct ident_split from_ident; | |
236 | struct string_list *ref_message_ids; | |
237 | int add_signoff; | |
238 | const char *extra_headers; | |
239 | const char *log_reencode; | |
240 | const char *subject_prefix; | |
241 | int no_inline; | |
242 | int show_log_size; | |
243 | struct string_list *mailmap; | |
244 | ||
245 | /* Filter by commit log message */ | |
246 | struct grep_opt grep_filter; | |
247 | /* Negate the match of grep_filter */ | |
248 | int invert_grep; | |
249 | ||
250 | /* Display history graph */ | |
251 | struct git_graph *graph; | |
252 | ||
253 | /* special limits */ | |
254 | int skip_count; | |
255 | int max_count; | |
256 | timestamp_t max_age; | |
257 | timestamp_t min_age; | |
258 | int min_parents; | |
259 | int max_parents; | |
260 | int (*include_check)(struct commit *, void *); | |
261 | void *include_check_data; | |
262 | ||
263 | /* diff info for patches and for paths limiting */ | |
264 | struct diff_options diffopt; | |
265 | struct diff_options pruning; | |
266 | ||
267 | struct reflog_walk_info *reflog_info; | |
268 | struct decoration children; | |
269 | struct decoration merge_simplification; | |
270 | struct decoration treesame; | |
271 | ||
272 | /* notes-specific options: which refs to show */ | |
273 | struct display_notes_opt notes_opt; | |
274 | ||
275 | /* interdiff */ | |
276 | const struct object_id *idiff_oid1; | |
277 | const struct object_id *idiff_oid2; | |
278 | const char *idiff_title; | |
279 | ||
280 | /* range-diff */ | |
281 | const char *rdiff1; | |
282 | const char *rdiff2; | |
283 | int creation_factor; | |
284 | const char *rdiff_title; | |
285 | ||
286 | /* commit counts */ | |
287 | int count_left; | |
288 | int count_right; | |
289 | int count_same; | |
290 | ||
291 | /* line level range that we are chasing */ | |
292 | struct decoration line_log_data; | |
293 | ||
294 | /* copies of the parent lists, for --full-diff display */ | |
295 | struct saved_parents *saved_parents_slab; | |
296 | ||
297 | struct commit_list *previous_parents; | |
298 | const char *break_bar; | |
299 | ||
300 | struct revision_sources *sources; | |
301 | ||
302 | struct topo_walk_info *topo_walk_info; | |
303 | ||
304 | /* Commit graph bloom filter fields */ | |
305 | /* The bloom filter key(s) for the pathspec */ | |
306 | struct bloom_key *bloom_keys; | |
307 | int bloom_keys_nr; | |
308 | ||
309 | /* | |
310 | * The bloom filter settings used to generate the key. | |
311 | * This is loaded from the commit-graph being used. | |
312 | */ | |
313 | struct bloom_filter_settings *bloom_filter_settings; | |
314 | }; | |
315 | ||
316 | int ref_excluded(struct string_list *, const char *path); | |
317 | void clear_ref_exclusion(struct string_list **); | |
318 | void add_ref_exclusion(struct string_list **, const char *exclude); | |
319 | ||
320 | ||
321 | #define REV_TREE_SAME 0 | |
322 | #define REV_TREE_NEW 1 /* Only new files */ | |
323 | #define REV_TREE_OLD 2 /* Only files removed */ | |
324 | #define REV_TREE_DIFFERENT 3 /* Mixed changes */ | |
325 | ||
326 | /* revision.c */ | |
327 | typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *); | |
328 | extern volatile show_early_output_fn_t show_early_output; | |
329 | ||
330 | struct setup_revision_opt { | |
331 | const char *def; | |
332 | void (*tweak)(struct rev_info *, struct setup_revision_opt *); | |
333 | const char *submodule; /* TODO: drop this and use rev_info->repo */ | |
334 | unsigned int assume_dashdash:1, | |
335 | allow_exclude_promisor_objects:1; | |
336 | unsigned revarg_opt; | |
337 | }; | |
338 | ||
339 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS | |
340 | #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix) | |
341 | #endif | |
342 | ||
343 | /** | |
344 | * Initialize a rev_info structure with default values. The third parameter may | |
345 | * be NULL or can be prefix path, and then the `.prefix` variable will be set | |
346 | * to it. This is typically the first function you want to call when you want | |
347 | * to deal with a revision list. After calling this function, you are free to | |
348 | * customize options, like set `.ignore_merges` to 0 if you don't want to | |
349 | * ignore merges, and so on. | |
350 | */ | |
351 | void repo_init_revisions(struct repository *r, | |
352 | struct rev_info *revs, | |
353 | const char *prefix); | |
354 | ||
355 | /** | |
356 | * Parse revision information, filling in the `rev_info` structure, and | |
357 | * removing the used arguments from the argument list. Returns the number | |
358 | * of arguments left that weren't recognized, which are also moved to the | |
359 | * head of the argument list. The last parameter is used in case no | |
360 | * parameter given by the first two arguments. | |
361 | */ | |
362 | int setup_revisions(int argc, const char **argv, struct rev_info *revs, | |
363 | struct setup_revision_opt *); | |
364 | ||
365 | void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx, | |
366 | const struct option *options, | |
367 | const char * const usagestr[]); | |
368 | #define REVARG_CANNOT_BE_FILENAME 01 | |
369 | #define REVARG_COMMITTISH 02 | |
370 | int handle_revision_arg(const char *arg, struct rev_info *revs, | |
371 | int flags, unsigned revarg_opt); | |
372 | ||
373 | /** | |
374 | * Reset the flags used by the revision walking api. You can use this to do | |
375 | * multiple sequential revision walks. | |
376 | */ | |
377 | void reset_revision_walk(void); | |
378 | ||
379 | /** | |
380 | * Prepares the rev_info structure for a walk. You should check if it returns | |
381 | * any error (non-zero return code) and if it does not, you can start using | |
382 | * get_revision() to do the iteration. | |
383 | */ | |
384 | int prepare_revision_walk(struct rev_info *revs); | |
385 | ||
386 | /** | |
387 | * Takes a pointer to a `rev_info` structure and iterates over it, returning a | |
388 | * `struct commit *` each time you call it. The end of the revision list is | |
389 | * indicated by returning a NULL pointer. | |
390 | */ | |
391 | struct commit *get_revision(struct rev_info *revs); | |
392 | ||
393 | const char *get_revision_mark(const struct rev_info *revs, | |
394 | const struct commit *commit); | |
395 | void put_revision_mark(const struct rev_info *revs, | |
396 | const struct commit *commit); | |
397 | ||
398 | void mark_parents_uninteresting(struct commit *commit); | |
399 | void mark_tree_uninteresting(struct repository *r, struct tree *tree); | |
400 | void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees); | |
401 | ||
402 | void show_object_with_name(FILE *, struct object *, const char *); | |
403 | ||
404 | /** | |
405 | * This function can be used if you want to add commit objects as revision | |
406 | * information. You can use the `UNINTERESTING` object flag to indicate if | |
407 | * you want to include or exclude the given commit (and commits reachable | |
408 | * from the given commit) from the revision list. | |
409 | * | |
410 | * NOTE: If you have the commits as a string list then you probably want to | |
411 | * use setup_revisions(), instead of parsing each string and using this | |
412 | * function. | |
413 | */ | |
414 | void add_pending_object(struct rev_info *revs, | |
415 | struct object *obj, const char *name); | |
416 | ||
417 | void add_pending_oid(struct rev_info *revs, | |
418 | const char *name, const struct object_id *oid, | |
419 | unsigned int flags); | |
420 | ||
421 | void add_head_to_pending(struct rev_info *); | |
422 | void add_reflogs_to_pending(struct rev_info *, unsigned int flags); | |
423 | void add_index_objects_to_pending(struct rev_info *, unsigned int flags); | |
424 | ||
425 | enum commit_action { | |
426 | commit_ignore, | |
427 | commit_show, | |
428 | commit_error | |
429 | }; | |
430 | ||
431 | enum commit_action get_commit_action(struct rev_info *revs, | |
432 | struct commit *commit); | |
433 | enum commit_action simplify_commit(struct rev_info *revs, | |
434 | struct commit *commit); | |
435 | ||
436 | enum rewrite_result { | |
437 | rewrite_one_ok, | |
438 | rewrite_one_noparents, | |
439 | rewrite_one_error | |
440 | }; | |
441 | ||
442 | typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp); | |
443 | ||
444 | int rewrite_parents(struct rev_info *revs, | |
445 | struct commit *commit, | |
446 | rewrite_parent_fn_t rewrite_parent); | |
447 | ||
448 | /* | |
449 | * The log machinery saves the original parent list so that | |
450 | * get_saved_parents() can later tell what the real parents of the | |
451 | * commits are, when commit->parents has been modified by history | |
452 | * simpification. | |
453 | * | |
454 | * get_saved_parents() will transparently return commit->parents if | |
455 | * history simplification is off. | |
456 | */ | |
457 | struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit); | |
458 | ||
459 | #endif |