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