object.h: centralize object flag allocation
[git/git.git] / revision.h
CommitLineData
ae563542
LT
1#ifndef REVISION_H
2#define REVISION_H
3
6b61ec05 4#include "parse-options.h"
0843acfd 5#include "grep.h"
894a9d33 6#include "notes.h"
08f704f2 7#include "commit.h"
19ecb564 8#include "diff.h"
6b61ec05 9
208acbfb 10/* Remember to update object flag allocation in object.h */
ae563542
LT
11#define SEEN (1u<<0)
12#define UNINTERESTING (1u<<1)
7dc0fe3b 13#define TREESAME (1u<<2)
765ac8ec 14#define SHOWN (1u<<3)
7ae0b0cb 15#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
384e99a4 16#define BOUNDARY (1u<<5)
2b064697 17#define CHILD_SHOWN (1u<<6)
1b65a5aa 18#define ADDED (1u<<7) /* Parents already parsed and added? */
577ed5c2 19#define SYMMETRIC_LEFT (1u<<8)
adbbb31e 20#define PATCHSAME (1u<<9)
7f34a46f
KB
21#define BOTTOM (1u<<10)
22#define ALL_REV_FLAGS ((1u<<11)-1)
ae563542 23
33e7018c
LH
24#define DECORATE_SHORT_REFS 1
25#define DECORATE_FULL_REFS 2
26
8efdc326 27struct rev_info;
91539833 28struct log_info;
894a9d33 29struct string_list;
53d00b39 30struct saved_parents;
8efdc326 31
281eee47
JH
32struct rev_cmdline_info {
33 unsigned int nr;
34 unsigned int alloc;
35 struct rev_cmdline_entry {
36 struct object *item;
37 const char *name;
38 enum {
39 REV_CMD_REF,
40 REV_CMD_PARENTS_ONLY,
41 REV_CMD_LEFT,
42 REV_CMD_RIGHT,
a765499a 43 REV_CMD_MERGE_BASE,
281eee47
JH
44 REV_CMD_REV
45 } whence;
46 unsigned flags;
47 } *rev;
48};
49
ca92e59e
MZ
50#define REVISION_WALK_WALK 0
51#define REVISION_WALK_NO_WALK_SORTED 1
52#define REVISION_WALK_NO_WALK_UNSORTED 2
53
ae563542
LT
54struct rev_info {
55 /* Starting list */
56 struct commit_list *commits;
1f1e895f 57 struct object_array pending;
ae563542 58
86ab4906
JH
59 /* Parents of shown commits */
60 struct object_array boundary_commits;
61
281eee47
JH
62 /* The end-points specified by the end user */
63 struct rev_cmdline_info cmdline;
64
e7b432c5
JH
65 /* excluding from --branches, --refs, etc. expansion */
66 struct string_list *ref_excludes;
67
ae563542
LT
68 /* Basic information */
69 const char *prefix;
02e54220 70 const char *def;
afe069d1 71 struct pathspec prune_data;
08f704f2
JH
72
73 /* topo-sort */
74 enum rev_sort_order sort_order;
75
cc243c3c
JH
76 unsigned int early_output:1,
77 ignore_missing:1;
cdcefbc9 78
ae563542
LT
79 /* Traversal flags */
80 unsigned int dense:1,
53b2c823 81 prune:1,
ca92e59e 82 no_walk:2,
3131b713 83 show_all:1,
ae563542 84 remove_empty_trees:1,
9202434c 85 simplify_history:1,
ae563542 86 topo_order:1,
6546b593 87 simplify_merges:1,
78892e32 88 simplify_by_decoration:1,
ae563542
LT
89 tag_objects:1,
90 tree_objects:1,
91 blob_objects:1,
5a48d240 92 verify_objects:1,
d9a83684
LT
93 edge_hint:1,
94 limited:1,
03a9683d 95 unpacked:1,
86ab4906 96 boundary:2,
f69c5018 97 count:1,
74bd9029 98 left_right:1,
60adf7d7
MG
99 left_only:1,
100 right_only:1,
885cf808
AS
101 rewrite_parents:1,
102 print_parents:1,
0f3a290b 103 show_source:1,
d467a525 104 show_decorations:1,
0053e902 105 reverse:1,
498bcd31 106 reverse_output_stage:1,
d7a17cad 107 cherry_pick:1,
adbbb31e 108 cherry_mark:1,
ad3f9a71 109 bisect:1,
ebdc94f3 110 ancestry_path:1,
12da1d1f
TR
111 first_parent_only:1,
112 line_level_traverse:1;
ae563542 113
cd2bdc53
LT
114 /* Diff flags */
115 unsigned int diff:1,
116 full_diff:1,
117 show_root_diff:1,
118 no_commit_id:1,
119 verbose_header:1,
120 ignore_merges:1,
121 combine_merges:1,
122 dense_combined_merges:1,
123 always_show_header:1;
124
125 /* Format info */
91539833 126 unsigned int shown_one:1,
bd1470b8 127 shown_dashes:1,
02e54220 128 show_merge:1,
66b2ed09
JH
129 show_notes:1,
130 show_notes_given:1,
0c37f1fc 131 show_signature:1,
66b2ed09 132 pretty_given:1,
4da45bef 133 abbrev_commit:1,
0c47695a 134 abbrev_commit_given:1,
7fefda5c 135 use_terminator:1,
f4ea32f0 136 missing_newline:1,
9553d2b2
JK
137 date_mode_explicit:1,
138 preserve_subject:1;
8b3dce56 139 unsigned int disable_stdin:1;
4a43d374 140 unsigned int leak_pending:1;
8b3dce56 141
a7b02ccf 142 enum date_mode date_mode;
106d710b 143
cd2bdc53
LT
144 unsigned int abbrev;
145 enum cmit_fmt commit_format;
91539833 146 struct log_info *loginfo;
596524b3 147 int nr, total;
698ce6f8 148 const char *mime_boundary;
108dab28
SB
149 const char *patch_suffix;
150 int numbered_files;
5fe10fe8 151 int reroll_count;
e1a37346 152 char *message_id;
a9080475 153 struct ident_split from_ident;
b079c50e 154 struct string_list *ref_message_ids;
5289c56a 155 int add_signoff;
20ff0680 156 const char *extra_headers;
52883fbd 157 const char *log_reencode;
2d9e4a47 158 const char *subject_prefix;
c112f689 159 int no_inline;
9fa3465d 160 int show_log_size;
0e2913b0 161 struct string_list *mailmap;
cd2bdc53 162
8ecae9b0 163 /* Filter by commit log message */
0843acfd 164 struct grep_opt grep_filter;
8ecae9b0 165
7fefda5c
AS
166 /* Display history graph */
167 struct git_graph *graph;
168
ae563542 169 /* special limits */
d5db6c9e 170 int skip_count;
ae563542
LT
171 int max_count;
172 unsigned long max_age;
173 unsigned long min_age;
ad5aeede
MG
174 int min_parents;
175 int max_parents;
8efdc326 176
cd2bdc53 177 /* diff info for patches and for paths limiting */
c4e05b1a 178 struct diff_options diffopt;
cd2bdc53 179 struct diff_options pruning;
c4e05b1a 180
8860fd42 181 struct reflog_walk_info *reflog_info;
f35f5603 182 struct decoration children;
faf0156b 183 struct decoration merge_simplification;
d0af663e 184 struct decoration treesame;
894a9d33
TR
185
186 /* notes-specific options: which refs to show */
187 struct display_notes_opt notes_opt;
f69c5018
TR
188
189 /* commit counts */
190 int count_left;
191 int count_right;
b388e14b 192 int count_same;
12da1d1f
TR
193
194 /* line level range that we are chasing */
195 struct decoration line_log_data;
53d00b39
TR
196
197 /* copies of the parent lists, for --full-diff display */
198 struct saved_parents *saved_parents_slab;
ae563542
LT
199};
200
ff32d342
JH
201extern int ref_excluded(struct string_list *, const char *path);
202void clear_ref_exclusion(struct string_list **);
203void add_ref_exclusion(struct string_list **, const char *exclude);
204
205
8efdc326 206#define REV_TREE_SAME 0
ceff8e7a
LT
207#define REV_TREE_NEW 1 /* Only new files */
208#define REV_TREE_OLD 2 /* Only files removed */
209#define REV_TREE_DIFFERENT 3 /* Mixed changes */
8efdc326 210
ae563542 211/* revision.c */
cdcefbc9 212typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
4dc1db0b 213extern volatile show_early_output_fn_t show_early_output;
8efdc326 214
32962c9b
JH
215struct setup_revision_opt {
216 const char *def;
b4490059 217 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
9ef6aeb0 218 const char *submodule;
6d5b93f2 219 int assume_dashdash;
d5f6b1d7 220 unsigned revarg_opt;
32962c9b
JH
221};
222
db6296a5 223extern void init_revisions(struct rev_info *revs, const char *prefix);
ff5f5f26
MH
224extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
225 struct setup_revision_opt *);
6b61ec05 226extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
ff5f5f26
MH
227 const struct option *options,
228 const char * const usagestr[]);
8e676e8b 229#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7 230#define REVARG_COMMITTISH 02
ff5f5f26
MH
231extern int handle_revision_arg(const char *arg, struct rev_info *revs,
232 int flags, unsigned revarg_opt);
5d6f0935 233
bcc0a3ea 234extern void reset_revision_walk(void);
cc0e6c5a 235extern int prepare_revision_walk(struct rev_info *revs);
a4a88b2b 236extern struct commit *get_revision(struct rev_info *revs);
ff5f5f26
MH
237extern char *get_revision_mark(const struct rev_info *revs,
238 const struct commit *commit);
239extern void put_revision_mark(const struct rev_info *revs,
240 const struct commit *commit);
a4a88b2b 241
ae563542
LT
242extern void mark_parents_uninteresting(struct commit *commit);
243extern void mark_tree_uninteresting(struct tree *tree);
244
245struct name_path {
246 struct name_path *up;
247 int elem_len;
248 const char *elem;
249};
250
cf2ab916 251char *path_name(const struct name_path *path, const char *name);
8d2dfc49 252
ff5f5f26
MH
253extern void show_object_with_name(FILE *, struct object *,
254 const struct name_path *, const char *);
91f17516 255
1f1e895f
LT
256extern void add_object(struct object *obj,
257 struct object_array *p,
258 struct name_path *path,
259 const char *name);
260
ff5f5f26
MH
261extern void add_pending_object(struct rev_info *revs,
262 struct object *obj, const char *name);
263extern void add_pending_sha1(struct rev_info *revs,
264 const char *name, const unsigned char *sha1,
265 unsigned int flags);
ae563542 266
3384a2df
JH
267extern void add_head_to_pending(struct rev_info *);
268
252a7c02
LT
269enum commit_action {
270 commit_ignore,
271 commit_show,
272 commit_error
273};
274
ff5f5f26
MH
275extern enum commit_action get_commit_action(struct rev_info *revs,
276 struct commit *commit);
277extern enum commit_action simplify_commit(struct rev_info *revs,
278 struct commit *commit);
252a7c02 279
c7edcae0
BY
280enum rewrite_result {
281 rewrite_one_ok,
282 rewrite_one_noparents,
283 rewrite_one_error
284};
285
286typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
287
288extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
289 rewrite_parent_fn_t rewrite_parent);
53d00b39
TR
290
291/*
292 * Save a copy of the parent list, and return the saved copy. This is
293 * used by the log machinery to retrieve the original parents when
294 * commit->parents has been modified by history simpification.
295 *
296 * You may only call save_parents() once per commit (this is checked
297 * for non-root commits).
298 *
299 * get_saved_parents() will transparently return commit->parents if
300 * history simplification is off.
301 */
302extern void save_parents(struct rev_info *revs, struct commit *commit);
303extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
304extern void free_saved_parents(struct rev_info *revs);
305
ae563542 306#endif