Document git-runstatus
[git] / revision.h
1 #ifndef REVISION_H
2 #define REVISION_H
3
4 #define SEEN            (1u<<0)
5 #define UNINTERESTING   (1u<<1)
6 #define TREECHANGE      (1u<<2)
7 #define SHOWN           (1u<<3)
8 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
9 #define BOUNDARY        (1u<<5)
10 #define BOUNDARY_SHOW   (1u<<6)
11 #define ADDED           (1u<<7) /* Parents already parsed and added? */
12
13 struct rev_info;
14 struct log_info;
15
16 typedef void (prune_fn_t)(struct rev_info *revs, struct commit *commit);
17
18 struct rev_info {
19         /* Starting list */
20         struct commit_list *commits;
21         struct object_array pending;
22
23         /* Basic information */
24         const char *prefix;
25         void *prune_data;
26         prune_fn_t *prune_fn;
27
28         /* Traversal flags */
29         unsigned int    dense:1,
30                         no_merges:1,
31                         no_walk:1,
32                         remove_empty_trees:1,
33                         simplify_history:1,
34                         lifo:1,
35                         topo_order:1,
36                         tag_objects:1,
37                         tree_objects:1,
38                         blob_objects:1,
39                         edge_hint:1,
40                         limited:1,
41                         unpacked:1, /* see also ignore_packed below */
42                         boundary:1,
43                         parents:1;
44
45         /* Diff flags */
46         unsigned int    diff:1,
47                         full_diff:1,
48                         show_root_diff:1,
49                         no_commit_id:1,
50                         verbose_header:1,
51                         ignore_merges:1,
52                         combine_merges:1,
53                         dense_combined_merges:1,
54                         always_show_header:1;
55
56         /* Format info */
57         unsigned int    shown_one:1,
58                         abbrev_commit:1,
59                         relative_date:1;
60
61         const char **ignore_packed; /* pretend objects in these are unpacked */
62         int num_ignore_packed;
63
64         unsigned int    abbrev;
65         enum cmit_fmt   commit_format;
66         struct log_info *loginfo;
67         int             nr, total;
68         const char      *mime_boundary;
69         const char      *message_id;
70         const char      *ref_message_id;
71         const char      *add_signoff;
72         const char      *extra_headers;
73
74         /* Filter by commit log message */
75         struct grep_opt *grep_filter;
76
77         /* special limits */
78         int max_count;
79         unsigned long max_age;
80         unsigned long min_age;
81
82         /* diff info for patches and for paths limiting */
83         struct diff_options diffopt;
84         struct diff_options pruning;
85
86         topo_sort_set_fn_t topo_setter;
87         topo_sort_get_fn_t topo_getter;
88 };
89
90 #define REV_TREE_SAME           0
91 #define REV_TREE_NEW            1
92 #define REV_TREE_DIFFERENT      2
93
94 /* revision.c */
95 extern int rev_same_tree_as_empty(struct rev_info *, struct tree *t1);
96 extern int rev_compare_tree(struct rev_info *, struct tree *t1, struct tree *t2);
97
98 extern void init_revisions(struct rev_info *revs, const char *prefix);
99 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, const char *def);
100 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
101
102 extern void prepare_revision_walk(struct rev_info *revs);
103 extern struct commit *get_revision(struct rev_info *revs);
104
105 extern void mark_parents_uninteresting(struct commit *commit);
106 extern void mark_tree_uninteresting(struct tree *tree);
107
108 struct name_path {
109         struct name_path *up;
110         int elem_len;
111         const char *elem;
112 };
113
114 extern void add_object(struct object *obj,
115                        struct object_array *p,
116                        struct name_path *path,
117                        const char *name);
118
119 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
120
121 #endif