gitweb: Improve installation instructions in gitweb/INSTALL
[git/jnareb-git.git] / revision.h
blob568f1c98de844dbadcebf1d583bffc24e6daa677
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 left_right:1,
61 rewrite_parents:1,
62 print_parents:1,
63 show_source:1,
64 show_decorations:1,
65 reverse:1,
66 reverse_output_stage:1,
67 cherry_pick:1,
68 bisect:1,
69 first_parent_only:1;
71 /* Diff flags */
72 unsigned int diff:1,
73 full_diff:1,
74 show_root_diff:1,
75 no_commit_id:1,
76 verbose_header:1,
77 ignore_merges:1,
78 combine_merges:1,
79 dense_combined_merges:1,
80 always_show_header:1;
82 /* Format info */
83 unsigned int shown_one:1,
84 show_merge:1,
85 show_notes:1,
86 show_notes_given:1,
87 pretty_given:1,
88 abbrev_commit:1,
89 use_terminator:1,
90 missing_newline:1,
91 date_mode_explicit:1;
92 unsigned int disable_stdin:1;
94 enum date_mode date_mode;
96 unsigned int abbrev;
97 enum cmit_fmt commit_format;
98 struct log_info *loginfo;
99 int nr, total;
100 const char *mime_boundary;
101 const char *patch_suffix;
102 int numbered_files;
103 char *message_id;
104 struct string_list *ref_message_ids;
105 const char *add_signoff;
106 const char *extra_headers;
107 const char *log_reencode;
108 const char *subject_prefix;
109 int no_inline;
110 int show_log_size;
112 /* Filter by commit log message */
113 struct grep_opt grep_filter;
115 /* Display history graph */
116 struct git_graph *graph;
118 /* special limits */
119 int skip_count;
120 int max_count;
121 unsigned long max_age;
122 unsigned long min_age;
124 /* diff info for patches and for paths limiting */
125 struct diff_options diffopt;
126 struct diff_options pruning;
128 struct reflog_walk_info *reflog_info;
129 struct decoration children;
130 struct decoration merge_simplification;
132 /* notes-specific options: which refs to show */
133 struct display_notes_opt notes_opt;
136 #define REV_TREE_SAME 0
137 #define REV_TREE_NEW 1 /* Only new files */
138 #define REV_TREE_OLD 2 /* Only files removed */
139 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
141 /* revision.c */
142 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
143 extern volatile show_early_output_fn_t show_early_output;
145 struct setup_revision_opt {
146 const char *def;
147 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
150 extern void init_revisions(struct rev_info *revs, const char *prefix);
151 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
152 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
153 const struct option *options,
154 const char * const usagestr[]);
155 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
157 extern int prepare_revision_walk(struct rev_info *revs);
158 extern struct commit *get_revision(struct rev_info *revs);
160 extern void mark_parents_uninteresting(struct commit *commit);
161 extern void mark_tree_uninteresting(struct tree *tree);
163 struct name_path {
164 struct name_path *up;
165 int elem_len;
166 const char *elem;
169 char *path_name(const struct name_path *path, const char *name);
171 extern void add_object(struct object *obj,
172 struct object_array *p,
173 struct name_path *path,
174 const char *name);
176 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
178 extern void add_head_to_pending(struct rev_info *);
180 enum commit_action {
181 commit_ignore,
182 commit_show,
183 commit_error
186 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
187 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
189 #endif