checkout: pass "struct checkout_opts *" as const pointer
[git/jnareb-git.git] / revision.h
blobcb5ab3513bc9982095e292119b9119d333556256
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_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;
44 struct rev_info {
45 /* Starting list */
46 struct commit_list *commits;
47 struct object_array pending;
49 /* Parents of shown commits */
50 struct object_array boundary_commits;
52 /* The end-points specified by the end user */
53 struct rev_cmdline_info cmdline;
55 /* Basic information */
56 const char *prefix;
57 const char *def;
58 struct pathspec prune_data;
59 unsigned int early_output:1,
60 ignore_missing:1;
62 /* Traversal flags */
63 unsigned int dense:1,
64 prune:1,
65 no_walk:1,
66 show_all:1,
67 remove_empty_trees:1,
68 simplify_history:1,
69 lifo:1,
70 topo_order:1,
71 simplify_merges:1,
72 simplify_by_decoration:1,
73 tag_objects:1,
74 tree_objects:1,
75 blob_objects:1,
76 verify_objects:1,
77 edge_hint:1,
78 limited:1,
79 unpacked:1,
80 boundary:2,
81 count:1,
82 left_right:1,
83 left_only:1,
84 right_only:1,
85 rewrite_parents:1,
86 print_parents:1,
87 show_source:1,
88 show_decorations:1,
89 reverse:1,
90 reverse_output_stage:1,
91 cherry_pick:1,
92 cherry_mark:1,
93 bisect:1,
94 ancestry_path:1,
95 first_parent_only:1;
97 /* Diff flags */
98 unsigned int diff:1,
99 full_diff:1,
100 show_root_diff:1,
101 no_commit_id:1,
102 verbose_header:1,
103 ignore_merges:1,
104 combine_merges:1,
105 dense_combined_merges:1,
106 always_show_header:1;
108 /* Format info */
109 unsigned int shown_one:1,
110 show_merge:1,
111 show_notes:1,
112 show_notes_given:1,
113 show_signature:1,
114 pretty_given:1,
115 abbrev_commit:1,
116 abbrev_commit_given:1,
117 use_terminator:1,
118 missing_newline:1,
119 date_mode_explicit:1,
120 preserve_subject:1;
121 unsigned int disable_stdin:1;
122 unsigned int leak_pending:1;
124 enum date_mode date_mode;
126 unsigned int abbrev;
127 enum cmit_fmt commit_format;
128 struct log_info *loginfo;
129 int nr, total;
130 const char *mime_boundary;
131 const char *patch_suffix;
132 int numbered_files;
133 char *message_id;
134 struct string_list *ref_message_ids;
135 const char *add_signoff;
136 const char *extra_headers;
137 const char *log_reencode;
138 const char *subject_prefix;
139 int no_inline;
140 int show_log_size;
142 /* Filter by commit log message */
143 struct grep_opt grep_filter;
145 /* Display history graph */
146 struct git_graph *graph;
148 /* special limits */
149 int skip_count;
150 int max_count;
151 unsigned long max_age;
152 unsigned long min_age;
153 int min_parents;
154 int max_parents;
156 /* diff info for patches and for paths limiting */
157 struct diff_options diffopt;
158 struct diff_options pruning;
160 struct reflog_walk_info *reflog_info;
161 struct decoration children;
162 struct decoration merge_simplification;
164 /* notes-specific options: which refs to show */
165 struct display_notes_opt notes_opt;
167 /* commit counts */
168 int count_left;
169 int count_right;
170 int count_same;
173 #define REV_TREE_SAME 0
174 #define REV_TREE_NEW 1 /* Only new files */
175 #define REV_TREE_OLD 2 /* Only files removed */
176 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
178 /* revision.c */
179 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
180 extern volatile show_early_output_fn_t show_early_output;
182 struct setup_revision_opt {
183 const char *def;
184 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
185 const char *submodule;
186 int assume_dashdash;
187 unsigned revarg_opt;
190 extern void init_revisions(struct rev_info *revs, const char *prefix);
191 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
192 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
193 const struct option *options,
194 const char * const usagestr[]);
195 #define REVARG_CANNOT_BE_FILENAME 01
196 #define REVARG_COMMITTISH 02
197 extern int handle_revision_arg(const char *arg, struct rev_info *revs, int flags, unsigned revarg_opt);
199 extern void reset_revision_walk(void);
200 extern int prepare_revision_walk(struct rev_info *revs);
201 extern struct commit *get_revision(struct rev_info *revs);
202 extern char *get_revision_mark(const struct rev_info *revs, const struct commit *commit);
203 extern void put_revision_mark(const struct rev_info *revs, const struct commit *commit);
205 extern void mark_parents_uninteresting(struct commit *commit);
206 extern void mark_tree_uninteresting(struct tree *tree);
208 struct name_path {
209 struct name_path *up;
210 int elem_len;
211 const char *elem;
214 char *path_name(const struct name_path *path, const char *name);
216 extern void show_object_with_name(FILE *, struct object *, const struct name_path *, const char *);
218 extern void add_object(struct object *obj,
219 struct object_array *p,
220 struct name_path *path,
221 const char *name);
223 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
224 extern void add_pending_sha1(struct rev_info *revs, const char *name, const unsigned char *sha1, unsigned int flags);
226 extern void add_head_to_pending(struct rev_info *);
228 enum commit_action {
229 commit_ignore,
230 commit_show,
231 commit_error
234 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
235 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
237 #endif