Documentation: git submodule: add missing options to synopsis
[git] / revision.h
1 #ifndef REVISION_H
2 #define REVISION_H
3
4 #include "parse-options.h"
5 #include "grep.h"
6
7 #define SEEN            (1u<<0)
8 #define UNINTERESTING   (1u<<1)
9 #define TREESAME        (1u<<2)
10 #define SHOWN           (1u<<3)
11 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
12 #define BOUNDARY        (1u<<5)
13 #define CHILD_SHOWN     (1u<<6)
14 #define ADDED           (1u<<7) /* Parents already parsed and added? */
15 #define SYMMETRIC_LEFT  (1u<<8)
16 #define ALL_REV_FLAGS   ((1u<<9)-1)
17
18 struct rev_info;
19 struct log_info;
20
21 struct rev_info {
22         /* Starting list */
23         struct commit_list *commits;
24         struct object_array pending;
25
26         /* Parents of shown commits */
27         struct object_array boundary_commits;
28
29         /* Basic information */
30         const char *prefix;
31         const char *def;
32         void *prune_data;
33         unsigned int early_output;
34
35         /* Traversal flags */
36         unsigned int    dense:1,
37                         prune:1,
38                         no_merges:1,
39                         merges_only:1,
40                         no_walk:1,
41                         show_all:1,
42                         remove_empty_trees:1,
43                         simplify_history:1,
44                         lifo:1,
45                         topo_order:1,
46                         simplify_merges:1,
47                         simplify_by_decoration:1,
48                         tag_objects:1,
49                         tree_objects:1,
50                         blob_objects:1,
51                         edge_hint:1,
52                         limited:1,
53                         unpacked:1,
54                         boundary:2,
55                         left_right:1,
56                         rewrite_parents:1,
57                         print_parents:1,
58                         show_source:1,
59                         show_decorations:1,
60                         reverse:1,
61                         reverse_output_stage:1,
62                         cherry_pick:1,
63                         first_parent_only:1;
64
65         /* Diff flags */
66         unsigned int    diff:1,
67                         full_diff:1,
68                         show_root_diff:1,
69                         no_commit_id:1,
70                         verbose_header:1,
71                         ignore_merges:1,
72                         combine_merges:1,
73                         dense_combined_merges:1,
74                         always_show_header:1;
75
76         /* Format info */
77         unsigned int    shown_one:1,
78                         show_merge:1,
79                         abbrev_commit:1,
80                         use_terminator:1,
81                         missing_newline:1;
82         enum date_mode date_mode;
83
84         unsigned int    abbrev;
85         enum cmit_fmt   commit_format;
86         struct log_info *loginfo;
87         int             nr, total;
88         const char      *mime_boundary;
89         const char      *patch_suffix;
90         int             numbered_files;
91         char            *message_id;
92         struct string_list *ref_message_ids;
93         const char      *add_signoff;
94         const char      *extra_headers;
95         const char      *log_reencode;
96         const char      *subject_prefix;
97         int             no_inline;
98         int             show_log_size;
99
100         /* Filter by commit log message */
101         struct grep_opt grep_filter;
102
103         /* Display history graph */
104         struct git_graph *graph;
105
106         /* special limits */
107         int skip_count;
108         int max_count;
109         unsigned long max_age;
110         unsigned long min_age;
111
112         /* diff info for patches and for paths limiting */
113         struct diff_options diffopt;
114         struct diff_options pruning;
115
116         struct reflog_walk_info *reflog_info;
117         struct decoration children;
118         struct decoration merge_simplification;
119 };
120
121 #define REV_TREE_SAME           0
122 #define REV_TREE_NEW            1       /* Only new files */
123 #define REV_TREE_OLD            2       /* Only files removed */
124 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
125
126 /* revision.c */
127 void read_revisions_from_stdin(struct rev_info *revs);
128
129 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
130 extern volatile show_early_output_fn_t show_early_output;
131
132 extern void init_revisions(struct rev_info *revs, const char *prefix);
133 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, const char *def);
134 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
135                                  const struct option *options,
136                                  const char * const usagestr[]);
137 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
138
139 extern int prepare_revision_walk(struct rev_info *revs);
140 extern struct commit *get_revision(struct rev_info *revs);
141
142 extern void mark_parents_uninteresting(struct commit *commit);
143 extern void mark_tree_uninteresting(struct tree *tree);
144
145 struct name_path {
146         struct name_path *up;
147         int elem_len;
148         const char *elem;
149 };
150
151 char *path_name(const struct name_path *path, const char *name);
152
153 extern void add_object(struct object *obj,
154                        struct object_array *p,
155                        struct name_path *path,
156                        const char *name);
157
158 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
159
160 extern void add_head_to_pending(struct rev_info *);
161
162 enum commit_action {
163         commit_ignore,
164         commit_show,
165         commit_error
166 };
167
168 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
169
170 #endif