clone: allow --branch to take a tag
[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 struct rev_info {
45         /* Starting list */
46         struct commit_list *commits;
47         struct object_array pending;
48
49         /* Parents of shown commits */
50         struct object_array boundary_commits;
51
52         /* The end-points specified by the end user */
53         struct rev_cmdline_info cmdline;
54
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;
61
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;
96
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;
107
108         /* Format info */
109         unsigned int    shown_one:1,
110                         show_merge:1,
111                         show_notes:1,
112                         show_notes_given:1,
113                         pretty_given:1,
114                         abbrev_commit:1,
115                         abbrev_commit_given:1,
116                         use_terminator:1,
117                         missing_newline:1,
118                         date_mode_explicit:1,
119                         preserve_subject:1;
120         unsigned int    disable_stdin:1;
121         unsigned int    leak_pending:1;
122
123         enum date_mode date_mode;
124
125         unsigned int    abbrev;
126         enum cmit_fmt   commit_format;
127         struct log_info *loginfo;
128         int             nr, total;
129         const char      *mime_boundary;
130         const char      *patch_suffix;
131         int             numbered_files;
132         char            *message_id;
133         struct string_list *ref_message_ids;
134         const char      *add_signoff;
135         const char      *extra_headers;
136         const char      *log_reencode;
137         const char      *subject_prefix;
138         int             no_inline;
139         int             show_log_size;
140
141         /* Filter by commit log message */
142         struct grep_opt grep_filter;
143
144         /* Display history graph */
145         struct git_graph *graph;
146
147         /* special limits */
148         int skip_count;
149         int max_count;
150         unsigned long max_age;
151         unsigned long min_age;
152         int min_parents;
153         int max_parents;
154
155         /* diff info for patches and for paths limiting */
156         struct diff_options diffopt;
157         struct diff_options pruning;
158
159         struct reflog_walk_info *reflog_info;
160         struct decoration children;
161         struct decoration merge_simplification;
162
163         /* notes-specific options: which refs to show */
164         struct display_notes_opt notes_opt;
165
166         /* commit counts */
167         int count_left;
168         int count_right;
169         int count_same;
170 };
171
172 #define REV_TREE_SAME           0
173 #define REV_TREE_NEW            1       /* Only new files */
174 #define REV_TREE_OLD            2       /* Only files removed */
175 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
176
177 /* revision.c */
178 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
179 extern volatile show_early_output_fn_t show_early_output;
180
181 struct setup_revision_opt {
182         const char *def;
183         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
184         const char *submodule;
185 };
186
187 extern void init_revisions(struct rev_info *revs, const char *prefix);
188 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
189 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
190                                  const struct option *options,
191                                  const char * const usagestr[]);
192 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
193
194 extern int prepare_revision_walk(struct rev_info *revs);
195 extern struct commit *get_revision(struct rev_info *revs);
196 extern char *get_revision_mark(const struct rev_info *revs, const struct commit *commit);
197 extern void put_revision_mark(const struct rev_info *revs, const struct commit *commit);
198
199 extern void mark_parents_uninteresting(struct commit *commit);
200 extern void mark_tree_uninteresting(struct tree *tree);
201
202 struct name_path {
203         struct name_path *up;
204         int elem_len;
205         const char *elem;
206 };
207
208 char *path_name(const struct name_path *path, const char *name);
209
210 extern void show_object_with_name(FILE *, struct object *, const struct name_path *, const char *);
211
212 extern void add_object(struct object *obj,
213                        struct object_array *p,
214                        struct name_path *path,
215                        const char *name);
216
217 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
218 extern void add_pending_sha1(struct rev_info *revs, const char *name, const unsigned char *sha1, unsigned int flags);
219
220 extern void add_head_to_pending(struct rev_info *);
221
222 enum commit_action {
223         commit_ignore,
224         commit_show,
225         commit_error
226 };
227
228 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
229 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
230
231 #endif