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