]>
Commit | Line | Data |
---|---|---|
ae563542 LT |
1 | #ifndef REVISION_H |
2 | #define REVISION_H | |
3 | ||
ef3ca954 | 4 | #include "commit.h" |
6b61ec05 | 5 | #include "parse-options.h" |
0843acfd | 6 | #include "grep.h" |
894a9d33 | 7 | #include "notes.h" |
cf394719 | 8 | #include "pretty.h" |
19ecb564 | 9 | #include "diff.h" |
87be2523 | 10 | #include "commit-slab-decl.h" |
ffaa137f | 11 | #include "list-objects-filter-options.h" |
6b61ec05 | 12 | |
301d595e HW |
13 | /** |
14 | * The revision walking API offers functions to build a list of revisions | |
15 | * and then iterate over that list. | |
16 | * | |
17 | * Calling sequence | |
18 | * ---------------- | |
19 | * | |
20 | * The walking API has a given calling sequence: first you need to initialize | |
21 | * a rev_info structure, then add revisions to control what kind of revision | |
22 | * list do you want to get, finally you can iterate over the revision list. | |
23 | * | |
24 | */ | |
25 | ||
208acbfb | 26 | /* Remember to update object flag allocation in object.h */ |
ae563542 LT |
27 | #define SEEN (1u<<0) |
28 | #define UNINTERESTING (1u<<1) | |
7dc0fe3b | 29 | #define TREESAME (1u<<2) |
765ac8ec | 30 | #define SHOWN (1u<<3) |
7ae0b0cb | 31 | #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */ |
384e99a4 | 32 | #define BOUNDARY (1u<<5) |
2b064697 | 33 | #define CHILD_SHOWN (1u<<6) |
1b65a5aa | 34 | #define ADDED (1u<<7) /* Parents already parsed and added? */ |
577ed5c2 | 35 | #define SYMMETRIC_LEFT (1u<<8) |
adbbb31e | 36 | #define PATCHSAME (1u<<9) |
7f34a46f | 37 | #define BOTTOM (1u<<10) |
8d049e18 DS |
38 | |
39 | /* WARNING: This is also used as REACHABLE in commit-graph.c. */ | |
40 | #define PULL_MERGE (1u<<15) | |
23c4319f RS |
41 | |
42 | #define TOPO_WALK_EXPLORED (1u<<23) | |
43 | #define TOPO_WALK_INDEGREE (1u<<24) | |
44 | ||
99c9aa95 MD |
45 | /* |
46 | * Indicates object was reached by traversal. i.e. not given by user on | |
47 | * command-line or stdin. | |
99c9aa95 MD |
48 | */ |
49 | #define NOT_USER_GIVEN (1u<<25) | |
1b32dece | 50 | #define TRACK_LINEAR (1u<<26) |
8d049e18 | 51 | #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE) |
ae563542 | 52 | |
33e7018c LH |
53 | #define DECORATE_SHORT_REFS 1 |
54 | #define DECORATE_FULL_REFS 2 | |
55 | ||
91539833 | 56 | struct log_info; |
2abf3503 NTND |
57 | struct repository; |
58 | struct rev_info; | |
894a9d33 | 59 | struct string_list; |
53d00b39 | 60 | struct saved_parents; |
a56b9464 GS |
61 | struct bloom_key; |
62 | struct bloom_filter_settings; | |
87be2523 | 63 | define_shared_commit_slab(revision_sources, char *); |
8efdc326 | 64 | |
281eee47 JH |
65 | struct rev_cmdline_info { |
66 | unsigned int nr; | |
67 | unsigned int alloc; | |
68 | struct rev_cmdline_entry { | |
69 | struct object *item; | |
70 | const char *name; | |
71 | enum { | |
72 | REV_CMD_REF, | |
73 | REV_CMD_PARENTS_ONLY, | |
74 | REV_CMD_LEFT, | |
75 | REV_CMD_RIGHT, | |
a765499a | 76 | REV_CMD_MERGE_BASE, |
281eee47 JH |
77 | REV_CMD_REV |
78 | } whence; | |
79 | unsigned flags; | |
80 | } *rev; | |
81 | }; | |
82 | ||
f1f5de44 | 83 | struct oidset; |
f0d9cc41 DS |
84 | struct topo_walk_info; |
85 | ||
ae563542 LT |
86 | struct rev_info { |
87 | /* Starting list */ | |
88 | struct commit_list *commits; | |
1f1e895f | 89 | struct object_array pending; |
2abf3503 | 90 | struct repository *repo; |
ae563542 | 91 | |
86ab4906 JH |
92 | /* Parents of shown commits */ |
93 | struct object_array boundary_commits; | |
94 | ||
281eee47 JH |
95 | /* The end-points specified by the end user */ |
96 | struct rev_cmdline_info cmdline; | |
97 | ||
ffaa137f DS |
98 | /* |
99 | * Object filter options. No filtering is specified | |
100 | * if and only if filter.choice is zero. | |
101 | */ | |
102 | struct list_objects_filter_options filter; | |
103 | ||
e7b432c5 JH |
104 | /* excluding from --branches, --refs, etc. expansion */ |
105 | struct string_list *ref_excludes; | |
106 | ||
ae563542 LT |
107 | /* Basic information */ |
108 | const char *prefix; | |
02e54220 | 109 | const char *def; |
afe069d1 | 110 | struct pathspec prune_data; |
08f704f2 | 111 | |
7ba82629 JK |
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 | ||
a12cbe23 JK |
119 | /* |
120 | * Whether we read from stdin due to the --stdin option. | |
121 | */ | |
122 | int read_from_stdin; | |
123 | ||
08f704f2 JH |
124 | /* topo-sort */ |
125 | enum rev_sort_order sort_order; | |
126 | ||
e35b6ac5 SG |
127 | unsigned int early_output; |
128 | ||
129 | unsigned int ignore_missing:1, | |
2db1a43f | 130 | ignore_missing_links:1; |
cdcefbc9 | 131 | |
ae563542 LT |
132 | /* Traversal flags */ |
133 | unsigned int dense:1, | |
53b2c823 | 134 | prune:1, |
29ef1f27 PS |
135 | no_walk:1, |
136 | unsorted_input:1, | |
ae563542 | 137 | remove_empty_trees:1, |
9202434c | 138 | simplify_history:1, |
8d049e18 | 139 | show_pulls:1, |
ae563542 | 140 | topo_order:1, |
6546b593 | 141 | simplify_merges:1, |
78892e32 | 142 | simplify_by_decoration:1, |
ff9445be | 143 | single_worktree:1, |
ae563542 LT |
144 | tag_objects:1, |
145 | tree_objects:1, | |
146 | blob_objects:1, | |
5a48d240 | 147 | verify_objects:1, |
d9a83684 | 148 | edge_hint:1, |
1684c1b2 | 149 | edge_hint_aggressive:1, |
d9a83684 | 150 | limited:1, |
03a9683d | 151 | unpacked:1, |
c9fff000 | 152 | no_kept_objects:1, |
86ab4906 | 153 | boundary:2, |
f69c5018 | 154 | count:1, |
74bd9029 | 155 | left_right:1, |
60adf7d7 MG |
156 | left_only:1, |
157 | right_only:1, | |
885cf808 AS |
158 | rewrite_parents:1, |
159 | print_parents:1, | |
d467a525 | 160 | show_decorations:1, |
0053e902 | 161 | reverse:1, |
498bcd31 | 162 | reverse_output_stage:1, |
d7a17cad | 163 | cherry_pick:1, |
adbbb31e | 164 | cherry_mark:1, |
ad3f9a71 | 165 | bisect:1, |
ebdc94f3 | 166 | ancestry_path:1, |
12da1d1f | 167 | first_parent_only:1, |
9d505b7b | 168 | exclude_first_parent_only:1, |
ce5b6f9b | 169 | line_level_traverse:1, |
f3d618d2 | 170 | tree_blobs_in_commit_order:1, |
df11e196 | 171 | |
7c0fe330 MD |
172 | /* |
173 | * Blobs are shown without regard for their existence. | |
174 | * But not so for trees: unless exclude_promisor_objects | |
175 | * is set and the tree in question is a promisor object; | |
176 | * OR ignore_missing_links is set, the revision walker | |
177 | * dies with a "bad tree object HASH" message when | |
178 | * encountering a missing tree. For callers that can | |
179 | * handle missing trees and want them to be filterable | |
180 | * and showable, set this to true. The revision walker | |
181 | * will filter and show such a missing tree as usual, | |
182 | * but will not attempt to recurse into this tree | |
183 | * object. | |
184 | */ | |
185 | do_not_die_on_missing_tree:1, | |
186 | ||
df11e196 JT |
187 | /* for internal use only */ |
188 | exclude_promisor_objects:1; | |
ae563542 | 189 | |
cd2bdc53 LT |
190 | /* Diff flags */ |
191 | unsigned int diff:1, | |
192 | full_diff:1, | |
193 | show_root_diff:1, | |
572fc9aa | 194 | match_missing:1, |
cd2bdc53 LT |
195 | no_commit_id:1, |
196 | verbose_header:1, | |
d9b1bc6d SO |
197 | always_show_header:1, |
198 | /* Diff-merge flags */ | |
1a2c4d80 | 199 | explicit_diff_merges: 1, |
a6d19ecc | 200 | merges_need_diff: 1, |
fd16a399 | 201 | merges_imply_patch:1, |
1a2c4d80 | 202 | separate_merges: 1, |
cd2bdc53 | 203 | combine_merges:1, |
d76ce4f7 | 204 | combined_all_paths:1, |
cd2bdc53 | 205 | dense_combined_merges:1, |
db757e8b EN |
206 | first_parent_merges:1, |
207 | remerge_diff:1; | |
cd2bdc53 LT |
208 | |
209 | /* Format info */ | |
1d729751 | 210 | int show_notes; |
91539833 | 211 | unsigned int shown_one:1, |
bd1470b8 | 212 | shown_dashes:1, |
02e54220 | 213 | show_merge:1, |
66b2ed09 | 214 | show_notes_given:1, |
0c37f1fc | 215 | show_signature:1, |
66b2ed09 | 216 | pretty_given:1, |
4da45bef | 217 | abbrev_commit:1, |
0c47695a | 218 | abbrev_commit_given:1, |
3a30aa17 | 219 | zero_commit:1, |
7fefda5c | 220 | use_terminator:1, |
f4ea32f0 | 221 | missing_newline:1, |
9553d2b2 | 222 | date_mode_explicit:1, |
19d097e3 | 223 | preserve_subject:1, |
d1c5ae78 | 224 | encode_email_headers:1, |
225 | include_header:1; | |
8b3dce56 | 226 | unsigned int disable_stdin:1; |
1b32dece NTND |
227 | /* --show-linear-break */ |
228 | unsigned int track_linear:1, | |
229 | track_first_time:1, | |
230 | linear:1; | |
8b3dce56 | 231 | |
a5481a6c | 232 | struct date_mode date_mode; |
0893eec8 JH |
233 | int expand_tabs_in_log; /* unset if negative */ |
234 | int expand_tabs_in_log_default; | |
106d710b | 235 | |
cd2bdc53 LT |
236 | unsigned int abbrev; |
237 | enum cmit_fmt commit_format; | |
91539833 | 238 | struct log_info *loginfo; |
596524b3 | 239 | int nr, total; |
698ce6f8 | 240 | const char *mime_boundary; |
108dab28 SB |
241 | const char *patch_suffix; |
242 | int numbered_files; | |
db91988a | 243 | const char *reroll_count; |
e1a37346 | 244 | char *message_id; |
a9080475 | 245 | struct ident_split from_ident; |
b079c50e | 246 | struct string_list *ref_message_ids; |
5289c56a | 247 | int add_signoff; |
20ff0680 | 248 | const char *extra_headers; |
52883fbd | 249 | const char *log_reencode; |
2d9e4a47 | 250 | const char *subject_prefix; |
3baf58bf | 251 | int patch_name_max; |
c112f689 | 252 | int no_inline; |
9fa3465d | 253 | int show_log_size; |
0e2913b0 | 254 | struct string_list *mailmap; |
cd2bdc53 | 255 | |
8ecae9b0 | 256 | /* Filter by commit log message */ |
0843acfd | 257 | struct grep_opt grep_filter; |
8ecae9b0 | 258 | |
7fefda5c AS |
259 | /* Display history graph */ |
260 | struct git_graph *graph; | |
261 | ||
ae563542 | 262 | /* special limits */ |
d5db6c9e | 263 | int skip_count; |
ae563542 | 264 | int max_count; |
dddbad72 | 265 | timestamp_t max_age; |
96697781 | 266 | timestamp_t max_age_as_filter; |
dddbad72 | 267 | timestamp_t min_age; |
ad5aeede MG |
268 | int min_parents; |
269 | int max_parents; | |
a330de31 | 270 | int (*include_check)(struct commit *, void *); |
aa9ad6fe | 271 | int (*include_check_obj)(struct object *obj, void *); |
a330de31 | 272 | void *include_check_data; |
8efdc326 | 273 | |
cd2bdc53 | 274 | /* diff info for patches and for paths limiting */ |
c4e05b1a | 275 | struct diff_options diffopt; |
cd2bdc53 | 276 | struct diff_options pruning; |
c4e05b1a | 277 | |
8860fd42 | 278 | struct reflog_walk_info *reflog_info; |
f35f5603 | 279 | struct decoration children; |
faf0156b | 280 | struct decoration merge_simplification; |
d0af663e | 281 | struct decoration treesame; |
894a9d33 TR |
282 | |
283 | /* notes-specific options: which refs to show */ | |
284 | struct display_notes_opt notes_opt; | |
f69c5018 | 285 | |
126facf8 ES |
286 | /* interdiff */ |
287 | const struct object_id *idiff_oid1; | |
288 | const struct object_id *idiff_oid2; | |
5ac290f9 | 289 | const char *idiff_title; |
126facf8 | 290 | |
31e2617a ES |
291 | /* range-diff */ |
292 | const char *rdiff1; | |
293 | const char *rdiff2; | |
294 | int creation_factor; | |
4ee99689 | 295 | const char *rdiff_title; |
31e2617a | 296 | |
f69c5018 TR |
297 | /* commit counts */ |
298 | int count_left; | |
299 | int count_right; | |
b388e14b | 300 | int count_same; |
12da1d1f TR |
301 | |
302 | /* line level range that we are chasing */ | |
303 | struct decoration line_log_data; | |
53d00b39 TR |
304 | |
305 | /* copies of the parent lists, for --full-diff display */ | |
306 | struct saved_parents *saved_parents_slab; | |
1b32dece NTND |
307 | |
308 | struct commit_list *previous_parents; | |
309 | const char *break_bar; | |
87be2523 NTND |
310 | |
311 | struct revision_sources *sources; | |
f0d9cc41 DS |
312 | |
313 | struct topo_walk_info *topo_walk_info; | |
a56b9464 GS |
314 | |
315 | /* Commit graph bloom filter fields */ | |
c525ce95 SG |
316 | /* The bloom filter key(s) for the pathspec */ |
317 | struct bloom_key *bloom_keys; | |
318 | int bloom_keys_nr; | |
319 | ||
a56b9464 GS |
320 | /* |
321 | * The bloom filter settings used to generate the key. | |
322 | * This is loaded from the commit-graph being used. | |
323 | */ | |
324 | struct bloom_filter_settings *bloom_filter_settings; | |
c9fff000 TB |
325 | |
326 | /* misc. flags related to '--no-kept-objects' */ | |
327 | unsigned keep_pack_cache_flags; | |
7b90ab46 EN |
328 | |
329 | /* Location where temporary objects for remerge-diff are written. */ | |
330 | struct tmp_objdir *remerge_objdir; | |
ae563542 LT |
331 | }; |
332 | ||
f196c1e9 ÆAB |
333 | /** |
334 | * Initialize the "struct rev_info" structure with a macro. | |
335 | * | |
336 | * This will not fully initialize a "struct rev_info", the | |
337 | * repo_init_revisions() function needs to be called before | |
338 | * setup_revisions() and any revision walking takes place. | |
339 | * | |
340 | * Use REV_INFO_INIT to make the "struct rev_info" safe for passing to | |
341 | * release_revisions() when it's inconvenient (e.g. due to a "goto | |
342 | * cleanup" pattern) to arrange for repo_init_revisions() to be called | |
343 | * before release_revisions() is called. | |
344 | * | |
345 | * Initializing with this REV_INFO_INIT is redundant to invoking | |
346 | * repo_init_revisions(). If repo_init_revisions() is guaranteed to be | |
347 | * called before release_revisions() the "struct rev_info" can be left | |
348 | * uninitialized. | |
349 | */ | |
350 | #define REV_INFO_INIT { 0 } | |
301d595e HW |
351 | |
352 | /** | |
353 | * Initialize a rev_info structure with default values. The third parameter may | |
354 | * be NULL or can be prefix path, and then the `.prefix` variable will be set | |
355 | * to it. This is typically the first function you want to call when you want | |
356 | * to deal with a revision list. After calling this function, you are free to | |
357 | * customize options, like set `.ignore_merges` to 0 if you don't want to | |
358 | * ignore merges, and so on. | |
359 | */ | |
2abf3503 NTND |
360 | void repo_init_revisions(struct repository *r, |
361 | struct rev_info *revs, | |
362 | const char *prefix); | |
296a1438 ÆAB |
363 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS |
364 | #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix) | |
365 | #endif | |
301d595e HW |
366 | |
367 | /** | |
368 | * Parse revision information, filling in the `rev_info` structure, and | |
369 | * removing the used arguments from the argument list. Returns the number | |
370 | * of arguments left that weren't recognized, which are also moved to the | |
371 | * head of the argument list. The last parameter is used in case no | |
372 | * parameter given by the first two arguments. | |
373 | */ | |
296a1438 ÆAB |
374 | struct setup_revision_opt { |
375 | const char *def; | |
376 | void (*tweak)(struct rev_info *, struct setup_revision_opt *); | |
377 | unsigned int assume_dashdash:1, | |
378 | allow_exclude_promisor_objects:1; | |
379 | unsigned revarg_opt; | |
380 | }; | |
d16ec9cd NTND |
381 | int setup_revisions(int argc, const char **argv, struct rev_info *revs, |
382 | struct setup_revision_opt *); | |
301d595e | 383 | |
1878b5ed ÆAB |
384 | /** |
385 | * Free data allocated in a "struct rev_info" after it's been | |
f196c1e9 | 386 | * initialized with repo_init_revisions() or REV_INFO_INIT. |
1878b5ed ÆAB |
387 | */ |
388 | void release_revisions(struct rev_info *revs); | |
389 | ||
d16ec9cd NTND |
390 | void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx, |
391 | const struct option *options, | |
392 | const char * const usagestr[]); | |
8e676e8b | 393 | #define REVARG_CANNOT_BE_FILENAME 01 |
d5f6b1d7 | 394 | #define REVARG_COMMITTISH 02 |
d16ec9cd NTND |
395 | int handle_revision_arg(const char *arg, struct rev_info *revs, |
396 | int flags, unsigned revarg_opt); | |
087c7458 | 397 | void revision_opts_finish(struct rev_info *revs); |
5d6f0935 | 398 | |
301d595e HW |
399 | /** |
400 | * Reset the flags used by the revision walking api. You can use this to do | |
401 | * multiple sequential revision walks. | |
402 | */ | |
d16ec9cd | 403 | void reset_revision_walk(void); |
301d595e HW |
404 | |
405 | /** | |
406 | * Prepares the rev_info structure for a walk. You should check if it returns | |
407 | * any error (non-zero return code) and if it does not, you can start using | |
408 | * get_revision() to do the iteration. | |
409 | */ | |
d16ec9cd | 410 | int prepare_revision_walk(struct rev_info *revs); |
301d595e HW |
411 | |
412 | /** | |
413 | * Takes a pointer to a `rev_info` structure and iterates over it, returning a | |
414 | * `struct commit *` each time you call it. The end of the revision list is | |
415 | * indicated by returning a NULL pointer. | |
416 | */ | |
d16ec9cd | 417 | struct commit *get_revision(struct rev_info *revs); |
301d595e | 418 | |
49825164 DL |
419 | const char *get_revision_mark(const struct rev_info *revs, |
420 | const struct commit *commit); | |
d16ec9cd NTND |
421 | void put_revision_mark(const struct rev_info *revs, |
422 | const struct commit *commit); | |
a4a88b2b | 423 | |
9d505b7b | 424 | void mark_parents_uninteresting(struct rev_info *revs, struct commit *commit); |
b3c7eef9 | 425 | void mark_tree_uninteresting(struct repository *r, struct tree *tree); |
f1f5de44 | 426 | void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees); |
ae563542 | 427 | |
d16ec9cd | 428 | void show_object_with_name(FILE *, struct object *, const char *); |
91f17516 | 429 | |
296a1438 ÆAB |
430 | /** |
431 | * Helpers to check if a "struct string_list" item matches with | |
432 | * wildmatch(). | |
433 | */ | |
434 | int ref_excluded(struct string_list *, const char *path); | |
435 | void clear_ref_exclusion(struct string_list **); | |
436 | void add_ref_exclusion(struct string_list **, const char *exclude); | |
437 | ||
301d595e HW |
438 | /** |
439 | * This function can be used if you want to add commit objects as revision | |
440 | * information. You can use the `UNINTERESTING` object flag to indicate if | |
441 | * you want to include or exclude the given commit (and commits reachable | |
442 | * from the given commit) from the revision list. | |
443 | * | |
444 | * NOTE: If you have the commits as a string list then you probably want to | |
445 | * use setup_revisions(), instead of parsing each string and using this | |
446 | * function. | |
447 | */ | |
d16ec9cd NTND |
448 | void add_pending_object(struct rev_info *revs, |
449 | struct object *obj, const char *name); | |
301d595e | 450 | |
d16ec9cd NTND |
451 | void add_pending_oid(struct rev_info *revs, |
452 | const char *name, const struct object_id *oid, | |
453 | unsigned int flags); | |
ae563542 | 454 | |
d16ec9cd NTND |
455 | void add_head_to_pending(struct rev_info *); |
456 | void add_reflogs_to_pending(struct rev_info *, unsigned int flags); | |
457 | void add_index_objects_to_pending(struct rev_info *, unsigned int flags); | |
3384a2df | 458 | |
252a7c02 LT |
459 | enum commit_action { |
460 | commit_ignore, | |
461 | commit_show, | |
462 | commit_error | |
463 | }; | |
464 | ||
d16ec9cd NTND |
465 | enum commit_action get_commit_action(struct rev_info *revs, |
466 | struct commit *commit); | |
467 | enum commit_action simplify_commit(struct rev_info *revs, | |
468 | struct commit *commit); | |
252a7c02 | 469 | |
c7edcae0 BY |
470 | enum rewrite_result { |
471 | rewrite_one_ok, | |
472 | rewrite_one_noparents, | |
473 | rewrite_one_error | |
474 | }; | |
475 | ||
476 | typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp); | |
477 | ||
d16ec9cd NTND |
478 | int rewrite_parents(struct rev_info *revs, |
479 | struct commit *commit, | |
480 | rewrite_parent_fn_t rewrite_parent); | |
53d00b39 TR |
481 | |
482 | /* | |
0131c490 JH |
483 | * The log machinery saves the original parent list so that |
484 | * get_saved_parents() can later tell what the real parents of the | |
485 | * commits are, when commit->parents has been modified by history | |
486 | * simpification. | |
53d00b39 TR |
487 | * |
488 | * get_saved_parents() will transparently return commit->parents if | |
489 | * history simplification is off. | |
490 | */ | |
d16ec9cd | 491 | struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit); |
53d00b39 | 492 | |
296a1438 ÆAB |
493 | /** |
494 | * Global for the (undocumented) "--early-output" flag for "git log". | |
495 | */ | |
496 | typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *); | |
497 | extern volatile show_early_output_fn_t show_early_output; | |
498 | ||
ae563542 | 499 | #endif |