]>
Commit | Line | Data |
---|---|---|
69b1cf91 KN |
1 | #ifndef REF_FILTER_H |
2 | #define REF_FILTER_H | |
3 | ||
f394e093 | 4 | #include "gettext.h" |
fe299ec5 | 5 | #include "oid-array.h" |
69b1cf91 KN |
6 | #include "refs.h" |
7 | #include "commit.h" | |
8 | #include "parse-options.h" | |
9 | ||
10 | /* Quoting styles */ | |
11 | #define QUOTE_NONE 0 | |
12 | #define QUOTE_SHELL 1 | |
13 | #define QUOTE_PERL 2 | |
14 | #define QUOTE_PYTHON 4 | |
15 | #define QUOTE_TCL 8 | |
16 | ||
5b4f2851 KN |
17 | #define FILTER_REFS_TAGS 0x0002 |
18 | #define FILTER_REFS_BRANCHES 0x0004 | |
19 | #define FILTER_REFS_REMOTES 0x0008 | |
20 | #define FILTER_REFS_OTHERS 0x0010 | |
21 | #define FILTER_REFS_ALL (FILTER_REFS_TAGS | FILTER_REFS_BRANCHES | \ | |
22 | FILTER_REFS_REMOTES | FILTER_REFS_OTHERS) | |
23 | #define FILTER_REFS_DETACHED_HEAD 0x0020 | |
24 | #define FILTER_REFS_KIND_MASK (FILTER_REFS_ALL | FILTER_REFS_DETACHED_HEAD) | |
14de7fba | 25 | |
3a25761a | 26 | struct atom_value; |
98e7ab6d | 27 | struct ref_sorting; |
69b1cf91 | 28 | |
98e7ab6d JH |
29 | enum ref_sorting_order { |
30 | REF_SORTING_REVERSE = 1<<0, | |
31 | REF_SORTING_ICASE = 1<<1, | |
32 | REF_SORTING_VERSION = 1<<2, | |
33 | REF_SORTING_DETACHED_HEAD_FIRST = 1<<3, | |
69b1cf91 KN |
34 | }; |
35 | ||
36 | struct ref_array_item { | |
cedfc41a | 37 | struct object_id objectname; |
b9dee075 | 38 | const char *rest; |
69b1cf91 | 39 | int flag; |
5b4f2851 | 40 | unsigned int kind; |
69b1cf91 | 41 | const char *symref; |
35257aa0 | 42 | struct commit *commit; |
69b1cf91 | 43 | struct atom_value *value; |
1958a6eb | 44 | char refname[FLEX_ARRAY]; |
69b1cf91 KN |
45 | }; |
46 | ||
47 | struct ref_array { | |
48 | int nr, alloc; | |
49 | struct ref_array_item **items; | |
1511b22d | 50 | struct rev_info *revs; |
69b1cf91 KN |
51 | }; |
52 | ||
53 | struct ref_filter { | |
54 | const char **name_patterns; | |
910650d2 | 55 | struct oid_array points_at; |
ee2bd06b | 56 | struct commit_list *with_commit; |
ac3f5a34 | 57 | struct commit_list *no_commit; |
21bf9339 AL |
58 | struct commit_list *reachable_from; |
59 | struct commit_list *unreachable_from; | |
ee2bd06b | 60 | |
bef0e12b | 61 | unsigned int with_commit_tag_algo : 1, |
1511b22d | 62 | match_as_path : 1, |
3bb16a8b | 63 | ignore_case : 1, |
1511b22d | 64 | detached : 1; |
1bb38e5a KN |
65 | unsigned int kind, |
66 | lines; | |
1511b22d KN |
67 | int abbrev, |
68 | verbose; | |
69b1cf91 KN |
69 | }; |
70 | ||
4a68e36d JK |
71 | struct ref_format { |
72 | /* | |
73 | * Set these to define the format; make sure you call | |
74 | * verify_ref_format() afterwards to finalize. | |
75 | */ | |
76 | const char *format; | |
b9dee075 | 77 | const char *rest; |
4a68e36d | 78 | int quote_style; |
b9dee075 | 79 | int use_rest; |
11b087ad | 80 | int use_color; |
bf285ae6 JK |
81 | |
82 | /* Internal state to ref-filter */ | |
83 | int need_color_reset_at_eol; | |
4a68e36d JK |
84 | }; |
85 | ||
b9dee075 | 86 | #define REF_FORMAT_INIT { .use_color = -1 } |
4a68e36d | 87 | |
5afcb905 KN |
88 | /* Macros for checking --merged and --no-merged options */ |
89 | #define _OPT_MERGED_NO_MERGED(option, filter, h) \ | |
90 | { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \ | |
91 | PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \ | |
92 | parse_opt_merge_filter, (intptr_t) "HEAD" \ | |
93 | } | |
94 | #define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h) | |
95 | #define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h) | |
96 | ||
95be717c | 97 | #define OPT_REF_SORT(var) \ |
98e7ab6d JH |
98 | OPT_STRING_LIST(0, "sort", (var), \ |
99 | N_("key"), N_("field name to sort on")) | |
95be717c | 100 | |
14de7fba KN |
101 | /* |
102 | * API for filtering a set of refs. Based on the type of refs the user | |
103 | * has requested, we iterate through those refs and apply filters | |
104 | * as per the given ref_filter structure and finally store the | |
105 | * filtered refs in the ref_array structure. | |
106 | */ | |
107 | int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type); | |
69b1cf91 KN |
108 | /* Clear all memory allocated to ref_array */ |
109 | void ref_array_clear(struct ref_array *array); | |
69b1cf91 | 110 | /* Used to verify if the given format is correct and to parse out the used atoms */ |
4a68e36d | 111 | int verify_ref_format(struct ref_format *format); |
69b1cf91 KN |
112 | /* Sort the given ref_array as per the ref_sorting provided */ |
113 | void ref_array_sort(struct ref_sorting *sort, struct ref_array *array); | |
7c269a7b ÆAB |
114 | /* Set REF_SORTING_* sort_flags for all elements of a sorting list */ |
115 | void ref_sorting_set_sort_flags_all(struct ref_sorting *sorting, unsigned int mask, int on); | |
99c6a71d | 116 | /* Based on the given format and quote_style, fill the strbuf */ |
3019eca9 | 117 | int format_ref_array_item(struct ref_array_item *info, |
e85fcb35 | 118 | struct ref_format *format, |
3019eca9 OT |
119 | struct strbuf *final_buf, |
120 | struct strbuf *error_buf); | |
e5fb0286 ÆAB |
121 | /* Release a "struct ref_sorting" */ |
122 | void ref_sorting_release(struct ref_sorting *); | |
98e7ab6d JH |
123 | /* Convert list of sort options into ref_sorting */ |
124 | struct ref_sorting *ref_sorting_options(struct string_list *); | |
5afcb905 KN |
125 | /* Function to parse --merged and --no-merged options */ |
126 | int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset); | |
d4919bb2 KN |
127 | /* Get the current HEAD's description */ |
128 | char *get_head_description(void); | |
6eac70fa KN |
129 | /* Set up translated strings in the output. */ |
130 | void setup_ref_filter_porcelain_msg(void); | |
69b1cf91 | 131 | |
2111aa79 LP |
132 | /* |
133 | * Print a single ref, outside of any ref-filter. Note that the | |
134 | * name must be a fully qualified refname. | |
135 | */ | |
53df97a2 | 136 | void pretty_print_ref(const char *name, const struct object_id *oid, |
e85fcb35 | 137 | struct ref_format *format); |
2111aa79 | 138 | |
427cbc9d JK |
139 | /* |
140 | * Push a single ref onto the array; this can be used to construct your own | |
141 | * ref_array without using filter_refs(). | |
142 | */ | |
143 | struct ref_array_item *ref_array_push(struct ref_array *array, | |
144 | const char *refname, | |
145 | const struct object_id *oid); | |
146 | ||
69b1cf91 | 147 | #endif /* REF_FILTER_H */ |