Merge branch 'rs/lose-leak-pending'
[git/git.git] / revision.h
1 #ifndef REVISION_H
2 #define REVISION_H
3
4 #include "parse-options.h"
5 #include "grep.h"
6 #include "notes.h"
7 #include "pretty.h"
8 #include "diff.h"
9
10 /* Remember to update object flag allocation in object.h */
11 #define SEEN (1u<<0)
12 #define UNINTERESTING (1u<<1)
13 #define TREESAME (1u<<2)
14 #define SHOWN (1u<<3)
15 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
16 #define BOUNDARY (1u<<5)
17 #define CHILD_SHOWN (1u<<6)
18 #define ADDED (1u<<7) /* Parents already parsed and added? */
19 #define SYMMETRIC_LEFT (1u<<8)
20 #define PATCHSAME (1u<<9)
21 #define BOTTOM (1u<<10)
22 #define TRACK_LINEAR (1u<<26)
23 #define ALL_REV_FLAGS (((1u<<11)-1) | TRACK_LINEAR)
24
25 #define DECORATE_SHORT_REFS 1
26 #define DECORATE_FULL_REFS 2
27
28 struct rev_info;
29 struct log_info;
30 struct string_list;
31 struct saved_parents;
32
33 struct rev_cmdline_info {
34 unsigned int nr;
35 unsigned int alloc;
36 struct rev_cmdline_entry {
37 struct object *item;
38 const char *name;
39 enum {
40 REV_CMD_REF,
41 REV_CMD_PARENTS_ONLY,
42 REV_CMD_LEFT,
43 REV_CMD_RIGHT,
44 REV_CMD_MERGE_BASE,
45 REV_CMD_REV
46 } whence;
47 unsigned flags;
48 } *rev;
49 };
50
51 #define REVISION_WALK_WALK 0
52 #define REVISION_WALK_NO_WALK_SORTED 1
53 #define REVISION_WALK_NO_WALK_UNSORTED 2
54
55 struct rev_info {
56 /* Starting list */
57 struct commit_list *commits;
58 struct object_array pending;
59
60 /* Parents of shown commits */
61 struct object_array boundary_commits;
62
63 /* The end-points specified by the end user */
64 struct rev_cmdline_info cmdline;
65
66 /* excluding from --branches, --refs, etc. expansion */
67 struct string_list *ref_excludes;
68
69 /* Basic information */
70 const char *prefix;
71 const char *def;
72 struct pathspec prune_data;
73
74 /*
75 * Whether the arguments parsed by setup_revisions() included any
76 * "input" revisions that might still have yielded an empty pending
77 * list (e.g., patterns like "--all" or "--glob").
78 */
79 int rev_input_given;
80
81 /* topo-sort */
82 enum rev_sort_order sort_order;
83
84 unsigned int early_output;
85
86 unsigned int ignore_missing:1,
87 ignore_missing_links:1;
88
89 /* Traversal flags */
90 unsigned int dense:1,
91 prune:1,
92 no_walk:2,
93 show_all:1,
94 remove_empty_trees:1,
95 simplify_history:1,
96 topo_order:1,
97 simplify_merges:1,
98 simplify_by_decoration:1,
99 single_worktree:1,
100 tag_objects:1,
101 tree_objects:1,
102 blob_objects:1,
103 verify_objects:1,
104 edge_hint:1,
105 edge_hint_aggressive:1,
106 limited:1,
107 unpacked:1,
108 boundary:2,
109 count:1,
110 left_right:1,
111 left_only:1,
112 right_only:1,
113 rewrite_parents:1,
114 print_parents:1,
115 show_source:1,
116 show_decorations:1,
117 reverse:1,
118 reverse_output_stage:1,
119 cherry_pick:1,
120 cherry_mark:1,
121 bisect:1,
122 ancestry_path:1,
123 first_parent_only:1,
124 line_level_traverse:1,
125 tree_blobs_in_commit_order:1;
126
127 /* Diff flags */
128 unsigned int diff:1,
129 full_diff:1,
130 show_root_diff:1,
131 no_commit_id:1,
132 verbose_header:1,
133 ignore_merges:1,
134 combine_merges:1,
135 dense_combined_merges:1,
136 always_show_header:1;
137
138 /* Format info */
139 unsigned int shown_one:1,
140 shown_dashes:1,
141 show_merge:1,
142 show_notes:1,
143 show_notes_given:1,
144 show_signature:1,
145 pretty_given:1,
146 abbrev_commit:1,
147 abbrev_commit_given:1,
148 zero_commit:1,
149 use_terminator:1,
150 missing_newline:1,
151 date_mode_explicit:1,
152 preserve_subject:1;
153 unsigned int disable_stdin:1;
154 /* --show-linear-break */
155 unsigned int track_linear:1,
156 track_first_time:1,
157 linear:1;
158
159 struct date_mode date_mode;
160 int expand_tabs_in_log; /* unset if negative */
161 int expand_tabs_in_log_default;
162
163 unsigned int abbrev;
164 enum cmit_fmt commit_format;
165 struct log_info *loginfo;
166 int nr, total;
167 const char *mime_boundary;
168 const char *patch_suffix;
169 int numbered_files;
170 int reroll_count;
171 char *message_id;
172 struct ident_split from_ident;
173 struct string_list *ref_message_ids;
174 int add_signoff;
175 const char *extra_headers;
176 const char *log_reencode;
177 const char *subject_prefix;
178 int no_inline;
179 int show_log_size;
180 struct string_list *mailmap;
181
182 /* Filter by commit log message */
183 struct grep_opt grep_filter;
184 /* Negate the match of grep_filter */
185 int invert_grep;
186
187 /* Display history graph */
188 struct git_graph *graph;
189
190 /* special limits */
191 int skip_count;
192 int max_count;
193 timestamp_t max_age;
194 timestamp_t min_age;
195 int min_parents;
196 int max_parents;
197 int (*include_check)(struct commit *, void *);
198 void *include_check_data;
199
200 /* diff info for patches and for paths limiting */
201 struct diff_options diffopt;
202 struct diff_options pruning;
203
204 struct reflog_walk_info *reflog_info;
205 struct decoration children;
206 struct decoration merge_simplification;
207 struct decoration treesame;
208
209 /* notes-specific options: which refs to show */
210 struct display_notes_opt notes_opt;
211
212 /* commit counts */
213 int count_left;
214 int count_right;
215 int count_same;
216
217 /* line level range that we are chasing */
218 struct decoration line_log_data;
219
220 /* copies of the parent lists, for --full-diff display */
221 struct saved_parents *saved_parents_slab;
222
223 struct commit_list *previous_parents;
224 const char *break_bar;
225 };
226
227 extern int ref_excluded(struct string_list *, const char *path);
228 void clear_ref_exclusion(struct string_list **);
229 void add_ref_exclusion(struct string_list **, const char *exclude);
230
231
232 #define REV_TREE_SAME 0
233 #define REV_TREE_NEW 1 /* Only new files */
234 #define REV_TREE_OLD 2 /* Only files removed */
235 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
236
237 /* revision.c */
238 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
239 extern volatile show_early_output_fn_t show_early_output;
240
241 struct setup_revision_opt {
242 const char *def;
243 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
244 const char *submodule;
245 int assume_dashdash;
246 unsigned revarg_opt;
247 };
248
249 extern void init_revisions(struct rev_info *revs, const char *prefix);
250 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
251 struct setup_revision_opt *);
252 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
253 const struct option *options,
254 const char * const usagestr[]);
255 #define REVARG_CANNOT_BE_FILENAME 01
256 #define REVARG_COMMITTISH 02
257 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
258 int flags, unsigned revarg_opt);
259
260 extern void reset_revision_walk(void);
261 extern int prepare_revision_walk(struct rev_info *revs);
262 extern struct commit *get_revision(struct rev_info *revs);
263 extern char *get_revision_mark(const struct rev_info *revs,
264 const struct commit *commit);
265 extern void put_revision_mark(const struct rev_info *revs,
266 const struct commit *commit);
267
268 extern void mark_parents_uninteresting(struct commit *commit);
269 extern void mark_tree_uninteresting(struct tree *tree);
270
271 extern void show_object_with_name(FILE *, struct object *, const char *);
272
273 extern void add_pending_object(struct rev_info *revs,
274 struct object *obj, const char *name);
275 extern void add_pending_oid(struct rev_info *revs,
276 const char *name, const struct object_id *oid,
277 unsigned int flags);
278
279 extern void add_head_to_pending(struct rev_info *);
280 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
281 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
282
283 enum commit_action {
284 commit_ignore,
285 commit_show,
286 commit_error
287 };
288
289 extern enum commit_action get_commit_action(struct rev_info *revs,
290 struct commit *commit);
291 extern enum commit_action simplify_commit(struct rev_info *revs,
292 struct commit *commit);
293
294 enum rewrite_result {
295 rewrite_one_ok,
296 rewrite_one_noparents,
297 rewrite_one_error
298 };
299
300 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
301
302 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
303 rewrite_parent_fn_t rewrite_parent);
304
305 /*
306 * The log machinery saves the original parent list so that
307 * get_saved_parents() can later tell what the real parents of the
308 * commits are, when commit->parents has been modified by history
309 * simpification.
310 *
311 * get_saved_parents() will transparently return commit->parents if
312 * history simplification is off.
313 */
314 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
315
316 #endif