l10n: bg.po: Updated Bulgarian translation (4839t)
[git] / revision.h
1 #ifndef REVISION_H
2 #define REVISION_H
3
4 #include "commit.h"
5 #include "parse-options.h"
6 #include "grep.h"
7 #include "notes.h"
8 #include "pretty.h"
9 #include "diff.h"
10 #include "commit-slab-decl.h"
11
12 /**
13  * The revision walking API offers functions to build a list of revisions
14  * and then iterate over that list.
15  *
16  * Calling sequence
17  * ----------------
18  *
19  * The walking API has a given calling sequence: first you need to initialize
20  * a rev_info structure, then add revisions to control what kind of revision
21  * list do you want to get, finally you can iterate over the revision list.
22  *
23  */
24
25 /* Remember to update object flag allocation in object.h */
26 #define SEEN            (1u<<0)
27 #define UNINTERESTING   (1u<<1)
28 #define TREESAME        (1u<<2)
29 #define SHOWN           (1u<<3)
30 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
31 #define BOUNDARY        (1u<<5)
32 #define CHILD_SHOWN     (1u<<6)
33 #define ADDED           (1u<<7) /* Parents already parsed and added? */
34 #define SYMMETRIC_LEFT  (1u<<8)
35 #define PATCHSAME       (1u<<9)
36 #define BOTTOM          (1u<<10)
37 /*
38  * Indicates object was reached by traversal. i.e. not given by user on
39  * command-line or stdin.
40  * NEEDSWORK: NOT_USER_GIVEN doesn't apply to commits because we only support
41  * filtering trees and blobs, but it may be useful to support filtering commits
42  * in the future.
43  */
44 #define NOT_USER_GIVEN  (1u<<25)
45 #define TRACK_LINEAR    (1u<<26)
46 #define ALL_REV_FLAGS   (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR)
47
48 #define TOPO_WALK_EXPLORED      (1u<<27)
49 #define TOPO_WALK_INDEGREE      (1u<<28)
50
51 #define DECORATE_SHORT_REFS     1
52 #define DECORATE_FULL_REFS      2
53
54 struct log_info;
55 struct repository;
56 struct rev_info;
57 struct string_list;
58 struct saved_parents;
59 define_shared_commit_slab(revision_sources, char *);
60
61 struct rev_cmdline_info {
62         unsigned int nr;
63         unsigned int alloc;
64         struct rev_cmdline_entry {
65                 struct object *item;
66                 const char *name;
67                 enum {
68                         REV_CMD_REF,
69                         REV_CMD_PARENTS_ONLY,
70                         REV_CMD_LEFT,
71                         REV_CMD_RIGHT,
72                         REV_CMD_MERGE_BASE,
73                         REV_CMD_REV
74                 } whence;
75                 unsigned flags;
76         } *rev;
77 };
78
79 #define REVISION_WALK_WALK 0
80 #define REVISION_WALK_NO_WALK_SORTED 1
81 #define REVISION_WALK_NO_WALK_UNSORTED 2
82
83 struct oidset;
84 struct topo_walk_info;
85
86 struct rev_info {
87         /* Starting list */
88         struct commit_list *commits;
89         struct object_array pending;
90         struct repository *repo;
91
92         /* Parents of shown commits */
93         struct object_array boundary_commits;
94
95         /* The end-points specified by the end user */
96         struct rev_cmdline_info cmdline;
97
98         /* excluding from --branches, --refs, etc. expansion */
99         struct string_list *ref_excludes;
100
101         /* Basic information */
102         const char *prefix;
103         const char *def;
104         struct pathspec prune_data;
105
106         /*
107          * Whether the arguments parsed by setup_revisions() included any
108          * "input" revisions that might still have yielded an empty pending
109          * list (e.g., patterns like "--all" or "--glob").
110          */
111         int rev_input_given;
112
113         /*
114          * Whether we read from stdin due to the --stdin option.
115          */
116         int read_from_stdin;
117
118         /* topo-sort */
119         enum rev_sort_order sort_order;
120
121         unsigned int early_output;
122
123         unsigned int    ignore_missing:1,
124                         ignore_missing_links:1;
125
126         /* Traversal flags */
127         unsigned int    dense:1,
128                         prune:1,
129                         no_walk:2,
130                         remove_empty_trees:1,
131                         simplify_history:1,
132                         topo_order:1,
133                         simplify_merges:1,
134                         simplify_by_decoration:1,
135                         single_worktree:1,
136                         tag_objects:1,
137                         tree_objects:1,
138                         blob_objects:1,
139                         verify_objects:1,
140                         edge_hint:1,
141                         edge_hint_aggressive:1,
142                         limited:1,
143                         unpacked:1,
144                         boundary:2,
145                         count:1,
146                         left_right:1,
147                         left_only:1,
148                         right_only:1,
149                         rewrite_parents:1,
150                         print_parents:1,
151                         show_decorations:1,
152                         reverse:1,
153                         reverse_output_stage:1,
154                         cherry_pick:1,
155                         cherry_mark:1,
156                         bisect:1,
157                         ancestry_path:1,
158                         first_parent_only:1,
159                         line_level_traverse:1,
160                         tree_blobs_in_commit_order:1,
161
162                         /*
163                          * Blobs are shown without regard for their existence.
164                          * But not so for trees: unless exclude_promisor_objects
165                          * is set and the tree in question is a promisor object;
166                          * OR ignore_missing_links is set, the revision walker
167                          * dies with a "bad tree object HASH" message when
168                          * encountering a missing tree. For callers that can
169                          * handle missing trees and want them to be filterable
170                          * and showable, set this to true. The revision walker
171                          * will filter and show such a missing tree as usual,
172                          * but will not attempt to recurse into this tree
173                          * object.
174                          */
175                         do_not_die_on_missing_tree:1,
176
177                         /* for internal use only */
178                         exclude_promisor_objects:1;
179
180         /* Diff flags */
181         unsigned int    diff:1,
182                         full_diff:1,
183                         show_root_diff:1,
184                         no_commit_id:1,
185                         verbose_header:1,
186                         ignore_merges:1,
187                         combine_merges:1,
188                         combined_all_paths:1,
189                         dense_combined_merges:1,
190                         always_show_header:1;
191
192         /* Format info */
193         int             show_notes;
194         unsigned int    shown_one:1,
195                         shown_dashes:1,
196                         show_merge:1,
197                         show_notes_given:1,
198                         show_signature:1,
199                         pretty_given:1,
200                         abbrev_commit:1,
201                         abbrev_commit_given:1,
202                         zero_commit:1,
203                         use_terminator:1,
204                         missing_newline:1,
205                         date_mode_explicit:1,
206                         preserve_subject:1;
207         unsigned int    disable_stdin:1;
208         /* --show-linear-break */
209         unsigned int    track_linear:1,
210                         track_first_time:1,
211                         linear:1;
212
213         struct date_mode date_mode;
214         int             expand_tabs_in_log; /* unset if negative */
215         int             expand_tabs_in_log_default;
216
217         unsigned int    abbrev;
218         enum cmit_fmt   commit_format;
219         struct log_info *loginfo;
220         int             nr, total;
221         const char      *mime_boundary;
222         const char      *patch_suffix;
223         int             numbered_files;
224         int             reroll_count;
225         char            *message_id;
226         struct ident_split from_ident;
227         struct string_list *ref_message_ids;
228         int             add_signoff;
229         const char      *extra_headers;
230         const char      *log_reencode;
231         const char      *subject_prefix;
232         int             no_inline;
233         int             show_log_size;
234         struct string_list *mailmap;
235
236         /* Filter by commit log message */
237         struct grep_opt grep_filter;
238         /* Negate the match of grep_filter */
239         int invert_grep;
240
241         /* Display history graph */
242         struct git_graph *graph;
243
244         /* special limits */
245         int skip_count;
246         int max_count;
247         timestamp_t max_age;
248         timestamp_t min_age;
249         int min_parents;
250         int max_parents;
251         int (*include_check)(struct commit *, void *);
252         void *include_check_data;
253
254         /* diff info for patches and for paths limiting */
255         struct diff_options diffopt;
256         struct diff_options pruning;
257
258         struct reflog_walk_info *reflog_info;
259         struct decoration children;
260         struct decoration merge_simplification;
261         struct decoration treesame;
262
263         /* notes-specific options: which refs to show */
264         struct display_notes_opt notes_opt;
265
266         /* interdiff */
267         const struct object_id *idiff_oid1;
268         const struct object_id *idiff_oid2;
269         const char *idiff_title;
270
271         /* range-diff */
272         const char *rdiff1;
273         const char *rdiff2;
274         int creation_factor;
275         const char *rdiff_title;
276
277         /* commit counts */
278         int count_left;
279         int count_right;
280         int count_same;
281
282         /* line level range that we are chasing */
283         struct decoration line_log_data;
284
285         /* copies of the parent lists, for --full-diff display */
286         struct saved_parents *saved_parents_slab;
287
288         struct commit_list *previous_parents;
289         const char *break_bar;
290
291         struct revision_sources *sources;
292
293         struct topo_walk_info *topo_walk_info;
294 };
295
296 int ref_excluded(struct string_list *, const char *path);
297 void clear_ref_exclusion(struct string_list **);
298 void add_ref_exclusion(struct string_list **, const char *exclude);
299
300
301 #define REV_TREE_SAME           0
302 #define REV_TREE_NEW            1       /* Only new files */
303 #define REV_TREE_OLD            2       /* Only files removed */
304 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
305
306 /* revision.c */
307 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
308 extern volatile show_early_output_fn_t show_early_output;
309
310 struct setup_revision_opt {
311         const char *def;
312         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
313         const char *submodule;  /* TODO: drop this and use rev_info->repo */
314         unsigned int    assume_dashdash:1,
315                         allow_exclude_promisor_objects:1;
316         unsigned revarg_opt;
317 };
318
319 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
320 #define init_revisions(revs, prefix) repo_init_revisions(the_repository, revs, prefix)
321 #endif
322
323 /**
324  * Initialize a rev_info structure with default values. The third parameter may
325  * be NULL or can be prefix path, and then the `.prefix` variable will be set
326  * to it. This is typically the first function you want to call when you want
327  * to deal with a revision list. After calling this function, you are free to
328  * customize options, like set `.ignore_merges` to 0 if you don't want to
329  * ignore merges, and so on.
330  */
331 void repo_init_revisions(struct repository *r,
332                          struct rev_info *revs,
333                          const char *prefix);
334
335 /**
336  * Parse revision information, filling in the `rev_info` structure, and
337  * removing the used arguments from the argument list. Returns the number
338  * of arguments left that weren't recognized, which are also moved to the
339  * head of the argument list. The last parameter is used in case no
340  * parameter given by the first two arguments.
341  */
342 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
343                     struct setup_revision_opt *);
344
345 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
346                         const struct option *options,
347                         const char * const usagestr[]);
348 #define REVARG_CANNOT_BE_FILENAME 01
349 #define REVARG_COMMITTISH 02
350 int handle_revision_arg(const char *arg, struct rev_info *revs,
351                         int flags, unsigned revarg_opt);
352
353 /**
354  * Reset the flags used by the revision walking api. You can use this to do
355  * multiple sequential revision walks.
356  */
357 void reset_revision_walk(void);
358
359 /**
360  * Prepares the rev_info structure for a walk. You should check if it returns
361  * any error (non-zero return code) and if it does not, you can start using
362  * get_revision() to do the iteration.
363  */
364 int prepare_revision_walk(struct rev_info *revs);
365
366 /**
367  * Takes a pointer to a `rev_info` structure and iterates over it, returning a
368  * `struct commit *` each time you call it. The end of the revision list is
369  * indicated by returning a NULL pointer.
370  */
371 struct commit *get_revision(struct rev_info *revs);
372
373 const char *get_revision_mark(const struct rev_info *revs,
374                               const struct commit *commit);
375 void put_revision_mark(const struct rev_info *revs,
376                        const struct commit *commit);
377
378 void mark_parents_uninteresting(struct commit *commit);
379 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
380 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
381
382 void show_object_with_name(FILE *, struct object *, const char *);
383
384 /**
385  * This function can be used if you want to add commit objects as revision
386  * information. You can use the `UNINTERESTING` object flag to indicate if
387  * you want to include or exclude the given commit (and commits reachable
388  * from the given commit) from the revision list.
389  *
390  * NOTE: If you have the commits as a string list then you probably want to
391  * use setup_revisions(), instead of parsing each string and using this
392  * function.
393  */
394 void add_pending_object(struct rev_info *revs,
395                         struct object *obj, const char *name);
396
397 void add_pending_oid(struct rev_info *revs,
398                      const char *name, const struct object_id *oid,
399                      unsigned int flags);
400
401 void add_head_to_pending(struct rev_info *);
402 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
403 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
404
405 enum commit_action {
406         commit_ignore,
407         commit_show,
408         commit_error
409 };
410
411 enum commit_action get_commit_action(struct rev_info *revs,
412                                      struct commit *commit);
413 enum commit_action simplify_commit(struct rev_info *revs,
414                                    struct commit *commit);
415
416 enum rewrite_result {
417         rewrite_one_ok,
418         rewrite_one_noparents,
419         rewrite_one_error
420 };
421
422 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
423
424 int rewrite_parents(struct rev_info *revs,
425                     struct commit *commit,
426                     rewrite_parent_fn_t rewrite_parent);
427
428 /*
429  * The log machinery saves the original parent list so that
430  * get_saved_parents() can later tell what the real parents of the
431  * commits are, when commit->parents has been modified by history
432  * simpification.
433  *
434  * get_saved_parents() will transparently return commit->parents if
435  * history simplification is off.
436  */
437 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
438
439 #endif