Merge branch 'es/doc-worktree-guessremote-config'
[git.git] / revision.h
blob52e5a88ff5725862dced5c72fbc2aa6435b94e3b
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 /* Remember to update object flag allocation in object.h */
13 #define SEEN (1u<<0)
14 #define UNINTERESTING (1u<<1)
15 #define TREESAME (1u<<2)
16 #define SHOWN (1u<<3)
17 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
18 #define BOUNDARY (1u<<5)
19 #define CHILD_SHOWN (1u<<6)
20 #define ADDED (1u<<7) /* Parents already parsed and added? */
21 #define SYMMETRIC_LEFT (1u<<8)
22 #define PATCHSAME (1u<<9)
23 #define BOTTOM (1u<<10)
25 * Indicates object was reached by traversal. i.e. not given by user on
26 * command-line or stdin.
27 * NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support
28 * filtering trees and blobs, but it may be useful to support filtering commits
29 * in the future.
31 #define NOT_USER_GIVEN (1u<<25)
32 #define TRACK_LINEAR (1u<<26)
33 #define ALL_REV_FLAGS (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR)
35 #define TOPO_WALK_EXPLORED (1u<<27)
36 #define TOPO_WALK_INDEGREE (1u<<28)
38 #define DECORATE_SHORT_REFS 1
39 #define DECORATE_FULL_REFS 2
41 struct log_info;
42 struct repository;
43 struct rev_info;
44 struct string_list;
45 struct saved_parents;
46 define_shared_commit_slab(revision_sources, char *);
48 struct rev_cmdline_info {
49 unsigned int nr;
50 unsigned int alloc;
51 struct rev_cmdline_entry {
52 struct object *item;
53 const char *name;
54 enum {
55 REV_CMD_REF,
56 REV_CMD_PARENTS_ONLY,
57 REV_CMD_LEFT,
58 REV_CMD_RIGHT,
59 REV_CMD_MERGE_BASE,
60 REV_CMD_REV
61 } whence;
62 unsigned flags;
63 } *rev;
66 #define REVISION_WALK_WALK 0
67 #define REVISION_WALK_NO_WALK_SORTED 1
68 #define REVISION_WALK_NO_WALK_UNSORTED 2
70 struct topo_walk_info;
72 struct rev_info {
73 /* Starting list */
74 struct commit_list *commits;
75 struct object_array pending;
76 struct repository *repo;
78 /* Parents of shown commits */
79 struct object_array boundary_commits;
81 /* The end-points specified by the end user */
82 struct rev_cmdline_info cmdline;
84 /* excluding from --branches, --refs, etc. expansion */
85 struct string_list *ref_excludes;
87 /* Basic information */
88 const char *prefix;
89 const char *def;
90 struct pathspec prune_data;
93 * Whether the arguments parsed by setup_revisions() included any
94 * "input" revisions that might still have yielded an empty pending
95 * list (e.g., patterns like "--all" or "--glob").
97 int rev_input_given;
100 * Whether we read from stdin due to the --stdin option.
102 int read_from_stdin;
104 /* topo-sort */
105 enum rev_sort_order sort_order;
107 unsigned int early_output;
109 unsigned int ignore_missing:1,
110 ignore_missing_links:1;
112 /* Traversal flags */
113 unsigned int dense:1,
114 prune:1,
115 no_walk:2,
116 remove_empty_trees:1,
117 simplify_history:1,
118 topo_order:1,
119 simplify_merges:1,
120 simplify_by_decoration:1,
121 single_worktree:1,
122 tag_objects:1,
123 tree_objects:1,
124 blob_objects:1,
125 verify_objects:1,
126 edge_hint:1,
127 edge_hint_aggressive:1,
128 limited:1,
129 unpacked:1,
130 boundary:2,
131 count:1,
132 left_right:1,
133 left_only:1,
134 right_only:1,
135 rewrite_parents:1,
136 print_parents:1,
137 show_decorations:1,
138 reverse:1,
139 reverse_output_stage:1,
140 cherry_pick:1,
141 cherry_mark:1,
142 bisect:1,
143 ancestry_path:1,
144 first_parent_only:1,
145 line_level_traverse:1,
146 tree_blobs_in_commit_order:1,
149 * Blobs are shown without regard for their existence.
150 * But not so for trees: unless exclude_promisor_objects
151 * is set and the tree in question is a promisor object;
152 * OR ignore_missing_links is set, the revision walker
153 * dies with a "bad tree object HASH" message when
154 * encountering a missing tree. For callers that can
155 * handle missing trees and want them to be filterable
156 * and showable, set this to true. The revision walker
157 * will filter and show such a missing tree as usual,
158 * but will not attempt to recurse into this tree
159 * object.
161 do_not_die_on_missing_tree:1,
163 /* for internal use only */
164 exclude_promisor_objects:1;
166 /* Diff flags */
167 unsigned int diff:1,
168 full_diff:1,
169 show_root_diff:1,
170 no_commit_id:1,
171 verbose_header:1,
172 ignore_merges:1,
173 combine_merges:1,
174 dense_combined_merges:1,
175 always_show_header:1;
177 /* Format info */
178 unsigned int shown_one:1,
179 shown_dashes:1,
180 show_merge:1,
181 show_notes:1,
182 show_notes_given:1,
183 show_signature:1,
184 pretty_given:1,
185 abbrev_commit:1,
186 abbrev_commit_given:1,
187 zero_commit:1,
188 use_terminator:1,
189 missing_newline:1,
190 date_mode_explicit:1,
191 preserve_subject:1;
192 unsigned int disable_stdin:1;
193 /* --show-linear-break */
194 unsigned int track_linear:1,
195 track_first_time:1,
196 linear:1;
198 struct date_mode date_mode;
199 int expand_tabs_in_log; /* unset if negative */
200 int expand_tabs_in_log_default;
202 unsigned int abbrev;
203 enum cmit_fmt commit_format;
204 struct log_info *loginfo;
205 int nr, total;
206 const char *mime_boundary;
207 const char *patch_suffix;
208 int numbered_files;
209 int reroll_count;
210 char *message_id;
211 struct ident_split from_ident;
212 struct string_list *ref_message_ids;
213 int add_signoff;
214 const char *extra_headers;
215 const char *log_reencode;
216 const char *subject_prefix;
217 int no_inline;
218 int show_log_size;
219 struct string_list *mailmap;
221 /* Filter by commit log message */
222 struct grep_opt grep_filter;
223 /* Negate the match of grep_filter */
224 int invert_grep;
226 /* Display history graph */
227 struct git_graph *graph;
229 /* special limits */
230 int skip_count;
231 int max_count;
232 timestamp_t max_age;
233 timestamp_t min_age;
234 int min_parents;
235 int max_parents;
236 int (*include_check)(struct commit *, void *);
237 void *include_check_data;
239 /* diff info for patches and for paths limiting */
240 struct diff_options diffopt;
241 struct diff_options pruning;
243 struct reflog_walk_info *reflog_info;
244 struct decoration children;
245 struct decoration merge_simplification;
246 struct decoration treesame;
248 /* notes-specific options: which refs to show */
249 struct display_notes_opt notes_opt;
251 /* interdiff */
252 const struct object_id *idiff_oid1;
253 const struct object_id *idiff_oid2;
254 const char *idiff_title;
256 /* range-diff */
257 const char *rdiff1;
258 const char *rdiff2;
259 int creation_factor;
260 const char *rdiff_title;
262 /* commit counts */
263 int count_left;
264 int count_right;
265 int count_same;
267 /* line level range that we are chasing */
268 struct decoration line_log_data;
270 /* copies of the parent lists, for --full-diff display */
271 struct saved_parents *saved_parents_slab;
273 struct commit_list *previous_parents;
274 const char *break_bar;
276 struct revision_sources *sources;
278 struct topo_walk_info *topo_walk_info;
281 int ref_excluded(struct string_list *, const char *path);
282 void clear_ref_exclusion(struct string_list **);
283 void add_ref_exclusion(struct string_list **, const char *exclude);
286 #define REV_TREE_SAME 0
287 #define REV_TREE_NEW 1 /* Only new files */
288 #define REV_TREE_OLD 2 /* Only files removed */
289 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
291 /* revision.c */
292 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
293 extern volatile show_early_output_fn_t show_early_output;
295 struct setup_revision_opt {
296 const char *def;
297 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
298 const char *submodule; /* TODO: drop this and use rev_info->repo */
299 unsigned int assume_dashdash:1,
300 allow_exclude_promisor_objects:1;
301 unsigned revarg_opt;
304 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
305 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
306 #endif
307 void repo_init_revisions(struct repository *r,
308 struct rev_info *revs,
309 const char *prefix);
310 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
311 struct setup_revision_opt *);
312 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
313 const struct option *options,
314 const char * const usagestr[]);
315 #define REVARG_CANNOT_BE_FILENAME 01
316 #define REVARG_COMMITTISH 02
317 int handle_revision_arg(const char *arg, struct rev_info *revs,
318 int flags, unsigned revarg_opt);
320 void reset_revision_walk(void);
321 int prepare_revision_walk(struct rev_info *revs);
322 struct commit *get_revision(struct rev_info *revs);
323 char *get_revision_mark(const struct rev_info *revs,
324 const struct commit *commit);
325 void put_revision_mark(const struct rev_info *revs,
326 const struct commit *commit);
328 void mark_parents_uninteresting(struct commit *commit);
329 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
331 void show_object_with_name(FILE *, struct object *, const char *);
333 void add_pending_object(struct rev_info *revs,
334 struct object *obj, const char *name);
335 void add_pending_oid(struct rev_info *revs,
336 const char *name, const struct object_id *oid,
337 unsigned int flags);
339 void add_head_to_pending(struct rev_info *);
340 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
341 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
343 enum commit_action {
344 commit_ignore,
345 commit_show,
346 commit_error
349 enum commit_action get_commit_action(struct rev_info *revs,
350 struct commit *commit);
351 enum commit_action simplify_commit(struct rev_info *revs,
352 struct commit *commit);
354 enum rewrite_result {
355 rewrite_one_ok,
356 rewrite_one_noparents,
357 rewrite_one_error
360 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
362 int rewrite_parents(struct rev_info *revs,
363 struct commit *commit,
364 rewrite_parent_fn_t rewrite_parent);
367 * The log machinery saves the original parent list so that
368 * get_saved_parents() can later tell what the real parents of the
369 * commits are, when commit->parents has been modified by history
370 * simpification.
372 * get_saved_parents() will transparently return commit->parents if
373 * history simplification is off.
375 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
377 #endif