Merge branch 'ah/doc-gitattributes-empty-index' into maint
[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 21#define BOTTOM (1u<<10)
1b32dece
NTND
22#define TRACK_LINEAR (1u<<26)
23#define ALL_REV_FLAGS (((1u<<11)-1) | TRACK_LINEAR)
ae563542 24
33e7018c
LH
25#define DECORATE_SHORT_REFS 1
26#define DECORATE_FULL_REFS 2
27
8efdc326 28struct rev_info;
91539833 29struct log_info;
894a9d33 30struct string_list;
53d00b39 31struct saved_parents;
8efdc326 32
281eee47
JH
33struct 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,
a765499a 44 REV_CMD_MERGE_BASE,
281eee47
JH
45 REV_CMD_REV
46 } whence;
47 unsigned flags;
48 } *rev;
49};
50
ca92e59e
MZ
51#define REVISION_WALK_WALK 0
52#define REVISION_WALK_NO_WALK_SORTED 1
53#define REVISION_WALK_NO_WALK_UNSORTED 2
54
ae563542
LT
55struct rev_info {
56 /* Starting list */
57 struct commit_list *commits;
1f1e895f 58 struct object_array pending;
ae563542 59
86ab4906
JH
60 /* Parents of shown commits */
61 struct object_array boundary_commits;
62
281eee47
JH
63 /* The end-points specified by the end user */
64 struct rev_cmdline_info cmdline;
65
e7b432c5
JH
66 /* excluding from --branches, --refs, etc. expansion */
67 struct string_list *ref_excludes;
68
ae563542
LT
69 /* Basic information */
70 const char *prefix;
02e54220 71 const char *def;
afe069d1 72 struct pathspec prune_data;
08f704f2
JH
73
74 /* topo-sort */
75 enum rev_sort_order sort_order;
76
e35b6ac5
SG
77 unsigned int early_output;
78
79 unsigned int ignore_missing:1,
2db1a43f 80 ignore_missing_links:1;
cdcefbc9 81
ae563542
LT
82 /* Traversal flags */
83 unsigned int dense:1,
53b2c823 84 prune:1,
ca92e59e 85 no_walk:2,
3131b713 86 show_all:1,
ae563542 87 remove_empty_trees:1,
9202434c 88 simplify_history:1,
ae563542 89 topo_order:1,
6546b593 90 simplify_merges:1,
78892e32 91 simplify_by_decoration:1,
ae563542
LT
92 tag_objects:1,
93 tree_objects:1,
94 blob_objects:1,
5a48d240 95 verify_objects:1,
d9a83684 96 edge_hint:1,
1684c1b2 97 edge_hint_aggressive:1,
d9a83684 98 limited:1,
03a9683d 99 unpacked:1,
86ab4906 100 boundary:2,
f69c5018 101 count:1,
74bd9029 102 left_right:1,
60adf7d7
MG
103 left_only:1,
104 right_only:1,
885cf808
AS
105 rewrite_parents:1,
106 print_parents:1,
0f3a290b 107 show_source:1,
d467a525 108 show_decorations:1,
0053e902 109 reverse:1,
498bcd31 110 reverse_output_stage:1,
d7a17cad 111 cherry_pick:1,
adbbb31e 112 cherry_mark:1,
ad3f9a71 113 bisect:1,
ebdc94f3 114 ancestry_path:1,
12da1d1f
TR
115 first_parent_only:1,
116 line_level_traverse:1;
ae563542 117
cd2bdc53
LT
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 */
91539833 130 unsigned int shown_one:1,
bd1470b8 131 shown_dashes:1,
02e54220 132 show_merge:1,
66b2ed09
JH
133 show_notes:1,
134 show_notes_given:1,
0c37f1fc 135 show_signature:1,
66b2ed09 136 pretty_given:1,
4da45bef 137 abbrev_commit:1,
0c47695a 138 abbrev_commit_given:1,
3a30aa17 139 zero_commit:1,
7fefda5c 140 use_terminator:1,
f4ea32f0 141 missing_newline:1,
9553d2b2
JK
142 date_mode_explicit:1,
143 preserve_subject:1;
8b3dce56 144 unsigned int disable_stdin:1;
4a43d374 145 unsigned int leak_pending:1;
1b32dece
NTND
146 /* --show-linear-break */
147 unsigned int track_linear:1,
148 track_first_time:1,
149 linear:1;
8b3dce56 150
a5481a6c 151 struct date_mode date_mode;
0893eec8
JH
152 int expand_tabs_in_log; /* unset if negative */
153 int expand_tabs_in_log_default;
106d710b 154
cd2bdc53
LT
155 unsigned int abbrev;
156 enum cmit_fmt commit_format;
91539833 157 struct log_info *loginfo;
596524b3 158 int nr, total;
698ce6f8 159 const char *mime_boundary;
108dab28
SB
160 const char *patch_suffix;
161 int numbered_files;
5fe10fe8 162 int reroll_count;
e1a37346 163 char *message_id;
a9080475 164 struct ident_split from_ident;
b079c50e 165 struct string_list *ref_message_ids;
5289c56a 166 int add_signoff;
20ff0680 167 const char *extra_headers;
52883fbd 168 const char *log_reencode;
2d9e4a47 169 const char *subject_prefix;
c112f689 170 int no_inline;
9fa3465d 171 int show_log_size;
0e2913b0 172 struct string_list *mailmap;
cd2bdc53 173
8ecae9b0 174 /* Filter by commit log message */
0843acfd 175 struct grep_opt grep_filter;
22dfa8a2
CJ
176 /* Negate the match of grep_filter */
177 int invert_grep;
8ecae9b0 178
7fefda5c
AS
179 /* Display history graph */
180 struct git_graph *graph;
181
ae563542 182 /* special limits */
d5db6c9e 183 int skip_count;
ae563542
LT
184 int max_count;
185 unsigned long max_age;
186 unsigned long min_age;
ad5aeede
MG
187 int min_parents;
188 int max_parents;
a330de31
VM
189 int (*include_check)(struct commit *, void *);
190 void *include_check_data;
8efdc326 191
cd2bdc53 192 /* diff info for patches and for paths limiting */
c4e05b1a 193 struct diff_options diffopt;
cd2bdc53 194 struct diff_options pruning;
c4e05b1a 195
8860fd42 196 struct reflog_walk_info *reflog_info;
f35f5603 197 struct decoration children;
faf0156b 198 struct decoration merge_simplification;
d0af663e 199 struct decoration treesame;
894a9d33
TR
200
201 /* notes-specific options: which refs to show */
202 struct display_notes_opt notes_opt;
f69c5018
TR
203
204 /* commit counts */
205 int count_left;
206 int count_right;
b388e14b 207 int count_same;
12da1d1f
TR
208
209 /* line level range that we are chasing */
210 struct decoration line_log_data;
53d00b39
TR
211
212 /* copies of the parent lists, for --full-diff display */
213 struct saved_parents *saved_parents_slab;
1b32dece
NTND
214
215 struct commit_list *previous_parents;
216 const char *break_bar;
ae563542
LT
217};
218
ff32d342
JH
219extern int ref_excluded(struct string_list *, const char *path);
220void clear_ref_exclusion(struct string_list **);
221void add_ref_exclusion(struct string_list **, const char *exclude);
222
223
8efdc326 224#define REV_TREE_SAME 0
ceff8e7a
LT
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 */
8efdc326 228
ae563542 229/* revision.c */
cdcefbc9 230typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
4dc1db0b 231extern volatile show_early_output_fn_t show_early_output;
8efdc326 232
32962c9b
JH
233struct setup_revision_opt {
234 const char *def;
b4490059 235 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
9ef6aeb0 236 const char *submodule;
6d5b93f2 237 int assume_dashdash;
d5f6b1d7 238 unsigned revarg_opt;
32962c9b
JH
239};
240
db6296a5 241extern void init_revisions(struct rev_info *revs, const char *prefix);
ff5f5f26
MH
242extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
243 struct setup_revision_opt *);
6b61ec05 244extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
ff5f5f26
MH
245 const struct option *options,
246 const char * const usagestr[]);
8e676e8b 247#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7 248#define REVARG_COMMITTISH 02
ff5f5f26
MH
249extern int handle_revision_arg(const char *arg, struct rev_info *revs,
250 int flags, unsigned revarg_opt);
5d6f0935 251
bcc0a3ea 252extern void reset_revision_walk(void);
cc0e6c5a 253extern int prepare_revision_walk(struct rev_info *revs);
a4a88b2b 254extern struct commit *get_revision(struct rev_info *revs);
ff5f5f26
MH
255extern char *get_revision_mark(const struct rev_info *revs,
256 const struct commit *commit);
257extern void put_revision_mark(const struct rev_info *revs,
258 const struct commit *commit);
a4a88b2b 259
ae563542
LT
260extern void mark_parents_uninteresting(struct commit *commit);
261extern void mark_tree_uninteresting(struct tree *tree);
262
de1e67d0 263extern void show_object_with_name(FILE *, struct object *, const char *);
91f17516 264
ff5f5f26
MH
265extern void add_pending_object(struct rev_info *revs,
266 struct object *obj, const char *name);
267extern void add_pending_sha1(struct rev_info *revs,
268 const char *name, const unsigned char *sha1,
269 unsigned int flags);
ae563542 270
3384a2df 271extern void add_head_to_pending(struct rev_info *);
718ccc97 272extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
4fe10219 273extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
3384a2df 274
252a7c02
LT
275enum commit_action {
276 commit_ignore,
277 commit_show,
278 commit_error
279};
280
ff5f5f26
MH
281extern enum commit_action get_commit_action(struct rev_info *revs,
282 struct commit *commit);
283extern enum commit_action simplify_commit(struct rev_info *revs,
284 struct commit *commit);
252a7c02 285
c7edcae0
BY
286enum rewrite_result {
287 rewrite_one_ok,
288 rewrite_one_noparents,
289 rewrite_one_error
290};
291
292typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
293
294extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
295 rewrite_parent_fn_t rewrite_parent);
53d00b39
TR
296
297/*
0131c490
JH
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.
53d00b39
TR
302 *
303 * get_saved_parents() will transparently return commit->parents if
304 * history simplification is off.
305 */
53d00b39 306extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
53d00b39 307
ae563542 308#endif