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