Merge branch 'mg/doc-bisect-tweak-worktree' into next
[git/mjg.git] / revision.h
blobae948601f94c726c3677f23517dba5c046431904
1 #ifndef REVISION_H
2 #define REVISION_H
4 #include "parse-options.h"
5 #include "grep.h"
6 #include "notes.h"
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)
20 #define DECORATE_SHORT_REFS 1
21 #define DECORATE_FULL_REFS 2
23 struct rev_info;
24 struct log_info;
25 struct string_list;
27 struct rev_info {
28 /* Starting list */
29 struct commit_list *commits;
30 struct object_array pending;
32 /* Parents of shown commits */
33 struct object_array boundary_commits;
35 /* Basic information */
36 const char *prefix;
37 const char *def;
38 struct pathspec prune_data;
39 unsigned int early_output;
41 /* Traversal flags */
42 unsigned int dense:1,
43 prune:1,
44 no_merges:1,
45 merges_only:1,
46 no_walk:1,
47 show_all:1,
48 remove_empty_trees:1,
49 simplify_history:1,
50 lifo:1,
51 topo_order:1,
52 simplify_merges:1,
53 simplify_by_decoration:1,
54 tag_objects:1,
55 tree_objects:1,
56 blob_objects:1,
57 edge_hint:1,
58 limited:1,
59 unpacked:1,
60 boundary:2,
61 count:1,
62 left_right:1,
63 left_only:1,
64 right_only:1,
65 rewrite_parents:1,
66 print_parents:1,
67 show_source:1,
68 show_decorations:1,
69 reverse:1,
70 reverse_output_stage:1,
71 cherry_pick:1,
72 cherry_mark:1,
73 bisect:1,
74 ancestry_path:1,
75 first_parent_only:1;
77 /* Diff flags */
78 unsigned int diff:1,
79 full_diff:1,
80 show_root_diff:1,
81 no_commit_id:1,
82 verbose_header:1,
83 ignore_merges:1,
84 combine_merges:1,
85 dense_combined_merges:1,
86 always_show_header:1;
88 /* Format info */
89 unsigned int shown_one:1,
90 show_merge:1,
91 show_notes:1,
92 show_notes_given:1,
93 pretty_given:1,
94 abbrev_commit:1,
95 use_terminator:1,
96 missing_newline:1,
97 date_mode_explicit:1;
98 unsigned int disable_stdin:1;
100 enum date_mode date_mode;
102 unsigned int abbrev;
103 enum cmit_fmt commit_format;
104 struct log_info *loginfo;
105 int nr, total;
106 const char *mime_boundary;
107 const char *patch_suffix;
108 int numbered_files;
109 char *message_id;
110 struct string_list *ref_message_ids;
111 const char *add_signoff;
112 const char *extra_headers;
113 const char *log_reencode;
114 const char *subject_prefix;
115 int no_inline;
116 int show_log_size;
118 /* Filter by commit log message */
119 struct grep_opt grep_filter;
121 /* Display history graph */
122 struct git_graph *graph;
124 /* special limits */
125 int skip_count;
126 int max_count;
127 unsigned long max_age;
128 unsigned long min_age;
130 /* diff info for patches and for paths limiting */
131 struct diff_options diffopt;
132 struct diff_options pruning;
134 struct reflog_walk_info *reflog_info;
135 struct decoration children;
136 struct decoration merge_simplification;
138 /* notes-specific options: which refs to show */
139 struct display_notes_opt notes_opt;
141 /* commit counts */
142 int count_left;
143 int count_right;
146 #define REV_TREE_SAME 0
147 #define REV_TREE_NEW 1 /* Only new files */
148 #define REV_TREE_OLD 2 /* Only files removed */
149 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
151 /* revision.c */
152 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
153 extern volatile show_early_output_fn_t show_early_output;
155 struct setup_revision_opt {
156 const char *def;
157 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
158 const char *submodule;
161 extern void init_revisions(struct rev_info *revs, const char *prefix);
162 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
163 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
164 const struct option *options,
165 const char * const usagestr[]);
166 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
168 extern int prepare_revision_walk(struct rev_info *revs);
169 extern struct commit *get_revision(struct rev_info *revs);
170 extern char *get_revision_mark(const struct rev_info *revs, const struct commit *commit);
171 extern void put_revision_mark(const struct rev_info *revs, const struct commit *commit);
173 extern void mark_parents_uninteresting(struct commit *commit);
174 extern void mark_tree_uninteresting(struct tree *tree);
176 struct name_path {
177 struct name_path *up;
178 int elem_len;
179 const char *elem;
182 char *path_name(const struct name_path *path, const char *name);
184 extern void add_object(struct object *obj,
185 struct object_array *p,
186 struct name_path *path,
187 const char *name);
189 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
191 extern void add_head_to_pending(struct rev_info *);
193 enum commit_action {
194 commit_ignore,
195 commit_show,
196 commit_error
199 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
200 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
202 #endif