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