Merge branch 'jk/warn-add-gitlink'
[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 "commit.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         /* topo-sort */
75         enum rev_sort_order sort_order;
76
77         unsigned int early_output;
78
79         unsigned int    ignore_missing:1,
80                         ignore_missing_links:1;
81
82         /* Traversal flags */
83         unsigned int    dense:1,
84                         prune:1,
85                         no_walk:2,
86                         show_all:1,
87                         remove_empty_trees:1,
88                         simplify_history:1,
89                         topo_order:1,
90                         simplify_merges:1,
91                         simplify_by_decoration:1,
92                         tag_objects:1,
93                         tree_objects:1,
94                         blob_objects:1,
95                         verify_objects:1,
96                         edge_hint:1,
97                         edge_hint_aggressive:1,
98                         limited:1,
99                         unpacked:1,
100                         boundary:2,
101                         count:1,
102                         left_right:1,
103                         left_only:1,
104                         right_only:1,
105                         rewrite_parents:1,
106                         print_parents:1,
107                         show_source:1,
108                         show_decorations:1,
109                         reverse:1,
110                         reverse_output_stage:1,
111                         cherry_pick:1,
112                         cherry_mark:1,
113                         bisect:1,
114                         ancestry_path:1,
115                         first_parent_only:1,
116                         line_level_traverse:1;
117
118         /* Diff flags */
119         unsigned int    diff:1,
120                         full_diff:1,
121                         show_root_diff:1,
122                         no_commit_id:1,
123                         verbose_header:1,
124                         ignore_merges:1,
125                         combine_merges:1,
126                         dense_combined_merges:1,
127                         always_show_header:1;
128
129         /* Format info */
130         unsigned int    shown_one:1,
131                         shown_dashes:1,
132                         show_merge:1,
133                         show_notes:1,
134                         show_notes_given:1,
135                         show_signature:1,
136                         pretty_given:1,
137                         abbrev_commit:1,
138                         abbrev_commit_given:1,
139                         zero_commit:1,
140                         use_terminator:1,
141                         missing_newline:1,
142                         date_mode_explicit:1,
143                         preserve_subject:1;
144         unsigned int    disable_stdin:1;
145         unsigned int    leak_pending:1;
146         /* --show-linear-break */
147         unsigned int    track_linear:1,
148                         track_first_time:1,
149                         linear:1;
150
151         struct date_mode date_mode;
152         int             expand_tabs_in_log; /* unset if negative */
153         int             expand_tabs_in_log_default;
154
155         unsigned int    abbrev;
156         enum cmit_fmt   commit_format;
157         struct log_info *loginfo;
158         int             nr, total;
159         const char      *mime_boundary;
160         const char      *patch_suffix;
161         int             numbered_files;
162         int             reroll_count;
163         char            *message_id;
164         struct ident_split from_ident;
165         struct string_list *ref_message_ids;
166         int             add_signoff;
167         const char      *extra_headers;
168         const char      *log_reencode;
169         const char      *subject_prefix;
170         int             no_inline;
171         int             show_log_size;
172         struct string_list *mailmap;
173
174         /* Filter by commit log message */
175         struct grep_opt grep_filter;
176         /* Negate the match of grep_filter */
177         int invert_grep;
178
179         /* Display history graph */
180         struct git_graph *graph;
181
182         /* special limits */
183         int skip_count;
184         int max_count;
185         timestamp_t max_age;
186         timestamp_t min_age;
187         int min_parents;
188         int max_parents;
189         int (*include_check)(struct commit *, void *);
190         void *include_check_data;
191
192         /* diff info for patches and for paths limiting */
193         struct diff_options diffopt;
194         struct diff_options pruning;
195
196         struct reflog_walk_info *reflog_info;
197         struct decoration children;
198         struct decoration merge_simplification;
199         struct decoration treesame;
200
201         /* notes-specific options: which refs to show */
202         struct display_notes_opt notes_opt;
203
204         /* commit counts */
205         int count_left;
206         int count_right;
207         int count_same;
208
209         /* line level range that we are chasing */
210         struct decoration line_log_data;
211
212         /* copies of the parent lists, for --full-diff display */
213         struct saved_parents *saved_parents_slab;
214
215         struct commit_list *previous_parents;
216         const char *break_bar;
217 };
218
219 extern int ref_excluded(struct string_list *, const char *path);
220 void clear_ref_exclusion(struct string_list **);
221 void add_ref_exclusion(struct string_list **, const char *exclude);
222
223
224 #define REV_TREE_SAME           0
225 #define REV_TREE_NEW            1       /* Only new files */
226 #define REV_TREE_OLD            2       /* Only files removed */
227 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
228
229 /* revision.c */
230 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
231 extern volatile show_early_output_fn_t show_early_output;
232
233 struct setup_revision_opt {
234         const char *def;
235         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
236         const char *submodule;
237         int assume_dashdash;
238         unsigned revarg_opt;
239 };
240
241 extern void init_revisions(struct rev_info *revs, const char *prefix);
242 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
243                            struct setup_revision_opt *);
244 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
245                                const struct option *options,
246                                const char * const usagestr[]);
247 #define REVARG_CANNOT_BE_FILENAME 01
248 #define REVARG_COMMITTISH 02
249 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
250                                int flags, unsigned revarg_opt);
251
252 extern void reset_revision_walk(void);
253 extern int prepare_revision_walk(struct rev_info *revs);
254 extern struct commit *get_revision(struct rev_info *revs);
255 extern char *get_revision_mark(const struct rev_info *revs,
256                                const struct commit *commit);
257 extern void put_revision_mark(const struct rev_info *revs,
258                               const struct commit *commit);
259
260 extern void mark_parents_uninteresting(struct commit *commit);
261 extern void mark_tree_uninteresting(struct tree *tree);
262
263 extern void show_object_with_name(FILE *, struct object *, const char *);
264
265 extern void add_pending_object(struct rev_info *revs,
266                                struct object *obj, const char *name);
267 extern void add_pending_oid(struct rev_info *revs,
268                             const char *name, const struct object_id *oid,
269                             unsigned int flags);
270
271 extern void add_head_to_pending(struct rev_info *);
272 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
273 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
274
275 enum commit_action {
276         commit_ignore,
277         commit_show,
278         commit_error
279 };
280
281 extern enum commit_action get_commit_action(struct rev_info *revs,
282                                             struct commit *commit);
283 extern enum commit_action simplify_commit(struct rev_info *revs,
284                                           struct commit *commit);
285
286 enum rewrite_result {
287         rewrite_one_ok,
288         rewrite_one_noparents,
289         rewrite_one_error
290 };
291
292 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
293
294 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
295         rewrite_parent_fn_t rewrite_parent);
296
297 /*
298  * The log machinery saves the original parent list so that
299  * get_saved_parents() can later tell what the real parents of the
300  * commits are, when commit->parents has been modified by history
301  * simpification.
302  *
303  * get_saved_parents() will transparently return commit->parents if
304  * history simplification is off.
305  */
306 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
307
308 #endif