]>
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" |
6b61ec05 | 11 | |
301d595e HW |
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 | ||
208acbfb | 25 | /* Remember to update object flag allocation in object.h */ |
ae563542 LT |
26 | #define SEEN (1u<<0) |
27 | #define UNINTERESTING (1u<<1) | |
7dc0fe3b | 28 | #define TREESAME (1u<<2) |
765ac8ec | 29 | #define SHOWN (1u<<3) |
7ae0b0cb | 30 | #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */ |
384e99a4 | 31 | #define BOUNDARY (1u<<5) |
2b064697 | 32 | #define CHILD_SHOWN (1u<<6) |
1b65a5aa | 33 | #define ADDED (1u<<7) /* Parents already parsed and added? */ |
577ed5c2 | 34 | #define SYMMETRIC_LEFT (1u<<8) |
adbbb31e | 35 | #define PATCHSAME (1u<<9) |
7f34a46f | 36 | #define BOTTOM (1u<<10) |
99c9aa95 MD |
37 | /* |
38 | * Indicates object was reached by traversal. i.e. not given by user on | |
39 | * command-line or stdin. | |
40 | * NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support | |
41 | * filtering trees and blobs, but it may be useful to support filtering commits | |
42 | * in the future. | |
43 | */ | |
44 | #define NOT_USER_GIVEN (1u<<25) | |
1b32dece | 45 | #define TRACK_LINEAR (1u<<26) |
99c9aa95 | 46 | #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR) |
ae563542 | 47 | |
b4542418 DS |
48 | #define TOPO_WALK_EXPLORED (1u<<27) |
49 | #define TOPO_WALK_INDEGREE (1u<<28) | |
ae563542 | 50 | |
33e7018c LH |
51 | #define DECORATE_SHORT_REFS 1 |
52 | #define DECORATE_FULL_REFS 2 | |
53 | ||
91539833 | 54 | struct log_info; |
2abf3503 NTND |
55 | struct repository; |
56 | struct rev_info; | |
894a9d33 | 57 | struct string_list; |
53d00b39 | 58 | struct saved_parents; |
87be2523 | 59 | define_shared_commit_slab(revision_sources, char *); |
8efdc326 | 60 | |
281eee47 JH |
61 | struct rev_cmdline_info { |
62 | unsigned int nr; | |
63 | unsigned int alloc; | |
64 | struct rev_cmdline_entry { | |
65 | struct object *item; | |
66 | const char *name; | |
67 | enum { | |
68 | REV_CMD_REF, | |
69 | REV_CMD_PARENTS_ONLY, | |
70 | REV_CMD_LEFT, | |
71 | REV_CMD_RIGHT, | |
a765499a | 72 | REV_CMD_MERGE_BASE, |
281eee47 JH |
73 | REV_CMD_REV |
74 | } whence; | |
75 | unsigned flags; | |
76 | } *rev; | |
77 | }; | |
78 | ||
ca92e59e MZ |
79 | #define REVISION_WALK_WALK 0 |
80 | #define REVISION_WALK_NO_WALK_SORTED 1 | |
81 | #define REVISION_WALK_NO_WALK_UNSORTED 2 | |
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 | ||
e7b432c5 JH |
98 | /* excluding from --branches, --refs, etc. expansion */ |
99 | struct string_list *ref_excludes; | |
100 | ||
ae563542 LT |
101 | /* Basic information */ |
102 | const char *prefix; | |
02e54220 | 103 | const char *def; |
afe069d1 | 104 | struct pathspec prune_data; |
08f704f2 | 105 | |
7ba82629 JK |
106 | /* |
107 | * Whether the arguments parsed by setup_revisions() included any | |
108 | * "input" revisions that might still have yielded an empty pending | |
109 | * list (e.g., patterns like "--all" or "--glob"). | |
110 | */ | |
111 | int rev_input_given; | |
112 | ||
a12cbe23 JK |
113 | /* |
114 | * Whether we read from stdin due to the --stdin option. | |
115 | */ | |
116 | int read_from_stdin; | |
117 | ||
08f704f2 JH |
118 | /* topo-sort */ |
119 | enum rev_sort_order sort_order; | |
120 | ||
e35b6ac5 SG |
121 | unsigned int early_output; |
122 | ||
123 | unsigned int ignore_missing:1, | |
2db1a43f | 124 | ignore_missing_links:1; |
cdcefbc9 | 125 | |
ae563542 LT |
126 | /* Traversal flags */ |
127 | unsigned int dense:1, | |
53b2c823 | 128 | prune:1, |
ca92e59e | 129 | no_walk:2, |
ae563542 | 130 | remove_empty_trees:1, |
9202434c | 131 | simplify_history:1, |
ae563542 | 132 | topo_order:1, |
6546b593 | 133 | simplify_merges:1, |
78892e32 | 134 | simplify_by_decoration:1, |
ff9445be | 135 | single_worktree:1, |
ae563542 LT |
136 | tag_objects:1, |
137 | tree_objects:1, | |
138 | blob_objects:1, | |
5a48d240 | 139 | verify_objects:1, |
d9a83684 | 140 | edge_hint:1, |
1684c1b2 | 141 | edge_hint_aggressive:1, |
d9a83684 | 142 | limited:1, |
03a9683d | 143 | unpacked:1, |
86ab4906 | 144 | boundary:2, |
f69c5018 | 145 | count:1, |
74bd9029 | 146 | left_right:1, |
60adf7d7 MG |
147 | left_only:1, |
148 | right_only:1, | |
885cf808 AS |
149 | rewrite_parents:1, |
150 | print_parents:1, | |
d467a525 | 151 | show_decorations:1, |
0053e902 | 152 | reverse:1, |
498bcd31 | 153 | reverse_output_stage:1, |
d7a17cad | 154 | cherry_pick:1, |
adbbb31e | 155 | cherry_mark:1, |
ad3f9a71 | 156 | bisect:1, |
ebdc94f3 | 157 | ancestry_path:1, |
12da1d1f | 158 | first_parent_only:1, |
ce5b6f9b | 159 | line_level_traverse:1, |
f3d618d2 | 160 | tree_blobs_in_commit_order:1, |
df11e196 | 161 | |
7c0fe330 MD |
162 | /* |
163 | * Blobs are shown without regard for their existence. | |
164 | * But not so for trees: unless exclude_promisor_objects | |
165 | * is set and the tree in question is a promisor object; | |
166 | * OR ignore_missing_links is set, the revision walker | |
167 | * dies with a "bad tree object HASH" message when | |
168 | * encountering a missing tree. For callers that can | |
169 | * handle missing trees and want them to be filterable | |
170 | * and showable, set this to true. The revision walker | |
171 | * will filter and show such a missing tree as usual, | |
172 | * but will not attempt to recurse into this tree | |
173 | * object. | |
174 | */ | |
175 | do_not_die_on_missing_tree:1, | |
176 | ||
df11e196 JT |
177 | /* for internal use only */ |
178 | exclude_promisor_objects:1; | |
ae563542 | 179 | |
cd2bdc53 LT |
180 | /* Diff flags */ |
181 | unsigned int diff:1, | |
182 | full_diff:1, | |
183 | show_root_diff:1, | |
184 | no_commit_id:1, | |
185 | verbose_header:1, | |
186 | ignore_merges:1, | |
187 | combine_merges:1, | |
d76ce4f7 | 188 | combined_all_paths:1, |
cd2bdc53 LT |
189 | dense_combined_merges:1, |
190 | always_show_header:1; | |
191 | ||
192 | /* Format info */ | |
1d729751 | 193 | int show_notes; |
91539833 | 194 | unsigned int shown_one:1, |
bd1470b8 | 195 | shown_dashes:1, |
02e54220 | 196 | show_merge:1, |
66b2ed09 | 197 | show_notes_given:1, |
0c37f1fc | 198 | show_signature:1, |
66b2ed09 | 199 | pretty_given:1, |
4da45bef | 200 | abbrev_commit:1, |
0c47695a | 201 | abbrev_commit_given:1, |
3a30aa17 | 202 | zero_commit:1, |
7fefda5c | 203 | use_terminator:1, |
f4ea32f0 | 204 | missing_newline:1, |
9553d2b2 JK |
205 | date_mode_explicit:1, |
206 | preserve_subject:1; | |
8b3dce56 | 207 | unsigned int disable_stdin:1; |
1b32dece NTND |
208 | /* --show-linear-break */ |
209 | unsigned int track_linear:1, | |
210 | track_first_time:1, | |
211 | linear:1; | |
8b3dce56 | 212 | |
a5481a6c | 213 | struct date_mode date_mode; |
0893eec8 JH |
214 | int expand_tabs_in_log; /* unset if negative */ |
215 | int expand_tabs_in_log_default; | |
106d710b | 216 | |
cd2bdc53 LT |
217 | unsigned int abbrev; |
218 | enum cmit_fmt commit_format; | |
91539833 | 219 | struct log_info *loginfo; |
596524b3 | 220 | int nr, total; |
698ce6f8 | 221 | const char *mime_boundary; |
108dab28 SB |
222 | const char *patch_suffix; |
223 | int numbered_files; | |
5fe10fe8 | 224 | int reroll_count; |
e1a37346 | 225 | char *message_id; |
a9080475 | 226 | struct ident_split from_ident; |
b079c50e | 227 | struct string_list *ref_message_ids; |
5289c56a | 228 | int add_signoff; |
20ff0680 | 229 | const char *extra_headers; |
52883fbd | 230 | const char *log_reencode; |
2d9e4a47 | 231 | const char *subject_prefix; |
c112f689 | 232 | int no_inline; |
9fa3465d | 233 | int show_log_size; |
0e2913b0 | 234 | struct string_list *mailmap; |
cd2bdc53 | 235 | |
8ecae9b0 | 236 | /* Filter by commit log message */ |
0843acfd | 237 | struct grep_opt grep_filter; |
22dfa8a2 CJ |
238 | /* Negate the match of grep_filter */ |
239 | int invert_grep; | |
8ecae9b0 | 240 | |
7fefda5c AS |
241 | /* Display history graph */ |
242 | struct git_graph *graph; | |
243 | ||
ae563542 | 244 | /* special limits */ |
d5db6c9e | 245 | int skip_count; |
ae563542 | 246 | int max_count; |
dddbad72 JS |
247 | timestamp_t max_age; |
248 | timestamp_t min_age; | |
ad5aeede MG |
249 | int min_parents; |
250 | int max_parents; | |
a330de31 VM |
251 | int (*include_check)(struct commit *, void *); |
252 | void *include_check_data; | |
8efdc326 | 253 | |
cd2bdc53 | 254 | /* diff info for patches and for paths limiting */ |
c4e05b1a | 255 | struct diff_options diffopt; |
cd2bdc53 | 256 | struct diff_options pruning; |
c4e05b1a | 257 | |
8860fd42 | 258 | struct reflog_walk_info *reflog_info; |
f35f5603 | 259 | struct decoration children; |
faf0156b | 260 | struct decoration merge_simplification; |
d0af663e | 261 | struct decoration treesame; |
894a9d33 TR |
262 | |
263 | /* notes-specific options: which refs to show */ | |
264 | struct display_notes_opt notes_opt; | |
f69c5018 | 265 | |
126facf8 ES |
266 | /* interdiff */ |
267 | const struct object_id *idiff_oid1; | |
268 | const struct object_id *idiff_oid2; | |
5ac290f9 | 269 | const char *idiff_title; |
126facf8 | 270 | |
31e2617a ES |
271 | /* range-diff */ |
272 | const char *rdiff1; | |
273 | const char *rdiff2; | |
274 | int creation_factor; | |
4ee99689 | 275 | const char *rdiff_title; |
31e2617a | 276 | |
f69c5018 TR |
277 | /* commit counts */ |
278 | int count_left; | |
279 | int count_right; | |
b388e14b | 280 | int count_same; |
12da1d1f TR |
281 | |
282 | /* line level range that we are chasing */ | |
283 | struct decoration line_log_data; | |
53d00b39 TR |
284 | |
285 | /* copies of the parent lists, for --full-diff display */ | |
286 | struct saved_parents *saved_parents_slab; | |
1b32dece NTND |
287 | |
288 | struct commit_list *previous_parents; | |
289 | const char *break_bar; | |
87be2523 NTND |
290 | |
291 | struct revision_sources *sources; | |
f0d9cc41 DS |
292 | |
293 | struct topo_walk_info *topo_walk_info; | |
ae563542 LT |
294 | }; |
295 | ||
d16ec9cd | 296 | int ref_excluded(struct string_list *, const char *path); |
ff32d342 JH |
297 | void clear_ref_exclusion(struct string_list **); |
298 | void add_ref_exclusion(struct string_list **, const char *exclude); | |
299 | ||
300 | ||
8efdc326 | 301 | #define REV_TREE_SAME 0 |
ceff8e7a LT |
302 | #define REV_TREE_NEW 1 /* Only new files */ |
303 | #define REV_TREE_OLD 2 /* Only files removed */ | |
304 | #define REV_TREE_DIFFERENT 3 /* Mixed changes */ | |
8efdc326 | 305 | |
ae563542 | 306 | /* revision.c */ |
cdcefbc9 | 307 | typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *); |
4dc1db0b | 308 | extern volatile show_early_output_fn_t show_early_output; |
8efdc326 | 309 | |
32962c9b JH |
310 | struct setup_revision_opt { |
311 | const char *def; | |
b4490059 | 312 | void (*tweak)(struct rev_info *, struct setup_revision_opt *); |
2abf3503 | 313 | const char *submodule; /* TODO: drop this and use rev_info->repo */ |
bbcde41a MD |
314 | unsigned int assume_dashdash:1, |
315 | allow_exclude_promisor_objects:1; | |
d5f6b1d7 | 316 | unsigned revarg_opt; |
32962c9b JH |
317 | }; |
318 | ||
2abf3503 NTND |
319 | #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS |
320 | #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix) | |
321 | #endif | |
301d595e HW |
322 | |
323 | /** | |
324 | * Initialize a rev_info structure with default values. The third parameter may | |
325 | * be NULL or can be prefix path, and then the `.prefix` variable will be set | |
326 | * to it. This is typically the first function you want to call when you want | |
327 | * to deal with a revision list. After calling this function, you are free to | |
328 | * customize options, like set `.ignore_merges` to 0 if you don't want to | |
329 | * ignore merges, and so on. | |
330 | */ | |
2abf3503 NTND |
331 | void repo_init_revisions(struct repository *r, |
332 | struct rev_info *revs, | |
333 | const char *prefix); | |
301d595e HW |
334 | |
335 | /** | |
336 | * Parse revision information, filling in the `rev_info` structure, and | |
337 | * removing the used arguments from the argument list. Returns the number | |
338 | * of arguments left that weren't recognized, which are also moved to the | |
339 | * head of the argument list. The last parameter is used in case no | |
340 | * parameter given by the first two arguments. | |
341 | */ | |
d16ec9cd NTND |
342 | int setup_revisions(int argc, const char **argv, struct rev_info *revs, |
343 | struct setup_revision_opt *); | |
301d595e | 344 | |
d16ec9cd NTND |
345 | void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx, |
346 | const struct option *options, | |
347 | const char * const usagestr[]); | |
8e676e8b | 348 | #define REVARG_CANNOT_BE_FILENAME 01 |
d5f6b1d7 | 349 | #define REVARG_COMMITTISH 02 |
d16ec9cd NTND |
350 | int handle_revision_arg(const char *arg, struct rev_info *revs, |
351 | int flags, unsigned revarg_opt); | |
5d6f0935 | 352 | |
301d595e HW |
353 | /** |
354 | * Reset the flags used by the revision walking api. You can use this to do | |
355 | * multiple sequential revision walks. | |
356 | */ | |
d16ec9cd | 357 | void reset_revision_walk(void); |
301d595e HW |
358 | |
359 | /** | |
360 | * Prepares the rev_info structure for a walk. You should check if it returns | |
361 | * any error (non-zero return code) and if it does not, you can start using | |
362 | * get_revision() to do the iteration. | |
363 | */ | |
d16ec9cd | 364 | int prepare_revision_walk(struct rev_info *revs); |
301d595e HW |
365 | |
366 | /** | |
367 | * Takes a pointer to a `rev_info` structure and iterates over it, returning a | |
368 | * `struct commit *` each time you call it. The end of the revision list is | |
369 | * indicated by returning a NULL pointer. | |
370 | */ | |
d16ec9cd | 371 | struct commit *get_revision(struct rev_info *revs); |
301d595e | 372 | |
49825164 DL |
373 | const char *get_revision_mark(const struct rev_info *revs, |
374 | const struct commit *commit); | |
d16ec9cd NTND |
375 | void put_revision_mark(const struct rev_info *revs, |
376 | const struct commit *commit); | |
a4a88b2b | 377 | |
d16ec9cd | 378 | void mark_parents_uninteresting(struct commit *commit); |
b3c7eef9 | 379 | void mark_tree_uninteresting(struct repository *r, struct tree *tree); |
f1f5de44 | 380 | void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees); |
ae563542 | 381 | |
d16ec9cd | 382 | void show_object_with_name(FILE *, struct object *, const char *); |
91f17516 | 383 | |
301d595e HW |
384 | /** |
385 | * This function can be used if you want to add commit objects as revision | |
386 | * information. You can use the `UNINTERESTING` object flag to indicate if | |
387 | * you want to include or exclude the given commit (and commits reachable | |
388 | * from the given commit) from the revision list. | |
389 | * | |
390 | * NOTE: If you have the commits as a string list then you probably want to | |
391 | * use setup_revisions(), instead of parsing each string and using this | |
392 | * function. | |
393 | */ | |
d16ec9cd NTND |
394 | void add_pending_object(struct rev_info *revs, |
395 | struct object *obj, const char *name); | |
301d595e | 396 | |
d16ec9cd NTND |
397 | void add_pending_oid(struct rev_info *revs, |
398 | const char *name, const struct object_id *oid, | |
399 | unsigned int flags); | |
ae563542 | 400 | |
d16ec9cd NTND |
401 | void add_head_to_pending(struct rev_info *); |
402 | void add_reflogs_to_pending(struct rev_info *, unsigned int flags); | |
403 | void add_index_objects_to_pending(struct rev_info *, unsigned int flags); | |
3384a2df | 404 | |
252a7c02 LT |
405 | enum commit_action { |
406 | commit_ignore, | |
407 | commit_show, | |
408 | commit_error | |
409 | }; | |
410 | ||
d16ec9cd NTND |
411 | enum commit_action get_commit_action(struct rev_info *revs, |
412 | struct commit *commit); | |
413 | enum commit_action simplify_commit(struct rev_info *revs, | |
414 | struct commit *commit); | |
252a7c02 | 415 | |
c7edcae0 BY |
416 | enum rewrite_result { |
417 | rewrite_one_ok, | |
418 | rewrite_one_noparents, | |
419 | rewrite_one_error | |
420 | }; | |
421 | ||
422 | typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp); | |
423 | ||
d16ec9cd NTND |
424 | int rewrite_parents(struct rev_info *revs, |
425 | struct commit *commit, | |
426 | rewrite_parent_fn_t rewrite_parent); | |
53d00b39 TR |
427 | |
428 | /* | |
0131c490 JH |
429 | * The log machinery saves the original parent list so that |
430 | * get_saved_parents() can later tell what the real parents of the | |
431 | * commits are, when commit->parents has been modified by history | |
432 | * simpification. | |
53d00b39 TR |
433 | * |
434 | * get_saved_parents() will transparently return commit->parents if | |
435 | * history simplification is off. | |
436 | */ | |
d16ec9cd | 437 | struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit); |
53d00b39 | 438 | |
ae563542 | 439 | #endif |