Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 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 | |
Karthik Nayak | 5b4f285 | 2015-09-10 21:18:23 +0530 | [diff] [blame] | 16 | #define FILTER_REFS_INCLUDE_BROKEN 0x0001 |
| 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) |
Karthik Nayak | 14de7fb | 2015-06-14 01:07:28 +0530 | [diff] [blame] | 25 | |
Karthik Nayak | 3a25761 | 2015-08-22 09:09:37 +0530 | [diff] [blame] | 26 | struct atom_value; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 27 | |
| 28 | struct ref_sorting { |
| 29 | struct ref_sorting *next; |
| 30 | int atom; /* index into used_atom array (internal) */ |
Karthik Nayak | 90c0040 | 2015-09-10 21:18:25 +0530 | [diff] [blame] | 31 | unsigned reverse : 1, |
Nguyễn Thái Ngọc Duy | 3bb16a8 | 2016-12-04 09:52:25 +0700 | [diff] [blame] | 32 | ignore_case : 1, |
Karthik Nayak | 90c0040 | 2015-09-10 21:18:25 +0530 | [diff] [blame] | 33 | version : 1; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 34 | }; |
| 35 | |
| 36 | struct ref_array_item { |
brian m. carlson | cedfc41 | 2017-05-06 22:10:21 +0000 | [diff] [blame] | 37 | struct object_id objectname; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 38 | int flag; |
Karthik Nayak | 5b4f285 | 2015-09-10 21:18:23 +0530 | [diff] [blame] | 39 | unsigned int kind; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 40 | const char *symref; |
Karthik Nayak | 35257aa | 2015-07-07 21:36:12 +0530 | [diff] [blame] | 41 | struct commit *commit; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 42 | struct atom_value *value; |
Karthik Nayak | 1958a6e | 2015-06-14 01:07:29 +0530 | [diff] [blame] | 43 | char refname[FLEX_ARRAY]; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 44 | }; |
| 45 | |
| 46 | struct ref_array { |
| 47 | int nr, alloc; |
| 48 | struct ref_array_item **items; |
Karthik Nayak | 1511b22 | 2015-09-23 23:41:11 +0530 | [diff] [blame] | 49 | struct rev_info *revs; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 50 | }; |
| 51 | |
| 52 | struct ref_filter { |
| 53 | const char **name_patterns; |
brian m. carlson | 910650d | 2017-03-31 01:40:00 +0000 | [diff] [blame] | 54 | struct oid_array points_at; |
Karthik Nayak | ee2bd06 | 2015-07-07 21:36:16 +0530 | [diff] [blame] | 55 | struct commit_list *with_commit; |
Ævar Arnfjörð Bjarmason | ac3f5a3 | 2017-03-24 18:40:57 +0000 | [diff] [blame] | 56 | struct commit_list *no_commit; |
Karthik Nayak | 35257aa | 2015-07-07 21:36:12 +0530 | [diff] [blame] | 57 | |
| 58 | enum { |
| 59 | REF_FILTER_MERGED_NONE = 0, |
| 60 | REF_FILTER_MERGED_INCLUDE, |
| 61 | REF_FILTER_MERGED_OMIT |
| 62 | } merge; |
| 63 | struct commit *merge_commit; |
Karthik Nayak | ee2bd06 | 2015-07-07 21:36:16 +0530 | [diff] [blame] | 64 | |
Karthik Nayak | bef0e12 | 2015-09-10 21:18:26 +0530 | [diff] [blame] | 65 | unsigned int with_commit_tag_algo : 1, |
Karthik Nayak | 1511b22 | 2015-09-23 23:41:11 +0530 | [diff] [blame] | 66 | match_as_path : 1, |
Nguyễn Thái Ngọc Duy | 3bb16a8 | 2016-12-04 09:52:25 +0700 | [diff] [blame] | 67 | ignore_case : 1, |
Karthik Nayak | 1511b22 | 2015-09-23 23:41:11 +0530 | [diff] [blame] | 68 | detached : 1; |
Karthik Nayak | 1bb38e5 | 2015-09-11 20:34:16 +0530 | [diff] [blame] | 69 | unsigned int kind, |
| 70 | lines; |
Karthik Nayak | 1511b22 | 2015-09-23 23:41:11 +0530 | [diff] [blame] | 71 | int abbrev, |
| 72 | verbose; |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 73 | }; |
| 74 | |
Karthik Nayak | 5afcb90 | 2015-07-07 21:36:11 +0530 | [diff] [blame] | 75 | /* Macros for checking --merged and --no-merged options */ |
| 76 | #define _OPT_MERGED_NO_MERGED(option, filter, h) \ |
| 77 | { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \ |
| 78 | PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \ |
| 79 | parse_opt_merge_filter, (intptr_t) "HEAD" \ |
| 80 | } |
| 81 | #define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h) |
| 82 | #define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h) |
| 83 | |
Karthik Nayak | 14de7fb | 2015-06-14 01:07:28 +0530 | [diff] [blame] | 84 | /* |
| 85 | * API for filtering a set of refs. Based on the type of refs the user |
| 86 | * has requested, we iterate through those refs and apply filters |
| 87 | * as per the given ref_filter structure and finally store the |
| 88 | * filtered refs in the ref_array structure. |
| 89 | */ |
| 90 | int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type); |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 91 | /* Clear all memory allocated to ref_array */ |
| 92 | void ref_array_clear(struct ref_array *array); |
| 93 | /* Parse format string and sort specifiers */ |
| 94 | int parse_ref_filter_atom(const char *atom, const char *ep); |
| 95 | /* Used to verify if the given format is correct and to parse out the used atoms */ |
| 96 | int verify_ref_format(const char *format); |
| 97 | /* Sort the given ref_array as per the ref_sorting provided */ |
| 98 | void ref_array_sort(struct ref_sorting *sort, struct ref_array *array); |
Karthik Nayak | 99c6a71 | 2017-01-10 14:19:39 +0530 | [diff] [blame] | 99 | /* Based on the given format and quote_style, fill the strbuf */ |
| 100 | void format_ref_array_item(struct ref_array_item *info, const char *format, |
| 101 | int quote_style, struct strbuf *final_buf); |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 102 | /* Print the ref using the given format and quote_style */ |
| 103 | void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style); |
| 104 | /* Callback function for parsing the sort option */ |
| 105 | int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset); |
| 106 | /* Default sort option based on refname */ |
| 107 | struct ref_sorting *ref_default_sorting(void); |
Karthik Nayak | 5afcb90 | 2015-07-07 21:36:11 +0530 | [diff] [blame] | 108 | /* Function to parse --merged and --no-merged options */ |
| 109 | int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset); |
Karthik Nayak | d4919bb | 2017-01-10 14:19:38 +0530 | [diff] [blame] | 110 | /* Get the current HEAD's description */ |
| 111 | char *get_head_description(void); |
Karthik Nayak | 6eac70f | 2017-01-10 14:19:50 +0530 | [diff] [blame] | 112 | /* Set up translated strings in the output. */ |
| 113 | void setup_ref_filter_porcelain_msg(void); |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 114 | |
Lukas Puehringer | 2111aa7 | 2017-01-17 18:37:19 -0500 | [diff] [blame] | 115 | /* |
| 116 | * Print a single ref, outside of any ref-filter. Note that the |
| 117 | * name must be a fully qualified refname. |
| 118 | */ |
| 119 | void pretty_print_ref(const char *name, const unsigned char *sha1, |
| 120 | const char *format); |
| 121 | |
Karthik Nayak | 69b1cf9 | 2015-06-14 01:07:26 +0530 | [diff] [blame] | 122 | #endif /* REF_FILTER_H */ |