Documentation/git-reset: reorder modes for soft-mixed-hard progression
[git/mjg.git] / revision.h
blob36fdf22b299c4cc7e6f20d767d5c6a6c3f69d952
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_info {
27 /* Starting list */
28 struct commit_list *commits;
29 struct object_array pending;
31 /* Parents of shown commits */
32 struct object_array boundary_commits;
34 /* Basic information */
35 const char *prefix;
36 const char *def;
37 void *prune_data;
38 unsigned int early_output;
40 /* Traversal flags */
41 unsigned int dense:1,
42 prune:1,
43 no_merges:1,
44 merges_only:1,
45 no_walk:1,
46 show_all:1,
47 remove_empty_trees:1,
48 simplify_history:1,
49 lifo:1,
50 topo_order:1,
51 simplify_merges:1,
52 simplify_by_decoration:1,
53 tag_objects:1,
54 tree_objects:1,
55 blob_objects:1,
56 edge_hint:1,
57 limited:1,
58 unpacked:1,
59 boundary:2,
60 count:1,
61 left_right:1,
62 rewrite_parents:1,
63 print_parents:1,
64 show_source:1,
65 show_decorations:1,
66 reverse:1,
67 reverse_output_stage:1,
68 cherry_pick:1,
69 bisect:1,
70 ancestry_path:1,
71 first_parent_only:1;
73 /* Diff flags */
74 unsigned int diff:1,
75 full_diff:1,
76 show_root_diff:1,
77 no_commit_id:1,
78 verbose_header:1,
79 ignore_merges:1,
80 combine_merges:1,
81 dense_combined_merges:1,
82 always_show_header:1;
84 /* Format info */
85 unsigned int shown_one:1,
86 show_merge:1,
87 show_notes:1,
88 show_notes_given:1,
89 pretty_given:1,
90 abbrev_commit:1,
91 use_terminator:1,
92 missing_newline:1,
93 date_mode_explicit:1;
94 unsigned int disable_stdin:1;
96 enum date_mode date_mode;
98 unsigned int abbrev;
99 enum cmit_fmt commit_format;
100 struct log_info *loginfo;
101 int nr, total;
102 const char *mime_boundary;
103 const char *patch_suffix;
104 int numbered_files;
105 char *message_id;
106 struct string_list *ref_message_ids;
107 const char *add_signoff;
108 const char *extra_headers;
109 const char *log_reencode;
110 const char *subject_prefix;
111 int no_inline;
112 int show_log_size;
114 /* Filter by commit log message */
115 struct grep_opt grep_filter;
117 /* Display history graph */
118 struct git_graph *graph;
120 /* special limits */
121 int skip_count;
122 int max_count;
123 unsigned long max_age;
124 unsigned long min_age;
126 /* diff info for patches and for paths limiting */
127 struct diff_options diffopt;
128 struct diff_options pruning;
130 struct reflog_walk_info *reflog_info;
131 struct decoration children;
132 struct decoration merge_simplification;
134 /* notes-specific options: which refs to show */
135 struct display_notes_opt notes_opt;
137 /* commit counts */
138 int count_left;
139 int count_right;
142 #define REV_TREE_SAME 0
143 #define REV_TREE_NEW 1 /* Only new files */
144 #define REV_TREE_OLD 2 /* Only files removed */
145 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
147 /* revision.c */
148 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
149 extern volatile show_early_output_fn_t show_early_output;
151 struct setup_revision_opt {
152 const char *def;
153 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
156 extern void init_revisions(struct rev_info *revs, const char *prefix);
157 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
158 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
159 const struct option *options,
160 const char * const usagestr[]);
161 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
163 extern int prepare_revision_walk(struct rev_info *revs);
164 extern struct commit *get_revision(struct rev_info *revs);
166 extern void mark_parents_uninteresting(struct commit *commit);
167 extern void mark_tree_uninteresting(struct tree *tree);
169 struct name_path {
170 struct name_path *up;
171 int elem_len;
172 const char *elem;
175 char *path_name(const struct name_path *path, const char *name);
177 extern void add_object(struct object *obj,
178 struct object_array *p,
179 struct name_path *path,
180 const char *name);
182 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
184 extern void add_head_to_pending(struct rev_info *);
186 enum commit_action {
187 commit_ignore,
188 commit_show,
189 commit_error
192 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
193 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
195 #endif