ref-filter: implement '--contains' option
[git/git.git] / ref-filter.h
1 #ifndef REF_FILTER_H
2 #define REF_FILTER_H
3
4 #include "sha1-array.h"
5 #include "refs.h"
6 #include "commit.h"
7 #include "parse-options.h"
8
9 /* Quoting styles */
10 #define QUOTE_NONE 0
11 #define QUOTE_SHELL 1
12 #define QUOTE_PERL 2
13 #define QUOTE_PYTHON 4
14 #define QUOTE_TCL 8
15
16 #define FILTER_REFS_INCLUDE_BROKEN 0x1
17 #define FILTER_REFS_ALL 0x2
18
19 struct atom_value {
20 const char *s;
21 unsigned long ul; /* used for sorting when not FIELD_STR */
22 };
23
24 struct ref_sorting {
25 struct ref_sorting *next;
26 int atom; /* index into used_atom array (internal) */
27 unsigned reverse : 1;
28 };
29
30 struct ref_array_item {
31 unsigned char objectname[20];
32 int flag;
33 const char *symref;
34 struct commit *commit;
35 struct atom_value *value;
36 char refname[FLEX_ARRAY];
37 };
38
39 struct ref_array {
40 int nr, alloc;
41 struct ref_array_item **items;
42 };
43
44 struct ref_filter {
45 const char **name_patterns;
46 struct sha1_array points_at;
47 struct commit_list *with_commit;
48
49 enum {
50 REF_FILTER_MERGED_NONE = 0,
51 REF_FILTER_MERGED_INCLUDE,
52 REF_FILTER_MERGED_OMIT
53 } merge;
54 struct commit *merge_commit;
55
56 unsigned int with_commit_tag_algo : 1;
57 };
58
59 struct ref_filter_cbdata {
60 struct ref_array *array;
61 struct ref_filter *filter;
62 };
63
64 /* Macros for checking --merged and --no-merged options */
65 #define _OPT_MERGED_NO_MERGED(option, filter, h) \
66 { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
67 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
68 parse_opt_merge_filter, (intptr_t) "HEAD" \
69 }
70 #define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
71 #define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
72
73 /*
74 * API for filtering a set of refs. Based on the type of refs the user
75 * has requested, we iterate through those refs and apply filters
76 * as per the given ref_filter structure and finally store the
77 * filtered refs in the ref_array structure.
78 */
79 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
80 /* Clear all memory allocated to ref_array */
81 void ref_array_clear(struct ref_array *array);
82 /* Parse format string and sort specifiers */
83 int parse_ref_filter_atom(const char *atom, const char *ep);
84 /* Used to verify if the given format is correct and to parse out the used atoms */
85 int verify_ref_format(const char *format);
86 /* Sort the given ref_array as per the ref_sorting provided */
87 void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
88 /* Print the ref using the given format and quote_style */
89 void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style);
90 /* Callback function for parsing the sort option */
91 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
92 /* Default sort option based on refname */
93 struct ref_sorting *ref_default_sorting(void);
94 /* Function to parse --merged and --no-merged options */
95 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
96
97 #endif /* REF_FILTER_H */