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