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