Code

revision: keep track of the end-user input from the command line
[git.git] / revision.h
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 ALL_REV_FLAGS   ((1u<<9)-1)
19 #define DECORATE_SHORT_REFS     1
20 #define DECORATE_FULL_REFS      2
22 struct rev_info;
23 struct log_info;
24 struct string_list;
26 struct rev_cmdline_info {
27         unsigned int nr;
28         unsigned int alloc;
29         struct rev_cmdline_entry {
30                 struct object *item;
31                 const char *name;
32                 enum {
33                         REV_CMD_REF,
34                         REV_CMD_PARENTS_ONLY,
35                         REV_CMD_LEFT,
36                         REV_CMD_RIGHT,
37                         REV_CMD_REV
38                 } whence;
39                 unsigned flags;
40         } *rev;
41 };
43 struct rev_info {
44         /* Starting list */
45         struct commit_list *commits;
46         struct object_array pending;
48         /* Parents of shown commits */
49         struct object_array boundary_commits;
51         /* The end-points specified by the end user */
52         struct rev_cmdline_info cmdline;
54         /* Basic information */
55         const char *prefix;
56         const char *def;
57         void *prune_data;
58         unsigned int early_output;
60         /* Traversal flags */
61         unsigned int    dense:1,
62                         prune:1,
63                         no_merges:1,
64                         merges_only: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                         edge_hint:1,
77                         limited:1,
78                         unpacked:1,
79                         boundary:2,
80                         left_right:1,
81                         rewrite_parents:1,
82                         print_parents:1,
83                         show_source:1,
84                         show_decorations:1,
85                         reverse:1,
86                         reverse_output_stage:1,
87                         cherry_pick:1,
88                         bisect:1,
89                         ancestry_path:1,
90                         first_parent_only:1;
92         /* Diff flags */
93         unsigned int    diff:1,
94                         full_diff:1,
95                         show_root_diff:1,
96                         no_commit_id:1,
97                         verbose_header:1,
98                         ignore_merges:1,
99                         combine_merges:1,
100                         dense_combined_merges:1,
101                         always_show_header:1;
103         /* Format info */
104         unsigned int    shown_one:1,
105                         show_merge:1,
106                         show_notes:1,
107                         show_notes_given:1,
108                         pretty_given:1,
109                         abbrev_commit:1,
110                         use_terminator:1,
111                         missing_newline:1,
112                         date_mode_explicit:1;
113         unsigned int    disable_stdin:1;
115         enum date_mode date_mode;
117         unsigned int    abbrev;
118         enum cmit_fmt   commit_format;
119         struct log_info *loginfo;
120         int             nr, total;
121         const char      *mime_boundary;
122         const char      *patch_suffix;
123         int             numbered_files;
124         char            *message_id;
125         struct string_list *ref_message_ids;
126         const char      *add_signoff;
127         const char      *extra_headers;
128         const char      *log_reencode;
129         const char      *subject_prefix;
130         int             no_inline;
131         int             show_log_size;
133         /* Filter by commit log message */
134         struct grep_opt grep_filter;
136         /* Display history graph */
137         struct git_graph *graph;
139         /* special limits */
140         int skip_count;
141         int max_count;
142         unsigned long max_age;
143         unsigned long min_age;
145         /* diff info for patches and for paths limiting */
146         struct diff_options diffopt;
147         struct diff_options pruning;
149         struct reflog_walk_info *reflog_info;
150         struct decoration children;
151         struct decoration merge_simplification;
153         /* notes-specific options: which refs to show */
154         struct display_notes_opt notes_opt;
155 };
157 #define REV_TREE_SAME           0
158 #define REV_TREE_NEW            1       /* Only new files */
159 #define REV_TREE_OLD            2       /* Only files removed */
160 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
162 /* revision.c */
163 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
164 extern volatile show_early_output_fn_t show_early_output;
166 struct setup_revision_opt {
167         const char *def;
168         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
169 };
171 extern void init_revisions(struct rev_info *revs, const char *prefix);
172 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
173 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
174                                  const struct option *options,
175                                  const char * const usagestr[]);
176 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
178 extern int prepare_revision_walk(struct rev_info *revs);
179 extern struct commit *get_revision(struct rev_info *revs);
181 extern void mark_parents_uninteresting(struct commit *commit);
182 extern void mark_tree_uninteresting(struct tree *tree);
184 struct name_path {
185         struct name_path *up;
186         int elem_len;
187         const char *elem;
188 };
190 char *path_name(const struct name_path *path, const char *name);
192 extern void add_object(struct object *obj,
193                        struct object_array *p,
194                        struct name_path *path,
195                        const char *name);
197 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
199 extern void add_head_to_pending(struct rev_info *);
201 enum commit_action {
202         commit_ignore,
203         commit_show,
204         commit_error
205 };
207 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
208 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
210 #endif