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