Merge branch 'jg/status-config'
[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
9 #define SEEN            (1u<<0)
10 #define UNINTERESTING   (1u<<1)
11 #define TREESAME        (1u<<2)
12 #define SHOWN           (1u<<3)
13 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
14 #define BOUNDARY        (1u<<5)
15 #define CHILD_SHOWN     (1u<<6)
16 #define ADDED           (1u<<7) /* Parents already parsed and added? */
17 #define SYMMETRIC_LEFT  (1u<<8)
18 #define PATCHSAME       (1u<<9)
19 #define BOTTOM          (1u<<10)
20 #define ALL_REV_FLAGS   ((1u<<11)-1)
21
22 #define DECORATE_SHORT_REFS     1
23 #define DECORATE_FULL_REFS      2
24
25 struct rev_info;
26 struct log_info;
27 struct string_list;
28
29 struct rev_cmdline_info {
30         unsigned int nr;
31         unsigned int alloc;
32         struct rev_cmdline_entry {
33                 struct object *item;
34                 const char *name;
35                 enum {
36                         REV_CMD_REF,
37                         REV_CMD_PARENTS_ONLY,
38                         REV_CMD_LEFT,
39                         REV_CMD_RIGHT,
40                         REV_CMD_MERGE_BASE,
41                         REV_CMD_REV
42                 } whence;
43                 unsigned flags;
44         } *rev;
45 };
46
47 #define REVISION_WALK_WALK 0
48 #define REVISION_WALK_NO_WALK_SORTED 1
49 #define REVISION_WALK_NO_WALK_UNSORTED 2
50
51 struct rev_info {
52         /* Starting list */
53         struct commit_list *commits;
54         struct object_array pending;
55
56         /* Parents of shown commits */
57         struct object_array boundary_commits;
58
59         /* The end-points specified by the end user */
60         struct rev_cmdline_info cmdline;
61
62         /* Basic information */
63         const char *prefix;
64         const char *def;
65         struct pathspec prune_data;
66
67         /* topo-sort */
68         enum rev_sort_order sort_order;
69
70         unsigned int    early_output:1,
71                         ignore_missing:1;
72
73         /* Traversal flags */
74         unsigned int    dense:1,
75                         prune:1,
76                         no_walk:2,
77                         show_all:1,
78                         remove_empty_trees:1,
79                         simplify_history:1,
80                         topo_order:1,
81                         simplify_merges:1,
82                         simplify_by_decoration:1,
83                         tag_objects:1,
84                         tree_objects:1,
85                         blob_objects:1,
86                         verify_objects:1,
87                         edge_hint:1,
88                         limited:1,
89                         unpacked:1,
90                         boundary:2,
91                         count:1,
92                         left_right:1,
93                         left_only:1,
94                         right_only:1,
95                         rewrite_parents:1,
96                         print_parents:1,
97                         show_source:1,
98                         show_decorations:1,
99                         reverse:1,
100                         reverse_output_stage:1,
101                         cherry_pick:1,
102                         cherry_mark:1,
103                         bisect:1,
104                         ancestry_path:1,
105                         first_parent_only:1,
106                         line_level_traverse:1;
107
108         /* Diff flags */
109         unsigned int    diff:1,
110                         full_diff:1,
111                         show_root_diff:1,
112                         no_commit_id:1,
113                         verbose_header:1,
114                         ignore_merges:1,
115                         combine_merges:1,
116                         dense_combined_merges:1,
117                         always_show_header:1;
118
119         /* Format info */
120         unsigned int    shown_one:1,
121                         shown_dashes:1,
122                         show_merge:1,
123                         show_notes:1,
124                         show_notes_given:1,
125                         show_signature:1,
126                         pretty_given:1,
127                         abbrev_commit:1,
128                         abbrev_commit_given:1,
129                         use_terminator:1,
130                         missing_newline:1,
131                         date_mode_explicit:1,
132                         preserve_subject:1;
133         unsigned int    disable_stdin:1;
134         unsigned int    leak_pending:1;
135
136         enum date_mode date_mode;
137
138         unsigned int    abbrev;
139         enum cmit_fmt   commit_format;
140         struct log_info *loginfo;
141         int             nr, total;
142         const char      *mime_boundary;
143         const char      *patch_suffix;
144         int             numbered_files;
145         int             reroll_count;
146         char            *message_id;
147         struct string_list *ref_message_ids;
148         int             add_signoff;
149         const char      *extra_headers;
150         const char      *log_reencode;
151         const char      *subject_prefix;
152         int             no_inline;
153         int             show_log_size;
154         struct string_list *mailmap;
155
156         /* Filter by commit log message */
157         struct grep_opt grep_filter;
158
159         /* Display history graph */
160         struct git_graph *graph;
161
162         /* special limits */
163         int skip_count;
164         int max_count;
165         unsigned long max_age;
166         unsigned long min_age;
167         int min_parents;
168         int max_parents;
169
170         /* diff info for patches and for paths limiting */
171         struct diff_options diffopt;
172         struct diff_options pruning;
173
174         struct reflog_walk_info *reflog_info;
175         struct decoration children;
176         struct decoration merge_simplification;
177         struct decoration treesame;
178
179         /* notes-specific options: which refs to show */
180         struct display_notes_opt notes_opt;
181
182         /* commit counts */
183         int count_left;
184         int count_right;
185         int count_same;
186
187         /* line level range that we are chasing */
188         struct decoration line_log_data;
189 };
190
191 #define REV_TREE_SAME           0
192 #define REV_TREE_NEW            1       /* Only new files */
193 #define REV_TREE_OLD            2       /* Only files removed */
194 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
195
196 /* revision.c */
197 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
198 extern volatile show_early_output_fn_t show_early_output;
199
200 struct setup_revision_opt {
201         const char *def;
202         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
203         const char *submodule;
204         int assume_dashdash;
205         unsigned revarg_opt;
206 };
207
208 extern void init_revisions(struct rev_info *revs, const char *prefix);
209 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
210                            struct setup_revision_opt *);
211 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
212                                const struct option *options,
213                                const char * const usagestr[]);
214 #define REVARG_CANNOT_BE_FILENAME 01
215 #define REVARG_COMMITTISH 02
216 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
217                                int flags, unsigned revarg_opt);
218
219 extern void reset_revision_walk(void);
220 extern int prepare_revision_walk(struct rev_info *revs);
221 extern struct commit *get_revision(struct rev_info *revs);
222 extern char *get_revision_mark(const struct rev_info *revs,
223                                const struct commit *commit);
224 extern void put_revision_mark(const struct rev_info *revs,
225                               const struct commit *commit);
226
227 extern void mark_parents_uninteresting(struct commit *commit);
228 extern void mark_tree_uninteresting(struct tree *tree);
229
230 struct name_path {
231         struct name_path *up;
232         int elem_len;
233         const char *elem;
234 };
235
236 char *path_name(const struct name_path *path, const char *name);
237
238 extern void show_object_with_name(FILE *, struct object *,
239                                   const struct name_path *, const char *);
240
241 extern void add_object(struct object *obj,
242                        struct object_array *p,
243                        struct name_path *path,
244                        const char *name);
245
246 extern void add_pending_object(struct rev_info *revs,
247                                struct object *obj, const char *name);
248 extern void add_pending_sha1(struct rev_info *revs,
249                              const char *name, const unsigned char *sha1,
250                              unsigned int flags);
251
252 extern void add_head_to_pending(struct rev_info *);
253
254 enum commit_action {
255         commit_ignore,
256         commit_show,
257         commit_error
258 };
259
260 extern enum commit_action get_commit_action(struct rev_info *revs,
261                                             struct commit *commit);
262 extern enum commit_action simplify_commit(struct rev_info *revs,
263                                           struct commit *commit);
264
265 enum rewrite_result {
266         rewrite_one_ok,
267         rewrite_one_noparents,
268         rewrite_one_error
269 };
270
271 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
272
273 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
274         rewrite_parent_fn_t rewrite_parent);
275 #endif